| blob | f6a11607b059bd3bb92a136964a64ae2f743c172 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;; Version: 7.8.03
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
72 ;;;; 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
211 "Show the org-mode version in the echo area.
212 With prefix arg HERE, insert it at point."
238 ;;; Compatibility constants
240 ;;; The custom variables
243 "Outline-based notes management and organizer."
249 "Mode hook for Org-mode, run after the mode was turned on."
254 "Hook that is run after org.el has been loaded."
259 "Hook that is run after an Org log buffer is created."
268 "Load all extensions listed in `org-modules'."
273 org-modules)
277 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
286 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
287 "Modules that should always be loaded together with org.el.
288 If a description starts with <C>, the file is not part of Emacs
289 and loading it will require that you have downloaded and properly installed
290 the org-mode distribution.
292 You can also use this system to load external packages (i.e. neither Org
293 core modules, nor modules from the CONTRIB directory). Just add symbols
294 to the end of the list. If the package is called org-xyz.el, then you need
295 to add the symbol `xyz', and the package must have a call to
297 (provide 'org-xyz)"
300 :type
331 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
340 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
349 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
365 "Non-nil means make shift-cursor commands select text when possible.
367 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
368 start selecting a region, or enlarge regions started in this way.
369 In Org-mode, in special contexts, these same keys are used for
370 other purposes, important enough to compete with shift selection.
371 Org tries to balance these needs by supporting `shift-select-mode'
372 outside these special contexts, under control of this variable.
374 The default of this variable is nil, to avoid confusing behavior. Shifted
375 cursor keys will then execute Org commands in the following contexts:
376 - on a headline, changing TODO state (left/right) and priority (up/down)
377 - on a time stamp, changing the time
378 - in a plain list item, changing the bullet type
379 - in a property definition line, switching between allowed values
380 - in the BEGIN line of a clock table (changing the time block).
381 Outside these contexts, the commands will throw an error.
383 When this variable is t and the cursor is not in a special
384 context, Org-mode will support shift-selection for making and
385 enlarging regions. To make this more effective, the bullet
386 cycling will no longer happen anywhere in an item line, but only
387 if the cursor is exactly on the bullet.
389 If you set this variable to the symbol `always', then the keys
390 will not be special in headlines, property lines, and item lines,
391 to make shift selection work there as well. If this is what you
392 want, you can use the following alternative commands: `C-c C-t'
393 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
394 can be used to switch TODO sets, `C-c -' to cycle item bullet
395 types, and properties can be edited by hand or in column view.
397 However, when the cursor is on a timestamp, shift-cursor commands
398 will still edit the time stamp - this is just too good to give up.
400 XEmacs user should have this variable set to nil, because
401 `shift-select-mode' is in Emacs 23 or later only."
409 "Shall some commands act upon headlines in the active region?
411 When set to `t', some commands will be performed in all headlines
412 within the active region.
414 When set to `start-level', some commands will be performed in all
415 headlines within the active region, provided that these headlines
416 are of the same level than the first one.
418 When set to a string, those commands will be performed on the
419 matching headlines within the active region. Such string must be
420 a tags/property/todo match as it is used in the agenda tags view.
422 The list of commands is: `org-schedule', `org-deadline',
423 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
424 `org-archive-to-archive-sibling'. The archiving commands skip
425 already archived entries."
434 "Options concerning startup of Org-mode."
439 "Non-nil means entering Org-mode will switch to OVERVIEW.
440 This can also be configured on a per-file basis by adding one of
441 the following lines anywhere in the buffer:
443 #+STARTUP: fold (or `overview', this is equivalent)
444 #+STARTUP: nofold (or `showall', this is equivalent)
445 #+STARTUP: content
446 #+STARTUP: showeverything"
455 "Non-nil means entering Org-mode will set `truncate-lines'.
456 This is useful since some lines containing links can be very long and
457 uninteresting. Also tables look terrible when wrapped."
462 "Non-nil means turn on `org-indent-mode' on startup.
463 This can also be configured on a per-file basis by adding one of
464 the following lines anywhere in the buffer:
466 #+STARTUP: indent
467 #+STARTUP: noindent"
475 When this option is turned on, you can use TeX-like syntax for sub- and
477 considered as a single item - so grouping with {} is normally not
478 needed. For example, the following things will be parsed as single
479 sub- or superscripts.
481 10^24 or 10^tau several digits will be considered 1 item.
482 10^-12 or 10^-tau a leading sign with digits or a word
483 x^2-y^3 will be read as x^2 - y^3, because items are
484 terminated by almost any nonword/nondigit char.
485 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
487 Still, ambiguity is possible - so when in doubt use {} to enclose the
488 sub/superscript. If you set this variable to the symbol `{}',
489 the braces are *required* in order to trigger interpretations as
491 frequently in plain text.
493 Not all export backends support this, but HTML does.
508 "Non-nil means turn on `org-beamer-mode' on startup.
509 This can also be configured on a per-file basis by adding one of
510 the following lines anywhere in the buffer:
512 #+STARTUP: beamer"
517 "Non-nil means align all tables when visiting a file.
518 This is useful when the column width in tables is forced with <N> cookies
519 in table fields. Such tables will look correct only after the first re-align.
520 This can also be configured on a per-file basis by adding one of
521 the following lines anywhere in the buffer:
522 #+STARTUP: align
523 #+STARTUP: noalign"
528 "Non-nil means show inline images when loading a new Org file.
529 This can also be configured on a per-file basis by adding one of
530 the following lines anywhere in the buffer:
531 #+STARTUP: inlineimages
532 #+STARTUP: noinlineimages"
537 "Non-nil means insert the first line setting Org-mode in empty files.
538 When the function `org-mode' is called interactively in an empty file, this
539 normally means that the file name does not automatically trigger Org-mode.
540 To ensure that the file will always be in Org-mode in the future, a
541 line enforcing Org-mode will be inserted into the buffer, if this option
542 has been set."
547 "Non-nil means use alternative key bindings for some keys.
548 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
549 These keys are also used by other packages like shift-selection-mode'
550 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
551 If you want to use Org-mode together with one of these other modes,
552 or more generally if you would like to move some Org-mode commands to
553 other keys, set this variable and configure the keys with the variable
554 `org-disputed-keys'.
556 This option is only relevant at load-time of Org-mode, and must be set
557 *before* org.el is loaded. Changing it requires a restart of Emacs to
558 become effective."
563 "Non-nil means use extra key sequence definitions for certain commands.
564 This happens automatically if you run XEmacs or if `window-system'
565 is nil. This variable lets you do the same manually. You must
566 set it before loading org.
568 Example: on Carbon Emacs 22 running graphically, with an external
569 keyboard on a Powerbook, the default way of setting M-left might
570 not work for either Alt or ESC. Setting this variable will make
571 it work for ESC."
585 "Keys for which Org-mode and other modes compete.
586 This is an alist, cars are the default keys, second element specifies
587 the alternative to use when `org-replace-disputed-keys' is t.
589 Keys can be specified in any syntax supported by `define-key'.
590 The value of this option takes effect only at Org-mode's startup,
591 therefore you'll have to restart Emacs to apply it after changing."
596 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
597 Or return the original if not disputed.
598 Also apply the translations defined in `org-xemacs-key-equivalents'."
603 org-disputed-keys)))
607 key)
617 "Define a key, possibly translated, as returned by `org-key'."
621 "The ellipsis to use in the Org-mode outline.
622 When nil, just use the standard three dots. When a string, use that instead,
623 When a face, use the standard 3 dots, but with the specified face.
624 The change affects only Org-mode (which will then use its own display table).
625 Changing this requires executing `M-x org-mode' in a buffer to become
626 effective."
636 "Keywords in Org-mode."
641 "String to mark deadline entries.
642 A deadline is this string, followed by a time stamp. Should be a word,
643 terminated by a colon. You can insert a schedule keyword and
645 Changes become only effective after restarting Emacs."
650 "String to mark scheduled TODO entries.
651 A schedule is this string, followed by a time stamp. Should be a word,
652 terminated by a colon. You can insert a schedule keyword and
654 Changes become only effective after restarting Emacs."
659 "String used as the prefix for timestamps logging closing a TODO entry."
664 "String used as prefix for timestamps clocking work hours on an item."
669 "Entries starting with this keyword will never be exported.
670 An entry can be toggled between COMMENT and normal with
672 Changes become only effective after restarting Emacs."
677 "Entries starting with this keyword will be exported in fixed-width font.
678 Quoting applies only to the text in the entry following the headline, and does
679 not extend beyond the next headline, even if that is lower level.
680 An entry can be toggled between QUOTE and normal with
687 "Regular expression for specifying repeated events.
691 "Options concerning the general structure of Org-mode files."
696 "Options about how to make context of a location visible."
720 "Non-nil means show full hierarchy when revealing a location.
721 Org-mode often shows locations in an org-mode file which might have
722 been invisible before. When this is set, the hierarchy of headings
723 above the exposed location is shown.
724 Turning this off for example for sparse trees makes them very compact.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. Valid contexts are
727 agenda when exposing an entry from the agenda
728 org-goto when using the command `org-goto' on key C-c C-j
729 occur-tree when using the command `org-occur' on key C-c /
730 tags-tree when constructing a sparse tree based on tags matches
731 link-search when exposing search matches associated with a link
732 mark-goto when exposing the jump goal of a mark
733 bookmark-jump when exposing a bookmark location
734 isearch when exiting from an incremental search
735 default default for all contexts not set explicitly"
740 "Non-nil means show following heading when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the heading following the
743 match is shown.
744 Turning this off for example for sparse trees makes them very compact,
745 but makes it harder to edit the location of the match. In such a case,
747 Instead of t, this can also be an alist specifying this option for different
748 contexts. See `org-show-hierarchy-above' for valid contexts."
753 "Non-nil means show all sibling heading when revealing a location.
754 Org-mode often shows locations in an org-mode file which might have
755 been invisible before. When this is set, the sibling of the current entry
756 heading are all made visible. If `org-show-hierarchy-above' is t,
757 the same happens on each level of the hierarchy above the current entry.
759 By default this is on for the isearch context, off for all other contexts.
760 Turning this off for example for sparse trees makes them very compact,
761 but makes it harder to edit the location of the match. In such a case,
763 Instead of t, this can also be an alist specifying this option for different
764 contexts. See `org-show-hierarchy-above' for valid contexts."
769 "Non-nil means show the entry below a headline when revealing a location.
770 Org-mode often shows locations in an org-mode file which might have
771 been invisible before. When this is set, the text below the headline that is
772 exposed is also shown.
774 By default this is off for all contexts.
775 Instead of t, this can also be an alist specifying this option for different
776 contexts. See `org-show-hierarchy-above' for valid contexts."
781 "How should indirect tree buffers be displayed?
782 This applies to indirect buffers created with the commands
784 Valid values are:
785 current-window Display in the current window
786 other-window Just display in another window.
787 dedicated-frame Create one new frame, and re-use it each time.
788 new-frame Make a new frame each time. Note that in this case
789 previously-made indirect buffers are kept, and you need to
790 kill these buffers yourself."
800 "Non-nil means activate single letter commands at beginning of a headline.
801 This may also be a function to test for appropriate locations where speed
802 commands should be active."
810 "Alist of additional speed commands.
811 This list will be checked before `org-speed-commands-default'
812 when the variable `org-use-speed-commands' is non-nil
813 and when the cursor is at the beginning of a headline.
814 The car if each entry is a string with a single letter, which must
815 be assigned to `self-insert-command' in the global map.
816 The cdr is either a command to be called interactively, a function
817 to be called, or a form to be evaluated.
818 An entry that is just a list with a single string will be interpreted
819 as a descriptive headline that will be added when listing the speed
820 commands in the Help buffer using the `?' speed command."
832 "Options concerning visibility cycling in Org-mode."
837 "Non-nil means skip CHILDREN state in entries that don't have any."
842 "Maximum level which should still be subject to visibility cycling.
843 Levels higher than this will, for cycling, be treated as text, not a headline.
844 When `org-odd-levels-only' is set, a value of N in this variable actually
845 means 2N-1 stars as the limiting headline.
846 When nil, cycle all levels.
847 Note that the limiting level of cycling is also influenced by
848 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
849 `org-inlinetask-min-level' is, cycling will be limited to levels one less
850 than its value."
857 "Names of drawers. Drawers are not opened by cycling on the headline above.
858 Drawers only open with a TAB on the drawer line itself. A drawer looks like
859 this:
860 :DRAWERNAME:
861 .....
862 :END:
864 the property API.
866 Drawers can be defined on the per-file basis with a line like:
868 #+DRAWERS: HIDDEN STATE PROPERTIES"
874 "Non-nil means entering Org-mode will fold all blocks.
875 This can also be set in on a per-file basis with
877 #+STARTUP: hideblocks
878 #+STARTUP: showblocks"
884 "Cycle globally if cursor is at beginning of buffer and not at a headline.
885 This makes it possible to do global cycling without having to use S-TAB or
887 of the buffer
888 must not be a headline - it may be empty or some other text. When used in
889 this way, `org-cycle-hook' is disables temporarily, to make sure the
890 cursor stays at the beginning of the buffer.
891 When this option is nil, don't do anything special at the beginning
892 of the buffer."
897 "Non-nil means cycle entry level or item indentation in new empty entries.
899 When the cursor is at the end of an empty headline, i.e with only stars
900 and maybe a TODO keyword, TAB will then switch the entry to become a child,
901 and then all possible ancestor states, before returning to the original state.
902 This makes data entry extremely fast: M-RET to create a new headline,
903 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
905 When the cursor is at the end of an empty plain list item, one TAB will
906 make it a subitem, two or more tabs will back up to make this an item
907 higher up in the item hierarchy."
912 "Where should `org-cycle' emulate TAB.
913 nil Never
914 white Only in completely white lines
915 whitestart Only at the beginning of lines, before the first non-white char
916 t Everywhere except in headlines
917 exc-hl-bol Everywhere except at the start of a headline
918 If TAB is used in a place where it does not emulate TAB, the current subtree
919 visibility is cycled."
926 ))
929 "Number of empty lines needed to keep an empty line between collapsed trees.
930 If you leave an empty line between the end of a subtree and the following
931 headline, this empty line is hidden when the subtree is folded.
932 Org-mode will leave (exactly) one empty line visible if the number of
933 empty lines is equal or larger to the number given in this variable.
934 So the default 2 means at least 2 empty lines after the end of a subtree
935 are needed to produce free space between a collapsed subtree and the
936 following headline.
938 If the number is negative, and the number of empty lines is at least -N,
939 all empty lines are shown.
941 Special case: when 0, never leave empty lines in collapsed view."
947 "Hook that is run before visibility cycling is happening.
948 The function(s) in this hook must accept a single argument which indicates
949 the new state that will be set right after running this hook. The
950 argument is a symbol. Before a global state change, it can have the values
951 `overview', `content', or `all'. Before a local state change, it can have
952 the values `folded', `children', or `subtree'."
957 org-cycle-hide-drawers
958 org-cycle-show-empty-lines
959 org-optimize-window-after-visibility-change)
960 "Hook that is run after `org-cycle' has changed the buffer visibility.
961 The function(s) in this hook must accept a single argument which indicates
962 the new state that was set by the most recent `org-cycle' command. The
963 argument is a symbol. After a global state change, it can have the values
964 `overview', `content', or `all'. After a local state change, it can have
965 the values `folded', `children', or `subtree'."
970 "Options concerning structure editing in Org-mode."
975 "Non-nil means skip even levels and only use odd levels for the outline.
976 This has the effect that two stars are being added/taken away in
977 promotion/demotion commands. It also influences how levels are
978 handled by the exporters.
979 Changing it requires restart of `font-lock-mode' to become effective
980 for fontification also in regions already fontified.
981 You may also set this on a per-file basis by adding one of the following
982 lines to the buffer:
984 #+STARTUP: odd
985 #+STARTUP: oddeven"
991 "Non-nil means adapt indentation to outline node level.
993 When this variable is set, Org assumes that you write outlines by
994 indenting text in each node to align with the headline (after the stars).
995 The following issues are influenced by this variable:
997 - When this is set and the *entire* text in an entry is indented, the
998 indentation is increased by one space in a demotion command, and
999 decreased by one in a promotion command. If any line in the entry
1000 body starts with text at column 0, indentation is not changed at all.
1002 - Property drawers and planning information is inserted indented when
1003 this variable s set. When nil, they will not be indented.
1005 - TAB indents a line relative to context. The lines below a headline
1006 will be indented when this variable is set.
1008 Note that this is all about true indentation, by adding and removing
1009 space characters. See also `org-indent.el' which does level-dependent
1010 indentation in a virtual way, i.e. at display time in Emacs."
1015 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1017 When t, `C-a' will bring back the cursor to the beginning of the
1018 headline text, i.e. after the stars and after a possible TODO keyword.
1019 In an item, this will be the position after the bullet.
1020 When the cursor is already at that position, another `C-a' will bring
1021 it to the beginning of the line.
1023 `C-e' will jump to the end of the headline, ignoring the presence of tags
1024 in the headline. A second `C-e' will then jump to the true end of the
1025 line, after any tags. This also means that, when this variable is
1026 non-nil, `C-e' also will never jump beyond the end of the heading of a
1027 folded section, i.e. not after the ellipses.
1029 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1030 going to the true line boundary first. Only a directly following, identical
1031 keypress will bring the cursor to the special positions.
1033 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1034 set separately."
1053 "Non-nil means `C-k' will behave specially in headlines.
1054 When nil, `C-k' will call the default `kill-line' command.
1055 When t, the following will happen while the cursor is in the headline:
1057 - When the cursor is at the beginning of a headline, kill the entire
1058 line and possible the folded subtree below the line.
1059 - When in the middle of the headline text, kill the headline up to the tags.
1060 - When after the headline text, kill the tags."
1065 "Non-nil means, do not delete a hidden subtree with C-k.
1066 When set to the symbol `error', simply throw an error when C-k is
1067 used to kill (part-of) a headline that has hidden text behind it.
1068 Any other non-nil value will result in a query to the user, if it is
1069 OK to kill that hidden subtree. When nil, kill without remorse."
1077 "Check if in invisible region before inserting or deleting a character.
1078 Valid values are:
1080 nil Do not check, so just do invisible edits.
1081 error Throw an error and do nothing.
1082 show Make point visible, and do the requested edit.
1083 show-and-error Make point visible, then throw an error and abort the edit.
1084 smart Make point visible, and do insertion/deletion if it is
1085 adjacent to visible text and the change feels predictable.
1086 Never delete a previously invisible character or add in the
1087 middle or right after an invisible region. Basically, this
1088 allows insertion and backward-delete right before ellipses.
1089 FIXME: maybe in this case we should not even show?"
1099 "Non-nil means when yanking subtrees, fold them.
1100 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1101 it starts with a heading and all other headings in it are either children
1102 or siblings, then fold all the subtrees. However, do this only if no
1103 text after the yank would be swallowed into a folded tree by this action."
1108 "Non-nil means when yanking subtrees, adjust the level.
1109 With this setting, `org-paste-subtree' is used to insert the subtree, see
1110 this function for details."
1115 "Non-nil means M-RET will split the line at the cursor position.
1116 When nil, it will go to the end of the line before making a
1117 new line.
1118 You may also set this option in a different way for different
1119 contexts. Valid contexts are:
1121 headline when creating a new headline
1122 item when creating a new item
1123 table in a table field
1124 default the value to be used for all contexts not explicitly
1125 customized"
1142 "Non-nil means insert new headings after the current subtree.
1143 When nil, the new heading is created directly after the current line.
1146 for the duration of the command."
1152 "Should `org-insert-heading' leave a blank line before new heading/item?
1153 The value is an alist, with `heading' and `plain-list-item' as CAR,
1154 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1155 which case Org will look at the surrounding headings/items and try to
1156 make an intelligent decision whether to insert a blank line or not.
1158 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1159 set, the setting here is ignored and no empty line is inserted, to avoid
1160 breaking the list structure."
1173 "Hook being run after inserting a new heading."
1179 This currently only means they are never auto-wrapped.
1180 When nil, such lines will be treated like ordinary lines.
1181 See also the QUOTE keyword."
1186 "Non-nil means typing characters in `org-goto' starts incremental search."
1191 "Options concerning sparse trees in Org-mode."
1196 "Non-nil means highlight all matches that define a sparse tree.
1197 The highlights will automatically disappear the next time the buffer is
1198 changed by an edit command."
1203 "Non-nil means any change to the buffer will remove temporary highlights.
1204 Such highlights are created by `org-occur' and `org-clock-display'.
1205 When nil, `C-c C-c needs to be used to get rid of the highlights.
1206 The highlights created by `org-preview-latex-fragment' always need
1207 `C-c C-c' to be removed."
1214 "Hook that is run after `org-occur' has constructed a sparse tree.
1215 This can be used to recenter the window to show as much of the structure
1216 as possible."
1221 "Options concerning imenu and speedbar in Org-mode."
1226 "The maximum level for Imenu access to Org-mode headlines.
1227 This also applied for speedbar access."
1232 "Options concerning tables in Org-mode."
1238 When nil, such lines will be treated like ordinary lines.
1240 When equal to the symbol `optimized', the table editor will be optimized to
1241 do the following:
1242 - Automatic overwrite mode in front of whitespace in table fields.
1243 This makes the structure of the table stay in tact as long as the edited
1244 field does not exceed the column width.
1245 - Minimize the number of realigns. Normally, the table is aligned each time
1246 TAB or RET are pressed to move to another field. With optimization this
1247 happens only if changes to a field might have changed the column width.
1248 Optimization requires replacing the functions `self-insert-command',
1249 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1250 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1251 very good at guessing when a re-align will be necessary, but you can always
1254 If you would like to use the optimized version in Org-mode, but the
1255 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1257 This variable can be used to turn on and off the table editor during a session,
1258 but in order to toggle optimization, a restart is required.
1260 See also the variable `org-table-auto-blank-field'."
1268 "Non-nil means cluster self-insert commands for undo when possible.
1269 If this is set, then, like in the Emacs command loop, 20 consecutive
1270 characters will be undone together.
1271 This is configurable, because there is some impact on typing performance."
1276 "Non-nil means TAB will automatically notice a table.el table.
1277 When it sees such a table, it moves point into it and - if necessary -
1278 calls `table-recognize-table'."
1283 "Options concerning links in Org-mode."
1288 "Buffer-local version of `org-link-abbrev-alist', which see.
1293 "Alist of link abbreviations.
1294 The car of each element is a string, to be replaced at the start of a link.
1296 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1298 [[linkkey:tag][description]]
1300 The 'linkkey' must be a word word, starting with a letter, followed
1301 by letters, numbers, '-' or '_'.
1303 If REPLACE is a string, the tag will simply be appended to create the link.
1306 be inserted at that point (see the function `url-hexify-string').
1308 REPLACE may also be a function that will be called with the tag as the
1309 only argument to create the link, which should be returned as a string.
1311 See the manual for examples."
1321 "Non-nil means Org will display descriptive links.
1322 E.g. [[http://orgmode.org][Org website]] will be displayed as
1324 description. When set to `nil', Org will display the full links
1325 literally.
1327 You can interactively set the value of this variable by calling
1328 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1333 "How the path name in file links should be stored.
1334 Valid values are:
1336 relative Relative to the current directory, i.e. the directory of the file
1337 into which the link is being inserted.
1338 absolute Absolute path, if possible with ~ for home directory.
1339 noabbrev Absolute path, no abbreviation of home directory.
1340 adaptive Use relative path for files in the current directory and sub-
1341 directories of it. For other files, use an absolute path."
1350 "Types of links that should be activated in Org-mode files.
1351 This is a list of symbols, each leading to the activation of a certain link
1352 type. In principle, it does not hurt to turn on most link types - there may
1353 be a small gain when turning off unused link types. The types are:
1355 bracket The recommended [[link][description]] or [[link]] links with hiding.
1356 angle Links in angular brackets that may contain whitespace like
1357 <bbdb:Carsten Dominik>.
1358 plain Plain links in normal text, no whitespace, like http://google.com.
1359 radio Text that is matched by a radio target, see manual for details.
1360 tag Tag settings in a headline (link to tag search).
1361 date Time stamps (link to calendar).
1362 footnote Footnote labels.
1364 Changing this variable requires a restart of Emacs to become effective."
1376 "Function to use to generate link descriptions from links.
1377 If nil the link location will be used. This function must take
1378 two parameters; the first is the link and the second the
1379 description `org-insert-link' has generated, and should return the
1380 description to use."
1385 "Options concerning storing links in Org-mode."
1390 "Format of the description part of a link to an email or usenet message.
1391 The following %-escapes will be replaced by corresponding information:
1399 %s subject
1400 %d date
1401 %m message-id.
1403 You may use normal field width specification between the % and the letter.
1404 This is for example useful to limit the length of the subject.
1418 It should match if the message is from the user him/herself."
1423 "Non-nil means storing a link to an Org file will use entry IDs.
1425 Note that before this variable is even considered, org-id must be loaded,
1426 so please customize `org-modules' and turn it on.
1428 The variable can have the following values:
1430 t Create an ID if needed to make a link to the current entry.
1432 create-if-interactive
1433 If `org-store-link' is called directly (interactively, as a user
1434 command), do create an ID to support the link. But when doing the
1435 job for remember, only use the ID if it already exists. The
1436 purpose of this setting is to avoid proliferation of unwanted
1437 IDs, just because you happen to be in an Org file when you
1438 call `org-remember' that automatically and preemptively
1439 creates a link. If you do want to get an ID link in a remember
1440 template to an entry not having an ID, create it first by
1441 explicitly creating a link to it, using `C-c C-l' first.
1443 create-if-interactive-and-no-custom-id
1444 Like create-if-interactive, but do not create an ID if there is
1445 a CUSTOM_ID property defined in the entry. This is the default.
1447 use-existing
1448 Use existing ID, do not create one.
1450 nil Never use an ID to make a link, instead link using a text search for
1451 the headline text."
1456 create-if-interactive)
1458 create-if-interactive-and-no-custom-id)
1463 "Non-nil means file links from `org-store-link' contain context.
1464 A search string will be added to the file name with :: as separator and
1465 used to find the context when the link is activated by the command
1466 `org-open-at-point'. When this option is t, the entire active region
1467 will be placed in the search string of the file link. If set to a
1468 positive integer, only the first n lines of context will be stored.
1471 negates this setting for the duration of the command."
1476 "Non-nil means keep link in list for entire session.
1478 The command `org-store-link' adds a link pointing to the current
1479 location to an internal list. These links accumulate during a session.
1480 The command `org-insert-link' can be used to insert links into any
1481 Org-mode file (offering completion for all stored links). When this
1483 will be removed from the list, to make completing the unused links
1484 more efficient."
1489 "Options concerning following links in Org-mode."
1494 "Function to translate links with different syntax to Org syntax.
1495 This can be used to translate links created for example by the Planner
1496 or emacs-wiki packages to Org syntax.
1497 The function must accept two parameters, a TYPE containing the link
1499 which is everything after the link protocol. It should return a cons
1500 with possibly modified values of type and path.
1501 Org contains a function for this, so if you set this variable to
1502 `org-translate-link-from-planner', you should be able follow many
1503 links created by planner."
1508 "Hook that is run after a link has been followed."
1513 "Non-nil means on links TAB will follow the link.
1514 Needs to be set before org.el is loaded.
1515 This really should not be used, it does not make sense, and the
1516 implementation is bad."
1521 "Non-nil means on links RET will follow the link."
1527 "Non-nil means mouse-1 on a link will follow the link.
1528 A longer mouse click will still set point. Does not work on XEmacs.
1529 Needs to be set before org.el is loaded."
1534 "Number of different positions to be recorded in the ring.
1535 Changing this requires a restart of Emacs to work correctly."
1540 "Non-nil means internal links in Org files must exactly match a headline.
1541 When nil, the link search tries to match a phrase with all words
1542 in the search text."
1548 query-to-create)))
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.
2252 This variable needs to be set before org.el is loaded, and you need to
2253 restart Emacs after a change to make the change effective. The only way
2254 to change is while Emacs is running is through the customize interface."
2266 "Non-nil means unchecked boxes will block switching the parent to DONE.
2267 When this is nil, checkboxes have no influence on switching TODO states.
2268 When non-nil, you first need to check off all check boxes before the TODO
2269 entry can be switched to DONE.
2270 This variable needs to be set before org.el is loaded, and you need to
2271 restart Emacs after a change to make the change effective. The only way
2272 to change is while Emacs is running is through the customize interface."
2284 "Non-nil means inserting a TODO heading is treated as state change.
2286 logging will apply if appropriate. When nil, the new TODO item will
2287 be inserted directly, and no logging will take place."
2292 "Non-nil means switching TODO states with S-cursor counts as state change.
2293 This is the default behavior. However, setting this to nil allows a
2294 convenient way to select a TODO state and bypass any logging associated
2295 with that."
2300 "Tag changes that should be triggered by TODO state changes.
2301 This is a list. Each entry is
2303 (state-change (tag . flag) .......)
2305 State-change can be a string with a state, and empty string to indicate the
2306 state that has no TODO keyword, or it can be one of the symbols `todo'
2307 or `done', meaning any not-done or done state, respectively."
2321 "Information to record when a task moves to the DONE state.
2323 Possible values are:
2325 nil Don't add anything, just change the keyword
2326 time Add a time stamp to the task
2327 note Prompt for a note and add it with template `org-log-note-headings'
2329 This option can also be set with on a per-file-basis with
2331 #+STARTUP: nologdone
2332 #+STARTUP: logdone
2333 #+STARTUP: lognotedone
2335 You can have local logging settings for a subtree by setting the LOGGING
2336 property to one or more of these keywords."
2344 ;; Normalize old uses of org-log-done.
2351 "Information to record when the scheduling date of a tasks is modified.
2353 Possible values are:
2355 nil Don't add anything, just change the date
2356 time Add a time stamp to the task
2357 note Prompt for a note and add it with template `org-log-note-headings'
2359 This option can also be set with on a per-file-basis with
2361 #+STARTUP: nologreschedule
2362 #+STARTUP: logreschedule
2363 #+STARTUP: lognotereschedule"
2372 "Information to record when the deadline date of a tasks is modified.
2374 Possible values are:
2376 nil Don't add anything, just change the date
2377 time Add a time stamp to the task
2378 note Prompt for a note and add it with template `org-log-note-headings'
2380 This option can also be set with on a per-file-basis with
2382 #+STARTUP: nologredeadline
2383 #+STARTUP: logredeadline
2384 #+STARTUP: lognoteredeadline
2386 You can have local logging settings for a subtree by setting the LOGGING
2387 property to one or more of these keywords."
2396 "Non-nil means record a note when clocking out of an item.
2397 This can also be configured on a per-file basis by adding one of
2398 the following lines anywhere in the buffer:
2400 #+STARTUP: lognoteclock-out
2401 #+STARTUP: nolognoteclock-out"
2407 "Non-nil means the CLOSED time stamp will contain date and time.
2408 When nil, only the date will be recorded."
2422 "Headings for notes added to entries.
2423 The value is an alist, with the car being a symbol indicating the note
2424 context, and the cdr is the heading to be used. The heading may also be the
2425 empty string.
2426 %t in the heading will be replaced by a time stamp.
2427 %T will be an active time stamp instead the default inactive one
2428 %d will be replaced by a short-format time stamp.
2429 %D will be replaced by an active short-format time stamp.
2430 %s will be replaced by the new TODO state, in double quotes.
2431 %S will be replaced by the old TODO state, in double quotes.
2432 %u will be replaced by the user name.
2433 %U will be replaced by the full user name.
2435 In fact, it is not a good idea to change the `state' entry, because
2436 agenda log mode depends on the format of these entries."
2442 "Heading when changing todo state (todo sequence only)"
2456 "Non-nil means insert state change notes and time stamps into a drawer.
2457 When nil, state changes notes will be inserted after the headline and
2458 any scheduling and clock lines, but not inside a drawer.
2460 The value of this variable should be the name of the drawer to use.
2461 LOGBOOK is proposed as the default drawer for this purpose, you can
2462 also set this to a string to define the drawer of your choice.
2466 If this variable is set, `org-log-state-notes-insert-after-drawers'
2467 will be ignored.
2469 You can set the property LOG_INTO_DRAWER to overrule this setting for
2470 a subtree."
2482 "Return the value of `org-log-into-drawer', but let properties overrule.
2483 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2484 used instead of the default value."
2492 "Non-nil means insert state change notes after any drawers in entry.
2493 Only the drawers that *immediately* follow the headline and the
2494 deadline/scheduled line are skipped.
2495 When nil, insert notes right after the heading and perhaps the line
2496 with deadline/scheduling if present.
2498 This variable will have no effect if `org-log-into-drawer' is
2499 set."
2505 "Non-nil means the latest state note will be directly after heading.
2506 When nil, the state change notes will be ordered according to time."
2512 "The TODO state to which a repeater should return the repeating task.
2513 By default this is the first task in a TODO sequence, or the previous state
2514 in a TODO_TYP set. But you can specify another task here.
2515 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2521 "Non-nil means record moving through the DONE state when triggering repeat.
2522 An auto-repeating task is immediately switched back to TODO when
2525 record a closing note, there will be no record of the task moving
2526 through DONE. This variable forces taking a note anyway.
2528 nil Don't force a record
2529 time Record a time stamp
2530 note Record a note
2532 This option can also be set with on a per-file-basis with
2534 #+STARTUP: logrepeat
2535 #+STARTUP: lognoterepeat
2536 #+STARTUP: nologrepeat
2538 You can have local logging settings for a subtree by setting the LOGGING
2539 property to one or more of these keywords."
2549 "Priorities in Org-mode."
2554 "Non-nil means priority commands are active.
2555 When nil, these commands will be disabled, so that you never accidentally
2556 set a priority."
2561 "The highest priority of TODO items. A character like ?A, ?B etc.
2562 Must have a smaller ASCII number than `org-lowest-priority'."
2567 "The lowest priority of TODO items. A character like ?A, ?B etc.
2568 Must have a larger ASCII number than `org-highest-priority'."
2573 "The default priority of TODO items.
2574 This is the priority an item gets if no explicit priority is given.
2575 When starting to cycle on an empty priority the first step in the cycle
2576 depends on `org-priority-start-cycle-with-default'. The resulting first
2577 step priority must not exceed the range from `org-highest-priority' to
2578 `org-lowest-priority' which means that `org-default-priority' has to be
2579 in this range exclusive or inclusive the range boundaries. Else the
2580 first step refuses to set the default and the second will fall back
2581 to (depending on the command used) the highest or lowest priority."
2586 "Non-nil means start with default priority when starting to cycle.
2587 When this is nil, the first step in the cycle will be (depending on the
2588 command used) one higher or lower than the default priority.
2589 See also `org-default-priority'."
2594 "Function to extract the priority from a string.
2595 The string is normally the headline. If this is nil Org computes the
2596 priority from the priority cookie like [#A] in the headline. It returns
2597 an integer, increasing by 1000 for each priority level.
2598 The user can set a different function here, which should take a string
2599 as an argument and return the numeric priority."
2604 "Options concerning time stamps and deadlines in Org-mode."
2609 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2610 When nil, these labeled time stamps are forces into the second line of an
2611 entry, just after the headline. When scheduling from the global TODO list,
2612 the time stamp will always be forced into the second line."
2617 "Formats for `format-time-string' which are used for time stamps.
2621 "Number of minutes to round time stamps to.
2622 These are two values, the first applies when first creating a time stamp.
2623 The second applies when changing it with the commands `S-up' and `S-down'.
2624 When changing the time stamp, this means that it will change in steps
2625 of N minutes, as given by the second value.
2627 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2628 numbers should be factors of 60, so for example 5, 10, 15.
2630 When this is larger than 1, you can still force an exact time stamp by using
2631 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2632 and by using a prefix arg to `S-up/down' to specify the exact number
2633 of minutes to shift."
2643 ;; Normalize old customizations of this variable.
2647 org-time-stamp-rounding-minutes)))
2650 "Non-nil means overlay custom formats over all time stamps.
2651 The formats are defined through the variable `org-time-stamp-custom-formats'.
2652 To turn this on on a per-file basis, insert anywhere in the file:
2653 #+STARTUP: customtime"
2661 "Custom formats for time stamps. See `format-time-string' for the syntax.
2662 These are overlaid over the default ISO format if the variable
2663 `org-display-custom-times' is set. Time like %H:%M should be at the
2664 end of the second format. The custom formats are also honored by export
2665 commands, if custom time display is turned on at the time of export."
2670 "Get the right format for a time string."
2675 f)))
2678 "The format string used when creating CLOCKSUM lines.
2679 This is also used when org-mode generates a time duration."
2685 org-mode generates a time duration."
2690 "The format string used when creating CLOCKSUM lines, or when
2691 org-mode generates a time duration."
2696 "No. of days before expiration during which a deadline becomes active.
2697 This variable governs the display in sparse trees and in the agenda.
2698 When 0 or negative, it means use this number (the absolute value of it)
2699 even if a deadline has a different individual lead time specified.
2701 Custom commands can set this variable in the options section."
2707 "Non-nil means assume future for incomplete date input from user.
2708 This affects the following situations:
2709 1. The user gives a month but not a year.
2712 2. The user gives a day, but no month.
2715 it will be considered as *this* month.
2717 If you set this variable to the symbol `time', then also the following
2718 will work:
2720 3. If the user gives a time, but no day. If the time is before now,
2721 to will be interpreted as tomorrow.
2723 Currently none of this works for ISO week specifications.
2725 When this option is nil, the current day, month and year will always be
2726 used as defaults.
2728 See also `org-agenda-jump-prefer-future'."
2736 "Should the agenda jump command prefer the future for incomplete dates?
2737 The default is to do the same as configured in `org-read-date-prefer-future'.
2738 But you can also set a deviating value here.
2739 This may t or nil, or the symbol `org-read-date-prefer-future'."
2744 org-read-date-prefer-future)
2749 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2751 Depending on the system Emacs is running on, certain dates cannot
2752 be represented with the type used internally to represent time.
2753 Dates between 1970-1-1 and 2038-1-1 can always be represented
2754 correctly. Some systems allow for earlier dates, some for later,
2755 some for both. One way to find out it to insert any date into an
2756 Org buffer, putting the cursor on the year and hitting S-up and
2757 S-down to test the range.
2759 When this variable is set to t, the date/time prompt will not let
2760 you specify dates outside the 1970-2037 range, so it is certain that
2761 these dates will work in whatever version of Emacs you are
2762 running, and also that you can move a file from one Emacs implementation
2763 to another. WHenever Org is forcing the year for you, it will display
2764 a message and beep.
2766 When this variable is nil, Org will check if the date is
2767 representable in the specific Emacs implementation you are using.
2768 If not, it will force a year, usually the current year, and beep
2769 to remind you. Currently this setting is not recommended because
2770 the likelihood that you will open your Org files in an Emacs that
2771 has limited date range is not negligible.
2773 A workaround for this problem is to use diary sexp dates for time
2774 stamps outside of this range."
2779 "Non-nil means display current interpretation of date prompt live.
2780 This display will be in an overlay, in the minibuffer."
2785 "Non-nil means pop up a calendar when prompting for a date.
2786 In the calendar, the date can be selected with mouse-1. However, the
2787 minibuffer will also be active, and you can simply enter the date as well.
2788 When nil, only the minibuffer will be available."
2796 "Hook to be used to set up keys for the date/time interface.
2797 Add key definitions to `minibuffer-local-map', which will be a temporary
2798 copy."
2803 "The hour when your day really ends. Must be an integer.
2804 This has influence for the following applications:
2806 the time given here, the day recognized as TODAY is actually yesterday.
2807 - When a date is read from the user and it is still before the time given
2808 here, the current date and time will be assumed to be yesterday, 23:59.
2809 Also, timestamps inserted in remember templates follow this rule.
2811 IMPORTANT: This is a feature whose implementation is and likely will
2812 remain incomplete. Really, it is only here because past midnight seems to
2813 be the favorite working time of John Wiegley :-)"
2818 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2819 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2821 23:59 of the previous day."
2826 "Non-nil means S-down will increase the time in a time stamp.
2827 When nil, S-up will increase."
2832 "Non-nil means make the calendar window follow timestamp changes.
2833 When a timestamp is modified and the calendar window is visible, it will be
2834 moved to the new date."
2839 "Options concerning tags in Org-mode."
2844 "List of tags allowed in Org-mode files.
2845 When this list is nil, Org-mode will base TAG input on what is already in the
2846 buffer.
2847 The value of this variable is an alist, the car of each entry must be a
2848 keyword as a string, the cdr may be a character that is used to select
2849 that tag through the fast-tag-selection interface.
2850 See the manual for details."
2865 "List of tags that will always appear in all Org-mode files.
2866 This is in addition to any in buffer settings or customizations
2867 of `org-tag-alist'.
2868 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2869 The value of this variable is an alist, the car of each entry must be a
2870 keyword as a string, the cdr may be a character that is used to select
2871 that tag through the fast-tag-selection interface.
2872 See the manual for details.
2873 To disable these tags on a per-file basis, insert anywhere in the file:
2874 #+STARTUP: noptag"
2885 "If non-nil, always offer completion for all tags of all agenda files.
2886 Instead of customizing this variable directly, you might want to
2887 set it locally for capture buffers, because there no list of
2888 tags in that file can be created dynamically (there are none).
2890 (add-hook 'org-capture-mode-hook
2891 (lambda ()
2892 (set (make-local-variable
2893 'org-complete-tags-always-offer-all-agenda-tags)
2894 t)))"
2899 "List of tags that can be inherited by all entries in the file.
2900 The tags will be inherited if the variable `org-use-tag-inheritance'
2901 says they should be.
2905 "Non-nil means use fast tag selection scheme.
2906 This is a special interface to select and deselect tags with single keys.
2907 When nil, fast selection is never used.
2908 When the symbol `auto', fast selection is used if and only if selection
2909 characters for tags have been configured, either through the variable
2910 `org-tag-alist' or through a #+TAGS line in the buffer.
2911 When t, fast selection is always used and selection keys are assigned
2912 automatically if necessary."
2920 "Non-nil means fast tag selection exits after first change.
2921 When nil, you have to press RET to exit it.
2922 During fast tag selection, you can toggle this flag with `C-c'.
2923 This variable can also have the value `expert'. In this case, the window
2924 displaying the tags menu is not even shown, until you press C-c again."
2932 "Non-nil means fast tags selection interface will also offer TODO states.
2936 "The column to which tags should be indented in a headline.
2937 If this number is positive, it specifies the column. If it is negative,
2938 it means that the tags should be flushright to that column. For example,
2939 -80 works well for a normal 80 character screen.
2940 When 0, place tags directly after headline text, with only one space in
2941 between."
2946 "Non-nil keeps tags aligned when modifying headlines.
2947 Some operations (i.e. demoting) change the length of a headline and
2948 therefore shift the tags around. With this option turned on, after
2949 each such operation the tags are again aligned to `org-tags-column'."
2954 "Non-nil means tags in levels apply also for sublevels.
2955 When nil, only the tags directly given in a specific line apply there.
2956 This may also be a list of tags that should be inherited, or a regexp that
2957 matches tags that should be inherited. Additional control is possible
2958 with the variable `org-tags-exclude-from-inheritance' which gives an
2959 explicit list of tags to be excluded from inheritance., even if the value of
2960 `org-use-tag-inheritance' would select it for inheritance.
2962 If this option is t, a match early-on in a tree can lead to a large
2963 number of matches in the subtree when constructing the agenda or creating
2964 a sparse tree. If you only want to see the first match in a tree during
2965 a search, check out the variable `org-tags-match-list-sublevels'."
2974 "List of tags that should never be inherited.
2975 This is a way to exclude a few tags from inheritance. For way to do
2976 the opposite, to actively allow inheritance for selected tags,
2977 see the variable `org-use-tag-inheritance'."
2982 "Check if TAG is one that should be inherited."
2994 "Non-nil means list also sublevels of headlines matching a search.
2995 This variable applies to tags/property searches, and also to stuck
2996 projects because this search is based on a tags match as well.
2998 When set to the symbol `indented', sublevels are indented with
2999 leading dots.
3001 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3002 the sublevels of a headline matching a tag search often also match
3003 the same search. Listing all of them can create very long lists.
3004 Setting this variable to nil causes subtrees of a match to be skipped.
3006 This variable is semi-obsolete and probably should always be true. It
3007 is better to limit inheritance to certain tags using the variables
3008 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3016 "When set, tags are sorted using this function as a comparator."
3032 "Options concerning properties in Org-mode."
3037 "How property key/value pairs should be formatted by `indent-line'.
3038 When `indent-line' hits a property definition, it will format the line
3039 according to this format, mainly to make sure that the values are
3040 lined-up with respect to each other."
3045 "Alist of properties and functions to adjust inserted values.
3046 Elements of this alist must be of the form
3048 ([string] [function])
3050 where [string] must be a property name and [function] must be a
3051 lambda expression: this lambda expression must take one argument,
3052 the value to adjust, and return the new value as a string.
3056 and the clock summary:
3059 (let ((clocksum (org-clock-sum-current-item))
3060 (effort (org-duration-string-to-minutes
3062 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3067 "Non-nil means properties apply also for sublevels.
3069 This setting is chiefly used during property searches. Turning it on can
3070 cause significant overhead when doing a search, which is why it is not
3071 on by default.
3073 When nil, only the properties directly given in the current entry count.
3074 When t, every property is inherited. The value may also be a list of
3075 properties that should have inheritance, or a regular expression matching
3076 properties that should be inherited.
3078 However, note that some special properties use inheritance under special
3079 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3081 for valid values of a property.
3083 Note for programmers:
3084 When querying an entry with `org-entry-get', you can control if inheritance
3085 should be used. By default, `org-entry-get' looks only at the local
3086 properties. You can request inheritance by setting the inherit argument
3087 to t (to force inheritance) or to `selective' (to respect the setting
3088 in this variable)."
3097 "Check if PROPERTY is one that should be inherited."
3108 "The default column format, if no other format has been defined.
3109 This variable can be set on the per-file basis by inserting a line
3111 #+COLUMNS: %25ITEM ....."
3116 "The ellipses to be used when a field in column view is truncated.
3117 When this is the empty string, as many characters as possible are shown,
3118 but then there will be no visual indication that the field has been truncated.
3119 When this is a string of length N, the last N characters of a truncated
3120 field are replaced by this string. If the column is narrower than the
3121 ellipses string, only part of the ellipses string will be shown."
3126 "Function that modifies values for display in column view.
3127 For example, it can be used to cut out a certain part from a time stamp.
3128 The function must take 2 arguments:
3130 column-title The title of the column (*not* the property name)
3131 value The value that should be modified.
3133 The function should return the value that should be displayed,
3134 or nil if the normal value should be used."
3139 "The property that is being used to keep track of effort estimates.
3140 Effort estimates given in this property need to have the format H:MM."
3148 "List of property/value pairs that can be inherited by any entry.
3150 These are fixed values, for the preset properties. The user variable
3151 that can be used to add to this list is `org-global-properties'.
3153 The entries in this list are cons cells where the car is a property
3154 name and cdr is a string with the value. If the value represents
3159 "List of property/value pairs that can be inherited by any entry.
3161 This list will be combined with the constant `org-global-properties-fixed'.
3163 The entries in this list are cons cells where the car is a property
3164 name and cdr is a string with the value.
3166 You can set buffer-local values for the same purpose in the variable
3167 `org-file-properties' this by adding lines like
3169 #+PROPERTY: NAME VALUE"
3176 "List of property/value pairs that can be inherited by any entry.
3177 Valid for the current buffer.
3182 "Options concerning agenda views in Org-mode."
3187 "Variable used by org files to set a category for agenda display.
3188 Such files should use a file variable to set it, for example
3192 or contain a special line
3194 #+CATEGORY: ELisp
3196 If the file does not specify a category, then file's base name
3202 "The files to be used for agenda display.
3206 If an entry is a directory, all files in that directory that are matched by
3207 `org-agenda-file-regexp' will be part of the file list.
3209 If the value of the variable is not a list but a single file name, then
3210 the list of agenda files is actually stored and maintained in that file, one
3211 agenda file per line. In this file paths can be given relative to
3212 `org-directory'. Tilde expansion and environment variable substitution
3213 are also made."
3220 "Regular expression to match files for `org-agenda-files'.
3221 If any element in the list in that variable contains a directory instead
3222 of a normal file, all files in that directory that are matched by this
3223 regular expression will be included."
3228 "List of extra files to be searched by text search commands.
3229 These files will be search in addition to the agenda files by the
3230 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3231 Note that these files will only be searched for text search commands,
3232 not for the other agenda views like todo lists, tag searches or the weekly
3233 agenda. This variable is intended to list notes and possibly archive files
3234 that should also be searched by these two commands.
3235 In fact, if the first element in the list is the symbol `agenda-archives',
3236 than all archive files of all agenda files will be added to the search
3237 scope."
3248 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3249 A nil value means to remove them, after a query, from the list."
3254 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3255 The command `org-calendar-goto-agenda' will be bound to this key. The
3256 default is the character `c' because then `c' can be used to switch back and
3257 forth between agenda and calendar."
3262 "The key to be installed in `calendar-mode-map' for agenda-action.
3263 The command `org-agenda-action' will be bound to this key. The
3264 default is the character `k' because we use the same key in the agenda."
3269 "The key to be installed in `calendar-mode-map' for adding diary entries.
3270 This option is irrelevant until `org-agenda-diary-file' has been configured
3271 to point to an Org-mode file. When that is the case, the command
3272 `org-agenda-diary-entry' will be bound to the key given here, by default
3273 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3274 if you want to continue doing this, you need to change this to a different
3275 key."
3280 "File to which to add new entries with the `i' key in agenda and calendar.
3281 When this is the symbol `diary-file', the functionality in the Emacs
3282 calendar will be used to add entries to the `diary-file'. But when this
3283 points to a file, `org-agenda-diary-entry' will be used instead."
3299 org-calendar-insert-diary-entry-key
3303 "Options for embedding LaTeX code into Org-mode."
3311 "Options for creating images from LaTeX fragments.
3312 This is a property list with the following properties:
3314 `default' means use the foreground of the default face.
3316 `default' means use the background of the default face.
3317 :scale a scaling factor for the size of the images, to get more pixels
3318 :html-foreground, :html-background, :html-scale
3319 the same numbers for HTML export.
3320 :matchers a list indicating which matchers should be used to
3321 find LaTeX fragments. Valid members of this list are:
3332 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3333 When nil, just push out a message."
3338 Use this to specify additional executable file say a jar file.
3340 When using MathToWeb as the converter, specify the full-path to
3341 your mathtoweb.jar file."
3348 "Command to convert LaTeX fragments to MathML.
3349 Replace format-specifiers in the command as noted below and use
3350 `shell-command' to convert LaTeX to MathML.
3351 %j: Executable file in fully expanded form as specified by
3352 `org-latex-to-mathml-jar-file'.
3353 %I: Input LaTeX file in fully expanded form
3354 %o: Output MathML file
3355 This command is used by `org-create-math-formula'.
3357 When using MathToWeb as the converter, set this to
3365 "Return t if `org-latex-to-mathml-convert-command' is usable."
3368 org-latex-to-mathml-convert-command)
3370 org-latex-to-mathml-convert-command))))
3375 t))))))
3382 \[PACKAGES]
3383 \[DEFAULT-PACKAGES]
3384 % The settings below are copied from fullpage.sty
3397 "The document header used for processing LaTeX fragments.
3398 It is imperative that this header make sure that no page number
3399 appears on the page. The package defined in the variables
3400 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3402 will be appended."
3409 "Set the packages alist and make sure it has 3 elements per entry."
3413 x))
3414 val)))
3418 "Get the packages alist and make sure it has 3 elements per entry."
3422 x))
3425 ;; The following variables are defined here because is it also used
3426 ;; when formatting latex fragments. Originally it was part of the
3427 ;; LaTeX exporter, which is why the name includes "export".
3444 )
3445 "Alist of default packages to be inserted in the header.
3446 Change this only if one of the packages here causes an incompatibility
3447 with another package you are using.
3448 The packages in this list are needed by one part or another of Org-mode
3449 to function properly.
3451 - inputenc, fontenc: for basic font and character selection
3452 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3453 for interpreting the entities in `org-entities'. You can skip some of these
3454 packages if you don't use any of the symbols in it.
3455 - graphicx: for including images
3456 - float, wrapfig: for figure placement
3457 - longtable: for long tables
3458 - hyperref: for cross references
3460 Therefore you should not modify this variable unless you know what you
3461 are doing. The one reason to change it anyway is that you might be loading
3462 some other package that conflicts with one of the default packages.
3464 If SNIPPET-FLAG is t, the package also needs to be included when
3465 compiling LaTeX snippets into images for inclusion into HTML."
3478 "Alist of packages to be inserted in every LaTeX header.
3479 These will be inserted after `org-export-latex-default-packages-alist'.
3481 SNIPPET-FLAG, when t, indicates that this package is also needed when
3482 turning LaTeX snippets into images for inclusion into HTML.
3483 Make sure that you only list packages here which:
3484 - you want in every file
3485 - do not conflict with the default packages in
3486 `org-export-latex-default-packages-alist'
3487 - do not conflict with the setup in `org-format-latex-header'."
3501 "Settings for Org-mode appearance."
3506 "Non-nil means fontify only the stars in each headline.
3507 When nil, the entire headline is fontified.
3508 Changing it requires restart of `font-lock-mode' to become effective
3509 also in regions already fontified."
3514 "Non-nil means hide the first N-1 stars in a headline.
3515 This works by using the face `org-hide' for these stars. This
3516 face is white for a light background, and black for a dark
3517 background. You may have to customize the face `org-hide' to
3518 make this work.
3519 Changing it requires restart of `font-lock-mode' to become effective
3520 also in regions already fontified.
3521 You may also set this on a per-file basis by adding one of the following
3522 lines to the buffer:
3524 #+STARTUP: hidestars
3525 #+STARTUP: showstars"
3530 "List of symbols corresponding to keywords to be hidden the org buffer.
3531 For example, a value '(title) for this list will make the document's title
3532 appear in the buffer without the initial #+TITLE: keyword."
3540 "Non-nil means change the face of a headline if it is marked DONE.
3541 Normally, only the TODO/DONE keyword indicates the state of a headline.
3542 When this is non-nil, the headline after the keyword is set to the
3543 `org-headline-done' as an additional indication."
3548 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3549 Changing this variable requires a restart of Emacs to take effect."
3554 "Non-nil means fontify the whole line for headings.
3555 This is useful when setting a background color for the
3556 org-level-* faces."
3561 "Non-nil means fontify what is treated specially by the exporters."
3566 "Non-nil mean font-lock should hide the emphasis marker characters."
3571 "Non-nil means show entities as UTF8 characters.
3577 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3582 "Regular expression for matching emphasis.
3583 After a match, the match groups contain these elements:
3584 0 The match of the full regular expression, including the characters
3585 before and after the proper match
3586 1 The character before the proper match, or empty at beginning of line
3587 2 The proper match, including the leading and trailing markers
3588 3 The leading marker like * or /, indicating the type of highlighting
3589 4 The text between the emphasis markers, not including the markers
3596 "Set variable and compute the emphasis regular expression."
3600 org-emphasis-alist org-emphasis-regexp-components)
3612 ;; make sure special characters appear at the right position in the class
3624 ;; Make the regexp
3632 body1
3644 body1
3652 "Components used to build the regular expression for emphasis.
3653 This is a list with five entries. Terminology: In an emphasis string
3657 specify what is allowed/forbidden in each part:
3659 pre Chars allowed as prematch. Beginning of line will be allowed too.
3660 post Chars allowed as postmatch. End of line will be allowed too.
3661 border The chars *forbidden* as border characters.
3663 non-shy groups here, and don't allow newline here.
3664 newline The maximum number of newlines allowed in an emphasis exp.
3666 Use customize to modify this, or restart Emacs after changing it."
3685 )
3686 "Special syntax for emphasized text.
3687 Text starting and ending with a special character will be emphasized, for
3688 example *bold*, _underlined_ and /italic/. This variable sets the marker
3689 characters, the face to be used by font-lock for highlighting in Org-mode
3690 Emacs buffers, and the HTML tags to be used for this.
3691 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3692 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3693 Use customize to modify this, or restart Emacs after changing it."
3708 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3711 ;;; Miscellaneous options
3714 "Completion in Org-mode."
3719 "Non-nil means use ido completion wherever possible.
3720 Note that `ido-mode' must be active for this variable to be relevant.
3721 If you decide to turn this variable on, you might well want to turn off
3722 `org-outline-path-complete-in-steps'.
3723 See also `org-completion-use-iswitchb'."
3728 "Non-nil means use iswitchb completion wherever possible.
3729 Note that `iswitchb-mode' must be active for this variable to be relevant.
3730 If you decide to turn this variable on, you might well want to turn off
3731 `org-outline-path-complete-in-steps'.
3732 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3738 Normal means, no org-mode-specific context."
3742 ;;; Functions and variables from their packages
3743 ;; Declared here to avoid compiler warnings
3745 ;; XEmacs only
3751 ;; Emacs only
3754 ;; Various packages
3773 org-agenda-format-item "org-agenda"
3804 ;;; Autoload and prepare some org modules
3806 ;; Some table stuff that needs to be defined here, because it is used
3807 ;; by the functions setting up org-mode or checking for table context.
3820 "Detect the first line outside a table when searching from within it.
3823 ;; Autoload the functions in org-table.el that are needed by functions here.
3828 org-table-convert org-table-convert-region org-table-copy-down
3829 org-table-copy-region org-table-create
3830 org-table-create-or-convert-from-region
3831 org-table-create-with-table.el org-table-current-dline
3832 org-table-cut-region org-table-delete-column org-table-edit-field
3833 org-table-edit-formulas org-table-end org-table-eval-formula
3834 org-table-export org-table-field-info
3835 org-table-get-stored-formulas org-table-goto-column
3836 org-table-hline-and-move org-table-import org-table-insert-column
3837 org-table-insert-hline org-table-insert-row org-table-iterate
3838 org-table-justify-field-maybe org-table-kill-row
3839 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3840 org-table-move-column org-table-move-column-left
3841 org-table-move-column-right org-table-move-row
3842 org-table-move-row-down org-table-move-row-up
3843 org-table-next-field org-table-next-row org-table-paste-rectangle
3844 org-table-previous-field org-table-recalculate
3845 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3846 org-table-toggle-coordinate-overlays
3847 org-table-toggle-formula-debugger org-table-wrap-region
3848 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3849 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3850 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3853 "Return t if the cursor is inside an org-type table.
3854 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3859 org-table-line-regexp)))
3860 nil))
3864 "Return t if and only if we are at a table.el table."
3870 "If there is a table.el table nearby, recognize it and move into it."
3876 nil
3886 t
3891 t)
3892 nil)
3893 nil))
3896 "Return t if the cursor is inside a hline in a table."
3901 nil))
3906 "Apply FUNCTION to the start of all tables in the buffer."
3922 ;; Declare and autoload functions from org-exp.el & Co
3930 org-insert-export-options-template
3931 org-table-clean-before-export))
3934 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3935 org-export-region-as-ascii))
3938 org-replace-region-by-latex org-export-region-as-latex
3939 org-export-as-latex org-export-as-pdf
3940 org-export-as-pdf-and-open))
3943 org-export-as-html-batch org-export-as-html-to-buffer
3944 org-replace-region-by-html org-export-region-as-html
3945 org-export-as-html))
3948 org-replace-region-by-docbook org-export-region-as-docbook
3949 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3950 org-export-as-docbook))
3953 org-export-icalendar-all-agenda-files
3954 org-export-icalendar-combine-agenda-files))
3958 ;; Declare and autoload functions from org-agenda.el
3963 org-todo-list org-tags-view org-agenda-list-stuck-projects
3964 org-diary org-agenda-to-appt
3965 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3967 ;; Autoload org-remember
3972 org-remember-apply-template org-remember org-remember-handler)))
3977 org-capture-import-remember-templates)))
3979 ;; Autoload org-clock.el
3994 "Return non-nil if clock is currently running.
3995 The return value is actually the clock marker."
4000 "org-clock"
4002 org-clock-goto org-clock-sum org-clock-display
4003 org-clock-remove-overlays org-clock-report
4004 org-clocktable-shift org-dblock-write:clocktable
4005 org-get-clocktable org-resolve-clocks)))
4008 "If this is a CLOCK line, update it and return t.
4009 Otherwise, return nil."
4018 ts te h m s neg)
4021 nil)
4026 ;; The clock is running here
4047 t))))))
4050 "Check if the current buffer contains the running clock.
4051 If yes, offer to stop it and to save the buffer with the changes."
4060 "Check if this line starts a clock table, if yes, shift the time block."
4064 ;; Autoload org-timer.el
4068 "org-timer"
4070 org-timer-change-times-in-region
4071 org-timer-set-timer
4072 org-timer-reset-timers
4073 org-timer-show-remaining-time)))
4075 ;; Autoload org-feed.el
4079 "org-feed"
4083 ;; Autoload org-indent.el
4085 ;; Define the variable already here, to make sure we have it.
4087 "Non-nil if Org-Indent mode is enabled.
4092 "org-indent"
4095 ;; Autoload org-mobile.el
4099 "org-mobile"
4102 ;; Autoload archiving code
4103 ;; The stuff that is needed for cycling and tags has to be defined here.
4106 "Options concerning archiving in Org-mode."
4111 "The location where subtrees should be archived.
4113 The value of this variable is a string, consisting of two parts,
4114 separated by a double-colon. The first part is a filename and
4115 the second part is a headline.
4117 When the filename is omitted, archiving happens in the same file.
4118 %s in the filename will be replaced by the current file
4119 name (without the directory part). Archiving to a different file
4120 is useful to keep archived entries from contributing to the
4121 Org-mode Agenda.
4123 The archived entries will be filed as subtrees of the specified
4124 headline. When the headline is omitted, the subtrees are simply
4125 filed away at the end of the file, as top-level entries. Also in
4126 the heading you can use %s to represent the file name, this can be
4127 useful when using the same archive for a number of different files.
4129 Here are a few examples:
4131 If the current file is Projects.org, archive in file
4132 Projects.org_archive, as top-level trees. This is the default.
4135 Archive in the current file, under the top-level headline
4139 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4142 Archive in file ~/org/archive.org (absolute path), under headlines
4146 Archive in file ./basement (relative path), as level 3 trees
4149 You may set this option on a per-file basis by adding to the buffer a
4150 line like
4152 #+ARCHIVE: basement::** Finished Tasks
4154 You may also define it locally for a subtree by setting an ARCHIVE property
4155 in the entry. If such a property is found in an entry, or anywhere up
4156 the hierarchy, it will be used."
4161 "The tag that marks a subtree as archived.
4162 An archived subtree does not open during visibility cycling, and does
4163 not contribute to the agenda listings.
4164 After changing this, font-lock must be restarted in the relevant buffers to
4165 get the proper fontification."
4171 "Non-nil means the agenda will skip any items located in archived trees.
4172 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4173 variable is no longer recommended, you should leave it at the value t.
4174 Instead, use the key `v' to cycle the archives-mode in the agenda."
4180 "Non-nil means ignore archived trees when creating column view."
4186 "Non-nil means `org-cycle' will open archived trees.
4187 An archived tree is a tree marked with the tag ARCHIVE.
4188 When nil, archived trees will stay folded. You can still open them with
4189 normal outline commands like `show-all', but not with the cycling commands."
4195 "Non-nil means sparse tree construction shows matches in archived trees.
4196 When nil, matches in these trees are highlighted, but the trees are kept in
4197 collapsed state."
4203 "Re-hide all archived subtrees after a visibility state change."
4214 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4217 "Cycle subtree even if it is archived."
4224 "Re-hide all archived subtrees after a visibility state change."
4239 flag)))
4246 org-archive-to-archive-sibling org-toggle-archive-tag
4247 org-archive-subtree-default
4248 org-archive-subtree-default-with-confirmation)))
4250 ;; Autoload Column View Code
4258 org-columns-compute org-agenda-columns org-columns-remove-overlays
4261 ;; Autoload ID code
4269 org-id-get-with-outline-path-completion
4270 org-id-get-with-outline-drilling org-id-store-link
4271 org-id-goto org-id-find org-id-store-link))
4273 ;; Autoload Plotting Code
4278 ;;; Variables for pre-computed regular expressions, all buffer local
4296 "Matches a headline and puts everything into groups:
4297 group 1: the stars
4298 group 2: The todo keyword, maybe
4299 group 3: Priority cookie
4300 group 4: True headline
4304 "Printf format to make regexp to match an exact headline.
4305 This regexp will match the headline of any node which has the
4306 exact headline text that is put into the format, but may have any
4310 "Matches a headline and puts TODO state into group 2 if present.
4359 "Regular expression to match a plain time or time range.
4360 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4361 groups carry important information:
4362 0 the full match
4363 1 the first time, range or not
4371 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4372 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4373 groups carry important information:
4374 0 the full match
4375 7 hours of duration
4384 "Regular expression to match a timestamp time or time range.
4385 After a match, the following groups carry important information:
4386 0 the full match
4387 1 date plus weekday, for back referencing to make sure both times are on the same day
4388 2 the first time, range or not
4443 "Variable associated with STARTUP options for org-mode.
4444 Each element is a list of three items: The startup options as written
4445 in the #+STARTUP line, the corresponding variable, and the value to
4446 set this variable to if the option is found. An optional forth element PUSH
4450 "Update PROPS with KEY and VAL."
4464 "Printf format for a regexp matching an headline with some keyword.
4465 This regexp will match the headline of any node which has the
4466 exact keyword that is put into the format. The keyword isn't in
4470 "Printf format for a regexp matching an headline, possibly with some keyword.
4471 This regexp can match any headline with the specified keyword, or
4472 without a keyword. The keyword isn't in any group by default,
4476 "Precompute regular expressions for current buffer."
4496 kwds kws0 kwsa key log value cat arch tags const links hw dws
4497 tail sep kws1 prio props ftags drawers beamer-p
4519 ;; general TODO-like setup
4531 links)))
4538 props))))
4543 ftags
4553 l var val)
4583 ;; search for property blocks
4592 props)))))))
4609 ;; Process the TODO keywords
4611 ;; Use the global values as if they had been given locally.
4623 kws)))
4626 kwsa nil
4629 ;; 1 2
4637 kw)
4639 kws0)
4656 ;; Process the constants
4664 ;; Process the tags.
4675 tgs))
4683 ;; Compute the regular expressions and other local variables.
4684 ;; Using `org-outline-regexp-bol' would complicate them much,
4685 ;; because of the fixed white space at the end of that string.
4693 org-drawer-regexp
4697 org-not-done-keywords
4699 org-todo-regexp
4703 org-not-done-regexp
4707 org-not-done-heading-regexp
4709 org-todo-line-regexp
4711 org-complex-heading-regexp
4718 org-complex-heading-regexp-format
4723 ;; Stats cookies can be stuck to body.
4730 org-todo-line-tags-regexp
4737 org-deadline-time-regexp
4739 org-deadline-line-regexp
4741 org-scheduled-regexp
4743 org-scheduled-time-regexp
4745 org-closed-time-regexp
4747 org-keyword-time-regexp
4753 org-keyword-time-not-clock-regexp
4759 org-maybe-keyword-time-regexp
4765 org-planning-or-clock-line-re
4770 org-all-time-keywords
4773 org-clock-string org-closed-string))
4774 )
4779 "Return the contents of FILE, as a string."
4793 "Extract the log state setting from a TODO keyword string.
4807 "Remove a pair of parenthesis at the end of each string in LIST."
4811 x))
4812 list))
4815 "Assign fast keys to a keyword-key alist.
4816 Respect keys that are already there."
4834 ;;; Some variables used in various places
4841 "Function to be called when `C-c C-c' is used.
4845 ;; FIXME: Occasionally check by commenting these, to make sure
4846 ;; no other functions uses these, forgetting to let-bind them.
4851 ;; Defined somewhere in this file, but used before definition.
4857 ;;;; Define the Org-mode
4860 (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"))
4863 ;; We use a before-change function to check if a table might need
4864 ;; an update.
4866 "Indicates that a table might need an update.
4867 This variable is set by `org-before-change-function'.
4870 "Every change indicates that a table might need an update."
4880 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4881 ;; some places -- e.g. see the macro org-with-limited-levels.
4882 ;;
4883 ;; In Org buffers, the value of `outline-regexp' is that of
4884 ;; `org-outline-regexp'. The only function still directly relying on
4885 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4886 ;; job when `orgstruct-mode' is active.
4890 "Regexp to match Org headlines.
4891 This is similar to `org-outline-regexp' but additionally makes
4895 "Matches an headline, putting stars and text into groups.
4898 ;;;###autoload
4900 "Outline-based notes management and organizer, alias
4903 Org-mode develops organizational tasks around a NOTES file which
4904 contains information about projects as plain text. Org-mode is
4905 implemented on top of outline-mode, which is ideal to keep the content
4906 of large files well structured. It supports ToDo items, deadlines and
4907 time stamps, which magically appear in the diary listing of the Emacs
4908 calendar. Tables are easily created with a built-in table editor.
4909 Plain text URL-like links connect to websites, emails (VM), Usenet
4910 messages (Gnus), BBDB entries, and any files related to the project.
4911 For printing and sharing of notes, an Org-mode file (or a part of it)
4912 can be exported as a structured ASCII or HTML file.
4914 The following commands are available:
4918 ;; Get rid of Outline menus, they are not needed
4919 ;; Need to do this here because define-derived-mode sets up
4920 ;; the keymap so late. Still, it is a waste to call this each time
4921 ;; we switch another buffer into org-mode.
4924 ;; Assume this is Greg's port, it uses easymenu
4950 org-display-table 4
4953 org-ellipsis)))
4958 ;; tag faces set outside customize.... force initialization.
4960 ;; Calc embedded
4966 ;; Activate before-change-function
4970 ;; Check for running clock before killing a buffer
4972 ;; Paragraphs and auto-filling
4976 ;; Beginning/end of defun
4979 ;; Next error for sparse trees
4981 ;; Make sure dependence stuff works reliably, even for users who set it
4982 ;; too late :-(
4994 ;; Comment characters
4998 ;; Align options lines
5000 'align-mode-rules-list
5005 ;; Imenu
5009 ;; Make isearch reveal context
5012 ;; Emacs 21 and XEmacs make use of the hook
5014 ;; Emacs 22 deals with this through a special variable
5018 ;; Turn on org-beamer-mode?
5021 ;; 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 "Run through the buffer and add overlays to links."
5474 t)))
5477 "Run through the buffer and add overlays to footnotes."
5484 'keymap org-mouse-map
5485 'help-echo
5487 "Footnote definition"
5489 'font-lock-fontified t
5490 'font-lock-multiline t
5494 "Run through the buffer and add overlays to bracketed links."
5498 ;; FIXME: above we should remove the escapes.
5499 ;; but that requires another match, protecting match data,
5500 ;; a lot of overhead for font-lock.
5507 ;; We need to remove the invisible property here. Table narrowing
5508 ;; may have made some of this invisible.
5526 t)))
5529 "Run through the buffer and add overlays to dates."
5541 t)))
5550 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5554 "Run through the buffer and add overlays to target matches."
5562 'keymap org-mouse-map
5566 t)))))
5569 "Find all radio targets in this file and update the regular expression."
5584 t)))
5591 ;; This should be with the exporter code, but we also use if for font-locking
5601 "Compute regular expression for stuff treated specially by exporters."
5608 org-latex-regexps)))
5636 org-entities)))
5640 org-latex-entities)
5641 nil))
5643 ))
5644 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5647 org-export-html-special-string-regexps)))
5652 ))))
5654 'org-latex-and-specials-regexp
5659 "Run through the buffer and add overlays to links."
5663 limit t))
5677 rtn)))
5680 "Restart `font-lock-mode', to force refontification."
5686 "Return a list of all targets in this file.
5687 With optional argument RADIO, only find radio targets."
5689 rtn)
5694 rtn)))
5697 "Make regular expression matching all strings in TARGETS.
5698 The regular expression finds the targets also if there is a line break
5699 between words."
5708 x)
5709 targets
5721 t)))
5724 "Compute the outline level of the heading at point.
5725 This function assumes that the cursor is at the beginning of a line matched
5726 by `outline-regexp'. Otherwise it returns garbage.
5727 If this is called at a normal headline, the level is the number of stars.
5728 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5735 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5742 "Functions that can manipulate `org-font-lock-extra-keywords'.
5743 This is called after `org-font-lock-extra-keywords' is defined, but before
5744 it is installed to be used by font lock. This can be useful if something
5755 ;; Call the hook
5757 ;; Headlines
5764 ;; Table lines
5767 ;; Table internals
5772 ;; Drawers
5775 ;; Properties
5779 ;; Links
5789 ;; TODO keyword
5791 org-todo-regexp)
5793 ;; DONE
5801 nil)
5802 ;; Priorities
5804 ;; Tags
5806 ;; Special keywords
5811 ;; Emphasis
5816 ;; Checkboxes
5817 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5822 ;; Description list items
5825 ;; ARCHIVEd headings
5827 org-outline-regexp-bol
5830 ;; Specials
5834 ;; Code
5836 ;; COMMENT
5843 ;; Blocks and meta lines
5845 )))
5848 ;; Now set the full font-lock-keywords
5855 "Toggle the composition display of entities as UTF8 characters."
5867 "Find an entity to fontify."
5873 limit t)
5885 nil))))
5888 "Fontify string S like in Org-mode."
5900 "Get the right face for match N in font-lock matching of headlines."
5913 "Get the right face for a TODO keyword KWD.
5914 If KWD is a number, get the corresponding match group."
5922 "Create a face list that inherits INHERIT, but sets the foreground color.
5923 When FACE-OR-COLOR is not a string, just return it."
5927 face-or-color)
5928 face-or-color))
5931 "Add the special tag faces."
5940 "Add the special priority faces."
5947 org-priority-faces)))
5952 "Get the right face for a TODO keyword KWD.
5953 If KWD is a number, get the corresponding match group."
5960 "Remove fontification and activation overlays from links."
5965 deactivate-mark buffer-file-name buffer-file-truename)
5969 invisible t intangible t
5970 org-no-flyspell t org-emphasis t))
5980 "Remove specific display properties that have been added by font lock.
5981 The will remove the raise properties that are used to show superscripts
5982 and subscripts."
5992 "Add raise properties to sub/superscripts."
5996 org-match-substring-regexp
5997 org-match-substring-with-braces-regexp)
5998 limit t)
6008 ;; FIXME: Should we go back one character here, for a_b^c
6009 ;; (goto-char (1- pos)) ;????????????????????
6011 t
6013 'display
6029 t)))))
6031 ;;;; Visibility cycling, including org-goto and indirect buffer
6033 ;;; Cycling
6040 ;;;###autoload
6045 "TAB-action and visibility cycling for Org-mode.
6047 This is the command invoked in Org-mode by the TAB key. Its main purpose
6048 is outline visibility cycling, but it also invokes other actions
6049 in special contexts.
6051 - When this function is called with a prefix argument, rotate the entire
6052 buffer through 3 states (global cycling)
6053 1. OVERVIEW: Show only top-level headlines.
6054 2. CONTENTS: Show all headlines of all levels, but no body text.
6055 3. SHOW ALL: Show everything.
6056 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6057 determined by the variable `org-startup-folded', and by any VISIBILITY
6058 properties in the buffer.
6059 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6060 including any drawers.
6062 - When inside a table, re-align the table and move to the next field.
6064 - When point is at the beginning of a headline, rotate the subtree started
6065 by this line through 3 different states (local cycling)
6066 1. FOLDED: Only the main headline is shown.
6067 2. CHILDREN: The main headline and the direct children are shown.
6068 From this state, you can move to one of the children
6069 and zoom in further.
6070 3. SUBTREE: Show the entire subtree, including body text.
6071 If there is no subtree, switch directly from CHILDREN to FOLDED.
6073 - When point is at the beginning of an empty headline and the variable
6074 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6075 of the headline by demoting and promoting it to likely levels. This
6076 speeds up creation document structure by pressing TAB once or several
6077 times right after creating a new headline.
6079 - When there is a numeric prefix, go up to a heading with level ARG, do
6080 a `show-subtree' and return to the previous cursor position. If ARG
6081 is negative, go up that many levels.
6083 - When point is not at the beginning of a headline, execute the global
6084 binding for TAB, which is re-indenting the line. See the option
6085 `org-cycle-emulate-tab' for details.
6087 - Special case: if point is at the beginning of the buffer and there is
6088 no headline in line 1, this function will act as if called with prefix arg
6089 (C-u TAB, same as S-TAB) also when called without prefix arg.
6090 But only if also the variable `org-cycle-global-at-bob' is t."
6100 org-inlinetask-min-level
6105 limit-level)))
6108 outline-regexp
6116 org-cycle-hook))
6120 ;; special case: use global cycling
6134 ;; Table: enter it or move to the next field.
6145 ;; Global cycling: delegate to `org-cycle-internal-global'.
6148 ;; Drawers: delegate to `org-flag-drawer'.
6156 ;; Show-subtree, ARG levels up from here.
6164 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6172 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6179 ;; From there: TAB emulation and template completion.
6201 t
6210 "Do the global cycling action."
6214 ;; We just created the overview - now do table of contents
6215 ;; This can be slow in very large buffers, so indicate action
6225 ;; We just showed the table of contents - now show everything
6233 ;; Default action: go to overview
6241 "Do the local cycling action."
6243 ;; First, determine end of headline (EOH), end of subtree or item
6244 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6268 ;; Determine end invisible part of buffer (EOL)
6270 ;; XEmacs doesn't have `next-single-char-property-change'
6280 ;; Find out what to do next and set `this-command'
6283 ;; Nothing is hidden behind this heading
6295 org-cycle-skip-children-state-if-no-children))))
6296 ;; Entire subtree is hidden in one line: children view
6302 ;; Fold every list in subtree to top-level items.
6324 ;; We just showed the children, or no children are there,
6325 ;; now show everything.
6332 ;; Default action: hide the subtree.
6339 ;;;###autoload
6341 "Cycle the global visibility. For details see `org-cycle'.
6343 With a numeric prefix, show all headlines up to that level."
6359 "Set the visibility required by startup options and properties."
6374 "Switch subtree visibilities according to :VISIBILITY: property."
6381 nil t)
6405 ;; This function uses outline-regexp instead of the more fundamental
6406 ;; org-outline-regexp so that org-cycle-global works outside of Org
6407 ;; buffers, where outline-regexp is needed.
6409 "Switch to overview mode, showing only top-level headlines.
6410 Really, this shows all headlines with level equal or greater than the level
6411 of the first headline in the buffer. This is important, because if the
6412 first headline is not level one, then (hide-sublevels 1) gives confusing
6413 results."
6424 "Show all headlines in the buffer, like a table of contents.
6425 With numerical argument N, show content up to level N."
6428 ;; Visit all headings and show their offspring
6435 t)
6444 "Adjust the window after a change in outline visibility.
6445 This function is the default value of the hook `org-cycle-hook'."
6455 "Remove outline overlays that do not contain non-white stuff."
6465 "Fix visibility issues after moving a subtree."
6466 ;; First, find a reasonable region to look at:
6467 ;; Start two siblings above, end three below
6485 ;; Properly fold already folded siblings
6496 "Show empty lines above all visible headlines.
6497 The region to be covered depends on STATE when called through
6498 `org-cycle-hook'. Lisp program can use t for STATE to get the
6499 entire buffer covered. Note that an empty line is only shown if there
6500 are at least `org-cycle-separator-lines' empty lines before the headline."
6510 beg end b e)
6534 ;; Never hide empty lines at the end of the file.
6544 "Move to the parent and re-show empty lines before visible headlines."
6550 "Return `org-agenda-files' list, plus all open org-mode files.
6551 This is useful for operations that need to scan all of a user's
6552 open and agenda-wise Org files."
6560 files))
6563 "Return the beginning position of the current entry."
6567 "Return the end position of the current entry."
6571 "Re-hide all drawers after a visibility state change."
6597 "Is the end of the current subtree visible?"
6602 "Move cursor to the first headline and recenter the headline.
6603 Optional argument N means put the headline into the Nth line of the window."
6609 ;;; Saving and restoring visibility
6612 "Return a list of the locations of all outline overlays.
6613 These are overlays with the `invisible' property value `outline'.
6614 The return value is a list of cons cells, with start and stop
6615 positions for each overlay.
6616 If USE-MARKERS is set, return the positions as markers."
6634 "Create visibility overlays for all positions in DATA.
6635 DATA should have been made by `org-outline-overlay-data'."
6643 data)))))
6645 ;;; Folding of blocks
6652 "Call FUNCTION at the head of all source blocks in the current buffer.
6653 Optional arguments START and END can be used to limit the range."
6665 "Toggle the visibility of all blocks in the current buffer."
6669 "Fold all blocks in the current buffer."
6675 "Unfold all blocks in the current buffer."
6681 "Toggle visibility of block at point."
6692 "Toggle the visibility of the current block."
6699 ov)
6715 ;; make the block accessible to isearch
6717 ov 'isearch-open-invisible
6728 ;; org-tab-after-check-for-cycling-hook
6730 ;; Remove overlays when changing major mode
6735 ;;; Org-goto
6741 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6757 nil)
6758 (org-defkey map "q" 'org-goto-quit)
6759 (org-defkey map "n" 'outline-next-visible-heading)
6760 (org-defkey map "p" 'outline-previous-visible-heading)
6761 (org-defkey map "f" 'outline-forward-same-level)
6762 (org-defkey map "b" 'outline-backward-same-level)
6763 (org-defkey map "u" 'outline-up-heading))
6764 (org-defkey map "/" 'org-occur)
6765 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6766 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6767 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6768 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6769 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6770 map))
6772 (defconst org-goto-help
6773 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6774 RET=jump to location [Q]uit and return to previous location
6775 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6777 (defvar org-goto-start-pos) ; dynamically scoped parameter
6779 ;; FIXME: Docstring does not mention both interfaces
6780 (defun org-goto (&optional alternative-interface)
6781 "Look up a different location in the current file, keeping current visibility.
6783 When you want look-up or go to a different location in a document, the
6784 fastest way is often to fold the entire buffer and then dive into the tree.
6785 This method has the disadvantage, that the previous location will be folded,
6786 which may not be what you want.
6788 This command works around this by showing a copy of the current buffer
6789 in an indirect buffer, in overview mode. You can dive into the tree in
6790 that copy, use org-occur and incremental search to find a location.
6791 When pressing RET or `Q', the command returns to the original buffer in
6792 which the visibility is still unchanged. After RET is will also jump to
6793 the location selected in the indirect buffer and expose the headline
6794 hierarchy above."
6795 (interactive "P")
6796 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6797 (org-refile-use-outline-path t)
6798 (org-refile-target-verify-function nil)
6799 (interface
6800 (if (not alternative-interface)
6801 org-goto-interface
6802 (if (eq org-goto-interface 'outline)
6803 'outline-path-completion
6804 'outline)))
6805 (org-goto-start-pos (point))
6806 (selected-point
6807 (if (eq interface 'outline)
6808 (car (org-get-location (current-buffer) org-goto-help))
6809 (let ((pa (org-refile-get-location "Goto")))
6810 (org-refile-check-position pa)
6811 (nth 3 pa)))))
6812 (if selected-point
6813 (progn
6814 (org-mark-ring-push org-goto-start-pos)
6815 (goto-char selected-point)
6816 (if (or (outline-invisible-p) (org-invisible-p2))
6817 (org-show-context 'org-goto)))
6818 (message "Quit"))))
6820 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6821 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6822 (defvar org-goto-local-auto-isearch-map) ; defined below
6824 (defun org-get-location (buf help)
6825 "Let the user select a location in the Org-mode buffer BUF.
6826 This function uses a recursive edit. It returns the selected position
6827 or nil."
6828 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6829 (isearch-hide-immediately nil)
6830 (isearch-search-fun-function
6831 (lambda () 'org-goto-local-search-headings))
6832 (org-goto-selected-point org-goto-exit-command)
6833 (pop-up-frames nil)
6834 (special-display-buffer-names nil)
6835 (special-display-regexps nil)
6836 (special-display-function nil))
6837 (save-excursion
6838 (save-window-excursion
6839 (delete-other-windows)
6840 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6841 (org-pop-to-buffer-same-window
6842 (condition-case nil
6843 (make-indirect-buffer (current-buffer) "*org-goto*")
6844 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6845 (with-output-to-temp-buffer "*Help*"
6846 (princ help))
6847 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6848 (setq buffer-read-only nil)
6849 (let ((org-startup-truncated t)
6850 (org-startup-folded nil)
6851 (org-startup-align-all-tables nil))
6852 (org-mode)
6853 (org-overview))
6854 (setq buffer-read-only t)
6855 (if (and (boundp 'org-goto-start-pos)
6856 (integer-or-marker-p org-goto-start-pos))
6857 (let ((org-show-hierarchy-above t)
6858 (org-show-siblings t)
6859 (org-show-following-heading t))
6860 (goto-char org-goto-start-pos)
6861 (and (outline-invisible-p) (org-show-context)))
6862 (goto-char (point-min)))
6863 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6864 (message "Select location and press RET")
6865 (use-local-map org-goto-map)
6866 (recursive-edit)
6867 ))
6868 (kill-buffer "*org-goto*")
6869 (cons org-goto-selected-point org-goto-exit-command)))
6871 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6872 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6873 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6874 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6876 (defun org-goto-local-search-headings (string bound noerror)
6877 "Search and make sure that any matches are in headlines."
6878 (catch 'return
6879 (while (if isearch-forward
6880 (search-forward string bound noerror)
6881 (search-backward string bound noerror))
6882 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6883 (and (member :headline context)
6884 (not (member :tags context))))
6885 (throw 'return (point))))))
6887 (defun org-goto-local-auto-isearch ()
6888 "Start isearch."
6889 (interactive)
6890 (goto-char (point-min))
6891 (let ((keys (this-command-keys)))
6892 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6893 (isearch-mode t)
6894 (isearch-process-search-char (string-to-char keys)))))
6896 (defun org-goto-ret (&optional arg)
6897 "Finish `org-goto' by going to the new location."
6898 (interactive "P")
6899 (setq org-goto-selected-point (point)
6900 org-goto-exit-command 'return)
6901 (throw 'exit nil))
6903 (defun org-goto-left ()
6904 "Finish `org-goto' by going to the new location."
6905 (interactive)
6906 (if (org-at-heading-p)
6907 (progn
6908 (beginning-of-line 1)
6909 (setq org-goto-selected-point (point)
6910 org-goto-exit-command 'left)
6911 (throw 'exit nil))
6912 (error "Not on a heading")))
6914 (defun org-goto-right ()
6915 "Finish `org-goto' by going to the new location."
6916 (interactive)
6917 (if (org-at-heading-p)
6918 (progn
6919 (setq org-goto-selected-point (point)
6920 org-goto-exit-command 'right)
6921 (throw 'exit nil))
6922 (error "Not on a heading")))
6924 (defun org-goto-quit ()
6925 "Finish `org-goto' without cursor motion."
6926 (interactive)
6927 (setq org-goto-selected-point nil)
6928 (setq org-goto-exit-command 'quit)
6929 (throw 'exit nil))
6931 ;;; Indirect buffer display of subtrees
6933 (defvar org-indirect-dedicated-frame nil
6934 "This is the frame being used for indirect tree display.")
6935 (defvar org-last-indirect-buffer nil)
6937 (defun org-tree-to-indirect-buffer (&optional arg)
6938 "Create indirect buffer and narrow it to current subtree.
6939 With numerical prefix ARG, go up to this level and then take that tree.
6940 If ARG is negative, go up that many levels.
6941 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6942 indirect buffer previously made with this command, to avoid proliferation of
6943 indirect buffers. However, when you call the command with a \
6945 when `org-indirect-buffer-display' is `new-frame', the last buffer
6946 is kept so that you can work with several indirect buffers at the same time.
6947 If `org-indirect-buffer-display' is `dedicated-frame', the \
6949 requests that a new frame be made for the new buffer, so that the dedicated
6950 frame is not changed."
6951 (interactive "P")
6952 (let ((cbuf (current-buffer))
6953 (cwin (selected-window))
6954 (pos (point))
6955 beg end level heading ibuf)
6956 (save-excursion
6957 (org-back-to-heading t)
6958 (when (numberp arg)
6959 (setq level (org-outline-level))
6960 (if (< arg 0) (setq arg (+ level arg)))
6961 (while (> (setq level (org-outline-level)) arg)
6962 (outline-up-heading 1 t)))
6963 (setq beg (point)
6964 heading (org-get-heading))
6965 (org-end-of-subtree t t)
6966 (if (org-at-heading-p) (backward-char 1))
6967 (setq end (point)))
6968 (if (and (buffer-live-p org-last-indirect-buffer)
6969 (not (eq org-indirect-buffer-display 'new-frame))
6970 (not arg))
6971 (kill-buffer org-last-indirect-buffer))
6972 (setq ibuf (org-get-indirect-buffer cbuf)
6973 org-last-indirect-buffer ibuf)
6974 (cond
6975 ((or (eq org-indirect-buffer-display 'new-frame)
6976 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6977 (select-frame (make-frame))
6978 (delete-other-windows)
6979 (org-pop-to-buffer-same-window ibuf)
6980 (org-set-frame-title heading))
6981 ((eq org-indirect-buffer-display 'dedicated-frame)
6982 (raise-frame
6983 (select-frame (or (and org-indirect-dedicated-frame
6984 (frame-live-p org-indirect-dedicated-frame)
6985 org-indirect-dedicated-frame)
6986 (setq org-indirect-dedicated-frame (make-frame)))))
6987 (delete-other-windows)
6988 (org-pop-to-buffer-same-window ibuf)
6989 (org-set-frame-title (concat "Indirect: " heading)))
6990 ((eq org-indirect-buffer-display 'current-window)
6991 (org-pop-to-buffer-same-window ibuf))
6992 ((eq org-indirect-buffer-display 'other-window)
6993 (pop-to-buffer ibuf))
6994 (t (error "Invalid value")))
6995 (if (featurep 'xemacs)
6996 (save-excursion (org-mode) (turn-on-font-lock)))
6997 (narrow-to-region beg end)
6998 (show-all)
6999 (goto-char pos)
7000 (run-hook-with-args 'org-cycle-hook 'all)
7001 (and (window-live-p cwin) (select-window cwin))))
7003 (defun org-get-indirect-buffer (&optional buffer)
7004 (setq buffer (or buffer (current-buffer)))
7005 (let ((n 1) (base (buffer-name buffer)) bname)
7006 (while (buffer-live-p
7007 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7008 (setq n (1+ n)))
7009 (condition-case nil
7010 (make-indirect-buffer buffer bname 'clone)
7011 (error (make-indirect-buffer buffer bname)))))
7013 (defun org-set-frame-title (title)
7014 "Set the title of the current frame to the string TITLE."
7015 ;; FIXME: how to name a single frame in XEmacs???
7016 (unless (featurep 'xemacs)
7017 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7019 ;;;; Structure editing
7021 ;;; Inserting headlines
7023 (defun org-previous-line-empty-p ()
7024 (save-excursion
7025 (and (not (bobp))
7026 (or (beginning-of-line 0) t)
7027 (save-match-data
7030 (defun org-insert-heading (&optional force-heading invisible-ok)
7031 "Insert a new heading or item with same depth at point.
7032 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7033 If point is at the beginning of a headline, insert a sibling before the
7034 current headline. If point is not at the beginning, split the line,
7035 create the new headline with the text in the current line after point
7036 \(but see also the variable `org-M-RET-may-split-line').
7038 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7039 This is important for non-interactive uses of the command."
7040 (interactive "P")
7041 (if (or (= (buffer-size) 0)
7042 (and (not (save-excursion
7043 (and (ignore-errors (org-back-to-heading invisible-ok))
7044 (org-at-heading-p))))
7045 (or force-heading (not (org-in-item-p)))))
7046 (progn
7048 (run-hooks 'org-insert-heading-hook))
7049 (when (or force-heading (not (org-insert-item)))
7050 (let* ((empty-line-p nil)
7051 (level nil)
7052 (on-heading (org-at-heading-p))
7053 (head (save-excursion
7054 (condition-case nil
7055 (progn
7056 (org-back-to-heading invisible-ok)
7057 (when (and (not on-heading)
7058 (featurep 'org-inlinetask)
7059 (integerp org-inlinetask-min-level)
7060 (>= (length (match-string 0))
7061 org-inlinetask-min-level))
7062 ;; Find a heading level before the inline task
7063 (while (and (setq level (org-up-heading-safe))
7064 (>= level org-inlinetask-min-level)))
7065 (if (org-at-heading-p)
7066 (org-back-to-heading invisible-ok)
7067 (error "This should not happen")))
7068 (setq empty-line-p (org-previous-line-empty-p))
7069 (match-string 0))
7070 (error "*"))))
7071 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7072 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7073 pos hide-previous previous-pos)
7074 (cond
7075 ((and (org-at-heading-p) (bolp)
7076 (or (bobp)
7077 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7078 ;; insert before the current line
7079 (open-line (if blank 2 1)))
7080 ((and (bolp)
7081 (not org-insert-heading-respect-content)
7082 (or (bobp)
7083 (save-excursion
7084 (backward-char 1) (not (outline-invisible-p)))))
7085 ;; insert right here
7086 nil)
7087 (t
7088 ;; somewhere in the line
7089 (save-excursion
7090 (setq previous-pos (point-at-bol))
7091 (end-of-line)
7092 (setq hide-previous (outline-invisible-p)))
7093 (and org-insert-heading-respect-content (org-show-subtree))
7094 (let ((split
7095 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7096 (save-excursion
7097 (let ((p (point)))
7098 (goto-char (point-at-bol))
7099 (and (looking-at org-complex-heading-regexp)
7100 (match-beginning 4)
7101 (> p (match-beginning 4)))))))
7102 tags pos)
7103 (cond
7104 (org-insert-heading-respect-content
7105 (org-end-of-subtree nil t)
7106 (when (featurep 'org-inlinetask)
7107 (while (and (not (eobp))
7109 (>= (length (match-string 1))
7110 org-inlinetask-min-level))
7111 (org-end-of-subtree nil t)))
7112 (or (bolp) (newline))
7113 (or (org-previous-line-empty-p)
7114 (and blank (newline)))
7115 (open-line 1))
7116 ((org-at-heading-p)
7117 (when hide-previous
7118 (show-children)
7119 (org-show-entry))
7121 (setq tags (and (match-end 2) (match-string 2)))
7122 (and (match-end 1)
7123 (delete-region (match-beginning 1) (match-end 1)))
7124 (setq pos (point-at-bol))
7125 (or split (end-of-line 1))
7126 (delete-horizontal-space)
7128 (buffer-substring (point-at-bol) (point)))
7129 (insert " "))
7130 (newline (if blank 2 1))
7131 (when tags
7132 (save-excursion
7133 (goto-char pos)
7134 (end-of-line 1)
7135 (insert " " tags)
7136 (org-set-tags nil 'align))))
7137 (t
7138 (or split (end-of-line 1))
7139 (newline (if blank 2 1)))))))
7140 (insert head) (just-one-space)
7141 (setq pos (point))
7142 (end-of-line 1)
7143 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7144 (when (and org-insert-heading-respect-content hide-previous)
7145 (save-excursion
7146 (goto-char previous-pos)
7147 (hide-subtree)))
7148 (run-hooks 'org-insert-heading-hook)))))
7150 (defun org-get-heading (&optional no-tags no-todo)
7151 "Return the heading of the current entry, without the stars.
7152 When NO-TAGS is non-nil, don't include tags.
7153 When NO-TODO is non-nil, don't include TODO keywords."
7154 (save-excursion
7155 (org-back-to-heading t)
7156 (cond
7157 ((and no-tags no-todo)
7158 (looking-at org-complex-heading-regexp)
7159 (match-string 4))
7160 (no-tags
7161 (looking-at (concat org-outline-regexp
7164 (match-string 1))
7165 (no-todo
7166 (looking-at org-todo-line-regexp)
7167 (match-string 3))
7168 (t (looking-at org-heading-regexp)
7169 (match-string 2)))))
7171 (defun org-heading-components ()
7172 "Return the components of the current heading.
7173 This is a list with the following elements:
7174 - the level as an integer
7175 - the reduced level, different if `org-odd-levels-only' is set.
7176 - the TODO keyword, or nil
7177 - the priority character, like ?A, or nil if no priority is given
7178 - the headline text itself, or the tags string if no headline text
7179 - the tags string, or nil."
7180 (save-excursion
7181 (org-back-to-heading t)
7182 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7183 (list (length (match-string 1))
7184 (org-reduced-level (length (match-string 1)))
7185 (org-match-string-no-properties 2)
7186 (and (match-end 3) (aref (match-string 3) 2))
7187 (org-match-string-no-properties 4)
7188 (org-match-string-no-properties 5)))))
7190 (defun org-get-entry ()
7191 "Get the entry text, after heading, entire subtree."
7192 (save-excursion
7193 (org-back-to-heading t)
7194 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7196 (defun org-insert-heading-after-current ()
7197 "Insert a new heading with same level as current, after current subtree."
7198 (interactive)
7199 (org-back-to-heading)
7200 (org-insert-heading)
7201 (org-move-subtree-down)
7202 (end-of-line 1))
7204 (defun org-insert-heading-respect-content ()
7205 (interactive)
7206 (let ((org-insert-heading-respect-content t))
7207 (org-insert-heading t)))
7209 (defun org-insert-todo-heading-respect-content (&optional force-state)
7210 (interactive "P")
7211 (let ((org-insert-heading-respect-content t))
7212 (org-insert-todo-heading force-state t)))
7214 (defun org-insert-todo-heading (arg &optional force-heading)
7215 "Insert a new heading with the same level and TODO state as current heading.
7216 If the heading has no TODO state, or if the state is DONE, use the first
7217 state (TODO by default). Also with prefix arg, force first state."
7218 (interactive "P")
7219 (when (or force-heading (not (org-insert-item 'checkbox)))
7220 (org-insert-heading force-heading)
7221 (save-excursion
7222 (org-back-to-heading)
7223 (outline-previous-heading)
7224 (looking-at org-todo-line-regexp))
7225 (let*
7226 ((new-mark-x
7227 (if (or arg
7228 (not (match-beginning 2))
7229 (member (match-string 2) org-done-keywords))
7230 (car org-todo-keywords-1)
7231 (match-string 2)))
7232 (new-mark
7233 (or
7234 (run-hook-with-args-until-success
7235 'org-todo-get-default-hook new-mark-x nil)
7236 new-mark-x)))
7237 (beginning-of-line 1)
7238 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7239 (if org-treat-insert-todo-heading-as-state-change
7240 (org-todo new-mark)
7241 (insert new-mark " "))))
7242 (when org-provide-todo-statistics
7243 (org-update-parent-todo-statistics))))
7245 (defun org-insert-subheading (arg)
7246 "Insert a new subheading and demote it.
7247 Works for outline headings and for plain lists alike."
7248 (interactive "P")
7249 (org-insert-heading arg)
7250 (cond
7251 ((org-at-heading-p) (org-do-demote))
7252 ((org-at-item-p) (org-indent-item))))
7254 (defun org-insert-todo-subheading (arg)
7255 "Insert a new subheading with TODO keyword or checkbox and demote it.
7256 Works for outline headings and for plain lists alike."
7257 (interactive "P")
7258 (org-insert-todo-heading arg)
7259 (cond
7260 ((org-at-heading-p) (org-do-demote))
7261 ((org-at-item-p) (org-indent-item))))
7263 ;;; Promotion and Demotion
7265 (defvar org-after-demote-entry-hook nil
7266 "Hook run after an entry has been demoted.
7267 The cursor will be at the beginning of the entry.
7268 When a subtree is being demoted, the hook will be called for each node.")
7270 (defvar org-after-promote-entry-hook nil
7271 "Hook run after an entry has been promoted.
7272 The cursor will be at the beginning of the entry.
7273 When a subtree is being promoted, the hook will be called for each node.")
7275 (defun org-promote-subtree ()
7276 "Promote the entire subtree.
7277 See also `org-promote'."
7278 (interactive)
7279 (save-excursion
7280 (org-with-limited-levels (org-map-tree 'org-promote)))
7281 (org-fix-position-after-promote))
7283 (defun org-demote-subtree ()
7284 "Demote the entire subtree. See `org-demote'.
7285 See also `org-promote'."
7286 (interactive)
7287 (save-excursion
7288 (org-with-limited-levels (org-map-tree 'org-demote)))
7289 (org-fix-position-after-promote))
7292 (defun org-do-promote ()
7293 "Promote the current heading higher up the tree.
7294 If the region is active in `transient-mark-mode', promote all headings
7295 in the region."
7296 (interactive)
7297 (save-excursion
7298 (if (org-region-active-p)
7299 (org-map-region 'org-promote (region-beginning) (region-end))
7300 (org-promote)))
7301 (org-fix-position-after-promote))
7303 (defun org-do-demote ()
7304 "Demote the current heading lower down the tree.
7305 If the region is active in `transient-mark-mode', demote all headings
7306 in the region."
7307 (interactive)
7308 (save-excursion
7309 (if (org-region-active-p)
7310 (org-map-region 'org-demote (region-beginning) (region-end))
7311 (org-demote)))
7312 (org-fix-position-after-promote))
7314 (defun org-fix-position-after-promote ()
7315 "Make sure that after pro/demotion cursor position is right."
7316 (let ((pos (point)))
7317 (when (save-excursion
7318 (beginning-of-line 1)
7319 (looking-at org-todo-line-regexp)
7320 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7321 (cond ((eobp) (insert " "))
7322 ((eolp) (insert " "))
7323 ((equal (char-after) ?\ ) (forward-char 1))))))
7325 (defun org-current-level ()
7326 "Return the level of the current entry, or nil if before the first headline.
7327 The level is the number of stars at the beginning of the headline."
7328 (save-excursion
7329 (org-with-limited-levels
7330 (if (ignore-errors (org-back-to-heading t))
7331 (funcall outline-level)))))
7333 (defun org-get-previous-line-level ()
7334 "Return the outline depth of the last headline before the current line.
7335 Returns 0 for the first headline in the buffer, and nil if before the
7336 first headline."
7337 (let ((current-level (org-current-level))
7338 (prev-level (when (> (line-number-at-pos) 1)
7339 (save-excursion
7340 (beginning-of-line 0)
7341 (org-current-level)))))
7342 (cond ((null current-level) nil) ; Before first headline
7343 ((null prev-level) 0) ; At first headline
7344 (prev-level))))
7346 (defun org-reduced-level (l)
7347 "Compute the effective level of a heading.
7348 This takes into account the setting of `org-odd-levels-only'."
7349 (cond
7350 ((zerop l) 0)
7351 (org-odd-levels-only (1+ (floor (/ l 2))))
7352 (t l)))
7354 (defun org-level-increment ()
7355 "Return the number of stars that will be added or removed at a
7356 time to headlines when structure editing, based on the value of
7357 `org-odd-levels-only'."
7358 (if org-odd-levels-only 2 1))
7360 (defun org-get-valid-level (level &optional change)
7361 "Rectify a level change under the influence of `org-odd-levels-only'
7362 LEVEL is a current level, CHANGE is by how much the level should be
7363 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7364 even level numbers will become the next higher odd number."
7365 (if org-odd-levels-only
7366 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7367 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7368 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7369 (max 1 (+ level (or change 0)))))
7371 (if (boundp 'define-obsolete-function-alias)
7372 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7373 (define-obsolete-function-alias 'org-get-legal-level
7374 'org-get-valid-level)
7375 (define-obsolete-function-alias 'org-get-legal-level
7376 'org-get-valid-level "23.1")))
7378 (defun org-promote ()
7379 "Promote the current heading higher up the tree.
7380 If the region is active in `transient-mark-mode', promote all headings
7381 in the region."
7382 (org-back-to-heading t)
7383 (let* ((level (save-match-data (funcall outline-level)))
7384 (after-change-functions (remove 'flyspell-after-change-function
7385 after-change-functions))
7386 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7387 (diff (abs (- level (length up-head) -1))))
7388 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7389 (replace-match up-head nil t)
7390 ;; Fixup tag positioning
7391 (and org-auto-align-tags (org-set-tags nil t))
7392 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7393 (run-hooks 'org-after-promote-entry-hook)))
7395 (defun org-demote ()
7396 "Demote the current heading lower down the tree.
7397 If the region is active in `transient-mark-mode', demote all headings
7398 in the region."
7399 (org-back-to-heading t)
7400 (let* ((level (save-match-data (funcall outline-level)))
7401 (after-change-functions (remove 'flyspell-after-change-function
7402 after-change-functions))
7403 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7404 (diff (abs (- level (length down-head) -1))))
7405 (replace-match down-head nil t)
7406 ;; Fixup tag positioning
7407 (and org-auto-align-tags (org-set-tags nil t))
7408 (if org-adapt-indentation (org-fixup-indentation diff))
7409 (run-hooks 'org-after-demote-entry-hook)))
7411 (defun org-cycle-level ()
7412 "Cycle the level of an empty headline through possible states.
7413 This goes first to child, then to parent, level, then up the hierarchy.
7414 After top level, it switches back to sibling level."
7415 (interactive)
7416 (let ((org-adapt-indentation nil))
7417 (when (org-point-at-end-of-empty-headline)
7418 (setq this-command 'org-cycle-level) ; Only needed for caching
7419 (let ((cur-level (org-current-level))
7420 (prev-level (org-get-previous-line-level)))
7421 (cond
7422 ;; If first headline in file, promote to top-level.
7423 ((= prev-level 0)
7424 (loop repeat (/ (- cur-level 1) (org-level-increment))
7425 do (org-do-promote)))
7426 ;; If same level as prev, demote one.
7427 ((= prev-level cur-level)
7428 (org-do-demote))
7429 ;; If parent is top-level, promote to top level if not already.
7430 ((= prev-level 1)
7431 (loop repeat (/ (- cur-level 1) (org-level-increment))
7432 do (org-do-promote)))
7433 ;; If top-level, return to prev-level.
7434 ((= cur-level 1)
7435 (loop repeat (/ (- prev-level 1) (org-level-increment))
7436 do (org-do-demote)))
7437 ;; If less than prev-level, promote one.
7438 ((< cur-level prev-level)
7439 (org-do-promote))
7440 ;; If deeper than prev-level, promote until higher than
7441 ;; prev-level.
7442 ((> cur-level prev-level)
7443 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7444 do (org-do-promote))))
7445 t))))
7447 (defun org-map-tree (fun)
7448 "Call FUN for every heading underneath the current one."
7449 (org-back-to-heading)
7450 (let ((level (funcall outline-level)))
7451 (save-excursion
7452 (funcall fun)
7453 (while (and (progn
7454 (outline-next-heading)
7455 (> (funcall outline-level) level))
7456 (not (eobp)))
7457 (funcall fun)))))
7459 (defun org-map-region (fun beg end)
7460 "Call FUN for every heading between BEG and END."
7461 (let ((org-ignore-region t))
7462 (save-excursion
7463 (setq end (copy-marker end))
7464 (goto-char beg)
7465 (if (and (re-search-forward org-outline-regexp-bol nil t)
7466 (< (point) end))
7467 (funcall fun))
7468 (while (and (progn
7469 (outline-next-heading)
7470 (< (point) end))
7471 (not (eobp)))
7472 (funcall fun)))))
7474 (defvar org-property-end-re) ; silence byte-compiler
7475 (defun org-fixup-indentation (diff)
7476 "Change the indentation in the current entry by DIFF.
7477 However, if any line in the current entry has no indentation, or if it
7478 would end up with no indentation after the change, nothing at all is done."
7479 (save-excursion
7480 (let ((end (save-excursion (outline-next-heading)
7481 (point-marker)))
7482 (prohibit (if (> diff 0)
7485 col)
7486 (unless (save-excursion (end-of-line 1)
7487 (re-search-forward prohibit end t))
7488 (while (and (< (point) end)
7490 (goto-char (match-end 0))
7491 (setq col (current-column))
7492 (if (< diff 0) (replace-match ""))
7493 (org-indent-to-column (+ diff col))))
7494 (move-marker end nil))))
7496 (defun org-convert-to-odd-levels ()
7497 "Convert an org-mode file with all levels allowed to one with odd levels.
7498 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7499 level 5 etc."
7500 (interactive)
7501 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7502 (let ((outline-level 'org-outline-level)
7503 (org-odd-levels-only nil) n)
7504 (save-excursion
7505 (goto-char (point-min))
7507 (setq n (- (length (match-string 0)) 2))
7508 (while (>= (setq n (1- n)) 0)
7509 (org-demote))
7510 (end-of-line 1))))))
7512 (defun org-convert-to-oddeven-levels ()
7513 "Convert an org-mode file with only odd levels to one with odd/even levels.
7514 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7515 file contains a section with an even level, conversion would
7516 destroy the structure of the file. An error is signaled in this
7517 case."
7518 (interactive)
7519 (goto-char (point-min))
7520 ;; First check if there are no even levels
7522 (org-show-context t)
7523 (error "Not all levels are odd in this file. Conversion not possible"))
7524 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7525 (let ((outline-regexp org-outline-regexp)
7526 (outline-level 'org-outline-level)
7527 (org-odd-levels-only nil) n)
7528 (save-excursion
7529 (goto-char (point-min))
7531 (setq n (/ (1- (length (match-string 0))) 2))
7532 (while (>= (setq n (1- n)) 0)
7533 (org-promote))
7534 (end-of-line 1))))))
7536 (defun org-tr-level (n)
7537 "Make N odd if required."
7538 (if org-odd-levels-only (1+ (/ n 2)) n))
7540 ;;; Vertical tree motion, cutting and pasting of subtrees
7542 (defun org-move-subtree-up (&optional arg)
7543 "Move the current subtree up past ARG headlines of the same level."
7544 (interactive "p")
7545 (org-move-subtree-down (- (prefix-numeric-value arg))))
7547 (defun org-move-subtree-down (&optional arg)
7548 "Move the current subtree down past ARG headlines of the same level."
7549 (interactive "p")
7550 (setq arg (prefix-numeric-value arg))
7551 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7552 'org-get-last-sibling))
7553 (ins-point (make-marker))
7554 (cnt (abs arg))
7555 (col (current-column))
7556 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7557 ;; Select the tree
7558 (org-back-to-heading)
7559 (setq beg0 (point))
7560 (save-excursion
7561 (setq ne-beg (org-back-over-empty-lines))
7562 (setq beg (point)))
7563 (save-match-data
7564 (save-excursion (outline-end-of-heading)
7565 (setq folded (outline-invisible-p)))
7566 (outline-end-of-subtree))
7567 (outline-next-heading)
7568 (setq ne-end (org-back-over-empty-lines))
7569 (setq end (point))
7570 (goto-char beg0)
7571 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7572 ;; include less whitespace
7573 (save-excursion
7574 (goto-char beg)
7575 (forward-line (- ne-beg ne-end))
7576 (setq beg (point))))
7577 ;; Find insertion point, with error handling
7578 (while (> cnt 0)
7579 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7580 (progn (goto-char beg0)
7581 (error "Cannot move past superior level or buffer limit")))
7582 (setq cnt (1- cnt)))
7583 (if (> arg 0)
7584 ;; Moving forward - still need to move over subtree
7585 (progn (org-end-of-subtree t t)
7586 (save-excursion
7587 (org-back-over-empty-lines)
7588 (or (bolp) (newline)))))
7589 (setq ne-ins (org-back-over-empty-lines))
7590 (move-marker ins-point (point))
7591 (setq txt (buffer-substring beg end))
7592 (org-save-markers-in-region beg end)
7593 (delete-region beg end)
7594 (org-remove-empty-overlays-at beg)
7595 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7596 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7598 (let ((bbb (point)))
7599 (insert-before-markers txt)
7600 (org-reinstall-markers-in-region bbb)
7601 (move-marker ins-point bbb))
7603 (setq ins-end (point))
7604 (goto-char ins-point)
7605 (org-skip-whitespace)
7606 (when (and (< arg 0)
7607 (org-first-sibling-p)
7608 (> ne-ins ne-beg))
7609 ;; Move whitespace back to beginning
7610 (save-excursion
7611 (goto-char ins-end)
7612 (let ((kill-whole-line t))
7613 (kill-line (- ne-ins ne-beg)) (point)))
7615 (move-marker ins-point nil)
7616 (if folded
7617 (hide-subtree)
7618 (org-show-entry)
7619 (show-children)
7620 (org-cycle-hide-drawers 'children))
7621 (org-clean-visibility-after-subtree-move)
7622 ;; move back to the initial column we were at
7623 (move-to-column col)))
7625 (defvar org-subtree-clip ""
7626 "Clipboard for cut and paste of subtrees.
7627 This is actually only a copy of the kill, because we use the normal kill
7628 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7630 (defvar org-subtree-clip-folded nil
7631 "Was the last copied subtree folded?
7632 This is used to fold the tree back after pasting.")
7634 (defun org-cut-subtree (&optional n)
7635 "Cut the current subtree into the clipboard.
7636 With prefix arg N, cut this many sequential subtrees.
7637 This is a short-hand for marking the subtree and then cutting it."
7638 (interactive "p")
7639 (org-copy-subtree n 'cut))
7641 (defun org-copy-subtree (&optional n cut force-store-markers)
7642 "Cut the current subtree into the clipboard.
7643 With prefix arg N, cut this many sequential subtrees.
7644 This is a short-hand for marking the subtree and then copying it.
7645 If CUT is non-nil, actually cut the subtree.
7646 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7647 of some markers in the region, even if CUT is non-nil. This is
7648 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7649 (interactive "p")
7650 (let (beg end folded (beg0 (point)))
7651 (if (org-called-interactively-p 'any)
7652 (org-back-to-heading nil) ; take what looks like a subtree
7653 (org-back-to-heading t)) ; take what is really there
7654 (org-back-over-empty-lines)
7655 (setq beg (point))
7657 (save-match-data
7658 (save-excursion (outline-end-of-heading)
7659 (setq folded (outline-invisible-p)))
7660 (condition-case nil
7661 (org-forward-same-level (1- n) t)
7662 (error nil))
7663 (org-end-of-subtree t t))
7664 (org-back-over-empty-lines)
7665 (setq end (point))
7666 (goto-char beg0)
7667 (when (> end beg)
7668 (setq org-subtree-clip-folded folded)
7669 (when (or cut force-store-markers)
7670 (org-save-markers-in-region beg end))
7671 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7672 (setq org-subtree-clip (current-kill 0))
7673 (message "%s: Subtree(s) with %d characters"
7674 (if cut "Cut" "Copied")
7675 (length org-subtree-clip)))))
7677 (defun org-paste-subtree (&optional level tree for-yank)
7678 "Paste the clipboard as a subtree, with modification of headline level.
7679 The entire subtree is promoted or demoted in order to match a new headline
7680 level.
7682 If the cursor is at the beginning of a headline, the same level as
7683 that headline is used to paste the tree
7685 If not, the new level is derived from the *visible* headings
7686 before and after the insertion point, and taken to be the inferior headline
7687 level of the two. So if the previous visible heading is level 3 and the
7688 next is level 4 (or vice versa), level 4 will be used for insertion.
7689 This makes sure that the subtree remains an independent subtree and does
7690 not swallow low level entries.
7692 You can also force a different level, either by using a numeric prefix
7693 argument, or by inserting the heading marker by hand. For example, if the
7696 If optional TREE is given, use this text instead of the kill ring.
7698 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7699 move back over whitespace before inserting, and move point to the end of
7700 the inserted text when done."
7701 (interactive "P")
7702 (setq tree (or tree (and kill-ring (current-kill 0))))
7703 (unless (org-kill-is-subtree-p tree)
7704 (error "%s"
7705 (substitute-command-keys
7707 (org-with-limited-levels
7708 (let* ((visp (not (outline-invisible-p)))
7709 (txt tree)
7711 (old-level (if (string-match org-outline-regexp-bol txt)
7712 (- (match-end 0) (match-beginning 0) 1)
7713 -1))
7714 (force-level (cond (level (prefix-numeric-value level))
7716 (string-match
7718 (point-at-bol) (point))))
7719 (- (match-end 1) (match-beginning 1)))
7720 ((and (bolp)
7721 (looking-at org-outline-regexp))
7722 (- (match-end 0) (point) 1))
7723 (t nil)))
7724 (previous-level (save-excursion
7725 (condition-case nil
7726 (progn
7727 (outline-previous-visible-heading 1)
7728 (if (looking-at ^re_)
7729 (- (match-end 0) (match-beginning 0) 1)
7730 1))
7731 (error 1))))
7732 (next-level (save-excursion
7733 (condition-case nil
7734 (progn
7735 (or (looking-at org-outline-regexp)
7736 (outline-next-visible-heading 1))
7737 (if (looking-at ^re_)
7738 (- (match-end 0) (match-beginning 0) 1)
7739 1))
7740 (error 1))))
7741 (new-level (or force-level (max previous-level next-level)))
7742 (shift (if (or (= old-level -1)
7743 (= new-level -1)
7744 (= old-level new-level))
7745 0
7746 (- new-level old-level)))
7747 (delta (if (> shift 0) -1 1))
7748 (func (if (> shift 0) 'org-demote 'org-promote))
7749 (org-odd-levels-only nil)
7750 beg end newend)
7751 ;; Remove the forced level indicator
7752 (if force-level
7753 (delete-region (point-at-bol) (point)))
7754 ;; Paste
7755 (beginning-of-line (if (bolp) 1 2))
7756 (unless for-yank (org-back-over-empty-lines))
7757 (setq beg (point))
7758 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7759 (insert-before-markers txt)
7761 (setq newend (point))
7762 (org-reinstall-markers-in-region beg)
7763 (setq end (point))
7764 (goto-char beg)
7766 (setq beg (point))
7767 (if (and (outline-invisible-p) visp)
7768 (save-excursion (outline-show-heading)))
7769 ;; Shift if necessary
7770 (unless (= shift 0)
7771 (save-restriction
7772 (narrow-to-region beg end)
7773 (while (not (= shift 0))
7774 (org-map-region func (point-min) (point-max))
7775 (setq shift (+ delta shift)))
7776 (goto-char (point-min))
7777 (setq newend (point-max))))
7778 (when (or (org-called-interactively-p 'interactive) for-yank)
7779 (message "Clipboard pasted as level %d subtree" new-level))
7780 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7781 kill-ring
7782 (eq org-subtree-clip (current-kill 0))
7783 org-subtree-clip-folded)
7784 ;; The tree was folded before it was killed/copied
7785 (hide-subtree))
7786 (and for-yank (goto-char newend)))))
7788 (defun org-kill-is-subtree-p (&optional txt)
7789 "Check if the current kill is an outline subtree, or a set of trees.
7790 Returns nil if kill does not start with a headline, or if the first
7791 headline level is not the largest headline level in the tree.
7792 So this will actually accept several entries of equal levels as well,
7793 which is OK for `org-paste-subtree'.
7794 If optional TXT is given, check this string instead of the current kill."
7795 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7796 (re (org-get-limited-outline-regexp))
7797 (^re (concat "^" re))
7798 (start-level (and kill
7799 (string-match
7801 kill)
7802 (- (match-end 2) (match-beginning 2) 1)))
7803 (start (1+ (or (match-beginning 2) -1))))
7804 (if (not start-level)
7805 (progn
7806 nil) ;; does not even start with a heading
7807 (catch 'exit
7808 (while (setq start (string-match ^re kill (1+ start)))
7809 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7810 (throw 'exit nil)))
7811 t))))
7813 (defvar org-markers-to-move nil
7814 "Markers that should be moved with a cut-and-paste operation.
7815 Those markers are stored together with their positions relative to
7816 the start of the region.")
7818 (defun org-save-markers-in-region (beg end)
7819 "Check markers in region.
7820 If these markers are between BEG and END, record their position relative
7821 to BEG, so that after moving the block of text, we can put the markers back
7822 into place.
7823 This function gets called just before an entry or tree gets cut from the
7824 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7825 called immediately, to move the markers with the entries."
7826 (setq org-markers-to-move nil)
7827 (when (featurep 'org-clock)
7828 (org-clock-save-markers-for-cut-and-paste beg end))
7829 (when (featurep 'org-agenda)
7830 (org-agenda-save-markers-for-cut-and-paste beg end)))
7832 (defun org-check-and-save-marker (marker beg end)
7833 "Check if MARKER is between BEG and END.
7834 If yes, remember the marker and the distance to BEG."
7835 (when (and (marker-buffer marker)
7836 (equal (marker-buffer marker) (current-buffer)))
7837 (if (and (>= marker beg) (< marker end))
7838 (push (cons marker (- marker beg)) org-markers-to-move))))
7840 (defun org-reinstall-markers-in-region (beg)
7841 "Move all remembered markers to their position relative to BEG."
7842 (mapc (lambda (x)
7843 (move-marker (car x) (+ beg (cdr x))))
7844 org-markers-to-move)
7845 (setq org-markers-to-move nil))
7847 (defun org-narrow-to-subtree ()
7848 "Narrow buffer to the current subtree."
7849 (interactive)
7850 (save-excursion
7851 (save-match-data
7852 (org-with-limited-levels
7853 (narrow-to-region
7854 (progn (org-back-to-heading t) (point))
7855 (progn (org-end-of-subtree t t)
7856 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7857 (point)))))))
7859 (defun org-narrow-to-block ()
7860 "Narrow buffer to the current block."
7861 (interactive)
7862 (let* ((case-fold-search t)
7865 (if blockp
7866 (narrow-to-region (car blockp) (cdr blockp))
7867 (error "Not in a block"))))
7869 (eval-when-compile
7870 (defvar org-property-drawer-re))
7872 (defvar org-property-start-re) ;; defined below
7873 (defun org-clone-subtree-with-time-shift (n &optional shift)
7874 "Clone the task (subtree) at point N times.
7875 The clones will be inserted as siblings.
7877 In interactive use, the user will be prompted for the number of
7878 clones to be produced, and for a time SHIFT, which may be a
7879 repeater as used in time stamps, for example `+3d'.
7881 When a valid repeater is given and the entry contains any time
7882 stamps, the clones will become a sequence in time, with time
7883 stamps in the subtree shifted for each clone produced. If SHIFT
7884 is nil or the empty string, time stamps will be left alone. The
7885 ID property of the original subtree is removed.
7887 If the original subtree did contain time stamps with a repeater,
7888 the following will happen:
7889 - the repeater will be removed in each clone
7890 - an additional clone will be produced, with the current, unshifted
7891 date(s) in the entry.
7892 - the original entry will be placed *after* all the clones, with
7893 repeater intact.
7894 - the start days in the repeater in the original entry will be shifted
7895 to past the last clone.
7896 I this way you can spell out a number of instances of a repeating task,
7897 and still retain the repeater to cover future instances of the task."
7898 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7899 (let (beg end template task idprop
7900 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7901 (drawer-re org-drawer-regexp))
7902 (if (not (and (integerp n) (> n 0)))
7903 (error "Invalid number of replications %s" n))
7906 shift)))
7907 (error "Invalid shift specification %s" shift))
7908 (when doshift
7909 (setq shift-n (string-to-number (match-string 1 shift))
7910 shift-what (cdr (assoc (match-string 2 shift)
7911 '(("d" . day) ("w" . week)
7912 ("m" . month) ("y" . year))))))
7913 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7914 (setq nmin 1 nmax n)
7915 (org-back-to-heading t)
7916 (setq beg (point))
7917 (setq idprop (org-entry-get nil "ID"))
7918 (org-end-of-subtree t t)
7920 (setq end (point))
7921 (setq template (buffer-substring beg end))
7922 (when (and doshift
7924 (delete-region beg end)
7925 (setq end beg)
7926 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7927 (goto-char end)
7928 (loop for n from nmin to nmax do
7929 ;; prepare clone
7930 (with-temp-buffer
7931 (insert template)
7932 (org-mode)
7933 (goto-char (point-min))
7934 (org-show-subtree)
7935 (and idprop (if org-clone-delete-id
7936 (org-entry-delete nil "ID")
7937 (org-id-get-create t)))
7938 (unless (= n 0)
7940 (kill-whole-line))
7941 (goto-char (point-min))
7942 (while (re-search-forward drawer-re nil t)
7943 (mapc (lambda (d)
7944 (org-remove-empty-drawer-at d (point))) org-drawers)))
7945 (goto-char (point-min))
7946 (when doshift
7947 (while (re-search-forward org-ts-regexp-both nil t)
7948 (org-timestamp-change (* n shift-n) shift-what))
7949 (unless (= n n-no-remove)
7950 (goto-char (point-min))
7951 (while (re-search-forward org-ts-regexp nil t)
7952 (save-excursion
7953 (goto-char (match-beginning 0))
7955 (delete-region (match-beginning 1) (match-end 1)))))))
7956 (setq task (buffer-string)))
7957 (insert task))
7958 (goto-char beg)))
7960 ;;; Outline Sorting
7962 (defun org-sort (with-case)
7963 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7964 Optional argument WITH-CASE means sort case-sensitively."
7965 (interactive "P")
7966 (cond
7967 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7968 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7969 (t
7970 (org-call-with-arg 'org-sort-entries with-case))))
7972 (defun org-sort-remove-invisible (s)
7973 (remove-text-properties 0 (length s) org-rm-props s)
7974 (while (string-match org-bracket-link-regexp s)
7975 (setq s (replace-match (if (match-end 2)
7976 (match-string 3 s)
7977 (match-string 1 s)) t t s)))
7978 s)
7980 (defvar org-priority-regexp) ; defined later in the file
7982 (defvar org-after-sorting-entries-or-items-hook nil
7983 "Hook that is run after a bunch of entries or items have been sorted.
7984 When children are sorted, the cursor is in the parent line when this
7985 hook gets called. When a region or a plain list is sorted, the cursor
7986 will be in the first entry of the sorted region/list.")
7988 (defun org-sort-entries
7989 (&optional with-case sorting-type getkey-func compare-func property)
7990 "Sort entries on a certain level of an outline tree.
7991 If there is an active region, the entries in the region are sorted.
7992 Else, if the cursor is before the first entry, sort the top-level items.
7993 Else, the children of the entry at point are sorted.
7995 Sorting can be alphabetically, numerically, by date/time as given by
7996 a time stamp, by a property or by priority.
7998 The command prompts for the sorting type unless it has been given to the
7999 function through the SORTING-TYPE argument, which needs to be a character,
8000 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8001 precise meaning of each character:
8003 n Numerically, by converting the beginning of the entry/item to a number.
8004 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8005 t By date/time, either the first active time stamp in the entry, or, if
8006 none exist, by the first inactive one.
8007 s By the scheduled date/time.
8008 d By deadline date/time.
8009 c By creation time, which is assumed to be the first inactive time stamp
8010 at the beginning of a line.
8011 p By priority according to the cookie.
8012 r By the value of a property.
8014 Capital letters will reverse the sort order.
8016 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8017 called with point at the beginning of the record. It must return either
8018 a string or a number that should serve as the sorting key for that record.
8020 Comparing entries ignores case by default. However, with an optional argument
8021 WITH-CASE, the sorting considers case as well."
8022 (interactive "P")
8023 (let ((case-func (if with-case 'identity 'downcase))
8024 start beg end stars re re2
8025 txt what tmp)
8026 ;; Find beginning and end of region to sort
8027 (cond
8028 ((org-region-active-p)
8029 ;; we will sort the region
8030 (setq end (region-end)
8031 what "region")
8032 (goto-char (region-beginning))
8033 (if (not (org-at-heading-p)) (outline-next-heading))
8034 (setq start (point)))
8035 ((or (org-at-heading-p)
8036 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8037 ;; we will sort the children of the current headline
8038 (org-back-to-heading)
8039 (setq start (point)
8040 end (progn (org-end-of-subtree t t)
8042 (org-back-over-empty-lines)
8043 (point))
8044 what "children")
8045 (goto-char start)
8046 (show-subtree)
8047 (outline-next-heading))
8048 (t
8049 ;; we will sort the top-level entries in this file
8050 (goto-char (point-min))
8051 (or (org-at-heading-p) (outline-next-heading))
8052 (setq start (point))
8053 (goto-char (point-max))
8054 (beginning-of-line 1)
8056 ;; File ends in a non-white line
8057 (end-of-line 1)
8059 (setq end (point-max))
8060 (setq what "top-level")
8061 (goto-char start)
8062 (show-all)))
8064 (setq beg (point))
8065 (if (>= beg end) (error "Nothing to sort"))
8068 (setq stars (match-string 1)
8069 re (concat "^" (regexp-quote stars) " +")
8071 txt (buffer-substring beg end))
8073 (if (and (not (equal stars "*")) (string-match re2 txt))
8074 (error "Region to sort contains a level above the first entry"))
8076 (unless sorting-type
8077 (message
8078 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8080 A/N/T/S/D/C/P/O/F means reversed:"
8081 what)
8082 (setq sorting-type (read-char-exclusive))
8084 (and (= (downcase sorting-type) ?f)
8085 (setq getkey-func
8086 (org-icompleting-read "Sort using function: "
8087 obarray 'fboundp t nil nil))
8088 (setq getkey-func (intern getkey-func)))
8090 (and (= (downcase sorting-type) ?r)
8091 (setq property
8092 (org-icompleting-read "Property: "
8093 (mapcar 'list (org-buffer-property-keys t))
8094 nil t))))
8096 (message "Sorting entries...")
8098 (save-restriction
8099 (narrow-to-region start end)
8100 (let ((dcst (downcase sorting-type))
8101 (case-fold-search nil)
8102 (now (current-time)))
8103 (sort-subr
8104 (/= dcst sorting-type)
8105 ;; This function moves to the beginning character of the "record" to
8106 ;; be sorted.
8107 (lambda nil
8108 (if (re-search-forward re nil t)
8109 (goto-char (match-beginning 0))
8110 (goto-char (point-max))))
8111 ;; This function moves to the last character of the "record" being
8112 ;; sorted.
8113 (lambda nil
8114 (save-match-data
8115 (condition-case nil
8116 (outline-forward-same-level 1)
8117 (error
8118 (goto-char (point-max))))))
8119 ;; This function returns the value that gets sorted against.
8120 (lambda nil
8121 (cond
8122 ((= dcst ?n)
8123 (if (looking-at org-complex-heading-regexp)
8124 (string-to-number (match-string 4))
8125 nil))
8126 ((= dcst ?a)
8127 (if (looking-at org-complex-heading-regexp)
8128 (funcall case-func (match-string 4))
8129 nil))
8130 ((= dcst ?t)
8131 (let ((end (save-excursion (outline-next-heading) (point))))
8132 (if (or (re-search-forward org-ts-regexp end t)
8133 (re-search-forward org-ts-regexp-both end t))
8134 (org-time-string-to-seconds (match-string 0))
8135 (org-float-time now))))
8136 ((= dcst ?c)
8137 (let ((end (save-excursion (outline-next-heading) (point))))
8138 (if (re-search-forward
8140 end t)
8141 (org-time-string-to-seconds (match-string 0))
8142 (org-float-time now))))
8143 ((= dcst ?s)
8144 (let ((end (save-excursion (outline-next-heading) (point))))
8145 (if (re-search-forward org-scheduled-time-regexp end t)
8146 (org-time-string-to-seconds (match-string 1))
8147 (org-float-time now))))
8148 ((= dcst ?d)
8149 (let ((end (save-excursion (outline-next-heading) (point))))
8150 (if (re-search-forward org-deadline-time-regexp end t)
8151 (org-time-string-to-seconds (match-string 1))
8152 (org-float-time now))))
8153 ((= dcst ?p)
8154 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8155 (string-to-char (match-string 2))
8156 org-default-priority))
8157 ((= dcst ?r)
8158 (or (org-entry-get nil property) ""))
8159 ((= dcst ?o)
8160 (if (looking-at org-complex-heading-regexp)
8161 (- 9999 (length (member (match-string 2)
8162 org-todo-keywords-1)))))
8163 ((= dcst ?f)
8164 (if getkey-func
8165 (progn
8166 (setq tmp (funcall getkey-func))
8167 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8168 tmp)
8169 (error "Invalid key function `%s'" getkey-func)))
8170 (t (error "Invalid sorting type `%c'" sorting-type))))
8171 nil
8172 (cond
8173 ((= dcst ?a) 'string<)
8174 ((= dcst ?f) compare-func)
8175 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8176 (t nil)))))
8177 (run-hooks 'org-after-sorting-entries-or-items-hook)
8178 (message "Sorting entries...done")))
8180 (defun org-do-sort (table what &optional with-case sorting-type)
8181 "Sort TABLE of WHAT according to SORTING-TYPE.
8182 The user will be prompted for the SORTING-TYPE if the call to this
8183 function does not specify it. WHAT is only for the prompt, to indicate
8184 what is being sorted. The sorting key will be extracted from
8185 the car of the elements of the table.
8186 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8187 (unless sorting-type
8188 (message
8189 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8190 what)
8191 (setq sorting-type (read-char-exclusive)))
8192 (let ((dcst (downcase sorting-type))
8193 extractfun comparefun)
8194 ;; Define the appropriate functions
8195 (cond
8196 ((= dcst ?n)
8197 (setq extractfun 'string-to-number
8198 comparefun (if (= dcst sorting-type) '< '>)))
8199 ((= dcst ?a)
8200 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8201 (lambda(x) (downcase (org-sort-remove-invisible x))))
8202 comparefun (if (= dcst sorting-type)
8203 'string<
8204 (lambda (a b) (and (not (string< a b))
8205 (not (string= a b)))))))
8206 ((= dcst ?t)
8207 (setq extractfun
8208 (lambda (x)
8209 (if (or (string-match org-ts-regexp x)
8210 (string-match org-ts-regexp-both x))
8211 (org-float-time
8212 (org-time-string-to-time (match-string 0 x)))
8213 0))
8214 comparefun (if (= dcst sorting-type) '< '>)))
8215 (t (error "Invalid sorting type `%c'" sorting-type)))
8217 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8218 table)
8219 (lambda (a b) (funcall comparefun (car a) (car b))))))
8222 ;;; The orgstruct minor mode
8224 ;; Define a minor mode which can be used in other modes in order to
8225 ;; integrate the org-mode structure editing commands.
8227 ;; This is really a hack, because the org-mode structure commands use
8228 ;; keys which normally belong to the major mode. Here is how it
8229 ;; works: The minor mode defines all the keys necessary to operate the
8230 ;; structure commands, but wraps the commands into a function which
8231 ;; tests if the cursor is currently at a headline or a plain list
8232 ;; item. If that is the case, the structure command is used,
8233 ;; temporarily setting many Org-mode variables like regular
8234 ;; expressions for filling etc. However, when any of those keys is
8235 ;; used at a different location, function uses `key-binding' to look
8236 ;; up if the key has an associated command in another currently active
8237 ;; keymap (minor modes, major mode, global), and executes that
8238 ;; command. There might be problems if any of the keys is otherwise
8239 ;; used as a prefix key.
8241 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8242 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8243 ;; addresses this by checking explicitly for both bindings.
8245 (defvar orgstruct-mode-map (make-sparse-keymap)
8246 "Keymap for the minor `orgstruct-mode'.")
8248 (defvar org-local-vars nil
8249 "List of local variables, for use by `orgstruct-mode'.")
8251 ;;;###autoload
8252 (define-minor-mode orgstruct-mode
8253 "Toggle the minor mode `orgstruct-mode'.
8254 This mode is for using Org-mode structure commands in other
8255 modes. The following keys behave as if Org-mode were active, if
8256 the cursor is on a headline, or on a plain list item (both as
8257 defined by Org-mode).
8259 M-up Move entry/item up
8260 M-down Move entry/item down
8261 M-left Promote
8262 M-right Demote
8263 M-S-up Move entry/item up
8264 M-S-down Move entry/item down
8265 M-S-left Promote subtree
8266 M-S-right Demote subtree
8267 M-q Fill paragraph and items like in Org-mode
8268 C-c ^ Sort entries
8269 C-c - Cycle list bullet
8270 TAB Cycle item visibility
8271 M-RET Insert new heading/item
8272 S-M-RET Insert new TODO heading / Checkbox item
8273 C-c C-c Set tags / toggle checkbox"
8274 nil " OrgStruct" nil
8275 (org-load-modules-maybe)
8276 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8278 ;;;###autoload
8279 (defun turn-on-orgstruct ()
8280 "Unconditionally turn on `orgstruct-mode'."
8281 (orgstruct-mode 1))
8283 (defun orgstruct++-mode (&optional arg)
8284 "Toggle `orgstruct-mode', the enhanced version of it.
8285 In addition to setting orgstruct-mode, this also exports all indentation
8286 and autofilling variables from org-mode into the buffer. It will also
8287 recognize item context in multiline items.
8288 Note that turning off orgstruct-mode will *not* remove the
8289 indentation/paragraph settings. This can only be done by refreshing the
8291 (interactive "P")
8292 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8293 (if (< arg 1)
8294 (orgstruct-mode -1)
8295 (orgstruct-mode 1)
8296 (let (var val)
8297 (mapc
8298 (lambda (x)
8299 (when (string-match
8301 (symbol-name (car x)))
8302 (setq var (car x) val (nth 1 x))
8303 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8304 org-local-vars)
8305 (org-set-local 'orgstruct-is-++ t))))
8307 (defvar orgstruct-is-++ nil
8308 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8309 (make-variable-buffer-local 'orgstruct-is-++)
8311 ;;;###autoload
8312 (defun turn-on-orgstruct++ ()
8313 "Unconditionally turn on `orgstruct++-mode'."
8314 (orgstruct++-mode 1))
8316 (defun orgstruct-error ()
8317 "Error when there is no default binding for a structure key."
8318 (interactive)
8319 (error "This key has no function outside structure elements"))
8321 (defun orgstruct-setup ()
8322 "Setup orgstruct keymaps."
8323 (let ((nfunc 0)
8324 (bindings
8325 (list
8326 '([(meta up)] org-metaup)
8327 '([(meta down)] org-metadown)
8328 '([(meta left)] org-metaleft)
8329 '([(meta right)] org-metaright)
8330 '([(meta shift up)] org-shiftmetaup)
8331 '([(meta shift down)] org-shiftmetadown)
8332 '([(meta shift left)] org-shiftmetaleft)
8333 '([(meta shift right)] org-shiftmetaright)
8334 '([?\e (up)] org-metaup)
8335 '([?\e (down)] org-metadown)
8336 '([?\e (left)] org-metaleft)
8337 '([?\e (right)] org-metaright)
8338 '([?\e (shift up)] org-shiftmetaup)
8339 '([?\e (shift down)] org-shiftmetadown)
8340 '([?\e (shift left)] org-shiftmetaleft)
8341 '([?\e (shift right)] org-shiftmetaright)
8342 '([(shift up)] org-shiftup)
8343 '([(shift down)] org-shiftdown)
8344 '([(shift left)] org-shiftleft)
8345 '([(shift right)] org-shiftright)
8346 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8347 '("\M-q" fill-paragraph)
8348 '("\C-c^" org-sort)
8349 '("\C-c-" org-cycle-list-bullet)))
8350 elt key fun cmd)
8351 (while (setq elt (pop bindings))
8352 (setq nfunc (1+ nfunc))
8353 (setq key (org-key (car elt))
8354 fun (nth 1 elt)
8355 cmd (orgstruct-make-binding fun nfunc key))
8356 (org-defkey orgstruct-mode-map key cmd))
8358 ;; Special treatment needed for TAB and RET
8359 (org-defkey orgstruct-mode-map [(tab)]
8360 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8361 (org-defkey orgstruct-mode-map "\C-i"
8362 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8364 (org-defkey orgstruct-mode-map "\M-\C-m"
8365 (orgstruct-make-binding 'org-insert-heading 105
8366 "\M-\C-m" [(meta return)]))
8367 (org-defkey orgstruct-mode-map [(meta return)]
8368 (orgstruct-make-binding 'org-insert-heading 106
8369 [(meta return)] "\M-\C-m"))
8371 (org-defkey orgstruct-mode-map [(shift meta return)]
8372 (orgstruct-make-binding 'org-insert-todo-heading 107
8373 [(meta return)] "\M-\C-m"))
8375 (org-defkey orgstruct-mode-map "\e\C-m"
8376 (orgstruct-make-binding 'org-insert-heading 108
8377 "\e\C-m" [?\e (return)]))
8378 (org-defkey orgstruct-mode-map [?\e (return)]
8379 (orgstruct-make-binding 'org-insert-heading 109
8380 [?\e (return)] "\e\C-m"))
8381 (org-defkey orgstruct-mode-map [?\e (shift return)]
8382 (orgstruct-make-binding 'org-insert-todo-heading 110
8383 [?\e (return)] "\e\C-m"))
8385 (unless org-local-vars
8386 (setq org-local-vars (org-get-local-variables)))
8388 t))
8390 (defun orgstruct-make-binding (fun n &rest keys)
8391 "Create a function for binding in the structure minor mode.
8392 FUN is the command to call inside a table. N is used to create a unique
8393 command name. KEYS are keys that should be checked in for a command
8394 to execute outside of tables."
8395 (eval
8396 (list 'defun
8397 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8398 '(arg)
8400 "Outside of structure, run the binding of `"
8401 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8402 "'.")
8403 '(interactive "p")
8404 (list 'if
8405 `(org-context-p 'headline 'item
8406 (and orgstruct-is-++
8407 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8408 'item-body))
8409 (list 'org-run-like-in-org-mode (list 'quote fun))
8410 (list 'let '(orgstruct-mode)
8411 (list 'call-interactively
8412 (append '(or)
8413 (mapcar (lambda (k)
8414 (list 'key-binding k))
8415 keys)
8416 '('orgstruct-error))))))))
8418 (defun org-context-p (&rest contexts)
8419 "Check if local context is any of CONTEXTS.
8420 Possible values in the list of contexts are `table', `headline', and `item'."
8421 (let ((pos (point)))
8422 (goto-char (point-at-bol))
8423 (prog1 (or (and (memq 'table contexts)
8425 (and (memq 'headline contexts)
8426 (looking-at org-outline-regexp))
8427 (and (memq 'item contexts)
8429 (and (memq 'item-body contexts)
8430 (org-in-item-p)))
8431 (goto-char pos))))
8433 (defun org-get-local-variables ()
8434 "Return a list of all local variables in an org-mode buffer."
8435 (let (varlist)
8436 (with-current-buffer (get-buffer-create "*Org tmp*")
8437 (erase-buffer)
8438 (org-mode)
8439 (setq varlist (buffer-local-variables)))
8440 (kill-buffer "*Org tmp*")
8441 (delq nil
8442 (mapcar
8443 (lambda (x)
8444 (setq x
8445 (if (symbolp x)
8446 (list x)
8447 (list (car x) (list 'quote (cdr x)))))
8448 (if (string-match
8449 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8450 (symbol-name (car x)))
8451 x nil))
8452 varlist))))
8454 (defun org-clone-local-variables (from-buffer &optional regexp)
8455 "Clone local variables from FROM-BUFFER.
8456 Optional argument REGEXP selects variables to clone."
8457 (mapc
8458 (lambda (pair)
8459 (and (symbolp (car pair))
8460 (or (null regexp)
8461 (string-match regexp (symbol-name (car pair))))
8462 (set (make-local-variable (car pair))
8463 (cdr pair))))
8464 (buffer-local-variables from-buffer)))
8466 ;;;###autoload
8467 (defun org-run-like-in-org-mode (cmd)
8468 "Run a command, pretending that the current buffer is in Org-mode.
8469 This will temporarily bind local variables that are typically bound in
8470 Org-mode to the values they have in Org-mode, and then interactively
8471 call CMD."
8472 (org-load-modules-maybe)
8473 (unless org-local-vars
8474 (setq org-local-vars (org-get-local-variables)))
8475 (eval (list 'let org-local-vars
8476 (list 'call-interactively (list 'quote cmd)))))
8478 ;;;; Archiving
8480 (defun org-get-category (&optional pos force-refresh)
8481 "Get the category applying to position POS."
8482 (if force-refresh (org-refresh-category-properties))
8483 (let ((pos (or pos (point))))
8484 (or (get-text-property pos 'org-category)
8485 (progn (org-refresh-category-properties)
8486 (get-text-property pos 'org-category)))))
8488 (defun org-refresh-category-properties ()
8489 "Refresh category text properties in the buffer."
8490 (let ((def-cat (cond
8491 ((null org-category)
8492 (if buffer-file-name
8493 (file-name-sans-extension
8494 (file-name-nondirectory buffer-file-name))
8495 "???"))
8496 ((symbolp org-category) (symbol-name org-category))
8497 (t org-category)))
8498 beg end cat pos optionp)
8499 (org-unmodified
8500 (save-excursion
8501 (save-restriction
8502 (widen)
8503 (goto-char (point-min))
8504 (put-text-property (point) (point-max) 'org-category def-cat)
8505 (while (re-search-forward
8507 (setq pos (match-end 0)
8508 optionp (equal (char-after (match-beginning 0)) ?#)
8509 cat (org-trim (match-string 2)))
8510 (if optionp
8511 (setq beg (point-at-bol) end (point-max))
8512 (org-back-to-heading t)
8513 (setq beg (point) end (org-end-of-subtree t t)))
8514 (put-text-property beg end 'org-category cat)
8515 (put-text-property beg end 'org-category-position beg)
8516 (goto-char pos)))))))
8519 ;;;; Link Stuff
8521 ;;; Link abbreviations
8523 (defun org-link-expand-abbrev (link)
8524 "Apply replacements as defined in `org-link-abbrev-alist."
8526 (let* ((key (match-string 1 link))
8527 (as (or (assoc key org-link-abbrev-alist-local)
8528 (assoc key org-link-abbrev-alist)))
8529 (tag (and (match-end 2) (match-string 3 link)))
8530 rpl)
8531 (if (not as)
8532 link
8533 (setq rpl (cdr as))
8534 (cond
8535 ((symbolp rpl) (funcall rpl tag))
8536 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8537 ((string-match "%h" rpl)
8538 (replace-match (url-hexify-string (or tag "")) t t rpl))
8539 (t (concat rpl tag)))))
8540 link))
8542 ;;; Storing and inserting links
8544 (defvar org-insert-link-history nil
8545 "Minibuffer history for links inserted with `org-insert-link'.")
8547 (defvar org-stored-links nil
8548 "Contains the links stored with `org-store-link'.")
8550 (defvar org-store-link-plist nil
8551 "Plist with info about the most recently link created with `org-store-link'.")
8553 (defvar org-link-protocols nil
8554 "Link protocols added to Org-mode using `org-add-link-type'.")
8556 (defvar org-store-link-functions nil
8557 "List of functions that are called to create and store a link.
8558 Each function will be called in turn until one returns a non-nil
8559 value. Each function should check if it is responsible for creating
8560 this link (for example by looking at the major mode).
8561 If not, it must exit and return nil.
8562 If yes, it should return a non-nil value after a calling
8563 `org-store-link-props' with a list of properties and values.
8564 Special properties are:
8568 This is obligatory as well.
8569 :description Optional default description for the second pair
8570 of brackets in an Org-mode link. The user can still change
8571 this when inserting this link into an Org-mode buffer.
8573 In addition to these, any additional properties can be specified
8574 and then used in remember templates.")
8576 (defun org-add-link-type (type &optional follow export)
8577 "Add TYPE to the list of `org-link-types'.
8578 Re-compute all regular expressions depending on `org-link-types'
8580 FOLLOW and EXPORT are two functions.
8582 FOLLOW should take the link path as the single argument and do whatever
8583 is necessary to follow the link, for example find a file or display
8584 a mail message.
8586 EXPORT should format the link path for export to one of the export formats.
8587 It should be a function accepting three arguments:
8590 desc the description of the link, if any, or a description added by
8591 org-export-normalize-links if there is none
8592 format the export format, a symbol like `html' or `latex' or `ascii'..
8594 The function may use the FORMAT information to return different values
8595 depending on the format. The return value will be put literally into
8596 the exported file. If the return value is nil, this means Org should
8597 do what it normally does with links which do not have EXPORT defined.
8599 Org-mode has a built-in default for exporting links. If you are happy with
8600 this default, there is no need to define an export function for the link
8601 type. For a simple example of an export function, see `org-bbdb.el'."
8602 (add-to-list 'org-link-types type t)
8603 (org-make-link-regexps)
8604 (if (assoc type org-link-protocols)
8605 (setcdr (assoc type org-link-protocols) (list follow export))
8606 (push (list type follow export) org-link-protocols)))
8608 (defvar org-agenda-buffer-name)
8610 ;;;###autoload
8611 (defun org-store-link (arg)
8613 This link is added to `org-stored-links' and can later be inserted
8616 For some link types, a prefix arg is interpreted:
8617 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8618 For file links, arg negates `org-context-in-file-links'."
8619 (interactive "P")
8620 (org-load-modules-maybe)
8621 (setq org-store-link-plist nil) ; reset
8622 (org-with-limited-levels
8623 (let (link cpltxt desc description search txt custom-id agenda-link)
8624 (cond
8626 ((run-hook-with-args-until-success 'org-store-link-functions)
8627 (setq link (plist-get org-store-link-plist :link)
8628 desc (or (plist-get org-store-link-plist :description) link)))
8630 ((equal (buffer-name) "*Org Edit Src Example*")
8631 (let (label gc)
8632 (while (or (not label)
8633 (save-excursion
8634 (save-restriction
8635 (widen)
8636 (goto-char (point-min))
8637 (re-search-forward
8638 (regexp-quote (format org-coderef-label-format label))
8639 nil t))))
8640 (when label (message "Label exists already") (sit-for 2))
8641 (setq label (read-string "Code line label: " label)))
8642 (end-of-line 1)
8643 (setq link (format org-coderef-label-format label))
8644 (setq gc (- 79 (length link)))
8645 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8646 (insert link)
8647 (setq link (concat "(" label ")") desc nil)))
8649 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8650 ;; We are in the agenda, link to referenced location
8651 (let ((m (or (get-text-property (point) 'org-hd-marker)
8652 (get-text-property (point) 'org-marker))))
8653 (when m
8654 (org-with-point-at m
8655 (setq agenda-link
8656 (if (org-called-interactively-p 'any)
8657 (call-interactively 'org-store-link)
8658 (org-store-link nil)))))))
8660 ((eq major-mode 'calendar-mode)
8661 (let ((cd (calendar-cursor-to-date)))
8662 (setq link
8663 (format-time-string
8664 (car org-time-stamp-formats)
8665 (apply 'encode-time
8666 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8667 nil nil nil))))
8668 (org-store-link-props :type "calendar" :date cd)))
8670 ((eq major-mode 'w3-mode)
8671 (setq cpltxt (if (and (buffer-name)
8672 (not (string-match "Untitled" (buffer-name))))
8673 (buffer-name)
8674 (url-view-url t))
8675 link (org-make-link (url-view-url t)))
8676 (org-store-link-props :type "w3" :url (url-view-url t)))
8678 ((eq major-mode 'w3m-mode)
8679 (setq cpltxt (or w3m-current-title w3m-current-url)
8680 link (org-make-link w3m-current-url))
8681 (org-store-link-props :type "w3m" :url (url-view-url t)))
8683 ((setq search (run-hook-with-args-until-success
8684 'org-create-file-search-functions))
8685 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8686 "::" search))
8687 (setq cpltxt (or description link)))
8689 ((eq major-mode 'image-mode)
8690 (setq cpltxt (concat "file:"
8691 (abbreviate-file-name buffer-file-name))
8692 link (org-make-link cpltxt))
8693 (org-store-link-props :type "image" :file buffer-file-name))
8695 ((eq major-mode 'dired-mode)
8696 ;; link to the file in the current line
8697 (let ((file (dired-get-filename nil t)))
8698 (setq file (if file
8699 (abbreviate-file-name
8700 (expand-file-name (dired-get-filename nil t)))
8701 ;; otherwise, no file so use current directory.
8702 default-directory))
8703 (setq cpltxt (concat "file:" file)
8704 link (org-make-link cpltxt))))
8706 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8707 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8708 (cond
8710 (setq cpltxt
8711 (concat "file:"
8712 (abbreviate-file-name
8713 (buffer-file-name (buffer-base-buffer)))
8714 "::" (match-string 1))
8715 link (org-make-link cpltxt)))
8716 ((and (featurep 'org-id)
8717 (or (eq org-link-to-org-use-id t)
8718 (and (eq org-link-to-org-use-id 'create-if-interactive)
8719 (org-called-interactively-p 'any))
8720 (and (eq org-link-to-org-use-id
8721 'create-if-interactive-and-no-custom-id)
8722 (org-called-interactively-p 'any)
8723 (not custom-id))
8724 (and org-link-to-org-use-id
8725 (org-entry-get nil "ID"))))
8726 ;; We can make a link using the ID.
8727 (setq link (condition-case nil
8728 (prog1 (org-id-store-link)
8729 (setq desc (plist-get org-store-link-plist
8730 :description)))
8731 (error
8732 ;; probably before first headline, link to file only
8733 (concat "file:"
8734 (abbreviate-file-name
8735 (buffer-file-name (buffer-base-buffer))))))))
8736 (t
8737 ;; Just link to current headline
8738 (setq cpltxt (concat "file:"
8739 (abbreviate-file-name
8740 (buffer-file-name (buffer-base-buffer)))))
8741 ;; Add a context search string
8742 (when (org-xor org-context-in-file-links arg)
8743 (setq txt (cond
8744 ((org-at-heading-p) nil)
8745 ((org-region-active-p)
8746 (buffer-substring (region-beginning) (region-end)))
8747 (t nil)))
8749 (setq cpltxt
8750 (concat cpltxt "::"
8751 (condition-case nil
8752 (org-make-org-heading-search-string txt)
8753 (error "")))
8754 desc (or (nth 4 (ignore-errors
8755 (org-heading-components))) "NONE"))))
8757 (setq cpltxt (substring cpltxt 0 -2)))
8758 (setq link (org-make-link cpltxt)))))
8760 ((buffer-file-name (buffer-base-buffer))
8761 ;; Just link to this file here.
8762 (setq cpltxt (concat "file:"
8763 (abbreviate-file-name
8764 (buffer-file-name (buffer-base-buffer)))))
8765 ;; Add a context string
8766 (when (org-xor org-context-in-file-links arg)
8767 (setq txt (if (org-region-active-p)
8768 (buffer-substring (region-beginning) (region-end))
8769 (buffer-substring (point-at-bol) (point-at-eol))))
8770 ;; Only use search option if there is some text.
8772 (setq cpltxt
8773 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8774 desc "NONE")))
8775 (setq link (org-make-link cpltxt)))
8777 ((org-called-interactively-p 'interactive)
8778 (error "Cannot link to a buffer which is not visiting a file"))
8780 (t (setq link nil)))
8782 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8783 (setq link (or link cpltxt)
8784 desc (or desc cpltxt))
8785 (if (equal desc "NONE") (setq desc nil))
8787 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8788 (progn
8789 (setq org-stored-links
8790 (cons (list link desc) org-stored-links))
8791 (message "Stored: %s" (or desc link))
8792 (when custom-id
8793 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8794 "::#" custom-id))
8795 (setq org-stored-links
8796 (cons (list link desc) org-stored-links))))
8797 (or agenda-link (and link (org-make-link-string link desc)))))))
8799 (defun org-store-link-props (&rest plist)
8800 "Store link properties, extract names and addresses."
8801 (let (x adr)
8802 (when (setq x (plist-get plist :from))
8803 (setq adr (mail-extract-address-components x))
8804 (setq plist (plist-put plist :fromname (car adr)))
8805 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8806 (when (setq x (plist-get plist :to))
8807 (setq adr (mail-extract-address-components x))
8808 (setq plist (plist-put plist :toname (car adr)))
8809 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8810 (let ((from (plist-get plist :from))
8811 (to (plist-get plist :to)))
8812 (when (and from to org-from-is-user-regexp)
8813 (setq plist
8814 (plist-put plist :fromto
8815 (if (string-match org-from-is-user-regexp from)
8816 (concat "to %t")
8817 (concat "from %f"))))))
8818 (setq org-store-link-plist plist))
8820 (defun org-add-link-props (&rest plist)
8821 "Add these properties to the link property list."
8822 (let (key value)
8823 (while plist
8824 (setq key (pop plist) value (pop plist))
8825 (setq org-store-link-plist
8826 (plist-put org-store-link-plist key value)))))
8828 (defun org-email-link-description (&optional fmt)
8829 "Return the description part of an email link.
8830 This takes information from `org-store-link-plist' and formats it
8831 according to FMT (default from `org-email-link-description-format')."
8832 (setq fmt (or fmt org-email-link-description-format))
8833 (let* ((p org-store-link-plist)
8834 (to (plist-get p :toaddress))
8835 (from (plist-get p :fromaddress))
8836 (table
8837 (list
8838 (cons "%c" (plist-get p :fromto))
8839 (cons "%F" (plist-get p :from))
8840 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8841 (cons "%T" (plist-get p :to))
8842 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8843 (cons "%s" (plist-get p :subject))
8844 (cons "%d" (plist-get p :date))
8845 (cons "%m" (plist-get p :message-id)))))
8846 (when (string-match "%c" fmt)
8847 ;; Check if the user wrote this message
8848 (if (and org-from-is-user-regexp from to
8849 (save-match-data (string-match org-from-is-user-regexp from)))
8850 (setq fmt (replace-match "to %t" t t fmt))
8851 (setq fmt (replace-match "from %f" t t fmt))))
8852 (org-replace-escapes fmt table)))
8854 (defun org-make-org-heading-search-string (&optional string heading)
8855 "Make search string for STRING or current headline."
8856 (interactive)
8857 (let ((s (or string (org-get-heading)))
8858 (lines org-context-in-file-links))
8859 (unless (and string (not heading))
8860 ;; We are using a headline, clean up garbage in there.
8861 (if (string-match org-todo-regexp s)
8862 (setq s (replace-match "" t t s)))
8864 (setq s (replace-match "" t t s)))
8865 (setq s (org-trim s))
8868 (setq s (replace-match "" t t s)))
8869 (while (string-match org-ts-regexp s)
8870 (setq s (replace-match "" t t s))))
8871 (or string (setq s (concat "*" s))) ; Add * for headlines
8872 (when (and string (integerp lines) (> lines 0))
8874 (when (< lines (length slines))
8875 (setq s (mapconcat
8876 'identity
8877 (reverse (nthcdr (- (length slines) lines)
8881 (defun org-make-link (&rest strings)
8882 "Concatenate STRINGS."
8883 (apply 'concat strings))
8885 (defun org-make-link-string (link &optional description)
8886 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8888 (error "Empty link"))
8889 (when (and description
8890 (stringp description)
8892 (setq description nil))
8893 (when (stringp description)
8894 ;; Remove brackets from the description, they are fatal.
8896 (setq description (replace-match "{" t t description)))
8898 (setq description (replace-match "}" t t description))))
8899 (when (equal link description)
8900 ;; No description needed, it is identical
8901 (setq description nil))
8902 (when (and (not description)
8903 (not (string-match (org-image-file-name-regexp) link))
8904 (not (equal link (org-link-escape link))))
8905 (setq description (org-extract-attributes link)))
8906 (setq link
8907 (cond ((string-match (org-image-file-name-regexp) link) link)
8908 ((string-match org-link-types-re link)
8909 (concat (match-string 1 link)
8910 (org-link-escape (substring link (match-end 1)))))
8911 (t (org-link-escape link))))
8912 (concat "[[" link "]"
8913 (if description (concat "[" description "]") "")
8914 "]"))
8916 (defconst org-link-escape-chars
8917 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8918 "List of characters that should be escaped in link.
8919 This is the list that is used for internal purposes.")
8921 (defvar org-url-encoding-use-url-hexify nil)
8923 (defconst org-link-escape-chars-browser
8924 '(?\ )
8925 "List of escapes for characters that are problematic in links.
8926 This is the list that is used before handing over to the browser.")
8928 (defun org-link-escape (text &optional table merge)
8929 "Return percent escaped representation of TEXT.
8930 TEXT is a string with the text to escape.
8931 Optional argument TABLE is a list with characters that should be
8932 escaped. When nil, `org-link-escape-chars' is used.
8933 If optional argument MERGE is set, merge TABLE into
8934 `org-link-escape-chars'."
8935 (if (and org-url-encoding-use-url-hexify (not table))
8936 (url-hexify-string text)
8937 (cond
8938 ((and table merge)
8939 (mapc (lambda (defchr)
8940 (unless (member defchr table)
8941 (setq table (cons defchr table)))) org-link-escape-chars))
8942 ((null table)
8943 (setq table org-link-escape-chars)))
8944 (mapconcat
8945 (lambda (char)
8946 (if (or (member char table)
8947 (< char 32) (= char 37) (> char 126))
8948 (mapconcat (lambda (sequence-element)
8949 (format "%%%.2X" sequence-element))
8950 (or (encode-coding-char char 'utf-8)
8951 (error "Unable to percent escape character: %s"
8952 (char-to-string char))) "")
8953 (char-to-string char))) text "")))
8955 (defun org-link-unescape (str)
8956 "Unhex hexified Unicode strings as returned from the JavaScript function
8957 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8958 (unless (and (null str) (string= "" str))
8959 (let ((pos 0) (case-fold-search t) unhexed)
8961 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8962 (setq str (replace-match unhexed t t str))
8963 (setq pos (+ pos (length unhexed))))))
8964 str)
8966 (defun org-link-unescape-compound (hex)
8967 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8968 Note: this function also decodes single byte encodings like
8970 (save-match-data
8971 (let* ((bytes (cdr (split-string hex "%")))
8972 (ret "")
8973 (eat 0)
8974 (sum 0))
8975 (while bytes
8976 (let* ((val (string-to-number (pop bytes) 16))
8977 (shift-xor
8978 (if (= 0 eat)
8979 (cond
8980 ((>= val 252) (cons 6 252))
8981 ((>= val 248) (cons 5 248))
8982 ((>= val 240) (cons 4 240))
8983 ((>= val 224) (cons 3 224))
8984 ((>= val 192) (cons 2 192))
8985 (t (cons 0 0)))
8986 (cons 6 128))))
8987 (if (>= val 192) (setq eat (car shift-xor)))
8988 (setq val (logxor val (cdr shift-xor)))
8989 (setq sum (+ (lsh sum (car shift-xor)) val))
8990 (if (> eat 0) (setq eat (- eat 1)))
8991 (cond
8992 ((= 0 eat) ;multi byte
8993 (setq ret (concat ret (org-char-to-string sum)))
8994 (setq sum 0))
8995 ((not bytes) ; single byte(s)
8996 (setq ret (org-link-unescape-single-byte-sequence hex))))
8997 )) ;; end (while bytes
8998 ret )))
9000 (defun org-link-unescape-single-byte-sequence (hex)
9001 "Unhexify hex-encoded single byte character sequences."
9002 (mapconcat (lambda (byte)
9003 (char-to-string (string-to-number byte 16)))
9004 (cdr (split-string hex "%")) ""))
9006 (defun org-xor (a b)
9007 "Exclusive or."
9008 (if a (not b) b))
9010 (defun org-fixup-message-id-for-http (s)
9011 "Replace special characters in a message id, so it can be used in an http query."
9012 (when (string-match "%" s)
9013 (setq s (mapconcat (lambda (c)
9014 (if (eq c ?%)
9015 "%25"
9016 (char-to-string c)))
9017 s "")))
9018 (while (string-match "<" s)
9019 (setq s (replace-match "%3C" t t s)))
9020 (while (string-match ">" s)
9021 (setq s (replace-match "%3E" t t s)))
9022 (while (string-match "@" s)
9023 (setq s (replace-match "%40" t t s)))
9024 s)
9026 ;;;###autoload
9027 (defun org-insert-link-global ()
9028 "Insert a link like Org-mode does.
9029 This command can be called in any mode to insert a link in Org-mode syntax."
9030 (interactive)
9031 (org-load-modules-maybe)
9032 (org-run-like-in-org-mode 'org-insert-link))
9034 (defun org-insert-link (&optional complete-file link-location default-description)
9035 "Insert a link. At the prompt, enter the link.
9037 Completion can be used to insert any of the link protocol prefixes like
9038 http or ftp in use.
9040 The history can be used to select a link previously stored with
9041 `org-store-link'. When the empty string is entered (i.e. if you just
9042 press RET at the prompt), the link defaults to the most recently
9043 stored link. As SPC triggers completion in the minibuffer, you need to
9044 use M-SPC or C-q SPC to force the insertion of a space character.
9046 You will also be prompted for a description, and if one is given, it will
9047 be displayed in the buffer instead of the link.
9049 If there is already a link at point, this command will allow you to edit link
9050 and description parts.
9053 be selected using completion. The path to the file will be relative to the
9054 current directory if the file is in the current directory or a subdirectory.
9055 Otherwise, the link will be the absolute path as completed in the minibuffer
9056 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9057 option `org-link-file-path-type'.
9060 the current directory or below.
9063 `org-keep-stored-link-after-insertion'.
9065 If `org-make-link-description-function' is non-nil, this function will be
9066 called with the link target, and the result will be the default
9067 link description.
9069 If the LINK-LOCATION parameter is non-nil, this value will be
9070 used as the link location instead of reading one interactively.
9072 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9073 be used as the default description."
9074 (interactive "P")
9075 (let* ((wcf (current-window-configuration))
9076 (region (if (org-region-active-p)
9077 (buffer-substring (region-beginning) (region-end))))
9078 (remove (and region (list (region-beginning) (region-end))))
9079 (desc region)
9080 tmphist ; byte-compile incorrectly complains about this
9081 (link link-location)
9082 entry file all-prefixes)
9083 (cond
9084 (link-location) ; specified by arg, just use it.
9085 ((org-in-regexp org-bracket-link-regexp 1)
9086 ;; We do have a link at point, and we are going to edit it.
9087 (setq remove (list (match-beginning 0) (match-end 0)))
9088 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9089 (setq link (read-string "Link: "
9090 (org-link-unescape
9091 (org-match-string-no-properties 1)))))
9092 ((or (org-in-regexp org-angle-link-re)
9093 (org-in-regexp org-plain-link-re))
9094 ;; Convert to bracket link
9095 (setq remove (list (match-beginning 0) (match-end 0))
9096 link (read-string "Link: "
9097 (org-remove-angle-brackets (match-string 0)))))
9098 ((member complete-file '((4) (16)))
9099 ;; Completing read for file names.
9100 (setq link (org-file-complete-link complete-file)))
9101 (t
9102 ;; Read link, with completion for stored links.
9103 (with-output-to-temp-buffer "*Org Links*"
9104 (princ "Insert a link.
9106 (when org-stored-links
9108 (princ (mapconcat
9109 (lambda (x)
9110 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9112 (let ((cw (selected-window)))
9113 (select-window (get-buffer-window "*Org Links*" 'visible))
9114 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9115 (unless (pos-visible-in-window-p (point-max))
9116 (org-fit-window-to-buffer))
9117 (and (window-live-p cw) (select-window cw)))
9118 ;; Fake a link history, containing the stored links.
9119 (setq tmphist (append (mapcar 'car org-stored-links)
9120 org-insert-link-history))
9121 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9122 (mapcar 'car org-link-abbrev-alist)
9123 org-link-types))
9124 (unwind-protect
9125 (progn
9126 (setq link
9127 (let ((org-completion-use-ido nil)
9128 (org-completion-use-iswitchb nil))
9129 (org-completing-read
9130 "Link: "
9131 (append
9132 (mapcar (lambda (x) (list (concat x ":")))
9133 all-prefixes)
9134 (mapcar 'car org-stored-links))
9135 nil nil nil
9136 'tmphist
9137 (car (car org-stored-links)))))
9139 (error "No link selected"))
9140 (if (or (member link all-prefixes)
9141 (and (equal ":" (substring link -1))
9142 (member (substring link 0 -1) all-prefixes)
9143 (setq link (substring link 0 -1))))
9144 (setq link (org-link-try-special-completion link))))
9145 (set-window-configuration wcf)
9146 (kill-buffer "*Org Links*"))
9147 (setq entry (assoc link org-stored-links))
9148 (or entry (push link org-insert-link-history))
9149 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9150 (not org-keep-stored-link-after-insertion))
9151 (setq org-stored-links (delq (assoc link org-stored-links)
9152 org-stored-links)))
9153 (setq desc (or desc (nth 1 entry)))))
9155 (if (string-match org-plain-link-re link)
9156 ;; URL-like link, normalize the use of angular brackets.
9157 (setq link (org-make-link (org-remove-angle-brackets link))))
9159 ;; Check if we are linking to the current file with a search option
9160 ;; If yes, simplify the link by using only the search option.
9161 (when (and buffer-file-name
9163 (let* ((path (match-string 1 link))
9164 (case-fold-search nil)
9165 (search (match-string 2 link)))
9166 (save-match-data
9167 (if (equal (file-truename buffer-file-name) (file-truename path))
9168 ;; We are linking to this same file, with a search option
9169 (setq link search)))))
9171 ;; Check if we can/should use a relative path. If yes, simplify the link
9173 (let* ((type (match-string 1 link))
9174 (path (match-string 2 link))
9175 (origpath path)
9176 (case-fold-search nil))
9177 (cond
9178 ((or (eq org-link-file-path-type 'absolute)
9179 (equal complete-file '(16)))
9180 (setq path (abbreviate-file-name (expand-file-name path))))
9181 ((eq org-link-file-path-type 'noabbrev)
9182 (setq path (expand-file-name path)))
9183 ((eq org-link-file-path-type 'relative)
9184 (setq path (file-relative-name path)))
9185 (t
9186 (save-match-data
9187 (if (string-match (concat "^" (regexp-quote
9188 (expand-file-name
9189 (file-name-as-directory
9190 default-directory))))
9191 (expand-file-name path))
9192 ;; We are linking a file with relative path name.
9193 (setq path (substring (expand-file-name path)
9194 (match-end 0)))
9195 (setq path (abbreviate-file-name (expand-file-name path)))))))
9196 (setq link (concat type path))
9197 (if (equal desc origpath)
9198 (setq desc path))))
9200 (if org-make-link-description-function
9201 (setq desc (funcall org-make-link-description-function link desc))
9202 (if default-description (setq desc default-description)))
9204 (setq desc (read-string "Description: " desc))
9206 (if remove (apply 'delete-region remove))
9207 (insert (org-make-link-string link desc))))
9209 (defun org-link-try-special-completion (type)
9210 "If there is completion support for link type TYPE, offer it."
9211 (let ((fun (intern (concat "org-" type "-complete-link"))))
9212 (if (functionp fun)
9213 (funcall fun)
9214 (read-string "Link (no completion support): " (concat type ":")))))
9216 (defun org-file-complete-link (&optional arg)
9217 "Create a file link using completion."
9218 (let (file link)
9219 (setq file (read-file-name "File: "))
9220 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9221 (pwd1 (file-name-as-directory (abbreviate-file-name
9222 (expand-file-name ".")))))
9223 (cond
9224 ((equal arg '(16))
9225 (setq link (org-make-link
9226 "file:"
9227 (abbreviate-file-name (expand-file-name file)))))
9229 (setq link (org-make-link "file:" (match-string 1 file))))
9231 (expand-file-name file))
9232 (setq link (org-make-link
9233 "file:" (match-string 1 (expand-file-name file)))))
9234 (t (setq link (org-make-link "file:" file)))))
9235 link))
9237 (defun org-completing-read (&rest args)
9238 "Completing-read with SPACE being a normal character."
9239 (let ((enable-recursive-minibuffers t)
9240 (minibuffer-local-completion-map
9241 (copy-keymap minibuffer-local-completion-map)))
9242 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9243 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9244 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9245 (apply 'org-icompleting-read args)))
9247 (defun org-completing-read-no-i (&rest args)
9248 (let (org-completion-use-ido org-completion-use-iswitchb)
9249 (apply 'org-completing-read args)))
9251 (defun org-iswitchb-completing-read (prompt choices &rest args)
9252 "Use iswitch as a completing-read replacement to choose from choices.
9253 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9254 from."
9255 (let* ((iswitchb-use-virtual-buffers nil)
9256 (iswitchb-make-buflist-hook
9257 (lambda ()
9258 (setq iswitchb-temp-buflist choices))))
9259 (iswitchb-read-buffer prompt)))
9261 (defun org-icompleting-read (&rest args)
9262 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9263 (org-without-partial-completion
9264 (if (and org-completion-use-ido
9265 (fboundp 'ido-completing-read)
9266 (boundp 'ido-mode) ido-mode
9267 (listp (second args)))
9268 (let ((ido-enter-matching-directory nil))
9269 (apply 'ido-completing-read (concat (car args))
9270 (if (consp (car (nth 1 args)))
9271 (mapcar 'car (nth 1 args))
9272 (nth 1 args))
9273 (cddr args)))
9274 (if (and org-completion-use-iswitchb
9275 (boundp 'iswitchb-mode) iswitchb-mode
9276 (listp (second args)))
9277 (apply 'org-iswitchb-completing-read (concat (car args))
9278 (if (consp (car (nth 1 args)))
9279 (mapcar 'car (nth 1 args))
9280 (nth 1 args))
9281 (cddr args))
9282 (apply 'completing-read args)))))
9284 (defun org-extract-attributes (s)
9285 "Extract the attributes cookie from a string and set as text property."
9286 (let (a attr (start 0) key value)
9287 (save-match-data
9289 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9291 (setq key (match-string 1 a) value (match-string 2 a)
9292 start (match-end 0)
9293 attr (plist-put attr (intern key) value))))
9294 (org-add-props s nil 'org-attr attr))
9295 s))
9297 (defun org-extract-attributes-from-string (tag)
9298 (let (key value attr)
9300 (setq key (match-string 1 tag) value (match-string 2 tag)
9301 tag (replace-match "" t t tag)
9302 attr (plist-put attr (intern key) value)))
9303 (cons tag attr)))
9305 (defun org-attributes-to-string (plist)
9306 "Format a property list into an HTML attribute list."
9307 (let ((s "") key value)
9308 (while plist
9309 (setq key (pop plist) value (pop plist))
9310 (and value
9312 s))
9314 ;;; Opening/following a link
9316 (defvar org-link-search-failed nil)
9318 (defvar org-open-link-functions nil
9319 "Hook for functions finding a plain text link.
9320 These functions must take a single argument, the link content.
9321 They will be called for links that look like [[link text][description]]
9325 These functions will be called *before* Org attempts to resolve the
9326 link by doing text searches in the current buffer - so if you want a
9328 handle this as a special case.
9330 When the function does handle the link, it must return a non-nil value.
9331 If it decides that it is not responsible for this link, it must return
9332 nil to indicate that that Org-mode can continue with other options
9333 like exact and fuzzy text search.")
9335 (defun org-next-link ()
9336 "Move forward to the next link.
9337 If the link is in hidden text, expose it."
9338 (interactive)
9339 (when (and org-link-search-failed (eq this-command last-command))
9340 (goto-char (point-min))
9341 (message "Link search wrapped back to beginning of buffer"))
9342 (setq org-link-search-failed nil)
9343 (let* ((pos (point))
9344 (ct (org-context))
9345 (a (assoc :link ct)))
9346 (if a (goto-char (nth 2 a)))
9347 (if (re-search-forward org-any-link-re nil t)
9348 (progn
9349 (goto-char (match-beginning 0))
9350 (if (outline-invisible-p) (org-show-context)))
9351 (goto-char pos)
9352 (setq org-link-search-failed t)
9353 (error "No further link found"))))
9355 (defun org-previous-link ()
9356 "Move backward to the previous link.
9357 If the link is in hidden text, expose it."
9358 (interactive)
9359 (when (and org-link-search-failed (eq this-command last-command))
9360 (goto-char (point-max))
9361 (message "Link search wrapped back to end of buffer"))
9362 (setq org-link-search-failed nil)
9363 (let* ((pos (point))
9364 (ct (org-context))
9365 (a (assoc :link ct)))
9366 (if a (goto-char (nth 1 a)))
9367 (if (re-search-backward org-any-link-re nil t)
9368 (progn
9369 (goto-char (match-beginning 0))
9370 (if (outline-invisible-p) (org-show-context)))
9371 (goto-char pos)
9372 (setq org-link-search-failed t)
9373 (error "No further link found"))))
9375 (defun org-translate-link (s)
9376 "Translate a link string if a translation function has been defined."
9377 (if (and org-link-translation-function
9378 (fboundp org-link-translation-function)
9380 (progn
9381 (setq s (funcall org-link-translation-function
9382 (match-string 1) (match-string 2)))
9383 (concat (car s) ":" (cdr s)))
9384 s))
9386 (defun org-translate-link-from-planner (type path)
9387 "Translate a link from Emacs Planner syntax so that Org can follow it.
9388 This is still an experimental function, your mileage may vary."
9389 (cond
9390 ((member type '("http" "https" "news" "ftp"))
9391 ;; standard Internet links are the same.
9392 nil)
9393 ((and (equal type "irc") (string-match "^//" path))
9394 ;; Planner has two / at the beginning of an irc link, we have 1.
9395 ;; We should have zero, actually....
9396 (setq path (substring path 1)))
9397 ((and (equal type "lisp") (string-match "^/" path))
9398 ;; Planner has a slash, we do not.
9399 (setq type "elisp" path (substring path 1)))
9401 ;; A typical message link. Planner has the id after the final slash,
9402 ;; we separate it with a hash mark
9403 (setq path (concat (match-string 1 path) "#"
9404 (org-remove-angle-brackets (match-string 2 path)))))
9405 )
9406 (cons type path))
9408 (defun org-find-file-at-mouse (ev)
9409 "Open file link or URL at mouse."
9410 (interactive "e")
9411 (mouse-set-point ev)
9412 (org-open-at-point 'in-emacs))
9414 (defun org-open-at-mouse (ev)
9415 "Open file link or URL at mouse.
9416 See the docstring of `org-open-file' for details."
9417 (interactive "e")
9418 (mouse-set-point ev)
9419 (if (eq major-mode 'org-agenda-mode)
9420 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9421 (org-open-at-point))
9423 (defvar org-window-config-before-follow-link nil
9424 "The window configuration before following a link.
9425 This is saved in case the need arises to restore it.")
9427 (defvar org-open-link-marker (make-marker)
9428 "Marker pointing to the location where `org-open-at-point; was called.")
9430 ;;;###autoload
9431 (defun org-open-at-point-global ()
9432 "Follow a link like Org-mode does.
9433 This command can be called in any mode to follow a link that has
9434 Org-mode syntax."
9435 (interactive)
9436 (org-run-like-in-org-mode 'org-open-at-point))
9438 ;;;###autoload
9439 (defun org-open-link-from-string (s &optional arg reference-buffer)
9440 "Open a link in the string S, as if it was in Org-mode."
9442 (let ((reference-buffer (or reference-buffer (current-buffer))))
9443 (with-temp-buffer
9444 (let ((org-inhibit-startup t))
9445 (org-mode)
9446 (insert s)
9447 (goto-char (point-min))
9448 (when reference-buffer
9449 (setq org-link-abbrev-alist-local
9450 (with-current-buffer reference-buffer
9451 org-link-abbrev-alist-local)))
9452 (org-open-at-point arg reference-buffer)))))
9454 (defvar org-open-at-point-functions nil
9455 "Hook that is run when following a link at point.
9457 Functions in this hook must return t if they identify and follow
9458 a link at point. If they don't find anything interesting at point,
9459 they must return nil.")
9461 (defun org-open-at-point (&optional arg reference-buffer)
9462 "Open link at or after point.
9463 If there is no link at point, this function will search forward up to
9464 the end of the current line.
9465 Normally, files will be opened by an appropriate application. If the
9466 optional prefix argument ARG is non-nil, Emacs will visit the file.
9467 With a double prefix argument, try to open outside of Emacs, in the
9468 application the system uses for this file type."
9469 (interactive "P")
9470 ;; if in a code block, then open the block's results
9471 (unless (call-interactively #'org-babel-open-src-block-result)
9472 (org-load-modules-maybe)
9473 (move-marker org-open-link-marker (point))
9474 (setq org-window-config-before-follow-link (current-window-configuration))
9475 (org-remove-occur-highlights nil nil t)
9476 (cond
9477 ((and (org-at-heading-p)
9478 (not (org-in-regexp
9483 (not (get-text-property (point) 'org-linked-text)))
9484 (or (org-offer-links-in-entry arg)
9485 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9486 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9487 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9488 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9489 (not (org-in-regexp org-bracket-link-regexp)))
9490 (org-footnote-action))
9491 (t
9492 (let (type path link line search (pos (point)))
9493 (catch 'match
9494 (save-excursion
9496 (when (org-in-regexp org-bracket-link-regexp 1)
9497 (setq link (org-extract-attributes
9498 (org-link-unescape (org-match-string-no-properties 1))))
9500 (setq link (replace-match " " t t link)))
9501 (setq link (org-link-expand-abbrev link))
9502 (cond
9503 ((or (file-name-absolute-p link)
9505 (setq type "file" path link))
9506 ((string-match org-link-re-with-space3 link)
9507 (setq type (match-string 1 link) path (match-string 2 link)))
9508 (t (setq type "thisfile" path link)))
9509 (throw 'match t)))
9511 (when (get-text-property (point) 'org-linked-text)
9512 (setq type "thisfile"
9513 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9514 (1+ (point)) (point))
9515 path (buffer-substring
9516 (or (previous-single-property-change pos 'org-linked-text)
9517 (point-min))
9518 (or (next-single-property-change pos 'org-linked-text)
9519 (point-max))))
9520 (throw 'match t))
9522 (save-excursion
9523 (when (or (org-in-regexp org-angle-link-re)
9524 (org-in-regexp org-plain-link-re))
9525 (setq type (match-string 1)
9526 path (org-link-unescape (match-string 2)))
9527 (throw 'match t)))
9528 (save-excursion
9530 (setq type "tags"
9531 path (match-string 1))
9532 (while (string-match ":" path)
9533 (setq path (replace-match "+" t t path)))
9534 (throw 'match t)))
9536 (setq type "tree-match"
9537 path (match-string 1))
9538 (throw 'match t)))
9539 (unless path
9540 (error "No link found"))
9542 ;; switch back to reference buffer
9543 ;; needed when if called in a temporary buffer through
9544 ;; org-open-link-from-string
9545 (with-current-buffer (or reference-buffer (current-buffer))
9547 ;; Remove any trailing spaces in path
9549 (setq path (replace-match "" t t path)))
9550 (if (and org-link-translation-function
9551 (fboundp org-link-translation-function))
9552 ;; Check if we need to translate the link
9553 (let ((tmp (funcall org-link-translation-function type path)))
9554 (setq type (car tmp) path (cdr tmp))))
9556 (cond
9558 ((assoc type org-link-protocols)
9559 (funcall (nth 1 (assoc type org-link-protocols)) path))
9561 ((equal type "mailto")
9562 (let ((cmd (car org-link-mailto-program))
9563 (args (cdr org-link-mailto-program)) args1
9564 (address path) (subject "") a)
9566 (setq address (match-string 1 path)
9567 subject (org-link-escape (match-string 2 path))))
9568 (while args
9569 (cond
9570 ((not (stringp (car args))) (push (pop args) args1))
9571 (t (setq a (pop args))
9572 (if (string-match "%a" a)
9573 (setq a (replace-match address t t a)))
9574 (if (string-match "%s" a)
9575 (setq a (replace-match subject t t a)))
9576 (push a args1))))
9577 (apply cmd (nreverse args1))))
9579 ((member type '("http" "https" "ftp" "news"))
9580 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9581 (org-link-escape
9582 path org-link-escape-chars-browser)
9583 path))))
9585 ((string= type "doi")
9586 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9587 (org-link-escape
9588 path org-link-escape-chars-browser)
9589 path))))
9591 ((member type '("message"))
9592 (browse-url (concat type ":" path)))
9594 ((string= type "tags")
9595 (org-tags-view arg path))
9597 ((string= type "tree-match")
9600 ((string= type "file")
9602 (setq line (string-to-number (match-string 1 path))
9603 path (substring path 0 (match-beginning 0)))
9605 (setq search (match-string 1 path)
9606 path (substring path 0 (match-beginning 0)))))
9607 (if (string-match "[*?{]" (file-name-nondirectory path))
9608 (dired path)
9609 (org-open-file path arg line search)))
9611 ((string= type "shell")
9612 (let ((cmd path))
9613 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9614 (string-match org-confirm-shell-link-not-regexp cmd))
9615 (not org-confirm-shell-link-function)
9616 (funcall org-confirm-shell-link-function
9618 (org-add-props cmd nil
9619 'face 'org-warning))))
9620 (progn
9621 (message "Executing %s" cmd)
9622 (shell-command cmd))
9623 (error "Abort"))))
9625 ((string= type "elisp")
9626 (let ((cmd path))
9627 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9628 (string-match org-confirm-elisp-link-not-regexp cmd))
9629 (not org-confirm-elisp-link-function)
9630 (funcall org-confirm-elisp-link-function
9632 (org-add-props cmd nil
9633 'face 'org-warning))))
9634 (message "%s => %s" cmd
9635 (if (equal (string-to-char cmd) ?\()
9636 (eval (read cmd))
9637 (call-interactively (read cmd))))
9638 (error "Abort"))))
9640 ((and (string= type "thisfile")
9641 (run-hook-with-args-until-success
9642 'org-open-link-functions path)))
9644 ((string= type "thisfile")
9645 (if arg
9646 (switch-to-buffer-other-window
9647 (org-get-buffer-for-internal-link (current-buffer)))
9648 (org-mark-ring-push))
9649 (let ((cmd `(org-link-search
9650 ,path
9651 ,(cond ((equal arg '(4)) ''occur)
9652 ((equal arg '(16)) ''org-occur)
9653 (t nil))
9654 ,pos)))
9655 (condition-case nil (let ((org-link-search-inhibit-query t))
9656 (eval cmd))
9657 (error (progn (widen) (eval cmd))))))
9659 (t
9660 (browse-url-at-point)))))))
9661 (move-marker org-open-link-marker nil)
9662 (run-hook-with-args 'org-follow-link-hook)))
9664 (defun org-offer-links-in-entry (&optional nth zero)
9665 "Offer links in the current entry and follow the selected link.
9666 If there is only one link, follow it immediately as well.
9667 If NTH is an integer, immediately pick the NTH link found.
9668 If ZERO is a string, check also this string for a link, and if
9669 there is one, offer it as link number zero."
9673 (cnt ?0)
9674 (in-emacs (if (integerp nth) nil nth))
9675 have-zero end links link c)
9676 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9677 (push (match-string 0 zero) links)
9678 (setq cnt (1- cnt) have-zero t))
9679 (save-excursion
9680 (org-back-to-heading t)
9681 (setq end (save-excursion (outline-next-heading) (point)))
9682 (while (re-search-forward re end t)
9683 (push (match-string 0) links))
9684 (setq links (org-uniquify (reverse links))))
9686 (cond
9687 ((null links)
9688 (message "No links"))
9689 ((equal (length links) 1)
9690 (setq link (list (car links))))
9691 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9692 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9693 (t ; we have to select a link
9694 (save-excursion
9695 (save-window-excursion
9696 (delete-other-windows)
9697 (with-output-to-temp-buffer "*Select Link*"
9698 (mapc (lambda (l)
9699 (if (not (string-match org-bracket-link-regexp l))
9701 (org-remove-angle-brackets l)))
9702 (if (match-end 3)
9704 (match-string 3 l) (match-string 1 l)))
9706 (match-string 1 l))))))
9707 links))
9708 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9709 (message "Select link to open, RET to open all:")
9710 (setq c (read-char-exclusive))
9711 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9712 (when (equal c ?q) (error "Abort"))
9713 (if (equal c ?\C-m)
9714 (setq link links)
9715 (setq nth (- c ?0))
9716 (if have-zero (setq nth (1+ nth)))
9717 (unless (and (integerp nth) (>= (length links) nth))
9718 (error "Invalid link selection"))
9719 (setq link (list (nth (1- nth) links))))))
9720 (if link
9721 (let ((buf (current-buffer)))
9722 (dolist (l link)
9723 (org-open-link-from-string l in-emacs buf))
9724 t)
9725 nil)))
9727 ;; Add special file links that specify the way of opening
9729 (org-add-link-type "file+sys" 'org-open-file-with-system)
9730 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9731 (defun org-open-file-with-system (path)
9732 "Open file at PATH using the system way of opening it."
9733 (org-open-file path 'system))
9734 (defun org-open-file-with-emacs (path)
9735 "Open file at PATH in Emacs."
9736 (org-open-file path 'emacs))
9737 (defun org-remove-file-link-modifiers ()
9738 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9739 (goto-char (point-min))
9741 (org-if-unprotected
9742 (replace-match "file:" t t))))
9743 (eval-after-load "org-exp"
9744 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9745 'org-remove-file-link-modifiers))
9747 ;;;; Time estimates
9749 (defun org-get-effort (&optional pom)
9750 "Get the effort estimate for the current entry."
9751 (org-entry-get pom org-effort-property))
9753 ;;; File search
9755 (defvar org-create-file-search-functions nil
9756 "List of functions to construct the right search string for a file link.
9757 These functions are called in turn with point at the location to
9758 which the link should point.
9760 A function in the hook should first test if it would like to
9761 handle this file type, for example by checking the `major-mode'
9762 or the file extension. If it decides not to handle this file, it
9763 should just return nil to give other functions a chance. If it
9764 does handle the file, it must return the search string to be used
9765 when following the link. The search string will be part of the
9766 file link, given after a double colon, and `org-open-at-point'
9767 will automatically search for it. If special measures must be
9768 taken to make the search successful, another function should be
9769 added to the companion hook `org-execute-file-search-functions',
9770 which see.
9772 A function in this hook may also use `setq' to set the variable
9773 `description' to provide a suggestion for the descriptive text to
9774 be used for this link when it gets inserted into an Org-mode
9777 (defvar org-execute-file-search-functions nil
9778 "List of functions to execute a file search triggered by a link.
9780 Functions added to this hook must accept a single argument, the
9781 search string that was part of the file link, the part after the
9782 double colon. The function must first check if it would like to
9783 handle this search, for example by checking the `major-mode' or
9784 the file extension. If it decides not to handle this search, it
9785 should just return nil to give other functions a chance. If it
9786 does handle the search, it must return a non-nil value to keep
9787 other functions from trying.
9789 Each function can access the current prefix argument through the
9790 variable `current-prefix-argument'. Note that a single prefix is
9791 used to force opening a link in Emacs, so it may be good to only
9792 use a numeric or double prefix to guide the search function.
9794 In case this is needed, a function in this hook can also restore
9795 the window configuration before `org-open-at-point' was called using:
9797 (set-window-configuration org-window-config-before-follow-link)")
9799 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9800 (defun org-link-search (s &optional type avoid-pos stealth)
9801 "Search for a link search option.
9802 If S is surrounded by forward slashes, it is interpreted as a
9803 regular expression. In org-mode files, this will create an `org-occur'
9804 sparse tree. In ordinary files, `occur' will be used to list matches.
9805 If the current buffer is in `dired-mode', grep will be used to search
9806 in all files. If AVOID-POS is given, ignore matches near that position.
9808 When optional argument STEALTH is non-nil, do not modify
9809 visibility around point, thus ignoring
9810 `org-show-hierarchy-above', `org-show-following-heading' and
9811 `org-show-siblings' variables."
9812 (let ((case-fold-search t)
9816 org-emphasis-alist)
9818 (pos (point))
9819 (pre nil) (post nil)
9820 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9821 (cond
9822 ;; First check if there are any special search functions
9823 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9824 ;; Now try the builtin stuff
9825 ((and (equal (string-to-char s0) ?#)
9826 (> (length s0) 1)
9827 (save-excursion
9828 (goto-char (point-min))
9829 (and
9830 (re-search-forward
9832 (setq type 'dedicated
9833 pos (match-beginning 0))))
9834 ;; There is an exact target for this
9835 (goto-char pos)
9836 (org-back-to-heading t)))
9837 ((save-excursion
9838 (goto-char (point-min))
9839 (and
9840 (re-search-forward
9841 (concat "<<" (regexp-quote s0) ">>") nil t)
9842 (setq type 'dedicated
9843 pos (match-beginning 0))))
9844 ;; There is an exact target for this
9845 (goto-char pos))
9847 (save-excursion
9848 (goto-char (point-min))
9849 (and
9850 (re-search-forward
9851 (concat "[^[]" (regexp-quote
9852 (format org-coderef-label-format
9853 (match-string 1 s0))))
9854 nil t)
9855 (setq type 'dedicated
9856 pos (1+ (match-beginning 0))))))
9857 ;; There is a coderef target for this
9858 (goto-char pos))
9860 ;; A regular expression
9861 (cond
9862 ((eq major-mode 'org-mode)
9863 (org-occur (match-string 1 s)))
9864 ;;((eq major-mode 'dired-mode)
9865 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9866 (t (org-do-occur (match-string 1 s)))))
9867 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9868 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9869 (goto-char (point-min))
9870 (cond
9871 ((let (case-fold-search)
9872 (re-search-forward (format org-complex-heading-regexp-format
9873 (regexp-quote s))
9874 nil t))
9875 ;; OK, found a match
9876 (setq type 'dedicated)
9877 (goto-char (match-beginning 0)))
9878 ((and (not org-link-search-inhibit-query)
9879 (eq org-link-search-must-match-exact-headline 'query-to-create)
9880 (y-or-n-p "No match - create this as a new heading? "))
9881 (goto-char (point-max))
9882 (or (bolp) (newline))
9884 (beginning-of-line 0))
9885 (t
9886 (goto-char pos)
9887 (error "No match"))))
9888 (t
9889 ;; A normal search string
9890 (when (equal (string-to-char s) ?*)
9891 ;; Anchor on headlines, post may include tags.
9894 s (substring s 1)))
9895 (remove-text-properties
9896 0 (length s)
9897 '(face nil mouse-face nil keymap nil fontified nil) s)
9898 ;; Make a series of regular expressions to find a match
9907 re4 (concat "[^a-zA-Z_]" re4_)
9909 re1 (concat pre re2 post)
9910 re3 (concat pre (if pre re4_ re4) post)
9911 re5 (concat pre ".*" re4)
9912 re2 (concat pre re2)
9913 re2a (concat pre (if pre re2a_ re2a))
9914 re4 (concat pre (if pre re4_ re4))
9918 ))
9919 (cond
9920 ((eq type 'org-occur) (org-occur reall))
9921 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9922 (t (goto-char (point-min))
9923 (setq type 'fuzzy)
9924 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9925 (org-search-not-self 1 re1 nil t)
9926 (org-search-not-self 1 re2 nil t)
9927 (org-search-not-self 1 re2a nil t)
9928 (org-search-not-self 1 re3 nil t)
9929 (org-search-not-self 1 re4 nil t)
9930 (org-search-not-self 1 re5 nil t)
9931 )
9932 (goto-char (match-beginning 1))
9933 (goto-char pos)
9934 (error "No match"))))))
9935 (and (eq major-mode 'org-mode)
9936 (not stealth)
9937 (org-show-context 'link-search))
9938 type))
9940 (defun org-search-not-self (group &rest args)
9941 "Execute `re-search-forward', but only accept matches that do not
9942 enclose the position of `org-open-link-marker'."
9943 (let ((m org-open-link-marker))
9944 (catch 'exit
9945 (while (apply 're-search-forward args)
9946 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9947 (goto-char (match-end group))
9948 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9949 (> (match-beginning 0) (marker-position m))
9950 (< (match-end 0) (marker-position m)))
9951 (save-match-data
9952 (or (not (org-in-regexp
9953 org-bracket-link-analytic-regexp 1))
9954 (not (match-end 4)) ; no description
9955 (and (<= (match-beginning 4) (point))
9956 (>= (match-end 4) (point))))))
9957 (throw 'exit (point))))))))
9959 (defun org-get-buffer-for-internal-link (buffer)
9960 "Return a buffer to be used for displaying the link target of internal links."
9961 (cond
9962 ((not org-display-internal-link-with-indirect-buffer)
9963 buffer)
9964 ((string-match "(Clone)$" (buffer-name buffer))
9965 (message "Buffer is already a clone, not making another one")
9966 ;; we also do not modify visibility in this case
9967 buffer)
9968 (t ; make a new indirect buffer for displaying the link
9969 (let* ((bn (buffer-name buffer))
9970 (ibn (concat bn "(Clone)"))
9971 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9972 (with-current-buffer ib (org-overview))
9973 ib))))
9975 (defun org-do-occur (regexp &optional cleanup)
9976 "Call the Emacs command `occur'.
9977 If CLEANUP is non-nil, remove the printout of the regular expression
9978 in the *Occur* buffer. This is useful if the regex is long and not useful
9979 to read."
9980 (occur regexp)
9981 (when cleanup
9982 (let ((cwin (selected-window)) win beg end)
9983 (when (setq win (get-buffer-window "*Occur*"))
9984 (select-window win))
9985 (goto-char (point-min))
9986 (when (re-search-forward "match[a-z]+" nil t)
9987 (setq beg (match-end 0))
9989 (setq end (1- (match-beginning 0)))))
9990 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9991 (goto-char (point-min))
9992 (select-window cwin))))
9994 ;;; The mark ring for links jumps
9996 (defvar org-mark-ring nil
9997 "Mark ring for positions before jumps in Org-mode.")
9998 (defvar org-mark-ring-last-goto nil
9999 "Last position in the mark ring used to go back.")
10000 ;; Fill and close the ring
10001 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10002 (loop for i from 1 to org-mark-ring-length do
10003 (push (make-marker) org-mark-ring))
10004 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10005 org-mark-ring)
10007 (defun org-mark-ring-push (&optional pos buffer)
10008 "Put the current position or POS into the mark ring and rotate it."
10009 (interactive)
10010 (setq pos (or pos (point)))
10011 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10012 (move-marker (car org-mark-ring)
10013 (or pos (point))
10014 (or buffer (current-buffer)))
10015 (message "%s"
10016 (substitute-command-keys
10019 (defun org-mark-ring-goto (&optional n)
10020 "Jump to the previous position in the mark ring.
10021 With prefix arg N, jump back that many stored positions. When
10022 called several times in succession, walk through the entire ring.
10023 Org-mode commands jumping to a different position in the current file,
10024 or to another Org-mode file, automatically push the old position
10025 onto the ring."
10026 (interactive "p")
10027 (let (p m)
10028 (if (eq last-command this-command)
10029 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10030 (setq p org-mark-ring))
10031 (setq org-mark-ring-last-goto p)
10032 (setq m (car p))
10033 (org-pop-to-buffer-same-window (marker-buffer m))
10034 (goto-char m)
10035 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10037 (defun org-remove-angle-brackets (s)
10038 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10039 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10040 s)
10041 (defun org-add-angle-brackets (s)
10042 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10043 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10044 s)
10045 (defun org-remove-double-quotes (s)
10048 s)
10050 ;;; Following specific links
10052 (defun org-follow-timestamp-link ()
10053 (cond
10054 ((org-at-date-range-p t)
10055 (let ((org-agenda-start-on-weekday)
10056 (t1 (match-string 1))
10057 (t2 (match-string 2)))
10058 (setq t1 (time-to-days (org-time-string-to-time t1))
10059 t2 (time-to-days (org-time-string-to-time t2)))
10060 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10061 ((org-at-timestamp-p t)
10062 (org-agenda-list nil (time-to-days (org-time-string-to-time
10063 (substring (match-string 1) 0 10)))
10064 1))
10065 (t (error "This should not happen"))))
10068 ;;; Following file links
10069 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10070 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10071 (declare-function mailcap-mime-info
10072 "mailcap" (string &optional request no-decode))
10073 (defvar org-wait nil)
10074 (defun org-open-file (path &optional in-emacs line search)
10075 "Open the file at PATH.
10076 First, this expands any special file name abbreviations. Then the
10077 configuration variable `org-file-apps' is checked if it contains an
10078 entry for this file type, and if yes, the corresponding command is launched.
10080 If no application is found, Emacs simply visits the file.
10082 With optional prefix argument IN-EMACS, Emacs will visit the file.
10084 prefix arg, Org tries to avoid opening in Emacs
10085 and to use an external application to visit the file.
10087 Optional LINE specifies a line to go to, optional SEARCH a string
10088 to search for. If LINE or SEARCH is given, the file will be
10089 opened in Emacs, unless an entry from org-file-apps that makes
10090 use of groups in a regexp matches.
10092 If you want to change the way frames are used when following a
10093 link, please customize `org-link-frame-setup'.
10095 If the file does not exist, an error is thrown."
10096 (let* ((file (if (equal path "")
10097 buffer-file-name
10098 (substitute-in-file-name (expand-file-name path))))
10099 (file-apps (append org-file-apps (org-default-apps)))
10100 (apps (org-remove-if
10101 'org-file-apps-entry-match-against-dlink-p file-apps))
10102 (apps-dlink (org-remove-if-not
10103 'org-file-apps-entry-match-against-dlink-p file-apps))
10104 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10105 (dirp (if remp nil (file-directory-p file)))
10106 (file (if (and dirp org-open-directory-means-index-dot-org)
10107 (concat (file-name-as-directory file) "index.org")
10108 file))
10109 (a-m-a-p (assq 'auto-mode apps))
10110 (dfile (downcase file))
10111 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10112 (link (cond ((and (eq line nil)
10113 (eq search nil))
10114 file)
10115 (line
10116 (concat file "::" (number-to-string line)))
10117 (search
10118 (concat file "::" search))))
10119 (dlink (downcase link))
10120 (old-buffer (current-buffer))
10121 (old-pos (point))
10122 (old-mode major-mode)
10123 ext cmd link-match-data)
10125 (setq ext (match-string 1 dfile))
10127 (setq ext (match-string 1 dfile))))
10128 (cond
10129 ((member in-emacs '((16) system))
10130 (setq cmd (cdr (assoc 'system apps))))
10131 (in-emacs (setq cmd 'emacs))
10132 (t
10133 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10134 (and dirp (cdr (assoc 'directory apps)))
10135 ; first, try matching against apps-dlink
10136 ; if we get a match here, store the match data for later
10137 (let ((match (assoc-default dlink apps-dlink
10138 'string-match)))
10139 (if match
10140 (progn (setq link-match-data (match-data))
10141 match)
10142 (progn (setq in-emacs (or in-emacs line search))
10143 nil))) ; if we have no match in apps-dlink,
10144 ; always open the file in emacs if line or search
10145 ; is given (for backwards compatibility)
10146 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10147 'string-match)
10148 (cdr (assoc ext apps))
10149 (cdr (assoc t apps))))))
10150 (when (eq cmd 'system)
10151 (setq cmd (cdr (assoc 'system apps))))
10152 (when (eq cmd 'default)
10153 (setq cmd (cdr (assoc t apps))))
10154 (when (eq cmd 'mailcap)
10155 (require 'mailcap)
10156 (mailcap-parse-mailcaps)
10157 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10158 (command (mailcap-mime-info mime-type)))
10159 (if (stringp command)
10160 (setq cmd command)
10161 (setq cmd 'emacs))))
10162 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10163 (not (file-exists-p file))
10164 (not org-open-non-existing-files))
10165 (error "No such file: %s" file))
10166 (cond
10168 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10170 (setq cmd (replace-match "%s" t t cmd)))
10171 (while (string-match "%s" cmd)
10172 (setq cmd (replace-match
10173 (save-match-data
10174 (shell-quote-argument
10175 (convert-standard-filename file)))
10176 t t cmd)))
10178 ;; Replace "%1", "%2" etc. in command with group matches from regex
10179 (save-match-data
10180 (let ((match-index 1)
10181 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10182 (set-match-data link-match-data)
10183 (while (<= match-index number-of-groups)
10184 (let ((regex (concat "%" (number-to-string match-index)))
10185 (replace-with (match-string match-index dlink)))
10186 (while (string-match regex cmd)
10187 (setq cmd (replace-match replace-with t t cmd))))
10188 (setq match-index (+ match-index 1)))))
10190 (save-window-excursion
10191 (start-process-shell-command cmd nil cmd)
10192 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10193 ))
10194 ((or (stringp cmd)
10195 (eq cmd 'emacs))
10196 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10197 (widen)
10198 (if line (org-goto-line line)
10199 (if search (org-link-search search))))
10200 ((consp cmd)
10201 (let ((file (convert-standard-filename file)))
10202 (save-match-data
10203 (set-match-data link-match-data)
10204 (eval cmd))))
10205 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10206 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10207 (or (not (equal old-buffer (current-buffer)))
10208 (not (equal old-pos (point))))
10209 (org-mark-ring-push old-pos old-buffer))))
10211 (defun org-file-apps-entry-match-against-dlink-p (entry)
10212 "This function returns non-nil if `entry' uses a regular
10213 expression which should be matched against the whole link by
10214 org-open-file.
10216 It assumes that is the case when the entry uses a regular
10217 expression which has at least one grouping construct and the
10218 action is either a lisp form or a command string containing
10219 '%1', i.e. using at least one subexpression match as a
10220 parameter."
10221 (let ((selector (car entry))
10222 (action (cdr entry)))
10223 (if (stringp selector)
10224 (and (> (regexp-opt-depth selector) 0)
10225 (or (and (stringp action)
10226 (string-match "%[0-9]" action))
10227 (consp action)))
10228 nil)))
10230 (defun org-default-apps ()
10231 "Return the default applications for this operating system."
10232 (cond
10233 ((eq system-type 'darwin)
10234 org-file-apps-defaults-macosx)
10235 ((eq system-type 'windows-nt)
10236 org-file-apps-defaults-windowsnt)
10237 (t org-file-apps-defaults-gnu)))
10239 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10240 "Convert extensions to regular expressions in the cars of LIST.
10241 Also, weed out any non-string entries, because the return value is used
10242 only for regexp matching.
10243 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10244 point to the symbol `emacs', indicating that the file should
10245 be opened in Emacs."
10246 (append
10247 (delq nil
10248 (mapcar (lambda (x)
10249 (if (not (stringp (car x)))
10250 nil
10252 x
10254 list))
10255 (if add-auto-mode
10256 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10258 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10259 (defun org-file-remote-p (file)
10260 "Test whether FILE specifies a location on a remote system.
10261 Return non-nil if the location is indeed remote.
10265 (cond ((fboundp 'file-remote-p)
10266 (file-remote-p file))
10267 ((fboundp 'tramp-handle-file-remote-p)
10268 (tramp-handle-file-remote-p file))
10269 ((and (boundp 'ange-ftp-name-format)
10270 (string-match (car ange-ftp-name-format) file))
10271 t)
10272 (t nil)))
10275 ;;;; Refiling
10277 (defun org-get-org-file ()
10278 "Read a filename, with default directory `org-directory'."
10279 (let ((default (or org-default-notes-file remember-data-file)))
10280 (read-file-name (format "File name [%s]: " default)
10281 (file-name-as-directory org-directory)
10282 default)))
10284 (defun org-notes-order-reversed-p ()
10285 "Check if the current file should receive notes in reversed order."
10286 (cond
10287 ((not org-reverse-note-order) nil)
10288 ((eq t org-reverse-note-order) t)
10289 ((not (listp org-reverse-note-order)) nil)
10290 (t (catch 'exit
10291 (let ((all org-reverse-note-order)
10292 entry)
10293 (while (setq entry (pop all))
10294 (if (string-match (car entry) buffer-file-name)
10295 (throw 'exit (cdr entry))))
10296 nil)))))
10298 (defvar org-refile-target-table nil
10299 "The list of refile targets, created by `org-refile'.")
10301 (defvar org-agenda-new-buffers nil
10302 "Buffers created to visit agenda files.")
10304 (defvar org-refile-cache nil
10305 "Cache for refile targets.")
10307 (defvar org-refile-markers nil
10308 "All the markers used for caching refile locations.")
10310 (defun org-refile-marker (pos)
10311 "Get a new refile marker, but only if caching is in use."
10312 (if (not org-refile-use-cache)
10313 pos
10314 (let ((m (make-marker)))
10315 (move-marker m pos)
10316 (push m org-refile-markers)
10317 m)))
10319 (defun org-refile-cache-clear ()
10320 "Clear the refile cache and disable all the markers."
10321 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10322 (setq org-refile-markers nil)
10323 (setq org-refile-cache nil)
10324 (message "Refile cache has been cleared"))
10326 (defun org-refile-cache-check-set (set)
10327 "Check if all the markers in the cache still have live buffers."
10328 (let (marker)
10329 (catch 'exit
10330 (while (and set (setq marker (nth 3 (pop set))))
10331 ;; if org-refile-use-outline-path is 'file, marker may be nil
10332 (when (and marker (null (marker-buffer marker)))
10333 (message "not found") (sit-for 3)
10334 (throw 'exit nil)))
10335 t)))
10337 (defun org-refile-cache-put (set &rest identifiers)
10338 "Push the refile targets SET into the cache, under IDENTIFIERS."
10339 (let* ((key (sha1 (prin1-to-string identifiers)))
10340 (entry (assoc key org-refile-cache)))
10341 (if entry
10342 (setcdr entry set)
10343 (push (cons key set) org-refile-cache))))
10345 (defun org-refile-cache-get (&rest identifiers)
10346 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10347 (cond
10348 ((not org-refile-cache) nil)
10349 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10350 (t
10351 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10352 org-refile-cache))))
10353 (and set (org-refile-cache-check-set set) set)))))
10355 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10356 "Produce a table with refile targets."
10357 (let ((case-fold-search nil)
10358 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10359 (entries (or org-refile-targets '((nil . (:level . 1)))))
10360 targets tgs txt re files f desc descre fast-path-p level pos0)
10361 (message "Getting targets...")
10362 (with-current-buffer (or default-buffer (current-buffer))
10363 (while (setq entry (pop entries))
10364 (setq files (car entry) desc (cdr entry))
10365 (setq fast-path-p nil)
10366 (cond
10367 ((null files) (setq files (list (current-buffer))))
10368 ((eq files 'org-agenda-files)
10369 (setq files (org-agenda-files 'unrestricted)))
10370 ((and (symbolp files) (fboundp files))
10371 (setq files (funcall files)))
10372 ((and (symbolp files) (boundp files))
10373 (setq files (symbol-value files))))
10374 (if (stringp files) (setq files (list files)))
10375 (cond
10376 ((eq (car desc) :tag)
10378 ((eq (car desc) :todo)
10380 ((eq (car desc) :regexp)
10381 (setq descre (cdr desc)))
10382 ((eq (car desc) :level)
10384 (if org-odd-levels-only
10385 (1- (* 2 (cdr desc)))
10386 (cdr desc)))
10388 ((eq (car desc) :maxlevel)
10389 (setq fast-path-p t)
10391 (if org-odd-levels-only
10392 (1- (* 2 (cdr desc)))
10393 (cdr desc)))
10395 (t (error "Bad refiling target description %s" desc)))
10396 (while (setq f (pop files))
10397 (with-current-buffer
10398 (if (bufferp f) f (org-get-agenda-file-buffer f))
10399 (or
10400 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10401 (progn
10402 (if (bufferp f) (setq f (buffer-file-name
10403 (buffer-base-buffer f))))
10404 (setq f (and f (expand-file-name f)))
10405 (if (eq org-refile-use-outline-path 'file)
10406 (push (list (file-name-nondirectory f) f nil nil) tgs))
10407 (save-excursion
10408 (save-restriction
10409 (widen)
10410 (goto-char (point-min))
10411 (while (re-search-forward descre nil t)
10412 (goto-char (setq pos0 (point-at-bol)))
10413 (catch 'next
10414 (when org-refile-target-verify-function
10415 (save-match-data
10416 (or (funcall org-refile-target-verify-function)
10417 (throw 'next t))))
10418 (when (and (looking-at org-complex-heading-regexp)
10419 (not (member (match-string 4) excluded-entries))
10420 (match-string 4))
10421 (setq level (org-reduced-level
10422 (- (match-end 1) (match-beginning 1)))
10423 txt (org-link-display-format (match-string 4))
10425 re (format org-complex-heading-regexp-format
10426 (regexp-quote (match-string 4))))
10427 (when org-refile-use-outline-path
10428 (setq txt (mapconcat
10429 'org-protect-slash
10430 (append
10431 (if (eq org-refile-use-outline-path
10432 'file)
10433 (list (file-name-nondirectory
10434 (buffer-file-name
10435 (buffer-base-buffer))))
10436 (if (eq org-refile-use-outline-path
10437 'full-file-path)
10438 (list (buffer-file-name
10439 (buffer-base-buffer)))))
10440 (org-get-outline-path fast-path-p
10441 level txt)
10442 (list txt))
10443 "/")))
10444 (push (list txt f re (org-refile-marker (point)))
10445 tgs)))
10446 (when (= (point) pos0)
10447 ;; verification function has not moved point
10448 (goto-char (point-at-eol))))))))
10449 (when org-refile-use-cache
10450 (org-refile-cache-put tgs (buffer-file-name) descre))
10451 (setq targets (append tgs targets))
10452 ))))
10453 (message "Getting targets...done")
10454 (nreverse targets)))
10456 (defun org-protect-slash (s)
10457 (while (string-match "/" s)
10459 s)
10461 (defvar org-olpa (make-vector 20 nil))
10463 (defun org-get-outline-path (&optional fastp level heading)
10464 "Return the outline path to the current entry, as a list.
10466 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10467 routine which makes outline path derivations for an entire file,
10468 avoiding backtracing. Refile target collection makes use of that."
10469 (if fastp
10470 (progn
10471 (if (> level 19)
10472 (error "Outline path failure, more than 19 levels"))
10473 (loop for i from level upto 19 do
10474 (aset org-olpa i nil))
10475 (prog1
10476 (delq nil (append org-olpa nil))
10477 (aset org-olpa level heading)))
10478 (let (rtn case-fold-search)
10479 (save-excursion
10480 (save-restriction
10481 (widen)
10482 (while (org-up-heading-safe)
10483 (when (looking-at org-complex-heading-regexp)
10484 (push (org-match-string-no-properties 4) rtn)))
10485 rtn)))))
10487 (defun org-format-outline-path (path &optional width prefix)
10488 "Format the outline path PATH for display.
10489 Width is the maximum number of characters that is available.
10490 Prefix is a prefix to be included in the returned string,
10491 such as the file name."
10492 (setq width (or width 79))
10493 (if prefix (setq width (- width (length prefix))))
10494 (if (not path)
10495 (or prefix "")
10496 (let* ((nsteps (length path))
10497 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10498 (maxwidth (if (<= total-width width)
10499 10000 ;; everything fits
10500 ;; we need to shorten the level headings
10501 (/ (- width nsteps) nsteps)))
10502 (org-odd-levels-only nil)
10503 (n 0)
10504 (total (1+ (length prefix))))
10505 (setq maxwidth (max maxwidth 10))
10506 (concat prefix
10507 (mapconcat
10508 (lambda (h)
10509 (setq n (1+ n))
10510 (if (and (= n nsteps) (< maxwidth 10000))
10511 (setq maxwidth (- total-width total)))
10512 (if (< (length h) maxwidth)
10513 (progn (setq total (+ total (length h) 1)) h)
10514 (setq h (substring h 0 (- maxwidth 2))
10515 total (+ total maxwidth 1))
10517 (setq h (substring h 0 (match-beginning 0))))
10518 (setq h (concat h "..")))
10519 (org-add-props h nil 'face
10520 (nth (% (1- n) org-n-level-faces)
10521 org-level-faces))
10522 h)
10523 path "/")))))
10525 (defun org-display-outline-path (&optional file current)
10526 "Display the current outline path in the echo area."
10527 (interactive "P")
10528 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10529 (case-fold-search nil)
10530 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10531 (if current (setq path (append path
10532 (save-excursion
10533 (org-back-to-heading t)
10534 (if (looking-at org-complex-heading-regexp)
10535 (list (match-string 4)))))))
10536 (message "%s"
10537 (org-format-outline-path
10538 path
10539 (1- (frame-width))
10540 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10542 (defvar org-refile-history nil
10543 "History for refiling operations.")
10545 (defvar org-after-refile-insert-hook nil
10546 "Hook run after `org-refile' has inserted its stuff at the new location.
10547 Note that this is still *before* the stuff will be removed from
10548 the *old* location.")
10550 (defvar org-capture-last-stored-marker)
10551 (defun org-refile (&optional goto default-buffer rfloc)
10552 "Move the entry or entries at point to another heading.
10553 The list of target headings is compiled using the information in
10554 `org-refile-targets', which see.
10556 At the target location, the entry is filed as a subitem of the target
10557 heading. Depending on `org-reverse-note-order', the new subitem will
10558 either be the first or the last subitem.
10560 If there is an active region, all entries in that region will be moved.
10561 However, the region must fulfill the requirement that the first heading
10562 is the first one sets the top-level of the moved text - at most siblings
10563 below it are allowed.
10565 With prefix arg GOTO, the command will only visit the target location
10566 and not actually move anything.
10569 go to the location where the last refiling operation has put the subtree.
10570 With a prefix argument of `2', refile to the running clock.
10572 RFLOC can be a refile location obtained in a different way.
10574 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10576 If you are using target caching (see `org-refile-use-cache'),
10577 You have to clear the target cache in order to find new targets.
10578 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10579 prefix argument (`C-u C-u C-u C-c C-w')."
10581 (interactive "P")
10582 (if (member goto '(0 (64)))
10583 (org-refile-cache-clear)
10584 (let* ((cbuf (current-buffer))
10585 (regionp (org-region-active-p))
10586 (region-start (and regionp (region-beginning)))
10587 (region-end (and regionp (region-end)))
10588 (region-length (and regionp (- region-end region-start)))
10589 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10590 pos it nbuf file re level reversed)
10591 (setq last-command nil)
10592 (when regionp
10593 (goto-char region-start)
10594 (or (bolp) (goto-char (point-at-bol)))
10595 (setq region-start (point))
10596 (unless (or (org-kill-is-subtree-p
10597 (buffer-substring region-start region-end))
10598 (prog1 org-refile-active-region-within-subtree
10599 (org-toggle-heading)))
10600 (error "The region is not a (sequence of) subtree(s)")))
10601 (if (equal goto '(16))
10602 (org-refile-goto-last-stored)
10603 (when (or
10604 (and (equal goto 2)
10605 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10606 (prog1
10607 (setq it (list (or org-clock-heading "running clock")
10608 (buffer-file-name
10609 (marker-buffer org-clock-hd-marker))
10610 ""
10611 (marker-position org-clock-hd-marker)))
10612 (setq goto nil)))
10613 (setq it (or rfloc
10614 (let (heading-text)
10615 (save-excursion
10616 (unless goto
10617 (org-back-to-heading t)
10618 (setq heading-text
10619 (nth 4 (org-heading-components))))
10620 (org-refile-get-location
10621 (cond (goto "Goto")
10622 (regionp "Refile region to")
10625 default-buffer
10626 org-refile-allow-creating-parent-nodes
10627 goto))))))
10628 (setq file (nth 1 it)
10629 re (nth 2 it)
10630 pos (nth 3 it))
10631 (if (and (not goto)
10632 pos
10633 (equal (buffer-file-name) file)
10634 (if regionp
10635 (and (>= pos region-start)
10636 (<= pos region-end))
10637 (and (>= pos (point))
10638 (< pos (save-excursion
10639 (org-end-of-subtree t t))))))
10640 (error "Cannot refile to position inside the tree or region"))
10642 (setq nbuf (or (find-buffer-visiting file)
10643 (find-file-noselect file)))
10644 (if goto
10645 (progn
10646 (org-pop-to-buffer-same-window nbuf)
10647 (goto-char pos)
10648 (org-show-context 'org-goto))
10649 (if regionp
10650 (progn
10651 (org-kill-new (buffer-substring region-start region-end))
10652 (org-save-markers-in-region region-start region-end))
10653 (org-copy-subtree 1 nil t))
10654 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10655 (find-file-noselect file)))
10656 (setq reversed (org-notes-order-reversed-p))
10657 (save-excursion
10658 (save-restriction
10659 (widen)
10660 (if pos
10661 (progn
10662 (goto-char pos)
10663 (looking-at org-outline-regexp)
10664 (setq level (org-get-valid-level (funcall outline-level) 1))
10665 (goto-char
10666 (if reversed
10667 (or (outline-next-heading) (point-max))
10668 (or (save-excursion (org-get-next-sibling))
10669 (org-end-of-subtree t t)
10670 (point-max)))))
10671 (setq level 1)
10672 (if (not reversed)
10673 (goto-char (point-max))
10674 (goto-char (point-min))
10675 (or (outline-next-heading) (goto-char (point-max)))))
10676 (if (not (bolp)) (newline))
10677 (org-paste-subtree level)
10678 (when org-log-refile
10679 (org-add-log-setup 'refile nil nil 'findpos
10680 org-log-refile)
10681 (unless (eq org-log-refile 'note)
10682 (save-excursion (org-add-log-note))))
10683 (and org-auto-align-tags (org-set-tags nil t))
10684 (bookmark-set "org-refile-last-stored")
10685 ;; If we are refiling for capture, make sure that the
10686 ;; last-capture pointers point here
10687 (when (org-bound-and-true-p org-refile-for-capture)
10688 (bookmark-set "org-capture-last-stored-marker")
10689 (move-marker org-capture-last-stored-marker (point)))
10690 (if (fboundp 'deactivate-mark) (deactivate-mark))
10691 (run-hooks 'org-after-refile-insert-hook))))
10692 (if regionp
10693 (delete-region (point) (+ (point) region-length))
10694 (org-cut-subtree))
10695 (when (featurep 'org-inlinetask)
10696 (org-inlinetask-remove-END-maybe))
10697 (setq org-markers-to-move nil)
10700 (defun org-refile-goto-last-stored ()
10701 "Go to the location where the last refile was stored."
10702 (interactive)
10703 (bookmark-jump "org-refile-last-stored")
10704 (message "This is the location of the last refile"))
10706 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10707 no-exclude)
10708 "Prompt the user for a refile location, using PROMPT.
10709 PROMPT should not be suffixed with a colon and a space, because
10710 this function appends the default value from
10711 `org-refile-history' automatically, if that is not empty.
10712 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10713 this is used for the GOTO interface."
10714 (let ((org-refile-targets org-refile-targets)
10715 (org-refile-use-outline-path org-refile-use-outline-path)
10716 excluded-entries)
10717 (when (and (eq major-mode 'org-mode)
10718 (not org-refile-use-cache)
10719 (not no-exclude))
10720 (org-map-tree
10721 (lambda()
10722 (setq excluded-entries
10723 (append excluded-entries (list (org-get-heading t t)))))))
10724 (setq org-refile-target-table
10725 (org-refile-get-targets default-buffer excluded-entries)))
10726 (unless org-refile-target-table
10727 (error "No refile targets"))
10728 (let* ((prompt (concat prompt
10729 (and (car org-refile-history)
10730 (concat " (default " (car org-refile-history) ")"))
10731 ": "))
10732 (cbuf (current-buffer))
10733 (partial-completion-mode nil)
10734 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10735 (cfunc (if (and org-refile-use-outline-path
10736 org-outline-path-complete-in-steps)
10737 'org-olpath-completing-read
10738 'org-icompleting-read))
10739 (extra (if org-refile-use-outline-path "/" ""))
10740 (filename (and cfn (expand-file-name cfn)))
10741 (tbl (mapcar
10742 (lambda (x)
10743 (if (and (not (member org-refile-use-outline-path
10744 '(file full-file-path)))
10745 (not (equal filename (nth 1 x))))
10746 (cons (concat (car x) extra " ("
10747 (file-name-nondirectory (nth 1 x)) ")")
10748 (cdr x))
10749 (cons (concat (car x) extra) (cdr x))))
10750 org-refile-target-table))
10751 (completion-ignore-case t)
10752 pa answ parent-target child parent old-hist)
10753 (setq old-hist org-refile-history)
10754 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10755 nil 'org-refile-history (car org-refile-history)))
10756 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10757 (org-refile-check-position pa)
10758 (if pa
10759 (progn
10760 (when (or (not org-refile-history)
10761 (not (eq old-hist org-refile-history))
10762 (not (equal (car pa) (car org-refile-history))))
10763 (setq org-refile-history
10764 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10765 org-refile-history
10766 (cdr org-refile-history))))
10767 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10768 (pop org-refile-history)))
10769 pa)
10771 (progn
10772 (setq parent (match-string 1 answ)
10773 child (match-string 2 answ))
10774 (setq parent-target (or (assoc parent tbl)
10775 (assoc (concat parent "/") tbl)))
10776 (when (and parent-target
10777 (or (eq new-nodes t)
10778 (and (eq new-nodes 'confirm)
10780 child)))))
10781 (org-refile-new-child parent-target child)))
10782 (error "Invalid target location")))))
10784 (defun org-refile-check-position (refile-pointer)
10785 "Check if the refile pointer matches the readline to which it points."
10786 (let* ((file (nth 1 refile-pointer))
10787 (re (nth 2 refile-pointer))
10788 (pos (nth 3 refile-pointer))
10789 buffer)
10790 (when (org-string-nw-p re)
10791 (setq buffer (if (markerp pos)
10792 (marker-buffer pos)
10793 (or (find-buffer-visiting file)
10794 (find-file-noselect file))))
10795 (with-current-buffer buffer
10796 (save-excursion
10797 (save-restriction
10798 (widen)
10799 (goto-char pos)
10800 (beginning-of-line 1)
10801 (unless (org-looking-at-p re)
10802 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10804 (defun org-refile-new-child (parent-target child)
10805 "Use refile target PARENT-TARGET to add new CHILD below it."
10806 (unless parent-target
10807 (error "Cannot find parent for new node"))
10808 (let ((file (nth 1 parent-target))
10809 (pos (nth 3 parent-target))
10810 level)
10811 (with-current-buffer (or (find-buffer-visiting file)
10812 (find-file-noselect file))
10813 (save-excursion
10814 (save-restriction
10815 (widen)
10816 (if pos
10817 (goto-char pos)
10818 (goto-char (point-max))
10819 (if (not (bolp)) (newline)))
10820 (when (looking-at org-outline-regexp)
10821 (setq level (funcall outline-level))
10822 (org-end-of-subtree t t))
10823 (org-back-over-empty-lines)
10825 (if pos (org-get-valid-level level 1) 1) ?*)
10827 (beginning-of-line 0)
10828 (list (concat (car parent-target) "/" child) file "" (point)))))))
10830 (defun org-olpath-completing-read (prompt collection &rest args)
10831 "Read an outline path like a file name."
10832 (let ((thetable collection)
10833 (org-completion-use-ido nil) ; does not work with ido.
10834 (org-completion-use-iswitchb nil)) ; or iswitchb
10835 (apply
10836 'org-icompleting-read prompt
10837 (lambda (string predicate &optional flag)
10838 (let (rtn r f (l (length string)))
10839 (cond
10840 ((eq flag nil)
10841 ;; try completion
10842 (try-completion string thetable))
10843 ((eq flag t)
10844 ;; all-completions
10845 (setq rtn (all-completions string thetable predicate))
10846 (mapcar
10847 (lambda (x)
10848 (setq r (substring x l))
10849 (if (string-match " ([^)]*)$" x)
10850 (setq f (match-string 0 x))
10851 (setq f ""))
10852 (if (string-match "/" r)
10853 (concat string (substring r 0 (match-end 0)) f)
10854 x))
10855 rtn))
10856 ((eq flag 'lambda)
10857 ;; exact match?
10858 (assoc string thetable)))
10859 ))
10860 args)))
10862 ;;;; Dynamic blocks
10864 (defun org-find-dblock (name)
10865 "Find the first dynamic block with name NAME in the buffer.
10866 If not found, stay at current position and return nil."
10867 (let (pos)
10868 (save-excursion
10869 (goto-char (point-min))
10871 nil t)
10872 (match-beginning 0))))
10873 (if pos (goto-char pos))
10874 pos))
10876 (defconst org-dblock-start-re
10878 "Matches the start line of a dynamic block, with parameters.")
10881 "Matches the end of a dynamic block.")
10883 (defun org-create-dblock (plist)
10884 "Create a dynamic block section, with parameters taken from PLIST.
10885 PLIST must contain a :name entry which is used as name of the block."
10887 (end-of-line 1)
10888 (newline))
10889 (let ((col (current-column))
10890 (name (plist-get plist :name)))
10891 (insert "#+BEGIN: " name)
10892 (while plist
10893 (if (eq (car plist) :name)
10894 (setq plist (cddr plist))
10895 (insert " " (prin1-to-string (pop plist)))))
10897 (beginning-of-line -2)))
10899 (defun org-prepare-dblock ()
10900 "Prepare dynamic block for refresh.
10901 This empties the block, puts the cursor at the insert position and returns
10902 the property list including an extra property :name with the block name."
10903 (unless (looking-at org-dblock-start-re)
10904 (error "Not at a dynamic block"))
10905 (let* ((begdel (1+ (match-end 0)))
10906 (name (org-no-properties (match-string 1)))
10907 (params (append (list :name name)
10908 (read (concat "(" (match-string 3) ")")))))
10909 (save-excursion
10910 (beginning-of-line 1)
10912 (setq params (plist-put params :indentation-column (current-column))))
10913 (unless (re-search-forward org-dblock-end-re nil t)
10914 (error "Dynamic block not terminated"))
10915 (setq params
10916 (append params
10917 (list :content (buffer-substring
10918 begdel (match-beginning 0)))))
10919 (delete-region begdel (match-beginning 0))
10920 (goto-char begdel)
10921 (open-line 1)
10922 params))
10924 (defun org-map-dblocks (&optional command)
10925 "Apply COMMAND to all dynamic blocks in the current buffer.
10926 If COMMAND is not given, use `org-update-dblock'."
10927 (let ((cmd (or command 'org-update-dblock)))
10928 (save-excursion
10929 (goto-char (point-min))
10930 (while (re-search-forward org-dblock-start-re nil t)
10931 (goto-char (match-beginning 0))
10932 (save-excursion
10933 (condition-case nil
10934 (funcall cmd)
10935 (error (message "Error during update of dynamic block"))))
10936 (unless (re-search-forward org-dblock-end-re nil t)
10937 (error "Dynamic block not terminated"))))))
10939 (defun org-dblock-update (&optional arg)
10940 "User command for updating dynamic blocks.
10941 Update the dynamic block at point. With prefix ARG, update all dynamic
10942 blocks in the buffer."
10943 (interactive "P")
10944 (if arg
10945 (org-update-all-dblocks)
10946 (or (looking-at org-dblock-start-re)
10947 (org-beginning-of-dblock))
10948 (org-update-dblock)))
10950 (defun org-update-dblock ()
10951 "Update the dynamic block at point.
10952 This means to empty the block, parse for parameters and then call
10953 the correct writing function."
10954 (interactive)
10955 (save-window-excursion
10956 (let* ((pos (point))
10957 (line (org-current-line))
10958 (params (org-prepare-dblock))
10959 (name (plist-get params :name))
10960 (indent (plist-get params :indentation-column))
10961 (cmd (intern (concat "org-dblock-write:" name))))
10962 (message "Updating dynamic block `%s' at line %d..." name line)
10963 (funcall cmd params)
10964 (message "Updating dynamic block `%s' at line %d...done" name line)
10965 (goto-char pos)
10966 (when (and indent (> indent 0))
10967 (setq indent (make-string indent ?\ ))
10968 (save-excursion
10969 (org-beginning-of-dblock)
10970 (forward-line 1)
10971 (while (not (looking-at org-dblock-end-re))
10972 (insert indent)
10973 (beginning-of-line 2))
10974 (when (looking-at org-dblock-end-re)
10976 (replace-match ""))
10977 (insert indent)))))))
10979 (defun org-beginning-of-dblock ()
10980 "Find the beginning of the dynamic block at point.
10981 Error if there is no such block at point."
10982 (let ((pos (point))
10983 beg)
10984 (end-of-line 1)
10985 (if (and (re-search-backward org-dblock-start-re nil t)
10986 (setq beg (match-beginning 0))
10987 (re-search-forward org-dblock-end-re nil t)
10988 (> (match-end 0) pos))
10989 (goto-char beg)
10990 (goto-char pos)
10991 (error "Not in a dynamic block"))))
10993 (defun org-update-all-dblocks ()
10994 "Update all dynamic blocks in the buffer.
10995 This function can be used in a hook."
10996 (interactive)
10997 (when (eq major-mode 'org-mode)
10998 (org-map-dblocks 'org-update-dblock)))
11001 ;;;; Completion
11003 (defconst org-additional-option-like-keywords
11004 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11005 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11006 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11007 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11008 "BEGIN:" "END:"
11009 "ORGTBL" "TBLFM:" "TBLNAME:"
11010 "BEGIN_EXAMPLE" "END_EXAMPLE"
11011 "BEGIN_QUOTE" "END_QUOTE"
11012 "BEGIN_VERSE" "END_VERSE"
11013 "BEGIN_CENTER" "END_CENTER"
11014 "BEGIN_SRC" "END_SRC"
11015 "BEGIN_RESULT" "END_RESULT"
11016 "NAME:" "RESULTS:"
11017 "HEADER:" "HEADERS:"
11018 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11019 "CAPTION:" "LABEL:"
11020 "SETUPFILE:"
11021 "INCLUDE:"
11022 "BIND:"
11023 "MACRO:"))
11025 (defcustom org-structure-template-alist
11026 '(
11039 ("L" "#+LaTeX: "
11043 ("H" "#+HTML: "
11046 ("A" "#+ASCII: ")
11047 ("i" "#+INDEX: ?"
11048 "#+INDEX: ?")
11049 ("I" "#+INCLUDE %file ?"
11051 )
11052 "Structure completion elements.
11053 This is a list of abbreviation keys and values. The value gets inserted
11054 if you type `<' followed by the key and then press the completion key,
11055 usually `M-TAB'. %file will be replaced by a file name after prompting
11056 for the file using completion. The cursor will be placed at the position
11057 of the `?` in the template.
11058 There are two templates for each key, the first uses the original Org syntax,
11059 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11060 the default when the /org-mtags.el/ module has been loaded. See also the
11061 variable `org-mtags-prefer-muse-templates'.
11062 This is an experimental feature, it is undecided if it is going to stay in."
11063 :group 'org-completion
11064 :type '(repeat
11065 (string :tag "Key")
11066 (string :tag "Template")
11067 (string :tag "Muse Template")))
11069 (defun org-try-structure-completion ()
11070 "Try to complete a structure template before point.
11072 expands them."
11073 (let ((l (buffer-substring (point-at-bol) (point)))
11074 a)
11077 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11078 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11079 (match-beginning 1)) a)
11080 t)))
11082 (defun org-complete-expand-structure-template (start cell)
11083 "Expand a structure template."
11084 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11085 (rpl (nth (if musep 2 1) cell))
11086 (ind ""))
11087 (delete-region start (point))
11089 (cond
11090 ((bolp))
11092 (setq ind (buffer-substring (point-at-bol) (point))))
11093 (t (newline))))
11094 (setq start (point))
11095 (if (string-match "%file" rpl)
11096 (setq rpl (replace-match
11097 (concat
11099 (save-match-data
11100 (abbreviate-file-name (read-file-name "Include file: ")))
11102 t t rpl)))
11105 (insert rpl)
11108 ;;;; TODO, DEADLINE, Comments
11110 (defun org-toggle-comment ()
11111 "Change the COMMENT state of an entry."
11112 (interactive)
11113 (save-excursion
11114 (org-back-to-heading)
11115 (let (case-fold-search)
11116 (cond
11117 ((looking-at (format org-heading-keyword-regexp-format
11118 org-comment-string))
11119 (goto-char (match-end 1))
11120 (looking-at (concat " +" org-comment-string))
11121 (replace-match "" t t)
11122 (when (eolp) (insert " ")))
11123 ((looking-at org-outline-regexp)
11124 (goto-char (match-end 0))
11125 (insert org-comment-string " "))))))
11127 (defvar org-last-todo-state-is-todo nil
11128 "This is non-nil when the last TODO state change led to a TODO state.
11129 If the last change removed the TODO tag or switched to DONE, then
11130 this is nil.")
11132 (defvar org-setting-tags nil) ; dynamically skipped
11134 (defvar org-todo-setup-filter-hook nil
11135 "Hook for functions that pre-filter todo specs.
11136 Each function takes a todo spec and returns either nil or the spec
11137 transformed into canonical form." )
11139 (defvar org-todo-get-default-hook nil
11140 "Hook for functions that get a default item for todo.
11141 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11142 nil or a string to be used for the todo mark." )
11144 (defvar org-agenda-headline-snapshot-before-repeat)
11146 (defun org-current-effective-time ()
11147 "Return current time adjusted for `org-extend-today-until' variable"
11148 (let* ((ct (org-current-time))
11149 (dct (decode-time ct))
11150 (ct1
11151 (if (and org-use-effective-time
11152 (< (nth 2 dct) org-extend-today-until))
11153 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11154 ct)))
11155 ct1))
11157 (defun org-todo-yesterday (&optional arg)
11158 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11159 (interactive "P")
11160 (if (eq major-mode 'org-agenda-mode)
11161 (apply 'org-agenda-todo-yesterday arg)
11162 (let* ((hour (third (decode-time
11163 (org-current-time))))
11164 (org-extend-today-until (1+ hour)))
11165 (org-todo arg))))
11167 (defun org-todo (&optional arg)
11168 "Change the TODO state of an item.
11169 The state of an item is given by a keyword at the start of the heading,
11170 like
11171 *** TODO Write paper
11172 *** DONE Call mom
11174 The different keywords are specified in the variable `org-todo-keywords'.
11176 So for this example: when the item starts with TODO, it is changed to DONE.
11177 When it starts with DONE, the DONE is removed. And when neither TODO nor
11178 DONE are present, add TODO at the beginning of the heading.
11181 state.
11182 With numeric prefix arg, switch to that state.
11184 keywords (nextset).
11186 With a numeric prefix arg of 0, inhibit note taking for the change.
11188 For calling through lisp, arg is also interpreted in the following way:
11189 'none -> empty state
11191 'done -> switch to DONE
11192 'nextset -> switch to the next set of keywords
11193 'previousset -> switch to the previous set of keywords
11195 really is a member of `org-todo-keywords'."
11196 (interactive "P")
11197 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11198 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11199 'region-start-level 'region))
11200 org-loop-over-headlines-in-active-region)
11201 (org-map-entries
11202 `(org-todo ,arg)
11203 org-loop-over-headlines-in-active-region
11204 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11205 (if (equal arg '(16)) (setq arg 'nextset))
11206 (let ((org-blocker-hook org-blocker-hook)
11207 (case-fold-search nil))
11208 (when (equal arg '(64))
11209 (setq arg nil org-blocker-hook nil))
11210 (when (and org-blocker-hook
11211 (or org-inhibit-blocking
11212 (org-entry-get nil "NOBLOCKING")))
11213 (setq org-blocker-hook nil))
11214 (save-excursion
11215 (catch 'exit
11216 (org-back-to-heading t)
11217 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11220 (let* ((match-data (match-data))
11221 (startpos (point-at-bol))
11222 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11223 (org-log-done org-log-done)
11224 (org-log-repeat org-log-repeat)
11225 (org-todo-log-states org-todo-log-states)
11226 (org-inhibit-logging
11227 (if (equal arg 0)
11228 (progn (setq arg nil) 'note) org-inhibit-logging))
11229 (this (match-string 1))
11230 (hl-pos (match-beginning 0))
11231 (head (org-get-todo-sequence-head this))
11232 (ass (assoc head org-todo-kwd-alist))
11233 (interpret (nth 1 ass))
11234 (done-word (nth 3 ass))
11235 (final-done-word (nth 4 ass))
11236 (last-state (or this ""))
11237 (completion-ignore-case t)
11238 (member (member this org-todo-keywords-1))
11239 (tail (cdr member))
11240 (state (cond
11241 ((and org-todo-key-trigger
11242 (or (and (equal arg '(4))
11243 (eq org-use-fast-todo-selection 'prefix))
11244 (and (not arg) org-use-fast-todo-selection
11245 (not (eq org-use-fast-todo-selection
11246 'prefix)))))
11247 ;; Use fast selection
11248 (org-fast-todo-selection))
11249 ((and (equal arg '(4))
11250 (or (not org-use-fast-todo-selection)
11251 (not org-todo-key-trigger)))
11252 ;; Read a state with completion
11253 (org-icompleting-read
11254 "State: " (mapcar (lambda(x) (list x))
11255 org-todo-keywords-1)
11256 nil t))
11257 ((eq arg 'right)
11258 (if this
11259 (if tail (car tail) nil)
11260 (car org-todo-keywords-1)))
11261 ((eq arg 'left)
11262 (if (equal member org-todo-keywords-1)
11263 nil
11264 (if this
11265 (nth (- (length org-todo-keywords-1)
11266 (length tail) 2)
11267 org-todo-keywords-1)
11268 (org-last org-todo-keywords-1))))
11269 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11270 (setq arg nil))) ; hack to fall back to cycling
11271 (arg
11272 ;; user or caller requests a specific state
11273 (cond
11274 ((equal arg "") nil)
11275 ((eq arg 'none) nil)
11276 ((eq arg 'done) (or done-word (car org-done-keywords)))
11277 ((eq arg 'nextset)
11278 (or (car (cdr (member head org-todo-heads)))
11279 (car org-todo-heads)))
11280 ((eq arg 'previousset)
11281 (let ((org-todo-heads (reverse org-todo-heads)))
11282 (or (car (cdr (member head org-todo-heads)))
11283 (car org-todo-heads))))
11284 ((car (member arg org-todo-keywords-1)))
11285 ((stringp arg)
11286 (error "State `%s' not valid in this file" arg))
11287 ((nth (1- (prefix-numeric-value arg))
11288 org-todo-keywords-1))))
11289 ((null member) (or head (car org-todo-keywords-1)))
11290 ((equal this final-done-word) nil) ;; -> make empty
11291 ((null tail) nil) ;; -> first entry
11292 ((memq interpret '(type priority))
11293 (if (eq this-command last-command)
11294 (car tail)
11295 (if (> (length tail) 0)
11296 (or done-word (car org-done-keywords))
11297 nil)))
11298 (t
11299 (car tail))))
11300 (state (or
11301 (run-hook-with-args-until-success
11302 'org-todo-get-default-hook state last-state)
11303 state))
11304 (next (if state (concat " " state " ") " "))
11305 (change-plist (list :type 'todo-state-change :from this :to state
11306 :position startpos))
11307 dolog now-done-p)
11308 (when org-blocker-hook
11309 (setq org-last-todo-state-is-todo
11310 (not (member this org-done-keywords)))
11311 (unless (save-excursion
11312 (save-match-data
11313 (org-with-wide-buffer
11314 (run-hook-with-args-until-failure
11315 'org-blocker-hook change-plist))))
11316 (if (org-called-interactively-p 'interactive)
11317 (error "TODO state change from %s to %s blocked" this state)
11318 ;; fail silently
11319 (message "TODO state change from %s to %s blocked" this state)
11320 (throw 'exit nil))))
11321 (store-match-data match-data)
11322 (replace-match next t t)
11323 (unless (pos-visible-in-window-p hl-pos)
11324 (message "TODO state changed to %s" (org-trim next)))
11325 (unless head
11326 (setq head (org-get-todo-sequence-head state)
11327 ass (assoc head org-todo-kwd-alist)
11328 interpret (nth 1 ass)
11329 done-word (nth 3 ass)
11330 final-done-word (nth 4 ass)))
11331 (when (memq arg '(nextset previousset))
11332 (message "Keyword-Set %d/%d: %s"
11333 (- (length org-todo-sets) -1
11334 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11335 (length org-todo-sets)
11336 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11337 (setq org-last-todo-state-is-todo
11338 (not (member state org-done-keywords)))
11339 (setq now-done-p (and (member state org-done-keywords)
11340 (not (member this org-done-keywords))))
11341 (and logging (org-local-logging logging))
11342 (when (and (or org-todo-log-states org-log-done)
11343 (not (eq org-inhibit-logging t))
11344 (not (memq arg '(nextset previousset))))
11345 ;; we need to look at recording a time and note
11346 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11347 (nth 2 (assoc this org-todo-log-states))))
11348 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11349 (setq dolog 'time))
11350 (when (and state
11351 (member state org-not-done-keywords)
11352 (not (member this org-not-done-keywords)))
11353 ;; This is now a todo state and was not one before
11354 ;; If there was a CLOSED time stamp, get rid of it.
11355 (org-add-planning-info nil nil 'closed))
11356 (when (and now-done-p org-log-done)
11357 ;; It is now done, and it was not done before
11358 (org-add-planning-info 'closed (org-current-effective-time))
11359 (if (and (not dolog) (eq 'note org-log-done))
11360 (org-add-log-setup 'done state this 'findpos 'note)))
11361 (when (and state dolog)
11362 ;; This is a non-nil state, and we need to log it
11363 (org-add-log-setup 'state state this 'findpos dolog)))
11364 ;; Fixup tag positioning
11365 (org-todo-trigger-tag-changes state)
11366 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11367 (when org-provide-todo-statistics
11368 (org-update-parent-todo-statistics))
11369 (run-hooks 'org-after-todo-state-change-hook)
11370 (if (and arg (not (member state org-done-keywords)))
11371 (setq head (org-get-todo-sequence-head state)))
11372 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11373 ;; Do we need to trigger a repeat?
11374 (when now-done-p
11375 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11376 ;; This is for the agenda, take a snapshot of the headline.
11377 (save-match-data
11378 (setq org-agenda-headline-snapshot-before-repeat
11379 (org-get-heading))))
11380 (org-auto-repeat-maybe state))
11381 ;; Fixup cursor location if close to the keyword
11382 (if (and (outline-on-heading-p)
11383 (not (bolp))
11384 (save-excursion (beginning-of-line 1)
11385 (looking-at org-todo-line-regexp))
11386 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11387 (progn
11388 (goto-char (or (match-end 2) (match-end 1)))
11389 (and (looking-at " ") (just-one-space))))
11390 (when org-trigger-hook
11391 (save-excursion
11392 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11394 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11395 "Block turning an entry into a TODO, using the hierarchy.
11396 This checks whether the current task should be blocked from state
11397 changes. Such blocking occurs when:
11399 1. The task has children which are not all in a completed state.
11401 2. A task has a parent with the property :ORDERED:, and there
11402 are siblings prior to the current task with incomplete
11403 status.
11405 3. The parent of the task is blocked because it has siblings that should
11406 be done first, or is child of a block grandparent TODO entry."
11408 (if (not org-enforce-todo-dependencies)
11409 t ; if locally turned off don't block
11410 (catch 'dont-block
11411 ;; If this is not a todo state change, or if this entry is already DONE,
11412 ;; do not block
11413 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11414 (member (plist-get change-plist :from)
11415 (cons 'done org-done-keywords))
11416 (member (plist-get change-plist :to)
11417 (cons 'todo org-not-done-keywords))
11418 (not (plist-get change-plist :to)))
11419 (throw 'dont-block t))
11420 ;; If this task has children, and any are undone, it's blocked
11421 (save-excursion
11422 (org-back-to-heading t)
11423 (let ((this-level (funcall outline-level)))
11424 (outline-next-heading)
11425 (let ((child-level (funcall outline-level)))
11426 (while (and (not (eobp))
11427 (> child-level this-level))
11428 ;; this todo has children, check whether they are all
11429 ;; completed
11430 (if (and (not (org-entry-is-done-p))
11431 (org-entry-is-todo-p))
11432 (throw 'dont-block nil))
11433 (outline-next-heading)
11434 (setq child-level (funcall outline-level))))))
11435 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11436 ;; any previous siblings are undone, it's blocked
11437 (save-excursion
11438 (org-back-to-heading t)
11439 (let* ((pos (point))
11440 (parent-pos (and (org-up-heading-safe) (point))))
11441 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11442 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11443 (forward-line 1)
11444 (re-search-forward org-not-done-heading-regexp pos t))
11445 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11446 ;; Search further up the hierarchy, to see if an ancestor is blocked
11447 (while t
11448 (goto-char parent-pos)
11449 (if (not (looking-at org-not-done-heading-regexp))
11450 (throw 'dont-block t)) ; do not block, parent is not a TODO
11451 (setq pos (point))
11452 (setq parent-pos (and (org-up-heading-safe) (point)))
11453 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11454 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11455 (forward-line 1)
11456 (re-search-forward org-not-done-heading-regexp pos t))
11457 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11459 (defcustom org-track-ordered-property-with-tag nil
11460 "Should the ORDERED property also be shown as a tag?
11461 The ORDERED property decides if an entry should require subtasks to be
11462 completed in sequence. Since a property is not very visible, setting
11463 this option means that toggling the ORDERED property with the command
11464 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11465 not relevant for the behavior, but it makes things more visible.
11467 Note that toggling the tag with tags commands will not change the property
11468 and therefore not influence behavior!
11470 This can be t, meaning the tag ORDERED should be used, It can also be a
11471 string to select a different tag for this task."
11472 :group 'org-todo
11473 :type '(choice
11474 (const :tag "No tracking" nil)
11475 (const :tag "Track with ORDERED tag" t)
11476 (string :tag "Use other tag")))
11478 (defun org-toggle-ordered-property ()
11479 "Toggle the ORDERED property of the current entry.
11480 For better visibility, you can track the value of this property with a tag.
11481 See variable `org-track-ordered-property-with-tag'."
11482 (interactive)
11483 (let* ((t1 org-track-ordered-property-with-tag)
11484 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11485 (save-excursion
11486 (org-back-to-heading)
11487 (if (org-entry-get nil "ORDERED")
11488 (progn
11489 (org-delete-property "ORDERED")
11490 (and tag (org-toggle-tag tag 'off))
11491 (message "Subtasks can be completed in arbitrary order"))
11492 (org-entry-put nil "ORDERED" "t")
11493 (and tag (org-toggle-tag tag 'on))
11494 (message "Subtasks must be completed in sequence")))))
11496 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11497 (defun org-block-todo-from-checkboxes (change-plist)
11498 "Block turning an entry into a TODO, using checkboxes.
11499 This checks whether the current task should be blocked from state
11500 changes because there are unchecked boxes in this entry."
11501 (if (not org-enforce-todo-checkbox-dependencies)
11502 t ; if locally turned off don't block
11503 (catch 'dont-block
11504 ;; If this is not a todo state change, or if this entry is already DONE,
11505 ;; do not block
11506 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11507 (member (plist-get change-plist :from)
11508 (cons 'done org-done-keywords))
11509 (member (plist-get change-plist :to)
11510 (cons 'todo org-not-done-keywords))
11511 (not (plist-get change-plist :to)))
11512 (throw 'dont-block t))
11513 ;; If this task has checkboxes that are not checked, it's blocked
11514 (save-excursion
11515 (org-back-to-heading t)
11516 (let ((beg (point)) end)
11517 (outline-next-heading)
11518 (setq end (point))
11519 (goto-char beg)
11520 (if (org-list-search-forward
11521 (concat (org-item-beginning-re)
11524 end t)
11525 (progn
11526 (if (boundp 'org-blocked-by-checkboxes)
11527 (setq org-blocked-by-checkboxes t))
11528 (throw 'dont-block nil)))))
11529 t))) ; do not block
11531 (defun org-entry-blocked-p ()
11532 "Is the current entry blocked?"
11533 (if (org-entry-get nil "NOBLOCKING")
11534 nil ;; Never block this entry
11535 (not
11536 (run-hook-with-args-until-failure
11537 'org-blocker-hook
11538 (list :type 'todo-state-change
11539 :position (point)
11540 :from 'todo
11541 :to 'done)))))
11543 (defun org-update-statistics-cookies (all)
11544 "Update the statistics cookie, either from TODO or from checkboxes.
11545 This should be called with the cursor in a line with a statistics cookie."
11546 (interactive "P")
11547 (if all
11548 (progn
11549 (org-update-checkbox-count 'all)
11550 (org-map-entries 'org-update-parent-todo-statistics))
11551 (if (not (org-at-heading-p))
11552 (org-update-checkbox-count)
11553 (let ((pos (move-marker (make-marker) (point)))
11554 end l1 l2)
11555 (ignore-errors (org-back-to-heading t))
11556 (if (not (org-at-heading-p))
11557 (org-update-checkbox-count)
11558 (setq l1 (org-outline-level))
11559 (setq end (save-excursion
11560 (outline-next-heading)
11561 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11562 (point)))
11563 (if (and (save-excursion
11564 (re-search-forward
11566 (not (save-excursion (re-search-forward
11568 (org-update-checkbox-count)
11569 (if (and l2 (> l2 l1))
11570 (progn
11571 (goto-char end)
11572 (org-update-parent-todo-statistics))
11573 (goto-char pos)
11574 (beginning-of-line 1)
11575 (while (re-search-forward
11577 (point-at-eol) t)
11578 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11579 (goto-char pos)
11580 (move-marker pos nil)))))
11582 (defvar org-entry-property-inherited-from) ;; defined below
11583 (defun org-update-parent-todo-statistics ()
11584 "Update any statistics cookie in the parent of the current headline.
11585 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11586 the entire subtree and this will travel up the hierarchy and update
11587 statistics everywhere."
11588 (let* ((prop (save-excursion (org-up-heading-safe)
11589 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11590 (recursive (or (not org-hierarchical-todo-statistics)
11592 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11593 0))
11594 (first t)
11596 level ltoggle l1 new ndel
11597 (cnt-all 0) (cnt-done 0) is-percent kwd
11598 checkbox-beg ov ovs ove cookie-present)
11599 (catch 'exit
11600 (save-excursion
11601 (beginning-of-line 1)
11602 (setq ltoggle (funcall outline-level))
11603 ;; Three situations are to consider:
11605 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11606 ;; to the top-level ancestor on the headline;
11608 ;; 2. If parent has "recursive" property, repeat up to the
11609 ;; headline setting that property, taking inheritance into
11610 ;; account;
11612 ;; 3. Else, move up to direct parent and proceed only once.
11613 (while (and (setq level (org-up-heading-safe))
11614 (or recursive first)
11615 (>= (point) lim))
11616 (setq first nil cookie-present nil)
11617 (unless (and level
11618 (not (string-match
11620 (downcase (or (org-entry-get nil "COOKIE_DATA")
11621 "")))))
11622 (throw 'exit nil))
11623 (while (re-search-forward box-re (point-at-eol) t)
11624 (setq cnt-all 0 cnt-done 0 cookie-present t)
11625 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11626 (save-match-data
11627 (unless (outline-next-heading) (throw 'exit nil))
11628 (while (and (looking-at org-complex-heading-regexp)
11629 (> (setq l1 (length (match-string 1))) level))
11630 (setq kwd (and (or recursive (= l1 ltoggle))
11631 (match-string 2)))
11632 (if (or (eq org-provide-todo-statistics 'all-headlines)
11633 (and (listp org-provide-todo-statistics)
11634 (or (member kwd org-provide-todo-statistics)
11635 (member kwd org-done-keywords))))
11636 (setq cnt-all (1+ cnt-all))
11637 (if (eq org-provide-todo-statistics t)
11638 (and kwd (setq cnt-all (1+ cnt-all)))))
11639 (and (member kwd org-done-keywords)
11640 (setq cnt-done (1+ cnt-done)))
11641 (outline-next-heading)))
11642 (setq new
11643 (if is-percent
11644 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11645 (format "[%d/%d]" cnt-done cnt-all))
11646 ndel (- (match-end 0) checkbox-beg))
11647 ;; handle overlays when updating cookie from column view
11648 (when (setq ov (car (overlays-at checkbox-beg)))
11649 (setq ovs (overlay-start ov) ove (overlay-end ov))
11650 (delete-overlay ov))
11651 (goto-char checkbox-beg)
11652 (insert new)
11653 (delete-region (point) (+ (point) ndel))
11654 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11655 (when ov (move-overlay ov ovs ove)))
11656 (when cookie-present
11657 (run-hook-with-args 'org-after-todo-statistics-hook
11658 cnt-done (- cnt-all cnt-done))))))
11659 (run-hooks 'org-todo-statistics-hook)))
11661 (defvar org-after-todo-statistics-hook nil
11662 "Hook that is called after a TODO statistics cookie has been updated.
11663 Each function is called with two arguments: the number of not-done entries
11664 and the number of done entries.
11666 For example, the following function, when added to this hook, will switch
11667 an entry to DONE when all children are done, and back to TODO when new
11668 entries are set to a TODO status. Note that this hook is only called
11669 when there is a statistics cookie in the headline!
11671 (defun org-summary-todo (n-done n-not-done)
11673 (let (org-log-done org-log-states) ; turn off logging
11675 ")
11677 (defvar org-todo-statistics-hook nil
11678 "Hook that is run whenever Org thinks TODO statistics should be updated.
11679 This hook runs even if there is no statistics cookie present, in which case
11680 `org-after-todo-statistics-hook' would not run.")
11682 (defun org-todo-trigger-tag-changes (state)
11683 "Apply the changes defined in `org-todo-state-tags-triggers'."
11684 (let ((l org-todo-state-tags-triggers)
11685 changes)
11686 (when (or (not state) (equal state ""))
11687 (setq changes (append changes (cdr (assoc "" l)))))
11688 (when (and (stringp state) (> (length state) 0))
11689 (setq changes (append changes (cdr (assoc state l)))))
11690 (when (member state org-not-done-keywords)
11691 (setq changes (append changes (cdr (assoc 'todo l)))))
11692 (when (member state org-done-keywords)
11693 (setq changes (append changes (cdr (assoc 'done l)))))
11694 (dolist (c changes)
11695 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11697 (defun org-local-logging (value)
11698 "Get logging settings from a property VALUE."
11699 (let* (words w a)
11700 ;; directly set the variables, they are already local.
11701 (setq org-log-done nil
11702 org-log-repeat nil
11703 org-todo-log-states nil)
11704 (setq words (org-split-string value))
11705 (while (setq w (pop words))
11706 (cond
11707 ((setq a (assoc w org-startup-options))
11708 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11709 (set (nth 1 a) (nth 2 a))))
11710 ((setq a (org-extract-log-state-settings w))
11711 (and (member (car a) org-todo-keywords-1)
11712 (push a org-todo-log-states)))))))
11714 (defun org-get-todo-sequence-head (kwd)
11715 "Return the head of the TODO sequence to which KWD belongs.
11716 If KWD is not set, check if there is a text property remembering the
11717 right sequence."
11718 (let (p)
11719 (cond
11720 ((not kwd)
11721 (or (get-text-property (point-at-bol) 'org-todo-head)
11722 (progn
11723 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11724 nil (point-at-eol)))
11725 (get-text-property p 'org-todo-head))))
11726 ((not (member kwd org-todo-keywords-1))
11727 (car org-todo-keywords-1))
11728 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11730 (defun org-fast-todo-selection ()
11731 "Fast TODO keyword selection with single keys.
11732 Returns the new TODO keyword, or nil if no state change should occur."
11733 (let* ((fulltable org-todo-key-alist)
11734 (done-keywords org-done-keywords) ;; needed for the faces.
11735 (maxlen (apply 'max (mapcar
11736 (lambda (x)
11737 (if (stringp (car x)) (string-width (car x)) 0))
11738 fulltable)))
11739 (expert nil)
11740 (fwidth (+ maxlen 3 1 3))
11741 (ncol (/ (- (window-width) 4) fwidth))
11742 tg cnt e c tbl
11743 groups ingroup)
11744 (save-excursion
11745 (save-window-excursion
11746 (if expert
11747 (set-buffer (get-buffer-create " *Org todo*"))
11748 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11749 (erase-buffer)
11750 (org-set-local 'org-done-keywords done-keywords)
11751 (setq tbl fulltable cnt 0)
11752 (while (setq e (pop tbl))
11753 (cond
11754 ((equal e '(:startgroup))
11755 (push '() groups) (setq ingroup t)
11756 (when (not (= cnt 0))
11757 (setq cnt 0)
11759 (insert "{ "))
11760 ((equal e '(:endgroup))
11761 (setq ingroup nil cnt 0)
11763 ((equal e '(:newline))
11764 (when (not (= cnt 0))
11765 (setq cnt 0)
11767 (setq e (car tbl))
11768 (while (equal (car tbl) '(:newline))
11770 (setq tbl (cdr tbl)))))
11771 (t
11772 (setq tg (car e) c (cdr e))
11773 (if ingroup (push tg (car groups)))
11774 (setq tg (org-add-props tg nil 'face
11775 (org-get-todo-face tg)))
11776 (if (and (= cnt 0) (not ingroup)) (insert " "))
11777 (insert "[" c "] " tg (make-string
11778 (- fwidth 4 (length tg)) ?\ ))
11779 (when (= (setq cnt (1+ cnt)) ncol)
11781 (if ingroup (insert " "))
11782 (setq cnt 0)))))
11784 (goto-char (point-min))
11785 (if (not expert) (org-fit-window-to-buffer))
11786 (message "[a-z..]:Set [SPC]:clear")
11787 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11788 (cond
11789 ((or (= c ?\C-g)
11790 (and (= c ?q) (not (rassoc c fulltable))))
11791 (setq quit-flag t))
11792 ((= c ?\ ) nil)
11793 ((setq e (rassoc c fulltable) tg (car e))
11794 tg)
11795 (t (setq quit-flag t)))))))
11797 (defun org-entry-is-todo-p ()
11798 (member (org-get-todo-state) org-not-done-keywords))
11800 (defun org-entry-is-done-p ()
11801 (member (org-get-todo-state) org-done-keywords))
11803 (defun org-get-todo-state ()
11804 (save-excursion
11805 (org-back-to-heading t)
11806 (and (looking-at org-todo-line-regexp)
11807 (match-end 2)
11808 (match-string 2))))
11810 (defun org-at-date-range-p (&optional inactive-ok)
11811 "Is the cursor inside a date range?"
11812 (interactive)
11813 (save-excursion
11814 (catch 'exit
11815 (let ((pos (point)))
11817 (skip-chars-backward "<[")
11818 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11819 (>= (match-end 0) pos)
11820 (throw 'exit t))
11822 (skip-chars-backward "<[")
11823 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11824 (>= (match-end 0) pos)
11825 (throw 'exit t)))
11826 nil)))
11828 (defun org-get-repeat (&optional tagline)
11829 "Check if there is a deadline/schedule with repeater in this entry."
11830 (save-match-data
11831 (save-excursion
11832 (org-back-to-heading t)
11833 (and (re-search-forward (if tagline
11835 org-repeat-re)
11836 (org-entry-end-position) t)
11837 (match-string-no-properties 1)))))
11839 (defvar org-last-changed-timestamp)
11840 (defvar org-last-inserted-timestamp)
11841 (defvar org-log-post-message)
11842 (defvar org-log-note-purpose)
11843 (defvar org-log-note-how)
11844 (defvar org-log-note-extra)
11845 (defun org-auto-repeat-maybe (done-word)
11846 "Check if the current headline contains a repeated deadline/schedule.
11847 If yes, set TODO state back to what it was and change the base date
11848 of repeating deadline/scheduled time stamps to new date.
11849 This function is run automatically after each state change to a DONE state."
11850 ;; last-state is dynamically scoped into this function
11851 (let* ((repeat (org-get-repeat))
11852 (aa (assoc last-state org-todo-kwd-alist))
11853 (interpret (nth 1 aa))
11854 (head (nth 2 aa))
11855 (whata '(("d" . day) ("m" . month) ("y" . year)))
11856 (msg "Entry repeats: ")
11857 (org-log-done nil)
11858 (org-todo-log-states nil)
11859 re type n what ts time to-state)
11860 (when repeat
11861 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11862 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11863 org-todo-repeat-to-state))
11864 (unless (and to-state (member to-state org-todo-keywords-1))
11865 (setq to-state (if (eq interpret 'type) last-state head)))
11866 (org-todo to-state)
11867 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11868 (org-entry-put nil "LAST_REPEAT" (format-time-string
11869 (org-time-stamp-format t t))))
11870 (when org-log-repeat
11871 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11872 (memq 'org-add-log-note post-command-hook))
11873 ;; OK, we are already setup for some record
11874 (if (eq org-log-repeat 'note)
11875 ;; make sure we take a note, not only a time stamp
11876 (setq org-log-note-how 'note))
11877 ;; Set up for taking a record
11878 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11879 last-state
11880 'findpos org-log-repeat)))
11881 (org-back-to-heading t)
11882 (org-add-planning-info nil nil 'closed)
11886 (while (re-search-forward
11887 re (save-excursion (outline-next-heading) (point)) t)
11888 (setq type (if (match-end 1) org-scheduled-string
11889 (if (match-end 3) org-deadline-string "Plain:"))
11890 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11892 (setq n (string-to-number (match-string 2 ts))
11893 what (match-string 3 ts))
11894 (if (equal what "w") (setq n (* n 7) what "d"))
11895 ;; Preparation, see if we need to modify the start date for the change
11896 (when (match-end 1)
11897 (setq time (save-match-data (org-time-string-to-time ts)))
11898 (cond
11899 ((equal (match-string 1 ts) ".")
11900 ;; Shift starting date to today
11901 (org-timestamp-change
11902 (- (org-today) (time-to-days time))
11903 'day))
11904 ((equal (match-string 1 ts) "+")
11905 (let ((nshiftmax 10) (nshift 0))
11906 (while (or (= nshift 0)
11907 (<= (time-to-days time)
11908 (time-to-days (current-time))))
11909 (when (= (incf nshift) nshiftmax)
11910 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11911 (error "Abort")))
11912 (org-timestamp-change n (cdr (assoc what whata)))
11913 (org-at-timestamp-p t)
11914 (setq ts (match-string 1))
11915 (setq time (save-match-data (org-time-string-to-time ts)))))
11916 (org-timestamp-change (- n) (cdr (assoc what whata)))
11917 ;; rematch, so that we have everything in place for the real shift
11918 (org-at-timestamp-p t)
11919 (setq ts (match-string 1))
11921 (org-timestamp-change n (cdr (assoc what whata)))
11922 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11923 (setq org-log-post-message msg)
11924 (message "%s" msg))))
11926 (defun org-show-todo-tree (arg)
11927 "Make a compact tree which shows all headlines marked with TODO.
11928 The tree will show the lines where the regexp matches, and all higher
11929 headlines above the match.
11931 With a numeric prefix N, construct a sparse tree for the Nth element
11932 of `org-todo-keywords-1'."
11933 (interactive "P")
11934 (let ((case-fold-search nil)
11935 (kwd-re
11936 (cond ((null arg) org-not-done-regexp)
11937 ((equal arg '(4))
11938 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11939 (mapcar 'list org-todo-keywords-1))))
11943 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11944 (regexp-quote (nth (1- (prefix-numeric-value arg))
11945 org-todo-keywords-1)))
11946 (t (error "Invalid prefix argument: %s" arg)))))
11947 (message "%d TODO entries found"
11948 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11950 (defun org-deadline (&optional remove time)
11952 With argument REMOVE, remove any deadline from the item.
11953 With argument TIME, set the deadline at the corresponding date. TIME
11955 (interactive "P")
11956 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11957 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11958 'region-start-level 'region))
11959 org-loop-over-headlines-in-active-region)
11960 (org-map-entries
11961 `(org-deadline ',remove ,time)
11962 org-loop-over-headlines-in-active-region
11963 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11964 (let* ((old-date (org-entry-get nil "DEADLINE"))
11965 (repeater (and old-date
11966 (string-match
11968 old-date)
11969 (match-string 1 old-date))))
11970 (if remove
11971 (progn
11972 (when (and old-date org-log-redeadline)
11973 (org-add-log-setup 'deldeadline nil old-date 'findpos
11974 org-log-redeadline))
11975 (org-remove-timestamp-with-keyword org-deadline-string)
11976 (message "Item no longer has a deadline."))
11977 (org-add-planning-info 'deadline time 'closed)
11978 (when (and old-date org-log-redeadline
11979 (not (equal old-date
11980 (substring org-last-inserted-timestamp 1 -1))))
11981 (org-add-log-setup 'redeadline nil old-date 'findpos
11982 org-log-redeadline))
11983 (when repeater
11984 (save-excursion
11985 (org-back-to-heading t)
11986 (when (re-search-forward (concat org-deadline-string " "
11987 org-last-inserted-timestamp)
11988 (save-excursion
11989 (outline-next-heading) (point)) t)
11990 (goto-char (1- (match-end 0)))
11991 (insert " " repeater)
11992 (setq org-last-inserted-timestamp
11993 (concat (substring org-last-inserted-timestamp 0 -1)
11994 " " repeater
11995 (substring org-last-inserted-timestamp -1))))))
11996 (message "Deadline on %s" org-last-inserted-timestamp)))))
11998 (defun org-schedule (&optional remove time)
11999 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12000 With argument REMOVE, remove any scheduling date from the item.
12001 With argument TIME, scheduled at the corresponding date. TIME can
12003 (interactive "P")
12004 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12005 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12006 'region-start-level 'region))
12007 org-loop-over-headlines-in-active-region)
12008 (org-map-entries
12009 `(org-schedule ',remove ,time)
12010 org-loop-over-headlines-in-active-region
12011 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12012 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12013 (repeater (and old-date
12014 (string-match
12016 old-date)
12017 (match-string 1 old-date))))
12018 (if remove
12019 (progn
12020 (when (and old-date org-log-reschedule)
12021 (org-add-log-setup 'delschedule nil old-date 'findpos
12022 org-log-reschedule))
12023 (org-remove-timestamp-with-keyword org-scheduled-string)
12024 (message "Item is no longer scheduled."))
12025 (org-add-planning-info 'scheduled time 'closed)
12026 (when (and old-date org-log-reschedule
12027 (not (equal old-date
12028 (substring org-last-inserted-timestamp 1 -1))))
12029 (org-add-log-setup 'reschedule nil old-date 'findpos
12030 org-log-reschedule))
12031 (when repeater
12032 (save-excursion
12033 (org-back-to-heading t)
12034 (when (re-search-forward (concat org-scheduled-string " "
12035 org-last-inserted-timestamp)
12036 (save-excursion
12037 (outline-next-heading) (point)) t)
12038 (goto-char (1- (match-end 0)))
12039 (insert " " repeater)
12040 (setq org-last-inserted-timestamp
12041 (concat (substring org-last-inserted-timestamp 0 -1)
12042 " " repeater
12043 (substring org-last-inserted-timestamp -1))))))
12044 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12046 (defun org-get-scheduled-time (pom &optional inherit)
12047 "Get the scheduled time as a time tuple, of a format suitable
12048 for calling org-schedule with, or if there is no scheduling,
12049 returns nil."
12050 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12051 (when time
12052 (apply 'encode-time (org-parse-time-string time)))))
12054 (defun org-get-deadline-time (pom &optional inherit)
12055 "Get the deadline as a time tuple, of a format suitable for
12056 calling org-deadline with, or if there is no scheduling, returns
12057 nil."
12058 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12059 (when time
12060 (apply 'encode-time (org-parse-time-string time)))))
12062 (defun org-remove-timestamp-with-keyword (keyword)
12063 "Remove all time stamps with KEYWORD in the current entry."
12065 beg)
12066 (save-excursion
12067 (org-back-to-heading t)
12068 (setq beg (point))
12069 (outline-next-heading)
12070 (while (re-search-backward re beg t)
12071 (replace-match "")
12073 (equal (char-before) ?\ ))
12074 (backward-delete-char 1)
12076 (point-at-bol) (point-at-eol)))
12077 (delete-region (point-at-bol)
12078 (min (point-max) (1+ (point-at-eol))))))))))
12080 (defun org-add-planning-info (what &optional time &rest remove)
12081 "Insert new timestamp with keyword in the line directly after the headline.
12082 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12083 If non is given, the user is prompted for a date.
12084 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12085 be removed."
12086 (interactive)
12087 (let (org-time-was-given org-end-time-was-given ts
12088 end default-time default-input)
12090 (catch 'exit
12091 (when (and (memq what '(scheduled deadline))
12092 (or (not time)
12093 (and (stringp time)
12094 (string-match "^[-+]+[0-9]" time))))
12095 ;; Try to get a default date/time from existing timestamp
12096 (save-excursion
12097 (org-back-to-heading t)
12098 (setq end (save-excursion (outline-next-heading) (point)))
12099 (when (re-search-forward (if (eq what 'scheduled)
12100 org-scheduled-time-regexp
12101 org-deadline-time-regexp)
12102 end t)
12103 (setq ts (match-string 1)
12104 default-time
12105 (apply 'encode-time (org-parse-time-string ts))
12106 default-input (and ts (org-get-compact-tod ts))))))
12107 (when what
12108 (setq time
12109 (if (stringp time)
12110 ;; This is a string (relative or absolute), set proper date
12111 (apply 'encode-time
12112 (org-read-date-analyze
12113 time default-time (decode-time default-time)))
12114 ;; If necessary, get the time from the user
12115 (or time (org-read-date nil 'to-time nil nil
12116 default-time default-input)))))
12118 (when (and org-insert-labeled-timestamps-at-point
12119 (member what '(scheduled deadline)))
12120 (insert
12121 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12122 (org-insert-time-stamp time org-time-was-given
12123 nil nil nil (list org-end-time-was-given))
12124 (setq what nil))
12125 (save-excursion
12126 (save-restriction
12127 (let (col list elt ts buffer-invisibility-spec)
12128 (org-back-to-heading t)
12130 (goto-char (match-end 1))
12131 (setq col (current-column))
12132 (goto-char (match-end 0))
12134 (when (and (not what)
12135 (not (looking-at
12137 org-keyword-time-not-clock-regexp))))
12138 ;; Nothing to add, nothing to remove...... :-)
12139 (throw 'exit nil))
12140 (if (and (not (looking-at org-outline-regexp))
12143 (not (equal (match-string 1) org-clock-string)))
12144 (narrow-to-region (match-beginning 0) (match-end 0))
12146 (backward-char 1)
12147 (narrow-to-region (point) (point))
12148 (and org-adapt-indentation (org-indent-to-column col)))
12149 ;; Check if we have to remove something.
12150 (setq list (cons what remove))
12151 (while list
12152 (setq elt (pop list))
12153 (when (or (and (eq elt 'scheduled)
12154 (re-search-forward org-scheduled-time-regexp nil t))
12155 (and (eq elt 'deadline)
12156 (re-search-forward org-deadline-time-regexp nil t))
12157 (and (eq elt 'closed)
12158 (re-search-forward org-closed-time-regexp nil t)))
12159 (replace-match "")
12160 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12162 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12163 (when what
12164 (insert
12165 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12166 (cond ((eq what 'scheduled) org-scheduled-string)
12167 ((eq what 'deadline) org-deadline-string)
12168 ((eq what 'closed) org-closed-string))
12169 " ")
12170 (setq ts (org-insert-time-stamp
12171 time
12172 (or org-time-was-given
12173 (and (eq what 'closed) org-log-done-with-time))
12174 (eq what 'closed)
12175 nil nil (list org-end-time-was-given)))
12176 (insert
12177 (if (not (or (bolp) (eq (char-before) ?\ )
12178 (memq (char-after) '(32 10))
12179 (eobp))) " " ""))
12180 (end-of-line 1))
12181 (goto-char (point-min))
12182 (widen)
12185 (delete-region (1- (point)) (point-at-eol)))
12186 ts))))))
12188 (defvar org-log-note-marker (make-marker))
12189 (defvar org-log-note-purpose nil)
12190 (defvar org-log-note-state nil)
12191 (defvar org-log-note-previous-state nil)
12192 (defvar org-log-note-how nil)
12193 (defvar org-log-note-extra nil)
12194 (defvar org-log-note-window-configuration nil)
12195 (defvar org-log-note-return-to (make-marker))
12196 (defvar org-log-note-effective-time nil
12197 "Remembered current time so that dynamically scoped
12198 `org-extend-today-until' affects tha timestamps in state change
12199 log")
12201 (defvar org-log-post-message nil
12202 "Message to be displayed after a log note has been stored.
12203 The auto-repeater uses this.")
12205 (defun org-add-note ()
12206 "Add a note to the current entry.
12207 This is done in the same way as adding a state change note."
12208 (interactive)
12209 (org-add-log-setup 'note nil nil 'findpos nil))
12211 (defvar org-property-end-re)
12212 (defun org-add-log-setup (&optional purpose state prev-state
12213 findpos how extra)
12214 "Set up the post command hook to take a note.
12215 If this is about to TODO state change, the new state is expected in STATE.
12216 When FINDPOS is non-nil, find the correct position for the note in
12217 the current entry. If not, assume that it can be inserted at point.
12218 HOW is an indicator what kind of note should be created.
12219 EXTRA is additional text that will be inserted into the notes buffer."
12220 (let* ((org-log-into-drawer (org-log-into-drawer))
12221 (drawer (cond ((stringp org-log-into-drawer)
12222 org-log-into-drawer)
12223 (org-log-into-drawer "LOGBOOK")
12224 (t nil))))
12225 (save-restriction
12226 (save-excursion
12227 (when findpos
12228 (org-back-to-heading t)
12229 (narrow-to-region (point) (save-excursion
12230 (outline-next-heading) (point)))
12234 (goto-char (match-end 0))
12235 (cond
12236 (drawer
12238 nil t)
12239 (progn
12240 (goto-char (match-end 0))
12241 (or org-log-states-order-reversed
12242 (and (re-search-forward org-property-end-re nil t)
12243 (goto-char (1- (match-beginning 0))))))
12245 (beginning-of-line 0)
12246 (org-indent-line-function)
12247 (beginning-of-line 2)
12248 (org-indent-line-function)
12249 (end-of-line 0)))
12250 ((and org-log-state-notes-insert-after-drawers
12251 (save-excursion
12252 (forward-line) (looking-at org-drawer-regexp)))
12253 (forward-line)
12254 (while (looking-at org-drawer-regexp)
12255 (goto-char (match-end 0))
12256 (re-search-forward org-property-end-re (point-max) t)
12257 (forward-line))
12258 (forward-line -1)))
12259 (unless org-log-states-order-reversed
12261 (org-skip-over-state-notes)
12263 (move-marker org-log-note-marker (point))
12264 (setq org-log-note-purpose purpose
12265 org-log-note-state state
12266 org-log-note-previous-state prev-state
12267 org-log-note-how how
12268 org-log-note-extra extra
12269 org-log-note-effective-time (org-current-effective-time))
12270 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12272 (defun org-skip-over-state-notes ()
12273 "Skip past the list of State notes in an entry."
12275 (when (ignore-errors (goto-char (org-in-item-p)))
12276 (let* ((struct (org-list-struct))
12277 (prevs (org-list-prevs-alist struct)))
12279 (goto-char (or (org-list-get-next-item (point) struct prevs)
12280 (org-list-get-item-end (point) struct)))))))
12282 (defun org-add-log-note (&optional purpose)
12283 "Pop up a window for taking a note, and add this note later at point."
12284 (remove-hook 'post-command-hook 'org-add-log-note)
12285 (setq org-log-note-window-configuration (current-window-configuration))
12286 (delete-other-windows)
12287 (move-marker org-log-note-return-to (point))
12288 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12289 (goto-char org-log-note-marker)
12290 (org-switch-to-buffer-other-window "*Org Note*")
12291 (erase-buffer)
12292 (if (memq org-log-note-how '(time state))
12293 (let (current-prefix-arg) (org-store-log-note))
12294 (let ((org-inhibit-startup t)) (org-mode))
12295 (insert (format "# Insert note for %s.
12297 (cond
12298 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12299 ((eq org-log-note-purpose 'done) "closed todo item")
12300 ((eq org-log-note-purpose 'state)
12302 (or org-log-note-previous-state "")
12303 (or org-log-note-state "")))
12304 ((eq org-log-note-purpose 'reschedule)
12305 "rescheduling")
12306 ((eq org-log-note-purpose 'delschedule)
12307 "no longer scheduled")
12308 ((eq org-log-note-purpose 'redeadline)
12309 "changing deadline")
12310 ((eq org-log-note-purpose 'deldeadline)
12311 "removing deadline")
12312 ((eq org-log-note-purpose 'refile)
12313 "refiling")
12314 ((eq org-log-note-purpose 'note)
12315 "this entry")
12316 (t (error "This should not happen")))))
12317 (if org-log-note-extra (insert org-log-note-extra))
12318 (org-set-local 'org-finish-function 'org-store-log-note)
12319 (run-hooks 'org-log-buffer-setup-hook)))
12321 (defvar org-note-abort nil) ; dynamically scoped
12322 (defun org-store-log-note ()
12323 "Finish taking a log note, and insert it to where it belongs."
12324 (let ((txt (buffer-string))
12325 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12326 lines ind bul)
12327 (kill-buffer (current-buffer))
12329 (setq txt (replace-match "" t t txt)))
12331 (setq txt (replace-match "" t t txt)))
12334 (setq note
12335 (org-replace-escapes
12336 note
12337 (list (cons "%u" (user-login-name))
12338 (cons "%U" user-full-name)
12339 (cons "%t" (format-time-string
12340 (org-time-stamp-format 'long 'inactive)
12341 org-log-note-effective-time))
12342 (cons "%T" (format-time-string
12343 (org-time-stamp-format 'long nil)
12344 org-log-note-effective-time))
12345 (cons "%d" (format-time-string
12346 (org-time-stamp-format nil 'inactive)
12347 org-log-note-effective-time))
12348 (cons "%D" (format-time-string
12349 (org-time-stamp-format nil nil)
12350 org-log-note-effective-time))
12351 (cons "%s" (if org-log-note-state
12353 ""))
12354 (cons "%S" (if org-log-note-previous-state
12358 (push note lines))
12359 (when (or current-prefix-arg org-note-abort)
12360 (when org-log-into-drawer
12361 (org-remove-empty-drawer-at
12362 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12363 org-log-note-marker))
12364 (setq lines nil))
12365 (when lines
12366 (with-current-buffer (marker-buffer org-log-note-marker)
12367 (save-excursion
12368 (goto-char org-log-note-marker)
12369 (move-marker org-log-note-marker nil)
12370 (end-of-line 1)
12372 (setq ind (save-excursion
12373 (if (ignore-errors (goto-char (org-in-item-p)))
12374 (let ((struct (org-list-struct)))
12375 (org-list-get-ind
12376 (org-list-get-top-point struct) struct))
12378 (cond
12379 ((and (org-at-heading-p)
12380 org-adapt-indentation)
12381 (1+ (org-current-level)))
12382 ((org-at-heading-p) 0)
12383 (t (org-get-indentation))))))
12384 (setq bul (org-list-bullet-string "-"))
12385 (org-indent-line-to ind)
12386 (insert bul (pop lines))
12387 (let ((ind-body (+ (length bul) ind)))
12388 (while lines
12390 (org-indent-line-to ind-body)
12391 (insert (pop lines))))
12392 (message "Note stored")
12393 (org-back-to-heading t)
12394 (org-cycle-hide-drawers 'children)))))
12395 (set-window-configuration org-log-note-window-configuration)
12396 (with-current-buffer (marker-buffer org-log-note-return-to)
12397 (goto-char org-log-note-return-to))
12398 (move-marker org-log-note-return-to nil)
12399 (and org-log-post-message (message "%s" org-log-post-message)))
12401 (defun org-remove-empty-drawer-at (drawer pos)
12402 "Remove an empty drawer DRAWER at position POS.
12403 POS may also be a marker."
12404 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12405 (save-excursion
12406 (save-restriction
12407 (widen)
12408 (goto-char pos)
12409 (if (org-in-regexp
12411 (replace-match ""))))))
12413 (defun org-sparse-tree (&optional arg)
12414 "Create a sparse tree, prompt for the details.
12415 This command can create sparse trees. You first need to select the type
12416 of match used to create the tree:
12418 t Show all TODO entries.
12419 T Show entries with a specific TODO keyword.
12420 m Show entries selected by a tags/property match.
12421 p Enter a property name and its value (both with completion on existing
12422 names/values) and show entries with that property.
12423 r Show entries matching a regular expression (`/' can be used as well)
12424 d Show deadlines due within `org-deadline-warning-days'.
12425 b Show deadlines and scheduled items before a date.
12426 a Show deadlines and scheduled items after a date."
12427 (interactive "P")
12428 (let (ans kwd value)
12429 (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")
12430 (setq ans (read-char-exclusive))
12431 (cond
12432 ((equal ans ?d)
12433 (call-interactively 'org-check-deadlines))
12434 ((equal ans ?b)
12435 (call-interactively 'org-check-before-date))
12436 ((equal ans ?a)
12437 (call-interactively 'org-check-after-date))
12438 ((equal ans ?D)
12439 (call-interactively 'org-check-dates-range))
12440 ((equal ans ?t)
12441 (org-show-todo-tree nil))
12442 ((equal ans ?T)
12443 (org-show-todo-tree '(4)))
12444 ((member ans '(?T ?m))
12445 (call-interactively 'org-match-sparse-tree))
12446 ((member ans '(?p ?P))
12447 (setq kwd (org-icompleting-read "Property: "
12448 (mapcar 'list (org-buffer-property-keys))))
12449 (setq value (org-icompleting-read "Value: "
12450 (mapcar 'list (org-property-values kwd))))
12453 (org-match-sparse-tree arg (concat kwd "=" value)))
12454 ((member ans '(?r ?R ?/))
12455 (call-interactively 'org-occur))
12458 (defvar org-occur-highlights nil
12459 "List of overlays used for occur matches.")
12460 (make-variable-buffer-local 'org-occur-highlights)
12461 (defvar org-occur-parameters nil
12462 "Parameters of the active org-occur calls.
12463 This is a list, each call to org-occur pushes as cons cell,
12464 containing the regular expression and the callback, onto the list.
12465 The list can contain several entries if `org-occur' has been called
12466 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12467 will only contain one set of parameters. When the highlights are
12468 removed (for example with `C-c C-c', or with the next edit (depending
12469 on `org-remove-highlights-with-change'), this variable is emptied
12470 as well.")
12471 (make-variable-buffer-local 'org-occur-parameters)
12473 (defun org-occur (regexp &optional keep-previous callback)
12474 "Make a compact tree which shows all matches of REGEXP.
12475 The tree will show the lines where the regexp matches, and all higher
12476 headlines above the match. It will also show the heading after the match,
12477 to make sure editing the matching entry is easy.
12478 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12479 call to `org-occur' will be kept, to allow stacking of calls to this
12480 command.
12481 If CALLBACK is non-nil, it is a function which is called to confirm
12482 that the match should indeed be shown."
12484 (when (equal regexp "")
12485 (error "Regexp cannot be empty"))
12486 (unless keep-previous
12487 (org-remove-occur-highlights nil nil t))
12488 (push (cons regexp callback) org-occur-parameters)
12489 (let ((cnt 0))
12490 (save-excursion
12491 (goto-char (point-min))
12492 (if (or (not keep-previous) ; do not want to keep
12493 (not org-occur-highlights)) ; no previous matches
12494 ;; hide everything
12495 (org-overview))
12496 (while (re-search-forward regexp nil t)
12497 (when (or (not callback)
12498 (save-match-data (funcall callback)))
12499 (setq cnt (1+ cnt))
12500 (when org-highlight-sparse-tree-matches
12501 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12502 (org-show-context 'occur-tree))))
12503 (when org-remove-highlights-with-change
12504 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12505 nil 'local))
12506 (unless org-sparse-tree-open-archived-trees
12507 (org-hide-archived-subtrees (point-min) (point-max)))
12508 (run-hooks 'org-occur-hook)
12509 (if (org-called-interactively-p 'interactive)
12510 (message "%d match(es) for regexp %s" cnt regexp))
12511 cnt))
12513 (defun org-occur-next-match (&optional n reset)
12514 "Function for `next-error-function' to find sparse tree matches.
12515 N is the number of matches to move, when negative move backwards.
12516 RESET is entirely ignored - this function always goes back to the
12517 starting point when no match is found."
12518 (let* ((limit (if (< n 0) (point-min) (point-max)))
12519 (search-func (if (< n 0)
12520 'previous-single-char-property-change
12521 'next-single-char-property-change))
12522 (n (abs n))
12523 (pos (point))
12524 p1)
12525 (catch 'exit
12526 (while (setq p1 (funcall search-func (point) 'org-type))
12527 (when (equal p1 limit)
12528 (goto-char pos)
12529 (error "No more matches"))
12530 (when (equal (get-char-property p1 'org-type) 'org-occur)
12531 (setq n (1- n))
12532 (when (= n 0)
12533 (goto-char p1)
12534 (throw 'exit (point))))
12535 (goto-char p1))
12536 (goto-char p1)
12537 (error "No more matches"))))
12539 (defun org-show-context (&optional key)
12540 "Make sure point and context are visible.
12541 How much context is shown depends upon the variables
12542 `org-show-hierarchy-above', `org-show-following-heading',
12543 `org-show-entry-below' and `org-show-siblings'."
12544 (let ((heading-p (org-at-heading-p t))
12545 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12546 (following-p (org-get-alist-option org-show-following-heading key))
12547 (entry-p (org-get-alist-option org-show-entry-below key))
12548 (siblings-p (org-get-alist-option org-show-siblings key)))
12549 (catch 'exit
12550 ;; Show heading or entry text
12551 (if (and heading-p (not entry-p))
12552 (org-flag-heading nil) ; only show the heading
12553 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12554 (org-show-hidden-entry))) ; show entire entry
12555 (when following-p
12556 ;; Show next sibling, or heading below text
12557 (save-excursion
12558 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12559 (org-flag-heading nil))))
12560 (when siblings-p (org-show-siblings))
12561 (when hierarchy-p
12562 ;; show all higher headings, possibly with siblings
12563 (save-excursion
12564 (while (and (condition-case nil
12565 (progn (org-up-heading-all 1) t)
12566 (error nil))
12567 (not (bobp)))
12568 (org-flag-heading nil)
12569 (when siblings-p (org-show-siblings))))))))
12571 (defvar org-reveal-start-hook nil
12572 "Hook run before revealing a location.")
12574 (defun org-reveal (&optional siblings)
12575 "Show current entry, hierarchy above it, and the following headline.
12576 This can be used to show a consistent set of context around locations
12577 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12578 not t for the search context.
12580 With optional argument SIBLINGS, on each level of the hierarchy all
12581 siblings are shown. This repairs the tree structure to what it would
12582 look like when opened with hierarchical calls to `org-cycle'.
12584 go to the parent and show the
12585 entire tree."
12586 (interactive "P")
12587 (run-hooks 'org-reveal-start-hook)
12588 (let ((org-show-hierarchy-above t)
12589 (org-show-following-heading t)
12590 (org-show-siblings (if siblings t org-show-siblings)))
12591 (org-show-context nil))
12592 (when (equal siblings '(16))
12593 (save-excursion
12594 (when (org-up-heading-safe)
12595 (org-show-subtree)
12596 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12598 (defun org-highlight-new-match (beg end)
12599 "Highlight from BEG to END and mark the highlight is an occur headline."
12600 (let ((ov (make-overlay beg end)))
12601 (overlay-put ov 'face 'secondary-selection)
12602 (overlay-put ov 'org-type 'org-occur)
12603 (push ov org-occur-highlights)))
12605 (defun org-remove-occur-highlights (&optional beg end noremove)
12606 "Remove the occur highlights from the buffer.
12607 BEG and END are ignored. If NOREMOVE is nil, remove this function
12608 from the `before-change-functions' in the current buffer."
12609 (interactive)
12610 (unless org-inhibit-highlight-removal
12611 (mapc 'delete-overlay org-occur-highlights)
12612 (setq org-occur-highlights nil)
12613 (setq org-occur-parameters nil)
12614 (unless noremove
12615 (remove-hook 'before-change-functions
12616 'org-remove-occur-highlights 'local))))
12618 ;;;; Priorities
12621 "Regular expression matching the priority indicator.")
12623 (defvar org-remove-priority-next-time nil)
12625 (defun org-priority-up ()
12626 "Increase the priority of the current item."
12627 (interactive)
12628 (org-priority 'up))
12630 (defun org-priority-down ()
12631 "Decrease the priority of the current item."
12632 (interactive)
12633 (org-priority 'down))
12635 (defun org-priority (&optional action)
12636 "Change the priority of an item by ARG.
12637 ACTION can be `set', `up', `down', or a character."
12638 (interactive)
12639 (unless org-enable-priority-commands
12640 (error "Priority commands are disabled"))
12641 (setq action (or action 'set))
12642 (let (current new news have remove)
12643 (save-excursion
12644 (org-back-to-heading t)
12645 (if (looking-at org-priority-regexp)
12646 (setq current (string-to-char (match-string 2))
12647 have t))
12648 (cond
12649 ((eq action 'remove)
12650 (setq remove t new ?\ ))
12651 ((or (eq action 'set)
12652 (if (featurep 'xemacs) (characterp action) (integerp action)))
12653 (if (not (eq action 'set))
12654 (setq new action)
12655 (message "Priority %c-%c, SPC to remove: "
12656 org-highest-priority org-lowest-priority)
12657 (save-match-data
12658 (setq new (read-char-exclusive))))
12659 (if (and (= (upcase org-highest-priority) org-highest-priority)
12660 (= (upcase org-lowest-priority) org-lowest-priority))
12661 (setq new (upcase new)))
12662 (cond ((equal new ?\ ) (setq remove t))
12663 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12664 (error "Priority must be between `%c' and `%c'"
12665 org-highest-priority org-lowest-priority))))
12666 ((eq action 'up)
12667 (setq new (if have
12668 (1- current) ; normal cycling
12669 ;; last priority was empty
12670 (if (eq last-command this-command)
12671 org-lowest-priority ; wrap around empty to lowest
12672 ;; default
12673 (if org-priority-start-cycle-with-default
12674 org-default-priority
12675 (1- org-default-priority))))))
12676 ((eq action 'down)
12677 (setq new (if have
12678 (1+ current) ; normal cycling
12679 ;; last priority was empty
12680 (if (eq last-command this-command)
12681 org-highest-priority ; wrap around empty to highest
12682 ;; default
12683 (if org-priority-start-cycle-with-default
12684 org-default-priority
12685 (1+ org-default-priority))))))
12686 (t (error "Invalid action")))
12687 (if (or (< (upcase new) org-highest-priority)
12688 (> (upcase new) org-lowest-priority))
12689 (if (and (memq action '(up down))
12690 (not have) (not (eq last-command this-command)))
12691 ;; `new' is from default priority
12692 (error
12693 "The default can not be set, see `org-default-priority' why")
12694 ;; normal cycling: `new' is beyond highest/lowest priority
12695 ;; and is wrapped around to the empty priority
12696 (setq remove t)))
12697 (setq news (format "%c" new))
12698 (if have
12699 (if remove
12700 (replace-match "" t t nil 1)
12701 (replace-match news t t nil 2))
12702 (if remove
12703 (error "No priority cookie found in line")
12704 (let ((case-fold-search nil))
12705 (looking-at org-todo-line-regexp))
12706 (if (match-end 2)
12707 (progn
12708 (goto-char (match-end 2))
12709 (insert " [#" news "]"))
12710 (goto-char (match-beginning 3))
12711 (insert "[#" news "] "))))
12712 (org-preserve-lc (org-set-tags nil 'align)))
12713 (if remove
12714 (message "Priority removed")
12715 (message "Priority of current item set to %s" news))))
12717 (defun org-get-priority (s)
12718 "Find priority cookie and return priority."
12719 (if (functionp org-get-priority-function)
12720 (funcall org-get-priority-function)
12721 (save-match-data
12722 (if (not (string-match org-priority-regexp s))
12723 (* 1000 (- org-lowest-priority org-default-priority))
12724 (* 1000 (- org-lowest-priority
12725 (string-to-char (match-string 2 s))))))))
12727 ;;;; Tags
12729 (defvar org-agenda-archives-mode)
12730 (defvar org-map-continue-from nil
12731 "Position from where mapping should continue.
12732 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12734 (defvar org-scanner-tags nil
12735 "The current tag list while the tags scanner is running.")
12736 (defvar org-trust-scanner-tags nil
12737 "Should `org-get-tags-at' use the tags for the scanner.
12738 This is for internal dynamical scoping only.
12739 When this is non-nil, the function `org-get-tags-at' will return the value
12740 of `org-scanner-tags' instead of building the list by itself. This
12741 can lead to large speed-ups when the tags scanner is used in a file with
12742 many entries, and when the list of tags is retrieved, for example to
12743 obtain a list of properties. Building the tags list for each entry in such
12744 a file becomes an N^2 operation - but with this variable set, it scales
12745 as N.")
12747 (defun org-scan-tags (action matcher &optional todo-only start-level)
12748 "Scan headline tags with inheritance and produce output ACTION.
12750 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12751 or `agenda' to produce an entry list for an agenda view. It can also be
12752 a Lisp form or a function that should be called at each matched headline, in
12753 this case the return value is a list of all return values from these calls.
12755 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12756 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12757 only lines with a TODO keyword are included in the output.
12759 START-LEVEL can be a string with asterisks, reducing the scope to
12760 headlines matching this string."
12761 (require 'org-agenda)
12762 (let* ((re (concat "^"
12763 (if start-level
12764 ;; Get the correct level to match
12766 org-outline-regexp)
12769 (org-re
12771 (props (list 'face 'default
12772 'done-face 'org-agenda-done
12773 'undone-face 'default
12774 'mouse-face 'highlight
12775 'org-not-done-regexp org-not-done-regexp
12776 'org-todo-regexp org-todo-regexp
12777 'org-complex-heading-regexp org-complex-heading-regexp
12778 'help-echo
12779 (format "mouse-2 or RET jump to org file %s"
12780 (abbreviate-file-name
12781 (or (buffer-file-name (buffer-base-buffer))
12782 (buffer-name (buffer-base-buffer)))))))
12783 (case-fold-search nil)
12784 (org-map-continue-from nil)
12785 lspos tags tags-list
12786 (tags-alist (list (cons 0 org-file-tags)))
12787 (llast 0) rtn rtn1 level category i txt
12788 todo marker entry priority)
12789 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12790 (setq action (list 'lambda nil action)))
12791 (save-excursion
12792 (goto-char (point-min))
12793 (when (eq action 'sparse-tree)
12794 (org-overview)
12795 (org-remove-occur-highlights))
12796 (while (re-search-forward re nil t)
12797 (setq org-map-continue-from nil)
12798 (catch :skip
12799 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12800 tags (if (match-end 4) (org-match-string-no-properties 4)))
12801 (goto-char (setq lspos (match-beginning 0)))
12802 (setq level (org-reduced-level (funcall outline-level))
12803 category (org-get-category))
12804 (setq i llast llast level)
12805 ;; remove tag lists from same and sublevels
12806 (while (>= i level)
12807 (when (setq entry (assoc i tags-alist))
12808 (setq tags-alist (delete entry tags-alist)))
12809 (setq i (1- i)))
12810 ;; add the next tags
12811 (when tags
12812 (setq tags (org-split-string tags ":")
12813 tags-alist
12814 (cons (cons level tags) tags-alist)))
12815 ;; compile tags for current headline
12816 (setq tags-list
12817 (if org-use-tag-inheritance
12818 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12819 tags)
12820 org-scanner-tags tags-list)
12821 (when org-use-tag-inheritance
12822 (setcdr (car tags-alist)
12823 (mapcar (lambda (x)
12824 (setq x (copy-sequence x))
12825 (org-add-prop-inherited x))
12826 (cdar tags-alist))))
12827 (when (and tags org-use-tag-inheritance
12828 (or (not (eq t org-use-tag-inheritance))
12829 org-tags-exclude-from-inheritance))
12830 ;; selective inheritance, remove uninherited ones
12831 (setcdr (car tags-alist)
12832 (org-remove-uninherited-tags (cdar tags-alist))))
12833 (when (and
12835 ;; eval matcher only when the todo condition is OK
12836 (and (or (not todo-only) (member todo org-not-done-keywords))
12837 (let ((case-fold-search t)) (eval matcher)))
12839 ;; Call the skipper, but return t if it does not skip,
12840 ;; so that the `and' form continues evaluating
12841 (progn
12842 (unless (eq action 'sparse-tree) (org-agenda-skip))
12843 t)
12845 ;; Check if timestamps are deselecting this entry
12846 (or (not todo-only)
12847 (and (member todo org-not-done-keywords)
12848 (or (not org-agenda-tags-todo-honor-ignore-options)
12849 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12851 ;; Extra check for the archive tag
12852 ;; FIXME: Does the skipper already do this????
12853 (or
12854 (not (member org-archive-tag tags-list))
12855 ;; we have an archive tag, should we use this anyway?
12856 (or (not org-agenda-skip-archived-trees)
12857 (and (eq action 'agenda) org-agenda-archives-mode))))
12859 ;; select this headline
12861 (cond
12862 ((eq action 'sparse-tree)
12863 (and org-highlight-sparse-tree-matches
12864 (org-get-heading) (match-end 0)
12865 (org-highlight-new-match
12866 (match-beginning 0) (match-beginning 1)))
12867 (org-show-context 'tags-tree))
12868 ((eq action 'agenda)
12869 (setq txt (org-agenda-format-item
12870 ""
12871 (concat
12872 (if (eq org-tags-match-list-sublevels 'indented)
12873 (make-string (1- level) ?.) "")
12874 (org-get-heading))
12875 category
12876 tags-list
12877 )
12878 priority (org-get-priority txt))
12879 (goto-char lspos)
12880 (setq marker (org-agenda-new-marker))
12881 (org-add-props txt props
12882 'org-marker marker 'org-hd-marker marker 'org-category category
12883 'todo-state todo
12884 'priority priority 'type "tagsmatch")
12885 (push txt rtn))
12886 ((functionp action)
12887 (setq org-map-continue-from nil)
12888 (save-excursion
12889 (setq rtn1 (funcall action))
12890 (push rtn1 rtn)))
12891 (t (error "Invalid action")))
12893 ;; if we are to skip sublevels, jump to end of subtree
12894 (unless org-tags-match-list-sublevels
12895 (org-end-of-subtree t)
12896 (backward-char 1))))
12897 ;; Get the correct position from where to continue
12898 (if org-map-continue-from
12899 (goto-char org-map-continue-from)
12900 (and (= (point) lspos) (end-of-line 1)))))
12901 (when (and (eq action 'sparse-tree)
12902 (not org-sparse-tree-open-archived-trees))
12903 (org-hide-archived-subtrees (point-min) (point-max)))
12904 (nreverse rtn)))
12906 (defun org-remove-uninherited-tags (tags)
12907 "Remove all tags that are not inherited from the list TAGS."
12908 (cond
12909 ((eq org-use-tag-inheritance t)
12910 (if org-tags-exclude-from-inheritance
12911 (org-delete-all org-tags-exclude-from-inheritance tags)
12912 tags))
12913 ((not org-use-tag-inheritance) nil)
12914 ((stringp org-use-tag-inheritance)
12915 (delq nil (mapcar
12916 (lambda (x)
12917 (if (and (string-match org-use-tag-inheritance x)
12918 (not (member x org-tags-exclude-from-inheritance)))
12919 x nil))
12920 tags)))
12921 ((listp org-use-tag-inheritance)
12922 (delq nil (mapcar
12923 (lambda (x)
12924 (if (member x org-use-tag-inheritance) x nil))
12925 tags)))))
12927 (defvar todo-only) ;; dynamically scoped
12929 (defun org-match-sparse-tree (&optional todo-only match)
12930 "Create a sparse tree according to tags string MATCH.
12931 MATCH can contain positive and negative selection of tags, like
12933 If optional argument TODO-ONLY is non-nil, only select lines that are
12934 also TODO lines."
12935 (interactive "P")
12936 (org-prepare-agenda-buffers (list (current-buffer)))
12937 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12939 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12941 (defvar org-cached-props nil)
12942 (defun org-cached-entry-get (pom property)
12943 (if (or (eq t org-use-property-inheritance)
12944 (and (stringp org-use-property-inheritance)
12945 (string-match org-use-property-inheritance property))
12946 (and (listp org-use-property-inheritance)
12947 (member property org-use-property-inheritance)))
12948 ;; Caching is not possible, check it directly
12949 (org-entry-get pom property 'inherit)
12950 ;; Get all properties, so that we can do complicated checks easily
12951 (cdr (assoc property (or org-cached-props
12952 (setq org-cached-props
12953 (org-entry-properties pom)))))))
12955 (defun org-global-tags-completion-table (&optional files)
12956 "Return the list of all tags in all agenda buffer/files.
12957 Optional FILES argument is a list of files to which can be used
12958 instead of the agenda files."
12959 (save-excursion
12960 (org-uniquify
12961 (delq nil
12962 (apply 'append
12963 (mapcar
12964 (lambda (file)
12965 (set-buffer (find-file-noselect file))
12966 (append (org-get-buffer-tags)
12967 (mapcar (lambda (x) (if (stringp (car-safe x))
12968 (list (car-safe x)) nil))
12969 org-tag-alist)))
12970 (if (and files (car files))
12971 files
12972 (org-agenda-files))))))))
12974 (defun org-make-tags-matcher (match)
12975 "Create the TAGS/TODO matcher form for the selection string MATCH."
12976 ;; todo-only is scoped dynamically into this function, and the function
12977 ;; may change it if the matcher asks for it.
12978 (unless match
12979 ;; Get a new match request, with completion
12980 (let ((org-last-tags-completion-table
12981 (org-global-tags-completion-table)))
12982 (setq match (org-completing-read-no-i
12983 "Match: " 'org-tags-completion-function nil nil nil
12984 'org-tags-history))))
12986 ;; Parse the string and create a lisp form
12987 (let ((match0 match)
12988 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12989 minus tag mm
12990 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12991 orterms term orlist re-p str-p level-p level-op time-p
12992 prop-p pn pv po gv rest)
12993 (if (string-match "/+" match)
12994 ;; match contains also a todo-matching request
12995 (progn
12996 (setq tagsmatch (substring match 0 (match-beginning 0))
12997 todomatch (substring match (match-end 0)))
12998 (if (string-match "^!" todomatch)
12999 (setq todo-only t todomatch (substring todomatch 1)))
13001 (setq todomatch nil)))
13002 ;; only matching tags
13003 (setq tagsmatch match todomatch nil))
13005 ;; Make the tags matcher
13007 (setq tagsmatcher t)
13008 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13009 (while (setq term (pop orterms))
13011 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13012 (while (string-match re term)
13013 (setq rest (substring term (match-end 0))
13014 minus (and (match-end 1)
13015 (equal (match-string 1 term) "-"))
13016 tag (save-match-data (replace-regexp-in-string
13018 (match-string 2 term)))
13019 re-p (equal (string-to-char tag) ?{)
13020 level-p (match-end 4)
13021 prop-p (match-end 5)
13022 mm (cond
13023 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13024 (level-p
13025 (setq level-op (org-op-to-function (match-string 3 term)))
13026 `(,level-op level ,(string-to-number
13027 (match-string 4 term))))
13028 (prop-p
13029 (setq pn (match-string 5 term)
13030 po (match-string 6 term)
13031 pv (match-string 7 term)
13032 re-p (equal (string-to-char pv) ?{)
13034 time-p (save-match-data
13036 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13037 (if time-p (setq pv (org-matcher-time pv)))
13038 (setq po (org-op-to-function po (if time-p 'time str-p)))
13039 (cond
13040 ((equal pn "CATEGORY")
13041 (setq gv '(get-text-property (point) 'org-category)))
13042 ((equal pn "TODO")
13043 (setq gv 'todo))
13044 (t
13045 (setq gv `(org-cached-entry-get nil ,pn))))
13046 (if re-p
13047 (if (eq po 'org<>)
13048 `(not (string-match ,pv (or ,gv "")))
13049 `(string-match ,pv (or ,gv "")))
13050 (if str-p
13051 `(,po (or ,gv "") ,pv)
13052 `(,po (string-to-number (or ,gv ""))
13053 ,(string-to-number pv) ))))
13054 (t `(member ,tag tags-list)))
13055 mm (if minus (list 'not mm) mm)
13056 term rest)
13057 (push mm tagsmatcher))
13058 (push (if (> (length tagsmatcher) 1)
13059 (cons 'and tagsmatcher)
13060 (car tagsmatcher))
13061 orlist)
13062 (setq tagsmatcher nil))
13063 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13064 (setq tagsmatcher
13065 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13066 ;; Make the todo matcher
13068 (setq todomatcher t)
13069 (setq orterms (org-split-string todomatch "|") orlist nil)
13070 (while (setq term (pop orterms))
13071 (while (string-match re term)
13072 (setq minus (and (match-end 1)
13073 (equal (match-string 1 term) "-"))
13074 kwd (match-string 2 term)
13075 re-p (equal (string-to-char kwd) ?{)
13076 term (substring term (match-end 0))
13077 mm (if re-p
13078 `(string-match ,(substring kwd 1 -1) todo)
13079 (list 'equal 'todo kwd))
13080 mm (if minus (list 'not mm) mm))
13081 (push mm todomatcher))
13082 (push (if (> (length todomatcher) 1)
13083 (cons 'and todomatcher)
13084 (car todomatcher))
13085 orlist)
13086 (setq todomatcher nil))
13087 (setq todomatcher (if (> (length orlist) 1)
13088 (cons 'or orlist) (car orlist))))
13090 ;; Return the string and lisp forms of the matcher
13091 (setq matcher (if todomatcher
13092 (list 'and tagsmatcher todomatcher)
13093 tagsmatcher))
13094 (cons match0 matcher)))
13096 (defun org-op-to-function (op &optional stringp)
13097 "Turn an operator into the appropriate function."
13098 (setq op
13099 (cond
13100 ((equal op "<" ) '(< string< org-time<))
13101 ((equal op ">" ) '(> org-string> org-time>))
13102 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13103 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13104 ((member op '("=" "==")) '(= string= org-time=))
13105 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13106 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13108 (defun org<> (a b) (not (= a b)))
13109 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13110 (defun org-string>= (a b) (not (string< a b)))
13111 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13112 (defun org-string<> (a b) (not (string= a b)))
13113 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13114 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13115 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13116 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13117 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13118 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13119 (defun org-2ft (s)
13120 "Convert S to a floating point time.
13121 If S is already a number, just return it. If it is a string, parse
13122 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13123 (cond
13124 ((numberp s) s)
13125 ((stringp s)
13126 (condition-case nil
13127 (float-time (apply 'encode-time (org-parse-time-string s)))
13128 (error 0.)))
13129 (t 0.)))
13131 (defun org-time-today ()
13132 "Time in seconds today at 0:00.
13133 Returns the float number of seconds since the beginning of the
13134 epoch to the beginning of today (00:00)."
13135 (float-time (apply 'encode-time
13136 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13138 (defun org-matcher-time (s)
13139 "Interpret a time comparison value."
13140 (save-match-data
13141 (cond
13142 ((string= s "<now>") (float-time))
13143 ((string= s "<today>") (org-time-today))
13144 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13145 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13147 (+ (org-time-today)
13148 (* (string-to-number (match-string 1 s))
13149 (cdr (assoc (match-string 2 s)
13150 '(("d" . 86400.0) ("w" . 604800.0)
13151 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13152 (t (org-2ft s)))))
13154 (defun org-match-any-p (re list)
13155 "Does re match any element of list?"
13156 (setq list (mapcar (lambda (x) (string-match re x)) list))
13157 (delq nil list))
13159 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13160 (defvar org-tags-overlay (make-overlay 1 1))
13161 (org-detach-overlay org-tags-overlay)
13163 (defun org-get-local-tags-at (&optional pos)
13164 "Get a list of tags defined in the current headline."
13165 (org-get-tags-at pos 'local))
13167 (defun org-get-local-tags ()
13168 "Get a list of tags defined in the current headline."
13169 (org-get-tags-at nil 'local))
13171 (defun org-get-tags-at (&optional pos local)
13172 "Get a list of all headline tags applicable at POS.
13173 POS defaults to point. If tags are inherited, the list contains
13174 the targets in the same sequence as the headlines appear, i.e.
13175 the tags of the current headline come last.
13176 When LOCAL is non-nil, only return tags from the current headline,
13177 ignore inherited ones."
13178 (interactive)
13179 (if (and org-trust-scanner-tags
13180 (or (not pos) (equal pos (point)))
13181 (not local))
13182 org-scanner-tags
13183 (let (tags ltags lastpos parent)
13184 (save-excursion
13185 (save-restriction
13186 (widen)
13187 (goto-char (or pos (point)))
13188 (save-match-data
13189 (catch 'done
13190 (condition-case nil
13191 (progn
13192 (org-back-to-heading t)
13193 (while (not (equal lastpos (point)))
13194 (setq lastpos (point))
13195 (when (looking-at
13197 (setq ltags (org-split-string
13198 (org-match-string-no-properties 1) ":"))
13199 (when parent
13200 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13201 (setq tags (append
13202 (if parent
13203 (org-remove-uninherited-tags ltags)
13204 ltags)
13205 tags)))
13206 (or org-use-tag-inheritance (throw 'done t))
13207 (if local (throw 'done t))
13208 (or (org-up-heading-safe) (error nil))
13209 (setq parent t)))
13210 (error nil)))))
13211 (if local
13212 tags
13213 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13215 (defun org-add-prop-inherited (s)
13216 (add-text-properties 0 (length s) '(inherited t) s)
13217 s)
13219 (defun org-toggle-tag (tag &optional onoff)
13220 "Toggle the tag TAG for the current line.
13221 If ONOFF is `on' or `off', don't toggle but set to this state."
13222 (let (res current)
13223 (save-excursion
13224 (org-back-to-heading t)
13226 (point-at-eol) t)
13227 (progn
13228 (setq current (match-string 1))
13229 (replace-match ""))
13230 (setq current ""))
13231 (setq current (nreverse (org-split-string current ":")))
13232 (cond
13233 ((eq onoff 'on)
13234 (setq res t)
13235 (or (member tag current) (push tag current)))
13236 ((eq onoff 'off)
13237 (or (not (member tag current)) (setq current (delete tag current))))
13238 (t (if (member tag current)
13239 (setq current (delete tag current))
13240 (setq res t)
13241 (push tag current))))
13242 (end-of-line 1)
13243 (if current
13244 (progn
13245 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13246 (org-set-tags nil t))
13247 (delete-horizontal-space))
13248 (run-hooks 'org-after-tags-change-hook))
13249 res))
13251 (defun org-align-tags-here (to-col)
13252 ;; Assumes that this is a headline
13253 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13254 (beginning-of-line 1)
13256 (< pos (match-beginning 2)))
13257 (progn
13258 (setq tags-l (- (match-end 2) (match-beginning 2)))
13259 (goto-char (match-beginning 1))
13260 (insert " ")
13261 (delete-region (point) (1+ (match-beginning 2)))
13262 (setq ncol (max (current-column)
13263 (1+ col)
13264 (if (> to-col 0)
13265 to-col
13266 (- (abs to-col) tags-l))))
13267 (setq p (point))
13268 (insert (make-string (- ncol (current-column)) ?\ ))
13269 (setq ncol (current-column))
13270 (when indent-tabs-mode (tabify p (point-at-eol)))
13271 (org-move-to-column (min ncol col) t))
13272 (goto-char pos))))
13274 (defun org-set-tags-command (&optional arg just-align)
13275 "Call the set-tags command for the current entry."
13276 (interactive "P")
13277 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13278 (org-set-tags arg just-align)
13279 (save-excursion
13280 (org-back-to-heading t)
13281 (org-set-tags arg just-align))))
13283 (defun org-set-tags-to (data)
13284 "Set the tags of the current entry to DATA, replacing the current tags.
13285 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13286 If DATA is nil or the empty string, any tags will be removed."
13287 (interactive "sTags: ")
13288 (setq data
13289 (cond
13290 ((eq data nil) "")
13291 ((equal data "") "")
13292 ((stringp data)
13293 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13294 ":"))
13295 ((listp data)
13296 (concat ":" (mapconcat 'identity data ":") ":"))
13297 (t nil)))
13298 (when data
13299 (save-excursion
13300 (org-back-to-heading t)
13301 (when (looking-at org-complex-heading-regexp)
13302 (if (match-end 5)
13303 (progn
13304 (goto-char (match-beginning 5))
13305 (insert data)
13306 (delete-region (point) (point-at-eol))
13307 (org-set-tags nil 'align))
13308 (goto-char (point-at-eol))
13309 (insert " " data)
13310 (org-set-tags nil 'align)))
13311 (beginning-of-line 1)
13313 (delete-region (match-beginning 1) (match-end 1))))))
13315 (defun org-align-all-tags ()
13316 "Align the tags i all headings."
13317 (interactive)
13318 (save-excursion
13319 (or (ignore-errors (org-back-to-heading t))
13320 (outline-next-heading))
13321 (if (org-at-heading-p)
13322 (org-set-tags t)
13323 (message "No headings"))))
13325 (defvar org-indent-indentation-per-level)
13326 (defun org-set-tags (&optional arg just-align)
13327 "Set the tags for the current headline.
13328 With prefix ARG, realign all tags in headings in the current buffer."
13329 (interactive "P")
13330 (let* ((re org-outline-regexp-bol)
13331 (current (unless arg (org-get-tags-string)))
13332 (col (current-column))
13333 (org-setting-tags t)
13334 table current-tags inherited-tags ; computed below when needed
13335 tags p0 c0 c1 rpl di tc level)
13336 (if arg
13337 (save-excursion
13338 (goto-char (point-min))
13339 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13340 (while (re-search-forward re nil t)
13341 (org-set-tags nil t)
13342 (end-of-line 1)))
13343 (message "All tags realigned to column %d" org-tags-column))
13344 (if just-align
13345 (setq tags current)
13346 ;; Get a new set of tags from the user
13347 (save-excursion
13348 (setq table (append org-tag-persistent-alist
13349 (or org-tag-alist (org-get-buffer-tags))
13350 (and
13351 org-complete-tags-always-offer-all-agenda-tags
13352 (org-global-tags-completion-table
13353 (org-agenda-files))))
13354 org-last-tags-completion-table table
13355 current-tags (org-split-string current ":")
13356 inherited-tags (nreverse
13357 (nthcdr (length current-tags)
13358 (nreverse (org-get-tags-at))))
13359 tags
13360 (if (or (eq t org-use-fast-tag-selection)
13361 (and org-use-fast-tag-selection
13362 (delq nil (mapcar 'cdr table))))
13363 (org-fast-tag-selection
13364 current-tags inherited-tags table
13365 (if org-fast-tag-selection-include-todo
13366 org-todo-key-alist))
13367 (let ((org-add-colon-after-tag-completion t))
13368 (org-trim
13369 (org-icompleting-read "Tags: "
13370 'org-tags-completion-function
13371 nil nil current 'org-tags-history))))))
13372 (while (string-match "[-+&]+" tags)
13373 ;; No boolean logic, just a list
13374 (setq tags (replace-match ":" t t tags))))
13376 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13378 (if org-tags-sort-function
13379 (setq tags (mapconcat 'identity
13380 (sort (org-split-string
13381 tags (org-re "[^[:alnum:]_@#%]+"))
13382 org-tags-sort-function) ":")))
13385 (setq tags "")
13386 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13387 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13389 ;; Insert new tags at the correct column
13390 (beginning-of-line 1)
13391 (setq level (or (and (looking-at org-outline-regexp)
13392 (- (match-end 0) (point) 1))
13393 1))
13394 (cond
13395 ((and (equal current "") (equal tags "")))
13396 ((re-search-forward
13398 (point-at-eol) t)
13399 (if (equal tags "")
13400 (setq rpl "")
13401 (goto-char (match-beginning 0))
13402 (setq c0 (current-column)
13403 ;; compute offset for the case of org-indent-mode active
13404 di (if org-indent-mode
13405 (* (1- org-indent-indentation-per-level) (1- level))
13406 0)
13407 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13408 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13409 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13410 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13411 (replace-match rpl t t)
13412 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13413 tags)
13414 (t (error "Tags alignment failed")))
13415 (org-move-to-column col)
13416 (unless just-align
13417 (run-hooks 'org-after-tags-change-hook)))))
13419 (defun org-change-tag-in-region (beg end tag off)
13420 "Add or remove TAG for each entry in the region.
13421 This works in the agenda, and also in an org-mode buffer."
13422 (interactive
13423 (list (region-beginning) (region-end)
13424 (let ((org-last-tags-completion-table
13425 (if (eq major-mode 'org-mode)
13426 (org-get-buffer-tags)
13427 (org-global-tags-completion-table))))
13428 (org-icompleting-read
13429 "Tag: " 'org-tags-completion-function nil nil nil
13430 'org-tags-history))
13431 (progn
13433 (equal (read-char-exclusive) ?r))))
13434 (if (fboundp 'deactivate-mark) (deactivate-mark))
13435 (let ((agendap (equal major-mode 'org-agenda-mode))
13436 l1 l2 m buf pos newhead (cnt 0))
13437 (goto-char end)
13438 (setq l2 (1- (org-current-line)))
13439 (goto-char beg)
13440 (setq l1 (org-current-line))
13441 (loop for l from l1 to l2 do
13442 (org-goto-line l)
13443 (setq m (get-text-property (point) 'org-hd-marker))
13444 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13445 (and agendap m))
13446 (setq buf (if agendap (marker-buffer m) (current-buffer))
13447 pos (if agendap m (point)))
13448 (with-current-buffer buf
13449 (save-excursion
13450 (save-restriction
13451 (goto-char pos)
13452 (setq cnt (1+ cnt))
13453 (org-toggle-tag tag (if off 'off 'on))
13454 (setq newhead (org-get-heading)))))
13455 (and agendap (org-agenda-change-all-lines newhead m))))
13456 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13458 (defun org-tags-completion-function (string predicate &optional flag)
13459 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13460 (confirm (lambda (x) (stringp (car x)))))
13462 (setq s1 (match-string 1 string)
13463 s2 (match-string 2 string))
13464 (setq s1 "" s2 string))
13465 (cond
13466 ((eq flag nil)
13467 ;; try completion
13468 (setq rtn (try-completion s2 ctable confirm))
13469 (if (stringp rtn)
13470 (setq rtn
13471 (concat s1 s2 (substring rtn (length s2))
13472 (if (and org-add-colon-after-tag-completion
13473 (assoc rtn ctable))
13474 ":" ""))))
13475 rtn)
13476 ((eq flag t)
13477 ;; all-completions
13478 (all-completions s2 ctable confirm)
13479 )
13480 ((eq flag 'lambda)
13481 ;; exact match?
13482 (assoc s2 ctable)))
13483 ))
13485 (defun org-fast-tag-insert (kwd tags face &optional end)
13486 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13487 (insert (format "%-12s" (concat kwd ":"))
13488 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13489 (or end "")))
13491 (defun org-fast-tag-show-exit (flag)
13492 (save-excursion
13493 (org-goto-line 3)
13495 (replace-match ""))
13496 (when flag
13497 (end-of-line 1)
13498 (org-move-to-column (- (window-width) 19) t)
13499 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13501 (defun org-set-current-tags-overlay (current prefix)
13502 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13503 (if (featurep 'xemacs)
13504 (org-overlay-display org-tags-overlay (concat prefix s)
13505 'secondary-selection)
13506 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13507 (org-overlay-display org-tags-overlay (concat prefix s)))))
13509 (defvar org-last-tag-selection-key nil)
13510 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13511 "Fast tag selection with single keys.
13512 CURRENT is the current list of tags in the headline, INHERITED is the
13513 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13514 possibly with grouping information. TODO-TABLE is a similar table with
13515 TODO keywords, should these have keys assigned to them.
13516 If the keys are nil, a-z are automatically assigned.
13517 Returns the new tags string, or nil to not change the current settings."
13518 (let* ((fulltable (append table todo-table))
13519 (maxlen (apply 'max (mapcar
13520 (lambda (x)
13521 (if (stringp (car x)) (string-width (car x)) 0))
13522 fulltable)))
13523 (buf (current-buffer))
13524 (expert (eq org-fast-tag-selection-single-key 'expert))
13525 (buffer-tags nil)
13526 (fwidth (+ maxlen 3 1 3))
13527 (ncol (/ (- (window-width) 4) fwidth))
13528 (i-face 'org-done)
13529 (c-face 'org-todo)
13530 tg cnt e c char c1 c2 ntable tbl rtn
13531 ov-start ov-end ov-prefix
13532 (exit-after-next org-fast-tag-selection-single-key)
13533 (done-keywords org-done-keywords)
13534 groups ingroup)
13535 (save-excursion
13536 (beginning-of-line 1)
13537 (if (looking-at
13539 (setq ov-start (match-beginning 1)
13540 ov-end (match-end 1)
13541 ov-prefix "")
13542 (setq ov-start (1- (point-at-eol))
13543 ov-end (1+ ov-start))
13545 (setq ov-prefix
13546 (concat
13547 (buffer-substring (1- (point)) (point))
13548 (if (> (current-column) org-tags-column)
13549 " "
13550 (make-string (- org-tags-column (current-column)) ?\ ))))))
13551 (move-overlay org-tags-overlay ov-start ov-end)
13552 (save-window-excursion
13553 (if expert
13554 (set-buffer (get-buffer-create " *Org tags*"))
13555 (delete-other-windows)
13556 (split-window-vertically)
13557 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13558 (erase-buffer)
13559 (org-set-local 'org-done-keywords done-keywords)
13562 (org-fast-tag-show-exit exit-after-next)
13563 (org-set-current-tags-overlay current ov-prefix)
13564 (setq tbl fulltable char ?a cnt 0)
13565 (while (setq e (pop tbl))
13566 (cond
13567 ((equal (car e) :startgroup)
13568 (push '() groups) (setq ingroup t)
13569 (when (not (= cnt 0))
13570 (setq cnt 0)
13572 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13573 ((equal (car e) :endgroup)
13574 (setq ingroup nil cnt 0)
13576 ((equal e '(:newline))
13577 (when (not (= cnt 0))
13578 (setq cnt 0)
13580 (setq e (car tbl))
13581 (while (equal (car tbl) '(:newline))
13583 (setq tbl (cdr tbl)))))
13584 (t
13585 (setq tg (copy-sequence (car e)) c2 nil)
13586 (if (cdr e)
13587 (setq c (cdr e))
13588 ;; automatically assign a character.
13589 (setq c1 (string-to-char
13590 (downcase (substring
13591 tg (if (= (string-to-char tg) ?@) 1 0)))))
13592 (if (or (rassoc c1 ntable) (rassoc c1 table))
13593 (while (or (rassoc char ntable) (rassoc char table))
13594 (setq char (1+ char)))
13595 (setq c2 c1))
13596 (setq c (or c2 char)))
13597 (if ingroup (push tg (car groups)))
13598 (setq tg (org-add-props tg nil 'face
13599 (cond
13600 ((not (assoc tg table))
13601 (org-get-todo-face tg))
13602 ((member tg current) c-face)
13603 ((member tg inherited) i-face)
13604 (t nil))))
13605 (if (and (= cnt 0) (not ingroup)) (insert " "))
13606 (insert "[" c "] " tg (make-string
13607 (- fwidth 4 (length tg)) ?\ ))
13608 (push (cons tg c) ntable)
13609 (when (= (setq cnt (1+ cnt)) ncol)
13611 (if ingroup (insert " "))
13612 (setq cnt 0)))))
13613 (setq ntable (nreverse ntable))
13615 (goto-char (point-min))
13616 (if (not expert) (org-fit-window-to-buffer))
13617 (setq rtn
13618 (catch 'exit
13619 (while t
13620 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13621 (if (not groups) "no " "")
13622 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13623 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13624 (setq org-last-tag-selection-key c)
13625 (cond
13627 ((= c ?!)
13628 (setq groups (not groups))
13629 (goto-char (point-min))
13630 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13631 ((= c ?\C-c)
13632 (if (not expert)
13633 (org-fast-tag-show-exit
13634 (setq exit-after-next (not exit-after-next)))
13635 (setq expert nil)
13636 (delete-other-windows)
13637 (set-window-buffer (split-window-vertically) " *Org tags*")
13638 (org-switch-to-buffer-other-window " *Org tags*")
13639 (org-fit-window-to-buffer)))
13640 ((or (= c ?\C-g)
13641 (and (= c ?q) (not (rassoc c ntable))))
13642 (org-detach-overlay org-tags-overlay)
13643 (setq quit-flag t))
13644 ((= c ?\ )
13645 (setq current nil)
13646 (if exit-after-next (setq exit-after-next 'now)))
13648 (condition-case nil
13649 (setq tg (org-icompleting-read
13650 "Tag: "
13651 (or buffer-tags
13652 (with-current-buffer buf
13653 (org-get-buffer-tags)))))
13654 (quit (setq tg "")))
13656 (add-to-list 'buffer-tags (list tg))
13657 (if (member tg current)
13658 (setq current (delete tg current))
13659 (push tg current)))
13660 (if exit-after-next (setq exit-after-next 'now)))
13661 ((setq e (rassoc c todo-table) tg (car e))
13662 (with-current-buffer buf
13663 (save-excursion (org-todo tg)))
13664 (if exit-after-next (setq exit-after-next 'now)))
13665 ((setq e (rassoc c ntable) tg (car e))
13666 (if (member tg current)
13667 (setq current (delete tg current))
13668 (loop for g in groups do
13669 (if (member tg g)
13670 (mapc (lambda (x)
13671 (setq current (delete x current)))
13672 g)))
13673 (push tg current))
13674 (if exit-after-next (setq exit-after-next 'now))))
13676 ;; Create a sorted list
13677 (setq current
13678 (sort current
13679 (lambda (a b)
13680 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13681 (if (eq exit-after-next 'now) (throw 'exit t))
13682 (goto-char (point-min))
13683 (beginning-of-line 2)
13684 (delete-region (point) (point-at-eol))
13685 (org-fast-tag-insert "Current" current c-face)
13686 (org-set-current-tags-overlay current ov-prefix)
13687 (while (re-search-forward
13689 (setq tg (match-string 1))
13690 (add-text-properties
13691 (match-beginning 1) (match-end 1)
13692 (list 'face
13693 (cond
13694 ((member tg current) c-face)
13695 ((member tg inherited) i-face)
13696 (t (get-text-property (match-beginning 1) 'face))))))
13697 (goto-char (point-min)))))
13698 (org-detach-overlay org-tags-overlay)
13699 (if rtn
13700 (mapconcat 'identity current ":")
13701 nil))))
13703 (defun org-get-tags-string ()
13704 "Get the TAGS string in the current headline."
13705 (unless (org-at-heading-p t)
13706 (error "Not on a heading"))
13707 (save-excursion
13708 (beginning-of-line 1)
13710 (org-match-string-no-properties 1)
13711 "")))
13713 (defun org-get-tags ()
13714 "Get the list of tags specified in the current headline."
13715 (org-split-string (org-get-tags-string) ":"))
13717 (defun org-get-buffer-tags ()
13718 "Get a table of all tags used in the buffer, for completion."
13719 (let (tags)
13720 (save-excursion
13721 (goto-char (point-min))
13722 (while (re-search-forward
13724 (when (equal (char-after (point-at-bol 0)) ?*)
13725 (mapc (lambda (x) (add-to-list 'tags x))
13726 (org-split-string (org-match-string-no-properties 1) ":")))))
13727 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13728 (mapcar 'list tags)))
13730 ;;;; The mapping API
13732 ;;;###autoload
13733 (defun org-map-entries (func &optional match scope &rest skip)
13734 "Call FUNC at each headline selected by MATCH in SCOPE.
13736 FUNC is a function or a lisp form. The function will be called without
13737 arguments, with the cursor positioned at the beginning of the headline.
13738 The return values of all calls to the function will be collected and
13739 returned as a list.
13741 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13742 does not need to preserve point. After evaluation, the cursor will be
13743 moved to the end of the line (presumably of the headline of the
13744 processed entry) and search continues from there. Under some
13745 circumstances, this may not produce the wanted results. For example,
13746 if you have removed (e.g. archived) the current (sub)tree it could
13747 mean that the next entry will be skipped entirely. In such cases, you
13748 can specify the position from where search should continue by making
13749 FUNC set the variable `org-map-continue-from' to the desired buffer
13750 position.
13752 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13753 Only headlines that are matched by this query will be considered during
13754 the iteration. When MATCH is nil or t, all headlines will be
13755 visited by the iteration.
13757 SCOPE determines the scope of this command. It can be any of:
13759 nil The current buffer, respecting the restriction if any
13760 tree The subtree started with the entry at point
13761 region The entries within the active region, if any
13762 region-start-level
13763 The entries within the active region, but only those at
13764 the same level than the first one.
13765 file The current buffer, without restriction
13766 file-with-archives
13767 The current buffer, and any archives associated with it
13768 agenda All agenda files
13769 agenda-with-archives
13770 All agenda files with any archive files associated with them
13771 \(file1 file2 ...)
13772 If this is a list, all files in the list will be scanned
13774 The remaining args are treated as settings for the skipping facilities of
13775 the scanner. The following items can be given here:
13777 archive skip trees with the archive tag.
13778 comment skip trees with the COMMENT keyword
13779 function or Emacs Lisp form:
13780 will be used as value for `org-agenda-skip-function', so whenever
13781 the function returns t, FUNC will not be called for that
13782 entry and search will continue from the point where the
13783 function leaves it.
13785 If your function needs to retrieve the tags including inherited tags
13786 at the *current* entry, you can use the value of the variable
13787 `org-scanner-tags' which will be much faster than getting the value
13788 with `org-get-tags-at'. If your function gets properties with
13789 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13790 to t around the call to `org-entry-properties' to get the same speedup.
13791 Note that if your function moves around to retrieve tags and properties at
13792 a *different* entry, you cannot use these techniques."
13793 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13794 (not (org-region-active-p)))
13795 (let* ((org-agenda-archives-mode nil) ; just to make sure
13796 (org-agenda-skip-archived-trees (memq 'archive skip))
13797 (org-agenda-skip-comment-trees (memq 'comment skip))
13798 (org-agenda-skip-function
13799 (car (org-delete-all '(comment archive) skip)))
13800 (org-tags-match-list-sublevels t)
13801 (start-level (eq scope 'region-start-level))
13802 matcher file res
13803 org-todo-keywords-for-agenda
13804 org-done-keywords-for-agenda
13805 org-todo-keyword-alist-for-agenda
13806 org-drawers-for-agenda
13807 org-tag-alist-for-agenda)
13809 (cond
13810 ((eq match t) (setq matcher t))
13811 ((eq match nil) (setq matcher t))
13812 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13814 (save-excursion
13815 (save-restriction
13816 (cond ((eq scope 'tree)
13817 (org-back-to-heading t)
13818 (org-narrow-to-subtree)
13819 (setq scope nil))
13820 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13821 (org-region-active-p))
13822 ;; If needed, set start-level to a string like "2"
13823 (when start-level
13824 (save-excursion
13825 (goto-char (region-beginning))
13826 (unless (org-at-heading-p) (outline-next-heading))
13827 (setq start-level (org-current-level))))
13828 (narrow-to-region (region-beginning)
13829 (save-excursion
13830 (goto-char (region-end))
13831 (unless (and (bolp) (org-at-heading-p))
13832 (outline-next-heading))
13833 (point)))
13834 (setq scope nil)))
13836 (if (not scope)
13837 (progn
13838 (org-prepare-agenda-buffers
13839 (list (buffer-file-name (current-buffer))))
13840 (setq res (org-scan-tags func matcher nil start-level)))
13841 ;; Get the right scope
13842 (cond
13843 ((and scope (listp scope) (symbolp (car scope)))
13844 (setq scope (eval scope)))
13845 ((eq scope 'agenda)
13846 (setq scope (org-agenda-files t)))
13847 ((eq scope 'agenda-with-archives)
13848 (setq scope (org-agenda-files t))
13849 (setq scope (org-add-archive-files scope)))
13850 ((eq scope 'file)
13851 (setq scope (list (buffer-file-name))))
13852 ((eq scope 'file-with-archives)
13853 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13854 (org-prepare-agenda-buffers scope)
13855 (while (setq file (pop scope))
13856 (with-current-buffer (org-find-base-buffer-visiting file)
13857 (save-excursion
13858 (save-restriction
13859 (widen)
13860 (goto-char (point-min))
13861 (setq res (append res (org-scan-tags func matcher))))))))))
13862 res)))
13864 ;;;; Properties
13866 ;;; Setting and retrieving properties
13868 (defconst org-special-properties
13869 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13870 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13871 "The special properties valid in Org-mode.
13873 These are properties that are not defined in the property drawer,
13874 but in some other way.")
13876 (defconst org-default-properties
13877 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13878 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13879 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13880 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13881 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13882 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13883 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13884 "Some properties that are used by Org-mode for various purposes.
13885 Being in this list makes sure that they are offered for completion.")
13888 "Regular expression matching the first line of a property drawer.")
13891 "Regular expression matching the last line of a property drawer.")
13894 "Regular expression matching the first line of a property drawer.")
13897 "Regular expression matching the first line of a property drawer.")
13899 (defconst org-property-drawer-re
13902 "Matches an entire property drawer.")
13904 (defconst org-clock-drawer-re
13907 "Matches an entire clock drawer.")
13909 (defsubst org-re-property (property)
13910 "Return a regexp matching PROPERTY.
13911 Match group 1 will be set to the value "
13914 (defun org-property-action ()
13915 "Do an action on properties."
13916 (interactive)
13917 (let (c)
13918 (org-at-property-p)
13919 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13920 (setq c (read-char-exclusive))
13921 (cond
13922 ((equal c ?s)
13923 (call-interactively 'org-set-property))
13924 ((equal c ?d)
13925 (call-interactively 'org-delete-property))
13926 ((equal c ?D)
13927 (call-interactively 'org-delete-property-globally))
13928 ((equal c ?c)
13929 (call-interactively 'org-compute-property-at-point))
13930 (t (error "No such property action %c" c)))))
13932 (defun org-set-effort (&optional value)
13933 "Set the effort property of the current entry.
13934 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13935 allowed value."
13936 (interactive "P")
13937 (if (equal value 0) (setq value 10))
13938 (let* ((completion-ignore-case t)
13939 (prop org-effort-property)
13940 (cur (org-entry-get nil prop))
13941 (allowed (org-property-get-allowed-values nil prop 'table))
13942 (existing (mapcar 'list (org-property-values prop)))
13943 rpl
13944 (val (cond
13945 ((stringp value) value)
13946 ((and allowed (integerp value))
13947 (or (car (nth (1- value) allowed))
13948 (car (org-last allowed))))
13949 (allowed
13950 (message "Select 1-9,0, [RET%s]: %s"
13951 (if cur (concat "=" cur) "")
13952 (mapconcat 'car allowed " "))
13953 (setq rpl (read-char-exclusive))
13955 cur
13956 (setq rpl (- rpl ?0))
13957 (if (equal rpl 0) (setq rpl 10))
13958 (if (and (> rpl 0) (<= rpl (length allowed)))
13959 (car (nth (1- rpl) allowed))
13960 (org-completing-read "Effort: " allowed nil))))
13961 (t
13962 (let (org-completion-use-ido org-completion-use-iswitchb)
13963 (org-completing-read
13965 (concat "[" cur "]") "")
13966 ": ")
13967 existing nil nil "" nil cur))))))
13968 (unless (equal (org-entry-get nil prop) val)
13969 (org-entry-put nil prop val))
13970 (message "%s is now %s" prop val)))
13972 (defun org-at-property-p ()
13973 "Is cursor inside a property drawer?"
13974 (save-excursion
13975 (beginning-of-line 1)
13977 (save-match-data ;; Used by calling procedures
13978 (let ((p (point))
13979 (range (unless (org-before-first-heading-p)
13980 (org-get-property-block))))
13981 (and range (<= (car range) p) (< p (cdr range))))))))
13983 (defun org-get-property-block (&optional beg end force)
13984 "Return the (beg . end) range of the body of the property drawer.
13985 BEG and END can be beginning and end of subtree, if not given
13986 they will be found.
13987 If the drawer does not exist and FORCE is non-nil, create the drawer."
13988 (catch 'exit
13989 (save-excursion
13990 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13991 (end (or end (progn (outline-next-heading) (point)))))
13992 (goto-char beg)
13993 (if (re-search-forward org-property-start-re end t)
13994 (setq beg (1+ (match-end 0)))
13995 (if force
13996 (save-excursion
13997 (org-insert-property-drawer)
13998 (setq end (progn (outline-next-heading) (point))))
13999 (throw 'exit nil))
14000 (goto-char beg)
14001 (if (re-search-forward org-property-start-re end t)
14002 (setq beg (1+ (match-end 0)))))
14003 (if (re-search-forward org-property-end-re end t)
14004 (setq end (match-beginning 0))
14005 (or force (throw 'exit nil))
14006 (goto-char beg)
14007 (setq end beg)
14008 (org-indent-line-function)
14010 (cons beg end)))))
14012 (defun org-entry-properties (&optional pom which specific)
14013 "Get all properties of the entry at point-or-marker POM.
14014 This includes the TODO keyword, the tags, time strings for deadline,
14015 scheduled, and clocking, and any additional properties defined in the
14016 entry. The return value is an alist, keys may occur multiple times
14017 if the property key was used several times.
14018 POM may also be nil, in which case the current entry is used.
14019 If WHICH is nil or `all', get all properties. If WHICH is
14020 `special' or `standard', only get that subclass. If WHICH
14021 is a string only get exactly this property. SPECIFIC can be a string, the
14022 specific property we are interested in. Specifying it can speed
14023 things up because then unnecessary parsing is avoided."
14024 (setq which (or which 'all))
14025 (org-with-point-at pom
14026 (let ((clockstr (substring org-clock-string 0 -1))
14027 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14028 (case-fold-search nil)
14029 beg end range props sum-props key key1 value string clocksum)
14030 (save-excursion
14031 (when (condition-case nil
14032 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14033 (error nil))
14034 (setq beg (point))
14035 (setq sum-props (get-text-property (point) 'org-summaries))
14036 (setq clocksum (get-text-property (point) :org-clock-minutes))
14037 (outline-next-heading)
14038 (setq end (point))
14039 (when (memq which '(all special))
14040 ;; Get the special properties, like TODO and tags
14041 (goto-char beg)
14042 (when (and (or (not specific) (string= specific "TODO"))
14043 (looking-at org-todo-line-regexp) (match-end 2))
14044 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14045 (when (and (or (not specific) (string= specific "PRIORITY"))
14046 (looking-at org-priority-regexp))
14047 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14048 (when (or (not specific) (string= specific "FILE"))
14049 (push (cons "FILE" buffer-file-name) props))
14050 (when (and (or (not specific) (string= specific "TAGS"))
14051 (setq value (org-get-tags-string))
14053 (push (cons "TAGS" value) props))
14054 (when (and (or (not specific) (string= specific "ALLTAGS"))
14055 (setq value (org-get-tags-at)))
14056 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14057 ":"))
14058 props))
14059 (when (or (not specific) (string= specific "BLOCKED"))
14060 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14061 (when (or (not specific)
14062 (member specific
14063 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14064 "TIMESTAMP" "TIMESTAMP_IA")))
14065 (catch 'match
14066 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14067 (setq key (if (match-end 1)
14068 (substring (org-match-string-no-properties 1)
14069 0 -1))
14070 string (if (equal key clockstr)
14071 (org-no-properties
14072 (org-trim
14073 (buffer-substring
14074 (match-beginning 3) (goto-char
14075 (point-at-eol)))))
14076 (substring (org-match-string-no-properties 3)
14077 1 -1)))
14078 ;; Get the correct property name from the key. This is
14079 ;; necessary if the user has configured time keywords.
14080 (setq key1 (concat key ":"))
14081 (cond
14082 ((not key)
14083 (setq key
14084 (if (= (char-after (match-beginning 3)) ?\[)
14085 "TIMESTAMP_IA" "TIMESTAMP")))
14086 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14087 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14088 ((equal key1 org-closed-string) (setq key "CLOSED"))
14089 ((equal key1 org-clock-string) (setq key "CLOCK")))
14090 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14091 (progn
14092 (push (cons key string) props)
14093 ;; no need to search further if match is found
14094 (throw 'match t))
14095 (when (or (equal key "CLOCK") (not (assoc key props)))
14096 (push (cons key string) props))))))
14097 )
14099 (when (memq which '(all standard))
14100 ;; Get the standard properties, like :PROP: ...
14101 (setq range (org-get-property-block beg end))
14102 (when range
14103 (goto-char (car range))
14104 (while (re-search-forward
14106 (cdr range) t)
14107 (setq key (org-match-string-no-properties 1)
14108 value (org-trim (or (org-match-string-no-properties 2) "")))
14109 (unless (member key excluded)
14110 (push (cons key (or value "")) props)))))
14111 (if clocksum
14112 (push (cons "CLOCKSUM"
14113 (org-columns-number-to-string (/ (float clocksum) 60.)
14114 'add_times))
14115 props))
14116 (unless (assoc "CATEGORY" props)
14117 (push (cons "CATEGORY" (org-get-category)) props))
14118 (append sum-props (nreverse props)))))))
14120 (defun org-entry-get (pom property &optional inherit literal-nil)
14121 "Get value of PROPERTY for entry at point-or-marker POM.
14122 If INHERIT is non-nil and the entry does not have the property,
14123 then also check higher levels of the hierarchy.
14124 If INHERIT is the symbol `selective', use inheritance only if the setting
14125 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14126 If the property is present but empty, the return value is the empty string.
14127 If the property is not present at all, nil is returned.
14130 do not interpret it as the list atom nil. This is used for inheritance
14132 (org-with-point-at pom
14133 (if (and inherit (if (eq inherit 'selective)
14134 (org-property-inherit-p property)
14135 t))
14136 (org-entry-get-with-inheritance property literal-nil)
14137 (if (member property org-special-properties)
14138 ;; We need a special property. Use `org-entry-properties' to
14139 ;; retrieve it, but specify the wanted property
14140 (cdr (assoc property (org-entry-properties nil 'special property)))
14141 (let ((range (unless (org-before-first-heading-p)
14142 (org-get-property-block))))
14143 (when (and range (goto-char (car range)))
14144 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14145 (cond
14146 ((re-search-forward
14147 (org-re-property property) (cdr range) t)
14148 (if (match-end 1) (org-match-string-no-properties 1) ""))
14149 ((re-search-forward
14150 (org-re-property (concat property "+")) (cdr range) t)
14151 (cdr (assoc
14152 property
14153 (org-update-property-plist
14154 (concat property "+")
14155 (if (match-end 1) (org-match-string-no-properties 1) "")
14156 (list (or (assoc property org-file-properties)
14157 (assoc property org-global-properties)
14158 (assoc property org-global-properties-fixed)
14159 ))))))))))))))
14161 (defun org-property-or-variable-value (var &optional inherit)
14162 "Check if there is a property fixing the value of VAR.
14163 If yes, return this value. If not, return the current value of the variable."
14164 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14166 (read prop)
14167 (symbol-value var))))
14169 (defun org-entry-delete (pom property)
14170 "Delete the property PROPERTY from entry at point-or-marker POM."
14171 (org-with-point-at pom
14172 (if (member property org-special-properties)
14173 nil ; cannot delete these properties.
14174 (let ((range (org-get-property-block)))
14175 (if (and range
14176 (goto-char (car range))
14177 (re-search-forward
14178 (org-re-property property)
14179 (cdr range) t))
14180 (progn
14181 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14182 t)
14183 nil)))))
14185 ;; Multi-values properties are properties that contain multiple values
14186 ;; These values are assumed to be single words, separated by whitespace.
14187 (defun org-entry-add-to-multivalued-property (pom property value)
14188 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14189 (let* ((old (org-entry-get pom property))
14191 (setq value (org-entry-protect-space value))
14192 (unless (member value values)
14193 (setq values (cons value values))
14194 (org-entry-put pom property
14195 (mapconcat 'identity values " ")))))
14197 (defun org-entry-remove-from-multivalued-property (pom property value)
14198 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14199 (let* ((old (org-entry-get pom property))
14201 (setq value (org-entry-protect-space value))
14202 (when (member value values)
14203 (setq values (delete value values))
14204 (org-entry-put pom property
14205 (mapconcat 'identity values " ")))))
14207 (defun org-entry-member-in-multivalued-property (pom property value)
14208 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14209 (let* ((old (org-entry-get pom property))
14211 (setq value (org-entry-protect-space value))
14212 (member value values)))
14214 (defun org-entry-get-multivalued-property (pom property)
14215 "Return a list of values in a multivalued property."
14216 (let* ((value (org-entry-get pom property))
14218 (mapcar 'org-entry-restore-space values)))
14220 (defun org-entry-put-multivalued-property (pom property &rest values)
14221 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14222 VALUES should be a list of strings. Spaces will be protected."
14223 (org-entry-put pom property
14224 (mapconcat 'org-entry-protect-space values " "))
14225 (let* ((value (org-entry-get pom property))
14227 (mapcar 'org-entry-restore-space values)))
14229 (defun org-entry-protect-space (s)
14230 "Protect spaces and newline in string S."
14231 (while (string-match " " s)
14232 (setq s (replace-match "%20" t t s)))
14234 (setq s (replace-match "%0A" t t s)))
14235 s)
14237 (defun org-entry-restore-space (s)
14238 "Restore spaces and newline in string S."
14239 (while (string-match "%20" s)
14240 (setq s (replace-match " " t t s)))
14241 (while (string-match "%0A" s)
14243 s)
14245 (defvar org-entry-property-inherited-from (make-marker)
14246 "Marker pointing to the entry from where a property was inherited.
14247 Each call to `org-entry-get-with-inheritance' will set this marker to the
14248 location of the entry where the inheritance search matched. If there was
14249 no match, the marker will point nowhere.
14250 Note that also `org-entry-get' calls this function, if the INHERIT flag
14251 is set.")
14253 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14254 "Get entry property, and search higher levels if not present.
14255 The search will stop at the first ancestor which has the property defined.
14257 should be considered as undefined (this is the meaning of nil here).
14259 (move-marker org-entry-property-inherited-from nil)
14260 (let (tmp)
14261 (unless (org-before-first-heading-p)
14262 (save-excursion
14263 (save-restriction
14264 (widen)
14265 (catch 'ex
14266 (while t
14267 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14268 (org-back-to-heading t)
14269 (move-marker org-entry-property-inherited-from (point))
14270 (throw 'ex tmp))
14271 (or (org-up-heading-safe) (throw 'ex nil)))))))
14272 (setq tmp (or tmp
14273 (cdr (assoc property org-file-properties))
14274 (cdr (assoc property org-global-properties))
14275 (cdr (assoc property org-global-properties-fixed))))
14276 (if literal-nil tmp (org-not-nil tmp))))
14278 (defvar org-property-changed-functions nil
14279 "Hook called when the value of a property has changed.
14280 Each hook function should accept two arguments, the name of the property
14281 and the new value.")
14283 (defun org-entry-put (pom property value)
14284 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14285 (org-with-point-at pom
14286 (org-back-to-heading t)
14287 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14288 range)
14289 (cond
14290 ((equal property "TODO")
14292 (not (member value org-todo-keywords-1)))
14294 (if (or (not value)
14296 (setq value 'none))
14297 (org-todo value)
14298 (org-set-tags nil 'align))
14299 ((equal property "PRIORITY")
14301 (string-to-char value) ?\ ))
14302 (org-set-tags nil 'align))
14303 ((equal property "SCHEDULED")
14304 (if (re-search-forward org-scheduled-time-regexp end t)
14305 (cond
14306 ((eq value 'earlier) (org-timestamp-change -1 'day))
14307 ((eq value 'later) (org-timestamp-change 1 'day))
14308 (t (call-interactively 'org-schedule)))
14309 (call-interactively 'org-schedule)))
14310 ((equal property "DEADLINE")
14311 (if (re-search-forward org-deadline-time-regexp end t)
14312 (cond
14313 ((eq value 'earlier) (org-timestamp-change -1 'day))
14314 ((eq value 'later) (org-timestamp-change 1 'day))
14315 (t (call-interactively 'org-deadline)))
14316 (call-interactively 'org-deadline)))
14317 ((member property org-special-properties)
14318 (error "The %s property can not yet be set with `org-entry-put'"
14319 property))
14320 (t ; a non-special property
14321 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14322 (setq range (org-get-property-block beg end 'force))
14323 (goto-char (car range))
14324 (if (re-search-forward
14325 (org-re-property property) (cdr range) t)
14326 (progn
14327 (delete-region (match-beginning 0) (match-end 0))
14328 (goto-char (match-beginning 0)))
14329 (goto-char (cdr range))
14331 (backward-char 1)
14332 (org-indent-line-function))
14333 (insert ":" property ":")
14334 (and value (insert " " value))
14335 (org-indent-line-function)))))
14336 (run-hook-with-args 'org-property-changed-functions property value)))
14338 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14339 "Get all property keys in the current buffer.
14340 With INCLUDE-SPECIALS, also list the special properties that reflect things
14341 like tags and TODO state.
14342 With INCLUDE-DEFAULTS, also include properties that has special meaning
14343 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14344 and others.
14345 With INCLUDE-COLUMNS, also include property names given in COLUMN
14346 formats in the current buffer."
14347 (let (rtn range cfmt s p)
14348 (save-excursion
14349 (save-restriction
14350 (widen)
14351 (goto-char (point-min))
14352 (while (re-search-forward org-property-start-re nil t)
14353 (setq range (org-get-property-block))
14354 (goto-char (car range))
14355 (while (re-search-forward
14357 (cdr range) t)
14358 (add-to-list 'rtn (org-match-string-no-properties 1)))
14359 (outline-next-heading))))
14361 (when include-specials
14362 (setq rtn (append org-special-properties rtn)))
14364 (when include-defaults
14365 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14366 (add-to-list 'rtn org-effort-property))
14368 (when include-columns
14369 (save-excursion
14370 (save-restriction
14371 (widen)
14372 (goto-char (point-min))
14373 (while (re-search-forward
14375 nil t)
14376 (setq cfmt (match-string 2) s 0)
14378 cfmt s)
14379 (setq s (match-end 0)
14380 p (match-string 1 cfmt))
14381 (unless (or (equal p "ITEM")
14382 (member p org-special-properties))
14383 (add-to-list 'rtn (match-string 1 cfmt))))))))
14385 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14387 (defun org-property-values (key)
14388 "Return a list of all values of property KEY in the current buffer."
14389 (save-excursion
14390 (save-restriction
14391 (widen)
14392 (goto-char (point-min))
14393 (let ((re (org-re-property key))
14394 values)
14395 (while (re-search-forward re nil t)
14396 (add-to-list 'values (org-trim (match-string 1))))
14397 (delete "" values)))))
14399 (defun org-insert-property-drawer ()
14400 "Insert a property drawer into the current entry."
14401 (interactive)
14402 (org-back-to-heading t)
14403 (looking-at org-outline-regexp)
14404 (let ((indent (if org-adapt-indentation
14405 (- (match-end 0)(match-beginning 0))
14406 0))
14407 (beg (point))
14409 end hiddenp)
14410 (outline-next-heading)
14411 (setq end (point))
14412 (goto-char beg)
14413 (while (re-search-forward re end t))
14414 (setq hiddenp (outline-invisible-p))
14415 (end-of-line 1)
14418 (if (member (match-string 1) '("CLOCK:" ":END:"))
14419 ;; just skip this line
14420 (beginning-of-line 2)
14421 ;; Drawer start, find the end
14423 (beginning-of-line 1)))
14424 (org-skip-over-state-notes)
14426 (if (eq (char-before) ?*) (forward-char 1))
14428 (beginning-of-line 0)
14429 (org-indent-to-column indent)
14430 (beginning-of-line 2)
14431 (org-indent-to-column indent)
14432 (beginning-of-line 0)
14433 (if hiddenp
14434 (save-excursion
14435 (org-back-to-heading t)
14436 (hide-entry))
14437 (org-flag-drawer t))))
14439 (defvar org-property-set-functions-alist nil
14440 "Property set function alist.
14441 Each entry should have the following format:
14443 (PROPERTY . READ-FUNCTION)
14445 The read function will be called with the same argument as
14446 `org-completing-read'.")
14448 (defun org-set-property-function (property)
14449 "Get the function that should be used to set PROPERTY.
14450 This is computed according to `org-property-set-functions-alist'."
14451 (or (cdr (assoc property org-property-set-functions-alist))
14452 'org-completing-read))
14454 (defun org-read-property-value (property)
14455 "Read PROPERTY value from user."
14456 (let* ((completion-ignore-case t)
14457 (allowed (org-property-get-allowed-values nil property 'table))
14458 (cur (org-entry-get nil property))
14459 (prompt (concat property " value"
14461 (concat " [" cur "]") "") ": "))
14462 (set-function (org-set-property-function property))
14463 (val (if allowed
14464 (funcall set-function prompt allowed nil
14465 (not (get-text-property 0 'org-unrestricted
14466 (caar allowed))))
14467 (let (org-completion-use-ido org-completion-use-iswitchb)
14468 (funcall set-function prompt
14469 (mapcar 'list (org-property-values property))
14470 nil nil "" nil cur)))))
14471 (if (equal val "")
14472 cur
14473 val)))
14475 (defvar org-last-set-property nil)
14476 (defun org-read-property-name ()
14477 "Read a property name."
14478 (let* ((completion-ignore-case t)
14479 (keys (org-buffer-property-keys nil t t))
14480 (default-prop (or (save-excursion
14481 (save-match-data
14482 (beginning-of-line)
14484 (null (string= (match-string 1) "END"))
14485 (match-string 1))))
14486 org-last-set-property))
14487 (property (org-icompleting-read
14488 (concat "Property"
14489 (if default-prop (concat " [" default-prop "]") "")
14490 ": ")
14491 (mapcar 'list keys)
14492 nil nil nil nil
14493 default-prop
14494 )))
14495 (if (member property keys)
14496 property
14497 (or (cdr (assoc (downcase property)
14498 (mapcar (lambda (x) (cons (downcase x) x))
14499 keys)))
14500 property))))
14502 (defun org-set-property (property value)
14503 "In the current entry, set PROPERTY to VALUE.
14504 When called interactively, this will prompt for a property name, offering
14505 completion on existing and default properties. And then it will prompt
14506 for a value, offering completion either on allowed values (via an inherited
14507 xxx_ALL property) or on existing values in other instances of this property
14508 in the current file."
14509 (interactive (list nil nil))
14510 (let* ((property (or property (org-read-property-name)))
14511 (value (or value (org-read-property-value property)))
14512 (fn (assoc property org-properties-postprocess-alist)))
14513 (setq org-last-set-property property)
14514 ;; Possibly postprocess the inserted value:
14515 (when fn (setq value (funcall (cadr fn) value)))
14516 (unless (equal (org-entry-get nil property) value)
14517 (org-entry-put nil property value))))
14519 (defun org-delete-property (property)
14520 "In the current entry, delete PROPERTY."
14521 (interactive
14522 (let* ((completion-ignore-case t)
14523 (prop (org-icompleting-read "Property: "
14524 (org-entry-properties nil 'standard))))
14525 (list prop)))
14526 (message "Property %s %s" property
14527 (if (org-entry-delete nil property)
14528 "deleted"
14529 "was not present in the entry")))
14531 (defun org-delete-property-globally (property)
14532 "Remove PROPERTY globally, from all entries."
14533 (interactive
14534 (let* ((completion-ignore-case t)
14535 (prop (org-icompleting-read
14536 "Globally remove property: "
14537 (mapcar 'list (org-buffer-property-keys)))))
14538 (list prop)))
14539 (save-excursion
14540 (save-restriction
14541 (widen)
14542 (goto-char (point-min))
14543 (let ((cnt 0))
14544 (while (re-search-forward
14545 (org-re-property property)
14546 nil t)
14547 (setq cnt (1+ cnt))
14548 (replace-match ""))
14551 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14553 (defun org-compute-property-at-point ()
14554 "Compute the property at point.
14555 This looks for an enclosing column format, extracts the operator and
14556 then applies it to the property in the column format's scope."
14557 (interactive)
14558 (unless (org-at-property-p)
14559 (error "Not at a property"))
14560 (let ((prop (org-match-string-no-properties 2)))
14561 (org-columns-get-format-and-top-level)
14562 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14563 (error "No operator defined for property %s" prop))
14564 (org-columns-compute prop)))
14566 (defvar org-property-allowed-value-functions nil
14567 "Hook for functions supplying allowed values for a specific property.
14568 The functions must take a single argument, the name of the property, and
14570 the values, this means that these values are intended as defaults for
14571 completion, but that other values should be allowed too.
14572 The functions must return nil if they are not responsible for this
14573 property.")
14575 (defun org-property-get-allowed-values (pom property &optional table)
14576 "Get allowed values for the property PROPERTY.
14577 When TABLE is non-nil, return an alist that can directly be used for
14578 completion."
14579 (let (vals)
14580 (cond
14581 ((equal property "TODO")
14582 (setq vals (org-with-point-at pom
14583 (append org-todo-keywords-1 '("")))))
14584 ((equal property "PRIORITY")
14585 (let ((n org-lowest-priority))
14586 (while (>= n org-highest-priority)
14587 (push (char-to-string n) vals)
14588 (setq n (1- n)))))
14589 ((member property org-special-properties))
14590 ((setq vals (run-hook-with-args-until-success
14591 'org-property-allowed-value-functions property)))
14592 (t
14593 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14595 (setq vals (car (read-from-string (concat "(" vals ")"))))
14596 (setq vals (mapcar (lambda (x)
14597 (cond ((stringp x) x)
14598 ((numberp x) (number-to-string x))
14599 ((symbolp x) (symbol-name x))
14600 (t "???")))
14601 vals)))))
14602 (when (member ":ETC" vals)
14603 (setq vals (remove ":ETC" vals))
14604 (org-add-props (car vals) '(org-unrestricted t)))
14605 (if table (mapcar 'list vals) vals)))
14607 (defun org-property-previous-allowed-value (&optional previous)
14608 "Switch to the next allowed value for this property."
14609 (interactive)
14610 (org-property-next-allowed-value t))
14612 (defun org-property-next-allowed-value (&optional previous)
14613 "Switch to the next allowed value for this property."
14614 (interactive)
14615 (unless (org-at-property-p)
14616 (error "Not at a property"))
14617 (let* ((key (match-string 2))
14618 (value (match-string 3))
14619 (allowed (or (org-property-get-allowed-values (point) key)
14620 (and (member value '("[ ]" "[-]" "[X]"))
14621 '("[ ]" "[X]"))))
14622 nval)
14623 (unless allowed
14624 (error "Allowed values for this property have not been defined"))
14625 (if previous (setq allowed (reverse allowed)))
14626 (if (member value allowed)
14627 (setq nval (car (cdr (member value allowed)))))
14628 (setq nval (or nval (car allowed)))
14629 (if (equal nval value)
14630 (error "Only one allowed value for this property"))
14631 (org-at-property-p)
14632 (replace-match (concat " :" key ": " nval) t t)
14633 (org-indent-line-function)
14634 (beginning-of-line 1)
14636 (run-hook-with-args 'org-property-changed-functions key nval)))
14638 (defun org-find-olp (path &optional this-buffer)
14639 "Return a marker pointing to the entry at outline path OLP.
14640 If anything goes wrong, throw an error.
14641 You can wrap this call to catch the error like this:
14643 (condition-case msg
14644 (org-mobile-locate-entry (match-string 4))
14645 (error (nth 1 msg)))
14647 The return value will then be either a string with the error message,
14648 or a marker if everything is OK.
14650 If THIS-BUFFER is set, the outline path does not contain a file,
14651 only headings."
14652 (let* ((file (if this-buffer buffer-file-name (pop path)))
14653 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14654 (level 1)
14655 (lmin 1)
14656 (lmax 1)
14657 limit re end found pos heading cnt flevel)
14658 (unless buffer (error "File not found :%s" file))
14659 (with-current-buffer buffer
14660 (save-excursion
14661 (save-restriction
14662 (widen)
14663 (setq limit (point-max))
14664 (goto-char (point-min))
14665 (while (setq heading (pop path))
14666 (setq re (format org-complex-heading-regexp-format
14667 (regexp-quote heading)))
14668 (setq cnt 0 pos (point))
14669 (while (re-search-forward re end t)
14670 (setq level (- (match-end 1) (match-beginning 1)))
14671 (if (and (>= level lmin) (<= level lmax))
14672 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14673 (when (= cnt 0) (error "Heading not found on level %d: %s"
14674 lmax heading))
14675 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14676 lmax heading))
14677 (goto-char found)
14678 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14679 (setq end (save-excursion (org-end-of-subtree t t))))
14680 (when (org-at-heading-p)
14681 (move-marker (make-marker) (point))))))))
14683 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14684 "Find node HEADING in BUFFER.
14685 Return a marker to the heading if it was found, or nil if not.
14686 If POS-ONLY is set, return just the position instead of a marker.
14688 The heading text must match exact, but it may have a TODO keyword,
14689 a priority cookie and tags in the standard locations."
14690 (with-current-buffer (or buffer (current-buffer))
14691 (save-excursion
14692 (save-restriction
14693 (widen)
14694 (goto-char (point-min))
14695 (let (case-fold-search)
14696 (if (re-search-forward
14697 (format org-complex-heading-regexp-format
14698 (regexp-quote heading)) nil t)
14699 (if pos-only
14700 (match-beginning 0)
14701 (move-marker (make-marker) (match-beginning 0)))))))))
14703 (defun org-find-exact-heading-in-directory (heading &optional dir)
14704 "Find Org node headline HEADING in all .org files in directory DIR.
14705 When the target headline is found, return a marker to this location."
14706 (let ((files (directory-files (or dir default-directory)
14708 file visiting m buffer)
14709 (catch 'found
14710 (while (setq file (pop files))
14711 (message "trying %s" file)
14712 (setq visiting (org-find-base-buffer-visiting file))
14713 (setq buffer (or visiting (find-file-noselect file)))
14714 (setq m (org-find-exact-headline-in-buffer
14715 heading buffer))
14716 (when (and (not m) (not visiting)) (kill-buffer buffer))
14717 (and m (throw 'found m))))))
14719 (defun org-find-entry-with-id (ident)
14720 "Locate the entry that contains the ID property with exact value IDENT.
14721 IDENT can be a string, a symbol or a number, this function will search for
14722 the string representation of it.
14723 Return the position where this entry starts, or nil if there is no such entry."
14724 (interactive "sID: ")
14725 (let ((id (cond
14726 ((stringp ident) ident)
14727 ((symbol-name ident) (symbol-name ident))
14728 ((numberp ident) (number-to-string ident))
14729 (t (error "IDENT %s must be a string, symbol or number" ident))))
14730 (case-fold-search nil))
14731 (save-excursion
14732 (save-restriction
14733 (widen)
14734 (goto-char (point-min))
14735 (when (re-search-forward
14737 nil t)
14738 (org-back-to-heading t)
14739 (point))))))
14741 ;;;; Timestamps
14743 (defvar org-last-changed-timestamp nil)
14744 (defvar org-last-inserted-timestamp nil
14745 "The last time stamp inserted with `org-insert-time-stamp'.")
14746 (defvar org-time-was-given) ; dynamically scoped parameter
14747 (defvar org-end-time-was-given) ; dynamically scoped parameter
14748 (defvar org-ts-what) ; dynamically scoped parameter
14750 (defun org-time-stamp (arg &optional inactive)
14751 "Prompt for a date/time and insert a time stamp.
14752 If the user specifies a time like HH:MM, or if this command is called
14753 with a prefix argument, the time stamp will contain date and time.
14754 Otherwise, only the date will be included. All parts of a date not
14755 specified by the user will be filled in from the current date/time.
14756 So if you press just return without typing anything, the time stamp
14757 will represent the current date/time. If there is already a timestamp
14758 at the cursor, it will be modified."
14759 (interactive "P")
14760 (let* ((ts nil)
14761 (default-time
14762 ;; Default time is either today, or, when entering a range,
14763 ;; the range start.
14764 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14765 (save-excursion
14766 (re-search-backward
14768 (- (point) 20) t)))
14769 (apply 'encode-time (org-parse-time-string (match-string 1)))
14770 (current-time)))
14771 (default-input (and ts (org-get-compact-tod ts)))
14772 (repeater (save-excursion
14773 (save-match-data
14774 (beginning-of-line)
14775 (when (re-search-forward
14777 (save-excursion (progn (end-of-line) (point))) t)
14778 (match-string 0)))))
14779 org-time-was-given org-end-time-was-given time)
14780 (cond
14781 ((and (org-at-timestamp-p t)
14782 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14783 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14784 (insert "--")
14785 (setq time (let ((this-command this-command))
14786 (org-read-date arg 'totime nil nil
14787 default-time default-input)))
14788 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14789 ((org-at-timestamp-p t)
14790 (setq time (let ((this-command this-command))
14791 (org-read-date arg 'totime nil nil default-time default-input)))
14792 (when (org-at-timestamp-p t) ; just to get the match data
14793 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14794 (replace-match "")
14795 (setq org-last-changed-timestamp
14796 (org-insert-time-stamp
14797 time (or org-time-was-given arg)
14798 inactive nil nil (list org-end-time-was-given)))
14799 (when repeater (goto-char (1- (point))) (insert " " repeater)
14800 (setq org-last-changed-timestamp
14801 (concat (substring org-last-inserted-timestamp 0 -1)
14802 " " repeater ">"))))
14803 (message "Timestamp updated"))
14804 (t
14805 (setq time (let ((this-command this-command))
14806 (org-read-date arg 'totime nil nil default-time default-input)))
14807 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14808 nil nil (list org-end-time-was-given))))))
14810 ;; FIXME: can we use this for something else, like computing time differences?
14811 (defun org-get-compact-tod (s)
14812 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14813 (let* ((t1 (match-string 1 s))
14814 (h1 (string-to-number (match-string 2 s)))
14815 (m1 (string-to-number (match-string 3 s)))
14816 (t2 (and (match-end 4) (match-string 5 s)))
14817 (h2 (and t2 (string-to-number (match-string 6 s))))
14818 (m2 (and t2 (string-to-number (match-string 7 s))))
14819 dh dm)
14820 (if (not t2)
14821 t1
14822 (setq dh (- h2 h1) dm (- m2 m1))
14823 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14824 (concat t1 "+" (number-to-string dh)
14825 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14827 (defun org-time-stamp-inactive (&optional arg)
14828 "Insert an inactive time stamp.
14829 An inactive time stamp is enclosed in square brackets instead of angle
14830 brackets. It is inactive in the sense that it does not trigger agenda entries,
14831 does not link to the calendar and cannot be changed with the S-cursor keys.
14832 So these are more for recording a certain time/date."
14833 (interactive "P")
14834 (org-time-stamp arg 'inactive))
14836 (defvar org-date-ovl (make-overlay 1 1))
14837 (overlay-put org-date-ovl 'face 'org-warning)
14838 (org-detach-overlay org-date-ovl)
14840 (defvar org-ans1) ; dynamically scoped parameter
14841 (defvar org-ans2) ; dynamically scoped parameter
14843 (defvar org-plain-time-of-day-regexp) ; defined below
14845 (defvar org-overriding-default-time nil) ; dynamically scoped
14846 (defvar org-read-date-overlay nil)
14847 (defvar org-dcst nil) ; dynamically scoped
14848 (defvar org-read-date-history nil)
14849 (defvar org-read-date-final-answer nil)
14850 (defvar org-read-date-analyze-futurep nil)
14851 (defvar org-read-date-analyze-forced-year nil)
14853 (defun org-read-date (&optional with-time to-time from-string prompt
14854 default-time default-input)
14855 "Read a date, possibly a time, and make things smooth for the user.
14856 The prompt will suggest to enter an ISO date, but you can also enter anything
14857 which will at least partially be understood by `parse-time-string'.
14858 Unrecognized parts of the date will default to the current day, month, year,
14859 hour and minute. If this command is called to replace a timestamp at point,
14860 or to enter the second timestamp of a range, the default time is taken
14861 from the existing stamp. Furthermore, the command prefers the future,
14862 so if you are giving a date where the year is not given, and the day-month
14863 combination is already past in the current year, it will assume you
14864 mean next year. For details, see the manual. A few examples:
14866 3-2-5 --> 2003-02-05
14867 feb 15 --> currentyear-02-15
14868 2/15 --> currentyear-02-15
14869 sep 12 9 --> 2009-09-12
14870 12:45 --> today 12:45
14871 22 sept 0:34 --> currentyear-09-22 0:34
14872 12 --> currentyear-currentmonth-12
14873 Fri --> nearest Friday (today or later)
14874 etc.
14876 Furthermore you can specify a relative date by giving, as the *first* thing
14877 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14878 change in days weeks, months, years.
14879 With a single plus or minus, the date is relative to today. With a double
14880 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14881 +4d --> four days from today
14882 +4 --> same as above
14883 +2w --> two weeks from today
14884 ++5 --> five days from default date
14886 The function understands only English month and weekday abbreviations,
14887 but this can be configured with the variables `parse-time-months' and
14888 `parse-time-weekdays'.
14890 While prompting, a calendar is popped up - you can also select the
14891 date with the mouse (button 1). The calendar shows a period of three
14892 months. To scroll it to other months, use the keys `>' and `<'.
14893 If you don't like the calendar, turn it off with
14894 \(setq org-read-date-popup-calendar nil)
14896 With optional argument TO-TIME, the date will immediately be converted
14897 to an internal time.
14898 With an optional argument WITH-TIME, the prompt will suggest to also
14899 insert a time. Note that when WITH-TIME is not set, you can still
14900 enter a time, and this function will inform the calling routine about
14901 this change. The calling routine may then choose to change the format
14902 used to insert the time stamp into the buffer to include the time.
14903 With optional argument FROM-STRING, read from this string instead from
14904 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14905 the time/date that is used for everything that is not specified by the
14906 user."
14907 (require 'parse-time)
14908 (let* ((org-time-stamp-rounding-minutes
14909 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14910 (org-dcst org-display-custom-times)
14911 (ct (org-current-time))
14912 (def (or org-overriding-default-time default-time ct))
14913 (defdecode (decode-time def))
14914 (dummy (progn
14915 (when (< (nth 2 defdecode) org-extend-today-until)
14916 (setcar (nthcdr 2 defdecode) -1)
14917 (setcar (nthcdr 1 defdecode) 59)
14918 (setq def (apply 'encode-time defdecode)
14919 defdecode (decode-time def)))))
14920 (calendar-frame-setup nil)
14921 (calendar-setup nil)
14922 (calendar-move-hook nil)
14923 (calendar-view-diary-initially-flag nil)
14924 (calendar-view-holidays-initially-flag nil)
14925 (timestr (format-time-string
14926 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14927 (prompt (concat (if prompt (concat prompt " ") "")
14928 (format "Date+time [%s]: " timestr)))
14929 ans (org-ans0 "") org-ans1 org-ans2 final)
14931 (cond
14932 (from-string (setq ans from-string))
14933 (org-read-date-popup-calendar
14934 (save-excursion
14935 (save-window-excursion
14936 (calendar)
14937 (unwind-protect
14938 (progn
14939 (calendar-forward-day (- (time-to-days def)
14940 (calendar-absolute-from-gregorian
14941 (calendar-current-date))))
14942 (org-eval-in-calendar nil t)
14943 (let* ((old-map (current-local-map))
14944 (map (copy-keymap calendar-mode-map))
14945 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14946 (org-defkey map (kbd "RET") 'org-calendar-select)
14947 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14948 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14949 (org-defkey minibuffer-local-map [(meta shift left)]
14950 (lambda () (interactive)
14951 (org-eval-in-calendar '(calendar-backward-month 1))))
14952 (org-defkey minibuffer-local-map [(meta shift right)]
14953 (lambda () (interactive)
14954 (org-eval-in-calendar '(calendar-forward-month 1))))
14955 (org-defkey minibuffer-local-map [(meta shift up)]
14956 (lambda () (interactive)
14957 (org-eval-in-calendar '(calendar-backward-year 1))))
14958 (org-defkey minibuffer-local-map [(meta shift down)]
14959 (lambda () (interactive)
14960 (org-eval-in-calendar '(calendar-forward-year 1))))
14961 (org-defkey minibuffer-local-map [?\e (shift left)]
14962 (lambda () (interactive)
14963 (org-eval-in-calendar '(calendar-backward-month 1))))
14964 (org-defkey minibuffer-local-map [?\e (shift right)]
14965 (lambda () (interactive)
14966 (org-eval-in-calendar '(calendar-forward-month 1))))
14967 (org-defkey minibuffer-local-map [?\e (shift up)]
14968 (lambda () (interactive)
14969 (org-eval-in-calendar '(calendar-backward-year 1))))
14970 (org-defkey minibuffer-local-map [?\e (shift down)]
14971 (lambda () (interactive)
14972 (org-eval-in-calendar '(calendar-forward-year 1))))
14973 (org-defkey minibuffer-local-map [(shift up)]
14974 (lambda () (interactive)
14975 (org-eval-in-calendar '(calendar-backward-week 1))))
14976 (org-defkey minibuffer-local-map [(shift down)]
14977 (lambda () (interactive)
14978 (org-eval-in-calendar '(calendar-forward-week 1))))
14979 (org-defkey minibuffer-local-map [(shift left)]
14980 (lambda () (interactive)
14981 (org-eval-in-calendar '(calendar-backward-day 1))))
14982 (org-defkey minibuffer-local-map [(shift right)]
14983 (lambda () (interactive)
14984 (org-eval-in-calendar '(calendar-forward-day 1))))
14985 (org-defkey minibuffer-local-map ">"
14986 (lambda () (interactive)
14987 (org-eval-in-calendar '(scroll-calendar-left 1))))
14988 (org-defkey minibuffer-local-map "<"
14989 (lambda () (interactive)
14990 (org-eval-in-calendar '(scroll-calendar-right 1))))
14991 (org-defkey minibuffer-local-map "\C-v"
14992 (lambda () (interactive)
14993 (org-eval-in-calendar
14994 '(calendar-scroll-left-three-months 1))))
14995 (org-defkey minibuffer-local-map "\M-v"
14996 (lambda () (interactive)
14997 (org-eval-in-calendar
14998 '(calendar-scroll-right-three-months 1))))
14999 (run-hooks 'org-read-date-minibuffer-setup-hook)
15000 (unwind-protect
15001 (progn
15002 (use-local-map map)
15003 (add-hook 'post-command-hook 'org-read-date-display)
15004 (setq org-ans0 (read-string prompt default-input
15005 'org-read-date-history nil))
15006 ;; org-ans0: from prompt
15007 ;; org-ans1: from mouse click
15008 ;; org-ans2: from calendar motion
15009 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15010 (remove-hook 'post-command-hook 'org-read-date-display)
15011 (use-local-map old-map)
15012 (when org-read-date-overlay
15013 (delete-overlay org-read-date-overlay)
15014 (setq org-read-date-overlay nil)))))
15015 (bury-buffer "*Calendar*")))))
15017 (t ; Naked prompt only
15018 (unwind-protect
15019 (setq ans (read-string prompt default-input
15020 'org-read-date-history timestr))
15021 (when org-read-date-overlay
15022 (delete-overlay org-read-date-overlay)
15023 (setq org-read-date-overlay nil)))))
15025 (setq final (org-read-date-analyze ans def defdecode))
15027 (when org-read-date-analyze-forced-year
15028 (message "Year was forced into %s"
15029 (if org-read-date-force-compatible-dates
15030 "compatible range (1970-2037)"
15031 "range representable on this machine"))
15032 (ding))
15034 ;; One round trip to get rid of 34th of August and stuff like that....
15035 (setq final (decode-time (apply 'encode-time final)))
15037 (setq org-read-date-final-answer ans)
15039 (if to-time
15040 (apply 'encode-time final)
15041 (if (and (boundp 'org-time-was-given) org-time-was-given)
15042 (format "%04d-%02d-%02d %02d:%02d"
15043 (nth 5 final) (nth 4 final) (nth 3 final)
15044 (nth 2 final) (nth 1 final))
15045 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15047 (defvar def)
15048 (defvar defdecode)
15049 (defvar with-time)
15050 (defun org-read-date-display ()
15051 "Display the current date prompt interpretation in the minibuffer."
15052 (when org-read-date-display-live
15053 (when org-read-date-overlay
15054 (delete-overlay org-read-date-overlay))
15055 (let ((p (point)))
15056 (end-of-line 1)
15057 (while (not (equal (buffer-substring
15058 (max (point-min) (- (point) 4)) (point))
15059 " "))
15060 (insert " "))
15061 (goto-char p))
15062 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15063 " " (or org-ans1 org-ans2)))
15064 (org-end-time-was-given nil)
15065 (f (org-read-date-analyze ans def defdecode))
15066 (fmts (if org-dcst
15067 org-time-stamp-custom-formats
15068 org-time-stamp-formats))
15069 (fmt (if (or with-time
15070 (and (boundp 'org-time-was-given) org-time-was-given))
15071 (cdr fmts)
15072 (car fmts)))
15073 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15074 (when (and org-end-time-was-given
15075 (string-match org-plain-time-of-day-regexp txt))
15076 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15077 org-end-time-was-given
15078 (substring txt (match-end 0)))))
15079 (when org-read-date-analyze-futurep
15080 (setq txt (concat txt " (=>F)")))
15081 (setq org-read-date-overlay
15082 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15083 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15085 (defun org-read-date-analyze (ans def defdecode)
15086 "Analyze the combined answer of the date prompt."
15087 ;; FIXME: cleanup and comment
15088 (let ((nowdecode (decode-time (current-time)))
15089 delta deltan deltaw deltadef year month day
15090 hour minute second wday pm h2 m2 tl wday1
15091 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15092 (setq org-read-date-analyze-futurep nil
15093 org-read-date-analyze-forced-year nil)
15095 (setq ans "+0"))
15097 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15098 (setq ans (replace-match "" t t ans)
15099 deltan (car delta)
15100 deltaw (nth 1 delta)
15101 deltadef (nth 2 delta)))
15103 ;; Check if there is an iso week date in there
15104 ;; If yes, store the info and postpone interpreting it until the rest
15105 ;; of the parsing is done
15106 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15107 (setq iso-year (if (match-end 1)
15108 (org-small-year-to-year
15109 (string-to-number (match-string 1 ans))))
15110 iso-weekday (if (match-end 3)
15111 (string-to-number (match-string 3 ans)))
15112 iso-week (string-to-number (match-string 2 ans)))
15113 (setq ans (replace-match "" t t ans)))
15115 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15116 (when (string-match
15118 (setq year (if (match-end 2)
15119 (string-to-number (match-string 2 ans))
15120 (progn (setq kill-year t)
15121 (string-to-number (format-time-string "%Y"))))
15122 month (string-to-number (match-string 3 ans))
15123 day (string-to-number (match-string 4 ans)))
15124 (if (< year 100) (setq year (+ 2000 year)))
15126 t nil ans)))
15128 ;; Help matching dotted european dates
15129 (when (string-match
15130 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15131 (setq year (if (match-end 3)
15132 (string-to-number (match-string 3 ans))
15133 (progn (setq kill-year t)
15134 (string-to-number (format-time-string "%Y"))))
15135 day (string-to-number (match-string 1 ans))
15136 month (string-to-number (match-string 2 ans))
15138 t nil ans)))
15140 ;; Help matching american dates, like 5/30 or 5/30/7
15141 (when (string-match
15142 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15143 (setq year (if (match-end 4)
15144 (string-to-number (match-string 4 ans))
15145 (progn (setq kill-year t)
15146 (string-to-number (format-time-string "%Y"))))
15147 month (string-to-number (match-string 1 ans))
15148 day (string-to-number (match-string 2 ans)))
15149 (if (< year 100) (setq year (+ 2000 year)))
15151 t nil ans)))
15152 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15153 ;; If there is a time with am/pm, and *no* time without it, we convert
15154 ;; so that matching will be successful.
15155 (loop for i from 1 to 2 do ; twice, for end time as well
15158 (setq hour (string-to-number (match-string 1 ans))
15159 minute (if (match-end 3)
15160 (string-to-number (match-string 3 ans))
15161 0)
15162 pm (equal ?p
15163 (string-to-char (downcase (match-string 4 ans)))))
15164 (if (and (= hour 12) (not pm))
15165 (setq hour 0)
15166 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15167 (setq ans (replace-match (format "%02d:%02d" hour minute)
15168 t t ans))))
15170 ;; Check if a time range is given as a duration
15171 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15172 (setq hour (string-to-number (match-string 1 ans))
15173 h2 (+ hour (string-to-number (match-string 3 ans)))
15174 minute (string-to-number (match-string 2 ans))
15175 m2 (+ minute (if (match-end 5) (string-to-number
15176 (match-string 5 ans))0)))
15177 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15178 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15179 t t ans)))
15181 ;; Check if there is a time range
15182 (when (boundp 'org-end-time-was-given)
15183 (setq org-time-was-given nil)
15184 (when (and (string-match org-plain-time-of-day-regexp ans)
15185 (match-end 8))
15186 (setq org-end-time-was-given (match-string 8 ans))
15187 (setq ans (concat (substring ans 0 (match-beginning 7))
15188 (substring ans (match-end 7))))))
15190 (setq tl (parse-time-string ans)
15191 day (or (nth 3 tl) (nth 3 defdecode))
15192 month (or (nth 4 tl)
15193 (if (and org-read-date-prefer-future
15194 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15195 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15196 (nth 4 defdecode)))
15197 year (or (and (not kill-year) (nth 5 tl))
15198 (if (and org-read-date-prefer-future
15199 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15200 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15201 (nth 5 defdecode)))
15202 hour (or (nth 2 tl) (nth 2 defdecode))
15203 minute (or (nth 1 tl) (nth 1 defdecode))
15204 second (or (nth 0 tl) 0)
15205 wday (nth 6 tl))
15207 (when (and (eq org-read-date-prefer-future 'time)
15208 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15209 (equal day (nth 3 nowdecode))
15210 (equal month (nth 4 nowdecode))
15211 (equal year (nth 5 nowdecode))
15212 (nth 2 tl)
15213 (or (< (nth 2 tl) (nth 2 nowdecode))
15214 (and (= (nth 2 tl) (nth 2 nowdecode))
15215 (nth 1 tl)
15216 (< (nth 1 tl) (nth 1 nowdecode)))))
15217 (setq day (1+ day)
15218 futurep t))
15220 ;; Special date definitions below
15221 (cond
15222 (iso-week
15223 ;; There was an iso week
15224 (require 'cal-iso)
15225 (setq futurep nil)
15226 (setq year (or iso-year year)
15227 day (or iso-weekday wday 1)
15228 wday nil ; to make sure that the trigger below does not match
15229 iso-date (calendar-gregorian-from-absolute
15230 (calendar-absolute-from-iso
15231 (list iso-week day year))))
15232 ; FIXME: Should we also push ISO weeks into the future?
15233 ; (when (and org-read-date-prefer-future
15234 ; (not iso-year)
15235 ; (< (calendar-absolute-from-gregorian iso-date)
15236 ; (time-to-days (current-time))))
15237 ; (setq year (1+ year)
15238 ; iso-date (calendar-gregorian-from-absolute
15239 ; (calendar-absolute-from-iso
15240 ; (list iso-week day year)))))
15241 (setq month (car iso-date)
15242 year (nth 2 iso-date)
15243 day (nth 1 iso-date)))
15244 (deltan
15245 (setq futurep nil)
15246 (unless deltadef
15247 (let ((now (decode-time (current-time))))
15248 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15249 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15250 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15251 ((equal deltaw "m") (setq month (+ month deltan)))
15252 ((equal deltaw "y") (setq year (+ year deltan)))))
15253 ((and wday (not (nth 3 tl)))
15254 (setq futurep nil)
15255 ;; Weekday was given, but no day, so pick that day in the week
15256 ;; on or after the derived date.
15257 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15258 (unless (equal wday wday1)
15259 (setq day (+ day (% (- wday wday1 -7) 7))))))
15260 (if (and (boundp 'org-time-was-given)
15261 (nth 2 tl))
15262 (setq org-time-was-given t))
15263 (if (< year 100) (setq year (+ 2000 year)))
15264 ;; Check of the date is representable
15265 (if org-read-date-force-compatible-dates
15266 (progn
15267 (if (< year 1970)
15268 (setq year 1970 org-read-date-analyze-forced-year t))
15269 (if (> year 2037)
15270 (setq year 2037 org-read-date-analyze-forced-year t)))
15271 (condition-case nil
15272 (ignore (encode-time second minute hour day month year))
15273 (error
15274 (setq year (nth 5 defdecode))
15275 (setq org-read-date-analyze-forced-year t))))
15276 (setq org-read-date-analyze-futurep futurep)
15277 (list second minute hour day month year)))
15279 (defvar parse-time-weekdays)
15281 (defun org-read-date-get-relative (s today default)
15282 "Check string S for special relative date string.
15283 TODAY and DEFAULT are internal times, for today and for a default.
15284 Return shift list (N what def-flag)
15286 N is the number of WHATs to shift.
15287 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15288 the DEFAULT date rather than TODAY."
15289 (require 'parse-time)
15290 (when (and
15291 (string-match
15292 (concat
15297 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15298 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15299 (string-to-char (substring (match-string 1 s) -1))
15300 ?+))
15301 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15302 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15303 (what (if (match-end 3) (match-string 3 s) "d"))
15304 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15305 (date (if rel default today))
15306 (wday (nth 6 (decode-time date)))
15307 delta)
15308 (if wday1
15309 (progn
15310 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15311 (if (= dir ?-) (setq delta (- delta 7)))
15312 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15313 (list delta "d" rel))
15314 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15316 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15317 "Turn a user-specified date into the internal representation.
15318 The internal representation needed by the calendar is (month day year).
15319 This is a wrapper to handle the brain-dead convention in calendar that
15320 user function argument order change dependent on argument order."
15321 (if (boundp 'calendar-date-style)
15322 (cond
15323 ((eq calendar-date-style 'american)
15324 (list arg1 arg2 arg3))
15325 ((eq calendar-date-style 'european)
15326 (list arg2 arg1 arg3))
15327 ((eq calendar-date-style 'iso)
15328 (list arg2 arg3 arg1)))
15329 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15330 (if (org-bound-and-true-p european-calendar-style)
15331 (list arg2 arg1 arg3)
15332 (list arg1 arg2 arg3)))))
15334 (defun org-eval-in-calendar (form &optional keepdate)
15335 "Eval FORM in the calendar window and return to current window.
15336 Also, store the cursor date in variable org-ans2."
15337 (let ((sf (selected-frame))
15338 (sw (selected-window)))
15339 (select-window (get-buffer-window "*Calendar*" t))
15340 (eval form)
15341 (when (and (not keepdate) (calendar-cursor-to-date))
15342 (let* ((date (calendar-cursor-to-date))
15343 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15344 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15345 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15346 (select-window sw)
15347 (org-select-frame-set-input-focus sf)))
15349 (defun org-calendar-select ()
15350 "Return to `org-read-date' with the date currently selected.
15351 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15352 (interactive)
15353 (when (calendar-cursor-to-date)
15354 (let* ((date (calendar-cursor-to-date))
15355 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15356 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15357 (if (active-minibuffer-window) (exit-minibuffer))))
15359 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15360 "Insert a date stamp for the date given by the internal TIME.
15361 WITH-HM means use the stamp format that includes the time of the day.
15362 INACTIVE means use square brackets instead of angular ones, so that the
15363 stamp will not contribute to the agenda.
15364 PRE and POST are optional strings to be inserted before and after the
15365 stamp.
15366 The command returns the inserted time stamp."
15367 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15368 stamp)
15369 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15370 (insert-before-markers (or pre ""))
15371 (when (listp extra)
15372 (setq extra (car extra))
15373 (if (and (stringp extra)
15375 (setq extra (format "-%02d:%02d"
15376 (string-to-number (match-string 1 extra))
15377 (string-to-number (match-string 2 extra))))
15378 (setq extra nil)))
15379 (when extra
15380 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15381 (insert-before-markers (setq stamp (format-time-string fmt time)))
15382 (insert-before-markers (or post ""))
15383 (setq org-last-inserted-timestamp stamp)))
15385 (defun org-toggle-time-stamp-overlays ()
15386 "Toggle the use of custom time stamp formats."
15387 (interactive)
15388 (setq org-display-custom-times (not org-display-custom-times))
15389 (unless org-display-custom-times
15390 (let ((p (point-min)) (bmp (buffer-modified-p)))
15391 (while (setq p (next-single-property-change p 'display))
15392 (if (and (get-text-property p 'display)
15393 (eq (get-text-property p 'face) 'org-date))
15394 (remove-text-properties
15395 p (setq p (next-single-property-change p 'display))
15396 '(display t))))
15397 (set-buffer-modified-p bmp)))
15398 (if (featurep 'xemacs)
15399 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15400 (org-restart-font-lock)
15401 (setq org-table-may-need-update t)
15402 (if org-display-custom-times
15403 (message "Time stamps are overlaid with custom format")
15404 (message "Time stamp overlays removed")))
15406 (defun org-display-custom-time (beg end)
15407 "Overlay modified time stamp format over timestamp between BEG and END."
15408 (let* ((ts (buffer-substring beg end))
15409 t1 w1 with-hm tf time str w2 (off 0))
15410 (save-match-data
15411 (setq t1 (org-parse-time-string ts t))
15412 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15413 (setq off (- (match-end 0) (match-beginning 0)))))
15414 (setq end (- end off))
15415 (setq w1 (- end beg)
15416 with-hm (and (nth 1 t1) (nth 2 t1))
15417 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15418 time (org-fix-decoded-time t1)
15419 str (org-add-props
15420 (format-time-string
15421 (substring tf 1 -1) (apply 'encode-time time))
15422 nil 'mouse-face 'highlight)
15423 w2 (length str))
15424 (if (not (= w2 w1))
15425 (add-text-properties (1+ beg) (+ 2 beg)
15426 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15427 (if (featurep 'xemacs)
15428 (progn
15429 (put-text-property beg end 'invisible t)
15430 (put-text-property beg end 'end-glyph (make-glyph str)))
15431 (put-text-property beg end 'display str))))
15433 (defun org-translate-time (string)
15434 "Translate all timestamps in STRING to custom format.
15435 But do this only if the variable `org-display-custom-times' is set."
15436 (when org-display-custom-times
15437 (save-match-data
15438 (let* ((start 0)
15439 (re org-ts-regexp-both)
15440 t1 with-hm inactive tf time str beg end)
15441 (while (setq start (string-match re string start))
15442 (setq beg (match-beginning 0)
15443 end (match-end 0)
15444 t1 (save-match-data
15445 (org-parse-time-string (substring string beg end) t))
15446 with-hm (and (nth 1 t1) (nth 2 t1))
15447 inactive (equal (substring string beg (1+ beg)) "[")
15448 tf (funcall (if with-hm 'cdr 'car)
15449 org-time-stamp-custom-formats)
15450 time (org-fix-decoded-time t1)
15451 str (format-time-string
15452 (concat
15453 (if inactive "[" "<") (substring tf 1 -1)
15454 (if inactive "]" ">"))
15455 (apply 'encode-time time))
15456 string (replace-match str t t string)
15457 start (+ start (length str)))))))
15458 string)
15460 (defun org-fix-decoded-time (time)
15461 "Set 0 instead of nil for the first 6 elements of time.
15462 Don't touch the rest."
15463 (let ((n 0))
15464 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15466 (defun org-days-to-time (timestamp-string)
15467 "Difference between TIMESTAMP-STRING and now in days."
15468 (- (time-to-days (org-time-string-to-time timestamp-string))
15469 (time-to-days (current-time))))
15471 (defun org-deadline-close (timestamp-string &optional ndays)
15472 "Is the time in TIMESTAMP-STRING close to the current date?"
15473 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15474 (and (< (org-days-to-time timestamp-string) ndays)
15475 (not (org-entry-is-done-p))))
15477 (defun org-get-wdays (ts)
15478 "Get the deadline lead time appropriate for timestring TS."
15479 (cond
15480 ((<= org-deadline-warning-days 0)
15481 ;; 0 or negative, enforce this value no matter what
15482 (- org-deadline-warning-days))
15484 ;; lead time is specified.
15485 (floor (* (string-to-number (match-string 1 ts))
15486 (cdr (assoc (match-string 2 ts)
15487 '(("d" . 1) ("w" . 7)
15488 ("m" . 30.4) ("y" . 365.25)))))))
15489 ;; go for the default.
15490 (t org-deadline-warning-days)))
15492 (defun org-calendar-select-mouse (ev)
15493 "Return to `org-read-date' with the date currently selected.
15494 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15495 (interactive "e")
15496 (mouse-set-point ev)
15497 (when (calendar-cursor-to-date)
15498 (let* ((date (calendar-cursor-to-date))
15499 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15500 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15501 (if (active-minibuffer-window) (exit-minibuffer))))
15503 (defun org-check-deadlines (ndays)
15504 "Check if there are any deadlines due or past due.
15505 A deadline is considered due if it happens within `org-deadline-warning-days'
15506 days from today's date. If the deadline appears in an entry marked DONE,
15507 it is not shown. The prefix arg NDAYS can be used to test that many
15509 (interactive "P")
15510 (let* ((org-warn-days
15511 (cond
15512 ((equal ndays '(4)) 100000)
15513 (ndays (prefix-numeric-value ndays))
15514 (t (abs org-deadline-warning-days))))
15515 (case-fold-search nil)
15517 (callback
15518 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15520 (message "%d deadlines past-due or due within %d days"
15521 (org-occur regexp nil callback)
15522 org-warn-days)))
15524 (defun org-check-before-date (date)
15525 "Check if there are deadlines or scheduled entries before DATE."
15526 (interactive (list (org-read-date)))
15527 (let ((case-fold-search nil)
15531 (callback
15532 (lambda () (time-less-p
15533 (org-time-string-to-time (match-string 2))
15534 (org-time-string-to-time date)))))
15535 (message "%d entries before %s"
15536 (org-occur regexp nil callback) date)))
15538 (defun org-check-after-date (date)
15539 "Check if there are deadlines or scheduled entries after DATE."
15540 (interactive (list (org-read-date)))
15541 (let ((case-fold-search nil)
15545 (callback
15546 (lambda () (not
15547 (time-less-p
15548 (org-time-string-to-time (match-string 2))
15549 (org-time-string-to-time date))))))
15550 (message "%d entries after %s"
15551 (org-occur regexp nil callback) date)))
15553 (defun org-check-dates-range (start-date end-date)
15554 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15555 (interactive (list (org-read-date nil nil nil "Range starts")
15556 (org-read-date nil nil nil "Range end")))
15557 (let ((case-fold-search nil)
15561 (callback
15562 (lambda ()
15563 (let ((match (match-string 2)))
15564 (and
15565 (not (time-less-p
15566 (org-time-string-to-time match)
15567 (org-time-string-to-time start-date)))
15568 (time-less-p
15569 (org-time-string-to-time match)
15570 (org-time-string-to-time end-date)))))))
15571 (message "%d entries between %s and %s"
15572 (org-occur regexp nil callback) start-date end-date)))
15574 (defun org-evaluate-time-range (&optional to-buffer)
15575 "Evaluate a time range by computing the difference between start and end.
15576 Normally the result is just printed in the echo area, but with prefix arg
15577 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15578 If the time range is actually in a table, the result is inserted into the
15579 next column.
15580 For time difference computation, a year is assumed to be exactly 365
15581 days in order to avoid rounding problems."
15582 (interactive "P")
15583 (or
15584 (org-clock-update-time-maybe)
15585 (save-excursion
15586 (unless (org-at-date-range-p t)
15587 (goto-char (point-at-bol))
15588 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15589 (if (not (org-at-date-range-p t))
15590 (error "Not at a time-stamp range, and none found in current line")))
15591 (let* ((ts1 (match-string 1))
15592 (ts2 (match-string 2))
15593 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15594 (match-end (match-end 0))
15595 (time1 (org-time-string-to-time ts1))
15596 (time2 (org-time-string-to-time ts2))
15597 (t1 (org-float-time time1))
15598 (t2 (org-float-time time2))
15599 (diff (abs (- t2 t1)))
15600 (negative (< (- t2 t1) 0))
15601 ;; (ys (floor (* 365 24 60 60)))
15602 (ds (* 24 60 60))
15603 (hs (* 60 60))
15604 (fy "%dy %dd %02d:%02d")
15605 (fy1 "%dy %dd")
15606 (fd "%dd %02d:%02d")
15607 (fd1 "%dd")
15608 (fh "%02d:%02d")
15609 y d h m align)
15610 (if havetime
15611 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15612 y 0
15613 d (floor (/ diff ds)) diff (mod diff ds)
15614 h (floor (/ diff hs)) diff (mod diff hs)
15615 m (floor (/ diff 60)))
15616 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15617 y 0
15618 d (floor (+ (/ diff ds) 0.5))
15619 h 0 m 0))
15620 (if (not to-buffer)
15621 (message "%s" (org-make-tdiff-string y d h m))
15622 (if (org-at-table-p)
15623 (progn
15624 (goto-char match-end)
15625 (setq align t)
15626 (and (looking-at " *|") (goto-char (match-end 0))))
15627 (goto-char match-end))
15628 (if (looking-at
15630 (replace-match ""))
15631 (if negative (insert " -"))
15632 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15633 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15634 (insert " " (format fh h m))))
15635 (if align (org-table-align))
15636 (message "Time difference inserted")))))
15638 (defun org-make-tdiff-string (y d h m)
15639 (let ((fmt "")
15640 (l nil))
15641 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15642 l (push y l)))
15643 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15644 l (push d l)))
15645 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15646 l (push h l)))
15647 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15648 l (push m l)))
15649 (apply 'format fmt (nreverse l))))
15651 (defun org-time-string-to-time (s &optional buffer pos)
15652 (condition-case errdata
15653 (apply 'encode-time (org-parse-time-string s))
15655 s (if (not (and buffer pos))
15656 ""
15657 (format " at %d in buffer `%s'" pos buffer))
15658 (cdr errdata)))))
15660 (defun org-time-string-to-seconds (s)
15661 (org-float-time (org-time-string-to-time s)))
15663 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15664 "Convert a time stamp to an absolute day number.
15665 If there is a specifier for a cyclic time stamp, get the closest date to
15666 DAYNR.
15667 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15668 The variable date is bound by the calendar when this is called."
15669 (cond
15671 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15672 daynr
15673 (+ daynr 1000)))
15675 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15676 (time-to-days (current-time))) (match-string 0 s)
15677 prefer show-all))
15678 (t (time-to-days
15679 (condition-case errdata
15680 (apply 'encode-time (org-parse-time-string s))
15682 s (if (not (and buffer pos))
15683 ""
15684 (format " at %d in buffer `%s'" pos buffer))
15685 (cdr errdata))))))))
15687 (defun org-days-to-iso-week (days)
15688 "Return the iso week number."
15689 (require 'cal-iso)
15690 (car (calendar-iso-from-absolute days)))
15692 (defun org-small-year-to-year (year)
15693 "Convert 2-digit years into 4-digit years.
15694 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15695 The year 2000 cannot be abbreviated. Any year larger than 99
15696 is returned unchanged."
15697 (if (< year 38)
15698 (setq year (+ 2000 year))
15699 (if (< year 100)
15700 (setq year (+ 1900 year))))
15701 year)
15703 (defun org-time-from-absolute (d)
15704 "Return the time corresponding to date D.
15705 D may be an absolute day number, or a calendar-type list (month day year)."
15706 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15707 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15709 (defun org-calendar-holiday ()
15710 "List of holidays, for Diary display in Org-mode."
15711 (require 'holidays)
15712 (let ((hl (funcall
15713 (if (fboundp 'calendar-check-holidays)
15714 'calendar-check-holidays 'check-calendar-holidays) date)))
15715 (if hl (mapconcat 'identity hl "; "))))
15717 (defun org-diary-sexp-entry (sexp entry date)
15718 "Process a SEXP diary ENTRY for DATE."
15719 (require 'diary-lib)
15720 (let ((result (if calendar-debug-sexp
15721 (let ((stack-trace-on-error t))
15722 (eval (car (read-from-string sexp))))
15723 (condition-case nil
15724 (eval (car (read-from-string sexp)))
15725 (error
15726 (beep)
15727 (message "Bad sexp at line %d in %s: %s"
15728 (org-current-line)
15729 (buffer-file-name) sexp)
15730 (sleep-for 2))))))
15731 (cond ((stringp result) (split-string result "; "))
15732 ((and (consp result)
15733 (not (consp (cdr result)))
15734 (stringp (cdr result))) (cdr result))
15735 ((and (consp result)
15736 (stringp (car result))) result)
15737 (result entry)
15738 (t nil))))
15740 (defun org-diary-to-ical-string (frombuf)
15741 "Get iCalendar entries from diary entries in buffer FROMBUF.
15742 This uses the icalendar.el library."
15743 (let* ((tmpdir (if (featurep 'xemacs)
15744 (temp-directory)
15745 temporary-file-directory))
15746 (tmpfile (make-temp-name
15747 (expand-file-name "orgics" tmpdir)))
15748 buf rtn b e)
15749 (with-current-buffer frombuf
15750 (icalendar-export-region (point-min) (point-max) tmpfile)
15751 (setq buf (find-buffer-visiting tmpfile))
15752 (set-buffer buf)
15753 (goto-char (point-min))
15754 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15755 (setq b (match-beginning 0)))
15756 (goto-char (point-max))
15757 (if (re-search-backward "^END:VEVENT" nil t)
15758 (setq e (match-end 0)))
15760 (kill-buffer buf)
15761 (delete-file tmpfile)
15762 rtn))
15764 (defun org-closest-date (start current change prefer show-all)
15765 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15766 When PREFER is `past', return a date that is either CURRENT or past.
15767 When PREFER is `future', return a date that is either CURRENT or future.
15768 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15769 ;; Make the proper lists from the dates
15770 (catch 'exit
15771 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15772 dn dw sday cday n1 n2 n0
15773 d m y y1 y2 date1 date2 nmonths nm ny m2)
15775 (setq start (org-date-to-gregorian start)
15776 current (org-date-to-gregorian
15777 (if show-all
15778 current
15779 (time-to-days (current-time))))
15780 sday (calendar-absolute-from-gregorian start)
15781 cday (calendar-absolute-from-gregorian current))
15783 (if (<= cday sday) (throw 'exit sday))
15786 (setq dn (string-to-number (match-string 1 change))
15787 dw (cdr (assoc (match-string 2 change) a1)))
15788 (error "Invalid change specifier: %s" change))
15789 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15790 (cond
15791 ((eq dw 'day)
15792 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15793 n2 (+ n1 dn)))
15794 ((eq dw 'year)
15795 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15796 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15797 (setq date1 (list m d y1)
15798 n1 (calendar-absolute-from-gregorian date1)
15799 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15800 n2 (calendar-absolute-from-gregorian date2)))
15801 ((eq dw 'month)
15802 ;; approx number of month between the two dates
15803 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15804 ;; How often does dn fit in there?
15805 (setq d (nth 1 start) m (car start) y (nth 2 start)
15806 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15807 m (+ m nm)
15808 ny (floor (/ m 12))
15809 y (+ y ny)
15810 m (- m (* ny 12)))
15811 (while (> m 12) (setq m (- m 12) y (1+ y)))
15812 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15813 (setq m2 (+ m dn) y2 y)
15814 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15815 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15816 (while (<= n2 cday)
15817 (setq n1 n2 m m2 y y2)
15818 (setq m2 (+ m dn) y2 y)
15819 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15820 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15821 ;; Make sure n1 is the earlier date
15822 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15823 (if show-all
15824 (cond
15825 ((eq prefer 'past) (if (= cday n2) n2 n1))
15826 ((eq prefer 'future) (if (= cday n1) n1 n2))
15827 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15828 (cond
15829 ((eq prefer 'past) (if (= cday n2) n2 n1))
15830 ((eq prefer 'future) (if (= cday n1) n1 n2))
15831 (t (if (= cday n1) n1 n2)))))))
15833 (defun org-date-to-gregorian (date)
15834 "Turn any specification of DATE into a Gregorian date for the calendar."
15835 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15836 ((and (listp date) (= (length date) 3)) date)
15837 ((stringp date)
15838 (setq date (org-parse-time-string date))
15839 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15840 ((listp date)
15841 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15843 (defun org-parse-time-string (s &optional nodefault)
15844 "Parse the standard Org-mode time string.
15845 This should be a lot faster than the normal `parse-time-string'.
15846 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15847 hour and minute fields will be nil if not given."
15848 (if (string-match org-ts-regexp0 s)
15849 (list 0
15850 (if (or (match-beginning 8) (not nodefault))
15851 (string-to-number (or (match-string 8 s) "0")))
15852 (if (or (match-beginning 7) (not nodefault))
15853 (string-to-number (or (match-string 7 s) "0")))
15854 (string-to-number (match-string 4 s))
15855 (string-to-number (match-string 3 s))
15856 (string-to-number (match-string 2 s))
15857 nil nil nil)
15858 (error "Not a standard Org-mode time string: %s" s)))
15860 (defun org-timestamp-up (&optional arg)
15861 "Increase the date item at the cursor by one.
15862 If the cursor is on the year, change the year. If it is on the month,
15863 the day or the time, change that.
15864 With prefix ARG, change by that many units."
15865 (interactive "p")
15866 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15868 (defun org-timestamp-down (&optional arg)
15869 "Decrease the date item at the cursor by one.
15870 If the cursor is on the year, change the year. If it is on the month,
15871 the day or the time, change that.
15872 With prefix ARG, change by that many units."
15873 (interactive "p")
15874 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15876 (defun org-timestamp-up-day (&optional arg)
15877 "Increase the date in the time stamp by one day.
15878 With prefix ARG, change that many days."
15879 (interactive "p")
15880 (if (and (not (org-at-timestamp-p t))
15881 (org-at-heading-p))
15882 (org-todo 'up)
15883 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15885 (defun org-timestamp-down-day (&optional arg)
15886 "Decrease the date in the time stamp by one day.
15887 With prefix ARG, change that many days."
15888 (interactive "p")
15889 (if (and (not (org-at-timestamp-p t))
15890 (org-at-heading-p))
15891 (org-todo 'down)
15892 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15894 (defun org-at-timestamp-p (&optional inactive-ok)
15895 "Determine if the cursor is in or at a timestamp."
15896 (interactive)
15897 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15898 (pos (point))
15899 (ans (or (looking-at tsr)
15900 (save-excursion
15902 (if (> (point) (point-min)) (backward-char 1))
15903 (and (looking-at tsr)
15904 (> (- (match-end 0) pos) -1))))))
15905 (and ans
15906 (boundp 'org-ts-what)
15907 (setq org-ts-what
15908 (cond
15909 ((= pos (match-beginning 0)) 'bracket)
15910 ;; Point is considered to be "on the bracket" whether
15911 ;; it's really on it or right after it.
15912 ((or (= pos (1- (match-end 0)))
15913 (= pos (match-end 0))) 'bracket)
15914 ((org-pos-in-match-range pos 2) 'year)
15915 ((org-pos-in-match-range pos 3) 'month)
15916 ((org-pos-in-match-range pos 7) 'hour)
15917 ((org-pos-in-match-range pos 8) 'minute)
15918 ((or (org-pos-in-match-range pos 4)
15919 (org-pos-in-match-range pos 5)) 'day)
15920 ((and (> pos (or (match-end 8) (match-end 5)))
15921 (< pos (match-end 0)))
15922 (- pos (or (match-end 8) (match-end 5))))
15923 (t 'day))))
15924 ans))
15926 (defun org-toggle-timestamp-type ()
15927 "Toggle the type (<active> or [inactive]) of a time stamp."
15928 (interactive)
15929 (when (org-at-timestamp-p t)
15930 (let ((beg (match-beginning 0)) (end (match-end 0))
15931 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15932 (save-excursion
15933 (goto-char beg)
15934 (while (re-search-forward "[][<>]" end t)
15935 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15936 t t)))
15937 (message "Timestamp is now %sactive"
15938 (if (equal (char-after beg) ?<) "" "in")))))
15940 (defun org-timestamp-change (n &optional what updown)
15941 "Change the date in the time stamp at point.
15942 The date will be changed by N times WHAT. WHAT can be `day', `month',
15943 `year', `minute', `second'. If WHAT is not given, the cursor position
15944 in the timestamp determines what will be changed."
15945 (let ((origin (point)) origin-cat
15946 with-hm inactive
15947 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15948 org-ts-what
15949 extra rem
15950 ts time time0)
15951 (if (not (org-at-timestamp-p t))
15952 (error "Not at a timestamp"))
15953 (if (and (not what) (eq org-ts-what 'bracket))
15954 (org-toggle-timestamp-type)
15955 ;; Point isn't on brackets. Remember the part of the time-stamp
15956 ;; the point was in. Indeed, size of time-stamps may change,
15957 ;; but point must be kept in the same category nonetheless.
15958 (setq origin-cat org-ts-what)
15959 (if (and (not what) (not (eq org-ts-what 'day))
15960 org-display-custom-times
15961 (get-text-property (point) 'display)
15962 (not (get-text-property (1- (point)) 'display)))
15963 (setq org-ts-what 'day))
15964 (setq org-ts-what (or what org-ts-what)
15965 inactive (= (char-after (match-beginning 0)) ?\[)
15966 ts (match-string 0))
15967 (replace-match "")
15968 (if (string-match
15970 ts)
15971 (setq extra (match-string 1 ts)))
15973 (setq with-hm t))
15974 (setq time0 (org-parse-time-string ts))
15975 (when (and updown
15976 (eq org-ts-what 'minute)
15977 (not current-prefix-arg))
15978 ;; This looks like s-up and s-down. Change by one rounding step.
15979 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15980 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15981 (setcar (cdr time0) (+ (nth 1 time0)
15982 (if (> n 0) (- rem) (- dm rem))))))
15983 (setq time
15984 (encode-time (or (car time0) 0)
15985 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15986 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15987 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15988 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15989 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15990 (nthcdr 6 time0)))
15991 (when (and (member org-ts-what '(hour minute))
15992 extra
15994 (setq extra (org-modify-ts-extra
15995 extra
15996 (if (eq org-ts-what 'hour) 2 5)
15997 n dm)))
15998 (when (integerp org-ts-what)
15999 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16000 (if (eq what 'calendar)
16001 (let ((cal-date (org-get-date-from-calendar)))
16002 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16003 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16004 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16005 (setcar time0 (or (car time0) 0))
16006 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16007 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16008 (setq time (apply 'encode-time time0))))
16009 ;; Insert the new time-stamp, and ensure point stays in the same
16010 ;; category as before (i.e. not after the last position in that
16011 ;; category).
16012 (let ((pos (point)))
16013 ;; Stay before inserted string. `save-excursion' is of no use.
16014 (setq org-last-changed-timestamp
16015 (org-insert-time-stamp time with-hm inactive nil nil extra))
16016 (goto-char pos))
16017 (save-match-data
16018 (looking-at org-ts-regexp3)
16019 (goto-char (cond
16020 ;; `day' category ends before `hour' if any, or at
16021 ;; the end of the day name.
16022 ((eq origin-cat 'day)
16023 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16024 ((eq origin-cat 'hour) (min (match-end 7) origin))
16025 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16026 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16027 ;; `year' and `month' have both fixed size: point
16028 ;; couldn't have moved into another part.
16029 (t origin))))
16030 ;; Update clock if on a CLOCK line.
16031 (org-clock-update-time-maybe)
16032 ;; Try to recenter the calendar window, if any.
16033 (if (and org-calendar-follow-timestamp-change
16034 (get-buffer-window "*Calendar*" t)
16035 (memq org-ts-what '(day month year)))
16036 (org-recenter-calendar (time-to-days time))))))
16038 (defun org-modify-ts-extra (s pos n dm)
16039 "Change the different parts of the lead-time and repeat fields in timestamp."
16040 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16041 ng h m new rem)
16042 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16043 (cond
16044 ((or (org-pos-in-match-range pos 2)
16045 (org-pos-in-match-range pos 3))
16046 (setq m (string-to-number (match-string 3 s))
16047 h (string-to-number (match-string 2 s)))
16048 (if (org-pos-in-match-range pos 2)
16049 (setq h (+ h n))
16050 (setq n (* dm (org-no-warnings (signum n))))
16051 (when (not (= 0 (setq rem (% m dm))))
16052 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16053 (setq m (+ m n)))
16054 (if (< m 0) (setq m (+ m 60) h (1- h)))
16055 (if (> m 59) (setq m (- m 60) h (1+ h)))
16056 (setq h (min 24 (max 0 h)))
16057 (setq ng 1 new (format "-%02d:%02d" h m)))
16058 ((org-pos-in-match-range pos 6)
16059 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16060 ((org-pos-in-match-range pos 5)
16061 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16063 ((org-pos-in-match-range pos 9)
16064 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16065 ((org-pos-in-match-range pos 8)
16066 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16068 (when ng
16069 (setq s (concat
16070 (substring s 0 (match-beginning ng))
16071 new
16072 (substring s (match-end ng))))))
16073 s))
16075 (defun org-recenter-calendar (date)
16076 "If the calendar is visible, recenter it to DATE."
16077 (let* ((win (selected-window))
16078 (cwin (get-buffer-window "*Calendar*" t))
16079 (calendar-move-hook nil))
16080 (when cwin
16081 (select-window cwin)
16082 (calendar-goto-date (if (listp date) date
16083 (calendar-gregorian-from-absolute date)))
16084 (select-window win))))
16086 (defun org-goto-calendar (&optional arg)
16087 "Go to the Emacs calendar at the current date.
16088 If there is a time stamp in the current line, go to that date.
16089 A prefix ARG can be used to force the current date."
16090 (interactive "P")
16091 (let ((tsr org-ts-regexp) diff
16092 (calendar-move-hook nil)
16093 (calendar-view-holidays-initially-flag nil)
16094 (calendar-view-diary-initially-flag nil))
16095 (if (or (org-at-timestamp-p)
16096 (save-excursion
16097 (beginning-of-line 1)
16098 (looking-at (concat ".*" tsr))))
16099 (let ((d1 (time-to-days (current-time)))
16100 (d2 (time-to-days
16101 (org-time-string-to-time (match-string 1)))))
16102 (setq diff (- d2 d1))))
16103 (calendar)
16104 (calendar-goto-today)
16105 (if (and diff (not arg)) (calendar-forward-day diff))))
16107 (defun org-get-date-from-calendar ()
16108 "Return a list (month day year) of date at point in calendar."
16109 (with-current-buffer "*Calendar*"
16110 (save-match-data
16111 (calendar-cursor-to-date))))
16113 (defun org-date-from-calendar ()
16114 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16115 If there is already a time stamp at the cursor position, update it."
16116 (interactive)
16117 (if (org-at-timestamp-p t)
16118 (org-timestamp-change 0 'calendar)
16119 (let ((cal-date (org-get-date-from-calendar)))
16120 (org-insert-time-stamp
16121 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16123 (defun org-minutes-to-hh:mm-string (m)
16124 "Compute H:MM from a number of minutes."
16125 (let ((h (/ m 60)))
16126 (setq m (- m (* 60 h)))
16127 (format org-time-clocksum-format h m)))
16129 (defun org-hh:mm-string-to-minutes (s)
16130 "Convert a string H:MM to a number of minutes.
16131 If the string is just a number, interpret it as minutes.
16132 In fact, the first hh:mm or number in the string will be taken,
16133 there can be extra stuff in the string.
16134 If no number is found, the return value is 0."
16135 (cond
16136 ((integerp s) s)
16138 (+ (* (string-to-number (match-string 1 s)) 60)
16139 (string-to-number (match-string 2 s))))
16141 (string-to-number (match-string 1 s)))
16142 (t 0)))
16144 (defcustom org-effort-durations
16145 `(("h" . 60)
16146 ("d" . ,(* 60 8))
16147 ("w" . ,(* 60 8 5))
16148 ("m" . ,(* 60 8 5 4))
16149 ("y" . ,(* 60 8 5 40)))
16150 "Conversion factor to minutes for an effort modifier.
16152 Each entry has the form (MODIFIER . MINUTES).
16154 In an effort string, a number followed by MODIFIER is multiplied
16155 by the specified number of MINUTES to obtain an effort in
16156 minutes.
16160 :group 'org-agenda
16161 :type '(alist :key-type (string :tag "Modifier")
16162 :value-type (number :tag "Minutes")))
16164 (defun org-duration-string-to-minutes (s)
16165 "Convert a duration string S to minutes.
16167 A bare number is interpreted as minutes, modifiers can be set by
16168 customizing `org-effort-durations' (which see).
16170 Entries containing a colon are interpreted as H:MM by
16171 `org-hh:mm-string-to-minutes'."
16172 (let ((result 0)
16174 (regexp-opt (mapcar 'car org-effort-durations))
16176 (while (string-match re s)
16177 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16178 (string-to-number (match-string 1 s))))
16179 (setq s (replace-match "" nil t s)))
16180 (incf result (org-hh:mm-string-to-minutes s))
16181 result))
16183 ;;;; Files
16185 (defun org-save-all-org-buffers ()
16186 "Save all Org-mode buffers without user confirmation."
16187 (interactive)
16188 (message "Saving all Org-mode buffers...")
16189 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16190 (when (featurep 'org-id) (org-id-locations-save))
16191 (message "Saving all Org-mode buffers... done"))
16193 (defun org-revert-all-org-buffers ()
16194 "Revert all Org-mode buffers.
16195 Prompt for confirmation when there are unsaved changes.
16196 Be sure you know what you are doing before letting this function
16197 overwrite your changes.
16199 This function is useful in a setup where one tracks org files
16200 with a version control system, to revert on one machine after pulling
16201 changes from another. I believe the procedure must be like this:
16203 1. M-x org-save-all-org-buffers
16204 2. Pull changes from the other machine, resolve conflicts
16205 3. M-x org-revert-all-org-buffers"
16206 (interactive)
16207 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16208 (error "Abort"))
16209 (save-excursion
16210 (save-window-excursion
16211 (mapc
16212 (lambda (b)
16213 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16214 (with-current-buffer b buffer-file-name))
16215 (org-pop-to-buffer-same-window b)
16216 (revert-buffer t 'no-confirm)))
16217 (buffer-list))
16218 (when (and (featurep 'org-id) org-id-track-globally)
16219 (org-id-locations-load)))))
16221 ;;;; Agenda files
16223 ;;;###autoload
16224 (defun org-switchb (&optional arg)
16225 "Switch between Org buffers.
16226 With one prefix argument, restrict available buffers to files.
16227 With two prefix arguments, restrict available buffers to agenda files.
16229 Defaults to `iswitchb' for buffer name completion.
16230 Set `org-completion-use-ido' to make it use ido instead."
16231 (interactive "P")
16232 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16233 ((equal arg '(16)) (org-buffer-list 'agenda))
16234 (t (org-buffer-list))))
16235 (org-completion-use-iswitchb org-completion-use-iswitchb)
16236 (org-completion-use-ido org-completion-use-ido))
16237 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16238 (setq org-completion-use-iswitchb t))
16239 (org-pop-to-buffer-same-window
16240 (org-icompleting-read "Org buffer: "
16241 (mapcar 'list (mapcar 'buffer-name blist))
16242 nil t))))
16244 ;;; Define some older names previously used for this functionality
16245 ;;;###autoload
16246 (defalias 'org-ido-switchb 'org-switchb)
16247 ;;;###autoload
16248 (defalias 'org-iswitchb 'org-switchb)
16250 (defun org-buffer-list (&optional predicate exclude-tmp)
16251 "Return a list of Org buffers.
16252 PREDICATE can be `export', `files' or `agenda'.
16254 export restrict the list to Export buffers.
16255 files restrict the list to buffers visiting Org files.
16256 agenda restrict the list to buffers visiting agenda files.
16258 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16259 (let* ((bfn nil)
16260 (agenda-files (and (eq predicate 'agenda)
16261 (mapcar 'file-truename (org-agenda-files t))))
16262 (filter
16263 (cond
16264 ((eq predicate 'files)
16265 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16266 ((eq predicate 'export)
16267 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16268 ((eq predicate 'agenda)
16269 (lambda (b)
16270 (with-current-buffer b
16271 (and (eq major-mode 'org-mode)
16272 (setq bfn (buffer-file-name b))
16273 (member (file-truename bfn) agenda-files)))))
16274 (t (lambda (b) (with-current-buffer b
16275 (or (eq major-mode 'org-mode)
16276 (string-match "\*Org .*Export"
16277 (buffer-name b)))))))))
16278 (delq nil
16279 (mapcar
16280 (lambda(b)
16281 (if (and (funcall filter b)
16282 (or (not exclude-tmp)
16283 (not (string-match "tmp" (buffer-name b)))))
16284 b
16285 nil))
16286 (buffer-list)))))
16288 (defun org-agenda-files (&optional unrestricted archives)
16289 "Get the list of agenda files.
16290 Optional UNRESTRICTED means return the full list even if a restriction
16291 is currently in place.
16292 When ARCHIVES is t, include all archive files that are really being
16293 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16294 `org-agenda-archives-mode' is t."
16295 (let ((files
16296 (cond
16297 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16298 ((stringp org-agenda-files) (org-read-agenda-file-list))
16299 ((listp org-agenda-files) org-agenda-files)
16300 (t (error "Invalid value of `org-agenda-files'")))))
16301 (setq files (apply 'append
16302 (mapcar (lambda (f)
16303 (if (file-directory-p f)
16304 (directory-files
16305 f t org-agenda-file-regexp)
16306 (list f)))
16307 files)))
16308 (when org-agenda-skip-unavailable-files
16309 (setq files (delq nil
16310 (mapcar (function
16311 (lambda (file)
16312 (and (file-readable-p file) file)))
16313 files))))
16314 (when (or (eq archives t)
16315 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16316 (setq files (org-add-archive-files files)))
16317 files))
16319 (defun org-agenda-file-p (&optional file)
16320 "Return non-nil, if FILE is an agenda file.
16321 If FILE is omitted, use the file associated with the current
16322 buffer."
16323 (member (or file (buffer-file-name))
16324 (org-agenda-files t)))
16326 (defun org-edit-agenda-file-list ()
16327 "Edit the list of agenda files.
16328 Depending on setup, this either uses customize to edit the variable
16329 `org-agenda-files', or it visits the file that is holding the list. In the
16330 latter case, the buffer is set up in a way that saving it automatically kills
16331 the buffer and restores the previous window configuration."
16332 (interactive)
16333 (if (stringp org-agenda-files)
16334 (let ((cw (current-window-configuration)))
16335 (find-file org-agenda-files)
16336 (org-set-local 'org-window-configuration cw)
16337 (org-add-hook 'after-save-hook
16338 (lambda ()
16339 (set-window-configuration
16340 (prog1 org-window-configuration
16341 (kill-buffer (current-buffer))))
16342 (org-install-agenda-files-menu)
16343 (message "New agenda file list installed"))
16344 nil 'local)
16345 (message "%s" (substitute-command-keys
16347 (customize-variable 'org-agenda-files)))
16349 (defun org-store-new-agenda-file-list (list)
16350 "Set new value for the agenda file list and save it correctly."
16351 (if (stringp org-agenda-files)
16352 (let ((fe (org-read-agenda-file-list t)) b u)
16353 (while (setq b (find-buffer-visiting org-agenda-files))
16354 (kill-buffer b))
16355 (with-temp-file org-agenda-files
16356 (insert
16357 (mapconcat
16358 (lambda (f) ;; Keep un-expanded entries.
16359 (if (setq u (assoc f fe))
16360 (cdr u)
16361 f))
16364 (let ((org-mode-hook nil) (org-inhibit-startup t)
16365 (org-insert-mode-line-in-empty-file nil))
16366 (setq org-agenda-files list)
16367 (customize-save-variable 'org-agenda-files org-agenda-files))))
16369 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16370 "Read the list of agenda files from a file.
16371 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16372 filenames, used by `org-store-new-agenda-file-list' to write back
16373 un-expanded file names."
16374 (when (file-directory-p org-agenda-files)
16375 (error "`org-agenda-files' cannot be a single directory"))
16376 (when (stringp org-agenda-files)
16377 (with-temp-buffer
16378 (insert-file-contents org-agenda-files)
16379 (mapcar
16380 (lambda (f)
16381 (let ((e (expand-file-name (substitute-in-file-name f)
16382 org-directory)))
16383 (if pair-with-expansion
16384 (cons e f)
16385 e)))
16388 ;;;###autoload
16389 (defun org-cycle-agenda-files ()
16390 "Cycle through the files in `org-agenda-files'.
16391 If the current buffer visits an agenda file, find the next one in the list.
16392 If the current buffer does not, find the first agenda file."
16393 (interactive)
16394 (let* ((fs (org-agenda-files t))
16395 (files (append fs (list (car fs))))
16396 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16397 file)
16398 (unless files (error "No agenda files"))
16399 (catch 'exit
16400 (while (setq file (pop files))
16401 (if (equal (file-truename file) tcf)
16402 (when (car files)
16403 (find-file (car files))
16404 (throw 'exit t))))
16405 (find-file (car fs)))
16406 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16408 (defun org-agenda-file-to-front (&optional to-end)
16409 "Move/add the current file to the top of the agenda file list.
16410 If the file is not present in the list, it is added to the front. If it is
16411 present, it is moved there. With optional argument TO-END, add/move to the
16412 end of the list."
16413 (interactive "P")
16414 (let ((org-agenda-skip-unavailable-files nil)
16415 (file-alist (mapcar (lambda (x)
16416 (cons (file-truename x) x))
16417 (org-agenda-files t)))
16418 (ctf (file-truename buffer-file-name))
16419 x had)
16420 (setq x (assoc ctf file-alist) had x)
16422 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16423 (if to-end
16424 (setq file-alist (append (delq x file-alist) (list x)))
16425 (setq file-alist (cons x (delq x file-alist))))
16426 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16427 (org-install-agenda-files-menu)
16428 (message "File %s to %s of agenda file list"
16429 (if had "moved" "added") (if to-end "end" "front"))))
16431 (defun org-remove-file (&optional file)
16432 "Remove current file from the list of files in variable `org-agenda-files'.
16433 These are the files which are being checked for agenda entries.
16434 Optional argument FILE means use this file instead of the current."
16435 (interactive)
16436 (let* ((org-agenda-skip-unavailable-files nil)
16437 (file (or file buffer-file-name))
16438 (true-file (file-truename file))
16439 (afile (abbreviate-file-name file))
16440 (files (delq nil (mapcar
16441 (lambda (x)
16442 (if (equal true-file
16443 (file-truename x))
16444 nil x))
16445 (org-agenda-files t)))))
16446 (if (not (= (length files) (length (org-agenda-files t))))
16447 (progn
16448 (org-store-new-agenda-file-list files)
16449 (org-install-agenda-files-menu)
16450 (message "Removed file: %s" afile))
16451 (message "File was not in list: %s (not removed)" afile))))
16453 (defun org-file-menu-entry (file)
16454 (vector file (list 'find-file file) t))
16456 (defun org-check-agenda-file (file)
16457 "Make sure FILE exists. If not, ask user what to do."
16458 (when (not (file-exists-p file))
16459 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16460 (abbreviate-file-name file))
16461 (let ((r (downcase (read-char-exclusive))))
16462 (cond
16463 ((equal r ?r)
16464 (org-remove-file file)
16465 (throw 'nextfile t))
16466 (t (error "Abort"))))))
16468 (defun org-get-agenda-file-buffer (file)
16469 "Get a buffer visiting FILE. If the buffer needs to be created, add
16470 it to the list of buffers which might be released later."
16471 (let ((buf (org-find-base-buffer-visiting file)))
16472 (if buf
16473 buf ; just return it
16474 ;; Make a new buffer and remember it
16475 (setq buf (find-file-noselect file))
16476 (if buf (push buf org-agenda-new-buffers))
16477 buf)))
16479 (defun org-release-buffers (blist)
16480 "Release all buffers in list, asking the user for confirmation when needed.
16481 When a buffer is unmodified, it is just killed. When modified, it is saved
16482 \(if the user agrees) and then killed."
16483 (let (buf file)
16484 (while (setq buf (pop blist))
16485 (setq file (buffer-file-name buf))
16486 (when (and (buffer-modified-p buf)
16487 file
16488 (y-or-n-p (format "Save file %s? " file)))
16489 (with-current-buffer buf (save-buffer)))
16490 (kill-buffer buf))))
16492 (defun org-prepare-agenda-buffers (files)
16493 "Create buffers for all agenda files, protect archived trees and comments."
16494 (interactive)
16495 (let ((pa '(:org-archived t))
16496 (pc '(:org-comment t))
16497 (pall '(:org-archived t :org-comment t))
16498 (inhibit-read-only t)
16499 (rea (concat ":" org-archive-tag ":"))
16500 bmp file re)
16501 (save-excursion
16502 (save-restriction
16503 (while (setq file (pop files))
16504 (catch 'nextfile
16505 (if (bufferp file)
16506 (set-buffer file)
16507 (org-check-agenda-file file)
16508 (set-buffer (org-get-agenda-file-buffer file)))
16509 (widen)
16510 (setq bmp (buffer-modified-p))
16511 (org-refresh-category-properties)
16512 (setq org-todo-keywords-for-agenda
16513 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16514 (setq org-done-keywords-for-agenda
16515 (append org-done-keywords-for-agenda org-done-keywords))
16516 (setq org-todo-keyword-alist-for-agenda
16517 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16518 (setq org-drawers-for-agenda
16519 (append org-drawers-for-agenda org-drawers))
16520 (setq org-tag-alist-for-agenda
16521 (append org-tag-alist-for-agenda org-tag-alist))
16523 (save-excursion
16524 (remove-text-properties (point-min) (point-max) pall)
16525 (when org-agenda-skip-archived-trees
16526 (goto-char (point-min))
16527 (while (re-search-forward rea nil t)
16528 (if (org-at-heading-p t)
16529 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16530 (goto-char (point-min))
16531 (setq re (format org-heading-keyword-regexp-format
16532 org-comment-string))
16533 (while (re-search-forward re nil t)
16534 (add-text-properties
16535 (match-beginning 0) (org-end-of-subtree t) pc)))
16536 (set-buffer-modified-p bmp)))))
16537 (setq org-todo-keywords-for-agenda
16538 (org-uniquify org-todo-keywords-for-agenda))
16539 (setq org-todo-keyword-alist-for-agenda
16540 (org-uniquify org-todo-keyword-alist-for-agenda)
16541 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16543 ;;;; Embedded LaTeX
16545 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16546 "Keymap for the minor `org-cdlatex-mode'.")
16548 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16549 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16550 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16551 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16552 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16554 (defvar org-cdlatex-texmathp-advice-is-done nil
16555 "Flag remembering if we have applied the advice to texmathp already.")
16557 (define-minor-mode org-cdlatex-mode
16558 "Toggle the minor `org-cdlatex-mode'.
16559 This mode supports entering LaTeX environment and math in LaTeX fragments
16560 in Org-mode.
16562 nil " OCDL" nil
16563 (when org-cdlatex-mode
16564 (require 'cdlatex)
16565 (run-hooks 'cdlatex-mode-hook)
16566 (cdlatex-compute-tables))
16567 (unless org-cdlatex-texmathp-advice-is-done
16568 (setq org-cdlatex-texmathp-advice-is-done t)
16569 (defadvice texmathp (around org-math-always-on activate)
16570 "Always return t in org-mode buffers.
16571 This is because we want to insert math symbols without dollars even outside
16572 the LaTeX math segments. If Orgmode thinks that point is actually inside
16573 an embedded LaTeX fragment, let texmathp do its job.
16575 (interactive)
16576 (let (p)
16577 (cond
16578 ((not (eq major-mode 'org-mode)) ad-do-it)
16579 ((eq this-command 'cdlatex-math-symbol)
16580 (setq ad-return-value t
16581 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16582 (t
16583 (let ((p (org-inside-LaTeX-fragment-p)))
16584 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16585 (setq ad-return-value t
16586 texmathp-why '("Org-mode embedded math" . 0))
16587 (if p ad-do-it)))))))))
16589 (defun turn-on-org-cdlatex ()
16590 "Unconditionally turn on `org-cdlatex-mode'."
16591 (org-cdlatex-mode 1))
16593 (defun org-inside-LaTeX-fragment-p ()
16594 "Test if point is inside a LaTeX fragment.
16596 sequence appearing also before point.
16597 Even though the matchers for math are configurable, this function assumes
16599 delimiters are skipped when they have been removed by customization.
16600 The return value is nil, or a cons cell with the delimiter and the
16601 position of this delimiter.
16603 This function does a reasonably good job, but can locally be fooled by
16604 for example currency specifications. For example it will assume being in
16606 fragments that are properly closed, but during editing, we have to live
16607 with the uncertainty caused by missing closing delimiters. This function
16608 looks only before point, not after."
16609 (catch 'exit
16610 (let ((pos (point))
16611 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16612 (lim (progn
16614 (point)))
16615 dd-on str (start 0) m re)
16616 (goto-char pos)
16617 (when dodollar
16619 re (nth 1 (assoc "$" org-latex-regexps)))
16620 (while (string-match re str start)
16621 (cond
16622 ((= (match-end 0) (length str))
16623 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16624 ((= (match-end 0) (- (length str) 5))
16625 (throw 'exit nil))
16626 (t (setq start (match-end 0))))))
16627 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16628 (goto-char pos)
16629 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16630 (and (match-beginning 2) (throw 'exit nil))
16631 ;; count $$
16633 (setq dd-on (not dd-on)))
16634 (goto-char pos)
16635 (if dd-on (cons "$$" m))))))
16637 (defun org-inside-latex-macro-p ()
16638 "Is point inside a LaTeX macro or its arguments?"
16639 (save-match-data
16640 (org-in-regexp
16643 (defun org-try-cdlatex-tab ()
16644 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16645 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16646 - inside a LaTeX fragment, or
16647 - after the first word in a line, where an abbreviation expansion could
16648 insert a LaTeX environment."
16649 (when org-cdlatex-mode
16650 (cond
16651 ;; Before any word on the line: No expansion possible.
16653 ;; Just after first word on the line: Expand it. Make sure it
16654 ;; cannot happen on headlines, though.
16655 ((save-excursion
16656 (skip-chars-backward "a-zA-Z0-9*")
16658 (and (bolp) (not (org-at-heading-p))))
16659 (cdlatex-tab) t)
16660 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16662 (defun org-cdlatex-underscore-caret (&optional arg)
16663 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16664 Revert to the normal definition outside of these fragments."
16665 (interactive "P")
16666 (if (org-inside-LaTeX-fragment-p)
16667 (call-interactively 'cdlatex-sub-superscript)
16668 (let (org-cdlatex-mode)
16669 (call-interactively (key-binding (vector last-input-event))))))
16671 (defun org-cdlatex-math-modify (&optional arg)
16672 "Execute `cdlatex-math-modify' in LaTeX fragments.
16673 Revert to the normal definition outside of these fragments."
16674 (interactive "P")
16675 (if (org-inside-LaTeX-fragment-p)
16676 (call-interactively 'cdlatex-math-modify)
16677 (let (org-cdlatex-mode)
16678 (call-interactively (key-binding (vector last-input-event))))))
16680 (defvar org-latex-fragment-image-overlays nil
16681 "List of overlays carrying the images of latex fragments.")
16682 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16684 (defun org-remove-latex-fragment-image-overlays ()
16685 "Remove all overlays with LaTeX fragment images in current buffer."
16686 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16687 (setq org-latex-fragment-image-overlays nil))
16689 (defun org-preview-latex-fragment (&optional subtree)
16690 "Preview the LaTeX fragment at point, or all locally or globally.
16691 If the cursor is in a LaTeX fragment, create the image and overlay
16692 it over the source code. If there is no fragment at point, display
16693 all fragments in the current text, from one headline to the next. With
16694 prefix SUBTREE, display all fragments in the current subtree. With a
16696 the cursor is before the first headline,
16697 display all fragments in the buffer.
16699 (interactive "P")
16700 (org-remove-latex-fragment-image-overlays)
16701 (save-excursion
16702 (save-restriction
16703 (let (beg end at msg)
16704 (cond
16705 ((or (equal subtree '(16))
16706 (not (save-excursion
16707 (re-search-backward org-outline-regexp-bol nil t))))
16708 (setq beg (point-min) end (point-max)
16709 msg "Creating images for buffer...%s"))
16710 ((equal subtree '(4))
16711 (org-back-to-heading)
16712 (setq beg (point) end (org-end-of-subtree t)
16713 msg "Creating images for subtree...%s"))
16714 (t
16715 (if (setq at (org-inside-LaTeX-fragment-p))
16716 (goto-char (max (point-min) (- (cdr at) 2)))
16717 (org-back-to-heading))
16718 (setq beg (point) end (progn (outline-next-heading) (point))
16719 msg (if at "Creating image...%s"
16720 "Creating images for entry...%s"))))
16721 (message msg "")
16722 (narrow-to-region beg end)
16723 (goto-char beg)
16724 (org-format-latex
16725 (concat "ltxpng/" (file-name-sans-extension
16726 (file-name-nondirectory
16727 buffer-file-name)))
16728 default-directory 'overlays msg at 'forbuffer 'dvipng)
16729 (message msg "done. Use `C-c C-c' to remove images.")))))
16731 (defvar org-latex-regexps
16733 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16736 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16740 "Regular expressions for matching embedded LaTeX.")
16742 (defvar org-export-have-math nil) ;; dynamic scoping
16743 (defun org-format-latex (prefix &optional dir overlays msg at
16744 forbuffer processing-type)
16745 "Replace LaTeX fragments with links to an image, and produce images.
16746 Some of the options can be changed using the variable
16747 `org-format-latex-options'."
16748 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16749 (let* ((prefixnodir (file-name-nondirectory prefix))
16750 (absprefix (expand-file-name prefix dir))
16751 (todir (file-name-directory absprefix))
16752 (opt org-format-latex-options)
16753 (matchers (plist-get opt :matchers))
16754 (re-list org-latex-regexps)
16755 (org-format-latex-header-extra
16756 (plist-get (org-infile-export-plist) :latex-header-extra))
16757 (cnt 0) txt hash link beg end re e checkdir
16758 executables-checked string
16759 m n block-type block linkfile movefile ov)
16760 ;; Check the different regular expressions
16761 (while (setq e (pop re-list))
16762 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16764 (when (member m matchers)
16765 (goto-char (point-min))
16766 (while (re-search-forward re nil t)
16767 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16768 (not (get-text-property (match-beginning n)
16769 'org-protected))
16770 (or (not overlays)
16771 (not (eq (get-char-property (match-beginning n)
16772 'org-overlay-type)
16773 'org-latex-overlay))))
16774 (setq org-export-have-math t)
16775 (cond
16776 ((eq processing-type 'verbatim)
16777 ;; Leave the text verbatim, just protect it
16778 (add-text-properties (match-beginning n) (match-end n)
16779 '(org-protected t)))
16780 ((eq processing-type 'mathjax)
16781 ;; Prepare for MathJax processing
16782 (setq string (match-string n))
16783 (if (member m '("$" "$1"))
16784 (save-excursion
16785 (delete-region (match-beginning n) (match-end n))
16786 (goto-char (match-beginning n))
16789 '(org-protected t))))
16790 (add-text-properties (match-beginning n) (match-end n)
16791 '(org-protected t))))
16792 ((eq processing-type 'dvipng)
16793 ;; Process to an image
16794 (setq txt (match-string n)
16795 beg (match-beginning n) end (match-end n)
16796 cnt (1+ cnt))
16797 (let (print-length print-level) ; make sure full list is printed
16798 (setq hash (sha1 (prin1-to-string
16799 (list org-format-latex-header
16800 org-format-latex-header-extra
16801 org-export-latex-default-packages-alist
16802 org-export-latex-packages-alist
16803 org-format-latex-options
16804 forbuffer txt)))
16805 linkfile (format "%s_%s.png" prefix hash)
16806 movefile (format "%s_%s.png" absprefix hash)))
16807 (setq link (concat block "[[file:" linkfile "]]" block))
16808 (if msg (message msg cnt))
16809 (goto-char beg)
16810 (unless checkdir ; make sure the directory exists
16811 (setq checkdir t)
16812 (or (file-directory-p todir) (make-directory todir t)))
16814 (unless executables-checked
16815 (org-check-external-command
16816 "latex" "needed to convert LaTeX fragments to images")
16817 (org-check-external-command
16818 "dvipng" "needed to convert LaTeX fragments to images")
16819 (setq executables-checked t))
16821 (unless (file-exists-p movefile)
16822 (org-create-formula-image
16823 txt movefile opt forbuffer))
16824 (if overlays
16825 (progn
16826 (mapc (lambda (o)
16827 (if (eq (overlay-get o 'org-overlay-type)
16828 'org-latex-overlay)
16829 (delete-overlay o)))
16830 (overlays-in beg end))
16831 (setq ov (make-overlay beg end))
16832 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16833 (if (featurep 'xemacs)
16834 (progn
16835 (overlay-put ov 'invisible t)
16836 (overlay-put
16837 ov 'end-glyph
16838 (make-glyph (vector 'png :file movefile))))
16839 (overlay-put
16840 ov 'display
16841 (list 'image :type 'png :file movefile :ascent 'center)))
16842 (push ov org-latex-fragment-image-overlays)
16843 (goto-char end))
16844 (delete-region beg end)
16845 (insert (org-add-props link
16846 (list 'org-latex-src
16847 (replace-regexp-in-string
16849 'org-latex-src-embed-type
16850 (if block-type 'paragraph 'character))))))
16851 ((eq processing-type 'mathml)
16852 ;; Process to MathML
16853 (unless executables-checked
16854 (unless (save-match-data (org-format-latex-mathml-available-p))
16855 (error "LaTeX to MathML converter not configured"))
16856 (setq executables-checked t))
16857 (setq txt (match-string n)
16858 beg (match-beginning n) end (match-end n)
16859 cnt (1+ cnt))
16860 (if msg (message msg cnt))
16861 (goto-char beg)
16862 (delete-region beg end)
16863 (insert (org-format-latex-as-mathml
16864 txt block-type prefix dir)))
16865 (t
16866 (error "Unknown conversion type %s for latex fragments"
16867 processing-type)))))))))
16869 (defun org-create-math-formula (latex-frag &optional mathml-file)
16870 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16871 Use `org-latex-to-mathml-convert-command'. If the conversion is
16873 elements otherwise return nil. When MATHML-FILE is specified,
16874 write the results in to that file. When invoked as an
16875 interactive command, prompt for LATEX-FRAG, with initial value
16876 set to the current active region and echo the results for user
16877 inspection."
16878 (interactive (list (let ((frag (when (region-active-p)
16879 (buffer-substring-no-properties
16880 (region-beginning) (region-end)))))
16881 (read-string "LaTeX Fragment: " frag nil frag))))
16882 (unless latex-frag (error "Invalid latex-frag"))
16883 (let* ((tmp-in-file (file-relative-name
16884 (make-temp-name (expand-file-name "ltxmathml-in"))))
16885 (ignore (write-region latex-frag nil tmp-in-file))
16886 (tmp-out-file (file-relative-name
16887 (make-temp-name (expand-file-name "ltxmathml-out"))))
16888 (cmd (format-spec
16889 org-latex-to-mathml-convert-command
16890 `((?j . ,(shell-quote-argument
16891 (expand-file-name org-latex-to-mathml-jar-file)))
16892 (?I . ,(shell-quote-argument tmp-in-file))
16893 (?o . ,(shell-quote-argument tmp-out-file)))))
16894 mathml shell-command-output)
16895 (when (org-called-interactively-p 'any)
16896 (unless (org-format-latex-mathml-available-p)
16897 (error "LaTeX to MathML converter not configured")))
16898 (message "Running %s" cmd)
16899 (setq shell-command-output (shell-command-to-string cmd))
16900 (setq mathml
16901 (when (file-readable-p tmp-out-file)
16902 (with-current-buffer (find-file-noselect tmp-out-file t)
16903 (goto-char (point-min))
16904 (when (re-search-forward
16905 (concat
16906 (regexp-quote
16909 (regexp-quote "</math>")) nil t)
16910 (prog1 (match-string 0) (kill-buffer))))))
16911 (cond
16912 (mathml
16913 (setq mathml
16915 (when mathml-file
16916 (write-region mathml nil mathml-file))
16917 (when (org-called-interactively-p 'any)
16918 (message mathml)))
16919 ((message "LaTeX to MathML conversion failed")
16920 (message shell-command-output)))
16921 (delete-file tmp-in-file)
16922 (when (file-exists-p tmp-out-file)
16923 (delete-file tmp-out-file))
16924 mathml))
16926 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16927 prefix &optional dir)
16928 "Use `org-create-math-formula' but check local cache first."
16929 (let* ((absprefix (expand-file-name prefix dir))
16930 (print-length nil) (print-level nil)
16931 (formula-id (concat
16932 "formula-"
16933 (sha1
16934 (prin1-to-string
16935 (list latex-frag
16936 org-latex-to-mathml-convert-command)))))
16937 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16938 (formula-cache-dir (file-name-directory formula-cache)))
16940 (unless (file-directory-p formula-cache-dir)
16941 (make-directory formula-cache-dir t))
16943 (unless (file-exists-p formula-cache)
16944 (org-create-math-formula latex-frag formula-cache))
16946 (if (file-exists-p formula-cache)
16947 ;; Successful conversion. Return the link to MathML file.
16948 (org-add-props
16949 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16951 'org-latex-src-embed-type (if latex-frag-type
16952 'paragraph 'character)))
16953 ;; Failed conversion. Return the LaTeX fragment verbatim
16954 (add-text-properties
16955 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16956 latex-frag)))
16958 ;; This function borrows from Ganesh Swami's latex2png.el
16959 (defun org-create-formula-image (string tofile options buffer)
16960 "This calls dvipng."
16961 (require 'org-latex)
16962 (let* ((tmpdir (if (featurep 'xemacs)
16963 (temp-directory)
16964 temporary-file-directory))
16965 (texfilebase (make-temp-name
16966 (expand-file-name "orgtex" tmpdir)))
16967 (texfile (concat texfilebase ".tex"))
16968 (dvifile (concat texfilebase ".dvi"))
16969 (pngfile (concat texfilebase ".png"))
16970 (fnh (if (featurep 'xemacs)
16971 (font-height (get-face-font 'default))
16972 (face-attribute 'default :height nil)))
16973 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16974 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16975 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16976 "Black"))
16977 (bg (or (plist-get options (if buffer :background :html-background))
16978 "Transparent")))
16979 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16980 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16981 (with-temp-file texfile
16982 (insert (org-splice-latex-header
16983 org-format-latex-header
16984 org-export-latex-default-packages-alist
16985 org-export-latex-packages-alist t
16986 org-format-latex-header-extra))
16988 (require 'org-latex)
16989 (org-export-latex-fix-inputenc))
16990 (let ((dir default-directory))
16991 (condition-case nil
16992 (progn
16993 (cd tmpdir)
16994 (call-process "latex" nil nil nil texfile))
16995 (error nil))
16996 (cd dir))
16997 (if (not (file-exists-p dvifile))
16998 (progn (message "Failed to create dvi file from %s" texfile) nil)
16999 (condition-case nil
17000 (call-process "dvipng" nil nil nil
17001 "-fg" fg "-bg" bg
17002 "-D" dpi
17003 ;;"-x" scale "-y" scale
17004 "-T" "tight"
17005 "-o" pngfile
17006 dvifile)
17007 (error nil))
17008 (if (not (file-exists-p pngfile))
17009 (if org-format-latex-signal-error
17010 (error "Failed to create png file from %s" texfile)
17011 (message "Failed to create png file from %s" texfile)
17012 nil)
17013 ;; Use the requested file name and clean up
17014 (copy-file pngfile tofile 'replace)
17015 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17016 (delete-file (concat texfilebase e)))
17017 pngfile))))
17019 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17020 "Fill a LaTeX header template TPL.
17021 In the template, the following place holders will be recognized:
17024 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17026 [NO-PACKAGES] do not include PKG
17027 [EXTRA] the string EXTRA
17028 [NO-EXTRA] do not include EXTRA
17030 For backward compatibility, if both the positive and the negative place
17032 assumed to be present at the end of the template.
17033 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17034 EXTRA is a string.
17035 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17036 (let (rpl (end ""))
17038 (setq rpl (if (or (match-end 1) (not def-pkg))
17039 "" (org-latex-packages-to-string def-pkg snippets-p t))
17040 tpl (replace-match rpl t t tpl))
17041 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17044 (setq rpl (if (or (match-end 1) (not pkg))
17045 "" (org-latex-packages-to-string pkg snippets-p t))
17046 tpl (replace-match rpl t t tpl))
17047 (if pkg (setq end
17049 (org-latex-packages-to-string pkg snippets-p)))))
17052 (setq rpl (if (or (match-end 1) (not extra))
17054 tpl (replace-match rpl t t tpl))
17060 tpl)))
17062 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17064 (setq pkg (mapconcat (lambda(p)
17065 (cond
17066 ((stringp p) p)
17067 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17068 (format "%% Package %s omitted" (cadr p)))
17069 ((equal "" (car p))
17071 (t
17073 (car p) (cadr p)))))
17074 pkg
17078 (defun org-dvipng-color (attr)
17079 "Return an rgb color specification for dvipng."
17080 (apply 'format "rgb %s %s %s"
17081 (mapcar 'org-normalize-color
17082 (color-values (face-attribute 'default attr nil)))))
17084 (defun org-normalize-color (value)
17085 "Return string to be used as color value for an RGB component."
17086 (format "%g" (/ value 65535.0)))
17088 ;; Image display
17091 (defvar org-inline-image-overlays nil)
17092 (make-variable-buffer-local 'org-inline-image-overlays)
17094 (defun org-toggle-inline-images (&optional include-linked)
17095 "Toggle the display of inline images.
17096 INCLUDE-LINKED is passed to `org-display-inline-images'."
17097 (interactive "P")
17098 (if org-inline-image-overlays
17099 (progn
17100 (org-remove-inline-images)
17101 (message "Inline image display turned off"))
17102 (org-display-inline-images include-linked)
17103 (if org-inline-image-overlays
17104 (message "%d images displayed inline"
17105 (length org-inline-image-overlays))
17106 (message "No images to display inline"))))
17108 (defun org-display-inline-images (&optional include-linked refresh beg end)
17109 "Display inline images.
17110 Normally only links without a description part are inlined, because this
17111 is how it will work for export. When INCLUDE-LINKED is set, also links
17112 with a description part will be inlined. This can be nice for a quick
17113 look at those images, but it does not reflect what exported files will look
17114 like.
17115 When REFRESH is set, refresh existing images between BEG and END.
17116 This will create new image displays only if necessary.
17117 BEG and END default to the buffer boundaries."
17118 (interactive "P")
17119 (unless refresh
17120 (org-remove-inline-images)
17121 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17122 (save-excursion
17123 (save-restriction
17124 (widen)
17125 (setq beg (or beg (point-min)) end (or end (point-max)))
17126 (goto-char (point-min))
17128 (substring (org-image-file-name-regexp) 0 -2)
17130 old file ov img)
17131 (while (re-search-forward re end t)
17132 (setq old (get-char-property-and-overlay (match-beginning 1)
17133 'org-image-overlay))
17134 (setq file (expand-file-name
17135 (concat (or (match-string 3) "") (match-string 4))))
17136 (when (file-exists-p file)
17137 (if (and (car-safe old) refresh)
17138 (image-refresh (overlay-get (cdr old) 'display))
17139 (setq img (save-match-data (create-image file)))
17140 (when img
17141 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17142 (overlay-put ov 'display img)
17143 (overlay-put ov 'face 'default)
17144 (overlay-put ov 'org-image-overlay t)
17145 (overlay-put ov 'modification-hooks
17146 (list 'org-display-inline-modification-hook))
17147 (push ov org-inline-image-overlays)))))))))
17149 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17150 "Remove inline-display overlay if a corresponding region is modified."
17151 (let ((inhibit-modification-hooks t))
17152 (when (and ov after)
17153 (delete ov org-inline-image-overlays)
17154 (delete-overlay ov))))
17156 (defun org-remove-inline-images ()
17157 "Remove inline display of images."
17158 (interactive)
17159 (mapc 'delete-overlay org-inline-image-overlays)
17160 (setq org-inline-image-overlays nil))
17162 ;;;; Key bindings
17164 ;; Outline functions from `outline-mode-prefix-map'
17165 ;; that can be remapped in Org:
17166 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17167 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17168 (define-key org-mode-map [remap outline-forward-same-level]
17169 'org-forward-same-level)
17170 (define-key org-mode-map [remap outline-backward-same-level]
17171 'org-backward-same-level)
17172 (define-key org-mode-map [remap show-branches]
17173 'org-kill-note-or-show-branches)
17174 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17175 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17176 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17178 ;; Outline functions from `outline-mode-prefix-map'
17179 ;; that can not be remapped in Org:
17180 ;; - the column "key binding" shows whether the Outline function is still
17181 ;; available in Org mode on the same key that it has been bound to in
17182 ;; Outline mode:
17183 ;; - "overridden": key used for a different functionality in Org mode
17184 ;; - else: key still bound to the same Outline function in Org mode
17185 ;; | Outline function | key binding | Org replacement |
17186 ;; |------------------------------------+-------------+-----------------------|
17187 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17188 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17189 ;; | `show-children' | `C-c C-i' | visibility cycling |
17190 ;; | `hide-subtree' | overridden | visibility cycling |
17191 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17192 ;; | `hide-body' | overridden | no replacement |
17193 ;; | `show-all' | overridden | no replacement |
17194 ;; | `hide-entry' | overridden | visibility cycling |
17195 ;; | `show-entry' | overridden | no replacement |
17196 ;; | `hide-leaves' | overridden | no replacement |
17197 ;; | `hide-sublevels' | overridden | no replacement |
17198 ;; | `hide-other' | overridden | no replacement |
17199 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17200 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17202 ;; Make `C-c C-x' a prefix key
17203 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17205 ;; TAB key with modifiers
17206 (org-defkey org-mode-map "\C-i" 'org-cycle)
17207 (org-defkey org-mode-map [(tab)] 'org-cycle)
17208 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17209 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17211 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17212 ;; The following line is necessary under Suse GNU/Linux
17213 (unless (featurep 'xemacs)
17214 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17215 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17216 (define-key org-mode-map [backtab] 'org-shifttab)
17218 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17219 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17220 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17222 ;; Cursor keys with modifiers
17223 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17224 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17225 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17226 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17228 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17229 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17230 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17231 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17233 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17234 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17235 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17236 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17238 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17239 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17240 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17241 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17243 ;; Babel keys
17244 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17245 (mapc (lambda (pair)
17246 (define-key org-babel-map (car pair) (cdr pair)))
17247 org-babel-key-bindings)
17249 ;;; Extra keys for tty access.
17250 ;; We only set them when really needed because otherwise the
17251 ;; menus don't show the simple keys
17253 (when (or org-use-extra-keys
17254 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17255 (not window-system))
17256 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17257 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17258 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17259 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17260 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17261 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17262 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17263 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17264 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17265 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17266 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17267 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17268 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17269 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17270 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17271 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17272 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17273 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17274 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17275 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17276 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17277 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17278 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17279 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17280 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17281 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17282 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17283 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17285 ;; All the other keys
17287 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17288 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17289 (if (boundp 'narrow-map)
17290 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17291 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17292 (if (boundp 'narrow-map)
17293 (org-defkey narrow-map "b" 'org-narrow-to-block)
17294 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17295 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17296 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17297 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17298 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17299 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17300 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17301 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17302 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17303 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17304 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17305 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17306 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17307 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17308 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17309 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17310 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17312 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17313 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17314 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17315 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17316 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17317 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17318 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17319 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17320 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17321 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17322 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17323 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17324 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17325 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17326 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17327 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17328 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17329 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17330 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17331 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17333 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17334 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17335 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17336 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17337 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17338 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17339 (org-defkey org-mode-map "\C-c^" 'org-sort)
17340 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17341 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17342 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17343 (org-defkey org-mode-map "\C-m" 'org-return)
17344 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17345 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17346 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17347 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17348 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17349 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17350 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17351 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17352 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17353 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17354 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17355 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17356 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17357 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17358 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17359 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17360 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17361 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17362 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17363 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17364 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17365 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17367 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17368 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17369 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17370 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17372 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17373 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17374 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17375 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17376 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17377 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17378 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17379 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17380 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17381 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17383 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17384 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17385 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17386 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17387 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17388 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17389 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17391 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17392 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17393 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17394 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17395 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17397 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17399 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17401 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17402 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17404 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17407 (when (featurep 'xemacs)
17408 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17411 (defconst org-speed-commands-default
17412 '(
17413 ("Outline Navigation")
17414 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17415 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17416 ("f" . (org-speed-move-safe 'org-forward-same-level))
17417 ("b" . (org-speed-move-safe 'org-backward-same-level))
17418 ("u" . (org-speed-move-safe 'outline-up-heading))
17419 ("j" . org-goto)
17420 ("g" . (org-refile t))
17421 ("Outline Visibility")
17422 ("c" . org-cycle)
17423 ("C" . org-shifttab)
17424 (" " . org-display-outline-path)
17425 ("Outline Structure Editing")
17426 ("U" . org-shiftmetaup)
17427 ("D" . org-shiftmetadown)
17428 ("r" . org-metaright)
17429 ("l" . org-metaleft)
17430 ("R" . org-shiftmetaright)
17431 ("L" . org-shiftmetaleft)
17432 ("i" . (progn (forward-char 1) (call-interactively
17433 'org-insert-heading-respect-content)))
17434 ("^" . org-sort)
17435 ("w" . org-refile)
17436 ("a" . org-archive-subtree-default-with-confirmation)
17437 ("." . org-mark-subtree)
17438 ("Clock Commands")
17439 ("I" . org-clock-in)
17440 ("O" . org-clock-out)
17441 ("Meta Data Editing")
17442 ("t" . org-todo)
17443 ("0" . (org-priority ?\ ))
17444 ("1" . (org-priority ?A))
17445 ("2" . (org-priority ?B))
17446 ("3" . (org-priority ?C))
17447 (";" . org-set-tags-command)
17448 ("e" . org-set-effort)
17449 ("Agenda Views etc")
17450 ("v" . org-agenda)
17451 ("/" . org-sparse-tree)
17452 ("Misc")
17453 ("o" . org-open-at-point)
17454 ("?" . org-speed-command-help)
17455 ("<" . (org-agenda-set-restriction-lock 'subtree))
17456 (">" . (org-agenda-remove-restriction-lock))
17457 )
17458 "The default speed commands.")
17460 (defun org-print-speed-command (e)
17461 (if (> (length (car e)) 1)
17462 (progn
17464 (princ (car e))
17466 (princ (make-string (length (car e)) ?-))
17468 (princ (car e))
17469 (princ " ")
17470 (if (symbolp (cdr e))
17471 (princ (symbol-name (cdr e)))
17472 (prin1 (cdr e)))
17475 (defun org-speed-command-help ()
17476 "Show the available speed commands."
17477 (interactive)
17478 (if (not org-use-speed-commands)
17479 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17480 (with-output-to-temp-buffer "*Help*"
17482 (mapc 'org-print-speed-command org-speed-commands-user)
17485 (mapc 'org-print-speed-command org-speed-commands-default))
17486 (with-current-buffer "*Help*"
17487 (setq truncate-lines t))))
17489 (defun org-speed-move-safe (cmd)
17490 "Execute CMD, but make sure that the cursor always ends up in a headline.
17491 If not, return to the original position and throw an error."
17492 (interactive)
17493 (let ((pos (point)))
17494 (call-interactively cmd)
17495 (unless (and (bolp) (org-at-heading-p))
17496 (goto-char pos)
17497 (error "Boundary reached while executing %s" cmd))))
17499 (defvar org-self-insert-command-undo-counter 0)
17501 (defvar org-table-auto-blank-field) ; defined in org-table.el
17502 (defvar org-speed-command nil)
17504 (defun org-speed-command-default-hook (keys)
17505 "Hook for activating single-letter speed commands.
17506 `org-speed-commands-default' specifies a minimal command set.
17507 Use `org-speed-commands-user' for further customization."
17508 (when (or (and (bolp) (looking-at org-outline-regexp))
17509 (and (functionp org-use-speed-commands)
17510 (funcall org-use-speed-commands)))
17511 (cdr (assoc keys (append org-speed-commands-user
17512 org-speed-commands-default)))))
17514 (defun org-babel-speed-command-hook (keys)
17515 "Hook for activating single-letter code block commands."
17516 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17517 (cdr (assoc keys org-babel-key-bindings))))
17519 (defcustom org-speed-command-hook
17520 '(org-speed-command-default-hook org-babel-speed-command-hook)
17521 "Hook for activating speed commands at strategic locations.
17522 Hook functions are called in sequence until a valid handler is
17523 found.
17525 Each hook takes a single argument, a user-pressed command key
17526 which is also a `self-insert-command' from the global map.
17528 Within the hook, examine the cursor position and the command key
17529 and return nil or a valid handler as appropriate. Handler could
17530 be one of an interactive command, a function, or a form.
17532 Set `org-use-speed-commands' to non-nil value to enable this
17533 hook. The default setting is `org-speed-command-default-hook'."
17534 :group 'org-structure
17535 :type 'hook)
17537 (defun org-self-insert-command (N)
17538 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17539 If the cursor is in a table looking at whitespace, the whitespace is
17540 overwritten, and the table is not marked as requiring realignment."
17541 (interactive "p")
17542 (org-check-before-invisible-edit 'insert)
17543 (cond
17544 ((and org-use-speed-commands
17545 (setq org-speed-command
17546 (run-hook-with-args-until-success
17547 'org-speed-command-hook (this-command-keys))))
17548 (cond
17549 ((commandp org-speed-command)
17550 (setq this-command org-speed-command)
17551 (call-interactively org-speed-command))
17552 ((functionp org-speed-command)
17553 (funcall org-speed-command))
17554 ((and org-speed-command (listp org-speed-command))
17555 (eval org-speed-command))
17556 (t (let (org-use-speed-commands)
17557 (call-interactively 'org-self-insert-command)))))
17558 ((and
17559 (org-table-p)
17560 (progn
17561 ;; check if we blank the field, and if that triggers align
17562 (and (featurep 'org-table) org-table-auto-blank-field
17563 (member last-command
17564 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17566 ;; got extra space, this field does not determine column width
17567 (let (org-table-may-need-update) (org-table-blank-field))
17568 ;; no extra space, this field may determine column width
17569 (org-table-blank-field)))
17570 t)
17571 (eq N 1)
17573 (let (org-table-may-need-update)
17574 (goto-char (1- (match-end 0)))
17575 (delete-char -1)
17576 (goto-char (match-beginning 0))
17577 (self-insert-command N)))
17578 (t
17579 (setq org-table-may-need-update t)
17580 (self-insert-command N)
17581 (org-fix-tags-on-the-fly)
17582 (if org-self-insert-cluster-for-undo
17583 (if (not (eq last-command 'org-self-insert-command))
17584 (setq org-self-insert-command-undo-counter 1)
17585 (if (>= org-self-insert-command-undo-counter 20)
17586 (setq org-self-insert-command-undo-counter 1)
17587 (and (> org-self-insert-command-undo-counter 0)
17588 buffer-undo-list (listp buffer-undo-list)
17589 (not (cadr buffer-undo-list)) ; remove nil entry
17590 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17591 (setq org-self-insert-command-undo-counter
17592 (1+ org-self-insert-command-undo-counter))))))))
17594 (defun org-check-before-invisible-edit (kind)
17595 "Check is editing if kind KIND would be dangerous with invisible text around.
17596 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17597 ;; First, try to get out of here as quickly as possible, to reduce overhead
17598 (if (and org-catch-invisible-edits
17599 (or (not (boundp 'visible-mode)) (not visible-mode))
17600 (or (get-char-property (point) 'invisible)
17601 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17602 ;; OK, we need to take a closer look
17603 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17604 (invisible-before-point (if (bobp) nil (get-char-property
17605 (1- (point)) 'invisible)))
17606 (border-and-ok-direction
17607 (or
17608 ;; Check if we are acting predictably before invisible text
17609 (and invisible-at-point (not invisible-before-point)
17610 (memq kind '(insert delete-backward)))
17611 ;; Check if we are acting predictably after invisible text
17612 ;; This works not well, and I have turned it off. It seems
17613 ;; better to always show and stop after invisible text.
17614 ;; (and (not invisible-at-point) invisible-before-point
17615 ;; (memq kind '(insert delete)))
17616 )))
17618 (when (or (memq invisible-at-point '(outline org-hide-block))
17619 (memq invisible-before-point '(outline org-hide-block)))
17620 (if (eq org-catch-invisible-edits 'error)
17621 (error "Editing in invisible areas is prohibited - make visible first"))
17622 ;; Make the area visible
17623 (save-excursion
17624 (if invisible-before-point
17625 (goto-char (previous-single-char-property-change
17626 (point) 'invisible)))
17627 (org-cycle))
17628 (cond
17629 ((eq org-catch-invisible-edits 'show)
17630 ;; That's it, we do the edit after showing
17631 (message
17632 "Unfolding invisible region around point before editing")
17633 (sit-for 1))
17634 ((and (eq org-catch-invisible-edits 'smart)
17635 border-and-ok-direction)
17636 (message "Unfolding invisible region around point before editing"))
17637 (t
17638 ;; Don't do the edit, make the user repeat it in full visibility
17639 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17641 (defun org-fix-tags-on-the-fly ()
17642 (when (and (equal (char-after (point-at-bol)) ?*)
17643 (org-at-heading-p))
17644 (org-align-tags-here org-tags-column)))
17646 (defun org-delete-backward-char (N)
17647 "Like `delete-backward-char', insert whitespace at field end in tables.
17648 When deleting backwards, in tables this function will insert whitespace in
17650 still be marked for re-alignment if the field did fill the entire column,
17651 because, in this case the deletion might narrow the column."
17652 (interactive "p")
17653 (org-check-before-invisible-edit 'delete-backward)
17654 (if (and (org-table-p)
17655 (eq N 1)
17656 (string-match "|" (buffer-substring (point-at-bol) (point)))
17657 (looking-at ".*?|"))
17658 (let ((pos (point))
17660 (c org-table-may-need-update))
17661 (backward-delete-char N)
17662 (if (not overwrite-mode)
17663 (progn
17664 (skip-chars-forward "^|")
17665 (insert " ")
17666 (goto-char (1- pos))))
17667 ;; noalign: if there were two spaces at the end, this field
17668 ;; does not determine the width of the column.
17669 (if noalign (setq org-table-may-need-update c)))
17670 (backward-delete-char N)
17671 (org-fix-tags-on-the-fly)))
17673 (defun org-delete-char (N)
17674 "Like `delete-char', but insert whitespace at field end in tables.
17675 When deleting characters, in tables this function will insert whitespace in
17677 still be marked for re-alignment if the field did fill the entire column,
17678 because, in this case the deletion might narrow the column."
17679 (interactive "p")
17680 (org-check-before-invisible-edit 'delete)
17681 (if (and (org-table-p)
17682 (not (bolp))
17683 (not (= (char-after) ?|))
17684 (eq N 1))
17685 (if (looking-at ".*?|")
17686 (let ((pos (point))
17688 (c org-table-may-need-update))
17689 (replace-match (concat
17690 (substring (match-string 0) 1 -1)
17691 " |"))
17692 (goto-char pos)
17693 ;; noalign: if there were two spaces at the end, this field
17694 ;; does not determine the width of the column.
17695 (if noalign (setq org-table-may-need-update c)))
17696 (delete-char N))
17697 (delete-char N)
17698 (org-fix-tags-on-the-fly)))
17700 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17701 (put 'org-self-insert-command 'delete-selection t)
17702 (put 'orgtbl-self-insert-command 'delete-selection t)
17703 (put 'org-delete-char 'delete-selection 'supersede)
17704 (put 'org-delete-backward-char 'delete-selection 'supersede)
17705 (put 'org-yank 'delete-selection 'yank)
17707 ;; Make `flyspell-mode' delay after some commands
17708 (put 'org-self-insert-command 'flyspell-delayed t)
17709 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17710 (put 'org-delete-char 'flyspell-delayed t)
17711 (put 'org-delete-backward-char 'flyspell-delayed t)
17713 ;; Make pabbrev-mode expand after org-mode commands
17714 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17715 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17717 ;; How to do this: Measure non-white length of current string
17718 ;; If equal to column width, we should realign.
17720 (defun org-remap (map &rest commands)
17721 "In MAP, remap the functions given in COMMANDS.
17722 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17723 (let (new old)
17724 (while commands
17725 (setq old (pop commands) new (pop commands))
17726 (if (fboundp 'command-remapping)
17727 (org-defkey map (vector 'remap old) new)
17728 (substitute-key-definition old new map global-map)))))
17730 (when (eq org-enable-table-editor 'optimized)
17731 ;; If the user wants maximum table support, we need to hijack
17732 ;; some standard editing functions
17733 (org-remap org-mode-map
17734 'self-insert-command 'org-self-insert-command
17735 'delete-char 'org-delete-char
17736 'delete-backward-char 'org-delete-backward-char)
17737 (org-defkey org-mode-map "|" 'org-force-self-insert))
17739 (defvar org-ctrl-c-ctrl-c-hook nil
17740 "Hook for functions attaching themselves to `C-c C-c'.
17742 This can be used to add additional functionality to the C-c C-c
17743 key which executes context-dependent commands. This hook is run
17744 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17745 run after the last test.
17747 Each function will be called with no arguments. The function
17748 must check if the context is appropriate for it to act. If yes,
17749 it should do its thing and then return a non-nil value. If the
17750 context is wrong, just do nothing and return nil.")
17752 (defvar org-ctrl-c-ctrl-c-final-hook nil
17753 "Hook for functions attaching themselves to `C-c C-c'.
17755 This can be used to add additional functionality to the C-c C-c
17756 key which executes context-dependent commands. This hook is run
17757 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17758 before the first test.
17760 Each function will be called with no arguments. The function
17761 must check if the context is appropriate for it to act. If yes,
17762 it should do its thing and then return a non-nil value. If the
17763 context is wrong, just do nothing and return nil.")
17765 (defvar org-tab-first-hook nil
17766 "Hook for functions to attach themselves to TAB.
17767 See `org-ctrl-c-ctrl-c-hook' for more information.
17768 This hook runs as the first action when TAB is pressed, even before
17769 `org-cycle' messes around with the `outline-regexp' to cater for
17770 inline tasks and plain list item folding.
17771 If any function in this hook returns t, any other actions that
17772 would have been caused by TAB (such as table field motion or visibility
17773 cycling) will not occur.")
17775 (defvar org-tab-after-check-for-table-hook nil
17776 "Hook for functions to attach themselves to TAB.
17777 See `org-ctrl-c-ctrl-c-hook' for more information.
17778 This hook runs after it has been established that the cursor is not in a
17779 table, but before checking if the cursor is in a headline or if global cycling
17780 should be done.
17781 If any function in this hook returns t, not other actions like visibility
17782 cycling will be done.")
17784 (defvar org-tab-after-check-for-cycling-hook nil
17785 "Hook for functions to attach themselves to TAB.
17786 See `org-ctrl-c-ctrl-c-hook' for more information.
17787 This hook runs after it has been established that not table field motion and
17788 not visibility should be done because of current context. This is probably
17789 the place where a package like yasnippets can hook in.")
17791 (defvar org-tab-before-tab-emulation-hook nil
17792 "Hook for functions to attach themselves to TAB.
17793 See `org-ctrl-c-ctrl-c-hook' for more information.
17794 This hook runs after every other options for TAB have been exhausted, but
17797 (defvar org-metaleft-hook nil
17798 "Hook for functions attaching themselves to `M-left'.
17799 See `org-ctrl-c-ctrl-c-hook' for more information.")
17800 (defvar org-metaright-hook nil
17801 "Hook for functions attaching themselves to `M-right'.
17802 See `org-ctrl-c-ctrl-c-hook' for more information.")
17803 (defvar org-metaup-hook nil
17804 "Hook for functions attaching themselves to `M-up'.
17805 See `org-ctrl-c-ctrl-c-hook' for more information.")
17806 (defvar org-metadown-hook nil
17807 "Hook for functions attaching themselves to `M-down'.
17808 See `org-ctrl-c-ctrl-c-hook' for more information.")
17809 (defvar org-shiftmetaleft-hook nil
17810 "Hook for functions attaching themselves to `M-S-left'.
17811 See `org-ctrl-c-ctrl-c-hook' for more information.")
17812 (defvar org-shiftmetaright-hook nil
17813 "Hook for functions attaching themselves to `M-S-right'.
17814 See `org-ctrl-c-ctrl-c-hook' for more information.")
17815 (defvar org-shiftmetaup-hook nil
17816 "Hook for functions attaching themselves to `M-S-up'.
17817 See `org-ctrl-c-ctrl-c-hook' for more information.")
17818 (defvar org-shiftmetadown-hook nil
17819 "Hook for functions attaching themselves to `M-S-down'.
17820 See `org-ctrl-c-ctrl-c-hook' for more information.")
17821 (defvar org-metareturn-hook nil
17822 "Hook for functions attaching themselves to `M-RET'.
17823 See `org-ctrl-c-ctrl-c-hook' for more information.")
17824 (defvar org-shiftup-hook nil
17825 "Hook for functions attaching themselves to `S-up'.
17826 See `org-ctrl-c-ctrl-c-hook' for more information.")
17827 (defvar org-shiftup-final-hook nil
17828 "Hook for functions attaching themselves to `S-up'.
17829 This one runs after all other options except shift-select have been excluded.
17830 See `org-ctrl-c-ctrl-c-hook' for more information.")
17831 (defvar org-shiftdown-hook nil
17832 "Hook for functions attaching themselves to `S-down'.
17833 See `org-ctrl-c-ctrl-c-hook' for more information.")
17834 (defvar org-shiftdown-final-hook nil
17835 "Hook for functions attaching themselves to `S-down'.
17836 This one runs after all other options except shift-select have been excluded.
17837 See `org-ctrl-c-ctrl-c-hook' for more information.")
17838 (defvar org-shiftleft-hook nil
17839 "Hook for functions attaching themselves to `S-left'.
17840 See `org-ctrl-c-ctrl-c-hook' for more information.")
17841 (defvar org-shiftleft-final-hook nil
17842 "Hook for functions attaching themselves to `S-left'.
17843 This one runs after all other options except shift-select have been excluded.
17844 See `org-ctrl-c-ctrl-c-hook' for more information.")
17845 (defvar org-shiftright-hook nil
17846 "Hook for functions attaching themselves to `S-right'.
17847 See `org-ctrl-c-ctrl-c-hook' for more information.")
17848 (defvar org-shiftright-final-hook nil
17849 "Hook for functions attaching themselves to `S-right'.
17850 This one runs after all other options except shift-select have been excluded.
17851 See `org-ctrl-c-ctrl-c-hook' for more information.")
17853 (defun org-modifier-cursor-error ()
17854 "Throw an error, a modified cursor command was applied in wrong context."
17855 (error "This command is active in special context like tables, headlines or items"))
17857 (defun org-shiftselect-error ()
17858 "Throw an error because Shift-Cursor command was applied in wrong context."
17859 (if (and (boundp 'shift-select-mode) shift-select-mode)
17860 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17861 (error "This command works only in special context like headlines or timestamps")))
17863 (defun org-call-for-shift-select (cmd)
17864 (let ((this-command-keys-shift-translated t))
17865 (call-interactively cmd)))
17867 (defun org-shifttab (&optional arg)
17868 "Global visibility cycling or move to previous table field.
17869 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17870 on context.
17871 See the individual commands for more information."
17872 (interactive "P")
17873 (cond
17874 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17875 ((integerp arg)
17876 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17877 (message "Content view to level: %d" arg)
17878 (org-content (prefix-numeric-value arg2))
17879 (setq org-cycle-global-status 'overview)))
17880 (t (call-interactively 'org-global-cycle))))
17882 (defun org-shiftmetaleft ()
17883 "Promote subtree or delete table column.
17884 Calls `org-promote-subtree', `org-outdent-item',
17885 or `org-table-delete-column', depending on context.
17886 See the individual commands for more information."
17887 (interactive)
17888 (cond
17889 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17890 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17891 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17892 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17893 (t (org-modifier-cursor-error))))
17895 (defun org-shiftmetaright ()
17896 "Demote subtree or insert table column.
17897 Calls `org-demote-subtree', `org-indent-item',
17898 or `org-table-insert-column', depending on context.
17899 See the individual commands for more information."
17900 (interactive)
17901 (cond
17902 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17903 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17904 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17905 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17906 (t (org-modifier-cursor-error))))
17908 (defun org-shiftmetaup (&optional arg)
17909 "Move subtree up or kill table row.
17910 Calls `org-move-subtree-up' or `org-table-kill-row' or
17911 `org-move-item-up' depending on context. See the individual commands
17912 for more information."
17913 (interactive "P")
17914 (cond
17915 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17916 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17917 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17918 ((org-at-item-p) (call-interactively 'org-move-item-up))
17919 (t (org-modifier-cursor-error))))
17921 (defun org-shiftmetadown (&optional arg)
17922 "Move subtree down or insert table row.
17923 Calls `org-move-subtree-down' or `org-table-insert-row' or
17924 `org-move-item-down', depending on context. See the individual
17925 commands for more information."
17926 (interactive "P")
17927 (cond
17928 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17929 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17930 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17931 ((org-at-item-p) (call-interactively 'org-move-item-down))
17932 (t (org-modifier-cursor-error))))
17934 (defsubst org-hidden-tree-error ()
17935 (error
17936 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17938 (defun org-metaleft (&optional arg)
17939 "Promote heading or move table column to left.
17940 Calls `org-do-promote' or `org-table-move-column', depending on context.
17941 With no specific context, calls the Emacs default `backward-word'.
17942 See the individual commands for more information."
17943 (interactive "P")
17944 (cond
17945 ((run-hook-with-args-until-success 'org-metaleft-hook))
17946 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17947 ((org-with-limited-levels
17948 (or (org-at-heading-p)
17949 (and (org-region-active-p)
17950 (save-excursion
17951 (goto-char (region-beginning))
17952 (org-at-heading-p)))))
17953 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17954 (call-interactively 'org-do-promote))
17955 ;; At an inline task.
17956 ((org-at-heading-p)
17957 (call-interactively 'org-inlinetask-promote))
17958 ((or (org-at-item-p)
17959 (and (org-region-active-p)
17960 (save-excursion
17961 (goto-char (region-beginning))
17962 (org-at-item-p))))
17963 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17964 (call-interactively 'org-outdent-item))
17965 (t (call-interactively 'backward-word))))
17967 (defun org-metaright (&optional arg)
17968 "Demote subtree or move table column to right.
17969 Calls `org-do-demote' or `org-table-move-column', depending on context.
17970 With no specific context, calls the Emacs default `forward-word'.
17971 See the individual commands for more information."
17972 (interactive "P")
17973 (cond
17974 ((run-hook-with-args-until-success 'org-metaright-hook))
17975 ((org-at-table-p) (call-interactively 'org-table-move-column))
17976 ((org-with-limited-levels
17977 (or (org-at-heading-p)
17978 (and (org-region-active-p)
17979 (save-excursion
17980 (goto-char (region-beginning))
17981 (org-at-heading-p)))))
17982 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17983 (call-interactively 'org-do-demote))
17984 ;; At an inline task.
17985 ((org-at-heading-p)
17986 (call-interactively 'org-inlinetask-demote))
17987 ((or (org-at-item-p)
17988 (and (org-region-active-p)
17989 (save-excursion
17990 (goto-char (region-beginning))
17991 (org-at-item-p))))
17992 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17993 (call-interactively 'org-indent-item))
17994 (t (call-interactively 'forward-word))))
17996 (defun org-check-for-hidden (what)
17997 "Check if there are hidden headlines/items in the current visual line.
17998 WHAT can be either `headlines' or `items'. If the current line is
17999 an outline or item heading and it has a folded subtree below it,
18000 this function returns t, nil otherwise."
18001 (let ((re (cond
18002 ((eq what 'headlines) org-outline-regexp-bol)
18003 ((eq what 'items) (org-item-beginning-re))
18004 (t (error "This should not happen"))))
18005 beg end)
18006 (save-excursion
18007 (catch 'exit
18008 (unless (org-region-active-p)
18009 (setq beg (point-at-bol))
18010 (beginning-of-line 2)
18011 (while (and (not (eobp)) ;; this is like `next-line'
18012 (get-char-property (1- (point)) 'invisible))
18013 (beginning-of-line 2))
18014 (setq end (point))
18015 (goto-char beg)
18016 (goto-char (point-at-eol))
18017 (setq end (max end (point)))
18018 (while (re-search-forward re end t)
18019 (if (get-char-property (match-beginning 0) 'invisible)
18020 (throw 'exit t))))
18021 nil))))
18023 (defun org-metaup (&optional arg)
18024 "Move subtree up or move table row up.
18025 Calls `org-move-subtree-up' or `org-table-move-row' or
18026 `org-move-item-up', depending on context. See the individual commands
18027 for more information."
18028 (interactive "P")
18029 (cond
18030 ((run-hook-with-args-until-success 'org-metaup-hook))
18031 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18032 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18033 ((org-at-item-p) (call-interactively 'org-move-item-up))
18034 (t (transpose-lines 1) (beginning-of-line -1))))
18036 (defun org-metadown (&optional arg)
18037 "Move subtree down or move table row down.
18038 Calls `org-move-subtree-down' or `org-table-move-row' or
18039 `org-move-item-down', depending on context. See the individual
18040 commands for more information."
18041 (interactive "P")
18042 (cond
18043 ((run-hook-with-args-until-success 'org-metadown-hook))
18044 ((org-at-table-p) (call-interactively 'org-table-move-row))
18045 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18046 ((org-at-item-p) (call-interactively 'org-move-item-down))
18047 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18049 (defun org-shiftup (&optional arg)
18050 "Increase item in timestamp or increase priority of current headline.
18051 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18052 depending on context. See the individual commands for more information."
18053 (interactive "P")
18054 (cond
18055 ((run-hook-with-args-until-success 'org-shiftup-hook))
18056 ((and org-support-shift-select (org-region-active-p))
18057 (org-call-for-shift-select 'previous-line))
18058 ((org-at-timestamp-p t)
18059 (call-interactively (if org-edit-timestamp-down-means-later
18060 'org-timestamp-down 'org-timestamp-up)))
18061 ((and (not (eq org-support-shift-select 'always))
18062 org-enable-priority-commands
18063 (org-at-heading-p))
18064 (call-interactively 'org-priority-up))
18065 ((and (not org-support-shift-select) (org-at-item-p))
18066 (call-interactively 'org-previous-item))
18067 ((org-clocktable-try-shift 'up arg))
18068 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18069 (org-support-shift-select
18070 (org-call-for-shift-select 'previous-line))
18071 (t (org-shiftselect-error))))
18073 (defun org-shiftdown (&optional arg)
18074 "Decrease item in timestamp or decrease priority of current headline.
18075 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18076 depending on context. See the individual commands for more information."
18077 (interactive "P")
18078 (cond
18079 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18080 ((and org-support-shift-select (org-region-active-p))
18081 (org-call-for-shift-select 'next-line))
18082 ((org-at-timestamp-p t)
18083 (call-interactively (if org-edit-timestamp-down-means-later
18084 'org-timestamp-up 'org-timestamp-down)))
18085 ((and (not (eq org-support-shift-select 'always))
18086 org-enable-priority-commands
18087 (org-at-heading-p))
18088 (call-interactively 'org-priority-down))
18089 ((and (not org-support-shift-select) (org-at-item-p))
18090 (call-interactively 'org-next-item))
18091 ((org-clocktable-try-shift 'down arg))
18092 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18093 (org-support-shift-select
18094 (org-call-for-shift-select 'next-line))
18095 (t (org-shiftselect-error))))
18097 (defun org-shiftright (&optional arg)
18098 "Cycle the thing at point or in the current line, depending on context.
18099 Depending on context, this does one of the following:
18101 - switch a timestamp at point one day into the future
18102 - on a headline, switch to the next TODO keyword.
18103 - on an item, switch entire list to the next bullet type
18104 - on a property line, switch to the next allowed value
18105 - on a clocktable definition line, move time block into the future"
18106 (interactive "P")
18107 (cond
18108 ((run-hook-with-args-until-success 'org-shiftright-hook))
18109 ((and org-support-shift-select (org-region-active-p))
18110 (org-call-for-shift-select 'forward-char))
18111 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18112 ((and (not (eq org-support-shift-select 'always))
18113 (org-at-heading-p))
18114 (let ((org-inhibit-logging
18115 (not org-treat-S-cursor-todo-selection-as-state-change))
18116 (org-inhibit-blocking
18117 (not org-treat-S-cursor-todo-selection-as-state-change)))
18118 (org-call-with-arg 'org-todo 'right)))
18119 ((or (and org-support-shift-select
18120 (not (eq org-support-shift-select 'always))
18121 (org-at-item-bullet-p))
18122 (and (not org-support-shift-select) (org-at-item-p)))
18123 (org-call-with-arg 'org-cycle-list-bullet nil))
18124 ((and (not (eq org-support-shift-select 'always))
18125 (org-at-property-p))
18126 (call-interactively 'org-property-next-allowed-value))
18127 ((org-clocktable-try-shift 'right arg))
18128 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18129 (org-support-shift-select
18130 (org-call-for-shift-select 'forward-char))
18131 (t (org-shiftselect-error))))
18133 (defun org-shiftleft (&optional arg)
18134 "Cycle the thing at point or in the current line, depending on context.
18135 Depending on context, this does one of the following:
18137 - switch a timestamp at point one day into the past
18138 - on a headline, switch to the previous TODO keyword.
18139 - on an item, switch entire list to the previous bullet type
18140 - on a property line, switch to the previous allowed value
18141 - on a clocktable definition line, move time block into the past"
18142 (interactive "P")
18143 (cond
18144 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18145 ((and org-support-shift-select (org-region-active-p))
18146 (org-call-for-shift-select 'backward-char))
18147 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18148 ((and (not (eq org-support-shift-select 'always))
18149 (org-at-heading-p))
18150 (let ((org-inhibit-logging
18151 (not org-treat-S-cursor-todo-selection-as-state-change))
18152 (org-inhibit-blocking
18153 (not org-treat-S-cursor-todo-selection-as-state-change)))
18154 (org-call-with-arg 'org-todo 'left)))
18155 ((or (and org-support-shift-select
18156 (not (eq org-support-shift-select 'always))
18157 (org-at-item-bullet-p))
18158 (and (not org-support-shift-select) (org-at-item-p)))
18159 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18160 ((and (not (eq org-support-shift-select 'always))
18161 (org-at-property-p))
18162 (call-interactively 'org-property-previous-allowed-value))
18163 ((org-clocktable-try-shift 'left arg))
18164 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18165 (org-support-shift-select
18166 (org-call-for-shift-select 'backward-char))
18167 (t (org-shiftselect-error))))
18169 (defun org-shiftcontrolright ()
18170 "Switch to next TODO set."
18171 (interactive)
18172 (cond
18173 ((and org-support-shift-select (org-region-active-p))
18174 (org-call-for-shift-select 'forward-word))
18175 ((and (not (eq org-support-shift-select 'always))
18176 (org-at-heading-p))
18177 (org-call-with-arg 'org-todo 'nextset))
18178 (org-support-shift-select
18179 (org-call-for-shift-select 'forward-word))
18180 (t (org-shiftselect-error))))
18182 (defun org-shiftcontrolleft ()
18183 "Switch to previous TODO set."
18184 (interactive)
18185 (cond
18186 ((and org-support-shift-select (org-region-active-p))
18187 (org-call-for-shift-select 'backward-word))
18188 ((and (not (eq org-support-shift-select 'always))
18189 (org-at-heading-p))
18190 (org-call-with-arg 'org-todo 'previousset))
18191 (org-support-shift-select
18192 (org-call-for-shift-select 'backward-word))
18193 (t (org-shiftselect-error))))
18195 (defun org-shiftcontrolup ()
18196 "Change timestamps synchronously up in CLOCK log lines."
18197 (interactive)
18198 (cond ((and (not org-support-shift-select)
18199 (org-at-clock-log-p)
18200 (org-at-timestamp-p t))
18201 (org-clock-timestamps-up))
18202 (t (org-shiftselect-error))))
18204 (defun org-shiftcontroldown ()
18205 "Change timestamps synchronously down in CLOCK log lines."
18206 (interactive)
18207 (cond ((and (not org-support-shift-select)
18208 (org-at-clock-log-p)
18209 (org-at-timestamp-p t))
18210 (org-clock-timestamps-down))
18211 (t (org-shiftselect-error))))
18213 (defun org-ctrl-c-ret ()
18214 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18215 (interactive)
18216 (cond
18217 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18218 (t (call-interactively 'org-insert-heading))))
18220 (defun org-find-visible ()
18221 (let ((s (point)))
18222 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18223 (get-char-property s 'invisible)))
18224 s))
18225 (defun org-find-invisible ()
18226 (let ((s (point)))
18227 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18228 (not (get-char-property s 'invisible))))
18229 s))
18231 (defun org-copy-visible (beg end)
18232 "Copy the visible parts of the region."
18233 (interactive "r")
18234 (let (snippets s)
18235 (save-excursion
18236 (save-restriction
18237 (narrow-to-region beg end)
18238 (setq s (goto-char (point-min)))
18239 (while (not (= (point) (point-max)))
18240 (goto-char (org-find-invisible))
18241 (push (buffer-substring s (point)) snippets)
18242 (setq s (goto-char (org-find-visible))))))
18243 (kill-new (apply 'concat (nreverse snippets)))))
18245 (defun org-copy-special ()
18246 "Copy region in table or copy current subtree.
18247 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18248 See the individual commands for more information."
18249 (interactive)
18250 (call-interactively
18251 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18253 (defun org-cut-special ()
18254 "Cut region in table or cut current subtree.
18255 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18256 See the individual commands for more information."
18257 (interactive)
18258 (call-interactively
18259 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18261 (defun org-paste-special (arg)
18262 "Paste rectangular region into table, or past subtree relative to level.
18263 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18264 See the individual commands for more information."
18265 (interactive "P")
18266 (if (org-at-table-p)
18267 (org-table-paste-rectangle)
18268 (org-paste-subtree arg)))
18270 (defun org-edit-special (&optional arg)
18271 "Call a special editor for the stuff at point.
18272 When at a table, call the formula editor with `org-table-edit-formulas'.
18273 When at the first line of an src example, call `org-edit-src-code'.
18274 When in an #+include line, visit the include file. Otherwise call
18275 `ffap' to visit the file at point."
18276 (interactive)
18277 ;; possibly prep session before editing source
18278 (when arg
18279 (let* ((info (org-babel-get-src-block-info))
18280 (lang (nth 0 info))
18281 (params (nth 2 info))
18282 (session (cdr (assoc :session params))))
18283 (when (and info session) ;; we are in a source-code block with a session
18284 (funcall
18285 (intern (concat "org-babel-prep-session:" lang)) session params))))
18286 (cond ;; proceed with `org-edit-special'
18287 ((save-excursion
18288 (beginning-of-line 1)
18289 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18290 (find-file (org-trim (match-string 1))))
18291 ((org-edit-src-code))
18292 ((org-edit-fixed-width-region))
18293 ((org-at-table.el-p)
18294 (org-edit-src-code))
18295 ((or (org-at-table-p)
18296 (save-excursion
18297 (beginning-of-line 1)
18299 (call-interactively 'org-table-edit-formulas))
18300 (t (call-interactively 'ffap))))
18302 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18303 (defun org-ctrl-c-ctrl-c (&optional arg)
18304 "Set tags in headline, or update according to changed information at point.
18306 This command does many different things, depending on context:
18308 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18309 this is what we do.
18311 - If the cursor is on a statistics cookie, update it.
18313 - If the cursor is in a headline, prompt for tags and insert them
18314 into the current line, aligned to `org-tags-column'. When called
18315 with prefix arg, realign all tags in the current buffer.
18317 - If the cursor is in one of the special #+KEYWORD lines, this
18318 triggers scanning the buffer for these lines and updating the
18319 information.
18321 - If the cursor is inside a table, realign the table. This command
18322 works even if the automatic table editor has been turned off.
18324 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18325 the entire table.
18327 - If the cursor is at a footnote reference or definition, jump to
18328 the corresponding definition or references, respectively.
18330 - If the cursor is a the beginning of a dynamic block, update it.
18332 - If the current buffer is a capture buffer, close note and file it.
18334 - If the cursor is on a <<<target>>>, update radio targets and
18335 corresponding links in this buffer.
18337 - If the cursor is on a numbered item in a plain list, renumber the
18338 ordered list.
18340 - If the cursor is on a checkbox, toggle it.
18342 - If the cursor is on a code block, evaluate it. The variable
18343 `org-confirm-babel-evaluate' can be used to control prompting
18344 before code block evaluation, by default every code block
18345 evaluation requires confirmation. Code block evaluation can be
18346 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18347 (interactive "P")
18348 (let ((org-enable-table-editor t))
18349 (cond
18350 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18351 org-occur-highlights
18352 org-latex-fragment-image-overlays)
18353 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18354 (org-remove-occur-highlights)
18355 (org-remove-latex-fragment-image-overlays)
18356 (message "Temporary highlights/overlays removed from current buffer"))
18357 ((and (local-variable-p 'org-finish-function (current-buffer))
18358 (fboundp org-finish-function))
18359 (funcall org-finish-function))
18360 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18361 ((org-in-regexp org-ts-regexp-both)
18362 (org-timestamp-change 0 'day))
18363 ((or (looking-at org-property-start-re)
18364 (org-at-property-p))
18365 (call-interactively 'org-property-action))
18366 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18368 (or (org-at-heading-p) (org-at-item-p)))
18369 (call-interactively 'org-update-statistics-cookies))
18370 ((org-at-heading-p) (call-interactively 'org-set-tags))
18371 ((org-at-table.el-p)
18372 (message "Use C-c ' to edit table.el tables"))
18373 ((org-at-table-p)
18374 (org-table-maybe-eval-formula)
18375 (if arg
18376 (call-interactively 'org-table-recalculate)
18377 (org-table-maybe-recalculate-line))
18378 (call-interactively 'org-table-align)
18379 (orgtbl-send-table 'maybe))
18380 ((or (org-footnote-at-reference-p)
18381 (org-footnote-at-definition-p))
18382 (call-interactively 'org-footnote-action))
18383 ((org-at-item-checkbox-p)
18384 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18385 ;; list only if at top item.
18386 (let* ((cbox (match-string 1))
18387 (struct (org-list-struct))
18388 (old-struct (copy-tree struct))
18389 (parents (org-list-parents-alist struct))
18390 (orderedp (org-entry-get nil "ORDERED"))
18391 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18392 block-item)
18393 ;; Use a light version of `org-toggle-checkbox' to avoid
18394 ;; computing list structure twice.
18395 (let ((new-box (cond
18396 ((equal arg '(16)) "[-]")
18397 ((equal arg '(4)) nil)
18398 ((equal "[X]" cbox) "[ ]")
18399 (t "[X]"))))
18400 (if (and firstp arg)
18401 ;; If at first item of sub-list, remove check-box from
18402 ;; every item at the same level.
18403 (mapc
18404 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18405 (org-list-get-all-items
18406 (point-at-bol) struct (org-list-prevs-alist struct)))
18407 (org-list-set-checkbox (point-at-bol) struct new-box)))
18408 ;; Replicate `org-list-write-struct', while grabbing a return
18409 ;; value from `org-list-struct-fix-box'.
18410 (org-list-struct-fix-ind struct parents 2)
18411 (org-list-struct-fix-item-end struct)
18412 (let ((prevs (org-list-prevs-alist struct)))
18413 (org-list-struct-fix-bul struct prevs)
18414 (org-list-struct-fix-ind struct parents)
18415 (setq block-item
18416 (org-list-struct-fix-box struct parents prevs orderedp)))
18417 (org-list-struct-apply-struct struct old-struct)
18418 (org-update-checkbox-count-maybe)
18419 (when block-item
18420 (message
18421 "Checkboxes were removed due to unchecked box at line %d"
18422 (org-current-line block-item)))
18423 (when firstp (org-list-send-list 'maybe))))
18424 ((org-at-item-p)
18425 ;; Cursor at an item: repair list. Do checkbox related actions
18426 ;; only if function was called with an argument. Send list only
18427 ;; if at top item.
18428 (let* ((struct (org-list-struct))
18429 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18430 old-struct)
18431 (when arg
18432 (setq old-struct (copy-tree struct))
18433 (if firstp
18434 ;; If at first item of sub-list, add check-box to every
18435 ;; item at the same level.
18436 (mapc
18437 (lambda (pos)
18438 (unless (org-list-get-checkbox pos struct)
18439 (org-list-set-checkbox pos struct "[ ]")))
18440 (org-list-get-all-items
18441 (point-at-bol) struct (org-list-prevs-alist struct)))
18442 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18443 (org-list-write-struct
18444 struct (org-list-parents-alist struct) old-struct)
18445 (when arg (org-update-checkbox-count-maybe))
18446 (when firstp (org-list-send-list 'maybe))))
18447 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18448 ;; Dynamic block
18449 (beginning-of-line 1)
18450 (save-excursion (org-update-dblock)))
18451 ((save-excursion
18452 (beginning-of-line 1)
18454 (cond
18455 ((equal (match-string 1) "TBLFM")
18456 ;; Recalculate the table before this line
18457 (save-excursion
18458 (beginning-of-line 1)
18460 (if (org-at-table-p)
18461 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18462 (t
18463 (let ((org-inhibit-startup-visibility-stuff t)
18464 (org-startup-align-all-tables nil))
18465 (when (boundp 'org-table-coordinate-overlays)
18466 (mapc 'delete-overlay org-table-coordinate-overlays)
18467 (setq org-table-coordinate-overlays nil))
18468 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18469 (message "Local setup has been refreshed"))))
18470 ((org-clock-update-time-maybe))
18471 (t
18472 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18473 (error "C-c C-c can do nothing useful at this location"))))))
18475 (defun org-mode-restart ()
18476 "Restart Org-mode, to scan again for special lines.
18477 Also updates the keyword regular expressions."
18478 (interactive)
18479 (org-mode)
18480 (message "Org-mode restarted"))
18482 (defun org-kill-note-or-show-branches ()
18483 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18484 (interactive)
18485 (if (not org-finish-function)
18486 (progn
18487 (hide-subtree)
18488 (call-interactively 'show-branches))
18489 (let ((org-note-abort t))
18490 (funcall org-finish-function))))
18492 (defun org-return (&optional indent)
18493 "Goto next table row or insert a newline.
18494 Calls `org-table-next-row' or `newline', depending on context.
18495 See the individual commands for more information."
18496 (interactive)
18497 (cond
18498 ((or (bobp) (org-in-src-block-p))
18499 (if indent (newline-and-indent) (newline)))
18500 ((org-at-table-p)
18501 (org-table-justify-field-maybe)
18502 (call-interactively 'org-table-next-row))
18503 ;; when `newline-and-indent' is called within a list, make sure
18504 ;; text moved stays inside the item.
18505 ((and (org-in-item-p) indent)
18506 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18507 (progn
18508 (save-match-data (newline))
18509 (org-indent-line-to (length (match-string 0))))
18510 (let ((ind (org-get-indentation)))
18511 (newline)
18512 (if (org-looking-back org-list-end-re)
18513 (org-indent-line-function)
18514 (org-indent-line-to ind)))))
18515 ((and org-return-follows-link
18516 (let ((tprop (get-text-property (point) 'face)))
18517 (or (eq tprop 'org-link)
18518 (and (listp tprop) (memq 'org-link tprop)))))
18519 (call-interactively 'org-open-at-point))
18520 ((and (org-at-heading-p)
18521 (looking-at
18523 (org-show-entry)
18524 (end-of-line 1)
18525 (newline))
18526 (t (if indent (newline-and-indent) (newline)))))
18528 (defun org-return-indent ()
18529 "Goto next table row or insert a newline and indent.
18530 Calls `org-table-next-row' or `newline-and-indent', depending on
18531 context. See the individual commands for more information."
18532 (interactive)
18533 (org-return t))
18535 (defun org-ctrl-c-star ()
18536 "Compute table, or change heading status of lines.
18537 Calls `org-table-recalculate' or `org-toggle-heading',
18538 depending on context."
18539 (interactive)
18540 (cond
18541 ((org-at-table-p)
18542 (call-interactively 'org-table-recalculate))
18543 (t
18544 ;; Convert all lines in region to list items
18545 (call-interactively 'org-toggle-heading))))
18547 (defun org-ctrl-c-minus ()
18548 "Insert separator line in table or modify bullet status of line.
18549 Also turns a plain line or a region of lines into list items.
18550 Calls `org-table-insert-hline', `org-toggle-item', or
18551 `org-cycle-list-bullet', depending on context."
18552 (interactive)
18553 (cond
18554 ((org-at-table-p)
18555 (call-interactively 'org-table-insert-hline))
18556 ((org-region-active-p)
18557 (call-interactively 'org-toggle-item))
18558 ((org-in-item-p)
18559 (call-interactively 'org-cycle-list-bullet))
18560 (t
18561 (call-interactively 'org-toggle-item))))
18563 (defun org-toggle-item (arg)
18564 "Convert headings or normal lines to items, items to normal lines.
18565 If there is no active region, only the current line is considered.
18567 If the first non blank line in the region is an headline, convert
18568 all headlines to items, shifting text accordingly.
18570 If it is an item, convert all items to normal lines.
18572 If it is normal text, change region into an item. With a prefix
18573 argument ARG, change each line in region into an item."
18574 (interactive "P")
18575 (let ((shift-text
18576 (function
18577 ;; Shift text in current section to IND, from point to END.
18578 ;; The function leaves point to END line.
18579 (lambda (ind end)
18580 (let ((min-i 1000) (end (copy-marker end)))
18581 ;; First determine the minimum indentation (MIN-I) of
18582 ;; the text.
18583 (save-excursion
18584 (catch 'exit
18585 (while (< (point) end)
18586 (let ((i (org-get-indentation)))
18587 (cond
18588 ;; Skip blank lines and inline tasks.
18590 ((looking-at org-outline-regexp-bol))
18591 ;; We can't find less than 0 indentation.
18592 ((zerop i) (throw 'exit (setq min-i 0)))
18593 ((< i min-i) (setq min-i i))))
18594 (forward-line))))
18595 ;; Then indent each line so that a line indented to
18596 ;; MIN-I becomes indented to IND. Ignore blank lines
18597 ;; and inline tasks in the process.
18598 (let ((delta (- ind min-i)))
18599 (while (< (point) end)
18601 (looking-at org-outline-regexp-bol))
18602 (org-indent-line-to (+ (org-get-indentation) delta)))
18603 (forward-line)))))))
18604 (skip-blanks
18605 (function
18606 ;; Return beginning of first non-blank line, starting from
18607 ;; line at POS.
18608 (lambda (pos)
18609 (save-excursion
18610 (goto-char pos)
18612 (point-at-bol)))))
18613 beg end)
18614 ;; Determine boundaries of changes.
18615 (if (org-region-active-p)
18616 (setq beg (funcall skip-blanks (region-beginning))
18617 end (copy-marker (region-end)))
18618 (setq beg (funcall skip-blanks (point-at-bol))
18619 end (copy-marker (point-at-eol))))
18620 ;; Depending on the starting line, choose an action on the text
18621 ;; between BEG and END.
18622 (org-with-limited-levels
18623 (save-excursion
18624 (goto-char beg)
18625 (cond
18626 ;; Case 1. Start at an item: de-itemize. Note that it only
18627 ;; happens when a region is active: `org-ctrl-c-minus'
18628 ;; would call `org-cycle-list-bullet' otherwise.
18629 ((org-at-item-p)
18630 (while (< (point) end)
18631 (when (org-at-item-p)
18633 (delete-region (point) (match-end 0)))
18634 (forward-line)))
18635 ;; Case 2. Start at an heading: convert to items.
18636 ((org-at-heading-p)
18637 (let* ((bul (org-list-bullet-string "-"))
18638 (bul-len (length bul))
18639 ;; Indentation of the first heading. It should be
18640 ;; relative to the indentation of its parent, if any.
18641 (start-ind (save-excursion
18642 (cond
18643 ((not org-adapt-indentation) 0)
18644 ((not (outline-previous-heading)) 0)
18645 (t (length (match-string 0))))))
18646 ;; Level of first heading. Further headings will be
18647 ;; compared to it to determine hierarchy in the list.
18648 (ref-level (org-reduced-level (org-outline-level))))
18649 (while (< (point) end)
18650 (let* ((level (org-reduced-level (org-outline-level)))
18651 (delta (max 0 (- level ref-level))))
18652 ;; If current headline is less indented than the first
18653 ;; one, set it as reference, in order to preserve
18654 ;; subtrees.
18655 (when (< level ref-level) (setq ref-level level))
18656 (replace-match bul t t)
18657 (org-indent-line-to (+ start-ind (* delta bul-len)))
18658 ;; Ensure all text down to END (or SECTION-END) belongs
18659 ;; to the newly created item.
18660 (let ((section-end (save-excursion
18661 (or (outline-next-heading) (point)))))
18662 (forward-line)
18663 (funcall shift-text
18664 (+ start-ind (* (1+ delta) bul-len))
18665 (min end section-end)))))))
18666 ;; Case 3. Normal line with ARG: turn each non-item line into
18667 ;; an item.
18668 (arg
18669 (while (< (point) end)
18670 (unless (or (org-at-heading-p) (org-at-item-p))
18672 (replace-match
18674 (forward-line)))
18675 ;; Case 4. Normal line without ARG: make the first line of
18676 ;; region an item, and shift indentation of others
18677 ;; lines to set them as item's body.
18678 (t (let* ((bul (org-list-bullet-string "-"))
18679 (bul-len (length bul))
18680 (ref-ind (org-get-indentation)))
18682 (insert bul)
18683 (forward-line)
18684 (while (< (point) end)
18685 ;; Ensure that lines less indented than first one
18686 ;; still get included in item body.
18687 (funcall shift-text
18688 (+ ref-ind bul-len)
18689 (min end (save-excursion (or (outline-next-heading)
18690 (point)))))
18691 (forward-line)))))))))
18693 (defun org-toggle-heading (&optional nstars)
18694 "Convert headings to normal text, or items or text to headings.
18695 If there is no active region, only the current line is considered.
18697 If the first non blank line is an headline, remove the stars from
18698 all headlines in the region.
18700 If it is a plain list item, turn all plain list items into headings.
18702 If it is a normal line, turn each and every normal line (i.e. not
18703 an heading or an item) in the region into a heading.
18705 When converting a line into a heading, the number of stars is chosen
18706 such that the lines become children of the current entry. However,
18707 when a prefix argument is given, its value determines the number of
18708 stars to add."
18709 (interactive "P")
18710 (let ((skip-blanks
18711 (function
18712 ;; Return beginning of first non-blank line, starting from
18713 ;; line at POS.
18714 (lambda (pos)
18715 (save-excursion
18716 (goto-char pos)
18718 (point-at-bol)))))
18719 beg end)
18720 ;; Determine boundaries of changes. If region ends at a bol, do
18721 ;; not consider the last line to be in the region.
18722 (if (org-region-active-p)
18723 (setq beg (funcall skip-blanks (region-beginning))
18724 end (copy-marker (save-excursion
18725 (goto-char (region-end))
18726 (if (bolp) (point) (point-at-eol)))))
18727 (setq beg (funcall skip-blanks (point-at-bol))
18728 end (copy-marker (point-at-eol))))
18729 ;; Ensure inline tasks don't count as headings.
18730 (org-with-limited-levels
18731 (save-excursion
18732 (goto-char beg)
18733 (cond
18734 ;; Case 1. Started at an heading: de-star headings.
18735 ((org-at-heading-p)
18736 (while (< (point) end)
18737 (when (org-at-heading-p t)
18738 (looking-at org-outline-regexp) (replace-match ""))
18739 (forward-line)))
18740 ;; Case 2. Started at an item: change items into headlines.
18741 ;; One star will be added by `org-list-to-subtree'.
18742 ((org-at-item-p)
18743 (let* ((stars (make-string
18744 (if nstars
18745 ;; subtract the star that will be added again by
18746 ;; `org-list-to-subtree'
18747 (1- (prefix-numeric-value current-prefix-arg))
18748 (or (org-current-level) 0))
18749 ?*))
18750 (add-stars
18751 (cond (nstars "") ; stars from prefix only
18752 ((equal stars "") "") ; before first heading
18753 (org-odd-levels-only "*") ; inside heading, odd
18754 (t "")))) ; inside heading, oddeven
18755 (while (< (point) end)
18756 (when (org-at-item-p)
18757 ;; Pay attention to cases when region ends before list.
18758 (let* ((struct (org-list-struct))
18759 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18760 (save-restriction
18761 (narrow-to-region (point) list-end)
18762 (insert
18763 (org-list-to-subtree
18764 (org-list-parse-list t)
18765 '(:istart (concat stars add-stars (funcall get-stars depth))
18766 :icount (concat stars add-stars (funcall get-stars depth))))))))
18767 (forward-line))))
18768 ;; Case 3. Started at normal text: make every line an heading,
18769 ;; skipping headlines and items.
18770 (t (let* ((stars (make-string
18771 (if nstars
18772 (prefix-numeric-value current-prefix-arg)
18773 (or (org-current-level) 0))
18774 ?*))
18775 (add-stars
18776 (cond (nstars "") ; stars from prefix only
18777 ((equal stars "") "*") ; before first heading
18778 (org-odd-levels-only "**") ; inside heading, odd
18779 (t "*"))) ; inside heading, oddeven
18780 (rpl (concat stars add-stars " ")))
18781 (while (< (point) end)
18782 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18784 (replace-match (concat rpl (match-string 2))))
18785 (forward-line)))))))))
18787 (defun org-meta-return (&optional arg)
18788 "Insert a new heading or wrap a region in a table.
18789 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18790 See the individual commands for more information."
18791 (interactive "P")
18792 (cond
18793 ((run-hook-with-args-until-success 'org-metareturn-hook))
18794 ((org-at-table-p)
18795 (call-interactively 'org-table-wrap-region))
18796 (t (call-interactively 'org-insert-heading))))
18798 ;;; Menu entries
18800 ;; Define the Org-mode menus
18801 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18802 '("Tbl"
18803 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18804 ["Next Field" org-cycle (org-at-table-p)]
18805 ["Previous Field" org-shifttab (org-at-table-p)]
18806 ["Next Row" org-return (org-at-table-p)]
18807 "--"
18808 ["Blank Field" org-table-blank-field (org-at-table-p)]
18809 ["Edit Field" org-table-edit-field (org-at-table-p)]
18810 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18811 "--"
18812 ("Column"
18813 ["Move Column Left" org-metaleft (org-at-table-p)]
18814 ["Move Column Right" org-metaright (org-at-table-p)]
18815 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18816 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18817 ("Row"
18818 ["Move Row Up" org-metaup (org-at-table-p)]
18819 ["Move Row Down" org-metadown (org-at-table-p)]
18820 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18821 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18822 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18823 "--"
18824 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18825 ("Rectangle"
18826 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18827 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18828 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18829 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18830 "--"
18831 ("Calculate"
18832 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18833 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18834 ["Edit Formulas" org-edit-special (org-at-table-p)]
18835 "--"
18836 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18837 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18838 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18839 "--"
18840 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18841 "--"
18842 ["Sum Column/Rectangle" org-table-sum
18843 (or (org-at-table-p) (org-region-active-p))]
18844 ["Which Column?" org-table-current-column (org-at-table-p)])
18845 ["Debug Formulas"
18846 org-table-toggle-formula-debugger
18847 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18848 ["Show Col/Row Numbers"
18849 org-table-toggle-coordinate-overlays
18850 :style toggle
18851 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18852 "--"
18853 ["Create" org-table-create (and (not (org-at-table-p))
18854 org-enable-table-editor)]
18855 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18856 ["Import from File" org-table-import (not (org-at-table-p))]
18857 ["Export to File" org-table-export (org-at-table-p)]
18858 "--"
18859 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18861 (easy-menu-define org-org-menu org-mode-map "Org menu"
18862 '("Org"
18863 ("Show/Hide"
18864 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18865 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18866 ["Sparse Tree..." org-sparse-tree t]
18867 ["Reveal Context" org-reveal t]
18868 ["Show All" show-all t]
18869 "--"
18870 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18871 "--"
18872 ["New Heading" org-insert-heading t]
18873 ("Navigate Headings"
18874 ["Up" outline-up-heading t]
18875 ["Next" outline-next-visible-heading t]
18876 ["Previous" outline-previous-visible-heading t]
18877 ["Next Same Level" outline-forward-same-level t]
18878 ["Previous Same Level" outline-backward-same-level t]
18879 "--"
18880 ["Jump" org-goto t])
18881 ("Edit Structure"
18882 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18883 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18884 "--"
18885 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18886 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18887 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18888 "--"
18889 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18890 "--"
18891 ["Copy visible text" org-copy-visible t]
18892 "--"
18893 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18894 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18895 ["Demote Heading" org-metaright (not (org-at-table-p))]
18896 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18897 "--"
18898 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18899 "--"
18900 ["Convert to odd levels" org-convert-to-odd-levels t]
18901 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18902 ("Editing"
18903 ["Emphasis..." org-emphasize t]
18904 ["Edit Source Example" org-edit-special t]
18905 "--"
18906 ["Footnote new/jump" org-footnote-action t]
18907 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18908 ("Archive"
18909 ["Archive (default method)" org-archive-subtree-default t]
18910 "--"
18911 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18912 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18913 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18914 )
18915 "--"
18916 ("Hyperlinks"
18917 ["Store Link (Global)" org-store-link t]
18918 ["Find existing link to here" org-occur-link-in-agenda-files t]
18919 ["Insert Link" org-insert-link t]
18920 ["Follow Link" org-open-at-point t]
18921 "--"
18922 ["Next link" org-next-link t]
18923 ["Previous link" org-previous-link t]
18924 "--"
18925 ["Descriptive Links"
18926 org-toggle-link-display
18927 :style radio
18928 :selected org-descriptive-links
18929 ]
18930 ["Literal Links"
18931 org-toggle-link-display
18932 :style radio
18933 :selected (not org-descriptive-links)])
18934 "--"
18935 ("TODO Lists"
18936 ["TODO/DONE/-" org-todo t]
18937 ("Select keyword"
18938 ["Next keyword" org-shiftright (org-at-heading-p)]
18939 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18940 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18941 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18942 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18943 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18944 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18945 "--"
18946 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18947 :selected org-enforce-todo-dependencies :style toggle :active t]
18948 "Settings for tree at point"
18949 ["Do Children sequentially" org-toggle-ordered-property :style radio
18950 :selected (org-entry-get nil "ORDERED")
18951 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18952 ["Do Children parallel" org-toggle-ordered-property :style radio
18953 :selected (not (org-entry-get nil "ORDERED"))
18954 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18955 "--"
18956 ["Set Priority" org-priority t]
18957 ["Priority Up" org-shiftup t]
18958 ["Priority Down" org-shiftdown t]
18959 "--"
18960 ["Get news from all feeds" org-feed-update-all t]
18961 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18962 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18963 ("TAGS and Properties"
18964 ["Set Tags" org-set-tags-command t]
18965 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18966 "--"
18967 ["Set property" org-set-property t]
18968 ["Column view of properties" org-columns t]
18969 ["Insert Column View DBlock" org-insert-columns-dblock t])
18970 ("Dates and Scheduling"
18971 ["Timestamp" org-time-stamp t]
18972 ["Timestamp (inactive)" org-time-stamp-inactive t]
18973 ("Change Date"
18974 ["1 Day Later" org-shiftright t]
18975 ["1 Day Earlier" org-shiftleft t]
18976 ["1 ... Later" org-shiftup t]
18977 ["1 ... Earlier" org-shiftdown t])
18978 ["Compute Time Range" org-evaluate-time-range t]
18979 ["Schedule Item" org-schedule t]
18980 ["Deadline" org-deadline t]
18981 "--"
18982 ["Custom time format" org-toggle-time-stamp-overlays
18983 :style radio :selected org-display-custom-times]
18984 "--"
18985 ["Goto Calendar" org-goto-calendar t]
18986 ["Date from Calendar" org-date-from-calendar t]
18987 "--"
18988 ["Start/Restart Timer" org-timer-start t]
18989 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18990 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18991 ["Insert Timer String" org-timer t]
18992 ["Insert Timer Item" org-timer-item t])
18993 ("Logging work"
18994 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18995 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18996 ["Clock out" org-clock-out t]
18997 ["Clock cancel" org-clock-cancel t]
18998 "--"
18999 ["Mark as default task" org-clock-mark-default-task t]
19000 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19001 ["Goto running clock" org-clock-goto t]
19002 "--"
19003 ["Display times" org-clock-display t]
19004 ["Create clock table" org-clock-report t]
19005 "--"
19006 ["Record DONE time"
19007 (progn (setq org-log-done (not org-log-done))
19008 (message "Switching to %s will %s record a timestamp"
19009 (car org-done-keywords)
19010 (if org-log-done "automatically" "not")))
19011 :style toggle :selected org-log-done])
19012 "--"
19013 ["Agenda Command..." org-agenda t]
19014 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19015 ("File List for Agenda")
19016 ("Special views current file"
19017 ["TODO Tree" org-show-todo-tree t]
19018 ["Check Deadlines" org-check-deadlines t]
19019 ["Timeline" org-timeline t]
19020 ["Tags/Property tree" org-match-sparse-tree t])
19021 "--"
19022 ["Export/Publish..." org-export t]
19023 ("LaTeX"
19024 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19025 :selected org-cdlatex-mode]
19026 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19027 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19028 ["Modify math symbol" org-cdlatex-math-modify
19029 (org-inside-LaTeX-fragment-p)]
19030 ["Insert citation" org-reftex-citation t]
19031 "--"
19032 ["Template for BEAMER" org-insert-beamer-options-template t])
19033 "--"
19034 ("MobileOrg"
19035 ["Push Files and Views" org-mobile-push t]
19036 ["Get Captured and Flagged" org-mobile-pull t]
19037 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19038 "--"
19039 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19040 "--"
19041 ("Documentation"
19042 ["Show Version" org-version t]
19043 ["Info Documentation" org-info t])
19044 ("Customize"
19045 ["Browse Org Group" org-customize t]
19046 "--"
19047 ["Expand This Menu" org-create-customize-menu
19048 (fboundp 'customize-menu-create)])
19049 ["Send bug report" org-submit-bug-report t]
19050 "--"
19051 ("Refresh/Reload"
19052 ["Refresh setup current buffer" org-mode-restart t]
19053 ["Reload Org (after update)" org-reload t]
19054 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19055 ))
19057 (defun org-info (&optional node)
19058 "Read documentation for Org-mode in the info system.
19059 With optional NODE, go directly to that node."
19060 (interactive)
19061 (info (format "(org)%s" (or node ""))))
19063 ;;;###autoload
19064 (defun org-submit-bug-report ()
19065 "Submit a bug report on Org-mode via mail.
19067 Don't hesitate to report any problems or inaccurate documentation.
19069 If you don't have setup sending mail from (X)Emacs, please copy the
19070 output buffer into your mail program, as it gives us important
19071 information about your Org-mode version and configuration."
19072 (interactive)
19073 (require 'reporter)
19074 (org-load-modules-maybe)
19075 (org-require-autoloaded-modules)
19076 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19077 (reporter-submit-bug-report
19078 "emacs-orgmode@gnu.org"
19079 (org-version)
19080 (let (list)
19081 (save-window-excursion
19082 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19083 (delete-other-windows)
19084 (erase-buffer)
19085 (insert "You are about to submit a bug report to the Org-mode mailing list.
19087 We would like to add your full Org-mode and Outline configuration to the
19088 bug report. This greatly simplifies the work of the maintainer and
19089 other experts on the mailing list.
19091 HOWEVER, some variables you have customized may contain private
19092 information. The names of customers, colleagues, or friends, might
19093 appear in the form of file names, tags, todo states, or search strings.
19094 If you answer yes to the prompt, you might want to check and remove
19095 such private information before sending the email.")
19096 (add-text-properties (point-min) (point-max) '(face org-warning))
19097 (when (yes-or-no-p "Include your Org-mode configuration ")
19098 (mapatoms
19099 (lambda (v)
19100 (and (boundp v)
19102 (or (and (symbol-value v)
19104 (and
19105 (get v 'custom-type) (get v 'standard-value)
19106 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19107 (push v list)))))
19108 (kill-buffer (get-buffer "*Warn about privacy*"))
19109 list))
19110 nil nil
19111 "Remember to cover the basics, that is, what you expected to happen and
19112 what in fact did happen. You don't know how to make a good report? See
19114 http://orgmode.org/manual/Feedback.html#Feedback
19116 Your bug report will be posted to the Org-mode mailing list.
19117 ------------------------------------------------------------------------")
19118 (save-excursion
19123 (defun org-install-agenda-files-menu ()
19124 (let ((bl (buffer-list)))
19125 (save-excursion
19126 (while bl
19127 (set-buffer (pop bl))
19128 (if (eq major-mode 'org-mode) (setq bl nil)))
19129 (when (eq major-mode 'org-mode)
19130 (easy-menu-change
19131 '("Org") "File List for Agenda"
19132 (append
19133 (list
19134 ["Edit File List" (org-edit-agenda-file-list) t]
19135 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19136 ["Remove Current File from List" org-remove-file t]
19137 ["Cycle through agenda files" org-cycle-agenda-files t]
19138 ["Occur in all agenda files" org-occur-in-agenda-files t]
19139 "--")
19140 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19142 ;;;; Documentation
19144 ;;;###autoload
19145 (defun org-require-autoloaded-modules ()
19146 (interactive)
19147 (mapc 'require
19148 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19149 org-docbook org-exp org-html org-icalendar
19150 org-id org-latex
19151 org-publish org-remember org-table
19152 org-timer org-xoxo)))
19154 ;;;###autoload
19155 (defun org-reload (&optional uncompiled)
19156 "Reload all org lisp files.
19157 With prefix arg UNCOMPILED, load the uncompiled versions."
19158 (interactive "P")
19159 (require 'find-func)
19161 (dir-org (file-name-directory (org-find-library-name "org")))
19162 (dir-org-contrib (ignore-errors
19163 (file-name-directory
19164 (org-find-library-name "org-contribdir"))))
19165 (babel-files
19166 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19167 (append (list nil "comint" "eval" "exp" "keys"
19168 "lob" "ref" "table" "tangle")
19169 (delq nil
19170 (mapcar
19171 (lambda (lang)
19172 (when (cdr lang) (symbol-name (car lang))))
19173 org-babel-load-languages)))))
19174 (files
19175 (append (directory-files dir-org t file-re)
19176 babel-files
19177 (and dir-org-contrib
19178 (directory-files dir-org-contrib t file-re))))
19179 (remove-re (concat (if (featurep 'xemacs)
19180 "org-colview" "org-colview-xemacs")
19182 (setq files (mapcar 'file-name-sans-extension files))
19183 (setq files (mapcar
19184 (lambda (x) (if (string-match remove-re x) nil x))
19185 files))
19186 (setq files (delq nil files))
19187 (mapc
19188 (lambda (f)
19189 (when (featurep (intern (file-name-nondirectory f)))
19190 (if (and (not uncompiled)
19191 (file-exists-p (concat f ".elc")))
19192 (load (concat f ".elc") nil nil t)
19193 (load (concat f ".el") nil nil t))))
19194 files))
19195 (org-version))
19197 ;;;###autoload
19198 (defun org-customize ()
19199 "Call the customize function with org as argument."
19200 (interactive)
19201 (org-load-modules-maybe)
19202 (org-require-autoloaded-modules)
19203 (customize-browse 'org))
19205 (defun org-create-customize-menu ()
19206 "Create a full customization menu for Org-mode, insert it into the menu."
19207 (interactive)
19208 (org-load-modules-maybe)
19209 (org-require-autoloaded-modules)
19210 (if (fboundp 'customize-menu-create)
19211 (progn
19212 (easy-menu-change
19213 '("Org") "Customize"
19214 `(["Browse Org group" org-customize t]
19215 "--"
19216 ,(customize-menu-create 'org)
19217 ["Set" Custom-set t]
19218 ["Save" Custom-save t]
19219 ["Reset to Current" Custom-reset-current t]
19220 ["Reset to Saved" Custom-reset-saved t]
19221 ["Reset to Standard Settings" Custom-reset-standard t]))
19223 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19225 ;;;; Miscellaneous stuff
19227 ;;; Generally useful functions
19229 (defun org-get-at-bol (property)
19230 "Get text property PROPERTY at beginning of line."
19231 (get-text-property (point-at-bol) property))
19233 (defun org-find-text-property-in-string (prop s)
19234 "Return the first non-nil value of property PROP in string S."
19235 (or (get-text-property 0 prop s)
19236 (get-text-property (or (next-single-property-change 0 prop s) 0)
19237 prop s)))
19239 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19240 "Display the given MESSAGE as a warning."
19241 (if (fboundp 'display-warning)
19242 (display-warning 'org message
19243 (if (featurep 'xemacs) 'warning :warning))
19244 (let ((buf (get-buffer-create "*Org warnings*")))
19245 (with-current-buffer buf
19246 (goto-char (point-max))
19247 (insert "Warning (Org): " message)
19248 (unless (bolp)
19249 (newline)))
19250 (display-buffer buf)
19251 (sit-for 0))))
19253 (defun org-eval (form)
19254 "Eval FORM and return result."
19255 (condition-case error
19256 (eval form)
19257 (error (format "%%![Error: %s]" error))))
19259 (defun org-in-commented-line ()
19260 "Is point in a line starting with `#'?"
19261 (equal (char-after (point-at-bol)) ?#))
19263 (defun org-in-indented-comment-line ()
19264 "Is point in a line starting with `#' after some white space?"
19265 (save-excursion
19266 (save-match-data
19267 (goto-char (point-at-bol))
19270 (defun org-in-verbatim-emphasis ()
19271 (save-match-data
19272 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19274 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19275 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19276 (if (and marker (marker-buffer marker)
19277 (buffer-live-p (marker-buffer marker)))
19278 (progn
19279 (org-pop-to-buffer-same-window (marker-buffer marker))
19280 (if (or (> marker (point-max)) (< marker (point-min)))
19281 (widen))
19282 (goto-char marker)
19283 (org-show-context 'org-goto))
19284 (if bookmark
19285 (bookmark-jump bookmark)
19286 (error "Cannot find location"))))
19288 (defun org-quote-csv-field (s)
19289 "Quote field for inclusion in CSV material."
19292 s))
19294 (defun org-force-self-insert (N)
19295 "Needed to enforce self-insert under remapping."
19296 (interactive "p")
19297 (self-insert-command N))
19299 (defun org-string-width (s)
19300 "Compute width of string, ignoring invisible characters.
19301 This ignores character with invisibility property `org-link', and also
19302 characters with property `org-cwidth', because these will become invisible
19303 upon the next fontification round."
19304 (let (b l)
19305 (when (or (eq t buffer-invisibility-spec)
19306 (assq 'org-link buffer-invisibility-spec))
19307 (while (setq b (text-property-any 0 (length s)
19308 'invisible 'org-link s))
19309 (setq s (concat (substring s 0 b)
19310 (substring s (or (next-single-property-change
19311 b 'invisible s) (length s)))))))
19312 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19313 (setq s (concat (substring s 0 b)
19314 (substring s (or (next-single-property-change
19315 b 'org-cwidth s) (length s))))))
19316 (setq l (string-width s) b -1)
19317 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19318 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19319 l))
19321 (defun org-shorten-string (s maxlength)
19322 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19323 If the string is shorter or has length MAXLENGTH, just return the
19324 original string. If it is longer, the functions finds a space in the
19325 string, breaks this string off at that locations and adds three dots
19326 as ellipsis. Including the ellipsis, the string will not be longer
19327 than MAXLENGTH. If finding a good breaking point in the string does
19328 not work, the string is just chopped off in the middle of a word
19329 if necessary."
19330 (if (<= (length s) maxlength)
19331 s
19332 (let* ((n (max (- maxlength 4) 1))
19334 (if (string-match re s)
19335 (concat (match-string 1 s) "...")
19336 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19338 (defun org-get-indentation (&optional line)
19339 "Get the indentation of the current line, interpreting tabs.
19340 When LINE is given, assume it represents a line and compute its indentation."
19341 (if line
19342 (if (string-match "^ *" (org-remove-tabs line))
19343 (match-end 0))
19344 (save-excursion
19345 (beginning-of-line 1)
19347 (current-column))))
19349 (defun org-get-string-indentation (s)
19350 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19351 (let ((n -1) (i 0) (w tab-width) c)
19352 (catch 'exit
19353 (while (< (setq n (1+ n)) (length s))
19354 (setq c (aref s n))
19355 (cond ((= c ?\ ) (setq i (1+ i)))
19357 (t (throw 'exit t)))))
19358 i))
19360 (defun org-remove-tabs (s &optional width)
19361 "Replace tabulators in S with spaces.
19362 Assumes that s is a single line, starting in column 0."
19363 (setq width (or width tab-width))
19365 (setq s (replace-match
19366 (make-string
19367 (- (* width (/ (+ (match-beginning 0) width) width))
19368 (match-beginning 0)) ?\ )
19369 t t s)))
19370 s)
19372 (defun org-fix-indentation (line ind)
19373 "Fix indentation in LINE.
19374 IND is a cons cell with target and minimum indentation.
19375 If the current indentation in LINE is smaller than the minimum,
19376 leave it alone. If it is larger than ind, set it to the target."
19377 (let* ((l (org-remove-tabs line))
19378 (i (org-get-indentation l))
19379 (i1 (car ind)) (i2 (cdr ind)))
19380 (if (>= i i2) (setq l (substring line i2)))
19381 (if (> i1 0)
19382 (concat (make-string i1 ?\ ) l)
19383 l)))
19385 (defun org-remove-indentation (code &optional n)
19386 "Remove the maximum common indentation from the lines in CODE.
19387 N may optionally be the number of spaces to remove."
19388 (with-temp-buffer
19389 (insert code)
19390 (org-do-remove-indentation n)
19391 (buffer-string)))
19393 (defun org-do-remove-indentation (&optional n)
19394 "Remove the maximum common indentation from the buffer."
19395 (untabify (point-min) (point-max))
19396 (let ((min 10000) re)
19397 (if n
19398 (setq min n)
19399 (goto-char (point-min))
19401 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19402 (unless (or (= min 0) (= min 10000))
19404 (goto-char (point-min))
19405 (while (re-search-forward re nil t)
19406 (replace-match "")
19407 (end-of-line 1))
19408 min)))
19410 (defun org-fill-template (template alist)
19411 "Find each %key of ALIST in TEMPLATE and replace it."
19412 (let ((case-fold-search nil)
19413 entry key value)
19414 (setq alist (sort (copy-sequence alist)
19415 (lambda (a b) (< (length (car a)) (length (car b))))))
19416 (while (setq entry (pop alist))
19417 (setq template
19418 (replace-regexp-in-string
19419 (concat "%" (regexp-quote (car entry)))
19420 (cdr entry) template t t)))
19421 template))
19423 (defun org-base-buffer (buffer)
19424 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19425 (if (not buffer)
19426 buffer
19427 (or (buffer-base-buffer buffer)
19428 buffer)))
19430 (defun org-trim (s)
19431 "Remove whitespace at beginning and end of string."
19434 s)
19436 (defun org-wrap (string &optional width lines)
19437 "Wrap string to either a number of lines, or a width in characters.
19438 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19439 that costs. If there is a word longer than WIDTH, the text is actually
19440 wrapped to the length of that word.
19441 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19442 many lines, whatever width that takes.
19443 The return value is a list of lines, without newlines at the end."
19445 (maxword (apply 'max (mapcar 'org-string-width words)))
19446 w ll)
19447 (cond (width
19448 (org-do-wrap words (max maxword width)))
19449 (lines
19450 (setq w maxword)
19451 (setq ll (org-do-wrap words maxword))
19452 (if (<= (length ll) lines)
19453 ll
19454 (setq ll words)
19455 (while (> (length ll) lines)
19456 (setq w (1+ w))
19457 (setq ll (org-do-wrap words w)))
19458 ll))
19459 (t (error "Cannot wrap this")))))
19461 (defun org-do-wrap (words width)
19462 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19463 (let (lines line)
19464 (while words
19465 (setq line (pop words))
19466 (while (and words (< (+ (length line) (length (car words))) width))
19467 (setq line (concat line " " (pop words))))
19468 (setq lines (push line lines)))
19469 (nreverse lines)))
19471 (defun org-split-string (string &optional separators)
19472 "Splits STRING into substrings at SEPARATORS.
19473 No empty strings are returned if there are matches at the beginning
19474 and end of string."
19476 (start 0)
19477 notfirst
19478 (list nil))
19479 (while (and (string-match rexp string
19480 (if (and notfirst
19481 (= start (match-beginning 0))
19482 (< start (length string)))
19483 (1+ start) start))
19484 (< (match-beginning 0) (length string)))
19485 (setq notfirst t)
19486 (or (eq (match-beginning 0) 0)
19487 (and (eq (match-beginning 0) (match-end 0))
19488 (eq (match-beginning 0) start))
19489 (setq list
19490 (cons (substring string start (match-beginning 0))
19491 list)))
19492 (setq start (match-end 0)))
19493 (or (eq start (length string))
19494 (setq list
19495 (cons (substring string start)
19496 list)))
19497 (nreverse list)))
19499 (defun org-quote-vert (s)
19501 (while (string-match "|" s)
19503 s)
19505 (defun org-uuidgen-p (s)
19506 "Is S an ID created by UUIDGEN?"
19507 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19509 (defun org-in-src-block-p nil
19510 "Whether point is in a code source block."
19511 (let (ov)
19512 (when (setq ov (overlays-at (point)))
19513 (memq 'org-block-background
19514 (overlay-properties
19515 (car ov))))))
19517 (defun org-context ()
19518 "Return a list of contexts of the current cursor position.
19519 If several contexts apply, all are returned.
19520 Each context entry is a list with a symbol naming the context, and
19521 two positions indicating start and end of the context. Possible
19522 contexts are:
19524 :headline anywhere in a headline
19525 :headline-stars on the leading stars in a headline
19526 :todo-keyword on a TODO keyword (including DONE) in a headline
19527 :tags on the TAGS in a headline
19528 :priority on the priority cookie in a headline
19529 :item on the first line of a plain list item
19530 :item-bullet on the bullet/number of a plain list item
19531 :checkbox on the checkbox in a plain list item
19532 :table in an org-mode table
19533 :table-special on a special filed in a table
19534 :table-table in a table.el table
19535 :clocktable in a clocktable
19536 :src-block in a source block
19537 :link on a hyperlink
19538 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19539 :target on a <<target>>
19540 :radio-target on a <<<radio-target>>>
19541 :latex-fragment on a LaTeX fragment
19542 :latex-preview on a LaTeX fragment with overlaid preview image
19544 This function expects the position to be visible because it uses font-lock
19545 faces as a help to recognize the following contexts: :table-special, :link,
19546 and :keyword."
19547 (let* ((f (get-text-property (point) 'face))
19548 (faces (if (listp f) f (list f)))
19549 (case-fold-search t)
19550 (p (point)) clist o)
19551 ;; First the large context
19552 (cond
19553 ((org-at-heading-p t)
19554 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19555 (when (progn
19556 (beginning-of-line 1)
19557 (looking-at org-todo-line-tags-regexp))
19558 (push (org-point-in-group p 1 :headline-stars) clist)
19559 (push (org-point-in-group p 2 :todo-keyword) clist)
19560 (push (org-point-in-group p 4 :tags) clist))
19561 (goto-char p)
19564 (push (org-point-in-group p 0 :priority) clist)))
19566 ((org-at-item-p)
19567 (push (org-point-in-group p 2 :item-bullet) clist)
19568 (push (list :item (point-at-bol)
19569 (save-excursion (org-end-of-item) (point)))
19570 clist)
19571 (and (org-at-item-checkbox-p)
19572 (push (org-point-in-group p 0 :checkbox) clist)))
19574 ((org-at-table-p)
19575 (push (list :table (org-table-begin) (org-table-end)) clist)
19576 (if (memq 'org-formula faces)
19577 (push (list :table-special
19578 (previous-single-property-change p 'face)
19579 (next-single-property-change p 'face)) clist)))
19580 ((org-at-table-p 'any)
19581 (push (list :table-table) clist)))
19582 (goto-char p)
19584 ;; New the "medium" contexts: clocktables, source blocks
19585 (cond ((org-in-clocktable-p)
19586 (push (list :clocktable
19588 (search-backward "#+BEGIN: clocktable" nil t))
19589 (match-beginning 0))
19591 (match-end 0))) clist))
19592 ((org-in-src-block-p)
19593 (push (list :src-block
19595 (search-backward "#+BEGIN_SRC" nil t))
19596 (match-beginning 0))
19597 (and (search-forward "#+END_SRC" nil t)
19598 (match-beginning 0))) clist)))
19599 (goto-char p)
19601 ;; Now the small context
19602 (cond
19603 ((org-at-timestamp-p)
19604 (push (org-point-in-group p 0 :timestamp) clist))
19605 ((memq 'org-link faces)
19606 (push (list :link
19607 (previous-single-property-change p 'face)
19608 (next-single-property-change p 'face)) clist))
19609 ((memq 'org-special-keyword faces)
19610 (push (list :keyword
19611 (previous-single-property-change p 'face)
19612 (next-single-property-change p 'face)) clist))
19613 ((org-at-target-p)
19614 (push (org-point-in-group p 0 :target) clist)
19615 (goto-char (1- (match-beginning 0)))
19616 (if (looking-at org-radio-target-regexp)
19617 (push (org-point-in-group p 0 :radio-target) clist))
19618 (goto-char p))
19619 ((setq o (car (delq nil
19620 (mapcar
19621 (lambda (x)
19622 (if (memq x org-latex-fragment-image-overlays) x))
19623 (overlays-at (point))))))
19624 (push (list :latex-fragment
19625 (overlay-start o) (overlay-end o)) clist)
19626 (push (list :latex-preview
19627 (overlay-start o) (overlay-end o)) clist))
19628 ((org-inside-LaTeX-fragment-p)
19629 ;; FIXME: positions wrong.
19630 (push (list :latex-fragment (point) (point)) clist)))
19632 (setq clist (nreverse (delq nil clist)))
19633 clist))
19635 ;; FIXME: Compare with at-regexp-p Do we need both?
19636 (defun org-in-regexp (re &optional nlines visually)
19637 "Check if point is inside a match of regexp.
19638 Normally only the current line is checked, but you can include NLINES extra
19639 lines both before and after point into the search.
19640 If VISUALLY is set, require that the cursor is not after the match but
19641 really on, so that the block visually is on the match."
19642 (catch 'exit
19643 (let ((pos (point))
19644 (eol (point-at-eol (+ 1 (or nlines 0))))
19645 (inc (if visually 1 0)))
19646 (save-excursion
19647 (beginning-of-line (- 1 (or nlines 0)))
19648 (while (re-search-forward re eol t)
19649 (if (and (<= (match-beginning 0) pos)
19650 (>= (+ inc (match-end 0)) pos))
19651 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19653 (defun org-at-regexp-p (regexp)
19654 "Is point inside a match of REGEXP in the current line?"
19655 (catch 'exit
19656 (save-excursion
19657 (let ((pos (point)) (end (point-at-eol)))
19658 (beginning-of-line 1)
19659 (while (re-search-forward regexp end t)
19660 (if (and (<= (match-beginning 0) pos)
19661 (>= (match-end 0) pos))
19662 (throw 'exit t)))
19663 nil))))
19665 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19666 "Non-nil when point is between matches of START-RE and END-RE.
19668 Also return a non-nil value when point is on one of the matches.
19670 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19671 buffer positions. Default values are the positions of headlines
19672 surrounding the point.
19674 The functions returns a cons cell whose car (resp. cdr) is the
19675 position before START-RE (resp. after END-RE)."
19676 (save-match-data
19677 (let ((pos (point))
19678 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19679 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19680 beg end)
19681 (save-excursion
19682 ;; Point is on a block when on START-RE or if START-RE can be
19683 ;; found before it...
19684 (and (or (org-at-regexp-p start-re)
19685 (re-search-backward start-re limit-up t))
19686 (setq beg (match-beginning 0))
19687 ;; ... and END-RE after it...
19688 (goto-char (match-end 0))
19689 (re-search-forward end-re limit-down t)
19690 (> (setq end (match-end 0)) pos)
19691 ;; ... without another START-RE in-between.
19692 (goto-char (match-beginning 0))
19693 (not (re-search-backward start-re (1+ beg) t))
19694 ;; Return value.
19695 (cons beg end))))))
19697 (defun org-in-block-p (names)
19698 "Non-nil when point belongs to a block whose name belongs to NAMES.
19700 NAMES is a list of strings containing names of blocks.
19702 Return first block name matched, or nil. Beware that in case of
19703 nested blocks, the returned name may not belong to the closest
19704 block from point."
19705 (save-match-data
19706 (catch 'exit
19707 (let ((case-fold-search t)
19708 (lim-up (save-excursion (outline-previous-heading)))
19709 (lim-down (save-excursion (outline-next-heading))))
19710 (mapc (lambda (name)
19711 (let ((n (regexp-quote name)))
19712 (when (org-between-regexps-p
19715 lim-up lim-down)
19716 (throw 'exit n))))
19717 names))
19718 nil)))
19720 (defun org-occur-in-agenda-files (regexp &optional nlines)
19721 "Call `multi-occur' with buffers for all agenda files."
19723 (let* ((files (org-agenda-files))
19724 (tnames (mapcar 'file-truename files))
19725 (extra org-agenda-text-search-extra-files)
19726 f)
19727 (when (eq (car extra) 'agenda-archives)
19728 (setq extra (cdr extra))
19729 (setq files (org-add-archive-files files)))
19730 (while (setq f (pop extra))
19731 (unless (member (file-truename f) tnames)
19732 (add-to-list 'files f 'append)
19733 (add-to-list 'tnames (file-truename f) 'append)))
19734 (multi-occur
19735 (mapcar (lambda (x)
19736 (with-current-buffer
19737 (or (get-file-buffer x) (find-file-noselect x))
19738 (widen)
19739 (current-buffer)))
19740 files)
19741 regexp)))
19743 (if (boundp 'occur-mode-find-occurrence-hook)
19744 ;; Emacs 23
19745 (add-hook 'occur-mode-find-occurrence-hook
19746 (lambda ()
19747 (when (eq major-mode 'org-mode)
19748 (org-reveal))))
19749 ;; Emacs 22
19750 (defadvice occur-mode-goto-occurrence
19751 (after org-occur-reveal activate)
19752 (and (eq major-mode 'org-mode) (org-reveal)))
19753 (defadvice occur-mode-goto-occurrence-other-window
19754 (after org-occur-reveal activate)
19755 (and (eq major-mode 'org-mode) (org-reveal)))
19756 (defadvice occur-mode-display-occurrence
19757 (after org-occur-reveal activate)
19758 (when (eq major-mode 'org-mode)
19759 (let ((pos (occur-mode-find-occurrence)))
19760 (with-current-buffer (marker-buffer pos)
19761 (save-excursion
19762 (goto-char pos)
19763 (org-reveal)))))))
19765 (defun org-occur-link-in-agenda-files ()
19766 "Create a link and search for it in the agendas.
19767 The link is not stored in `org-stored-links', it is just created
19768 for the search purpose."
19769 (interactive)
19770 (let ((link (condition-case nil
19771 (org-store-link nil)
19772 (error "Unable to create a link to here"))))
19773 (org-occur-in-agenda-files (regexp-quote link))))
19775 (defun org-uniquify (list)
19776 "Remove duplicate elements from LIST."
19777 (let (res)
19778 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19779 res))
19781 (defun org-delete-all (elts list)
19782 "Remove all elements in ELTS from LIST."
19783 (while elts
19784 (setq list (delete (pop elts) list)))
19785 list)
19787 (defun org-count (cl-item cl-seq)
19788 "Count the number of occurrences of ITEM in SEQ.
19789 Taken from `count' in cl-seq.el with all keyword arguments removed."
19790 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19791 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19792 (while (< cl-start cl-end)
19793 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19794 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19795 (setq cl-start (1+ cl-start)))
19796 cl-count))
19798 (defun org-remove-if (predicate seq)
19799 "Remove everything from SEQ that fulfills PREDICATE."
19800 (let (res e)
19801 (while seq
19802 (setq e (pop seq))
19803 (if (not (funcall predicate e)) (push e res)))
19804 (nreverse res)))
19806 (defun org-remove-if-not (predicate seq)
19807 "Remove everything from SEQ that does not fulfill PREDICATE."
19808 (let (res e)
19809 (while seq
19810 (setq e (pop seq))
19811 (if (funcall predicate e) (push e res)))
19812 (nreverse res)))
19814 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19815 "Reduce two-argument FUNCTION across SEQ.
19816 Taken from `reduce' in cl-seq.el with all keyword arguments but
19818 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19819 (cadr (memq :initial-value cl-keys)))
19820 (cl-seq (pop cl-seq))
19821 (t (funcall cl-func)))))
19822 (while cl-seq
19823 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19824 cl-accum))
19826 (defun org-back-over-empty-lines ()
19827 "Move backwards over whitespace, to the beginning of the first empty line.
19828 Returns the number of empty lines passed."
19829 (let ((pos (point)))
19830 (if (cdr (assoc 'heading org-blank-before-new-entry))
19832 (unless (eobp)
19833 (forward-line -1)))
19834 (beginning-of-line 2)
19835 (goto-char (min (point) pos))
19836 (count-lines (point) pos)))
19838 (defun org-skip-whitespace ()
19841 (defun org-point-in-group (point group &optional context)
19842 "Check if POINT is in match-group GROUP.
19843 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19844 match. If the match group does not exist or point is not inside it,
19845 return nil."
19846 (and (match-beginning group)
19847 (>= point (match-beginning group))
19848 (<= point (match-end group))
19849 (if context
19850 (list context (match-beginning group) (match-end group))
19851 t)))
19853 (defun org-switch-to-buffer-other-window (&rest args)
19854 "Switch to buffer in a second window on the current frame.
19855 In particular, do not allow pop-up frames.
19856 Returns the newly created buffer."
19857 (let (pop-up-frames special-display-buffer-names special-display-regexps
19858 special-display-function)
19859 (apply 'switch-to-buffer-other-window args)))
19861 (defun org-combine-plists (&rest plists)
19862 "Create a single property list from all plists in PLISTS.
19863 The process starts by copying the first list, and then setting properties
19864 from the other lists. Settings in the last list are the most significant
19865 ones and overrule settings in the other lists."
19866 (let ((rtn (copy-sequence (pop plists)))
19867 p v ls)
19868 (while plists
19869 (setq ls (pop plists))
19870 (while ls
19871 (setq p (pop ls) v (pop ls))
19872 (setq rtn (plist-put rtn p v))))
19873 rtn))
19875 (defun org-move-line-down (arg)
19876 "Move the current line down. With prefix argument, move it past ARG lines."
19877 (interactive "p")
19878 (let ((col (current-column))
19879 beg end pos)
19880 (beginning-of-line 1) (setq beg (point))
19881 (beginning-of-line 2) (setq end (point))
19882 (beginning-of-line (+ 1 arg))
19883 (setq pos (move-marker (make-marker) (point)))
19884 (insert (delete-and-extract-region beg end))
19885 (goto-char pos)
19886 (org-move-to-column col)))
19888 (defun org-move-line-up (arg)
19889 "Move the current line up. With prefix argument, move it past ARG lines."
19890 (interactive "p")
19891 (let ((col (current-column))
19892 beg end pos)
19893 (beginning-of-line 1) (setq beg (point))
19894 (beginning-of-line 2) (setq end (point))
19895 (beginning-of-line (- arg))
19896 (setq pos (move-marker (make-marker) (point)))
19897 (insert (delete-and-extract-region beg end))
19898 (goto-char pos)
19899 (org-move-to-column col)))
19901 (defun org-replace-escapes (string table)
19902 "Replace %-escapes in STRING with values in TABLE.
19904 The sequences in STRING may contain normal field width and padding information,
19906 so values can contain further %-escapes if they are define later in TABLE."
19907 (let ((tbl (copy-alist table))
19908 (case-fold-search nil)
19909 (pchg 0)
19910 e re rpl)
19911 (while (setq e (pop tbl))
19912 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19913 (when (and (cdr e) (string-match re (cdr e)))
19914 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19915 (safe "SREF"))
19916 (add-text-properties 0 3 (list 'sref sref) safe)
19917 (setcdr e (replace-match safe t t (cdr e)))))
19918 (while (string-match re string)
19919 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19920 (cdr e)))
19921 (setq string (replace-match rpl t t string))))
19922 (while (setq pchg (next-property-change pchg string))
19923 (let ((sref (get-text-property pchg 'sref string)))
19924 (when (and sref (string-match "SREF" string pchg))
19925 (setq string (replace-match sref t t string)))))
19926 string))
19928 (defun org-sublist (list start end)
19929 "Return a section of LIST, from START to END.
19930 Counting starts at 1."
19931 (let (rtn (c start))
19932 (setq list (nthcdr (1- start) list))
19933 (while (and list (<= c end))
19934 (push (pop list) rtn)
19935 (setq c (1+ c)))
19936 (nreverse rtn)))
19938 (defun org-find-base-buffer-visiting (file)
19939 "Like `find-buffer-visiting' but always return the base buffer and
19940 not an indirect buffer."
19941 (let ((buf (or (get-file-buffer file)
19942 (find-buffer-visiting file))))
19943 (if buf
19944 (or (buffer-base-buffer buf) buf)
19945 nil)))
19947 (defun org-image-file-name-regexp (&optional extensions)
19948 "Return regexp matching the file names of images.
19949 If EXTENSIONS is given, only match these."
19950 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19951 (image-file-name-regexp)
19952 (let ((image-file-name-extensions
19953 (or extensions
19954 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19955 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19957 (regexp-opt (nconc (mapcar 'upcase
19958 image-file-name-extensions)
19959 image-file-name-extensions)
19960 t)
19963 (defun org-file-image-p (file &optional extensions)
19964 "Return non-nil if FILE is an image."
19965 (save-match-data
19966 (string-match (org-image-file-name-regexp extensions) file)))
19968 (defun org-get-cursor-date ()
19969 "Return the date at cursor in as a time.
19970 This works in the calendar and in the agenda, anywhere else it just
19971 returns the current time."
19972 (let (date day defd)
19973 (cond
19974 ((eq major-mode 'calendar-mode)
19975 (setq date (calendar-cursor-to-date)
19976 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19977 ((eq major-mode 'org-agenda-mode)
19978 (setq day (get-text-property (point) 'day))
19979 (if day
19980 (setq date (calendar-gregorian-from-absolute day)
19981 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19982 (nth 2 date))))))
19983 (or defd (current-time))))
19985 (defvar org-agenda-action-marker (make-marker)
19986 "Marker pointing to the entry for the next agenda action.")
19988 (defun org-mark-entry-for-agenda-action ()
19989 "Mark the current entry as target of an agenda action.
19990 Agenda actions are actions executed from the agenda with the key `k',
19991 which make use of the date at the cursor."
19992 (interactive)
19993 (move-marker org-agenda-action-marker
19994 (save-excursion (org-back-to-heading t) (point))
19995 (current-buffer))
19996 (message
19997 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19999 (defun org-mark-subtree ()
20000 "Mark the current subtree.
20001 This puts point at the start of the current subtree, and mark at the end.
20003 If point is in an inline task, mark that task instead."
20004 (interactive)
20005 (let ((inline-task-p
20006 (and (featurep 'org-inlinetask)
20007 (org-inlinetask-in-task-p)))
20008 (beg))
20009 ;; Get beginning of subtree
20010 (cond
20011 (inline-task-p (org-inlinetask-goto-beginning))
20012 ((org-at-heading-p) (beginning-of-line))
20013 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20014 (setq beg (point))
20015 ;; Get end of it
20016 (if inline-task-p
20017 (org-inlinetask-goto-end)
20018 (org-end-of-subtree))
20019 ;; Mark zone
20020 (push-mark (point) nil t)
20021 (goto-char beg)))
20023 ;;; Paragraph filling stuff.
20024 ;; We want this to be just right, so use the full arsenal.
20026 (defun org-indent-line-function ()
20027 "Indent line depending on context."
20028 (interactive)
20029 (let* ((pos (point))
20030 (itemp (org-at-item-p))
20031 (case-fold-search t)
20033 (inline-task-p (and (featurep 'org-inlinetask)
20034 (org-inlinetask-in-task-p)))
20035 (inline-re (and inline-task-p
20036 (org-inlinetask-outline-regexp)))
20037 column)
20038 (beginning-of-line 1)
20039 (cond
20040 ;; Comments
20041 ((looking-at "# ") (setq column 0))
20042 ;; Headings
20043 ((looking-at org-outline-regexp) (setq column 0))
20044 ;; Included files
20046 ;; Footnote definition
20047 ((looking-at org-footnote-definition-re) (setq column 0))
20048 ;; Literal examples
20050 (setq column (org-get-indentation))) ; do nothing
20051 ;; Lists
20052 ((ignore-errors (goto-char (org-in-item-p)))
20053 (setq column (if itemp
20054 (org-get-indentation)
20055 (org-list-item-body-column (point))))
20056 (goto-char pos))
20057 ;; Drawers
20059 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20060 (save-excursion
20061 (goto-char (1- (match-beginning 1)))
20062 (setq column (current-column))))
20063 ;; Special blocks
20065 (save-excursion
20066 (re-search-backward
20068 (setq column (org-get-indentation (match-string 0))))
20071 (save-excursion
20073 (setq column
20074 (cond ((equal (downcase (match-string 1)) "src")
20075 ;; src blocks: let `org-edit-src-exit' handle them
20076 (org-get-indentation))
20077 ((equal (downcase (match-string 1)) "example")
20078 (max (org-get-indentation)
20079 (org-get-indentation (match-string 0))))
20080 (t
20081 (org-get-indentation (match-string 0))))))
20082 ;; This line has nothing special, look at the previous relevant
20083 ;; line to compute indentation
20084 (t
20085 (beginning-of-line 0)
20086 (while (and (not (bobp))
20087 (not (looking-at org-drawer-regexp))
20088 ;; When point started in an inline task, do not move
20089 ;; above task starting line.
20090 (not (and inline-task-p (looking-at inline-re)))
20091 ;; Skip drawers, blocks, empty lines, verbatim,
20092 ;; comments, tables, footnotes definitions, lists,
20093 ;; inline tasks.
20095 (re-search-backward org-drawer-regexp nil t))
20099 (looking-at org-footnote-definition-re)
20100 (and (ignore-errors (goto-char (org-in-item-p)))
20101 (goto-char
20102 (org-list-get-top-point (org-list-struct))))
20103 (and (not inline-task-p)
20104 (featurep 'org-inlinetask)
20105 (org-inlinetask-in-task-p)
20106 (or (org-inlinetask-goto-beginning) t))))
20107 (beginning-of-line 0))
20108 (cond
20109 ;; There was an heading above.
20111 (if (not org-adapt-indentation)
20112 (setq column 0)
20113 (goto-char (match-end 0))
20114 (setq column (current-column))))
20115 ;; A drawer had started and is unfinished
20116 ((looking-at org-drawer-regexp)
20117 (goto-char (1- (match-beginning 1)))
20118 (setq column (current-column)))
20119 ;; Else, nothing noticeable found: get indentation and go on.
20120 (t (setq column (org-get-indentation))))))
20121 ;; Now apply indentation and move cursor accordingly
20122 (goto-char pos)
20123 (if (<= (current-column) (current-indentation))
20124 (org-indent-line-to column)
20125 (save-excursion (org-indent-line-to column)))
20126 ;; Special polishing for properties, see `org-property-format'
20127 (setq column (current-column))
20128 (beginning-of-line 1)
20129 (if (looking-at
20131 (replace-match (concat (match-string 1)
20132 (format org-property-format
20133 (match-string 2) (match-string 3)))
20134 t t))
20135 (org-move-to-column column)))
20137 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20138 "Variable to store copy of `adaptive-fill-regexp'.
20139 Since `adaptive-fill-regexp' is set to never match, we need to
20140 store a backup of its value before entering `org-mode' so that
20141 the functionality can be provided as a fall-back.")
20143 (defun org-set-autofill-regexps ()
20144 (interactive)
20145 ;; In the paragraph separator we include headlines, because filling
20146 ;; text in a line directly attached to a headline would otherwise
20147 ;; fill the headline as well.
20150 ;; The paragraph starter includes hand-formatted lists.
20151 (org-set-local
20152 'paragraph-start
20153 (concat
20162 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20163 ;; But only if the user has not turned off tables or fixed-width regions
20164 (org-set-local
20165 'auto-fill-inhibit-regexp
20166 (concat org-outline-regexp
20169 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20170 (concat
20172 (if org-enable-table-editor "|" "")
20173 (if org-enable-fixed-width-editor ":" "")
20174 "]"))))
20175 ;; We use our own fill-paragraph function, to make sure that tables
20176 ;; and fixed-width regions are not wrapped. That function will pass
20177 ;; through to `fill-paragraph' when appropriate.
20178 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20179 ;; Prevent auto-fill from inserting unwanted new items.
20180 (if (boundp 'fill-nobreak-predicate)
20181 (org-set-local 'fill-nobreak-predicate
20182 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20183 fill-nobreak-predicate
20184 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20185 ;; Adaptive filling: To get full control, first make sure that
20186 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20187 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20188 (org-set-local 'org-adaptive-fill-regexp-backup
20189 adaptive-fill-regexp))
20191 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20192 (org-set-local 'adaptive-fill-function
20193 'org-adaptive-fill-function)
20194 (org-set-local
20195 'align-mode-rules-list
20196 '((org-in-buffer-settings
20198 (modes . '(org-mode))))))
20200 (defun org-fill-item-nobreak-p ()
20201 "Non-nil when a line break at point would insert a new item."
20202 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20204 (defun org-fill-paragraph (&optional justify)
20205 "Re-align a table, pass through to fill-paragraph if no table."
20206 (let ((table-p (org-at-table-p))
20207 (table.el-p (org-at-table.el-p))
20208 (itemp (org-in-item-p)))
20209 (cond ((and (equal (char-after (point-at-bol)) ?*)
20210 (save-excursion (goto-char (point-at-bol))
20211 (looking-at org-outline-regexp)))
20212 t) ; skip headlines
20213 (table.el-p t) ; skip table.el tables
20214 (table-p (org-table-align) t) ; align Org tables
20215 (itemp ; align text in items
20216 (let* ((struct (save-excursion (goto-char itemp)
20217 (org-list-struct)))
20218 (parents (org-list-parents-alist struct))
20219 (children (org-list-get-children itemp struct parents))
20220 beg end prev next prefix)
20221 ;; Determine in which part of item point is: before
20222 ;; first child, after last child, between two
20223 ;; sub-lists, or simply in item if there's no child.
20224 (cond
20225 ((not children)
20226 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20227 beg itemp
20228 end (org-list-get-item-end itemp struct)))
20229 ((< (point) (setq next (car children)))
20230 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20231 beg itemp
20232 end next))
20233 ((> (point) (setq prev (car (last children))))
20234 (setq beg (org-list-get-item-end prev struct)
20235 end (org-list-get-item-end itemp struct)
20236 prefix (save-excursion
20237 (goto-char beg)
20239 (make-string (current-column) ?\ ))))
20240 (t (catch 'exit
20241 (while (setq next (pop children))
20242 (if (> (point) next)
20243 (setq prev next)
20244 (setq beg (org-list-get-item-end prev struct)
20245 end next
20246 prefix (save-excursion
20247 (goto-char beg)
20249 (make-string (current-column) ?\ )))
20250 (throw 'exit nil))))))
20251 ;; Use `fill-paragraph' with buffer narrowed to item
20252 ;; without any child, and with our computed PREFIX.
20253 (flet ((fill-context-prefix (from to &optional flr) prefix))
20254 (save-restriction
20255 (narrow-to-region beg end)
20256 (save-excursion (fill-paragraph justify)))) t))
20257 ;; Special case where point is not in a list but is on
20258 ;; a paragraph adjacent to a list: make sure this paragraph
20259 ;; doesn't get merged with the end of the list by narrowing
20260 ;; buffer first.
20261 ((save-excursion (forward-paragraph -1)
20262 (setq itemp (org-in-item-p)))
20263 (let ((struct (save-excursion (goto-char itemp)
20264 (org-list-struct))))
20265 (save-restriction
20266 (narrow-to-region (org-list-get-bottom-point struct)
20267 (save-excursion (forward-paragraph 1)
20268 (point)))
20269 (fill-paragraph justify) t)))
20270 ;; Else simply call `fill-paragraph'.
20271 (t nil))))
20273 ;; For reference, this is the default value of adaptive-fill-regexp
20276 (defun org-adaptive-fill-function ()
20277 "Return a fill prefix for org-mode files."
20278 (let (itemp)
20279 (save-excursion
20280 (cond
20281 ;; Comment line
20283 (match-string-no-properties 0))
20284 ;; Plain list item
20285 ((org-at-item-p)
20286 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20287 ;; Point is in a list after `backward-paragraph': original
20288 ;; point wasn't in the list, or filling would have been taken
20289 ;; care of by `org-auto-fill-function', but the list and the
20290 ;; real paragraph are not separated by a blank line. Thus, move
20291 ;; point after the list to go back to real paragraph and
20292 ;; determine fill-prefix.
20293 ((setq itemp (org-in-item-p))
20294 (goto-char itemp)
20295 (let* ((struct (org-list-struct))
20296 (bottom (org-list-get-bottom-point struct)))
20297 (goto-char bottom)
20298 (make-string (org-get-indentation) ?\ )))
20299 ;; Other text
20300 ((looking-at org-adaptive-fill-regexp-backup)
20301 (match-string-no-properties 0))))))
20303 (defun org-auto-fill-function ()
20304 "Auto-fill function."
20305 (let (itemp prefix)
20306 ;; When in a list, compute an appropriate fill-prefix and make
20307 ;; sure it will be used by `do-auto-fill'.
20308 (if (setq itemp (org-in-item-p))
20309 (progn
20310 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20311 (flet ((fill-context-prefix (from to &optional flr) prefix))
20312 (do-auto-fill)))
20313 ;; Else just use `do-auto-fill'.
20314 (do-auto-fill))))
20316 ;;; Other stuff.
20318 (defun org-toggle-fixed-width-section (arg)
20319 "Toggle the fixed-width export.
20320 If there is no active region, the QUOTE keyword at the current headline is
20321 inserted or removed. When present, it causes the text between this headline
20322 and the next to be exported as fixed-width text, and unmodified.
20323 If there is an active region, this command adds or removes a colon as the
20324 first character of this line. If the first character of a line is a colon,
20325 this line is also exported in fixed-width font."
20326 (interactive "P")
20327 (let* ((cc 0)
20328 (regionp (org-region-active-p))
20329 (beg (if regionp (region-beginning) (point)))
20330 (end (if regionp (region-end)))
20331 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20332 (case-fold-search nil)
20334 off)
20335 (if regionp
20336 (save-excursion
20337 (goto-char beg)
20338 (setq cc (current-column))
20339 (beginning-of-line 1)
20340 (setq off (looking-at re))
20341 (while (> nlines 0)
20342 (setq nlines (1- nlines))
20343 (beginning-of-line 1)
20344 (cond
20345 (arg
20346 (org-move-to-column cc t)
20348 (forward-line -1))
20349 ((and off (looking-at re))
20350 (replace-match "" t t nil 1))
20351 ((not off) (org-move-to-column cc t) (insert ": ")))
20352 (forward-line 1)))
20353 (save-excursion
20354 (org-back-to-heading)
20355 (cond
20356 ((looking-at (format org-heading-keyword-regexp-format
20357 org-quote-string))
20358 (goto-char (match-end 1))
20359 (looking-at (concat " +" org-quote-string))
20360 (replace-match "" t t)
20361 (when (eolp) (insert " ")))
20362 ((looking-at org-outline-regexp)
20363 (goto-char (match-end 0))
20364 (insert org-quote-string " ")))))))
20366 (defun org-reftex-citation ()
20367 "Use reftex-citation to insert a citation into the buffer.
20368 This looks for a line like
20370 #+BIBLIOGRAPHY: foo plain option:-d
20372 and derives from it that foo.bib is the bibliography file relevant
20373 for this document. It then installs the necessary environment for RefTeX
20374 to work in this buffer and calls `reftex-citation' to insert a citation
20375 into the buffer.
20377 Export of such citations to both LaTeX and HTML is handled by the contributed
20378 package org-exp-bibtex by Taru Karttunen."
20379 (interactive)
20380 (let ((reftex-docstruct-symbol 'rds)
20382 rds bib)
20383 (save-excursion
20384 (save-restriction
20385 (widen)
20386 (let ((case-fold-search t)
20388 (if (not (save-excursion
20389 (or (re-search-forward re nil t)
20390 (re-search-backward re nil t))))
20391 (error "No bibliography defined in file")
20392 (setq bib (concat (match-string 1) ".bib")
20393 rds (list (list 'bib bib)))))))
20394 (call-interactively 'reftex-citation)))
20396 ;;;; Functions extending outline functionality
20398 (defun org-beginning-of-line (&optional arg)
20399 "Go to the beginning of the current line. If that is invisible, continue
20400 to a visible line beginning. This makes the function of C-a more intuitive.
20401 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20402 first attempt, and only move to after the tags when the cursor is already
20403 beyond the end of the headline."
20404 (interactive "P")
20405 (let ((pos (point))
20406 (special (if (consp org-special-ctrl-a/e)
20407 (car org-special-ctrl-a/e)
20408 org-special-ctrl-a/e))
20409 refpos)
20410 (if (org-bound-and-true-p line-move-visual)
20411 (beginning-of-visual-line 1)
20412 (beginning-of-line 1))
20413 (if (and arg (fboundp 'move-beginning-of-line))
20414 (call-interactively 'move-beginning-of-line)
20415 (if (bobp)
20416 nil
20417 (backward-char 1)
20418 (if (org-truely-invisible-p)
20419 (while (and (not (bobp)) (org-truely-invisible-p))
20420 (backward-char 1)
20421 (beginning-of-line 1))
20422 (forward-char 1))))
20423 (when special
20424 (cond
20425 ((and (looking-at org-complex-heading-regexp)
20426 (= (char-after (match-end 1)) ?\ ))
20427 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20428 (point-at-eol)))
20429 (goto-char
20430 (if (eq special t)
20431 (cond ((> pos refpos) refpos)
20432 ((= pos (point)) refpos)
20433 (t (point)))
20434 (cond ((> pos (point)) (point))
20435 ((not (eq last-command this-command)) (point))
20436 (t refpos)))))
20437 ((org-at-item-p)
20438 (goto-char
20439 (if (eq special t)
20440 (cond ((> pos (match-end 0)) (match-end 0))
20441 ((= pos (point)) (match-end 0))
20442 (t (point)))
20443 (cond ((> pos (point)) (point))
20444 ((not (eq last-command this-command)) (point))
20445 (t (match-end 0))))))))
20446 (org-no-warnings
20447 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20449 (defun org-end-of-line (&optional arg)
20450 "Go to the end of the line.
20451 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20452 first attempt, and only move to after the tags when the cursor is already
20453 beyond the end of the headline."
20454 (interactive "P")
20455 (let ((special (if (consp org-special-ctrl-a/e)
20456 (cdr org-special-ctrl-a/e)
20457 org-special-ctrl-a/e)))
20458 (cond
20459 ((or (not special) arg
20460 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20461 (call-interactively
20462 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20463 ((fboundp 'move-end-of-line) 'move-end-of-line)
20464 (t 'end-of-line))))
20465 ((org-at-heading-p)
20466 (let ((pos (point)))
20467 (beginning-of-line 1)
20469 (if (eq special t)
20470 (if (or (< pos (match-beginning 1))
20471 (= pos (match-end 0)))
20472 (goto-char (match-beginning 1))
20473 (goto-char (match-end 0)))
20474 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20475 (goto-char (match-end 0))
20476 (goto-char (match-beginning 1))))
20477 (call-interactively (if (fboundp 'move-end-of-line)
20478 'move-end-of-line
20479 'end-of-line)))))
20480 ((org-at-drawer-p)
20481 (move-end-of-line 1)
20482 (when (overlays-at (1- (point))) (backward-char 1)))
20483 ;; At an item: Move before any hidden text.
20484 (t (call-interactively 'end-of-line)))
20485 (org-no-warnings
20486 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20488 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20489 (define-key org-mode-map "\C-e" 'org-end-of-line)
20491 (defun org-backward-sentence (&optional arg)
20492 "Go to beginning of sentence, or beginning of table field.
20493 This will call `backward-sentence' or `org-table-beginning-of-field',
20494 depending on context."
20495 (interactive "P")
20496 (cond
20497 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20498 (t (call-interactively 'backward-sentence))))
20500 (defun org-forward-sentence (&optional arg)
20501 "Go to end of sentence, or end of table field.
20502 This will call `forward-sentence' or `org-table-end-of-field',
20503 depending on context."
20504 (interactive "P")
20505 (cond
20506 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20507 (t (call-interactively 'forward-sentence))))
20509 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20510 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20512 (defun org-kill-line (&optional arg)
20513 "Kill line, to tags or end of line."
20514 (interactive "P")
20515 (cond
20516 ((or (not org-special-ctrl-k)
20517 (bolp)
20518 (not (org-at-heading-p)))
20519 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20520 org-ctrl-k-protect-subtree)
20521 (if (or (eq org-ctrl-k-protect-subtree 'error)
20522 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20523 (error "C-k aborted - would kill hidden subtree")))
20524 (call-interactively
20525 (if visual-line-mode 'kill-visual-line 'kill-line)))
20527 (kill-region (point) (match-beginning 1))
20528 (org-set-tags nil t))
20529 (t (kill-region (point) (point-at-eol)))))
20531 (define-key org-mode-map "\C-k" 'org-kill-line)
20533 (defun org-yank (&optional arg)
20534 "Yank. If the kill is a subtree, treat it specially.
20535 This command will look at the current kill and check if is a single
20536 subtree, or a series of subtrees[1]. If it passes the test, and if the
20537 cursor is at the beginning of a line or after the stars of a currently
20538 empty headline, then the yank is handled specially. How exactly depends
20539 on the value of the following variables, both set by default.
20541 org-yank-folded-subtrees
20542 When set, the subtree(s) will be folded after insertion, but only
20543 if doing so would now swallow text after the yanked text.
20545 org-yank-adjusted-subtrees
20546 When set, the subtree will be promoted or demoted in order to
20547 fit into the local outline tree structure, which means that the level
20548 will be adjusted so that it becomes the smaller one of the two
20549 *visible* surrounding headings.
20551 Any prefix to this command will cause `yank' to be called directly with
20553 will just
20554 plainly yank the text as it is.
20556 \[1] The test checks if the first non-white line is a heading
20557 and if there are no other headings with fewer stars."
20558 (interactive "P")
20559 (org-yank-generic 'yank arg))
20561 (defun org-yank-generic (command arg)
20562 "Perform some yank-like command.
20564 This function implements the behavior described in the `org-yank'
20565 documentation. However, it has been generalized to work for any
20566 interactive command with similar behavior."
20568 ;; pretend to be command COMMAND
20569 (setq this-command command)
20571 (if arg
20572 (call-interactively command)
20574 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20575 (and (org-kill-is-subtree-p)
20576 (or (bolp)
20578 (string-match
20580 (buffer-substring (point-at-bol) (point)))))))
20581 swallowp)
20582 (cond
20583 ((and subtreep org-yank-folded-subtrees)
20584 (let ((beg (point))
20585 end)
20586 (if (and subtreep org-yank-adjusted-subtrees)
20587 (org-paste-subtree nil nil 'for-yank)
20588 (call-interactively command))
20590 (setq end (point))
20591 (goto-char beg)
20592 (when (and (bolp) subtreep
20593 (not (setq swallowp
20594 (org-yank-folding-would-swallow-text beg end))))
20595 (org-with-limited-levels
20596 (or (looking-at org-outline-regexp)
20597 (re-search-forward org-outline-regexp-bol end t))
20598 (while (and (< (point) end) (looking-at org-outline-regexp))
20599 (hide-subtree)
20600 (org-cycle-show-empty-lines 'folded)
20601 (condition-case nil
20602 (outline-forward-same-level 1)
20603 (error (goto-char end))))))
20604 (when swallowp
20605 (message
20606 "Inserted text not folded because that would swallow text"))
20608 (goto-char end)
20610 (beginning-of-line 1)
20611 (push-mark beg 'nomsg)))
20612 ((and subtreep org-yank-adjusted-subtrees)
20613 (let ((beg (point-at-bol)))
20614 (org-paste-subtree nil nil 'for-yank)
20615 (push-mark beg 'nomsg)))
20616 (t
20617 (call-interactively command))))))
20619 (defun org-yank-folding-would-swallow-text (beg end)
20620 "Would hide-subtree at BEG swallow any text after END?"
20621 (let (level)
20622 (org-with-limited-levels
20623 (save-excursion
20624 (goto-char beg)
20625 (when (or (looking-at org-outline-regexp)
20626 (re-search-forward org-outline-regexp-bol end t))
20627 (setq level (org-outline-level)))
20628 (goto-char end)
20630 (if (or (eobp)
20631 (and (bolp) (looking-at org-outline-regexp)
20632 (<= (org-outline-level) level)))
20633 nil ; Nothing would be swallowed
20634 t))))) ; something would swallow
20636 (define-key org-mode-map "\C-y" 'org-yank)
20638 (defun org-truely-invisible-p ()
20639 "Check if point is at a character currently not visible.
20640 This version does not only check the character property, but also
20641 `visible-mode'."
20642 ;; Early versions of noutline don't have `outline-invisible-p'.
20643 (if (org-bound-and-true-p visible-mode)
20644 nil
20645 (outline-invisible-p)))
20647 (defun org-invisible-p2 ()
20648 "Check if point is at a character currently not visible."
20649 (save-excursion
20650 (if (and (eolp) (not (bobp))) (backward-char 1))
20651 ;; Early versions of noutline don't have `outline-invisible-p'.
20652 (outline-invisible-p)))
20654 (defun org-back-to-heading (&optional invisible-ok)
20655 "Call `outline-back-to-heading', but provide a better error message."
20656 (condition-case nil
20657 (outline-back-to-heading invisible-ok)
20658 (error (error "Before first headline at position %d in buffer %s"
20659 (point) (current-buffer)))))
20661 (defun org-beginning-of-defun ()
20662 "Go to the beginning of the subtree, i.e. back to the heading."
20663 (org-back-to-heading))
20664 (defun org-end-of-defun ()
20665 "Go to the end of the subtree."
20666 (org-end-of-subtree nil t))
20668 (defun org-before-first-heading-p ()
20669 "Before first heading?"
20670 (save-excursion
20671 (end-of-line)
20672 (null (re-search-backward org-outline-regexp-bol nil t))))
20674 (defun org-at-heading-p (&optional ignored)
20675 (outline-on-heading-p t))
20676 ;; Compatibility alias with Org versions < 7.8.03
20677 (defalias 'org-on-heading-p 'org-at-heading-p)
20679 (defun org-at-drawer-p nil
20680 "Whether point is at a drawer."
20681 (save-excursion
20682 (move-beginning-of-line 1)
20683 (looking-at org-drawer-regexp)))
20685 (defun org-point-at-end-of-empty-headline ()
20686 "If point is at the end of an empty headline, return t, else nil.
20687 If the heading only contains a TODO keyword, it is still still considered
20688 empty."
20690 (save-excursion
20691 (beginning-of-line 1)
20692 (let ((case-fold-search nil))
20693 (looking-at org-todo-line-regexp)))
20694 (string= (match-string 3) "")))
20696 (defun org-at-heading-or-item-p ()
20697 (or (org-at-heading-p) (org-at-item-p)))
20699 (defun org-at-target-p ()
20700 (or (org-in-regexp org-radio-target-regexp)
20701 (org-in-regexp org-target-regexp)))
20702 ;; Compatibility alias with Org versions < 7.8.03
20703 (defalias 'org-on-target-p 'org-at-target-p)
20705 (defun org-up-heading-all (arg)
20706 "Move to the heading line of which the present line is a subheading.
20707 This function considers both visible and invisible heading lines.
20708 With argument, move up ARG levels."
20709 (if (fboundp 'outline-up-heading-all)
20710 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20711 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20713 (defun org-up-heading-safe ()
20714 "Move to the heading line of which the present line is a subheading.
20715 This version will not throw an error. It will return the level of the
20716 headline found, or nil if no higher level is found.
20718 Also, this function will be a lot faster than `outline-up-heading',
20719 because it relies on stars being the outline starters. This can really
20720 make a significant difference in outlines with very many siblings."
20721 (let (start-level re)
20722 (org-back-to-heading t)
20723 (setq start-level (funcall outline-level))
20724 (if (equal start-level 1)
20725 nil
20727 (if (re-search-backward re nil t)
20728 (funcall outline-level)))))
20730 (defun org-first-sibling-p ()
20731 "Is this heading the first child of its parents?"
20732 (interactive)
20733 (let ((re org-outline-regexp-bol)
20734 level l)
20735 (unless (org-at-heading-p t)
20736 (error "Not at a heading"))
20737 (setq level (funcall outline-level))
20738 (save-excursion
20739 (if (not (re-search-backward re nil t))
20740 t
20741 (setq l (funcall outline-level))
20742 (< l level)))))
20744 (defun org-goto-sibling (&optional previous)
20745 "Goto the next sibling, even if it is invisible.
20746 When PREVIOUS is set, go to the previous sibling instead. Returns t
20747 when a sibling was found. When none is found, return nil and don't
20748 move point."
20749 (let ((fun (if previous 're-search-backward 're-search-forward))
20750 (pos (point))
20751 (re org-outline-regexp-bol)
20752 level l)
20753 (when (condition-case nil (org-back-to-heading t) (error nil))
20754 (setq level (funcall outline-level))
20755 (catch 'exit
20756 (or previous (forward-char 1))
20757 (while (funcall fun re nil t)
20758 (setq l (funcall outline-level))
20759 (when (< l level) (goto-char pos) (throw 'exit nil))
20760 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20761 (goto-char pos)
20762 nil))))
20764 (defun org-show-siblings ()
20765 "Show all siblings of the current headline."
20766 (save-excursion
20767 (while (org-goto-sibling) (org-flag-heading nil)))
20768 (save-excursion
20769 (while (org-goto-sibling 'previous)
20770 (org-flag-heading nil))))
20772 (defun org-goto-first-child ()
20773 "Goto the first child, even if it is invisible.
20774 Return t when a child was found. Otherwise don't move point and
20775 return nil."
20776 (let (level (pos (point)) (re org-outline-regexp-bol))
20777 (when (condition-case nil (org-back-to-heading t) (error nil))
20778 (setq level (outline-level))
20779 (forward-char 1)
20780 (if (and (re-search-forward re nil t) (> (outline-level) level))
20781 (progn (goto-char (match-beginning 0)) t)
20782 (goto-char pos) nil))))
20784 (defun org-show-hidden-entry ()
20785 "Show an entry where even the heading is hidden."
20786 (save-excursion
20787 (org-show-entry)))
20789 (defun org-flag-heading (flag &optional entry)
20790 "Flag the current heading. FLAG non-nil means make invisible.
20791 When ENTRY is non-nil, show the entire entry."
20792 (save-excursion
20793 (org-back-to-heading t)
20794 ;; Check if we should show the entire entry
20795 (if entry
20796 (progn
20797 (org-show-entry)
20798 (save-excursion
20799 (and (outline-next-heading)
20800 (org-flag-heading nil))))
20801 (outline-flag-region (max (point-min) (1- (point)))
20802 (save-excursion (outline-end-of-heading) (point))
20803 flag))))
20805 (defun org-get-next-sibling ()
20806 "Move to next heading of the same level, and return point.
20807 If there is no such heading, return nil.
20808 This is like outline-next-sibling, but invisible headings are ok."
20809 (let ((level (funcall outline-level)))
20810 (outline-next-heading)
20811 (while (and (not (eobp)) (> (funcall outline-level) level))
20812 (outline-next-heading))
20813 (if (or (eobp) (< (funcall outline-level) level))
20814 nil
20815 (point))))
20817 (defun org-get-last-sibling ()
20818 "Move to previous heading of the same level, and return point.
20819 If there is no such heading, return nil."
20820 (let ((opoint (point))
20821 (level (funcall outline-level)))
20822 (outline-previous-heading)
20823 (when (and (/= (point) opoint) (outline-on-heading-p t))
20824 (while (and (> (funcall outline-level) level)
20825 (not (bobp)))
20826 (outline-previous-heading))
20827 (if (< (funcall outline-level) level)
20828 nil
20829 (point)))))
20831 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20832 ;; This contains an exact copy of the original function, but it uses
20833 ;; `org-back-to-heading', to make it work also in invisible
20834 ;; trees. And is uses an invisible-OK argument.
20835 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20836 ;; Furthermore, when used inside Org, finding the end of a large subtree
20837 ;; with many children and grandchildren etc, this can be much faster
20838 ;; than the outline version.
20839 (org-back-to-heading invisible-OK)
20840 (let ((first t)
20841 (level (funcall outline-level)))
20842 (if (and (eq major-mode 'org-mode) (< level 1000))
20843 ;; A true heading (not a plain list item), in Org-mode
20844 ;; This means we can easily find the end by looking
20845 ;; only for the right number of stars. Using a regexp to do
20846 ;; this is so much faster than using a Lisp loop.
20848 (forward-char 1)
20849 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20850 ;; something else, do it the slow way
20851 (while (and (not (eobp))
20852 (or first (> (funcall outline-level) level)))
20853 (setq first nil)
20854 (outline-next-heading)))
20855 (unless to-heading
20857 (progn
20858 ;; Go to end of line before heading
20859 (forward-char -1)
20861 ;; leave blank line before heading
20862 (forward-char -1))))))
20863 (point))
20865 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20866 "Use Org version in org-mode, for dramatic speed-up."
20867 (if (eq major-mode 'org-mode)
20868 (progn
20869 (org-end-of-subtree nil t)
20870 (unless (eobp) (backward-char 1)))
20871 ad-do-it))
20873 (defun org-end-of-meta-data-and-drawers ()
20874 "Jump to the first text after meta data and drawers in the current entry.
20875 This will move over empty lines, lines with planning time stamps,
20876 clocking lines, and drawers."
20877 (org-back-to-heading t)
20878 (let ((end (save-excursion (outline-next-heading) (point)))
20881 (forward-line 1)
20882 (while (re-search-forward re end t)
20883 (if (not (match-end 1))
20884 ;; empty or planning line
20885 (forward-line 1)
20886 ;; a drawer, find the end
20888 (forward-line 1)))
20890 (point)))
20892 (defun org-forward-same-level (arg &optional invisible-ok)
20893 "Move forward to the arg'th subheading at same level as this one.
20894 Stop at the first and last subheadings of a superior heading.
20895 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20896 it wil also look at invisible ones."
20897 (interactive "p")
20898 (org-back-to-heading invisible-ok)
20899 (org-at-heading-p)
20900 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20902 l)
20903 (forward-char 1)
20904 (while (> arg 0)
20905 (while (and (re-search-forward re nil 'move)
20906 (setq l (- (match-end 0) (match-beginning 0) 1))
20907 (= l level)
20908 (not invisible-ok)
20909 (progn (backward-char 1) (outline-invisible-p)))
20910 (if (< l level) (setq arg 1)))
20911 (setq arg (1- arg)))
20912 (beginning-of-line 1)))
20914 (defun org-backward-same-level (arg &optional invisible-ok)
20915 "Move backward to the arg'th subheading at same level as this one.
20916 Stop at the first and last subheadings of a superior heading."
20917 (interactive "p")
20918 (org-back-to-heading)
20919 (org-at-heading-p)
20920 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20922 l)
20923 (while (> arg 0)
20924 (while (and (re-search-backward re nil 'move)
20925 (setq l (- (match-end 0) (match-beginning 0) 1))
20926 (= l level)
20927 (not invisible-ok)
20928 (outline-invisible-p))
20929 (if (< l level) (setq arg 1)))
20930 (setq arg (1- arg)))))
20932 (defun org-show-subtree ()
20933 "Show everything after this heading at deeper levels."
20934 (outline-flag-region
20935 (point)
20936 (save-excursion
20937 (org-end-of-subtree t t))
20938 nil))
20940 (defun org-show-entry ()
20941 "Show the body directly following this heading.
20942 Show the heading too, if it is currently invisible."
20943 (interactive)
20944 (save-excursion
20945 (condition-case nil
20946 (progn
20947 (org-back-to-heading t)
20948 (outline-flag-region
20949 (max (point-min) (1- (point)))
20950 (save-excursion
20951 (if (re-search-forward
20953 (match-beginning 1)
20954 (point-max)))
20955 nil)
20956 (org-cycle-hide-drawers 'children))
20957 (error nil))))
20959 (defun org-make-options-regexp (kwds &optional extra)
20960 "Make a regular expression for keyword lines."
20961 (concat
20962 "^"
20969 ;; Make isearch reveal the necessary context
20970 (defun org-isearch-end ()
20971 "Reveal context after isearch exits."
20972 (when isearch-success ; only if search was successful
20973 (if (featurep 'xemacs)
20974 ;; Under XEmacs, the hook is run in the correct place,
20975 ;; we directly show the context.
20976 (org-show-context 'isearch)
20977 ;; In Emacs the hook runs *before* restoring the overlays.
20978 ;; So we have to use a one-time post-command-hook to do this.
20979 ;; (Emacs 22 has a special variable, see function `org-mode')
20980 (unless (and (boundp 'isearch-mode-end-hook-quit)
20981 isearch-mode-end-hook-quit)
20982 ;; Only when the isearch was not quitted.
20983 (org-add-hook 'post-command-hook 'org-isearch-post-command
20984 'append 'local)))))
20986 (defun org-isearch-post-command ()
20987 "Remove self from hook, and show context."
20988 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20989 (org-show-context 'isearch))
20992 ;;;; Integration with and fixes for other packages
20994 ;;; Imenu support
20996 (defvar org-imenu-markers nil
20997 "All markers currently used by Imenu.")
20998 (make-variable-buffer-local 'org-imenu-markers)
21000 (defun org-imenu-new-marker (&optional pos)
21001 "Return a new marker for use by Imenu, and remember the marker."
21002 (let ((m (make-marker)))
21003 (move-marker m (or pos (point)))
21004 (push m org-imenu-markers)
21005 m))
21007 (defun org-imenu-get-tree ()
21008 "Produce the index for Imenu."
21009 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21010 (setq org-imenu-markers nil)
21011 (let* ((n org-imenu-depth)
21012 (re (concat "^" (org-get-limited-outline-regexp)))
21013 (subs (make-vector (1+ n) nil))
21014 (last-level 0)
21015 m level head)
21016 (save-excursion
21017 (save-restriction
21018 (widen)
21019 (goto-char (point-max))
21020 (while (re-search-backward re nil t)
21021 (setq level (org-reduced-level (funcall outline-level)))
21022 (when (<= level n)
21023 (looking-at org-complex-heading-regexp)
21024 (setq head (org-link-display-format
21025 (org-match-string-no-properties 4))
21026 m (org-imenu-new-marker))
21027 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21028 (if (>= level last-level)
21029 (push (cons head m) (aref subs level))
21030 (push (cons head (aref subs (1+ level))) (aref subs level))
21031 (loop for i from (1+ level) to n do (aset subs i nil)))
21032 (setq last-level level)))))
21033 (aref subs 1)))
21035 (eval-after-load "imenu"
21036 '(progn
21037 (add-hook 'imenu-after-jump-hook
21038 (lambda ()
21039 (if (eq major-mode 'org-mode)
21040 (org-show-context 'org-goto))))))
21042 (defun org-link-display-format (link)
21043 "Replace a link with either the description, or the link target
21044 if no description is present"
21045 (save-match-data
21046 (if (string-match org-bracket-link-analytic-regexp link)
21047 (replace-match (if (match-end 5)
21048 (match-string 5 link)
21049 (concat (match-string 1 link)
21050 (match-string 3 link)))
21051 nil t link)
21052 link)))
21054 (defun org-toggle-link-display ()
21055 "Toggle the literal or descriptive display of links."
21056 (interactive)
21057 (if org-descriptive-links
21058 (progn (org-remove-from-invisibility-spec '(org-link))
21059 (org-restart-font-lock)
21060 (setq org-descriptive-links nil))
21061 (progn (add-to-invisibility-spec '(org-link))
21062 (org-restart-font-lock)
21063 (setq org-descriptive-links t))))
21065 ;; Speedbar support
21067 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21068 "Overlay marking the agenda restriction line in speedbar.")
21069 (overlay-put org-speedbar-restriction-lock-overlay
21070 'face 'org-agenda-restriction-lock)
21071 (overlay-put org-speedbar-restriction-lock-overlay
21072 'help-echo "Agendas are currently limited to this item.")
21073 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21075 (defun org-speedbar-set-agenda-restriction ()
21076 "Restrict future agenda commands to the location at point in speedbar.
21078 (interactive)
21079 (require 'org-agenda)
21080 (let (p m tp np dir txt)
21081 (cond
21082 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21083 'org-imenu t))
21084 (setq m (get-text-property p 'org-imenu-marker))
21085 (with-current-buffer (marker-buffer m)
21086 (goto-char m)
21087 (org-agenda-set-restriction-lock 'subtree)))
21088 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21089 'speedbar-function 'speedbar-find-file))
21090 (setq tp (previous-single-property-change
21091 (1+ p) 'speedbar-function)
21092 np (next-single-property-change
21093 tp 'speedbar-function)
21094 dir (speedbar-line-directory)
21095 txt (buffer-substring-no-properties (or tp (point-min))
21096 (or np (point-max))))
21097 (with-current-buffer (find-file-noselect
21098 (let ((default-directory dir))
21099 (expand-file-name txt)))
21100 (unless (eq major-mode 'org-mode)
21101 (error "Cannot restrict to non-Org-mode file"))
21102 (org-agenda-set-restriction-lock 'file)))
21103 (t (error "Don't know how to restrict Org-mode's agenda")))
21104 (move-overlay org-speedbar-restriction-lock-overlay
21105 (point-at-bol) (point-at-eol))
21106 (setq current-prefix-arg nil)
21107 (org-agenda-maybe-redo)))
21109 (eval-after-load "speedbar"
21110 '(progn
21111 (speedbar-add-supported-extension ".org")
21112 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21113 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21114 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21115 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21116 (add-hook 'speedbar-visiting-tag-hook
21117 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21119 ;;; Fixes and Hacks for problems with other packages
21121 ;; Make flyspell not check words in links, to not mess up our keymap
21122 (defun org-mode-flyspell-verify ()
21123 "Don't let flyspell put overlays at active buttons, or on
21124 {todo,all-time,additional-option-like}-keywords."
21125 (let ((pos (max (1- (point)) (point-min)))
21126 (word (thing-at-point 'word)))
21127 (and (not (get-text-property pos 'keymap))
21128 (not (get-text-property pos 'org-no-flyspell))
21129 (not (member word org-todo-keywords-1))
21130 (not (member word org-all-time-keywords))
21131 (not (member word org-additional-option-like-keywords)))))
21133 (defun org-remove-flyspell-overlays-in (beg end)
21134 "Remove flyspell overlays in region."
21135 (and (org-bound-and-true-p flyspell-mode)
21136 (fboundp 'flyspell-delete-region-overlays)
21137 (flyspell-delete-region-overlays beg end))
21138 (add-text-properties beg end '(org-no-flyspell t)))
21140 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21141 (eval-after-load "bookmark"
21142 '(if (boundp 'bookmark-after-jump-hook)
21143 ;; We can use the hook
21144 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21145 ;; Hook not available, use advice
21146 (defadvice bookmark-jump (after org-make-visible activate)
21147 "Make the position visible."
21148 (org-bookmark-jump-unhide))))
21150 ;; Make sure saveplace shows the location if it was hidden
21151 (eval-after-load "saveplace"
21152 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21153 "Make the position visible."
21154 (org-bookmark-jump-unhide)))
21156 ;; Make sure ecb shows the location if it was hidden
21157 (eval-after-load "ecb"
21158 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21159 "Make hierarchy visible when jumping into location from ECB tree buffer."
21160 (if (eq major-mode 'org-mode)
21161 (org-show-context))))
21163 (defun org-bookmark-jump-unhide ()
21164 "Unhide the current position, to show the bookmark location."
21165 (and (eq major-mode 'org-mode)
21166 (or (outline-invisible-p)
21167 (save-excursion (goto-char (max (point-min) (1- (point))))
21168 (outline-invisible-p)))
21169 (org-show-context 'bookmark-jump)))
21171 ;; Make session.el ignore our circular variable
21172 (eval-after-load "session"
21173 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21175 ;;;; Experimental code
21177 (defun org-closed-in-range ()
21178 "Sparse tree of items closed in a certain time range.
21179 Still experimental, may disappear in the future."
21180 (interactive)
21181 ;; Get the time interval from the user.
21182 (let* ((time1 (org-float-time
21183 (org-read-date nil 'to-time nil "Starting date: ")))
21184 (time2 (org-float-time
21185 (org-read-date nil 'to-time nil "End date:")))
21186 ;; callback function
21187 (callback (lambda ()
21188 (let ((time
21189 (org-float-time
21190 (apply 'encode-time
21191 (org-parse-time-string
21192 (match-string 1))))))
21193 ;; check if time in interval
21194 (and (>= time time1) (<= time time2))))))
21195 ;; make tree, check each match with the callback
21198 ;;;; Finish up
21200 (provide 'org)
21202 (run-hooks 'org-load-hook)
21204 ;;; org.el ends here