| blob | b204b0b47f827637b8fd8284dd15512847448ba5 |
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)))
1555 "Setup the frame configuration for following links.
1556 When following a link with Emacs, it may often be useful to display
1557 this link in another window or frame. This variable can be used to
1558 set this up for the different types of links.
1559 For VM, use any of
1560 `vm-visit-folder'
1561 `vm-visit-folder-other-window'
1562 `vm-visit-folder-other-frame'
1563 For Gnus, use any of
1564 `gnus'
1565 `gnus-other-frame'
1566 `org-gnus-no-new-news'
1567 For FILE, use any of
1568 `find-file'
1569 `find-file-other-window'
1570 `find-file-other-frame'
1571 For Wanderlust use any of
1572 `wl'
1573 `wl-other-frame'
1574 For the calendar, use the variable `calendar-setup'.
1575 For BBDB, it is currently only possible to display the matches in
1576 another window."
1600 "Non-nil means use indirect buffer to display infile links.
1601 Activating internal links (from one location in a file to another location
1602 in the same file) normally just jumps to the location. When the link is
1604 is displayed in
1605 another window. When this option is set, the other window actually displays
1606 an indirect buffer clone of the current buffer, to avoid any visibility
1607 changes to the current buffer."
1612 "Non-nil means `org-open-file' will open non-existing files.
1613 When nil, an error will be generated.
1614 This variable applies only to external applications because they
1615 might choke on non-existing files. If the link is to a file that
1616 will be opened in Emacs, the variable is ignored."
1621 "Non-nil means a link to a directory really means to index.org.
1622 When nil, following a directory link will run dired or open a finder/explorer
1623 window on that directory."
1628 "Function and arguments to call for following mailto links.
1629 This is a list with the first element being a Lisp function, and the
1630 remaining elements being arguments to the function. In string arguments,
1631 %a will be replaced by the address, and %s will be replaced by the subject
1632 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1641 "Non-nil means ask for confirmation before executing shell links.
1642 Shell links can be dangerous: just think about a link
1644 [[shell:rm -rf ~/*][Google Search]]
1647 but really it would remove your entire home directory.
1648 Therefore we advise against setting this variable to nil.
1649 Just change it to `y-or-n-p' if you want to confirm with a
1657 'safe-local-variable
1661 "A regexp to skip confirmation for shell links."
1666 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1667 Elisp links can be dangerous: just think about a link
1672 but really it would remove your entire home directory.
1673 Therefore we advise against setting this variable to nil.
1674 Just change it to `y-or-n-p' if you want to confirm with a
1682 'safe-local-variable
1686 "A regexp to skip confirmation for Elisp links."
1694 "Default file applications on a UNIX or GNU/Linux system.
1705 "Default file applications on a MacOS X system.
1707 for some files for which the OS does not have a good default.
1715 'mswindows-shell-execute
1720 'mswindows-shell-execute
1723 "Default file applications on a Windows NT system.
1728 '(
1733 )
1734 "External applications for opening `file:path' items in a document.
1735 Org-mode uses system defaults for different file types, but
1736 you can use this variable to set the application for a given file
1737 extension. The entries in this list are cons cells where the car identifies
1738 files and the cdr the corresponding command. Possible values for the
1739 file identifier are
1741 ways, depending on its contents:
1743 - Alphanumeric characters only:
1744 Match links with this file extension.
1746 to open PDFs with evince.
1748 - Regular expression: Match links where the
1749 filename matches the regexp. If you want to
1750 use groups here, use shy groups.
1754 to open *.html and *.xhtml with firefox.
1756 - Regular expression which contains (non-shy) groups:
1758 anything after that, matches the regexp.
1759 In a custom command string, %1, %2, etc. are replaced with
1760 the parts of the link that were matched by the groups.
1761 For backwards compatibility, if a command string is given
1762 that does not use any of the group matches, this case is
1763 handled identically to the second one (i.e. match against
1764 file name only).
1765 In a custom lisp form, you can access the group matches with
1766 (match-string n link).
1769 to open [[file:document.pdf::5]] with evince at page 5.
1771 `directory' Matches a directory
1772 `remote' Matches a remote file, accessible through tramp or efs.
1773 Remote files most likely should be visited through Emacs
1774 because external applications cannot handle such paths.
1775 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1776 so all files Emacs knows how to handle. Using this with
1777 command `emacs' will open most files in Emacs. Beware that this
1778 will also open html files inside Emacs, unless you add
1780 t Default for files not matched by any of the other options.
1781 `system' The system command to open files, like `open' on Windows
1782 and Mac OS X, and mailcap under GNU/Linux. This is the command
1783 that will be selected if you call `C-c C-o' with a double
1786 Possible values for the command are:
1787 `emacs' The file will be visited by the current Emacs process.
1788 `default' Use the default application for this file type, which is the
1789 association for t in the list, most likely in the system-specific
1790 part.
1791 This can be used to overrule an unwanted setting in the
1792 system-specific variable.
1794 This command is specified by the entry whose car is `system'.
1795 Most likely, the system-specific version of this variable
1796 does define this command, but you can overrule/replace it
1797 here.
1798 string A command to be executed by a shell; %s will be replaced
1799 by the path to the file.
1800 sexp A Lisp form which will be evaluated. The file path will
1801 be available in the Lisp variable `file'.
1802 For more examples, see the system specific constants
1803 `org-file-apps-defaults-macosx'
1804 `org-file-apps-defaults-windowsnt'
1805 `org-file-apps-defaults-gnu'."
1815 auto-mode))
1826 "Options concerning refiling entries in Org-mode."
1831 "Directory with org files.
1832 This is just a default location to look for Org files. There is no need
1833 at all to put your files into this directory. It is only used in the
1834 following situations:
1836 1. When a remember template specifies a target file that is not an
1837 absolute path. The path will then be interpreted relative to
1838 `org-directory'
1839 2. When a remember note is filed away in an interactive way (when exiting the
1840 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1841 with `org-directory' as the default path."
1847 "Default target for storing notes.
1848 Used as a fall back file for org-remember.el and org-capture.el, for
1849 templates that do not specify a target file."
1854 file))
1857 "The default interface to be used for `org-goto'.
1858 Allowed values are:
1859 outline The interface shows an outline of the relevant file
1860 and the correct heading is found by moving through
1861 the outline or by searching with incremental search.
1862 outline-path-completion Headlines in the current buffer are offered via
1863 completion. This is the interface also used by
1864 the refile command."
1871 "Maximum target level when running `org-goto' with refile interface."
1876 "Non-nil means store new notes at the beginning of a file or entry.
1877 When nil, new notes will be filed to the end of a file or entry.
1878 This can also be a list with cons cells of regular expressions that
1879 are matched against file names, and values."
1889 "Information to record when a task is refiled.
1891 Possible values are:
1893 nil Don't add anything
1894 time Add a time stamp to the task
1895 note Prompt for a note and add it with template `org-log-note-headings'
1897 This option can also be set with on a per-file-basis with
1899 #+STARTUP: nologrefile
1900 #+STARTUP: logrefile
1901 #+STARTUP: lognoterefile
1903 You can have local logging settings for a subtree by setting the LOGGING
1904 property to one or more of these keywords.
1906 When bulk-refiling from the agenda, the value `note' is forbidden and
1907 will temporarily be changed to `time'."
1917 This is a list of cons cells. Each cell contains:
1918 - a specification of the files to be considered, either a list of files,
1919 or a symbol whose function or variable value will be used to retrieve
1920 a file name or a list of file names. If you use `org-agenda-files' for
1921 that, all agenda files will be scanned for targets. Nil means consider
1922 headings in the current buffer.
1923 - A specification of how to find candidate refile targets. This may be
1924 any of:
1926 This tag has to be present in all target headlines, inheritance will
1927 not be considered.
1929 todo keyword.
1931 headlines that are refiling targets.
1932 - a cons cell (:level . N). Any headline of level N is considered a target.
1933 Note that, when `org-odd-levels-only' is set, level corresponds to
1934 order in hierarchy, not to the number of stars.
1935 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1936 Note that, when `org-odd-levels-only' is set, level corresponds to
1937 order in hierarchy, not to the number of stars.
1939 Each element of this list generates a set of possible targets.
1940 The union of these sets is presented (with completion) to
1941 the user by `org-refile'.
1943 You can set the variable `org-refile-target-verify-function' to a function
1944 to verify each headline found by the simple criteria above.
1946 When this variable is nil, all top-level headlines in the current buffer
1947 are used, equivalent to the value `((nil . (:level . 1))'."
1963 "Function to verify if the headline at point should be a refile target.
1964 The function will be called without arguments, with point at the
1965 beginning of the headline. It should return t and leave point
1966 where it is if the headline is a valid target for refiling.
1968 If the target should not be selected, the function must return nil.
1969 In addition to this, it may move point to a place from where the search
1970 should be continued. For example, the function may decide that the entire
1971 subtree of the current entry should be excluded and move point to the end
1972 of the subtree."
1977 "Non-nil means cache refile targets to speed up the process.
1978 The cache for a particular file will be updated automatically when
1979 the buffer has been killed, or when any of the marker used for flagging
1980 refile targets no longer points at a live buffer.
1981 If you have added new entries to a buffer that might themselves be targets,
1982 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1983 find that easier, `C-u C-u C-u C-c C-w'."
1988 "Non-nil means provide refile targets as paths.
1989 So a level 3 headline will be available as level1/level2/level3.
1991 When the value is `file', also include the file name (without directory)
1992 into the path. In this case, you can also stop the completion after
1993 the file name, to get entries inserted as top level in the file.
1995 When `full-file-path', include the full file path."
2004 "Non-nil means complete the outline path in hierarchical steps.
2005 When Org-mode uses the refile interface to select an outline path
2006 \(see variable `org-refile-use-outline-path'), the completion of
2007 the path can be done is a single go, or if can be done in steps down
2008 the headline hierarchy. Going in steps is probably the best if you
2009 do not use a special completion package like `ido' or `icicles'.
2010 However, when using these packages, going in one step can be very
2011 fast, while still showing the whole path to the entry."
2016 "Non-nil means allow to create new nodes as refile targets.
2018 of an existing node. When the value of this variable is `confirm',
2019 new node creation must be confirmed by the user (recommended)
2020 When nil, the completion must match an existing entry.
2022 Note that, if the new heading is not seen by the criteria
2023 listed in `org-refile-targets', multiple instances of the same
2024 heading would be created by trying again to file under the new
2025 heading."
2033 "Non-nil means also refile active region within a subtree.
2035 By default `org-refile' doesn't allow refiling regions if they
2036 don't contain a set of subtrees, but it might be convenient to
2037 do so sometimes: in that case, the first line of the region is
2038 converted to a headline before refiling."
2043 "Options concerning TODO items in Org-mode."
2048 "Options concerning Progress logging in Org-mode."
2055 "The available interpretation symbols for customizing `org-todo-keywords'.
2059 "List of TODO entry keyword sequences and their interpretation.
2062 Each sequence starts with a symbol, either `sequence' or `type',
2063 indicating if the keywords should be interpreted as a sequence of
2064 action steps, or as different types of TODO items. The first
2065 keywords are states requiring action - these states will select a headline
2066 for inclusion into the global TODO list Org-mode produces. If one of
2069 the last keyword is treated as the only DONE state of the sequence.
2072 additional state where no keyword is present. For details about this
2073 cycling, see the manual.
2075 TODO keywords and interpretation can also be set on a per-file basis with
2076 the special #+SEQ_TODO and #+TYP_TODO lines.
2078 Each keyword can optionally specify a character for fast state selection
2079 \(in combination with the variable `org-use-fast-todo-selection')
2080 and specifiers for state change logging, using the same syntax
2083 indicates to record a time stamp each time this state is selected.
2085 Each keyword may also specify if a timestamp or a note should be
2086 recorded when entering or leaving the state, by adding additional
2087 characters in the parenthesis after the keyword. This looks like this:
2089 record only the time of the state change. With X and Y being either
2091 Y when leaving the state if and only if the *target* state does not
2092 define X. You may omit any of the fast-selection key or X or /Y,
2093 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2095 For backward compatibility, this variable may also be just a list
2096 of keywords - in this case the interpretation (sequence or type) will be
2097 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2107 ;;Quick and dirty way to see
2108 ;;`org-todo-interpretations'. This takes the
2109 ;;place of item arguments
2110 :convert-widget
2117 org-todo-interpretation-widgets))
2118 widget))
2149 "Controls how TODO keywords are interpreted.
2150 This variable is in principle obsolete and is only used for
2151 backward compatibility, if the interpretation of todo keywords is
2152 not given already in `org-todo-keywords'. See that variable for
2153 more information."
2160 "Non-nil means use the fast todo selection scheme with C-c C-t.
2161 This variable describes if and under what circumstances the cycling
2162 mechanism for TODO keywords will be replaced by a single-key, direct
2163 selection scheme.
2165 When nil, fast selection is never used.
2167 When the symbol `prefix', it will be used when `org-todo' is called with
2168 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2169 in an agenda buffer.
2171 When t, fast selection is used by default. In this case, the prefix
2172 argument forces cycling instead.
2174 In all cases, the special interface is only used if access keys have actually
2175 been assigned by the user, i.e. if keywords in the configuration are followed
2176 by a letter in parenthesis, like TODO(t)."
2184 "Non-nil means update todo statistics after insert and toggle.
2185 ALL-HEADLINES means update todo statistics by including headlines
2186 with no TODO keyword as well, counting them as not done.
2187 A list of TODO keywords means the same, but skip keywords that are
2188 not in this list.
2190 When this is set, todo statistics is updated in the parent of the
2191 current entry each time a todo state is changed."
2201 "Non-nil means TODO statistics covers just direct children.
2202 When nil, all entries in the subtree are considered.
2203 This has only an effect if `org-provide-todo-statistics' is set.
2204 To set this to nil for only a single subtree, use a COOKIE_DATA
2210 "Hook which is run after the state of a TODO item was changed.
2211 The new state (a string with a TODO keyword, or nil) is available in the
2212 Lisp variable `state'."
2217 "Hook for functions that are allowed to block a state change.
2219 Each function gets as its single argument a property list, see
2220 `org-trigger-hook' for more information about this list.
2222 If any of the functions in this hook returns nil, the state change
2226 "Hook for functions that are triggered by a state change.
2228 Each function gets as its single argument a property list with at least
2229 the following elements:
2231 (:type type-of-change :position pos-at-entry-start
2232 :from old-state :to new-state)
2234 Depending on the type, more properties may be present.
2236 This mechanism is currently implemented for:
2238 TODO state changes
2239 ------------------
2240 :type todo-state-change
2241 :from previous state (keyword as a string), or nil, or a symbol
2242 'todo' or 'done', to indicate the general type of state.
2246 "Non-nil means undone TODO entries will block switching the parent to DONE.
2247 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2248 be blocked if any prior sibling is not yet done.
2249 Finally, if the parent is blocked because of ordered siblings of its own,
2250 the child will also be blocked.
2251 This variable needs to be set before org.el is loaded, and you need to
2252 restart Emacs after a change to make the change effective. The only way
2253 to change is while Emacs is running is through the customize interface."
2265 "Non-nil means unchecked boxes will block switching the parent to DONE.
2266 When this is nil, checkboxes have no influence on switching TODO states.
2267 When non-nil, you first need to check off all check boxes before the TODO
2268 entry can be switched to DONE.
2269 This variable needs to be set before org.el is loaded, and you need to
2270 restart Emacs after a change to make the change effective. The only way
2271 to change is while Emacs is running is through the customize interface."
2283 "Non-nil means inserting a TODO heading is treated as state change.
2285 logging will apply if appropriate. When nil, the new TODO item will
2286 be inserted directly, and no logging will take place."
2291 "Non-nil means switching TODO states with S-cursor counts as state change.
2292 This is the default behavior. However, setting this to nil allows a
2293 convenient way to select a TODO state and bypass any logging associated
2294 with that."
2299 "Tag changes that should be triggered by TODO state changes.
2300 This is a list. Each entry is
2302 (state-change (tag . flag) .......)
2304 State-change can be a string with a state, and empty string to indicate the
2305 state that has no TODO keyword, or it can be one of the symbols `todo'
2306 or `done', meaning any not-done or done state, respectively."
2320 "Information to record when a task moves to the DONE state.
2322 Possible values are:
2324 nil Don't add anything, just change the keyword
2325 time Add a time stamp to the task
2326 note Prompt for a note and add it with template `org-log-note-headings'
2328 This option can also be set with on a per-file-basis with
2330 #+STARTUP: nologdone
2331 #+STARTUP: logdone
2332 #+STARTUP: lognotedone
2334 You can have local logging settings for a subtree by setting the LOGGING
2335 property to one or more of these keywords."
2343 ;; Normalize old uses of org-log-done.
2350 "Information to record when the scheduling date of a tasks is modified.
2352 Possible values are:
2354 nil Don't add anything, just change the date
2355 time Add a time stamp to the task
2356 note Prompt for a note and add it with template `org-log-note-headings'
2358 This option can also be set with on a per-file-basis with
2360 #+STARTUP: nologreschedule
2361 #+STARTUP: logreschedule
2362 #+STARTUP: lognotereschedule"
2371 "Information to record when the deadline date of a tasks is modified.
2373 Possible values are:
2375 nil Don't add anything, just change the date
2376 time Add a time stamp to the task
2377 note Prompt for a note and add it with template `org-log-note-headings'
2379 This option can also be set with on a per-file-basis with
2381 #+STARTUP: nologredeadline
2382 #+STARTUP: logredeadline
2383 #+STARTUP: lognoteredeadline
2385 You can have local logging settings for a subtree by setting the LOGGING
2386 property to one or more of these keywords."
2395 "Non-nil means record a note when clocking out of an item.
2396 This can also be configured on a per-file basis by adding one of
2397 the following lines anywhere in the buffer:
2399 #+STARTUP: lognoteclock-out
2400 #+STARTUP: nolognoteclock-out"
2406 "Non-nil means the CLOSED time stamp will contain date and time.
2407 When nil, only the date will be recorded."
2421 "Headings for notes added to entries.
2422 The value is an alist, with the car being a symbol indicating the note
2423 context, and the cdr is the heading to be used. The heading may also be the
2424 empty string.
2425 %t in the heading will be replaced by a time stamp.
2426 %T will be an active time stamp instead the default inactive one
2427 %d will be replaced by a short-format time stamp.
2428 %D will be replaced by an active short-format time stamp.
2429 %s will be replaced by the new TODO state, in double quotes.
2430 %S will be replaced by the old TODO state, in double quotes.
2431 %u will be replaced by the user name.
2432 %U will be replaced by the full user name.
2434 In fact, it is not a good idea to change the `state' entry, because
2435 agenda log mode depends on the format of these entries."
2441 "Heading when changing todo state (todo sequence only)"
2455 "Non-nil means insert state change notes and time stamps into a drawer.
2456 When nil, state changes notes will be inserted after the headline and
2457 any scheduling and clock lines, but not inside a drawer.
2459 The value of this variable should be the name of the drawer to use.
2460 LOGBOOK is proposed as the default drawer for this purpose, you can
2461 also set this to a string to define the drawer of your choice.
2465 If this variable is set, `org-log-state-notes-insert-after-drawers'
2466 will be ignored.
2468 You can set the property LOG_INTO_DRAWER to overrule this setting for
2469 a subtree."
2481 "Return the value of `org-log-into-drawer', but let properties overrule.
2482 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2483 used instead of the default value."
2491 "Non-nil means insert state change notes after any drawers in entry.
2492 Only the drawers that *immediately* follow the headline and the
2493 deadline/scheduled line are skipped.
2494 When nil, insert notes right after the heading and perhaps the line
2495 with deadline/scheduling if present.
2497 This variable will have no effect if `org-log-into-drawer' is
2498 set."
2504 "Non-nil means the latest state note will be directly after heading.
2505 When nil, the state change notes will be ordered according to time."
2511 "The TODO state to which a repeater should return the repeating task.
2512 By default this is the first task in a TODO sequence, or the previous state
2513 in a TODO_TYP set. But you can specify another task here.
2514 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2520 "Non-nil means record moving through the DONE state when triggering repeat.
2521 An auto-repeating task is immediately switched back to TODO when
2524 record a closing note, there will be no record of the task moving
2525 through DONE. This variable forces taking a note anyway.
2527 nil Don't force a record
2528 time Record a time stamp
2529 note Record a note
2531 This option can also be set with on a per-file-basis with
2533 #+STARTUP: logrepeat
2534 #+STARTUP: lognoterepeat
2535 #+STARTUP: nologrepeat
2537 You can have local logging settings for a subtree by setting the LOGGING
2538 property to one or more of these keywords."
2548 "Priorities in Org-mode."
2553 "Non-nil means priority commands are active.
2554 When nil, these commands will be disabled, so that you never accidentally
2555 set a priority."
2560 "The highest priority of TODO items. A character like ?A, ?B etc.
2561 Must have a smaller ASCII number than `org-lowest-priority'."
2566 "The lowest priority of TODO items. A character like ?A, ?B etc.
2567 Must have a larger ASCII number than `org-highest-priority'."
2572 "The default priority of TODO items.
2573 This is the priority an item gets if no explicit priority is given.
2574 When starting to cycle on an empty priority the first step in the cycle
2575 depends on `org-priority-start-cycle-with-default'. The resulting first
2576 step priority must not exceed the range from `org-highest-priority' to
2577 `org-lowest-priority' which means that `org-default-priority' has to be
2578 in this range exclusive or inclusive the range boundaries. Else the
2579 first step refuses to set the default and the second will fall back
2580 to (depending on the command used) the highest or lowest priority."
2585 "Non-nil means start with default priority when starting to cycle.
2586 When this is nil, the first step in the cycle will be (depending on the
2587 command used) one higher or lower than the default priority.
2588 See also `org-default-priority'."
2593 "Function to extract the priority from a string.
2594 The string is normally the headline. If this is nil Org computes the
2595 priority from the priority cookie like [#A] in the headline. It returns
2596 an integer, increasing by 1000 for each priority level.
2597 The user can set a different function here, which should take a string
2598 as an argument and return the numeric priority."
2603 "Options concerning time stamps and deadlines in Org-mode."
2608 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2609 When nil, these labeled time stamps are forces into the second line of an
2610 entry, just after the headline. When scheduling from the global TODO list,
2611 the time stamp will always be forced into the second line."
2616 "Formats for `format-time-string' which are used for time stamps.
2620 "Number of minutes to round time stamps to.
2621 These are two values, the first applies when first creating a time stamp.
2622 The second applies when changing it with the commands `S-up' and `S-down'.
2623 When changing the time stamp, this means that it will change in steps
2624 of N minutes, as given by the second value.
2626 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2627 numbers should be factors of 60, so for example 5, 10, 15.
2629 When this is larger than 1, you can still force an exact time stamp by using
2630 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2631 and by using a prefix arg to `S-up/down' to specify the exact number
2632 of minutes to shift."
2642 ;; Normalize old customizations of this variable.
2646 org-time-stamp-rounding-minutes)))
2649 "Non-nil means overlay custom formats over all time stamps.
2650 The formats are defined through the variable `org-time-stamp-custom-formats'.
2651 To turn this on on a per-file basis, insert anywhere in the file:
2652 #+STARTUP: customtime"
2660 "Custom formats for time stamps. See `format-time-string' for the syntax.
2661 These are overlaid over the default ISO format if the variable
2662 `org-display-custom-times' is set. Time like %H:%M should be at the
2663 end of the second format. The custom formats are also honored by export
2664 commands, if custom time display is turned on at the time of export."
2669 "Get the right format for a time string."
2674 f)))
2677 "The format string used when creating CLOCKSUM lines.
2678 This is also used when org-mode generates a time duration."
2684 org-mode generates a time duration."
2689 "The format string used when creating CLOCKSUM lines, or when
2690 org-mode generates a time duration."
2695 "No. of days before expiration during which a deadline becomes active.
2696 This variable governs the display in sparse trees and in the agenda.
2697 When 0 or negative, it means use this number (the absolute value of it)
2698 even if a deadline has a different individual lead time specified.
2700 Custom commands can set this variable in the options section."
2706 "Non-nil means assume future for incomplete date input from user.
2707 This affects the following situations:
2708 1. The user gives a month but not a year.
2711 2. The user gives a day, but no month.
2714 it will be considered as *this* month.
2716 If you set this variable to the symbol `time', then also the following
2717 will work:
2719 3. If the user gives a time, but no day. If the time is before now,
2720 to will be interpreted as tomorrow.
2722 Currently none of this works for ISO week specifications.
2724 When this option is nil, the current day, month and year will always be
2725 used as defaults.
2727 See also `org-agenda-jump-prefer-future'."
2735 "Should the agenda jump command prefer the future for incomplete dates?
2736 The default is to do the same as configured in `org-read-date-prefer-future'.
2737 But you can also set a deviating value here.
2738 This may t or nil, or the symbol `org-read-date-prefer-future'."
2743 org-read-date-prefer-future)
2748 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2750 Depending on the system Emacs is running on, certain dates cannot
2751 be represented with the type used internally to represent time.
2752 Dates between 1970-1-1 and 2038-1-1 can always be represented
2753 correctly. Some systems allow for earlier dates, some for later,
2754 some for both. One way to find out it to insert any date into an
2755 Org buffer, putting the cursor on the year and hitting S-up and
2756 S-down to test the range.
2758 When this variable is set to t, the date/time prompt will not let
2759 you specify dates outside the 1970-2037 range, so it is certain that
2760 these dates will work in whatever version of Emacs you are
2761 running, and also that you can move a file from one Emacs implementation
2762 to another. WHenever Org is forcing the year for you, it will display
2763 a message and beep.
2765 When this variable is nil, Org will check if the date is
2766 representable in the specific Emacs implementation you are using.
2767 If not, it will force a year, usually the current year, and beep
2768 to remind you. Currently this setting is not recommended because
2769 the likelihood that you will open your Org files in an Emacs that
2770 has limited date range is not negligible.
2772 A workaround for this problem is to use diary sexp dates for time
2773 stamps outside of this range."
2778 "Non-nil means display current interpretation of date prompt live.
2779 This display will be in an overlay, in the minibuffer."
2784 "Non-nil means pop up a calendar when prompting for a date.
2785 In the calendar, the date can be selected with mouse-1. However, the
2786 minibuffer will also be active, and you can simply enter the date as well.
2787 When nil, only the minibuffer will be available."
2795 "Hook to be used to set up keys for the date/time interface.
2796 Add key definitions to `minibuffer-local-map', which will be a temporary
2797 copy."
2802 "The hour when your day really ends. Must be an integer.
2803 This has influence for the following applications:
2805 the time given here, the day recognized as TODAY is actually yesterday.
2806 - When a date is read from the user and it is still before the time given
2807 here, the current date and time will be assumed to be yesterday, 23:59.
2808 Also, timestamps inserted in remember templates follow this rule.
2810 IMPORTANT: This is a feature whose implementation is and likely will
2811 remain incomplete. Really, it is only here because past midnight seems to
2812 be the favorite working time of John Wiegley :-)"
2817 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2818 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2820 23:59 of the previous day."
2825 "Non-nil means S-down will increase the time in a time stamp.
2826 When nil, S-up will increase."
2831 "Non-nil means make the calendar window follow timestamp changes.
2832 When a timestamp is modified and the calendar window is visible, it will be
2833 moved to the new date."
2838 "Options concerning tags in Org-mode."
2843 "List of tags allowed in Org-mode files.
2844 When this list is nil, Org-mode will base TAG input on what is already in the
2845 buffer.
2846 The value of this variable is an alist, the car of each entry must be a
2847 keyword as a string, the cdr may be a character that is used to select
2848 that tag through the fast-tag-selection interface.
2849 See the manual for details."
2864 "List of tags that will always appear in all Org-mode files.
2865 This is in addition to any in buffer settings or customizations
2866 of `org-tag-alist'.
2867 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2868 The value of this variable is an alist, the car of each entry must be a
2869 keyword as a string, the cdr may be a character that is used to select
2870 that tag through the fast-tag-selection interface.
2871 See the manual for details.
2872 To disable these tags on a per-file basis, insert anywhere in the file:
2873 #+STARTUP: noptag"
2884 "If non-nil, always offer completion for all tags of all agenda files.
2885 Instead of customizing this variable directly, you might want to
2886 set it locally for capture buffers, because there no list of
2887 tags in that file can be created dynamically (there are none).
2889 (add-hook 'org-capture-mode-hook
2890 (lambda ()
2891 (set (make-local-variable
2892 'org-complete-tags-always-offer-all-agenda-tags)
2893 t)))"
2898 "List of tags that can be inherited by all entries in the file.
2899 The tags will be inherited if the variable `org-use-tag-inheritance'
2900 says they should be.
2904 "Non-nil means use fast tag selection scheme.
2905 This is a special interface to select and deselect tags with single keys.
2906 When nil, fast selection is never used.
2907 When the symbol `auto', fast selection is used if and only if selection
2908 characters for tags have been configured, either through the variable
2909 `org-tag-alist' or through a #+TAGS line in the buffer.
2910 When t, fast selection is always used and selection keys are assigned
2911 automatically if necessary."
2919 "Non-nil means fast tag selection exits after first change.
2920 When nil, you have to press RET to exit it.
2921 During fast tag selection, you can toggle this flag with `C-c'.
2922 This variable can also have the value `expert'. In this case, the window
2923 displaying the tags menu is not even shown, until you press C-c again."
2931 "Non-nil means fast tags selection interface will also offer TODO states.
2935 "The column to which tags should be indented in a headline.
2936 If this number is positive, it specifies the column. If it is negative,
2937 it means that the tags should be flushright to that column. For example,
2938 -80 works well for a normal 80 character screen.
2939 When 0, place tags directly after headline text, with only one space in
2940 between."
2945 "Non-nil keeps tags aligned when modifying headlines.
2946 Some operations (i.e. demoting) change the length of a headline and
2947 therefore shift the tags around. With this option turned on, after
2948 each such operation the tags are again aligned to `org-tags-column'."
2953 "Non-nil means tags in levels apply also for sublevels.
2954 When nil, only the tags directly given in a specific line apply there.
2955 This may also be a list of tags that should be inherited, or a regexp that
2956 matches tags that should be inherited. Additional control is possible
2957 with the variable `org-tags-exclude-from-inheritance' which gives an
2958 explicit list of tags to be excluded from inheritance., even if the value of
2959 `org-use-tag-inheritance' would select it for inheritance.
2961 If this option is t, a match early-on in a tree can lead to a large
2962 number of matches in the subtree when constructing the agenda or creating
2963 a sparse tree. If you only want to see the first match in a tree during
2964 a search, check out the variable `org-tags-match-list-sublevels'."
2973 "List of tags that should never be inherited.
2974 This is a way to exclude a few tags from inheritance. For way to do
2975 the opposite, to actively allow inheritance for selected tags,
2976 see the variable `org-use-tag-inheritance'."
2981 "Check if TAG is one that should be inherited."
2993 "Non-nil means list also sublevels of headlines matching a search.
2994 This variable applies to tags/property searches, and also to stuck
2995 projects because this search is based on a tags match as well.
2997 When set to the symbol `indented', sublevels are indented with
2998 leading dots.
3000 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3001 the sublevels of a headline matching a tag search often also match
3002 the same search. Listing all of them can create very long lists.
3003 Setting this variable to nil causes subtrees of a match to be skipped.
3005 This variable is semi-obsolete and probably should always be true. It
3006 is better to limit inheritance to certain tags using the variables
3007 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3015 "When set, tags are sorted using this function as a comparator."
3031 "Options concerning properties in Org-mode."
3036 "How property key/value pairs should be formatted by `indent-line'.
3037 When `indent-line' hits a property definition, it will format the line
3038 according to this format, mainly to make sure that the values are
3039 lined-up with respect to each other."
3044 "Alist of properties and functions to adjust inserted values.
3045 Elements of this alist must be of the form
3047 ([string] [function])
3049 where [string] must be a property name and [function] must be a
3050 lambda expression: this lambda expression must take one argument,
3051 the value to adjust, and return the new value as a string.
3055 and the clock summary:
3058 (let ((clocksum (org-clock-sum-current-item))
3059 (effort (org-duration-string-to-minutes
3061 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3066 "Non-nil means properties apply also for sublevels.
3068 This setting is chiefly used during property searches. Turning it on can
3069 cause significant overhead when doing a search, which is why it is not
3070 on by default.
3072 When nil, only the properties directly given in the current entry count.
3073 When t, every property is inherited. The value may also be a list of
3074 properties that should have inheritance, or a regular expression matching
3075 properties that should be inherited.
3077 However, note that some special properties use inheritance under special
3078 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3080 for valid values of a property.
3082 Note for programmers:
3083 When querying an entry with `org-entry-get', you can control if inheritance
3084 should be used. By default, `org-entry-get' looks only at the local
3085 properties. You can request inheritance by setting the inherit argument
3086 to t (to force inheritance) or to `selective' (to respect the setting
3087 in this variable)."
3096 "Check if PROPERTY is one that should be inherited."
3107 "The default column format, if no other format has been defined.
3108 This variable can be set on the per-file basis by inserting a line
3110 #+COLUMNS: %25ITEM ....."
3115 "The ellipses to be used when a field in column view is truncated.
3116 When this is the empty string, as many characters as possible are shown,
3117 but then there will be no visual indication that the field has been truncated.
3118 When this is a string of length N, the last N characters of a truncated
3119 field are replaced by this string. If the column is narrower than the
3120 ellipses string, only part of the ellipses string will be shown."
3125 "Function that modifies values for display in column view.
3126 For example, it can be used to cut out a certain part from a time stamp.
3127 The function must take 2 arguments:
3129 column-title The title of the column (*not* the property name)
3130 value The value that should be modified.
3132 The function should return the value that should be displayed,
3133 or nil if the normal value should be used."
3138 "The property that is being used to keep track of effort estimates.
3139 Effort estimates given in this property need to have the format H:MM."
3147 "List of property/value pairs that can be inherited by any entry.
3149 These are fixed values, for the preset properties. The user variable
3150 that can be used to add to this list is `org-global-properties'.
3152 The entries in this list are cons cells where the car is a property
3153 name and cdr is a string with the value. If the value represents
3158 "List of property/value pairs that can be inherited by any entry.
3160 This list will be combined with the constant `org-global-properties-fixed'.
3162 The entries in this list are cons cells where the car is a property
3163 name and cdr is a string with the value.
3165 You can set buffer-local values for the same purpose in the variable
3166 `org-file-properties' this by adding lines like
3168 #+PROPERTY: NAME VALUE"
3175 "List of property/value pairs that can be inherited by any entry.
3176 Valid for the current buffer.
3181 "Options concerning agenda views in Org-mode."
3186 "Variable used by org files to set a category for agenda display.
3187 Such files should use a file variable to set it, for example
3191 or contain a special line
3193 #+CATEGORY: ELisp
3195 If the file does not specify a category, then file's base name
3201 "The files to be used for agenda display.
3205 If an entry is a directory, all files in that directory that are matched by
3206 `org-agenda-file-regexp' will be part of the file list.
3208 If the value of the variable is not a list but a single file name, then
3209 the list of agenda files is actually stored and maintained in that file, one
3210 agenda file per line. In this file paths can be given relative to
3211 `org-directory'. Tilde expansion and environment variable substitution
3212 are also made."
3219 "Regular expression to match files for `org-agenda-files'.
3220 If any element in the list in that variable contains a directory instead
3221 of a normal file, all files in that directory that are matched by this
3222 regular expression will be included."
3227 "List of extra files to be searched by text search commands.
3228 These files will be search in addition to the agenda files by the
3229 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3230 Note that these files will only be searched for text search commands,
3231 not for the other agenda views like todo lists, tag searches or the weekly
3232 agenda. This variable is intended to list notes and possibly archive files
3233 that should also be searched by these two commands.
3234 In fact, if the first element in the list is the symbol `agenda-archives',
3235 than all archive files of all agenda files will be added to the search
3236 scope."
3247 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3248 A nil value means to remove them, after a query, from the list."
3253 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3254 The command `org-calendar-goto-agenda' will be bound to this key. The
3255 default is the character `c' because then `c' can be used to switch back and
3256 forth between agenda and calendar."
3261 "The key to be installed in `calendar-mode-map' for agenda-action.
3262 The command `org-agenda-action' will be bound to this key. The
3263 default is the character `k' because we use the same key in the agenda."
3268 "The key to be installed in `calendar-mode-map' for adding diary entries.
3269 This option is irrelevant until `org-agenda-diary-file' has been configured
3270 to point to an Org-mode file. When that is the case, the command
3271 `org-agenda-diary-entry' will be bound to the key given here, by default
3272 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3273 if you want to continue doing this, you need to change this to a different
3274 key."
3279 "File to which to add new entries with the `i' key in agenda and calendar.
3280 When this is the symbol `diary-file', the functionality in the Emacs
3281 calendar will be used to add entries to the `diary-file'. But when this
3282 points to a file, `org-agenda-diary-entry' will be used instead."
3298 org-calendar-insert-diary-entry-key
3302 "Options for embedding LaTeX code into Org-mode."
3310 "Options for creating images from LaTeX fragments.
3311 This is a property list with the following properties:
3313 `default' means use the foreground of the default face.
3315 `default' means use the background of the default face.
3316 :scale a scaling factor for the size of the images, to get more pixels
3317 :html-foreground, :html-background, :html-scale
3318 the same numbers for HTML export.
3319 :matchers a list indicating which matchers should be used to
3320 find LaTeX fragments. Valid members of this list are:
3331 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3332 When nil, just push out a message."
3337 Use this to specify additional executable file say a jar file.
3339 When using MathToWeb as the converter, specify the full-path to
3340 your mathtoweb.jar file."
3347 "Command to convert LaTeX fragments to MathML.
3348 Replace format-specifiers in the command as noted below and use
3349 `shell-command' to convert LaTeX to MathML.
3350 %j: Executable file in fully expanded form as specified by
3351 `org-latex-to-mathml-jar-file'.
3352 %I: Input LaTeX file in fully expanded form
3353 %o: Output MathML file
3354 This command is used by `org-create-math-formula'.
3356 When using MathToWeb as the converter, set this to
3364 "Return t if `org-latex-to-mathml-convert-command' is usable."
3367 org-latex-to-mathml-convert-command)
3369 org-latex-to-mathml-convert-command))))
3374 t))))))
3381 \[PACKAGES]
3382 \[DEFAULT-PACKAGES]
3383 % The settings below are copied from fullpage.sty
3396 "The document header used for processing LaTeX fragments.
3397 It is imperative that this header make sure that no page number
3398 appears on the page. The package defined in the variables
3399 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3401 will be appended."
3408 "Set the packages alist and make sure it has 3 elements per entry."
3412 x))
3413 val)))
3417 "Get the packages alist and make sure it has 3 elements per entry."
3421 x))
3424 ;; The following variables are defined here because is it also used
3425 ;; when formatting latex fragments. Originally it was part of the
3426 ;; LaTeX exporter, which is why the name includes "export".
3443 )
3444 "Alist of default packages to be inserted in the header.
3445 Change this only if one of the packages here causes an incompatibility
3446 with another package you are using.
3447 The packages in this list are needed by one part or another of Org-mode
3448 to function properly.
3450 - inputenc, fontenc: for basic font and character selection
3451 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3452 for interpreting the entities in `org-entities'. You can skip some of these
3453 packages if you don't use any of the symbols in it.
3454 - graphicx: for including images
3455 - float, wrapfig: for figure placement
3456 - longtable: for long tables
3457 - hyperref: for cross references
3459 Therefore you should not modify this variable unless you know what you
3460 are doing. The one reason to change it anyway is that you might be loading
3461 some other package that conflicts with one of the default packages.
3463 If SNIPPET-FLAG is t, the package also needs to be included when
3464 compiling LaTeX snippets into images for inclusion into HTML."
3477 "Alist of packages to be inserted in every LaTeX header.
3478 These will be inserted after `org-export-latex-default-packages-alist'.
3480 SNIPPET-FLAG, when t, indicates that this package is also needed when
3481 turning LaTeX snippets into images for inclusion into HTML.
3482 Make sure that you only list packages here which:
3483 - you want in every file
3484 - do not conflict with the default packages in
3485 `org-export-latex-default-packages-alist'
3486 - do not conflict with the setup in `org-format-latex-header'."
3500 "Settings for Org-mode appearance."
3505 "Non-nil means fontify only the stars in each headline.
3506 When nil, the entire headline is fontified.
3507 Changing it requires restart of `font-lock-mode' to become effective
3508 also in regions already fontified."
3513 "Non-nil means hide the first N-1 stars in a headline.
3514 This works by using the face `org-hide' for these stars. This
3515 face is white for a light background, and black for a dark
3516 background. You may have to customize the face `org-hide' to
3517 make this work.
3518 Changing it requires restart of `font-lock-mode' to become effective
3519 also in regions already fontified.
3520 You may also set this on a per-file basis by adding one of the following
3521 lines to the buffer:
3523 #+STARTUP: hidestars
3524 #+STARTUP: showstars"
3529 "List of symbols corresponding to keywords to be hidden the org buffer.
3530 For example, a value '(title) for this list will make the document's title
3531 appear in the buffer without the initial #+TITLE: keyword."
3539 "Non-nil means change the face of a headline if it is marked DONE.
3540 Normally, only the TODO/DONE keyword indicates the state of a headline.
3541 When this is non-nil, the headline after the keyword is set to the
3542 `org-headline-done' as an additional indication."
3547 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3548 Changing this variable requires a restart of Emacs to take effect."
3553 "Non-nil means fontify the whole line for headings.
3554 This is useful when setting a background color for the
3555 org-level-* faces."
3560 "Non-nil means fontify what is treated specially by the exporters."
3565 "Non-nil mean font-lock should hide the emphasis marker characters."
3570 "Non-nil means show entities as UTF8 characters.
3576 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3581 "Regular expression for matching emphasis.
3582 After a match, the match groups contain these elements:
3583 0 The match of the full regular expression, including the characters
3584 before and after the proper match
3585 1 The character before the proper match, or empty at beginning of line
3586 2 The proper match, including the leading and trailing markers
3587 3 The leading marker like * or /, indicating the type of highlighting
3588 4 The text between the emphasis markers, not including the markers
3595 "Set variable and compute the emphasis regular expression."
3599 org-emphasis-alist org-emphasis-regexp-components)
3611 ;; make sure special characters appear at the right position in the class
3623 ;; Make the regexp
3631 body1
3643 body1
3651 "Components used to build the regular expression for emphasis.
3652 This is a list with five entries. Terminology: In an emphasis string
3656 specify what is allowed/forbidden in each part:
3658 pre Chars allowed as prematch. Beginning of line will be allowed too.
3659 post Chars allowed as postmatch. End of line will be allowed too.
3660 border The chars *forbidden* as border characters.
3662 non-shy groups here, and don't allow newline here.
3663 newline The maximum number of newlines allowed in an emphasis exp.
3665 Use customize to modify this, or restart Emacs after changing it."
3684 )
3685 "Special syntax for emphasized text.
3686 Text starting and ending with a special character will be emphasized, for
3687 example *bold*, _underlined_ and /italic/. This variable sets the marker
3688 characters, the face to be used by font-lock for highlighting in Org-mode
3689 Emacs buffers, and the HTML tags to be used for this.
3690 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3691 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3692 Use customize to modify this, or restart Emacs after changing it."
3707 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3710 ;;; Miscellaneous options
3713 "Completion in Org-mode."
3718 "Non-nil means use ido completion wherever possible.
3719 Note that `ido-mode' must be active for this variable to be relevant.
3720 If you decide to turn this variable on, you might well want to turn off
3721 `org-outline-path-complete-in-steps'.
3722 See also `org-completion-use-iswitchb'."
3727 "Non-nil means use iswitchb completion wherever possible.
3728 Note that `iswitchb-mode' must be active for this variable to be relevant.
3729 If you decide to turn this variable on, you might well want to turn off
3730 `org-outline-path-complete-in-steps'.
3731 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3737 Normal means, no org-mode-specific context."
3741 ;;; Functions and variables from their packages
3742 ;; Declared here to avoid compiler warnings
3744 ;; XEmacs only
3750 ;; Emacs only
3753 ;; Various packages
3772 org-agenda-format-item "org-agenda"
3803 ;;; Autoload and prepare some org modules
3805 ;; Some table stuff that needs to be defined here, because it is used
3806 ;; by the functions setting up org-mode or checking for table context.
3819 "Detect the first line outside a table when searching from within it.
3822 ;; Autoload the functions in org-table.el that are needed by functions here.
3827 org-table-convert org-table-convert-region org-table-copy-down
3828 org-table-copy-region org-table-create
3829 org-table-create-or-convert-from-region
3830 org-table-create-with-table.el org-table-current-dline
3831 org-table-cut-region org-table-delete-column org-table-edit-field
3832 org-table-edit-formulas org-table-end org-table-eval-formula
3833 org-table-export org-table-field-info
3834 org-table-get-stored-formulas org-table-goto-column
3835 org-table-hline-and-move org-table-import org-table-insert-column
3836 org-table-insert-hline org-table-insert-row org-table-iterate
3837 org-table-justify-field-maybe org-table-kill-row
3838 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3839 org-table-move-column org-table-move-column-left
3840 org-table-move-column-right org-table-move-row
3841 org-table-move-row-down org-table-move-row-up
3842 org-table-next-field org-table-next-row org-table-paste-rectangle
3843 org-table-previous-field org-table-recalculate
3844 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3845 org-table-toggle-coordinate-overlays
3846 org-table-toggle-formula-debugger org-table-wrap-region
3847 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3848 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3849 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3852 "Return t if the cursor is inside an org-type table.
3853 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3858 org-table-line-regexp)))
3859 nil))
3863 "Return t if and only if we are at a table.el table."
3869 "If there is a table.el table nearby, recognize it and move into it."
3875 nil
3885 t
3890 t)
3891 nil)
3892 nil))
3895 "Return t if the cursor is inside a hline in a table."
3900 nil))
3905 "Apply FUNCTION to the start of all tables in the buffer."
3921 ;; Declare and autoload functions from org-exp.el & Co
3929 org-insert-export-options-template
3930 org-table-clean-before-export))
3933 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3934 org-export-region-as-ascii))
3937 org-replace-region-by-latex org-export-region-as-latex
3938 org-export-as-latex org-export-as-pdf
3939 org-export-as-pdf-and-open))
3942 org-export-as-html-batch org-export-as-html-to-buffer
3943 org-replace-region-by-html org-export-region-as-html
3944 org-export-as-html))
3947 org-replace-region-by-docbook org-export-region-as-docbook
3948 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3949 org-export-as-docbook))
3952 org-export-icalendar-all-agenda-files
3953 org-export-icalendar-combine-agenda-files))
3957 ;; Declare and autoload functions from org-agenda.el
3962 org-todo-list org-tags-view org-agenda-list-stuck-projects
3963 org-diary org-agenda-to-appt
3964 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3966 ;; Autoload org-remember
3971 org-remember-apply-template org-remember org-remember-handler)))
3976 org-capture-import-remember-templates)))
3978 ;; Autoload org-clock.el
3993 "Return non-nil if clock is currently running.
3994 The return value is actually the clock marker."
3999 "org-clock"
4001 org-clock-goto org-clock-sum org-clock-display
4002 org-clock-remove-overlays org-clock-report
4003 org-clocktable-shift org-dblock-write:clocktable
4004 org-get-clocktable org-resolve-clocks)))
4007 "If this is a CLOCK line, update it and return t.
4008 Otherwise, return nil."
4017 ts te h m s neg)
4020 nil)
4025 ;; The clock is running here
4046 t))))))
4049 "Check if the current buffer contains the running clock.
4050 If yes, offer to stop it and to save the buffer with the changes."
4059 "Check if this line starts a clock table, if yes, shift the time block."
4063 ;; Autoload org-timer.el
4067 "org-timer"
4069 org-timer-change-times-in-region
4070 org-timer-set-timer
4071 org-timer-reset-timers
4072 org-timer-show-remaining-time)))
4074 ;; Autoload org-feed.el
4078 "org-feed"
4082 ;; Autoload org-indent.el
4084 ;; Define the variable already here, to make sure we have it.
4086 "Non-nil if Org-Indent mode is enabled.
4091 "org-indent"
4094 ;; Autoload org-mobile.el
4098 "org-mobile"
4101 ;; Autoload archiving code
4102 ;; The stuff that is needed for cycling and tags has to be defined here.
4105 "Options concerning archiving in Org-mode."
4110 "The location where subtrees should be archived.
4112 The value of this variable is a string, consisting of two parts,
4113 separated by a double-colon. The first part is a filename and
4114 the second part is a headline.
4116 When the filename is omitted, archiving happens in the same file.
4117 %s in the filename will be replaced by the current file
4118 name (without the directory part). Archiving to a different file
4119 is useful to keep archived entries from contributing to the
4120 Org-mode Agenda.
4122 The archived entries will be filed as subtrees of the specified
4123 headline. When the headline is omitted, the subtrees are simply
4124 filed away at the end of the file, as top-level entries. Also in
4125 the heading you can use %s to represent the file name, this can be
4126 useful when using the same archive for a number of different files.
4128 Here are a few examples:
4130 If the current file is Projects.org, archive in file
4131 Projects.org_archive, as top-level trees. This is the default.
4134 Archive in the current file, under the top-level headline
4138 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4141 Archive in file ~/org/archive.org (absolute path), under headlines
4145 Archive in file ./basement (relative path), as level 3 trees
4148 You may set this option on a per-file basis by adding to the buffer a
4149 line like
4151 #+ARCHIVE: basement::** Finished Tasks
4153 You may also define it locally for a subtree by setting an ARCHIVE property
4154 in the entry. If such a property is found in an entry, or anywhere up
4155 the hierarchy, it will be used."
4160 "The tag that marks a subtree as archived.
4161 An archived subtree does not open during visibility cycling, and does
4162 not contribute to the agenda listings.
4163 After changing this, font-lock must be restarted in the relevant buffers to
4164 get the proper fontification."
4170 "Non-nil means the agenda will skip any items located in archived trees.
4171 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4172 variable is no longer recommended, you should leave it at the value t.
4173 Instead, use the key `v' to cycle the archives-mode in the agenda."
4179 "Non-nil means ignore archived trees when creating column view."
4185 "Non-nil means `org-cycle' will open archived trees.
4186 An archived tree is a tree marked with the tag ARCHIVE.
4187 When nil, archived trees will stay folded. You can still open them with
4188 normal outline commands like `show-all', but not with the cycling commands."
4194 "Non-nil means sparse tree construction shows matches in archived trees.
4195 When nil, matches in these trees are highlighted, but the trees are kept in
4196 collapsed state."
4202 "Re-hide all archived subtrees after a visibility state change."
4213 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4216 "Cycle subtree even if it is archived."
4223 "Re-hide all archived subtrees after a visibility state change."
4238 flag)))
4245 org-archive-to-archive-sibling org-toggle-archive-tag
4246 org-archive-subtree-default
4247 org-archive-subtree-default-with-confirmation)))
4249 ;; Autoload Column View Code
4257 org-columns-compute org-agenda-columns org-columns-remove-overlays
4260 ;; Autoload ID code
4268 org-id-get-with-outline-path-completion
4269 org-id-get-with-outline-drilling org-id-store-link
4270 org-id-goto org-id-find org-id-store-link))
4272 ;; Autoload Plotting Code
4277 ;;; Variables for pre-computed regular expressions, all buffer local
4295 "Matches a headline and puts everything into groups:
4296 group 1: the stars
4297 group 2: The todo keyword, maybe
4298 group 3: Priority cookie
4299 group 4: True headline
4303 "Printf format to make regexp to match an exact headline.
4304 This regexp will match the headline of any node which has the
4305 exact headline text that is put into the format, but may have any
4309 "Matches a headline and puts TODO state into group 2 if present.
4358 "Regular expression to match a plain time or time range.
4359 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4360 groups carry important information:
4361 0 the full match
4362 1 the first time, range or not
4370 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4371 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4372 groups carry important information:
4373 0 the full match
4374 7 hours of duration
4383 "Regular expression to match a timestamp time or time range.
4384 After a match, the following groups carry important information:
4385 0 the full match
4386 1 date plus weekday, for back referencing to make sure both times are on the same day
4387 2 the first time, range or not
4442 "Variable associated with STARTUP options for org-mode.
4443 Each element is a list of three items: The startup options as written
4444 in the #+STARTUP line, the corresponding variable, and the value to
4445 set this variable to if the option is found. An optional forth element PUSH
4449 "Update PROPS with KEY and VAL."
4463 "Printf format for a regexp matching an headline with some keyword.
4464 This regexp will match the headline of any node which has the
4465 exact keyword that is put into the format. The keyword isn't in
4469 "Printf format for a regexp matching an headline, possibly with some keyword.
4470 This regexp can match any headline with the specified keyword, or
4471 without a keyword. The keyword isn't in any group by default,
4475 "Precompute regular expressions for current buffer."
4495 kwds kws0 kwsa key log value cat arch tags const links hw dws
4496 tail sep kws1 prio props ftags drawers beamer-p
4518 ;; general TODO-like setup
4530 links)))
4537 props))))
4542 ftags
4552 l var val)
4582 ;; search for property blocks
4591 props)))))))
4608 ;; Process the TODO keywords
4610 ;; Use the global values as if they had been given locally.
4622 kws)))
4625 kwsa nil
4628 ;; 1 2
4636 kw)
4638 kws0)
4655 ;; Process the constants
4663 ;; Process the tags.
4674 tgs))
4682 ;; Compute the regular expressions and other local variables.
4683 ;; Using `org-outline-regexp-bol' would complicate them much,
4684 ;; because of the fixed white space at the end of that string.
4692 org-drawer-regexp
4696 org-not-done-keywords
4698 org-todo-regexp
4702 org-not-done-regexp
4706 org-not-done-heading-regexp
4708 org-todo-line-regexp
4710 org-complex-heading-regexp
4717 org-complex-heading-regexp-format
4722 ;; Stats cookies can be stuck to body.
4729 org-todo-line-tags-regexp
4736 org-deadline-time-regexp
4738 org-deadline-line-regexp
4740 org-scheduled-regexp
4742 org-scheduled-time-regexp
4744 org-closed-time-regexp
4746 org-keyword-time-regexp
4752 org-keyword-time-not-clock-regexp
4758 org-maybe-keyword-time-regexp
4764 org-planning-or-clock-line-re
4769 org-all-time-keywords
4772 org-clock-string org-closed-string))
4773 )
4778 "Return the contents of FILE, as a string."
4792 "Extract the log state setting from a TODO keyword string.
4806 "Remove a pair of parenthesis at the end of each string in LIST."
4810 x))
4811 list))
4814 "Assign fast keys to a keyword-key alist.
4815 Respect keys that are already there."
4833 ;;; Some variables used in various places
4840 "Function to be called when `C-c C-c' is used.
4844 ;; FIXME: Occasionally check by commenting these, to make sure
4845 ;; no other functions uses these, forgetting to let-bind them.
4850 ;; Defined somewhere in this file, but used before definition.
4856 ;;;; Define the Org-mode
4859 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
4862 ;; We use a before-change function to check if a table might need
4863 ;; an update.
4865 "Indicates that a table might need an update.
4866 This variable is set by `org-before-change-function'.
4869 "Every change indicates that a table might need an update."
4879 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4880 ;; some places -- e.g. see the macro org-with-limited-levels.
4881 ;;
4882 ;; In Org buffers, the value of `outline-regexp' is that of
4883 ;; `org-outline-regexp'. The only function still directly relying on
4884 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4885 ;; job when `orgstruct-mode' is active.
4889 "Regexp to match Org headlines.
4890 This is similar to `org-outline-regexp' but additionally makes
4894 "Matches an headline, putting stars and text into groups.
4897 ;;;###autoload
4899 "Outline-based notes management and organizer, alias
4902 Org-mode develops organizational tasks around a NOTES file which
4903 contains information about projects as plain text. Org-mode is
4904 implemented on top of outline-mode, which is ideal to keep the content
4905 of large files well structured. It supports ToDo items, deadlines and
4906 time stamps, which magically appear in the diary listing of the Emacs
4907 calendar. Tables are easily created with a built-in table editor.
4908 Plain text URL-like links connect to websites, emails (VM), Usenet
4909 messages (Gnus), BBDB entries, and any files related to the project.
4910 For printing and sharing of notes, an Org-mode file (or a part of it)
4911 can be exported as a structured ASCII or HTML file.
4913 The following commands are available:
4917 ;; Get rid of Outline menus, they are not needed
4918 ;; Need to do this here because define-derived-mode sets up
4919 ;; the keymap so late. Still, it is a waste to call this each time
4920 ;; we switch another buffer into org-mode.
4923 ;; Assume this is Greg's port, it uses easymenu
4949 org-display-table 4
4952 org-ellipsis)))
4957 ;; tag faces set outside customize.... force initialization.
4959 ;; Calc embedded
4965 ;; Activate before-change-function
4969 ;; Check for running clock before killing a buffer
4971 ;; Paragraphs and auto-filling
4975 ;; Beginning/end of defun
4978 ;; Next error for sparse trees
4980 ;; Make sure dependence stuff works reliably, even for users who set it
4981 ;; too late :-(
4993 ;; Comment characters
4997 ;; Align options lines
4999 'align-mode-rules-list
5004 ;; Imenu
5008 ;; Make isearch reveal context
5011 ;; Emacs 21 and XEmacs make use of the hook
5013 ;; Emacs 22 deals with this through a special variable
5017 ;; Turn on org-beamer-mode?
5020 ;; Setup the pcomplete hooks
5033 ;; If empty file that did not turn on org-mode automatically, make it to.
5058 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5068 "Return today date, considering `org-extend-today-until'."
5073 ;;;; Font-Lock stuff, including the activators
5104 "Regular expression used to analyze links.
5105 Here is what the match groups contain after a match:
5106 1: http:
5107 2: http
5108 3: path
5109 4: [desc]
5117 "Number of stacked braces for sub/superscript matching.
5118 This has to be set before loading org.el to be effective."
5123 "Create a regular expression which will match a balanced sexp.
5124 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5125 as single character strings.
5126 The regexp returned will match the entire expression including the
5127 delimiters. It will also define a single group which contains the
5128 match except for the outermost delimiters. The maximum depth of
5129 stacked delimiters is N. Escaping delimiters is not possible."
5158 "Update the link regular expressions.
5159 This should be called after the variable `org-link-types' has changed."
5163 org-link-re-with-space
5169 org-link-re-with-space2
5175 org-link-re-with-space3
5180 org-angle-link-re
5186 org-plain-link-re
5190 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5191 org-bracket-link-regexp
5193 org-bracket-link-analytic-regexp
5201 org-bracket-link-analytic-regexp++
5209 org-any-link-re
5218 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5220 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5221 "Regular expression matching time strings for analysis.
5222 This one does not require the space after the date, so it can be used
5224 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5240 "Regular expression matching a time stamp or time stamp range.
5246 "Run through the buffer and add overlays to emphasized strings."
5255 'face
5268 rtn))
5271 "Insert or change an emphasis, i.e. a font like bold or italic.
5272 If there is an active region, change that region to a new emphasis.
5273 If there is no region, just insert the marker characters and position
5274 the cursor between them.
5275 CHAR should be either the marker character, or the first character of the
5276 HTML tag associated with that emphasis. If CHAR is a space, the means
5277 to remove the emphasis of the selected region.
5278 If char is not given (for example in an interactive call) it
5279 will be prompted for."
5330 "Run through the buffer and add overlays to links."
5339 nil
5345 t)))))
5353 t)))
5356 "When non-nil, fontify code in code blocks."
5367 "Fontify #+ lines and blocks, in the correct ways."
5370 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5371 limit t)
5379 end end1 quoting block-type ovl)
5382 ;; a single line of backend-specific content
5390 ; for backend-specific code
5391 t)
5393 ;; Truly a block
5405 beg end
5413 ;; remove old background overlays
5418 ;; add a background overlay
5432 t))
5445 ;; just any other in-buffer setting, but not indented
5449 t)
5457 t)
5465 "Run through the buffer and add overlays to links."
5473 t)))
5476 "Run through the buffer and add overlays to footnotes."
5483 'keymap org-mouse-map
5484 'help-echo
5486 "Footnote definition"
5488 'font-lock-fontified t
5489 'font-lock-multiline t
5493 "Run through the buffer and add overlays to bracketed links."
5497 ;; FIXME: above we should remove the escapes.
5498 ;; but that requires another match, protecting match data,
5499 ;; a lot of overhead for font-lock.
5506 ;; We need to remove the invisible property here. Table narrowing
5507 ;; may have made some of this invisible.
5525 t)))
5528 "Run through the buffer and add overlays to dates."
5540 t)))
5549 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5553 "Run through the buffer and add overlays to target matches."
5561 'keymap org-mouse-map
5565 t)))))
5568 "Find all radio targets in this file and update the regular expression."
5583 t)))
5590 ;; This should be with the exporter code, but we also use if for font-locking
5600 "Compute regular expression for stuff treated specially by exporters."
5607 org-latex-regexps)))
5635 org-entities)))
5639 org-latex-entities)
5640 nil))
5642 ))
5643 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5646 org-export-html-special-string-regexps)))
5651 ))))
5653 'org-latex-and-specials-regexp
5658 "Run through the buffer and add overlays to links."
5662 limit t))
5676 rtn)))
5679 "Restart `font-lock-mode', to force refontification."
5685 "Return a list of all targets in this file.
5686 With optional argument RADIO, only find radio targets."
5688 rtn)
5693 rtn)))
5696 "Make regular expression matching all strings in TARGETS.
5697 The regular expression finds the targets also if there is a line break
5698 between words."
5707 x)
5708 targets
5720 t)))
5723 "Compute the outline level of the heading at point.
5724 This function assumes that the cursor is at the beginning of a line matched
5725 by `outline-regexp'. Otherwise it returns garbage.
5726 If this is called at a normal headline, the level is the number of stars.
5727 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5734 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5741 "Functions that can manipulate `org-font-lock-extra-keywords'.
5742 This is called after `org-font-lock-extra-keywords' is defined, but before
5743 it is installed to be used by font lock. This can be useful if something
5754 ;; Call the hook
5756 ;; Headlines
5763 ;; Table lines
5766 ;; Table internals
5771 ;; Drawers
5774 ;; Properties
5778 ;; Links
5788 ;; TODO keyword
5790 org-todo-regexp)
5792 ;; DONE
5800 nil)
5801 ;; Priorities
5803 ;; Tags
5805 ;; Special keywords
5810 ;; Emphasis
5815 ;; Checkboxes
5816 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5821 ;; Description list items
5824 ;; ARCHIVEd headings
5826 org-outline-regexp-bol
5829 ;; Specials
5833 ;; Code
5835 ;; COMMENT
5842 ;; Blocks and meta lines
5844 )))
5847 ;; Now set the full font-lock-keywords
5854 "Toggle the composition display of entities as UTF8 characters."
5866 "Find an entity to fontify."
5872 limit t)
5884 nil))))
5887 "Fontify string S like in Org-mode."
5899 "Get the right face for match N in font-lock matching of headlines."
5912 "Get the right face for a TODO keyword KWD.
5913 If KWD is a number, get the corresponding match group."
5921 "Create a face list that inherits INHERIT, but sets the foreground color.
5922 When FACE-OR-COLOR is not a string, just return it."
5926 face-or-color)
5927 face-or-color))
5930 "Add the special tag faces."
5939 "Add the special priority faces."
5946 org-priority-faces)))
5951 "Get the right face for a TODO keyword KWD.
5952 If KWD is a number, get the corresponding match group."
5959 "Remove fontification and activation overlays from links."
5964 deactivate-mark buffer-file-name buffer-file-truename)
5968 invisible t intangible t
5969 org-no-flyspell t org-emphasis t))
5979 "Remove specific display properties that have been added by font lock.
5980 The will remove the raise properties that are used to show superscripts
5981 and subscripts."
5991 "Add raise properties to sub/superscripts."
5995 org-match-substring-regexp
5996 org-match-substring-with-braces-regexp)
5997 limit t)
6007 ;; FIXME: Should we go back one character here, for a_b^c
6008 ;; (goto-char (1- pos)) ;????????????????????
6010 t
6012 'display
6028 t)))))
6030 ;;;; Visibility cycling, including org-goto and indirect buffer
6032 ;;; Cycling
6039 ;;;###autoload
6044 "TAB-action and visibility cycling for Org-mode.
6046 This is the command invoked in Org-mode by the TAB key. Its main purpose
6047 is outline visibility cycling, but it also invokes other actions
6048 in special contexts.
6050 - When this function is called with a prefix argument, rotate the entire
6051 buffer through 3 states (global cycling)
6052 1. OVERVIEW: Show only top-level headlines.
6053 2. CONTENTS: Show all headlines of all levels, but no body text.
6054 3. SHOW ALL: Show everything.
6055 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6056 determined by the variable `org-startup-folded', and by any VISIBILITY
6057 properties in the buffer.
6058 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6059 including any drawers.
6061 - When inside a table, re-align the table and move to the next field.
6063 - When point is at the beginning of a headline, rotate the subtree started
6064 by this line through 3 different states (local cycling)
6065 1. FOLDED: Only the main headline is shown.
6066 2. CHILDREN: The main headline and the direct children are shown.
6067 From this state, you can move to one of the children
6068 and zoom in further.
6069 3. SUBTREE: Show the entire subtree, including body text.
6070 If there is no subtree, switch directly from CHILDREN to FOLDED.
6072 - When point is at the beginning of an empty headline and the variable
6073 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6074 of the headline by demoting and promoting it to likely levels. This
6075 speeds up creation document structure by pressing TAB once or several
6076 times right after creating a new headline.
6078 - When there is a numeric prefix, go up to a heading with level ARG, do
6079 a `show-subtree' and return to the previous cursor position. If ARG
6080 is negative, go up that many levels.
6082 - When point is not at the beginning of a headline, execute the global
6083 binding for TAB, which is re-indenting the line. See the option
6084 `org-cycle-emulate-tab' for details.
6086 - Special case: if point is at the beginning of the buffer and there is
6087 no headline in line 1, this function will act as if called with prefix arg
6088 (C-u TAB, same as S-TAB) also when called without prefix arg.
6089 But only if also the variable `org-cycle-global-at-bob' is t."
6099 org-inlinetask-min-level
6104 limit-level)))
6107 outline-regexp
6115 org-cycle-hook))
6119 ;; special case: use global cycling
6133 ;; Table: enter it or move to the next field.
6144 ;; Global cycling: delegate to `org-cycle-internal-global'.
6147 ;; Drawers: delegate to `org-flag-drawer'.
6155 ;; Show-subtree, ARG levels up from here.
6163 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6171 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6178 ;; From there: TAB emulation and template completion.
6200 t
6209 "Do the global cycling action."
6213 ;; We just created the overview - now do table of contents
6214 ;; This can be slow in very large buffers, so indicate action
6224 ;; We just showed the table of contents - now show everything
6232 ;; Default action: go to overview
6240 "Do the local cycling action."
6242 ;; First, determine end of headline (EOH), end of subtree or item
6243 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6267 ;; Determine end invisible part of buffer (EOL)
6269 ;; XEmacs doesn't have `next-single-char-property-change'
6279 ;; Find out what to do next and set `this-command'
6282 ;; Nothing is hidden behind this heading
6294 org-cycle-skip-children-state-if-no-children))))
6295 ;; Entire subtree is hidden in one line: children view
6301 ;; Fold every list in subtree to top-level items.
6323 ;; We just showed the children, or no children are there,
6324 ;; now show everything.
6331 ;; Default action: hide the subtree.
6338 ;;;###autoload
6340 "Cycle the global visibility. For details see `org-cycle'.
6342 With a numeric prefix, show all headlines up to that level."
6358 "Set the visibility required by startup options and properties."
6373 "Switch subtree visibilities according to :VISIBILITY: property."
6380 nil t)
6404 ;; This function uses outline-regexp instead of the more fundamental
6405 ;; org-outline-regexp so that org-cycle-global works outside of Org
6406 ;; buffers, where outline-regexp is needed.
6408 "Switch to overview mode, showing only top-level headlines.
6409 Really, this shows all headlines with level equal or greater than the level
6410 of the first headline in the buffer. This is important, because if the
6411 first headline is not level one, then (hide-sublevels 1) gives confusing
6412 results."
6423 "Show all headlines in the buffer, like a table of contents.
6424 With numerical argument N, show content up to level N."
6427 ;; Visit all headings and show their offspring
6434 t)
6443 "Adjust the window after a change in outline visibility.
6444 This function is the default value of the hook `org-cycle-hook'."
6454 "Remove outline overlays that do not contain non-white stuff."
6464 "Fix visibility issues after moving a subtree."
6465 ;; First, find a reasonable region to look at:
6466 ;; Start two siblings above, end three below
6484 ;; Properly fold already folded siblings
6495 "Show empty lines above all visible headlines.
6496 The region to be covered depends on STATE when called through
6497 `org-cycle-hook'. Lisp program can use t for STATE to get the
6498 entire buffer covered. Note that an empty line is only shown if there
6499 are at least `org-cycle-separator-lines' empty lines before the headline."
6509 beg end b e)
6533 ;; Never hide empty lines at the end of the file.
6543 "Move to the parent and re-show empty lines before visible headlines."
6549 "Return `org-agenda-files' list, plus all open org-mode files.
6550 This is useful for operations that need to scan all of a user's
6551 open and agenda-wise Org files."
6559 files))
6562 "Return the beginning position of the current entry."
6566 "Return the end position of the current entry."
6570 "Re-hide all drawers after a visibility state change."
6596 "Is the end of the current subtree visible?"
6601 "Move cursor to the first headline and recenter the headline.
6602 Optional argument N means put the headline into the Nth line of the window."
6608 ;;; Saving and restoring visibility
6611 "Return a list of the locations of all outline overlays.
6612 These are overlays with the `invisible' property value `outline'.
6613 The return value is a list of cons cells, with start and stop
6614 positions for each overlay.
6615 If USE-MARKERS is set, return the positions as markers."
6633 "Create visibility overlays for all positions in DATA.
6634 DATA should have been made by `org-outline-overlay-data'."
6642 data)))))
6644 ;;; Folding of blocks
6651 "Call FUNCTION at the head of all source blocks in the current buffer.
6652 Optional arguments START and END can be used to limit the range."
6664 "Toggle the visibility of all blocks in the current buffer."
6668 "Fold all blocks in the current buffer."
6674 "Unfold all blocks in the current buffer."
6680 "Toggle visibility of block at point."
6691 "Toggle the visibility of the current block."
6698 ov)
6714 ;; make the block accessible to isearch
6716 ov 'isearch-open-invisible
6727 ;; org-tab-after-check-for-cycling-hook
6729 ;; Remove overlays when changing major mode
6734 ;;; Org-goto
6740 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6756 nil)
6757 (org-defkey map "q" 'org-goto-quit)
6758 (org-defkey map "n" 'outline-next-visible-heading)
6759 (org-defkey map "p" 'outline-previous-visible-heading)
6760 (org-defkey map "f" 'outline-forward-same-level)
6761 (org-defkey map "b" 'outline-backward-same-level)
6762 (org-defkey map "u" 'outline-up-heading))
6763 (org-defkey map "/" 'org-occur)
6764 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6765 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6766 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6767 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6768 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6769 map))
6771 (defconst org-goto-help
6772 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6773 RET=jump to location [Q]uit and return to previous location
6774 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6776 (defvar org-goto-start-pos) ; dynamically scoped parameter
6778 ;; FIXME: Docstring does not mention both interfaces
6779 (defun org-goto (&optional alternative-interface)
6780 "Look up a different location in the current file, keeping current visibility.
6782 When you want look-up or go to a different location in a document, the
6783 fastest way is often to fold the entire buffer and then dive into the tree.
6784 This method has the disadvantage, that the previous location will be folded,
6785 which may not be what you want.
6787 This command works around this by showing a copy of the current buffer
6788 in an indirect buffer, in overview mode. You can dive into the tree in
6789 that copy, use org-occur and incremental search to find a location.
6790 When pressing RET or `Q', the command returns to the original buffer in
6791 which the visibility is still unchanged. After RET is will also jump to
6792 the location selected in the indirect buffer and expose the headline
6793 hierarchy above."
6794 (interactive "P")
6795 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6796 (org-refile-use-outline-path t)
6797 (org-refile-target-verify-function nil)
6798 (interface
6799 (if (not alternative-interface)
6800 org-goto-interface
6801 (if (eq org-goto-interface 'outline)
6802 'outline-path-completion
6803 'outline)))
6804 (org-goto-start-pos (point))
6805 (selected-point
6806 (if (eq interface 'outline)
6807 (car (org-get-location (current-buffer) org-goto-help))
6808 (let ((pa (org-refile-get-location "Goto")))
6809 (org-refile-check-position pa)
6810 (nth 3 pa)))))
6811 (if selected-point
6812 (progn
6813 (org-mark-ring-push org-goto-start-pos)
6814 (goto-char selected-point)
6815 (if (or (outline-invisible-p) (org-invisible-p2))
6816 (org-show-context 'org-goto)))
6817 (message "Quit"))))
6819 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6820 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6821 (defvar org-goto-local-auto-isearch-map) ; defined below
6823 (defun org-get-location (buf help)
6824 "Let the user select a location in the Org-mode buffer BUF.
6825 This function uses a recursive edit. It returns the selected position
6826 or nil."
6827 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6828 (isearch-hide-immediately nil)
6829 (isearch-search-fun-function
6830 (lambda () 'org-goto-local-search-headings))
6831 (org-goto-selected-point org-goto-exit-command)
6832 (pop-up-frames nil)
6833 (special-display-buffer-names nil)
6834 (special-display-regexps nil)
6835 (special-display-function nil))
6836 (save-excursion
6837 (save-window-excursion
6838 (delete-other-windows)
6839 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6840 (org-pop-to-buffer-same-window
6841 (condition-case nil
6842 (make-indirect-buffer (current-buffer) "*org-goto*")
6843 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6844 (with-output-to-temp-buffer "*Help*"
6845 (princ help))
6846 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6847 (setq buffer-read-only nil)
6848 (let ((org-startup-truncated t)
6849 (org-startup-folded nil)
6850 (org-startup-align-all-tables nil))
6851 (org-mode)
6852 (org-overview))
6853 (setq buffer-read-only t)
6854 (if (and (boundp 'org-goto-start-pos)
6855 (integer-or-marker-p org-goto-start-pos))
6856 (let ((org-show-hierarchy-above t)
6857 (org-show-siblings t)
6858 (org-show-following-heading t))
6859 (goto-char org-goto-start-pos)
6860 (and (outline-invisible-p) (org-show-context)))
6861 (goto-char (point-min)))
6862 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6863 (message "Select location and press RET")
6864 (use-local-map org-goto-map)
6865 (recursive-edit)
6866 ))
6867 (kill-buffer "*org-goto*")
6868 (cons org-goto-selected-point org-goto-exit-command)))
6870 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6871 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6872 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6873 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6875 (defun org-goto-local-search-headings (string bound noerror)
6876 "Search and make sure that any matches are in headlines."
6877 (catch 'return
6878 (while (if isearch-forward
6879 (search-forward string bound noerror)
6880 (search-backward string bound noerror))
6881 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6882 (and (member :headline context)
6883 (not (member :tags context))))
6884 (throw 'return (point))))))
6886 (defun org-goto-local-auto-isearch ()
6887 "Start isearch."
6888 (interactive)
6889 (goto-char (point-min))
6890 (let ((keys (this-command-keys)))
6891 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6892 (isearch-mode t)
6893 (isearch-process-search-char (string-to-char keys)))))
6895 (defun org-goto-ret (&optional arg)
6896 "Finish `org-goto' by going to the new location."
6897 (interactive "P")
6898 (setq org-goto-selected-point (point)
6899 org-goto-exit-command 'return)
6900 (throw 'exit nil))
6902 (defun org-goto-left ()
6903 "Finish `org-goto' by going to the new location."
6904 (interactive)
6905 (if (org-at-heading-p)
6906 (progn
6907 (beginning-of-line 1)
6908 (setq org-goto-selected-point (point)
6909 org-goto-exit-command 'left)
6910 (throw 'exit nil))
6911 (error "Not on a heading")))
6913 (defun org-goto-right ()
6914 "Finish `org-goto' by going to the new location."
6915 (interactive)
6916 (if (org-at-heading-p)
6917 (progn
6918 (setq org-goto-selected-point (point)
6919 org-goto-exit-command 'right)
6920 (throw 'exit nil))
6921 (error "Not on a heading")))
6923 (defun org-goto-quit ()
6924 "Finish `org-goto' without cursor motion."
6925 (interactive)
6926 (setq org-goto-selected-point nil)
6927 (setq org-goto-exit-command 'quit)
6928 (throw 'exit nil))
6930 ;;; Indirect buffer display of subtrees
6932 (defvar org-indirect-dedicated-frame nil
6933 "This is the frame being used for indirect tree display.")
6934 (defvar org-last-indirect-buffer nil)
6936 (defun org-tree-to-indirect-buffer (&optional arg)
6937 "Create indirect buffer and narrow it to current subtree.
6938 With numerical prefix ARG, go up to this level and then take that tree.
6939 If ARG is negative, go up that many levels.
6940 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6941 indirect buffer previously made with this command, to avoid proliferation of
6942 indirect buffers. However, when you call the command with a \
6944 when `org-indirect-buffer-display' is `new-frame', the last buffer
6945 is kept so that you can work with several indirect buffers at the same time.
6946 If `org-indirect-buffer-display' is `dedicated-frame', the \
6948 requests that a new frame be made for the new buffer, so that the dedicated
6949 frame is not changed."
6950 (interactive "P")
6951 (let ((cbuf (current-buffer))
6952 (cwin (selected-window))
6953 (pos (point))
6954 beg end level heading ibuf)
6955 (save-excursion
6956 (org-back-to-heading t)
6957 (when (numberp arg)
6958 (setq level (org-outline-level))
6959 (if (< arg 0) (setq arg (+ level arg)))
6960 (while (> (setq level (org-outline-level)) arg)
6961 (outline-up-heading 1 t)))
6962 (setq beg (point)
6963 heading (org-get-heading))
6964 (org-end-of-subtree t t)
6965 (if (org-at-heading-p) (backward-char 1))
6966 (setq end (point)))
6967 (if (and (buffer-live-p org-last-indirect-buffer)
6968 (not (eq org-indirect-buffer-display 'new-frame))
6969 (not arg))
6970 (kill-buffer org-last-indirect-buffer))
6971 (setq ibuf (org-get-indirect-buffer cbuf)
6972 org-last-indirect-buffer ibuf)
6973 (cond
6974 ((or (eq org-indirect-buffer-display 'new-frame)
6975 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6976 (select-frame (make-frame))
6977 (delete-other-windows)
6978 (org-pop-to-buffer-same-window ibuf)
6979 (org-set-frame-title heading))
6980 ((eq org-indirect-buffer-display 'dedicated-frame)
6981 (raise-frame
6982 (select-frame (or (and org-indirect-dedicated-frame
6983 (frame-live-p org-indirect-dedicated-frame)
6984 org-indirect-dedicated-frame)
6985 (setq org-indirect-dedicated-frame (make-frame)))))
6986 (delete-other-windows)
6987 (org-pop-to-buffer-same-window ibuf)
6988 (org-set-frame-title (concat "Indirect: " heading)))
6989 ((eq org-indirect-buffer-display 'current-window)
6990 (org-pop-to-buffer-same-window ibuf))
6991 ((eq org-indirect-buffer-display 'other-window)
6992 (pop-to-buffer ibuf))
6993 (t (error "Invalid value")))
6994 (if (featurep 'xemacs)
6995 (save-excursion (org-mode) (turn-on-font-lock)))
6996 (narrow-to-region beg end)
6997 (show-all)
6998 (goto-char pos)
6999 (run-hook-with-args 'org-cycle-hook 'all)
7000 (and (window-live-p cwin) (select-window cwin))))
7002 (defun org-get-indirect-buffer (&optional buffer)
7003 (setq buffer (or buffer (current-buffer)))
7004 (let ((n 1) (base (buffer-name buffer)) bname)
7005 (while (buffer-live-p
7006 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7007 (setq n (1+ n)))
7008 (condition-case nil
7009 (make-indirect-buffer buffer bname 'clone)
7010 (error (make-indirect-buffer buffer bname)))))
7012 (defun org-set-frame-title (title)
7013 "Set the title of the current frame to the string TITLE."
7014 ;; FIXME: how to name a single frame in XEmacs???
7015 (unless (featurep 'xemacs)
7016 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7018 ;;;; Structure editing
7020 ;;; Inserting headlines
7022 (defun org-previous-line-empty-p ()
7023 (save-excursion
7024 (and (not (bobp))
7025 (or (beginning-of-line 0) t)
7026 (save-match-data
7029 (defun org-insert-heading (&optional force-heading invisible-ok)
7030 "Insert a new heading or item with same depth at point.
7031 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7032 If point is at the beginning of a headline, insert a sibling before the
7033 current headline. If point is not at the beginning, split the line,
7034 create the new headline with the text in the current line after point
7035 \(but see also the variable `org-M-RET-may-split-line').
7037 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7038 This is important for non-interactive uses of the command."
7039 (interactive "P")
7040 (if (or (= (buffer-size) 0)
7041 (and (not (save-excursion
7042 (and (ignore-errors (org-back-to-heading invisible-ok))
7043 (org-at-heading-p))))
7044 (or force-heading (not (org-in-item-p)))))
7045 (progn
7047 (run-hooks 'org-insert-heading-hook))
7048 (when (or force-heading (not (org-insert-item)))
7049 (let* ((empty-line-p nil)
7050 (level nil)
7051 (on-heading (org-at-heading-p))
7052 (head (save-excursion
7053 (condition-case nil
7054 (progn
7055 (org-back-to-heading invisible-ok)
7056 (when (and (not on-heading)
7057 (featurep 'org-inlinetask)
7058 (integerp org-inlinetask-min-level)
7059 (>= (length (match-string 0))
7060 org-inlinetask-min-level))
7061 ;; Find a heading level before the inline task
7062 (while (and (setq level (org-up-heading-safe))
7063 (>= level org-inlinetask-min-level)))
7064 (if (org-at-heading-p)
7065 (org-back-to-heading invisible-ok)
7066 (error "This should not happen")))
7067 (setq empty-line-p (org-previous-line-empty-p))
7068 (match-string 0))
7069 (error "*"))))
7070 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7071 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7072 pos hide-previous previous-pos)
7073 (cond
7074 ((and (org-at-heading-p) (bolp)
7075 (or (bobp)
7076 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7077 ;; insert before the current line
7078 (open-line (if blank 2 1)))
7079 ((and (bolp)
7080 (not org-insert-heading-respect-content)
7081 (or (bobp)
7082 (save-excursion
7083 (backward-char 1) (not (outline-invisible-p)))))
7084 ;; insert right here
7085 nil)
7086 (t
7087 ;; somewhere in the line
7088 (save-excursion
7089 (setq previous-pos (point-at-bol))
7090 (end-of-line)
7091 (setq hide-previous (outline-invisible-p)))
7092 (and org-insert-heading-respect-content (org-show-subtree))
7093 (let ((split
7094 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7095 (save-excursion
7096 (let ((p (point)))
7097 (goto-char (point-at-bol))
7098 (and (looking-at org-complex-heading-regexp)
7099 (match-beginning 4)
7100 (> p (match-beginning 4)))))))
7101 tags pos)
7102 (cond
7103 (org-insert-heading-respect-content
7104 (org-end-of-subtree nil t)
7105 (when (featurep 'org-inlinetask)
7106 (while (and (not (eobp))
7108 (>= (length (match-string 1))
7109 org-inlinetask-min-level))
7110 (org-end-of-subtree nil t)))
7111 (or (bolp) (newline))
7112 (or (org-previous-line-empty-p)
7113 (and blank (newline)))
7114 (open-line 1))
7115 ((org-at-heading-p)
7116 (when hide-previous
7117 (show-children)
7118 (org-show-entry))
7120 (setq tags (and (match-end 2) (match-string 2)))
7121 (and (match-end 1)
7122 (delete-region (match-beginning 1) (match-end 1)))
7123 (setq pos (point-at-bol))
7124 (or split (end-of-line 1))
7125 (delete-horizontal-space)
7127 (buffer-substring (point-at-bol) (point)))
7128 (insert " "))
7129 (newline (if blank 2 1))
7130 (when tags
7131 (save-excursion
7132 (goto-char pos)
7133 (end-of-line 1)
7134 (insert " " tags)
7135 (org-set-tags nil 'align))))
7136 (t
7137 (or split (end-of-line 1))
7138 (newline (if blank 2 1)))))))
7139 (insert head) (just-one-space)
7140 (setq pos (point))
7141 (end-of-line 1)
7142 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7143 (when (and org-insert-heading-respect-content hide-previous)
7144 (save-excursion
7145 (goto-char previous-pos)
7146 (hide-subtree)))
7147 (run-hooks 'org-insert-heading-hook)))))
7149 (defun org-get-heading (&optional no-tags no-todo)
7150 "Return the heading of the current entry, without the stars.
7151 When NO-TAGS is non-nil, don't include tags.
7152 When NO-TODO is non-nil, don't include TODO keywords."
7153 (save-excursion
7154 (org-back-to-heading t)
7155 (cond
7156 ((and no-tags no-todo)
7157 (looking-at org-complex-heading-regexp)
7158 (match-string 4))
7159 (no-tags
7160 (looking-at (concat org-outline-regexp
7163 (match-string 1))
7164 (no-todo
7165 (looking-at org-todo-line-regexp)
7166 (match-string 3))
7167 (t (looking-at org-heading-regexp)
7168 (match-string 2)))))
7170 (defun org-heading-components ()
7171 "Return the components of the current heading.
7172 This is a list with the following elements:
7173 - the level as an integer
7174 - the reduced level, different if `org-odd-levels-only' is set.
7175 - the TODO keyword, or nil
7176 - the priority character, like ?A, or nil if no priority is given
7177 - the headline text itself, or the tags string if no headline text
7178 - the tags string, or nil."
7179 (save-excursion
7180 (org-back-to-heading t)
7181 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7182 (list (length (match-string 1))
7183 (org-reduced-level (length (match-string 1)))
7184 (org-match-string-no-properties 2)
7185 (and (match-end 3) (aref (match-string 3) 2))
7186 (org-match-string-no-properties 4)
7187 (org-match-string-no-properties 5)))))
7189 (defun org-get-entry ()
7190 "Get the entry text, after heading, entire subtree."
7191 (save-excursion
7192 (org-back-to-heading t)
7193 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7195 (defun org-insert-heading-after-current ()
7196 "Insert a new heading with same level as current, after current subtree."
7197 (interactive)
7198 (org-back-to-heading)
7199 (org-insert-heading)
7200 (org-move-subtree-down)
7201 (end-of-line 1))
7203 (defun org-insert-heading-respect-content ()
7204 (interactive)
7205 (let ((org-insert-heading-respect-content t))
7206 (org-insert-heading t)))
7208 (defun org-insert-todo-heading-respect-content (&optional force-state)
7209 (interactive "P")
7210 (let ((org-insert-heading-respect-content t))
7211 (org-insert-todo-heading force-state t)))
7213 (defun org-insert-todo-heading (arg &optional force-heading)
7214 "Insert a new heading with the same level and TODO state as current heading.
7215 If the heading has no TODO state, or if the state is DONE, use the first
7216 state (TODO by default). Also with prefix arg, force first state."
7217 (interactive "P")
7218 (when (or force-heading (not (org-insert-item 'checkbox)))
7219 (org-insert-heading force-heading)
7220 (save-excursion
7221 (org-back-to-heading)
7222 (outline-previous-heading)
7223 (looking-at org-todo-line-regexp))
7224 (let*
7225 ((new-mark-x
7226 (if (or arg
7227 (not (match-beginning 2))
7228 (member (match-string 2) org-done-keywords))
7229 (car org-todo-keywords-1)
7230 (match-string 2)))
7231 (new-mark
7232 (or
7233 (run-hook-with-args-until-success
7234 'org-todo-get-default-hook new-mark-x nil)
7235 new-mark-x)))
7236 (beginning-of-line 1)
7237 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7238 (if org-treat-insert-todo-heading-as-state-change
7239 (org-todo new-mark)
7240 (insert new-mark " "))))
7241 (when org-provide-todo-statistics
7242 (org-update-parent-todo-statistics))))
7244 (defun org-insert-subheading (arg)
7245 "Insert a new subheading and demote it.
7246 Works for outline headings and for plain lists alike."
7247 (interactive "P")
7248 (org-insert-heading arg)
7249 (cond
7250 ((org-at-heading-p) (org-do-demote))
7251 ((org-at-item-p) (org-indent-item))))
7253 (defun org-insert-todo-subheading (arg)
7254 "Insert a new subheading with TODO keyword or checkbox and demote it.
7255 Works for outline headings and for plain lists alike."
7256 (interactive "P")
7257 (org-insert-todo-heading arg)
7258 (cond
7259 ((org-at-heading-p) (org-do-demote))
7260 ((org-at-item-p) (org-indent-item))))
7262 ;;; Promotion and Demotion
7264 (defvar org-after-demote-entry-hook nil
7265 "Hook run after an entry has been demoted.
7266 The cursor will be at the beginning of the entry.
7267 When a subtree is being demoted, the hook will be called for each node.")
7269 (defvar org-after-promote-entry-hook nil
7270 "Hook run after an entry has been promoted.
7271 The cursor will be at the beginning of the entry.
7272 When a subtree is being promoted, the hook will be called for each node.")
7274 (defun org-promote-subtree ()
7275 "Promote the entire subtree.
7276 See also `org-promote'."
7277 (interactive)
7278 (save-excursion
7279 (org-with-limited-levels (org-map-tree 'org-promote)))
7280 (org-fix-position-after-promote))
7282 (defun org-demote-subtree ()
7283 "Demote the entire subtree. See `org-demote'.
7284 See also `org-promote'."
7285 (interactive)
7286 (save-excursion
7287 (org-with-limited-levels (org-map-tree 'org-demote)))
7288 (org-fix-position-after-promote))
7291 (defun org-do-promote ()
7292 "Promote the current heading higher up the tree.
7293 If the region is active in `transient-mark-mode', promote all headings
7294 in the region."
7295 (interactive)
7296 (save-excursion
7297 (if (org-region-active-p)
7298 (org-map-region 'org-promote (region-beginning) (region-end))
7299 (org-promote)))
7300 (org-fix-position-after-promote))
7302 (defun org-do-demote ()
7303 "Demote the current heading lower down the tree.
7304 If the region is active in `transient-mark-mode', demote all headings
7305 in the region."
7306 (interactive)
7307 (save-excursion
7308 (if (org-region-active-p)
7309 (org-map-region 'org-demote (region-beginning) (region-end))
7310 (org-demote)))
7311 (org-fix-position-after-promote))
7313 (defun org-fix-position-after-promote ()
7314 "Make sure that after pro/demotion cursor position is right."
7315 (let ((pos (point)))
7316 (when (save-excursion
7317 (beginning-of-line 1)
7318 (looking-at org-todo-line-regexp)
7319 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7320 (cond ((eobp) (insert " "))
7321 ((eolp) (insert " "))
7322 ((equal (char-after) ?\ ) (forward-char 1))))))
7324 (defun org-current-level ()
7325 "Return the level of the current entry, or nil if before the first headline.
7326 The level is the number of stars at the beginning of the headline."
7327 (save-excursion
7328 (org-with-limited-levels
7329 (if (ignore-errors (org-back-to-heading t))
7330 (funcall outline-level)))))
7332 (defun org-get-previous-line-level ()
7333 "Return the outline depth of the last headline before the current line.
7334 Returns 0 for the first headline in the buffer, and nil if before the
7335 first headline."
7336 (let ((current-level (org-current-level))
7337 (prev-level (when (> (line-number-at-pos) 1)
7338 (save-excursion
7339 (beginning-of-line 0)
7340 (org-current-level)))))
7341 (cond ((null current-level) nil) ; Before first headline
7342 ((null prev-level) 0) ; At first headline
7343 (prev-level))))
7345 (defun org-reduced-level (l)
7346 "Compute the effective level of a heading.
7347 This takes into account the setting of `org-odd-levels-only'."
7348 (cond
7349 ((zerop l) 0)
7350 (org-odd-levels-only (1+ (floor (/ l 2))))
7351 (t l)))
7353 (defun org-level-increment ()
7354 "Return the number of stars that will be added or removed at a
7355 time to headlines when structure editing, based on the value of
7356 `org-odd-levels-only'."
7357 (if org-odd-levels-only 2 1))
7359 (defun org-get-valid-level (level &optional change)
7360 "Rectify a level change under the influence of `org-odd-levels-only'
7361 LEVEL is a current level, CHANGE is by how much the level should be
7362 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7363 even level numbers will become the next higher odd number."
7364 (if org-odd-levels-only
7365 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7366 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7367 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7368 (max 1 (+ level (or change 0)))))
7370 (if (boundp 'define-obsolete-function-alias)
7371 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7372 (define-obsolete-function-alias 'org-get-legal-level
7373 'org-get-valid-level)
7374 (define-obsolete-function-alias 'org-get-legal-level
7375 'org-get-valid-level "23.1")))
7377 (defun org-promote ()
7378 "Promote the current heading higher up the tree.
7379 If the region is active in `transient-mark-mode', promote all headings
7380 in the region."
7381 (org-back-to-heading t)
7382 (let* ((level (save-match-data (funcall outline-level)))
7383 (after-change-functions (remove 'flyspell-after-change-function
7384 after-change-functions))
7385 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7386 (diff (abs (- level (length up-head) -1))))
7387 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7388 (replace-match up-head nil t)
7389 ;; Fixup tag positioning
7390 (and org-auto-align-tags (org-set-tags nil t))
7391 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7392 (run-hooks 'org-after-promote-entry-hook)))
7394 (defun org-demote ()
7395 "Demote the current heading lower down the tree.
7396 If the region is active in `transient-mark-mode', demote all headings
7397 in the region."
7398 (org-back-to-heading t)
7399 (let* ((level (save-match-data (funcall outline-level)))
7400 (after-change-functions (remove 'flyspell-after-change-function
7401 after-change-functions))
7402 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7403 (diff (abs (- level (length down-head) -1))))
7404 (replace-match down-head nil t)
7405 ;; Fixup tag positioning
7406 (and org-auto-align-tags (org-set-tags nil t))
7407 (if org-adapt-indentation (org-fixup-indentation diff))
7408 (run-hooks 'org-after-demote-entry-hook)))
7410 (defun org-cycle-level ()
7411 "Cycle the level of an empty headline through possible states.
7412 This goes first to child, then to parent, level, then up the hierarchy.
7413 After top level, it switches back to sibling level."
7414 (interactive)
7415 (let ((org-adapt-indentation nil))
7416 (when (org-point-at-end-of-empty-headline)
7417 (setq this-command 'org-cycle-level) ; Only needed for caching
7418 (let ((cur-level (org-current-level))
7419 (prev-level (org-get-previous-line-level)))
7420 (cond
7421 ;; If first headline in file, promote to top-level.
7422 ((= prev-level 0)
7423 (loop repeat (/ (- cur-level 1) (org-level-increment))
7424 do (org-do-promote)))
7425 ;; If same level as prev, demote one.
7426 ((= prev-level cur-level)
7427 (org-do-demote))
7428 ;; If parent is top-level, promote to top level if not already.
7429 ((= prev-level 1)
7430 (loop repeat (/ (- cur-level 1) (org-level-increment))
7431 do (org-do-promote)))
7432 ;; If top-level, return to prev-level.
7433 ((= cur-level 1)
7434 (loop repeat (/ (- prev-level 1) (org-level-increment))
7435 do (org-do-demote)))
7436 ;; If less than prev-level, promote one.
7437 ((< cur-level prev-level)
7438 (org-do-promote))
7439 ;; If deeper than prev-level, promote until higher than
7440 ;; prev-level.
7441 ((> cur-level prev-level)
7442 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7443 do (org-do-promote))))
7444 t))))
7446 (defun org-map-tree (fun)
7447 "Call FUN for every heading underneath the current one."
7448 (org-back-to-heading)
7449 (let ((level (funcall outline-level)))
7450 (save-excursion
7451 (funcall fun)
7452 (while (and (progn
7453 (outline-next-heading)
7454 (> (funcall outline-level) level))
7455 (not (eobp)))
7456 (funcall fun)))))
7458 (defun org-map-region (fun beg end)
7459 "Call FUN for every heading between BEG and END."
7460 (let ((org-ignore-region t))
7461 (save-excursion
7462 (setq end (copy-marker end))
7463 (goto-char beg)
7464 (if (and (re-search-forward org-outline-regexp-bol nil t)
7465 (< (point) end))
7466 (funcall fun))
7467 (while (and (progn
7468 (outline-next-heading)
7469 (< (point) end))
7470 (not (eobp)))
7471 (funcall fun)))))
7473 (defvar org-property-end-re) ; silence byte-compiler
7474 (defun org-fixup-indentation (diff)
7475 "Change the indentation in the current entry by DIFF.
7476 However, if any line in the current entry has no indentation, or if it
7477 would end up with no indentation after the change, nothing at all is done."
7478 (save-excursion
7479 (let ((end (save-excursion (outline-next-heading)
7480 (point-marker)))
7481 (prohibit (if (> diff 0)
7484 col)
7485 (unless (save-excursion (end-of-line 1)
7486 (re-search-forward prohibit end t))
7487 (while (and (< (point) end)
7489 (goto-char (match-end 0))
7490 (setq col (current-column))
7491 (if (< diff 0) (replace-match ""))
7492 (org-indent-to-column (+ diff col))))
7493 (move-marker end nil))))
7495 (defun org-convert-to-odd-levels ()
7496 "Convert an org-mode file with all levels allowed to one with odd levels.
7497 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7498 level 5 etc."
7499 (interactive)
7500 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7501 (let ((outline-level 'org-outline-level)
7502 (org-odd-levels-only nil) n)
7503 (save-excursion
7504 (goto-char (point-min))
7506 (setq n (- (length (match-string 0)) 2))
7507 (while (>= (setq n (1- n)) 0)
7508 (org-demote))
7509 (end-of-line 1))))))
7511 (defun org-convert-to-oddeven-levels ()
7512 "Convert an org-mode file with only odd levels to one with odd/even levels.
7513 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7514 file contains a section with an even level, conversion would
7515 destroy the structure of the file. An error is signaled in this
7516 case."
7517 (interactive)
7518 (goto-char (point-min))
7519 ;; First check if there are no even levels
7521 (org-show-context t)
7522 (error "Not all levels are odd in this file. Conversion not possible"))
7523 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7524 (let ((outline-regexp org-outline-regexp)
7525 (outline-level 'org-outline-level)
7526 (org-odd-levels-only nil) n)
7527 (save-excursion
7528 (goto-char (point-min))
7530 (setq n (/ (1- (length (match-string 0))) 2))
7531 (while (>= (setq n (1- n)) 0)
7532 (org-promote))
7533 (end-of-line 1))))))
7535 (defun org-tr-level (n)
7536 "Make N odd if required."
7537 (if org-odd-levels-only (1+ (/ n 2)) n))
7539 ;;; Vertical tree motion, cutting and pasting of subtrees
7541 (defun org-move-subtree-up (&optional arg)
7542 "Move the current subtree up past ARG headlines of the same level."
7543 (interactive "p")
7544 (org-move-subtree-down (- (prefix-numeric-value arg))))
7546 (defun org-move-subtree-down (&optional arg)
7547 "Move the current subtree down past ARG headlines of the same level."
7548 (interactive "p")
7549 (setq arg (prefix-numeric-value arg))
7550 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7551 'org-get-last-sibling))
7552 (ins-point (make-marker))
7553 (cnt (abs arg))
7554 (col (current-column))
7555 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7556 ;; Select the tree
7557 (org-back-to-heading)
7558 (setq beg0 (point))
7559 (save-excursion
7560 (setq ne-beg (org-back-over-empty-lines))
7561 (setq beg (point)))
7562 (save-match-data
7563 (save-excursion (outline-end-of-heading)
7564 (setq folded (outline-invisible-p)))
7565 (outline-end-of-subtree))
7566 (outline-next-heading)
7567 (setq ne-end (org-back-over-empty-lines))
7568 (setq end (point))
7569 (goto-char beg0)
7570 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7571 ;; include less whitespace
7572 (save-excursion
7573 (goto-char beg)
7574 (forward-line (- ne-beg ne-end))
7575 (setq beg (point))))
7576 ;; Find insertion point, with error handling
7577 (while (> cnt 0)
7578 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7579 (progn (goto-char beg0)
7580 (error "Cannot move past superior level or buffer limit")))
7581 (setq cnt (1- cnt)))
7582 (if (> arg 0)
7583 ;; Moving forward - still need to move over subtree
7584 (progn (org-end-of-subtree t t)
7585 (save-excursion
7586 (org-back-over-empty-lines)
7587 (or (bolp) (newline)))))
7588 (setq ne-ins (org-back-over-empty-lines))
7589 (move-marker ins-point (point))
7590 (setq txt (buffer-substring beg end))
7591 (org-save-markers-in-region beg end)
7592 (delete-region beg end)
7593 (org-remove-empty-overlays-at beg)
7594 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7595 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7597 (let ((bbb (point)))
7598 (insert-before-markers txt)
7599 (org-reinstall-markers-in-region bbb)
7600 (move-marker ins-point bbb))
7602 (setq ins-end (point))
7603 (goto-char ins-point)
7604 (org-skip-whitespace)
7605 (when (and (< arg 0)
7606 (org-first-sibling-p)
7607 (> ne-ins ne-beg))
7608 ;; Move whitespace back to beginning
7609 (save-excursion
7610 (goto-char ins-end)
7611 (let ((kill-whole-line t))
7612 (kill-line (- ne-ins ne-beg)) (point)))
7614 (move-marker ins-point nil)
7615 (if folded
7616 (hide-subtree)
7617 (org-show-entry)
7618 (show-children)
7619 (org-cycle-hide-drawers 'children))
7620 (org-clean-visibility-after-subtree-move)
7621 ;; move back to the initial column we were at
7622 (move-to-column col)))
7624 (defvar org-subtree-clip ""
7625 "Clipboard for cut and paste of subtrees.
7626 This is actually only a copy of the kill, because we use the normal kill
7627 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7629 (defvar org-subtree-clip-folded nil
7630 "Was the last copied subtree folded?
7631 This is used to fold the tree back after pasting.")
7633 (defun org-cut-subtree (&optional n)
7634 "Cut the current subtree into the clipboard.
7635 With prefix arg N, cut this many sequential subtrees.
7636 This is a short-hand for marking the subtree and then cutting it."
7637 (interactive "p")
7638 (org-copy-subtree n 'cut))
7640 (defun org-copy-subtree (&optional n cut force-store-markers)
7641 "Cut the current subtree into the clipboard.
7642 With prefix arg N, cut this many sequential subtrees.
7643 This is a short-hand for marking the subtree and then copying it.
7644 If CUT is non-nil, actually cut the subtree.
7645 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7646 of some markers in the region, even if CUT is non-nil. This is
7647 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7648 (interactive "p")
7649 (let (beg end folded (beg0 (point)))
7650 (if (org-called-interactively-p 'any)
7651 (org-back-to-heading nil) ; take what looks like a subtree
7652 (org-back-to-heading t)) ; take what is really there
7653 (org-back-over-empty-lines)
7654 (setq beg (point))
7656 (save-match-data
7657 (save-excursion (outline-end-of-heading)
7658 (setq folded (outline-invisible-p)))
7659 (condition-case nil
7660 (org-forward-same-level (1- n) t)
7661 (error nil))
7662 (org-end-of-subtree t t))
7663 (org-back-over-empty-lines)
7664 (setq end (point))
7665 (goto-char beg0)
7666 (when (> end beg)
7667 (setq org-subtree-clip-folded folded)
7668 (when (or cut force-store-markers)
7669 (org-save-markers-in-region beg end))
7670 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7671 (setq org-subtree-clip (current-kill 0))
7672 (message "%s: Subtree(s) with %d characters"
7673 (if cut "Cut" "Copied")
7674 (length org-subtree-clip)))))
7676 (defun org-paste-subtree (&optional level tree for-yank)
7677 "Paste the clipboard as a subtree, with modification of headline level.
7678 The entire subtree is promoted or demoted in order to match a new headline
7679 level.
7681 If the cursor is at the beginning of a headline, the same level as
7682 that headline is used to paste the tree
7684 If not, the new level is derived from the *visible* headings
7685 before and after the insertion point, and taken to be the inferior headline
7686 level of the two. So if the previous visible heading is level 3 and the
7687 next is level 4 (or vice versa), level 4 will be used for insertion.
7688 This makes sure that the subtree remains an independent subtree and does
7689 not swallow low level entries.
7691 You can also force a different level, either by using a numeric prefix
7692 argument, or by inserting the heading marker by hand. For example, if the
7695 If optional TREE is given, use this text instead of the kill ring.
7697 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7698 move back over whitespace before inserting, and move point to the end of
7699 the inserted text when done."
7700 (interactive "P")
7701 (setq tree (or tree (and kill-ring (current-kill 0))))
7702 (unless (org-kill-is-subtree-p tree)
7703 (error "%s"
7704 (substitute-command-keys
7706 (org-with-limited-levels
7707 (let* ((visp (not (outline-invisible-p)))
7708 (txt tree)
7710 (old-level (if (string-match org-outline-regexp-bol txt)
7711 (- (match-end 0) (match-beginning 0) 1)
7712 -1))
7713 (force-level (cond (level (prefix-numeric-value level))
7715 (string-match
7717 (point-at-bol) (point))))
7718 (- (match-end 1) (match-beginning 1)))
7719 ((and (bolp)
7720 (looking-at org-outline-regexp))
7721 (- (match-end 0) (point) 1))
7722 (t nil)))
7723 (previous-level (save-excursion
7724 (condition-case nil
7725 (progn
7726 (outline-previous-visible-heading 1)
7727 (if (looking-at ^re_)
7728 (- (match-end 0) (match-beginning 0) 1)
7729 1))
7730 (error 1))))
7731 (next-level (save-excursion
7732 (condition-case nil
7733 (progn
7734 (or (looking-at org-outline-regexp)
7735 (outline-next-visible-heading 1))
7736 (if (looking-at ^re_)
7737 (- (match-end 0) (match-beginning 0) 1)
7738 1))
7739 (error 1))))
7740 (new-level (or force-level (max previous-level next-level)))
7741 (shift (if (or (= old-level -1)
7742 (= new-level -1)
7743 (= old-level new-level))
7744 0
7745 (- new-level old-level)))
7746 (delta (if (> shift 0) -1 1))
7747 (func (if (> shift 0) 'org-demote 'org-promote))
7748 (org-odd-levels-only nil)
7749 beg end newend)
7750 ;; Remove the forced level indicator
7751 (if force-level
7752 (delete-region (point-at-bol) (point)))
7753 ;; Paste
7754 (beginning-of-line (if (bolp) 1 2))
7755 (unless for-yank (org-back-over-empty-lines))
7756 (setq beg (point))
7757 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7758 (insert-before-markers txt)
7760 (setq newend (point))
7761 (org-reinstall-markers-in-region beg)
7762 (setq end (point))
7763 (goto-char beg)
7765 (setq beg (point))
7766 (if (and (outline-invisible-p) visp)
7767 (save-excursion (outline-show-heading)))
7768 ;; Shift if necessary
7769 (unless (= shift 0)
7770 (save-restriction
7771 (narrow-to-region beg end)
7772 (while (not (= shift 0))
7773 (org-map-region func (point-min) (point-max))
7774 (setq shift (+ delta shift)))
7775 (goto-char (point-min))
7776 (setq newend (point-max))))
7777 (when (or (org-called-interactively-p 'interactive) for-yank)
7778 (message "Clipboard pasted as level %d subtree" new-level))
7779 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7780 kill-ring
7781 (eq org-subtree-clip (current-kill 0))
7782 org-subtree-clip-folded)
7783 ;; The tree was folded before it was killed/copied
7784 (hide-subtree))
7785 (and for-yank (goto-char newend)))))
7787 (defun org-kill-is-subtree-p (&optional txt)
7788 "Check if the current kill is an outline subtree, or a set of trees.
7789 Returns nil if kill does not start with a headline, or if the first
7790 headline level is not the largest headline level in the tree.
7791 So this will actually accept several entries of equal levels as well,
7792 which is OK for `org-paste-subtree'.
7793 If optional TXT is given, check this string instead of the current kill."
7794 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7795 (re (org-get-limited-outline-regexp))
7796 (^re (concat "^" re))
7797 (start-level (and kill
7798 (string-match
7800 kill)
7801 (- (match-end 2) (match-beginning 2) 1)))
7802 (start (1+ (or (match-beginning 2) -1))))
7803 (if (not start-level)
7804 (progn
7805 nil) ;; does not even start with a heading
7806 (catch 'exit
7807 (while (setq start (string-match ^re kill (1+ start)))
7808 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7809 (throw 'exit nil)))
7810 t))))
7812 (defvar org-markers-to-move nil
7813 "Markers that should be moved with a cut-and-paste operation.
7814 Those markers are stored together with their positions relative to
7815 the start of the region.")
7817 (defun org-save-markers-in-region (beg end)
7818 "Check markers in region.
7819 If these markers are between BEG and END, record their position relative
7820 to BEG, so that after moving the block of text, we can put the markers back
7821 into place.
7822 This function gets called just before an entry or tree gets cut from the
7823 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7824 called immediately, to move the markers with the entries."
7825 (setq org-markers-to-move nil)
7826 (when (featurep 'org-clock)
7827 (org-clock-save-markers-for-cut-and-paste beg end))
7828 (when (featurep 'org-agenda)
7829 (org-agenda-save-markers-for-cut-and-paste beg end)))
7831 (defun org-check-and-save-marker (marker beg end)
7832 "Check if MARKER is between BEG and END.
7833 If yes, remember the marker and the distance to BEG."
7834 (when (and (marker-buffer marker)
7835 (equal (marker-buffer marker) (current-buffer)))
7836 (if (and (>= marker beg) (< marker end))
7837 (push (cons marker (- marker beg)) org-markers-to-move))))
7839 (defun org-reinstall-markers-in-region (beg)
7840 "Move all remembered markers to their position relative to BEG."
7841 (mapc (lambda (x)
7842 (move-marker (car x) (+ beg (cdr x))))
7843 org-markers-to-move)
7844 (setq org-markers-to-move nil))
7846 (defun org-narrow-to-subtree ()
7847 "Narrow buffer to the current subtree."
7848 (interactive)
7849 (save-excursion
7850 (save-match-data
7851 (org-with-limited-levels
7852 (narrow-to-region
7853 (progn (org-back-to-heading t) (point))
7854 (progn (org-end-of-subtree t t)
7855 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7856 (point)))))))
7858 (defun org-narrow-to-block ()
7859 "Narrow buffer to the current block."
7860 (interactive)
7861 (let* ((case-fold-search t)
7864 (if blockp
7865 (narrow-to-region (car blockp) (cdr blockp))
7866 (error "Not in a block"))))
7868 (eval-when-compile
7869 (defvar org-property-drawer-re))
7871 (defvar org-property-start-re) ;; defined below
7872 (defun org-clone-subtree-with-time-shift (n &optional shift)
7873 "Clone the task (subtree) at point N times.
7874 The clones will be inserted as siblings.
7876 In interactive use, the user will be prompted for the number of
7877 clones to be produced, and for a time SHIFT, which may be a
7878 repeater as used in time stamps, for example `+3d'.
7880 When a valid repeater is given and the entry contains any time
7881 stamps, the clones will become a sequence in time, with time
7882 stamps in the subtree shifted for each clone produced. If SHIFT
7883 is nil or the empty string, time stamps will be left alone. The
7884 ID property of the original subtree is removed.
7886 If the original subtree did contain time stamps with a repeater,
7887 the following will happen:
7888 - the repeater will be removed in each clone
7889 - an additional clone will be produced, with the current, unshifted
7890 date(s) in the entry.
7891 - the original entry will be placed *after* all the clones, with
7892 repeater intact.
7893 - the start days in the repeater in the original entry will be shifted
7894 to past the last clone.
7895 I this way you can spell out a number of instances of a repeating task,
7896 and still retain the repeater to cover future instances of the task."
7897 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7898 (let (beg end template task idprop
7899 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7900 (drawer-re org-drawer-regexp))
7901 (if (not (and (integerp n) (> n 0)))
7902 (error "Invalid number of replications %s" n))
7905 shift)))
7906 (error "Invalid shift specification %s" shift))
7907 (when doshift
7908 (setq shift-n (string-to-number (match-string 1 shift))
7909 shift-what (cdr (assoc (match-string 2 shift)
7910 '(("d" . day) ("w" . week)
7911 ("m" . month) ("y" . year))))))
7912 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7913 (setq nmin 1 nmax n)
7914 (org-back-to-heading t)
7915 (setq beg (point))
7916 (setq idprop (org-entry-get nil "ID"))
7917 (org-end-of-subtree t t)
7919 (setq end (point))
7920 (setq template (buffer-substring beg end))
7921 (when (and doshift
7923 (delete-region beg end)
7924 (setq end beg)
7925 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7926 (goto-char end)
7927 (loop for n from nmin to nmax do
7928 ;; prepare clone
7929 (with-temp-buffer
7930 (insert template)
7931 (org-mode)
7932 (goto-char (point-min))
7933 (org-show-subtree)
7934 (and idprop (if org-clone-delete-id
7935 (org-entry-delete nil "ID")
7936 (org-id-get-create t)))
7937 (unless (= n 0)
7939 (kill-whole-line))
7940 (goto-char (point-min))
7941 (while (re-search-forward drawer-re nil t)
7942 (mapc (lambda (d)
7943 (org-remove-empty-drawer-at d (point))) org-drawers)))
7944 (goto-char (point-min))
7945 (when doshift
7946 (while (re-search-forward org-ts-regexp-both nil t)
7947 (org-timestamp-change (* n shift-n) shift-what))
7948 (unless (= n n-no-remove)
7949 (goto-char (point-min))
7950 (while (re-search-forward org-ts-regexp nil t)
7951 (save-excursion
7952 (goto-char (match-beginning 0))
7954 (delete-region (match-beginning 1) (match-end 1)))))))
7955 (setq task (buffer-string)))
7956 (insert task))
7957 (goto-char beg)))
7959 ;;; Outline Sorting
7961 (defun org-sort (with-case)
7962 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7963 Optional argument WITH-CASE means sort case-sensitively."
7964 (interactive "P")
7965 (cond
7966 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7967 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7968 (t
7969 (org-call-with-arg 'org-sort-entries with-case))))
7971 (defun org-sort-remove-invisible (s)
7972 (remove-text-properties 0 (length s) org-rm-props s)
7973 (while (string-match org-bracket-link-regexp s)
7974 (setq s (replace-match (if (match-end 2)
7975 (match-string 3 s)
7976 (match-string 1 s)) t t s)))
7977 s)
7979 (defvar org-priority-regexp) ; defined later in the file
7981 (defvar org-after-sorting-entries-or-items-hook nil
7982 "Hook that is run after a bunch of entries or items have been sorted.
7983 When children are sorted, the cursor is in the parent line when this
7984 hook gets called. When a region or a plain list is sorted, the cursor
7985 will be in the first entry of the sorted region/list.")
7987 (defun org-sort-entries
7988 (&optional with-case sorting-type getkey-func compare-func property)
7989 "Sort entries on a certain level of an outline tree.
7990 If there is an active region, the entries in the region are sorted.
7991 Else, if the cursor is before the first entry, sort the top-level items.
7992 Else, the children of the entry at point are sorted.
7994 Sorting can be alphabetically, numerically, by date/time as given by
7995 a time stamp, by a property or by priority.
7997 The command prompts for the sorting type unless it has been given to the
7998 function through the SORTING-TYPE argument, which needs to be a character,
7999 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8000 precise meaning of each character:
8002 n Numerically, by converting the beginning of the entry/item to a number.
8003 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8004 t By date/time, either the first active time stamp in the entry, or, if
8005 none exist, by the first inactive one.
8006 s By the scheduled date/time.
8007 d By deadline date/time.
8008 c By creation time, which is assumed to be the first inactive time stamp
8009 at the beginning of a line.
8010 p By priority according to the cookie.
8011 r By the value of a property.
8013 Capital letters will reverse the sort order.
8015 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8016 called with point at the beginning of the record. It must return either
8017 a string or a number that should serve as the sorting key for that record.
8019 Comparing entries ignores case by default. However, with an optional argument
8020 WITH-CASE, the sorting considers case as well."
8021 (interactive "P")
8022 (let ((case-func (if with-case 'identity 'downcase))
8023 start beg end stars re re2
8024 txt what tmp)
8025 ;; Find beginning and end of region to sort
8026 (cond
8027 ((org-region-active-p)
8028 ;; we will sort the region
8029 (setq end (region-end)
8030 what "region")
8031 (goto-char (region-beginning))
8032 (if (not (org-at-heading-p)) (outline-next-heading))
8033 (setq start (point)))
8034 ((or (org-at-heading-p)
8035 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8036 ;; we will sort the children of the current headline
8037 (org-back-to-heading)
8038 (setq start (point)
8039 end (progn (org-end-of-subtree t t)
8041 (org-back-over-empty-lines)
8042 (point))
8043 what "children")
8044 (goto-char start)
8045 (show-subtree)
8046 (outline-next-heading))
8047 (t
8048 ;; we will sort the top-level entries in this file
8049 (goto-char (point-min))
8050 (or (org-at-heading-p) (outline-next-heading))
8051 (setq start (point))
8052 (goto-char (point-max))
8053 (beginning-of-line 1)
8055 ;; File ends in a non-white line
8056 (end-of-line 1)
8058 (setq end (point-max))
8059 (setq what "top-level")
8060 (goto-char start)
8061 (show-all)))
8063 (setq beg (point))
8064 (if (>= beg end) (error "Nothing to sort"))
8067 (setq stars (match-string 1)
8068 re (concat "^" (regexp-quote stars) " +")
8070 txt (buffer-substring beg end))
8072 (if (and (not (equal stars "*")) (string-match re2 txt))
8073 (error "Region to sort contains a level above the first entry"))
8075 (unless sorting-type
8076 (message
8077 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8079 A/N/T/S/D/C/P/O/F means reversed:"
8080 what)
8081 (setq sorting-type (read-char-exclusive))
8083 (and (= (downcase sorting-type) ?f)
8084 (setq getkey-func
8085 (org-icompleting-read "Sort using function: "
8086 obarray 'fboundp t nil nil))
8087 (setq getkey-func (intern getkey-func)))
8089 (and (= (downcase sorting-type) ?r)
8090 (setq property
8091 (org-icompleting-read "Property: "
8092 (mapcar 'list (org-buffer-property-keys t))
8093 nil t))))
8095 (message "Sorting entries...")
8097 (save-restriction
8098 (narrow-to-region start end)
8099 (let ((dcst (downcase sorting-type))
8100 (case-fold-search nil)
8101 (now (current-time)))
8102 (sort-subr
8103 (/= dcst sorting-type)
8104 ;; This function moves to the beginning character of the "record" to
8105 ;; be sorted.
8106 (lambda nil
8107 (if (re-search-forward re nil t)
8108 (goto-char (match-beginning 0))
8109 (goto-char (point-max))))
8110 ;; This function moves to the last character of the "record" being
8111 ;; sorted.
8112 (lambda nil
8113 (save-match-data
8114 (condition-case nil
8115 (outline-forward-same-level 1)
8116 (error
8117 (goto-char (point-max))))))
8118 ;; This function returns the value that gets sorted against.
8119 (lambda nil
8120 (cond
8121 ((= dcst ?n)
8122 (if (looking-at org-complex-heading-regexp)
8123 (string-to-number (match-string 4))
8124 nil))
8125 ((= dcst ?a)
8126 (if (looking-at org-complex-heading-regexp)
8127 (funcall case-func (match-string 4))
8128 nil))
8129 ((= dcst ?t)
8130 (let ((end (save-excursion (outline-next-heading) (point))))
8131 (if (or (re-search-forward org-ts-regexp end t)
8132 (re-search-forward org-ts-regexp-both end t))
8133 (org-time-string-to-seconds (match-string 0))
8134 (org-float-time now))))
8135 ((= dcst ?c)
8136 (let ((end (save-excursion (outline-next-heading) (point))))
8137 (if (re-search-forward
8139 end t)
8140 (org-time-string-to-seconds (match-string 0))
8141 (org-float-time now))))
8142 ((= dcst ?s)
8143 (let ((end (save-excursion (outline-next-heading) (point))))
8144 (if (re-search-forward org-scheduled-time-regexp end t)
8145 (org-time-string-to-seconds (match-string 1))
8146 (org-float-time now))))
8147 ((= dcst ?d)
8148 (let ((end (save-excursion (outline-next-heading) (point))))
8149 (if (re-search-forward org-deadline-time-regexp end t)
8150 (org-time-string-to-seconds (match-string 1))
8151 (org-float-time now))))
8152 ((= dcst ?p)
8153 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8154 (string-to-char (match-string 2))
8155 org-default-priority))
8156 ((= dcst ?r)
8157 (or (org-entry-get nil property) ""))
8158 ((= dcst ?o)
8159 (if (looking-at org-complex-heading-regexp)
8160 (- 9999 (length (member (match-string 2)
8161 org-todo-keywords-1)))))
8162 ((= dcst ?f)
8163 (if getkey-func
8164 (progn
8165 (setq tmp (funcall getkey-func))
8166 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8167 tmp)
8168 (error "Invalid key function `%s'" getkey-func)))
8169 (t (error "Invalid sorting type `%c'" sorting-type))))
8170 nil
8171 (cond
8172 ((= dcst ?a) 'string<)
8173 ((= dcst ?f) compare-func)
8174 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8175 (t nil)))))
8176 (run-hooks 'org-after-sorting-entries-or-items-hook)
8177 (message "Sorting entries...done")))
8179 (defun org-do-sort (table what &optional with-case sorting-type)
8180 "Sort TABLE of WHAT according to SORTING-TYPE.
8181 The user will be prompted for the SORTING-TYPE if the call to this
8182 function does not specify it. WHAT is only for the prompt, to indicate
8183 what is being sorted. The sorting key will be extracted from
8184 the car of the elements of the table.
8185 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8186 (unless sorting-type
8187 (message
8188 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8189 what)
8190 (setq sorting-type (read-char-exclusive)))
8191 (let ((dcst (downcase sorting-type))
8192 extractfun comparefun)
8193 ;; Define the appropriate functions
8194 (cond
8195 ((= dcst ?n)
8196 (setq extractfun 'string-to-number
8197 comparefun (if (= dcst sorting-type) '< '>)))
8198 ((= dcst ?a)
8199 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8200 (lambda(x) (downcase (org-sort-remove-invisible x))))
8201 comparefun (if (= dcst sorting-type)
8202 'string<
8203 (lambda (a b) (and (not (string< a b))
8204 (not (string= a b)))))))
8205 ((= dcst ?t)
8206 (setq extractfun
8207 (lambda (x)
8208 (if (or (string-match org-ts-regexp x)
8209 (string-match org-ts-regexp-both x))
8210 (org-float-time
8211 (org-time-string-to-time (match-string 0 x)))
8212 0))
8213 comparefun (if (= dcst sorting-type) '< '>)))
8214 (t (error "Invalid sorting type `%c'" sorting-type)))
8216 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8217 table)
8218 (lambda (a b) (funcall comparefun (car a) (car b))))))
8221 ;;; The orgstruct minor mode
8223 ;; Define a minor mode which can be used in other modes in order to
8224 ;; integrate the org-mode structure editing commands.
8226 ;; This is really a hack, because the org-mode structure commands use
8227 ;; keys which normally belong to the major mode. Here is how it
8228 ;; works: The minor mode defines all the keys necessary to operate the
8229 ;; structure commands, but wraps the commands into a function which
8230 ;; tests if the cursor is currently at a headline or a plain list
8231 ;; item. If that is the case, the structure command is used,
8232 ;; temporarily setting many Org-mode variables like regular
8233 ;; expressions for filling etc. However, when any of those keys is
8234 ;; used at a different location, function uses `key-binding' to look
8235 ;; up if the key has an associated command in another currently active
8236 ;; keymap (minor modes, major mode, global), and executes that
8237 ;; command. There might be problems if any of the keys is otherwise
8238 ;; used as a prefix key.
8240 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8241 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8242 ;; addresses this by checking explicitly for both bindings.
8244 (defvar orgstruct-mode-map (make-sparse-keymap)
8245 "Keymap for the minor `orgstruct-mode'.")
8247 (defvar org-local-vars nil
8248 "List of local variables, for use by `orgstruct-mode'.")
8250 ;;;###autoload
8251 (define-minor-mode orgstruct-mode
8252 "Toggle the minor mode `orgstruct-mode'.
8253 This mode is for using Org-mode structure commands in other
8254 modes. The following keys behave as if Org-mode were active, if
8255 the cursor is on a headline, or on a plain list item (both as
8256 defined by Org-mode).
8258 M-up Move entry/item up
8259 M-down Move entry/item down
8260 M-left Promote
8261 M-right Demote
8262 M-S-up Move entry/item up
8263 M-S-down Move entry/item down
8264 M-S-left Promote subtree
8265 M-S-right Demote subtree
8266 M-q Fill paragraph and items like in Org-mode
8267 C-c ^ Sort entries
8268 C-c - Cycle list bullet
8269 TAB Cycle item visibility
8270 M-RET Insert new heading/item
8271 S-M-RET Insert new TODO heading / Checkbox item
8272 C-c C-c Set tags / toggle checkbox"
8273 nil " OrgStruct" nil
8274 (org-load-modules-maybe)
8275 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8277 ;;;###autoload
8278 (defun turn-on-orgstruct ()
8279 "Unconditionally turn on `orgstruct-mode'."
8280 (orgstruct-mode 1))
8282 (defun orgstruct++-mode (&optional arg)
8283 "Toggle `orgstruct-mode', the enhanced version of it.
8284 In addition to setting orgstruct-mode, this also exports all indentation
8285 and autofilling variables from org-mode into the buffer. It will also
8286 recognize item context in multiline items.
8287 Note that turning off orgstruct-mode will *not* remove the
8288 indentation/paragraph settings. This can only be done by refreshing the
8290 (interactive "P")
8291 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8292 (if (< arg 1)
8293 (orgstruct-mode -1)
8294 (orgstruct-mode 1)
8295 (let (var val)
8296 (mapc
8297 (lambda (x)
8298 (when (string-match
8300 (symbol-name (car x)))
8301 (setq var (car x) val (nth 1 x))
8302 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8303 org-local-vars)
8304 (org-set-local 'orgstruct-is-++ t))))
8306 (defvar orgstruct-is-++ nil
8307 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8308 (make-variable-buffer-local 'orgstruct-is-++)
8310 ;;;###autoload
8311 (defun turn-on-orgstruct++ ()
8312 "Unconditionally turn on `orgstruct++-mode'."
8313 (orgstruct++-mode 1))
8315 (defun orgstruct-error ()
8316 "Error when there is no default binding for a structure key."
8317 (interactive)
8318 (error "This key has no function outside structure elements"))
8320 (defun orgstruct-setup ()
8321 "Setup orgstruct keymaps."
8322 (let ((nfunc 0)
8323 (bindings
8324 (list
8325 '([(meta up)] org-metaup)
8326 '([(meta down)] org-metadown)
8327 '([(meta left)] org-metaleft)
8328 '([(meta right)] org-metaright)
8329 '([(meta shift up)] org-shiftmetaup)
8330 '([(meta shift down)] org-shiftmetadown)
8331 '([(meta shift left)] org-shiftmetaleft)
8332 '([(meta shift right)] org-shiftmetaright)
8333 '([?\e (up)] org-metaup)
8334 '([?\e (down)] org-metadown)
8335 '([?\e (left)] org-metaleft)
8336 '([?\e (right)] org-metaright)
8337 '([?\e (shift up)] org-shiftmetaup)
8338 '([?\e (shift down)] org-shiftmetadown)
8339 '([?\e (shift left)] org-shiftmetaleft)
8340 '([?\e (shift right)] org-shiftmetaright)
8341 '([(shift up)] org-shiftup)
8342 '([(shift down)] org-shiftdown)
8343 '([(shift left)] org-shiftleft)
8344 '([(shift right)] org-shiftright)
8345 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8346 '("\M-q" fill-paragraph)
8347 '("\C-c^" org-sort)
8348 '("\C-c-" org-cycle-list-bullet)))
8349 elt key fun cmd)
8350 (while (setq elt (pop bindings))
8351 (setq nfunc (1+ nfunc))
8352 (setq key (org-key (car elt))
8353 fun (nth 1 elt)
8354 cmd (orgstruct-make-binding fun nfunc key))
8355 (org-defkey orgstruct-mode-map key cmd))
8357 ;; Special treatment needed for TAB and RET
8358 (org-defkey orgstruct-mode-map [(tab)]
8359 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8360 (org-defkey orgstruct-mode-map "\C-i"
8361 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8363 (org-defkey orgstruct-mode-map "\M-\C-m"
8364 (orgstruct-make-binding 'org-insert-heading 105
8365 "\M-\C-m" [(meta return)]))
8366 (org-defkey orgstruct-mode-map [(meta return)]
8367 (orgstruct-make-binding 'org-insert-heading 106
8368 [(meta return)] "\M-\C-m"))
8370 (org-defkey orgstruct-mode-map [(shift meta return)]
8371 (orgstruct-make-binding 'org-insert-todo-heading 107
8372 [(meta return)] "\M-\C-m"))
8374 (org-defkey orgstruct-mode-map "\e\C-m"
8375 (orgstruct-make-binding 'org-insert-heading 108
8376 "\e\C-m" [?\e (return)]))
8377 (org-defkey orgstruct-mode-map [?\e (return)]
8378 (orgstruct-make-binding 'org-insert-heading 109
8379 [?\e (return)] "\e\C-m"))
8380 (org-defkey orgstruct-mode-map [?\e (shift return)]
8381 (orgstruct-make-binding 'org-insert-todo-heading 110
8382 [?\e (return)] "\e\C-m"))
8384 (unless org-local-vars
8385 (setq org-local-vars (org-get-local-variables)))
8387 t))
8389 (defun orgstruct-make-binding (fun n &rest keys)
8390 "Create a function for binding in the structure minor mode.
8391 FUN is the command to call inside a table. N is used to create a unique
8392 command name. KEYS are keys that should be checked in for a command
8393 to execute outside of tables."
8394 (eval
8395 (list 'defun
8396 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8397 '(arg)
8399 "Outside of structure, run the binding of `"
8400 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8401 "'.")
8402 '(interactive "p")
8403 (list 'if
8404 `(org-context-p 'headline 'item
8405 (and orgstruct-is-++
8406 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8407 'item-body))
8408 (list 'org-run-like-in-org-mode (list 'quote fun))
8409 (list 'let '(orgstruct-mode)
8410 (list 'call-interactively
8411 (append '(or)
8412 (mapcar (lambda (k)
8413 (list 'key-binding k))
8414 keys)
8415 '('orgstruct-error))))))))
8417 (defun org-context-p (&rest contexts)
8418 "Check if local context is any of CONTEXTS.
8419 Possible values in the list of contexts are `table', `headline', and `item'."
8420 (let ((pos (point)))
8421 (goto-char (point-at-bol))
8422 (prog1 (or (and (memq 'table contexts)
8424 (and (memq 'headline contexts)
8425 (looking-at org-outline-regexp))
8426 (and (memq 'item contexts)
8428 (and (memq 'item-body contexts)
8429 (org-in-item-p)))
8430 (goto-char pos))))
8432 (defun org-get-local-variables ()
8433 "Return a list of all local variables in an org-mode buffer."
8434 (let (varlist)
8435 (with-current-buffer (get-buffer-create "*Org tmp*")
8436 (erase-buffer)
8437 (org-mode)
8438 (setq varlist (buffer-local-variables)))
8439 (kill-buffer "*Org tmp*")
8440 (delq nil
8441 (mapcar
8442 (lambda (x)
8443 (setq x
8444 (if (symbolp x)
8445 (list x)
8446 (list (car x) (list 'quote (cdr x)))))
8447 (if (string-match
8448 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8449 (symbol-name (car x)))
8450 x nil))
8451 varlist))))
8453 (defun org-clone-local-variables (from-buffer &optional regexp)
8454 "Clone local variables from FROM-BUFFER.
8455 Optional argument REGEXP selects variables to clone."
8456 (mapc
8457 (lambda (pair)
8458 (and (symbolp (car pair))
8459 (or (null regexp)
8460 (string-match regexp (symbol-name (car pair))))
8461 (set (make-local-variable (car pair))
8462 (cdr pair))))
8463 (buffer-local-variables from-buffer)))
8465 ;;;###autoload
8466 (defun org-run-like-in-org-mode (cmd)
8467 "Run a command, pretending that the current buffer is in Org-mode.
8468 This will temporarily bind local variables that are typically bound in
8469 Org-mode to the values they have in Org-mode, and then interactively
8470 call CMD."
8471 (org-load-modules-maybe)
8472 (unless org-local-vars
8473 (setq org-local-vars (org-get-local-variables)))
8474 (eval (list 'let org-local-vars
8475 (list 'call-interactively (list 'quote cmd)))))
8477 ;;;; Archiving
8479 (defun org-get-category (&optional pos force-refresh)
8480 "Get the category applying to position POS."
8481 (if force-refresh (org-refresh-category-properties))
8482 (let ((pos (or pos (point))))
8483 (or (get-text-property pos 'org-category)
8484 (progn (org-refresh-category-properties)
8485 (get-text-property pos 'org-category)))))
8487 (defun org-refresh-category-properties ()
8488 "Refresh category text properties in the buffer."
8489 (let ((def-cat (cond
8490 ((null org-category)
8491 (if buffer-file-name
8492 (file-name-sans-extension
8493 (file-name-nondirectory buffer-file-name))
8494 "???"))
8495 ((symbolp org-category) (symbol-name org-category))
8496 (t org-category)))
8497 beg end cat pos optionp)
8498 (org-unmodified
8499 (save-excursion
8500 (save-restriction
8501 (widen)
8502 (goto-char (point-min))
8503 (put-text-property (point) (point-max) 'org-category def-cat)
8504 (while (re-search-forward
8506 (setq pos (match-end 0)
8507 optionp (equal (char-after (match-beginning 0)) ?#)
8508 cat (org-trim (match-string 2)))
8509 (if optionp
8510 (setq beg (point-at-bol) end (point-max))
8511 (org-back-to-heading t)
8512 (setq beg (point) end (org-end-of-subtree t t)))
8513 (put-text-property beg end 'org-category cat)
8514 (put-text-property beg end 'org-category-position beg)
8515 (goto-char pos)))))))
8518 ;;;; Link Stuff
8520 ;;; Link abbreviations
8522 (defun org-link-expand-abbrev (link)
8523 "Apply replacements as defined in `org-link-abbrev-alist."
8525 (let* ((key (match-string 1 link))
8526 (as (or (assoc key org-link-abbrev-alist-local)
8527 (assoc key org-link-abbrev-alist)))
8528 (tag (and (match-end 2) (match-string 3 link)))
8529 rpl)
8530 (if (not as)
8531 link
8532 (setq rpl (cdr as))
8533 (cond
8534 ((symbolp rpl) (funcall rpl tag))
8535 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8536 ((string-match "%h" rpl)
8537 (replace-match (url-hexify-string (or tag "")) t t rpl))
8538 (t (concat rpl tag)))))
8539 link))
8541 ;;; Storing and inserting links
8543 (defvar org-insert-link-history nil
8544 "Minibuffer history for links inserted with `org-insert-link'.")
8546 (defvar org-stored-links nil
8547 "Contains the links stored with `org-store-link'.")
8549 (defvar org-store-link-plist nil
8550 "Plist with info about the most recently link created with `org-store-link'.")
8552 (defvar org-link-protocols nil
8553 "Link protocols added to Org-mode using `org-add-link-type'.")
8555 (defvar org-store-link-functions nil
8556 "List of functions that are called to create and store a link.
8557 Each function will be called in turn until one returns a non-nil
8558 value. Each function should check if it is responsible for creating
8559 this link (for example by looking at the major mode).
8560 If not, it must exit and return nil.
8561 If yes, it should return a non-nil value after a calling
8562 `org-store-link-props' with a list of properties and values.
8563 Special properties are:
8567 This is obligatory as well.
8568 :description Optional default description for the second pair
8569 of brackets in an Org-mode link. The user can still change
8570 this when inserting this link into an Org-mode buffer.
8572 In addition to these, any additional properties can be specified
8573 and then used in remember templates.")
8575 (defun org-add-link-type (type &optional follow export)
8576 "Add TYPE to the list of `org-link-types'.
8577 Re-compute all regular expressions depending on `org-link-types'
8579 FOLLOW and EXPORT are two functions.
8581 FOLLOW should take the link path as the single argument and do whatever
8582 is necessary to follow the link, for example find a file or display
8583 a mail message.
8585 EXPORT should format the link path for export to one of the export formats.
8586 It should be a function accepting three arguments:
8589 desc the description of the link, if any, or a description added by
8590 org-export-normalize-links if there is none
8591 format the export format, a symbol like `html' or `latex' or `ascii'..
8593 The function may use the FORMAT information to return different values
8594 depending on the format. The return value will be put literally into
8595 the exported file. If the return value is nil, this means Org should
8596 do what it normally does with links which do not have EXPORT defined.
8598 Org-mode has a built-in default for exporting links. If you are happy with
8599 this default, there is no need to define an export function for the link
8600 type. For a simple example of an export function, see `org-bbdb.el'."
8601 (add-to-list 'org-link-types type t)
8602 (org-make-link-regexps)
8603 (if (assoc type org-link-protocols)
8604 (setcdr (assoc type org-link-protocols) (list follow export))
8605 (push (list type follow export) org-link-protocols)))
8607 (defvar org-agenda-buffer-name)
8609 ;;;###autoload
8610 (defun org-store-link (arg)
8612 This link is added to `org-stored-links' and can later be inserted
8615 For some link types, a prefix arg is interpreted:
8616 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8617 For file links, arg negates `org-context-in-file-links'."
8618 (interactive "P")
8619 (org-load-modules-maybe)
8620 (setq org-store-link-plist nil) ; reset
8621 (org-with-limited-levels
8622 (let (link cpltxt desc description search txt custom-id agenda-link)
8623 (cond
8625 ((run-hook-with-args-until-success 'org-store-link-functions)
8626 (setq link (plist-get org-store-link-plist :link)
8627 desc (or (plist-get org-store-link-plist :description) link)))
8629 ((equal (buffer-name) "*Org Edit Src Example*")
8630 (let (label gc)
8631 (while (or (not label)
8632 (save-excursion
8633 (save-restriction
8634 (widen)
8635 (goto-char (point-min))
8636 (re-search-forward
8637 (regexp-quote (format org-coderef-label-format label))
8638 nil t))))
8639 (when label (message "Label exists already") (sit-for 2))
8640 (setq label (read-string "Code line label: " label)))
8641 (end-of-line 1)
8642 (setq link (format org-coderef-label-format label))
8643 (setq gc (- 79 (length link)))
8644 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8645 (insert link)
8646 (setq link (concat "(" label ")") desc nil)))
8648 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8649 ;; We are in the agenda, link to referenced location
8650 (let ((m (or (get-text-property (point) 'org-hd-marker)
8651 (get-text-property (point) 'org-marker))))
8652 (when m
8653 (org-with-point-at m
8654 (setq agenda-link
8655 (if (org-called-interactively-p 'any)
8656 (call-interactively 'org-store-link)
8657 (org-store-link nil)))))))
8659 ((eq major-mode 'calendar-mode)
8660 (let ((cd (calendar-cursor-to-date)))
8661 (setq link
8662 (format-time-string
8663 (car org-time-stamp-formats)
8664 (apply 'encode-time
8665 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8666 nil nil nil))))
8667 (org-store-link-props :type "calendar" :date cd)))
8669 ((eq major-mode 'w3-mode)
8670 (setq cpltxt (if (and (buffer-name)
8671 (not (string-match "Untitled" (buffer-name))))
8672 (buffer-name)
8673 (url-view-url t))
8674 link (org-make-link (url-view-url t)))
8675 (org-store-link-props :type "w3" :url (url-view-url t)))
8677 ((eq major-mode 'w3m-mode)
8678 (setq cpltxt (or w3m-current-title w3m-current-url)
8679 link (org-make-link w3m-current-url))
8680 (org-store-link-props :type "w3m" :url (url-view-url t)))
8682 ((setq search (run-hook-with-args-until-success
8683 'org-create-file-search-functions))
8684 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8685 "::" search))
8686 (setq cpltxt (or description link)))
8688 ((eq major-mode 'image-mode)
8689 (setq cpltxt (concat "file:"
8690 (abbreviate-file-name buffer-file-name))
8691 link (org-make-link cpltxt))
8692 (org-store-link-props :type "image" :file buffer-file-name))
8694 ((eq major-mode 'dired-mode)
8695 ;; link to the file in the current line
8696 (let ((file (dired-get-filename nil t)))
8697 (setq file (if file
8698 (abbreviate-file-name
8699 (expand-file-name (dired-get-filename nil t)))
8700 ;; otherwise, no file so use current directory.
8701 default-directory))
8702 (setq cpltxt (concat "file:" file)
8703 link (org-make-link cpltxt))))
8705 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8706 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8707 (cond
8709 (setq cpltxt
8710 (concat "file:"
8711 (abbreviate-file-name
8712 (buffer-file-name (buffer-base-buffer)))
8713 "::" (match-string 1))
8714 link (org-make-link cpltxt)))
8715 ((and (featurep 'org-id)
8716 (or (eq org-link-to-org-use-id t)
8717 (and (eq org-link-to-org-use-id 'create-if-interactive)
8718 (org-called-interactively-p 'any))
8719 (and (eq org-link-to-org-use-id
8720 'create-if-interactive-and-no-custom-id)
8721 (org-called-interactively-p 'any)
8722 (not custom-id))
8723 (and org-link-to-org-use-id
8724 (org-entry-get nil "ID"))))
8725 ;; We can make a link using the ID.
8726 (setq link (condition-case nil
8727 (prog1 (org-id-store-link)
8728 (setq desc (plist-get org-store-link-plist
8729 :description)))
8730 (error
8731 ;; probably before first headline, link to file only
8732 (concat "file:"
8733 (abbreviate-file-name
8734 (buffer-file-name (buffer-base-buffer))))))))
8735 (t
8736 ;; Just link to current headline
8737 (setq cpltxt (concat "file:"
8738 (abbreviate-file-name
8739 (buffer-file-name (buffer-base-buffer)))))
8740 ;; Add a context search string
8741 (when (org-xor org-context-in-file-links arg)
8742 (setq txt (cond
8743 ((org-at-heading-p) nil)
8744 ((org-region-active-p)
8745 (buffer-substring (region-beginning) (region-end)))
8746 (t nil)))
8748 (setq cpltxt
8749 (concat cpltxt "::"
8750 (condition-case nil
8751 (org-make-org-heading-search-string txt)
8752 (error "")))
8753 desc (or (nth 4 (ignore-errors
8754 (org-heading-components))) "NONE"))))
8756 (setq cpltxt (substring cpltxt 0 -2)))
8757 (setq link (org-make-link cpltxt)))))
8759 ((buffer-file-name (buffer-base-buffer))
8760 ;; Just link to this file here.
8761 (setq cpltxt (concat "file:"
8762 (abbreviate-file-name
8763 (buffer-file-name (buffer-base-buffer)))))
8764 ;; Add a context string
8765 (when (org-xor org-context-in-file-links arg)
8766 (setq txt (if (org-region-active-p)
8767 (buffer-substring (region-beginning) (region-end))
8768 (buffer-substring (point-at-bol) (point-at-eol))))
8769 ;; Only use search option if there is some text.
8771 (setq cpltxt
8772 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8773 desc "NONE")))
8774 (setq link (org-make-link cpltxt)))
8776 ((org-called-interactively-p 'interactive)
8777 (error "Cannot link to a buffer which is not visiting a file"))
8779 (t (setq link nil)))
8781 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8782 (setq link (or link cpltxt)
8783 desc (or desc cpltxt))
8784 (if (equal desc "NONE") (setq desc nil))
8786 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8787 (progn
8788 (setq org-stored-links
8789 (cons (list link desc) org-stored-links))
8790 (message "Stored: %s" (or desc link))
8791 (when custom-id
8792 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8793 "::#" custom-id))
8794 (setq org-stored-links
8795 (cons (list link desc) org-stored-links))))
8796 (or agenda-link (and link (org-make-link-string link desc)))))))
8798 (defun org-store-link-props (&rest plist)
8799 "Store link properties, extract names and addresses."
8800 (let (x adr)
8801 (when (setq x (plist-get plist :from))
8802 (setq adr (mail-extract-address-components x))
8803 (setq plist (plist-put plist :fromname (car adr)))
8804 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8805 (when (setq x (plist-get plist :to))
8806 (setq adr (mail-extract-address-components x))
8807 (setq plist (plist-put plist :toname (car adr)))
8808 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8809 (let ((from (plist-get plist :from))
8810 (to (plist-get plist :to)))
8811 (when (and from to org-from-is-user-regexp)
8812 (setq plist
8813 (plist-put plist :fromto
8814 (if (string-match org-from-is-user-regexp from)
8815 (concat "to %t")
8816 (concat "from %f"))))))
8817 (setq org-store-link-plist plist))
8819 (defun org-add-link-props (&rest plist)
8820 "Add these properties to the link property list."
8821 (let (key value)
8822 (while plist
8823 (setq key (pop plist) value (pop plist))
8824 (setq org-store-link-plist
8825 (plist-put org-store-link-plist key value)))))
8827 (defun org-email-link-description (&optional fmt)
8828 "Return the description part of an email link.
8829 This takes information from `org-store-link-plist' and formats it
8830 according to FMT (default from `org-email-link-description-format')."
8831 (setq fmt (or fmt org-email-link-description-format))
8832 (let* ((p org-store-link-plist)
8833 (to (plist-get p :toaddress))
8834 (from (plist-get p :fromaddress))
8835 (table
8836 (list
8837 (cons "%c" (plist-get p :fromto))
8838 (cons "%F" (plist-get p :from))
8839 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8840 (cons "%T" (plist-get p :to))
8841 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8842 (cons "%s" (plist-get p :subject))
8843 (cons "%d" (plist-get p :date))
8844 (cons "%m" (plist-get p :message-id)))))
8845 (when (string-match "%c" fmt)
8846 ;; Check if the user wrote this message
8847 (if (and org-from-is-user-regexp from to
8848 (save-match-data (string-match org-from-is-user-regexp from)))
8849 (setq fmt (replace-match "to %t" t t fmt))
8850 (setq fmt (replace-match "from %f" t t fmt))))
8851 (org-replace-escapes fmt table)))
8853 (defun org-make-org-heading-search-string (&optional string heading)
8854 "Make search string for STRING or current headline."
8855 (interactive)
8856 (let ((s (or string (org-get-heading)))
8857 (lines org-context-in-file-links))
8858 (unless (and string (not heading))
8859 ;; We are using a headline, clean up garbage in there.
8860 (if (string-match org-todo-regexp s)
8861 (setq s (replace-match "" t t s)))
8863 (setq s (replace-match "" t t s)))
8864 (setq s (org-trim s))
8867 (setq s (replace-match "" t t s)))
8868 (while (string-match org-ts-regexp s)
8869 (setq s (replace-match "" t t s))))
8870 (or string (setq s (concat "*" s))) ; Add * for headlines
8871 (when (and string (integerp lines) (> lines 0))
8873 (when (< lines (length slines))
8874 (setq s (mapconcat
8875 'identity
8876 (reverse (nthcdr (- (length slines) lines)
8880 (defun org-make-link (&rest strings)
8881 "Concatenate STRINGS."
8882 (apply 'concat strings))
8884 (defun org-make-link-string (link &optional description)
8885 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8887 (error "Empty link"))
8888 (when (and description
8889 (stringp description)
8891 (setq description nil))
8892 (when (stringp description)
8893 ;; Remove brackets from the description, they are fatal.
8895 (setq description (replace-match "{" t t description)))
8897 (setq description (replace-match "}" t t description))))
8898 (when (equal link description)
8899 ;; No description needed, it is identical
8900 (setq description nil))
8901 (when (and (not description)
8902 (not (string-match (org-image-file-name-regexp) link))
8903 (not (equal link (org-link-escape link))))
8904 (setq description (org-extract-attributes link)))
8905 (setq link
8906 (cond ((string-match (org-image-file-name-regexp) link) link)
8907 ((string-match org-link-types-re link)
8908 (concat (match-string 1 link)
8909 (org-link-escape (substring link (match-end 1)))))
8910 (t (org-link-escape link))))
8911 (concat "[[" link "]"
8912 (if description (concat "[" description "]") "")
8913 "]"))
8915 (defconst org-link-escape-chars
8916 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8917 "List of characters that should be escaped in link.
8918 This is the list that is used for internal purposes.")
8920 (defvar org-url-encoding-use-url-hexify nil)
8922 (defconst org-link-escape-chars-browser
8923 '(?\ )
8924 "List of escapes for characters that are problematic in links.
8925 This is the list that is used before handing over to the browser.")
8927 (defun org-link-escape (text &optional table merge)
8928 "Return percent escaped representation of TEXT.
8929 TEXT is a string with the text to escape.
8930 Optional argument TABLE is a list with characters that should be
8931 escaped. When nil, `org-link-escape-chars' is used.
8932 If optional argument MERGE is set, merge TABLE into
8933 `org-link-escape-chars'."
8934 (if (and org-url-encoding-use-url-hexify (not table))
8935 (url-hexify-string text)
8936 (cond
8937 ((and table merge)
8938 (mapc (lambda (defchr)
8939 (unless (member defchr table)
8940 (setq table (cons defchr table)))) org-link-escape-chars))
8941 ((null table)
8942 (setq table org-link-escape-chars)))
8943 (mapconcat
8944 (lambda (char)
8945 (if (or (member char table)
8946 (< char 32) (= char 37) (> char 126))
8947 (mapconcat (lambda (sequence-element)
8948 (format "%%%.2X" sequence-element))
8949 (or (encode-coding-char char 'utf-8)
8950 (error "Unable to percent escape character: %s"
8951 (char-to-string char))) "")
8952 (char-to-string char))) text "")))
8954 (defun org-link-unescape (str)
8955 "Unhex hexified Unicode strings as returned from the JavaScript function
8956 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8957 (unless (and (null str) (string= "" str))
8958 (let ((pos 0) (case-fold-search t) unhexed)
8960 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8961 (setq str (replace-match unhexed t t str))
8962 (setq pos (+ pos (length unhexed))))))
8963 str)
8965 (defun org-link-unescape-compound (hex)
8966 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8967 Note: this function also decodes single byte encodings like
8969 (save-match-data
8970 (let* ((bytes (cdr (split-string hex "%")))
8971 (ret "")
8972 (eat 0)
8973 (sum 0))
8974 (while bytes
8975 (let* ((val (string-to-number (pop bytes) 16))
8976 (shift-xor
8977 (if (= 0 eat)
8978 (cond
8979 ((>= val 252) (cons 6 252))
8980 ((>= val 248) (cons 5 248))
8981 ((>= val 240) (cons 4 240))
8982 ((>= val 224) (cons 3 224))
8983 ((>= val 192) (cons 2 192))
8984 (t (cons 0 0)))
8985 (cons 6 128))))
8986 (if (>= val 192) (setq eat (car shift-xor)))
8987 (setq val (logxor val (cdr shift-xor)))
8988 (setq sum (+ (lsh sum (car shift-xor)) val))
8989 (if (> eat 0) (setq eat (- eat 1)))
8990 (cond
8991 ((= 0 eat) ;multi byte
8992 (setq ret (concat ret (org-char-to-string sum)))
8993 (setq sum 0))
8994 ((not bytes) ; single byte(s)
8995 (setq ret (org-link-unescape-single-byte-sequence hex))))
8996 )) ;; end (while bytes
8997 ret )))
8999 (defun org-link-unescape-single-byte-sequence (hex)
9000 "Unhexify hex-encoded single byte character sequences."
9001 (mapconcat (lambda (byte)
9002 (char-to-string (string-to-number byte 16)))
9003 (cdr (split-string hex "%")) ""))
9005 (defun org-xor (a b)
9006 "Exclusive or."
9007 (if a (not b) b))
9009 (defun org-fixup-message-id-for-http (s)
9010 "Replace special characters in a message id, so it can be used in an http query."
9011 (when (string-match "%" s)
9012 (setq s (mapconcat (lambda (c)
9013 (if (eq c ?%)
9014 "%25"
9015 (char-to-string c)))
9016 s "")))
9017 (while (string-match "<" s)
9018 (setq s (replace-match "%3C" t t s)))
9019 (while (string-match ">" s)
9020 (setq s (replace-match "%3E" t t s)))
9021 (while (string-match "@" s)
9022 (setq s (replace-match "%40" t t s)))
9023 s)
9025 ;;;###autoload
9026 (defun org-insert-link-global ()
9027 "Insert a link like Org-mode does.
9028 This command can be called in any mode to insert a link in Org-mode syntax."
9029 (interactive)
9030 (org-load-modules-maybe)
9031 (org-run-like-in-org-mode 'org-insert-link))
9033 (defun org-insert-link (&optional complete-file link-location default-description)
9034 "Insert a link. At the prompt, enter the link.
9036 Completion can be used to insert any of the link protocol prefixes like
9037 http or ftp in use.
9039 The history can be used to select a link previously stored with
9040 `org-store-link'. When the empty string is entered (i.e. if you just
9041 press RET at the prompt), the link defaults to the most recently
9042 stored link. As SPC triggers completion in the minibuffer, you need to
9043 use M-SPC or C-q SPC to force the insertion of a space character.
9045 You will also be prompted for a description, and if one is given, it will
9046 be displayed in the buffer instead of the link.
9048 If there is already a link at point, this command will allow you to edit link
9049 and description parts.
9052 be selected using completion. The path to the file will be relative to the
9053 current directory if the file is in the current directory or a subdirectory.
9054 Otherwise, the link will be the absolute path as completed in the minibuffer
9055 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9056 option `org-link-file-path-type'.
9059 the current directory or below.
9062 `org-keep-stored-link-after-insertion'.
9064 If `org-make-link-description-function' is non-nil, this function will be
9065 called with the link target, and the result will be the default
9066 link description.
9068 If the LINK-LOCATION parameter is non-nil, this value will be
9069 used as the link location instead of reading one interactively.
9071 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9072 be used as the default description."
9073 (interactive "P")
9074 (let* ((wcf (current-window-configuration))
9075 (region (if (org-region-active-p)
9076 (buffer-substring (region-beginning) (region-end))))
9077 (remove (and region (list (region-beginning) (region-end))))
9078 (desc region)
9079 tmphist ; byte-compile incorrectly complains about this
9080 (link link-location)
9081 entry file all-prefixes)
9082 (cond
9083 (link-location) ; specified by arg, just use it.
9084 ((org-in-regexp org-bracket-link-regexp 1)
9085 ;; We do have a link at point, and we are going to edit it.
9086 (setq remove (list (match-beginning 0) (match-end 0)))
9087 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9088 (setq link (read-string "Link: "
9089 (org-link-unescape
9090 (org-match-string-no-properties 1)))))
9091 ((or (org-in-regexp org-angle-link-re)
9092 (org-in-regexp org-plain-link-re))
9093 ;; Convert to bracket link
9094 (setq remove (list (match-beginning 0) (match-end 0))
9095 link (read-string "Link: "
9096 (org-remove-angle-brackets (match-string 0)))))
9097 ((member complete-file '((4) (16)))
9098 ;; Completing read for file names.
9099 (setq link (org-file-complete-link complete-file)))
9100 (t
9101 ;; Read link, with completion for stored links.
9102 (with-output-to-temp-buffer "*Org Links*"
9103 (princ "Insert a link.
9105 (when org-stored-links
9107 (princ (mapconcat
9108 (lambda (x)
9109 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9111 (let ((cw (selected-window)))
9112 (select-window (get-buffer-window "*Org Links*" 'visible))
9113 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9114 (unless (pos-visible-in-window-p (point-max))
9115 (org-fit-window-to-buffer))
9116 (and (window-live-p cw) (select-window cw)))
9117 ;; Fake a link history, containing the stored links.
9118 (setq tmphist (append (mapcar 'car org-stored-links)
9119 org-insert-link-history))
9120 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9121 (mapcar 'car org-link-abbrev-alist)
9122 org-link-types))
9123 (unwind-protect
9124 (progn
9125 (setq link
9126 (let ((org-completion-use-ido nil)
9127 (org-completion-use-iswitchb nil))
9128 (org-completing-read
9129 "Link: "
9130 (append
9131 (mapcar (lambda (x) (list (concat x ":")))
9132 all-prefixes)
9133 (mapcar 'car org-stored-links))
9134 nil nil nil
9135 'tmphist
9136 (car (car org-stored-links)))))
9138 (error "No link selected"))
9139 (if (or (member link all-prefixes)
9140 (and (equal ":" (substring link -1))
9141 (member (substring link 0 -1) all-prefixes)
9142 (setq link (substring link 0 -1))))
9143 (setq link (org-link-try-special-completion link))))
9144 (set-window-configuration wcf)
9145 (kill-buffer "*Org Links*"))
9146 (setq entry (assoc link org-stored-links))
9147 (or entry (push link org-insert-link-history))
9148 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9149 (not org-keep-stored-link-after-insertion))
9150 (setq org-stored-links (delq (assoc link org-stored-links)
9151 org-stored-links)))
9152 (setq desc (or desc (nth 1 entry)))))
9154 (if (string-match org-plain-link-re link)
9155 ;; URL-like link, normalize the use of angular brackets.
9156 (setq link (org-make-link (org-remove-angle-brackets link))))
9158 ;; Check if we are linking to the current file with a search option
9159 ;; If yes, simplify the link by using only the search option.
9160 (when (and buffer-file-name
9162 (let* ((path (match-string 1 link))
9163 (case-fold-search nil)
9164 (search (match-string 2 link)))
9165 (save-match-data
9166 (if (equal (file-truename buffer-file-name) (file-truename path))
9167 ;; We are linking to this same file, with a search option
9168 (setq link search)))))
9170 ;; Check if we can/should use a relative path. If yes, simplify the link
9172 (let* ((type (match-string 1 link))
9173 (path (match-string 2 link))
9174 (origpath path)
9175 (case-fold-search nil))
9176 (cond
9177 ((or (eq org-link-file-path-type 'absolute)
9178 (equal complete-file '(16)))
9179 (setq path (abbreviate-file-name (expand-file-name path))))
9180 ((eq org-link-file-path-type 'noabbrev)
9181 (setq path (expand-file-name path)))
9182 ((eq org-link-file-path-type 'relative)
9183 (setq path (file-relative-name path)))
9184 (t
9185 (save-match-data
9186 (if (string-match (concat "^" (regexp-quote
9187 (expand-file-name
9188 (file-name-as-directory
9189 default-directory))))
9190 (expand-file-name path))
9191 ;; We are linking a file with relative path name.
9192 (setq path (substring (expand-file-name path)
9193 (match-end 0)))
9194 (setq path (abbreviate-file-name (expand-file-name path)))))))
9195 (setq link (concat type path))
9196 (if (equal desc origpath)
9197 (setq desc path))))
9199 (if org-make-link-description-function
9200 (setq desc (funcall org-make-link-description-function link desc))
9201 (if default-description (setq desc default-description)))
9203 (setq desc (read-string "Description: " desc))
9205 (if remove (apply 'delete-region remove))
9206 (insert (org-make-link-string link desc))))
9208 (defun org-link-try-special-completion (type)
9209 "If there is completion support for link type TYPE, offer it."
9210 (let ((fun (intern (concat "org-" type "-complete-link"))))
9211 (if (functionp fun)
9212 (funcall fun)
9213 (read-string "Link (no completion support): " (concat type ":")))))
9215 (defun org-file-complete-link (&optional arg)
9216 "Create a file link using completion."
9217 (let (file link)
9218 (setq file (read-file-name "File: "))
9219 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9220 (pwd1 (file-name-as-directory (abbreviate-file-name
9221 (expand-file-name ".")))))
9222 (cond
9223 ((equal arg '(16))
9224 (setq link (org-make-link
9225 "file:"
9226 (abbreviate-file-name (expand-file-name file)))))
9228 (setq link (org-make-link "file:" (match-string 1 file))))
9230 (expand-file-name file))
9231 (setq link (org-make-link
9232 "file:" (match-string 1 (expand-file-name file)))))
9233 (t (setq link (org-make-link "file:" file)))))
9234 link))
9236 (defun org-completing-read (&rest args)
9237 "Completing-read with SPACE being a normal character."
9238 (let ((enable-recursive-minibuffers t)
9239 (minibuffer-local-completion-map
9240 (copy-keymap minibuffer-local-completion-map)))
9241 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9242 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9243 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9244 (apply 'org-icompleting-read args)))
9246 (defun org-completing-read-no-i (&rest args)
9247 (let (org-completion-use-ido org-completion-use-iswitchb)
9248 (apply 'org-completing-read args)))
9250 (defun org-iswitchb-completing-read (prompt choices &rest args)
9251 "Use iswitch as a completing-read replacement to choose from choices.
9252 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9253 from."
9254 (let* ((iswitchb-use-virtual-buffers nil)
9255 (iswitchb-make-buflist-hook
9256 (lambda ()
9257 (setq iswitchb-temp-buflist choices))))
9258 (iswitchb-read-buffer prompt)))
9260 (defun org-icompleting-read (&rest args)
9261 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9262 (org-without-partial-completion
9263 (if (and org-completion-use-ido
9264 (fboundp 'ido-completing-read)
9265 (boundp 'ido-mode) ido-mode
9266 (listp (second args)))
9267 (let ((ido-enter-matching-directory nil))
9268 (apply 'ido-completing-read (concat (car args))
9269 (if (consp (car (nth 1 args)))
9270 (mapcar 'car (nth 1 args))
9271 (nth 1 args))
9272 (cddr args)))
9273 (if (and org-completion-use-iswitchb
9274 (boundp 'iswitchb-mode) iswitchb-mode
9275 (listp (second args)))
9276 (apply 'org-iswitchb-completing-read (concat (car args))
9277 (if (consp (car (nth 1 args)))
9278 (mapcar 'car (nth 1 args))
9279 (nth 1 args))
9280 (cddr args))
9281 (apply 'completing-read args)))))
9283 (defun org-extract-attributes (s)
9284 "Extract the attributes cookie from a string and set as text property."
9285 (let (a attr (start 0) key value)
9286 (save-match-data
9288 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9290 (setq key (match-string 1 a) value (match-string 2 a)
9291 start (match-end 0)
9292 attr (plist-put attr (intern key) value))))
9293 (org-add-props s nil 'org-attr attr))
9294 s))
9296 (defun org-extract-attributes-from-string (tag)
9297 (let (key value attr)
9299 (setq key (match-string 1 tag) value (match-string 2 tag)
9300 tag (replace-match "" t t tag)
9301 attr (plist-put attr (intern key) value)))
9302 (cons tag attr)))
9304 (defun org-attributes-to-string (plist)
9305 "Format a property list into an HTML attribute list."
9306 (let ((s "") key value)
9307 (while plist
9308 (setq key (pop plist) value (pop plist))
9309 (and value
9311 s))
9313 ;;; Opening/following a link
9315 (defvar org-link-search-failed nil)
9317 (defvar org-open-link-functions nil
9318 "Hook for functions finding a plain text link.
9319 These functions must take a single argument, the link content.
9320 They will be called for links that look like [[link text][description]]
9324 These functions will be called *before* Org attempts to resolve the
9325 link by doing text searches in the current buffer - so if you want a
9327 handle this as a special case.
9329 When the function does handle the link, it must return a non-nil value.
9330 If it decides that it is not responsible for this link, it must return
9331 nil to indicate that that Org-mode can continue with other options
9332 like exact and fuzzy text search.")
9334 (defun org-next-link ()
9335 "Move forward to the next link.
9336 If the link is in hidden text, expose it."
9337 (interactive)
9338 (when (and org-link-search-failed (eq this-command last-command))
9339 (goto-char (point-min))
9340 (message "Link search wrapped back to beginning of buffer"))
9341 (setq org-link-search-failed nil)
9342 (let* ((pos (point))
9343 (ct (org-context))
9344 (a (assoc :link ct)))
9345 (if a (goto-char (nth 2 a)))
9346 (if (re-search-forward org-any-link-re nil t)
9347 (progn
9348 (goto-char (match-beginning 0))
9349 (if (outline-invisible-p) (org-show-context)))
9350 (goto-char pos)
9351 (setq org-link-search-failed t)
9352 (error "No further link found"))))
9354 (defun org-previous-link ()
9355 "Move backward to the previous link.
9356 If the link is in hidden text, expose it."
9357 (interactive)
9358 (when (and org-link-search-failed (eq this-command last-command))
9359 (goto-char (point-max))
9360 (message "Link search wrapped back to end of buffer"))
9361 (setq org-link-search-failed nil)
9362 (let* ((pos (point))
9363 (ct (org-context))
9364 (a (assoc :link ct)))
9365 (if a (goto-char (nth 1 a)))
9366 (if (re-search-backward org-any-link-re nil t)
9367 (progn
9368 (goto-char (match-beginning 0))
9369 (if (outline-invisible-p) (org-show-context)))
9370 (goto-char pos)
9371 (setq org-link-search-failed t)
9372 (error "No further link found"))))
9374 (defun org-translate-link (s)
9375 "Translate a link string if a translation function has been defined."
9376 (if (and org-link-translation-function
9377 (fboundp org-link-translation-function)
9379 (progn
9380 (setq s (funcall org-link-translation-function
9381 (match-string 1) (match-string 2)))
9382 (concat (car s) ":" (cdr s)))
9383 s))
9385 (defun org-translate-link-from-planner (type path)
9386 "Translate a link from Emacs Planner syntax so that Org can follow it.
9387 This is still an experimental function, your mileage may vary."
9388 (cond
9389 ((member type '("http" "https" "news" "ftp"))
9390 ;; standard Internet links are the same.
9391 nil)
9392 ((and (equal type "irc") (string-match "^//" path))
9393 ;; Planner has two / at the beginning of an irc link, we have 1.
9394 ;; We should have zero, actually....
9395 (setq path (substring path 1)))
9396 ((and (equal type "lisp") (string-match "^/" path))
9397 ;; Planner has a slash, we do not.
9398 (setq type "elisp" path (substring path 1)))
9400 ;; A typical message link. Planner has the id after the final slash,
9401 ;; we separate it with a hash mark
9402 (setq path (concat (match-string 1 path) "#"
9403 (org-remove-angle-brackets (match-string 2 path)))))
9404 )
9405 (cons type path))
9407 (defun org-find-file-at-mouse (ev)
9408 "Open file link or URL at mouse."
9409 (interactive "e")
9410 (mouse-set-point ev)
9411 (org-open-at-point 'in-emacs))
9413 (defun org-open-at-mouse (ev)
9414 "Open file link or URL at mouse.
9415 See the docstring of `org-open-file' for details."
9416 (interactive "e")
9417 (mouse-set-point ev)
9418 (if (eq major-mode 'org-agenda-mode)
9419 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9420 (org-open-at-point))
9422 (defvar org-window-config-before-follow-link nil
9423 "The window configuration before following a link.
9424 This is saved in case the need arises to restore it.")
9426 (defvar org-open-link-marker (make-marker)
9427 "Marker pointing to the location where `org-open-at-point; was called.")
9429 ;;;###autoload
9430 (defun org-open-at-point-global ()
9431 "Follow a link like Org-mode does.
9432 This command can be called in any mode to follow a link that has
9433 Org-mode syntax."
9434 (interactive)
9435 (org-run-like-in-org-mode 'org-open-at-point))
9437 ;;;###autoload
9438 (defun org-open-link-from-string (s &optional arg reference-buffer)
9439 "Open a link in the string S, as if it was in Org-mode."
9441 (let ((reference-buffer (or reference-buffer (current-buffer))))
9442 (with-temp-buffer
9443 (let ((org-inhibit-startup t))
9444 (org-mode)
9445 (insert s)
9446 (goto-char (point-min))
9447 (when reference-buffer
9448 (setq org-link-abbrev-alist-local
9449 (with-current-buffer reference-buffer
9450 org-link-abbrev-alist-local)))
9451 (org-open-at-point arg reference-buffer)))))
9453 (defvar org-open-at-point-functions nil
9454 "Hook that is run when following a link at point.
9456 Functions in this hook must return t if they identify and follow
9457 a link at point. If they don't find anything interesting at point,
9458 they must return nil.")
9460 (defun org-open-at-point (&optional arg reference-buffer)
9461 "Open link at or after point.
9462 If there is no link at point, this function will search forward up to
9463 the end of the current line.
9464 Normally, files will be opened by an appropriate application. If the
9465 optional prefix argument ARG is non-nil, Emacs will visit the file.
9466 With a double prefix argument, try to open outside of Emacs, in the
9467 application the system uses for this file type."
9468 (interactive "P")
9469 ;; if in a code block, then open the block's results
9470 (unless (call-interactively #'org-babel-open-src-block-result)
9471 (org-load-modules-maybe)
9472 (move-marker org-open-link-marker (point))
9473 (setq org-window-config-before-follow-link (current-window-configuration))
9474 (org-remove-occur-highlights nil nil t)
9475 (cond
9476 ((and (org-at-heading-p)
9477 (not (org-in-regexp
9482 (not (get-text-property (point) 'org-linked-text)))
9483 (or (org-offer-links-in-entry arg)
9484 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9485 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9486 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9487 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9488 (not (org-in-regexp org-bracket-link-regexp)))
9489 (org-footnote-action))
9490 (t
9491 (let (type path link line search (pos (point)))
9492 (catch 'match
9493 (save-excursion
9495 (when (org-in-regexp org-bracket-link-regexp 1)
9496 (setq link (org-extract-attributes
9497 (org-link-unescape (org-match-string-no-properties 1))))
9499 (setq link (replace-match " " t t link)))
9500 (setq link (org-link-expand-abbrev link))
9501 (cond
9502 ((or (file-name-absolute-p link)
9504 (setq type "file" path link))
9505 ((string-match org-link-re-with-space3 link)
9506 (setq type (match-string 1 link) path (match-string 2 link)))
9507 (t (setq type "thisfile" path link)))
9508 (throw 'match t)))
9510 (when (get-text-property (point) 'org-linked-text)
9511 (setq type "thisfile"
9512 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9513 (1+ (point)) (point))
9514 path (buffer-substring
9515 (or (previous-single-property-change pos 'org-linked-text)
9516 (point-min))
9517 (or (next-single-property-change pos 'org-linked-text)
9518 (point-max))))
9519 (throw 'match t))
9521 (save-excursion
9522 (when (or (org-in-regexp org-angle-link-re)
9523 (org-in-regexp org-plain-link-re))
9524 (setq type (match-string 1)
9525 path (org-link-unescape (match-string 2)))
9526 (throw 'match t)))
9527 (save-excursion
9529 (setq type "tags"
9530 path (match-string 1))
9531 (while (string-match ":" path)
9532 (setq path (replace-match "+" t t path)))
9533 (throw 'match t)))
9535 (setq type "tree-match"
9536 path (match-string 1))
9537 (throw 'match t)))
9538 (unless path
9539 (error "No link found"))
9541 ;; switch back to reference buffer
9542 ;; needed when if called in a temporary buffer through
9543 ;; org-open-link-from-string
9544 (with-current-buffer (or reference-buffer (current-buffer))
9546 ;; Remove any trailing spaces in path
9548 (setq path (replace-match "" t t path)))
9549 (if (and org-link-translation-function
9550 (fboundp org-link-translation-function))
9551 ;; Check if we need to translate the link
9552 (let ((tmp (funcall org-link-translation-function type path)))
9553 (setq type (car tmp) path (cdr tmp))))
9555 (cond
9557 ((assoc type org-link-protocols)
9558 (funcall (nth 1 (assoc type org-link-protocols)) path))
9560 ((equal type "mailto")
9561 (let ((cmd (car org-link-mailto-program))
9562 (args (cdr org-link-mailto-program)) args1
9563 (address path) (subject "") a)
9565 (setq address (match-string 1 path)
9566 subject (org-link-escape (match-string 2 path))))
9567 (while args
9568 (cond
9569 ((not (stringp (car args))) (push (pop args) args1))
9570 (t (setq a (pop args))
9571 (if (string-match "%a" a)
9572 (setq a (replace-match address t t a)))
9573 (if (string-match "%s" a)
9574 (setq a (replace-match subject t t a)))
9575 (push a args1))))
9576 (apply cmd (nreverse args1))))
9578 ((member type '("http" "https" "ftp" "news"))
9579 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9580 (org-link-escape
9581 path org-link-escape-chars-browser)
9582 path))))
9584 ((string= type "doi")
9585 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9586 (org-link-escape
9587 path org-link-escape-chars-browser)
9588 path))))
9590 ((member type '("message"))
9591 (browse-url (concat type ":" path)))
9593 ((string= type "tags")
9594 (org-tags-view arg path))
9596 ((string= type "tree-match")
9599 ((string= type "file")
9601 (setq line (string-to-number (match-string 1 path))
9602 path (substring path 0 (match-beginning 0)))
9604 (setq search (match-string 1 path)
9605 path (substring path 0 (match-beginning 0)))))
9606 (if (string-match "[*?{]" (file-name-nondirectory path))
9607 (dired path)
9608 (org-open-file path arg line search)))
9610 ((string= type "shell")
9611 (let ((cmd path))
9612 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9613 (string-match org-confirm-shell-link-not-regexp cmd))
9614 (not org-confirm-shell-link-function)
9615 (funcall org-confirm-shell-link-function
9617 (org-add-props cmd nil
9618 'face 'org-warning))))
9619 (progn
9620 (message "Executing %s" cmd)
9621 (shell-command cmd))
9622 (error "Abort"))))
9624 ((string= type "elisp")
9625 (let ((cmd path))
9626 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9627 (string-match org-confirm-elisp-link-not-regexp cmd))
9628 (not org-confirm-elisp-link-function)
9629 (funcall org-confirm-elisp-link-function
9631 (org-add-props cmd nil
9632 'face 'org-warning))))
9633 (message "%s => %s" cmd
9634 (if (equal (string-to-char cmd) ?\()
9635 (eval (read cmd))
9636 (call-interactively (read cmd))))
9637 (error "Abort"))))
9639 ((and (string= type "thisfile")
9640 (run-hook-with-args-until-success
9641 'org-open-link-functions path)))
9643 ((string= type "thisfile")
9644 (if arg
9645 (switch-to-buffer-other-window
9646 (org-get-buffer-for-internal-link (current-buffer)))
9647 (org-mark-ring-push))
9648 (let ((cmd `(org-link-search
9649 ,path
9650 ,(cond ((equal arg '(4)) ''occur)
9651 ((equal arg '(16)) ''org-occur)
9652 (t nil))
9653 ,pos)))
9654 (condition-case nil (let ((org-link-search-inhibit-query t))
9655 (eval cmd))
9656 (error (progn (widen) (eval cmd))))))
9658 (t
9659 (browse-url-at-point)))))))
9660 (move-marker org-open-link-marker nil)
9661 (run-hook-with-args 'org-follow-link-hook)))
9663 (defun org-offer-links-in-entry (&optional nth zero)
9664 "Offer links in the current entry and follow the selected link.
9665 If there is only one link, follow it immediately as well.
9666 If NTH is an integer, immediately pick the NTH link found.
9667 If ZERO is a string, check also this string for a link, and if
9668 there is one, offer it as link number zero."
9672 (cnt ?0)
9673 (in-emacs (if (integerp nth) nil nth))
9674 have-zero end links link c)
9675 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9676 (push (match-string 0 zero) links)
9677 (setq cnt (1- cnt) have-zero t))
9678 (save-excursion
9679 (org-back-to-heading t)
9680 (setq end (save-excursion (outline-next-heading) (point)))
9681 (while (re-search-forward re end t)
9682 (push (match-string 0) links))
9683 (setq links (org-uniquify (reverse links))))
9685 (cond
9686 ((null links)
9687 (message "No links"))
9688 ((equal (length links) 1)
9689 (setq link (list (car links))))
9690 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9691 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9692 (t ; we have to select a link
9693 (save-excursion
9694 (save-window-excursion
9695 (delete-other-windows)
9696 (with-output-to-temp-buffer "*Select Link*"
9697 (mapc (lambda (l)
9698 (if (not (string-match org-bracket-link-regexp l))
9700 (org-remove-angle-brackets l)))
9701 (if (match-end 3)
9703 (match-string 3 l) (match-string 1 l)))
9705 (match-string 1 l))))))
9706 links))
9707 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9708 (message "Select link to open, RET to open all:")
9709 (setq c (read-char-exclusive))
9710 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9711 (when (equal c ?q) (error "Abort"))
9712 (if (equal c ?\C-m)
9713 (setq link links)
9714 (setq nth (- c ?0))
9715 (if have-zero (setq nth (1+ nth)))
9716 (unless (and (integerp nth) (>= (length links) nth))
9717 (error "Invalid link selection"))
9718 (setq link (list (nth (1- nth) links))))))
9719 (if link
9720 (let ((buf (current-buffer)))
9721 (dolist (l link)
9722 (org-open-link-from-string l in-emacs buf))
9723 t)
9724 nil)))
9726 ;; Add special file links that specify the way of opening
9728 (org-add-link-type "file+sys" 'org-open-file-with-system)
9729 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9730 (defun org-open-file-with-system (path)
9731 "Open file at PATH using the system way of opening it."
9732 (org-open-file path 'system))
9733 (defun org-open-file-with-emacs (path)
9734 "Open file at PATH in Emacs."
9735 (org-open-file path 'emacs))
9736 (defun org-remove-file-link-modifiers ()
9737 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9738 (goto-char (point-min))
9740 (org-if-unprotected
9741 (replace-match "file:" t t))))
9742 (eval-after-load "org-exp"
9743 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9744 'org-remove-file-link-modifiers))
9746 ;;;; Time estimates
9748 (defun org-get-effort (&optional pom)
9749 "Get the effort estimate for the current entry."
9750 (org-entry-get pom org-effort-property))
9752 ;;; File search
9754 (defvar org-create-file-search-functions nil
9755 "List of functions to construct the right search string for a file link.
9756 These functions are called in turn with point at the location to
9757 which the link should point.
9759 A function in the hook should first test if it would like to
9760 handle this file type, for example by checking the `major-mode'
9761 or the file extension. If it decides not to handle this file, it
9762 should just return nil to give other functions a chance. If it
9763 does handle the file, it must return the search string to be used
9764 when following the link. The search string will be part of the
9765 file link, given after a double colon, and `org-open-at-point'
9766 will automatically search for it. If special measures must be
9767 taken to make the search successful, another function should be
9768 added to the companion hook `org-execute-file-search-functions',
9769 which see.
9771 A function in this hook may also use `setq' to set the variable
9772 `description' to provide a suggestion for the descriptive text to
9773 be used for this link when it gets inserted into an Org-mode
9776 (defvar org-execute-file-search-functions nil
9777 "List of functions to execute a file search triggered by a link.
9779 Functions added to this hook must accept a single argument, the
9780 search string that was part of the file link, the part after the
9781 double colon. The function must first check if it would like to
9782 handle this search, for example by checking the `major-mode' or
9783 the file extension. If it decides not to handle this search, it
9784 should just return nil to give other functions a chance. If it
9785 does handle the search, it must return a non-nil value to keep
9786 other functions from trying.
9788 Each function can access the current prefix argument through the
9789 variable `current-prefix-argument'. Note that a single prefix is
9790 used to force opening a link in Emacs, so it may be good to only
9791 use a numeric or double prefix to guide the search function.
9793 In case this is needed, a function in this hook can also restore
9794 the window configuration before `org-open-at-point' was called using:
9796 (set-window-configuration org-window-config-before-follow-link)")
9798 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9799 (defun org-link-search (s &optional type avoid-pos stealth)
9800 "Search for a link search option.
9801 If S is surrounded by forward slashes, it is interpreted as a
9802 regular expression. In org-mode files, this will create an `org-occur'
9803 sparse tree. In ordinary files, `occur' will be used to list matches.
9804 If the current buffer is in `dired-mode', grep will be used to search
9805 in all files. If AVOID-POS is given, ignore matches near that position.
9807 When optional argument STEALTH is non-nil, do not modify
9808 visibility around point, thus ignoring
9809 `org-show-hierarchy-above', `org-show-following-heading' and
9810 `org-show-siblings' variables."
9811 (let ((case-fold-search t)
9815 org-emphasis-alist)
9817 (pos (point))
9818 (pre nil) (post nil)
9819 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9820 (cond
9821 ;; First check if there are any special search functions
9822 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9823 ;; Now try the builtin stuff
9824 ((and (equal (string-to-char s0) ?#)
9825 (> (length s0) 1)
9826 (save-excursion
9827 (goto-char (point-min))
9828 (and
9829 (re-search-forward
9831 (setq type 'dedicated
9832 pos (match-beginning 0))))
9833 ;; There is an exact target for this
9834 (goto-char pos)
9835 (org-back-to-heading t)))
9836 ((save-excursion
9837 (goto-char (point-min))
9838 (and
9839 (re-search-forward
9840 (concat "<<" (regexp-quote s0) ">>") nil t)
9841 (setq type 'dedicated
9842 pos (match-beginning 0))))
9843 ;; There is an exact target for this
9844 (goto-char pos))
9846 (save-excursion
9847 (goto-char (point-min))
9848 (and
9849 (re-search-forward
9850 (concat "[^[]" (regexp-quote
9851 (format org-coderef-label-format
9852 (match-string 1 s0))))
9853 nil t)
9854 (setq type 'dedicated
9855 pos (1+ (match-beginning 0))))))
9856 ;; There is a coderef target for this
9857 (goto-char pos))
9859 ;; A regular expression
9860 (cond
9861 ((eq major-mode 'org-mode)
9862 (org-occur (match-string 1 s)))
9863 ;;((eq major-mode 'dired-mode)
9864 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9865 (t (org-do-occur (match-string 1 s)))))
9866 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9867 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9868 (goto-char (point-min))
9869 (cond
9870 ((let (case-fold-search)
9871 (re-search-forward (format org-complex-heading-regexp-format
9872 (regexp-quote s))
9873 nil t))
9874 ;; OK, found a match
9875 (setq type 'dedicated)
9876 (goto-char (match-beginning 0)))
9877 ((and (not org-link-search-inhibit-query)
9878 (eq org-link-search-must-match-exact-headline 'query-to-create)
9879 (y-or-n-p "No match - create this as a new heading? "))
9880 (goto-char (point-max))
9881 (or (bolp) (newline))
9883 (beginning-of-line 0))
9884 (t
9885 (goto-char pos)
9886 (error "No match"))))
9887 (t
9888 ;; A normal search string
9889 (when (equal (string-to-char s) ?*)
9890 ;; Anchor on headlines, post may include tags.
9893 s (substring s 1)))
9894 (remove-text-properties
9895 0 (length s)
9896 '(face nil mouse-face nil keymap nil fontified nil) s)
9897 ;; Make a series of regular expressions to find a match
9906 re4 (concat "[^a-zA-Z_]" re4_)
9908 re1 (concat pre re2 post)
9909 re3 (concat pre (if pre re4_ re4) post)
9910 re5 (concat pre ".*" re4)
9911 re2 (concat pre re2)
9912 re2a (concat pre (if pre re2a_ re2a))
9913 re4 (concat pre (if pre re4_ re4))
9917 ))
9918 (cond
9919 ((eq type 'org-occur) (org-occur reall))
9920 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9921 (t (goto-char (point-min))
9922 (setq type 'fuzzy)
9923 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9924 (org-search-not-self 1 re1 nil t)
9925 (org-search-not-self 1 re2 nil t)
9926 (org-search-not-self 1 re2a nil t)
9927 (org-search-not-self 1 re3 nil t)
9928 (org-search-not-self 1 re4 nil t)
9929 (org-search-not-self 1 re5 nil t)
9930 )
9931 (goto-char (match-beginning 1))
9932 (goto-char pos)
9933 (error "No match"))))))
9934 (and (eq major-mode 'org-mode)
9935 (not stealth)
9936 (org-show-context 'link-search))
9937 type))
9939 (defun org-search-not-self (group &rest args)
9940 "Execute `re-search-forward', but only accept matches that do not
9941 enclose the position of `org-open-link-marker'."
9942 (let ((m org-open-link-marker))
9943 (catch 'exit
9944 (while (apply 're-search-forward args)
9945 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9946 (goto-char (match-end group))
9947 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9948 (> (match-beginning 0) (marker-position m))
9949 (< (match-end 0) (marker-position m)))
9950 (save-match-data
9951 (or (not (org-in-regexp
9952 org-bracket-link-analytic-regexp 1))
9953 (not (match-end 4)) ; no description
9954 (and (<= (match-beginning 4) (point))
9955 (>= (match-end 4) (point))))))
9956 (throw 'exit (point))))))))
9958 (defun org-get-buffer-for-internal-link (buffer)
9959 "Return a buffer to be used for displaying the link target of internal links."
9960 (cond
9961 ((not org-display-internal-link-with-indirect-buffer)
9962 buffer)
9963 ((string-match "(Clone)$" (buffer-name buffer))
9964 (message "Buffer is already a clone, not making another one")
9965 ;; we also do not modify visibility in this case
9966 buffer)
9967 (t ; make a new indirect buffer for displaying the link
9968 (let* ((bn (buffer-name buffer))
9969 (ibn (concat bn "(Clone)"))
9970 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9971 (with-current-buffer ib (org-overview))
9972 ib))))
9974 (defun org-do-occur (regexp &optional cleanup)
9975 "Call the Emacs command `occur'.
9976 If CLEANUP is non-nil, remove the printout of the regular expression
9977 in the *Occur* buffer. This is useful if the regex is long and not useful
9978 to read."
9979 (occur regexp)
9980 (when cleanup
9981 (let ((cwin (selected-window)) win beg end)
9982 (when (setq win (get-buffer-window "*Occur*"))
9983 (select-window win))
9984 (goto-char (point-min))
9985 (when (re-search-forward "match[a-z]+" nil t)
9986 (setq beg (match-end 0))
9988 (setq end (1- (match-beginning 0)))))
9989 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9990 (goto-char (point-min))
9991 (select-window cwin))))
9993 ;;; The mark ring for links jumps
9995 (defvar org-mark-ring nil
9996 "Mark ring for positions before jumps in Org-mode.")
9997 (defvar org-mark-ring-last-goto nil
9998 "Last position in the mark ring used to go back.")
9999 ;; Fill and close the ring
10000 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10001 (loop for i from 1 to org-mark-ring-length do
10002 (push (make-marker) org-mark-ring))
10003 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10004 org-mark-ring)
10006 (defun org-mark-ring-push (&optional pos buffer)
10007 "Put the current position or POS into the mark ring and rotate it."
10008 (interactive)
10009 (setq pos (or pos (point)))
10010 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10011 (move-marker (car org-mark-ring)
10012 (or pos (point))
10013 (or buffer (current-buffer)))
10014 (message "%s"
10015 (substitute-command-keys
10018 (defun org-mark-ring-goto (&optional n)
10019 "Jump to the previous position in the mark ring.
10020 With prefix arg N, jump back that many stored positions. When
10021 called several times in succession, walk through the entire ring.
10022 Org-mode commands jumping to a different position in the current file,
10023 or to another Org-mode file, automatically push the old position
10024 onto the ring."
10025 (interactive "p")
10026 (let (p m)
10027 (if (eq last-command this-command)
10028 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10029 (setq p org-mark-ring))
10030 (setq org-mark-ring-last-goto p)
10031 (setq m (car p))
10032 (org-pop-to-buffer-same-window (marker-buffer m))
10033 (goto-char m)
10034 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10036 (defun org-remove-angle-brackets (s)
10037 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10038 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10039 s)
10040 (defun org-add-angle-brackets (s)
10041 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10042 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10043 s)
10044 (defun org-remove-double-quotes (s)
10047 s)
10049 ;;; Following specific links
10051 (defun org-follow-timestamp-link ()
10052 (cond
10053 ((org-at-date-range-p t)
10054 (let ((org-agenda-start-on-weekday)
10055 (t1 (match-string 1))
10056 (t2 (match-string 2)))
10057 (setq t1 (time-to-days (org-time-string-to-time t1))
10058 t2 (time-to-days (org-time-string-to-time t2)))
10059 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10060 ((org-at-timestamp-p t)
10061 (org-agenda-list nil (time-to-days (org-time-string-to-time
10062 (substring (match-string 1) 0 10)))
10063 1))
10064 (t (error "This should not happen"))))
10067 ;;; Following file links
10068 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10069 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10070 (declare-function mailcap-mime-info
10071 "mailcap" (string &optional request no-decode))
10072 (defvar org-wait nil)
10073 (defun org-open-file (path &optional in-emacs line search)
10074 "Open the file at PATH.
10075 First, this expands any special file name abbreviations. Then the
10076 configuration variable `org-file-apps' is checked if it contains an
10077 entry for this file type, and if yes, the corresponding command is launched.
10079 If no application is found, Emacs simply visits the file.
10081 With optional prefix argument IN-EMACS, Emacs will visit the file.
10083 prefix arg, Org tries to avoid opening in Emacs
10084 and to use an external application to visit the file.
10086 Optional LINE specifies a line to go to, optional SEARCH a string
10087 to search for. If LINE or SEARCH is given, the file will be
10088 opened in Emacs, unless an entry from org-file-apps that makes
10089 use of groups in a regexp matches.
10091 If you want to change the way frames are used when following a
10092 link, please customize `org-link-frame-setup'.
10094 If the file does not exist, an error is thrown."
10095 (let* ((file (if (equal path "")
10096 buffer-file-name
10097 (substitute-in-file-name (expand-file-name path))))
10098 (file-apps (append org-file-apps (org-default-apps)))
10099 (apps (org-remove-if
10100 'org-file-apps-entry-match-against-dlink-p file-apps))
10101 (apps-dlink (org-remove-if-not
10102 'org-file-apps-entry-match-against-dlink-p file-apps))
10103 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10104 (dirp (if remp nil (file-directory-p file)))
10105 (file (if (and dirp org-open-directory-means-index-dot-org)
10106 (concat (file-name-as-directory file) "index.org")
10107 file))
10108 (a-m-a-p (assq 'auto-mode apps))
10109 (dfile (downcase file))
10110 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10111 (link (cond ((and (eq line nil)
10112 (eq search nil))
10113 file)
10114 (line
10115 (concat file "::" (number-to-string line)))
10116 (search
10117 (concat file "::" search))))
10118 (dlink (downcase link))
10119 (old-buffer (current-buffer))
10120 (old-pos (point))
10121 (old-mode major-mode)
10122 ext cmd link-match-data)
10124 (setq ext (match-string 1 dfile))
10126 (setq ext (match-string 1 dfile))))
10127 (cond
10128 ((member in-emacs '((16) system))
10129 (setq cmd (cdr (assoc 'system apps))))
10130 (in-emacs (setq cmd 'emacs))
10131 (t
10132 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10133 (and dirp (cdr (assoc 'directory apps)))
10134 ; first, try matching against apps-dlink
10135 ; if we get a match here, store the match data for later
10136 (let ((match (assoc-default dlink apps-dlink
10137 'string-match)))
10138 (if match
10139 (progn (setq link-match-data (match-data))
10140 match)
10141 (progn (setq in-emacs (or in-emacs line search))
10142 nil))) ; if we have no match in apps-dlink,
10143 ; always open the file in emacs if line or search
10144 ; is given (for backwards compatibility)
10145 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10146 'string-match)
10147 (cdr (assoc ext apps))
10148 (cdr (assoc t apps))))))
10149 (when (eq cmd 'system)
10150 (setq cmd (cdr (assoc 'system apps))))
10151 (when (eq cmd 'default)
10152 (setq cmd (cdr (assoc t apps))))
10153 (when (eq cmd 'mailcap)
10154 (require 'mailcap)
10155 (mailcap-parse-mailcaps)
10156 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10157 (command (mailcap-mime-info mime-type)))
10158 (if (stringp command)
10159 (setq cmd command)
10160 (setq cmd 'emacs))))
10161 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10162 (not (file-exists-p file))
10163 (not org-open-non-existing-files))
10164 (error "No such file: %s" file))
10165 (cond
10167 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10169 (setq cmd (replace-match "%s" t t cmd)))
10170 (while (string-match "%s" cmd)
10171 (setq cmd (replace-match
10172 (save-match-data
10173 (shell-quote-argument
10174 (convert-standard-filename file)))
10175 t t cmd)))
10177 ;; Replace "%1", "%2" etc. in command with group matches from regex
10178 (save-match-data
10179 (let ((match-index 1)
10180 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10181 (set-match-data link-match-data)
10182 (while (<= match-index number-of-groups)
10183 (let ((regex (concat "%" (number-to-string match-index)))
10184 (replace-with (match-string match-index dlink)))
10185 (while (string-match regex cmd)
10186 (setq cmd (replace-match replace-with t t cmd))))
10187 (setq match-index (+ match-index 1)))))
10189 (save-window-excursion
10190 (start-process-shell-command cmd nil cmd)
10191 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10192 ))
10193 ((or (stringp cmd)
10194 (eq cmd 'emacs))
10195 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10196 (widen)
10197 (if line (org-goto-line line)
10198 (if search (org-link-search search))))
10199 ((consp cmd)
10200 (let ((file (convert-standard-filename file)))
10201 (save-match-data
10202 (set-match-data link-match-data)
10203 (eval cmd))))
10204 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10205 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10206 (or (not (equal old-buffer (current-buffer)))
10207 (not (equal old-pos (point))))
10208 (org-mark-ring-push old-pos old-buffer))))
10210 (defun org-file-apps-entry-match-against-dlink-p (entry)
10211 "This function returns non-nil if `entry' uses a regular
10212 expression which should be matched against the whole link by
10213 org-open-file.
10215 It assumes that is the case when the entry uses a regular
10216 expression which has at least one grouping construct and the
10217 action is either a lisp form or a command string containing
10218 '%1', i.e. using at least one subexpression match as a
10219 parameter."
10220 (let ((selector (car entry))
10221 (action (cdr entry)))
10222 (if (stringp selector)
10223 (and (> (regexp-opt-depth selector) 0)
10224 (or (and (stringp action)
10225 (string-match "%[0-9]" action))
10226 (consp action)))
10227 nil)))
10229 (defun org-default-apps ()
10230 "Return the default applications for this operating system."
10231 (cond
10232 ((eq system-type 'darwin)
10233 org-file-apps-defaults-macosx)
10234 ((eq system-type 'windows-nt)
10235 org-file-apps-defaults-windowsnt)
10236 (t org-file-apps-defaults-gnu)))
10238 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10239 "Convert extensions to regular expressions in the cars of LIST.
10240 Also, weed out any non-string entries, because the return value is used
10241 only for regexp matching.
10242 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10243 point to the symbol `emacs', indicating that the file should
10244 be opened in Emacs."
10245 (append
10246 (delq nil
10247 (mapcar (lambda (x)
10248 (if (not (stringp (car x)))
10249 nil
10251 x
10253 list))
10254 (if add-auto-mode
10255 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10257 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10258 (defun org-file-remote-p (file)
10259 "Test whether FILE specifies a location on a remote system.
10260 Return non-nil if the location is indeed remote.
10264 (cond ((fboundp 'file-remote-p)
10265 (file-remote-p file))
10266 ((fboundp 'tramp-handle-file-remote-p)
10267 (tramp-handle-file-remote-p file))
10268 ((and (boundp 'ange-ftp-name-format)
10269 (string-match (car ange-ftp-name-format) file))
10270 t)
10271 (t nil)))
10274 ;;;; Refiling
10276 (defun org-get-org-file ()
10277 "Read a filename, with default directory `org-directory'."
10278 (let ((default (or org-default-notes-file remember-data-file)))
10279 (read-file-name (format "File name [%s]: " default)
10280 (file-name-as-directory org-directory)
10281 default)))
10283 (defun org-notes-order-reversed-p ()
10284 "Check if the current file should receive notes in reversed order."
10285 (cond
10286 ((not org-reverse-note-order) nil)
10287 ((eq t org-reverse-note-order) t)
10288 ((not (listp org-reverse-note-order)) nil)
10289 (t (catch 'exit
10290 (let ((all org-reverse-note-order)
10291 entry)
10292 (while (setq entry (pop all))
10293 (if (string-match (car entry) buffer-file-name)
10294 (throw 'exit (cdr entry))))
10295 nil)))))
10297 (defvar org-refile-target-table nil
10298 "The list of refile targets, created by `org-refile'.")
10300 (defvar org-agenda-new-buffers nil
10301 "Buffers created to visit agenda files.")
10303 (defvar org-refile-cache nil
10304 "Cache for refile targets.")
10306 (defvar org-refile-markers nil
10307 "All the markers used for caching refile locations.")
10309 (defun org-refile-marker (pos)
10310 "Get a new refile marker, but only if caching is in use."
10311 (if (not org-refile-use-cache)
10312 pos
10313 (let ((m (make-marker)))
10314 (move-marker m pos)
10315 (push m org-refile-markers)
10316 m)))
10318 (defun org-refile-cache-clear ()
10319 "Clear the refile cache and disable all the markers."
10320 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10321 (setq org-refile-markers nil)
10322 (setq org-refile-cache nil)
10323 (message "Refile cache has been cleared"))
10325 (defun org-refile-cache-check-set (set)
10326 "Check if all the markers in the cache still have live buffers."
10327 (let (marker)
10328 (catch 'exit
10329 (while (and set (setq marker (nth 3 (pop set))))
10330 ;; if org-refile-use-outline-path is 'file, marker may be nil
10331 (when (and marker (null (marker-buffer marker)))
10332 (message "not found") (sit-for 3)
10333 (throw 'exit nil)))
10334 t)))
10336 (defun org-refile-cache-put (set &rest identifiers)
10337 "Push the refile targets SET into the cache, under IDENTIFIERS."
10338 (let* ((key (sha1 (prin1-to-string identifiers)))
10339 (entry (assoc key org-refile-cache)))
10340 (if entry
10341 (setcdr entry set)
10342 (push (cons key set) org-refile-cache))))
10344 (defun org-refile-cache-get (&rest identifiers)
10345 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10346 (cond
10347 ((not org-refile-cache) nil)
10348 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10349 (t
10350 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10351 org-refile-cache))))
10352 (and set (org-refile-cache-check-set set) set)))))
10354 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10355 "Produce a table with refile targets."
10356 (let ((case-fold-search nil)
10357 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10358 (entries (or org-refile-targets '((nil . (:level . 1)))))
10359 targets tgs txt re files f desc descre fast-path-p level pos0)
10360 (message "Getting targets...")
10361 (with-current-buffer (or default-buffer (current-buffer))
10362 (while (setq entry (pop entries))
10363 (setq files (car entry) desc (cdr entry))
10364 (setq fast-path-p nil)
10365 (cond
10366 ((null files) (setq files (list (current-buffer))))
10367 ((eq files 'org-agenda-files)
10368 (setq files (org-agenda-files 'unrestricted)))
10369 ((and (symbolp files) (fboundp files))
10370 (setq files (funcall files)))
10371 ((and (symbolp files) (boundp files))
10372 (setq files (symbol-value files))))
10373 (if (stringp files) (setq files (list files)))
10374 (cond
10375 ((eq (car desc) :tag)
10377 ((eq (car desc) :todo)
10379 ((eq (car desc) :regexp)
10380 (setq descre (cdr desc)))
10381 ((eq (car desc) :level)
10383 (if org-odd-levels-only
10384 (1- (* 2 (cdr desc)))
10385 (cdr desc)))
10387 ((eq (car desc) :maxlevel)
10388 (setq fast-path-p t)
10390 (if org-odd-levels-only
10391 (1- (* 2 (cdr desc)))
10392 (cdr desc)))
10394 (t (error "Bad refiling target description %s" desc)))
10395 (while (setq f (pop files))
10396 (with-current-buffer
10397 (if (bufferp f) f (org-get-agenda-file-buffer f))
10398 (or
10399 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10400 (progn
10401 (if (bufferp f) (setq f (buffer-file-name
10402 (buffer-base-buffer f))))
10403 (setq f (and f (expand-file-name f)))
10404 (if (eq org-refile-use-outline-path 'file)
10405 (push (list (file-name-nondirectory f) f nil nil) tgs))
10406 (save-excursion
10407 (save-restriction
10408 (widen)
10409 (goto-char (point-min))
10410 (while (re-search-forward descre nil t)
10411 (goto-char (setq pos0 (point-at-bol)))
10412 (catch 'next
10413 (when org-refile-target-verify-function
10414 (save-match-data
10415 (or (funcall org-refile-target-verify-function)
10416 (throw 'next t))))
10417 (when (and (looking-at org-complex-heading-regexp)
10418 (not (member (match-string 4) excluded-entries))
10419 (match-string 4))
10420 (setq level (org-reduced-level
10421 (- (match-end 1) (match-beginning 1)))
10422 txt (org-link-display-format (match-string 4))
10424 re (format org-complex-heading-regexp-format
10425 (regexp-quote (match-string 4))))
10426 (when org-refile-use-outline-path
10427 (setq txt (mapconcat
10428 'org-protect-slash
10429 (append
10430 (if (eq org-refile-use-outline-path
10431 'file)
10432 (list (file-name-nondirectory
10433 (buffer-file-name
10434 (buffer-base-buffer))))
10435 (if (eq org-refile-use-outline-path
10436 'full-file-path)
10437 (list (buffer-file-name
10438 (buffer-base-buffer)))))
10439 (org-get-outline-path fast-path-p
10440 level txt)
10441 (list txt))
10442 "/")))
10443 (push (list txt f re (org-refile-marker (point)))
10444 tgs)))
10445 (when (= (point) pos0)
10446 ;; verification function has not moved point
10447 (goto-char (point-at-eol))))))))
10448 (when org-refile-use-cache
10449 (org-refile-cache-put tgs (buffer-file-name) descre))
10450 (setq targets (append tgs targets))
10451 ))))
10452 (message "Getting targets...done")
10453 (nreverse targets)))
10455 (defun org-protect-slash (s)
10456 (while (string-match "/" s)
10458 s)
10460 (defvar org-olpa (make-vector 20 nil))
10462 (defun org-get-outline-path (&optional fastp level heading)
10463 "Return the outline path to the current entry, as a list.
10465 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10466 routine which makes outline path derivations for an entire file,
10467 avoiding backtracing. Refile target collection makes use of that."
10468 (if fastp
10469 (progn
10470 (if (> level 19)
10471 (error "Outline path failure, more than 19 levels"))
10472 (loop for i from level upto 19 do
10473 (aset org-olpa i nil))
10474 (prog1
10475 (delq nil (append org-olpa nil))
10476 (aset org-olpa level heading)))
10477 (let (rtn case-fold-search)
10478 (save-excursion
10479 (save-restriction
10480 (widen)
10481 (while (org-up-heading-safe)
10482 (when (looking-at org-complex-heading-regexp)
10483 (push (org-match-string-no-properties 4) rtn)))
10484 rtn)))))
10486 (defun org-format-outline-path (path &optional width prefix)
10487 "Format the outline path PATH for display.
10488 Width is the maximum number of characters that is available.
10489 Prefix is a prefix to be included in the returned string,
10490 such as the file name."
10491 (setq width (or width 79))
10492 (if prefix (setq width (- width (length prefix))))
10493 (if (not path)
10494 (or prefix "")
10495 (let* ((nsteps (length path))
10496 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10497 (maxwidth (if (<= total-width width)
10498 10000 ;; everything fits
10499 ;; we need to shorten the level headings
10500 (/ (- width nsteps) nsteps)))
10501 (org-odd-levels-only nil)
10502 (n 0)
10503 (total (1+ (length prefix))))
10504 (setq maxwidth (max maxwidth 10))
10505 (concat prefix
10506 (mapconcat
10507 (lambda (h)
10508 (setq n (1+ n))
10509 (if (and (= n nsteps) (< maxwidth 10000))
10510 (setq maxwidth (- total-width total)))
10511 (if (< (length h) maxwidth)
10512 (progn (setq total (+ total (length h) 1)) h)
10513 (setq h (substring h 0 (- maxwidth 2))
10514 total (+ total maxwidth 1))
10516 (setq h (substring h 0 (match-beginning 0))))
10517 (setq h (concat h "..")))
10518 (org-add-props h nil 'face
10519 (nth (% (1- n) org-n-level-faces)
10520 org-level-faces))
10521 h)
10522 path "/")))))
10524 (defun org-display-outline-path (&optional file current)
10525 "Display the current outline path in the echo area."
10526 (interactive "P")
10527 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10528 (case-fold-search nil)
10529 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10530 (if current (setq path (append path
10531 (save-excursion
10532 (org-back-to-heading t)
10533 (if (looking-at org-complex-heading-regexp)
10534 (list (match-string 4)))))))
10535 (message "%s"
10536 (org-format-outline-path
10537 path
10538 (1- (frame-width))
10539 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10541 (defvar org-refile-history nil
10542 "History for refiling operations.")
10544 (defvar org-after-refile-insert-hook nil
10545 "Hook run after `org-refile' has inserted its stuff at the new location.
10546 Note that this is still *before* the stuff will be removed from
10547 the *old* location.")
10549 (defvar org-capture-last-stored-marker)
10550 (defun org-refile (&optional goto default-buffer rfloc)
10551 "Move the entry or entries at point to another heading.
10552 The list of target headings is compiled using the information in
10553 `org-refile-targets', which see.
10555 At the target location, the entry is filed as a subitem of the target
10556 heading. Depending on `org-reverse-note-order', the new subitem will
10557 either be the first or the last subitem.
10559 If there is an active region, all entries in that region will be moved.
10560 However, the region must fulfill the requirement that the first heading
10561 is the first one sets the top-level of the moved text - at most siblings
10562 below it are allowed.
10564 With prefix arg GOTO, the command will only visit the target location
10565 and not actually move anything.
10568 go to the location where the last refiling operation has put the subtree.
10569 With a prefix argument of `2', refile to the running clock.
10571 RFLOC can be a refile location obtained in a different way.
10573 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10575 If you are using target caching (see `org-refile-use-cache'),
10576 You have to clear the target cache in order to find new targets.
10577 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10578 prefix argument (`C-u C-u C-u C-c C-w')."
10580 (interactive "P")
10581 (if (member goto '(0 (64)))
10582 (org-refile-cache-clear)
10583 (let* ((cbuf (current-buffer))
10584 (regionp (org-region-active-p))
10585 (region-start (and regionp (region-beginning)))
10586 (region-end (and regionp (region-end)))
10587 (region-length (and regionp (- region-end region-start)))
10588 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10589 pos it nbuf file re level reversed)
10590 (setq last-command nil)
10591 (when regionp
10592 (goto-char region-start)
10593 (or (bolp) (goto-char (point-at-bol)))
10594 (setq region-start (point))
10595 (unless (or (org-kill-is-subtree-p
10596 (buffer-substring region-start region-end))
10597 (prog1 org-refile-active-region-within-subtree
10598 (org-toggle-heading)))
10599 (error "The region is not a (sequence of) subtree(s)")))
10600 (if (equal goto '(16))
10601 (org-refile-goto-last-stored)
10602 (when (or
10603 (and (equal goto 2)
10604 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10605 (prog1
10606 (setq it (list (or org-clock-heading "running clock")
10607 (buffer-file-name
10608 (marker-buffer org-clock-hd-marker))
10609 ""
10610 (marker-position org-clock-hd-marker)))
10611 (setq goto nil)))
10612 (setq it (or rfloc
10613 (let (heading-text)
10614 (save-excursion
10615 (unless goto
10616 (org-back-to-heading t)
10617 (setq heading-text
10618 (nth 4 (org-heading-components))))
10619 (org-refile-get-location
10620 (cond (goto "Goto")
10621 (regionp "Refile region to")
10624 default-buffer
10625 org-refile-allow-creating-parent-nodes
10626 goto))))))
10627 (setq file (nth 1 it)
10628 re (nth 2 it)
10629 pos (nth 3 it))
10630 (if (and (not goto)
10631 pos
10632 (equal (buffer-file-name) file)
10633 (if regionp
10634 (and (>= pos region-start)
10635 (<= pos region-end))
10636 (and (>= pos (point))
10637 (< pos (save-excursion
10638 (org-end-of-subtree t t))))))
10639 (error "Cannot refile to position inside the tree or region"))
10641 (setq nbuf (or (find-buffer-visiting file)
10642 (find-file-noselect file)))
10643 (if goto
10644 (progn
10645 (org-pop-to-buffer-same-window nbuf)
10646 (goto-char pos)
10647 (org-show-context 'org-goto))
10648 (if regionp
10649 (progn
10650 (org-kill-new (buffer-substring region-start region-end))
10651 (org-save-markers-in-region region-start region-end))
10652 (org-copy-subtree 1 nil t))
10653 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10654 (find-file-noselect file)))
10655 (setq reversed (org-notes-order-reversed-p))
10656 (save-excursion
10657 (save-restriction
10658 (widen)
10659 (if pos
10660 (progn
10661 (goto-char pos)
10662 (looking-at org-outline-regexp)
10663 (setq level (org-get-valid-level (funcall outline-level) 1))
10664 (goto-char
10665 (if reversed
10666 (or (outline-next-heading) (point-max))
10667 (or (save-excursion (org-get-next-sibling))
10668 (org-end-of-subtree t t)
10669 (point-max)))))
10670 (setq level 1)
10671 (if (not reversed)
10672 (goto-char (point-max))
10673 (goto-char (point-min))
10674 (or (outline-next-heading) (goto-char (point-max)))))
10675 (if (not (bolp)) (newline))
10676 (org-paste-subtree level)
10677 (when org-log-refile
10678 (org-add-log-setup 'refile nil nil 'findpos
10679 org-log-refile)
10680 (unless (eq org-log-refile 'note)
10681 (save-excursion (org-add-log-note))))
10682 (and org-auto-align-tags (org-set-tags nil t))
10683 (bookmark-set "org-refile-last-stored")
10684 ;; If we are refiling for capture, make sure that the
10685 ;; last-capture pointers point here
10686 (when (org-bound-and-true-p org-refile-for-capture)
10687 (bookmark-set "org-capture-last-stored-marker")
10688 (move-marker org-capture-last-stored-marker (point)))
10689 (if (fboundp 'deactivate-mark) (deactivate-mark))
10690 (run-hooks 'org-after-refile-insert-hook))))
10691 (if regionp
10692 (delete-region (point) (+ (point) region-length))
10693 (org-cut-subtree))
10694 (when (featurep 'org-inlinetask)
10695 (org-inlinetask-remove-END-maybe))
10696 (setq org-markers-to-move nil)
10699 (defun org-refile-goto-last-stored ()
10700 "Go to the location where the last refile was stored."
10701 (interactive)
10702 (bookmark-jump "org-refile-last-stored")
10703 (message "This is the location of the last refile"))
10705 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10706 no-exclude)
10707 "Prompt the user for a refile location, using PROMPT.
10708 PROMPT should not be suffixed with a colon and a space, because
10709 this function appends the default value from
10710 `org-refile-history' automatically, if that is not empty.
10711 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10712 this is used for the GOTO interface."
10713 (let ((org-refile-targets org-refile-targets)
10714 (org-refile-use-outline-path org-refile-use-outline-path)
10715 excluded-entries)
10716 (when (and (eq major-mode 'org-mode)
10717 (not org-refile-use-cache)
10718 (not no-exclude))
10719 (org-map-tree
10720 (lambda()
10721 (setq excluded-entries
10722 (append excluded-entries (list (org-get-heading t t)))))))
10723 (setq org-refile-target-table
10724 (org-refile-get-targets default-buffer excluded-entries)))
10725 (unless org-refile-target-table
10726 (error "No refile targets"))
10727 (let* ((prompt (concat prompt
10728 (and (car org-refile-history)
10729 (concat " (default " (car org-refile-history) ")"))
10730 ": "))
10731 (cbuf (current-buffer))
10732 (partial-completion-mode nil)
10733 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10734 (cfunc (if (and org-refile-use-outline-path
10735 org-outline-path-complete-in-steps)
10736 'org-olpath-completing-read
10737 'org-icompleting-read))
10738 (extra (if org-refile-use-outline-path "/" ""))
10739 (filename (and cfn (expand-file-name cfn)))
10740 (tbl (mapcar
10741 (lambda (x)
10742 (if (and (not (member org-refile-use-outline-path
10743 '(file full-file-path)))
10744 (not (equal filename (nth 1 x))))
10745 (cons (concat (car x) extra " ("
10746 (file-name-nondirectory (nth 1 x)) ")")
10747 (cdr x))
10748 (cons (concat (car x) extra) (cdr x))))
10749 org-refile-target-table))
10750 (completion-ignore-case t)
10751 pa answ parent-target child parent old-hist)
10752 (setq old-hist org-refile-history)
10753 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10754 nil 'org-refile-history (car org-refile-history)))
10755 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10756 (org-refile-check-position pa)
10757 (if pa
10758 (progn
10759 (when (or (not org-refile-history)
10760 (not (eq old-hist org-refile-history))
10761 (not (equal (car pa) (car org-refile-history))))
10762 (setq org-refile-history
10763 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10764 org-refile-history
10765 (cdr org-refile-history))))
10766 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10767 (pop org-refile-history)))
10768 pa)
10770 (progn
10771 (setq parent (match-string 1 answ)
10772 child (match-string 2 answ))
10773 (setq parent-target (or (assoc parent tbl)
10774 (assoc (concat parent "/") tbl)))
10775 (when (and parent-target
10776 (or (eq new-nodes t)
10777 (and (eq new-nodes 'confirm)
10779 child)))))
10780 (org-refile-new-child parent-target child)))
10781 (error "Invalid target location")))))
10783 (defun org-refile-check-position (refile-pointer)
10784 "Check if the refile pointer matches the readline to which it points."
10785 (let* ((file (nth 1 refile-pointer))
10786 (re (nth 2 refile-pointer))
10787 (pos (nth 3 refile-pointer))
10788 buffer)
10789 (when (org-string-nw-p re)
10790 (setq buffer (if (markerp pos)
10791 (marker-buffer pos)
10792 (or (find-buffer-visiting file)
10793 (find-file-noselect file))))
10794 (with-current-buffer buffer
10795 (save-excursion
10796 (save-restriction
10797 (widen)
10798 (goto-char pos)
10799 (beginning-of-line 1)
10800 (unless (org-looking-at-p re)
10801 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10803 (defun org-refile-new-child (parent-target child)
10804 "Use refile target PARENT-TARGET to add new CHILD below it."
10805 (unless parent-target
10806 (error "Cannot find parent for new node"))
10807 (let ((file (nth 1 parent-target))
10808 (pos (nth 3 parent-target))
10809 level)
10810 (with-current-buffer (or (find-buffer-visiting file)
10811 (find-file-noselect file))
10812 (save-excursion
10813 (save-restriction
10814 (widen)
10815 (if pos
10816 (goto-char pos)
10817 (goto-char (point-max))
10818 (if (not (bolp)) (newline)))
10819 (when (looking-at org-outline-regexp)
10820 (setq level (funcall outline-level))
10821 (org-end-of-subtree t t))
10822 (org-back-over-empty-lines)
10824 (if pos (org-get-valid-level level 1) 1) ?*)
10826 (beginning-of-line 0)
10827 (list (concat (car parent-target) "/" child) file "" (point)))))))
10829 (defun org-olpath-completing-read (prompt collection &rest args)
10830 "Read an outline path like a file name."
10831 (let ((thetable collection)
10832 (org-completion-use-ido nil) ; does not work with ido.
10833 (org-completion-use-iswitchb nil)) ; or iswitchb
10834 (apply
10835 'org-icompleting-read prompt
10836 (lambda (string predicate &optional flag)
10837 (let (rtn r f (l (length string)))
10838 (cond
10839 ((eq flag nil)
10840 ;; try completion
10841 (try-completion string thetable))
10842 ((eq flag t)
10843 ;; all-completions
10844 (setq rtn (all-completions string thetable predicate))
10845 (mapcar
10846 (lambda (x)
10847 (setq r (substring x l))
10848 (if (string-match " ([^)]*)$" x)
10849 (setq f (match-string 0 x))
10850 (setq f ""))
10851 (if (string-match "/" r)
10852 (concat string (substring r 0 (match-end 0)) f)
10853 x))
10854 rtn))
10855 ((eq flag 'lambda)
10856 ;; exact match?
10857 (assoc string thetable)))
10858 ))
10859 args)))
10861 ;;;; Dynamic blocks
10863 (defun org-find-dblock (name)
10864 "Find the first dynamic block with name NAME in the buffer.
10865 If not found, stay at current position and return nil."
10866 (let (pos)
10867 (save-excursion
10868 (goto-char (point-min))
10870 nil t)
10871 (match-beginning 0))))
10872 (if pos (goto-char pos))
10873 pos))
10875 (defconst org-dblock-start-re
10877 "Matches the start line of a dynamic block, with parameters.")
10880 "Matches the end of a dynamic block.")
10882 (defun org-create-dblock (plist)
10883 "Create a dynamic block section, with parameters taken from PLIST.
10884 PLIST must contain a :name entry which is used as name of the block."
10886 (end-of-line 1)
10887 (newline))
10888 (let ((col (current-column))
10889 (name (plist-get plist :name)))
10890 (insert "#+BEGIN: " name)
10891 (while plist
10892 (if (eq (car plist) :name)
10893 (setq plist (cddr plist))
10894 (insert " " (prin1-to-string (pop plist)))))
10896 (beginning-of-line -2)))
10898 (defun org-prepare-dblock ()
10899 "Prepare dynamic block for refresh.
10900 This empties the block, puts the cursor at the insert position and returns
10901 the property list including an extra property :name with the block name."
10902 (unless (looking-at org-dblock-start-re)
10903 (error "Not at a dynamic block"))
10904 (let* ((begdel (1+ (match-end 0)))
10905 (name (org-no-properties (match-string 1)))
10906 (params (append (list :name name)
10907 (read (concat "(" (match-string 3) ")")))))
10908 (save-excursion
10909 (beginning-of-line 1)
10911 (setq params (plist-put params :indentation-column (current-column))))
10912 (unless (re-search-forward org-dblock-end-re nil t)
10913 (error "Dynamic block not terminated"))
10914 (setq params
10915 (append params
10916 (list :content (buffer-substring
10917 begdel (match-beginning 0)))))
10918 (delete-region begdel (match-beginning 0))
10919 (goto-char begdel)
10920 (open-line 1)
10921 params))
10923 (defun org-map-dblocks (&optional command)
10924 "Apply COMMAND to all dynamic blocks in the current buffer.
10925 If COMMAND is not given, use `org-update-dblock'."
10926 (let ((cmd (or command 'org-update-dblock)))
10927 (save-excursion
10928 (goto-char (point-min))
10929 (while (re-search-forward org-dblock-start-re nil t)
10930 (goto-char (match-beginning 0))
10931 (save-excursion
10932 (condition-case nil
10933 (funcall cmd)
10934 (error (message "Error during update of dynamic block"))))
10935 (unless (re-search-forward org-dblock-end-re nil t)
10936 (error "Dynamic block not terminated"))))))
10938 (defun org-dblock-update (&optional arg)
10939 "User command for updating dynamic blocks.
10940 Update the dynamic block at point. With prefix ARG, update all dynamic
10941 blocks in the buffer."
10942 (interactive "P")
10943 (if arg
10944 (org-update-all-dblocks)
10945 (or (looking-at org-dblock-start-re)
10946 (org-beginning-of-dblock))
10947 (org-update-dblock)))
10949 (defun org-update-dblock ()
10950 "Update the dynamic block at point.
10951 This means to empty the block, parse for parameters and then call
10952 the correct writing function."
10953 (interactive)
10954 (save-window-excursion
10955 (let* ((pos (point))
10956 (line (org-current-line))
10957 (params (org-prepare-dblock))
10958 (name (plist-get params :name))
10959 (indent (plist-get params :indentation-column))
10960 (cmd (intern (concat "org-dblock-write:" name))))
10961 (message "Updating dynamic block `%s' at line %d..." name line)
10962 (funcall cmd params)
10963 (message "Updating dynamic block `%s' at line %d...done" name line)
10964 (goto-char pos)
10965 (when (and indent (> indent 0))
10966 (setq indent (make-string indent ?\ ))
10967 (save-excursion
10968 (org-beginning-of-dblock)
10969 (forward-line 1)
10970 (while (not (looking-at org-dblock-end-re))
10971 (insert indent)
10972 (beginning-of-line 2))
10973 (when (looking-at org-dblock-end-re)
10975 (replace-match ""))
10976 (insert indent)))))))
10978 (defun org-beginning-of-dblock ()
10979 "Find the beginning of the dynamic block at point.
10980 Error if there is no such block at point."
10981 (let ((pos (point))
10982 beg)
10983 (end-of-line 1)
10984 (if (and (re-search-backward org-dblock-start-re nil t)
10985 (setq beg (match-beginning 0))
10986 (re-search-forward org-dblock-end-re nil t)
10987 (> (match-end 0) pos))
10988 (goto-char beg)
10989 (goto-char pos)
10990 (error "Not in a dynamic block"))))
10992 (defun org-update-all-dblocks ()
10993 "Update all dynamic blocks in the buffer.
10994 This function can be used in a hook."
10995 (interactive)
10996 (when (eq major-mode 'org-mode)
10997 (org-map-dblocks 'org-update-dblock)))
11000 ;;;; Completion
11002 (defconst org-additional-option-like-keywords
11003 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11004 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11005 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11006 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11007 "BEGIN:" "END:"
11008 "ORGTBL" "TBLFM:" "TBLNAME:"
11009 "BEGIN_EXAMPLE" "END_EXAMPLE"
11010 "BEGIN_QUOTE" "END_QUOTE"
11011 "BEGIN_VERSE" "END_VERSE"
11012 "BEGIN_CENTER" "END_CENTER"
11013 "BEGIN_SRC" "END_SRC"
11014 "BEGIN_RESULT" "END_RESULT"
11015 "NAME:" "RESULTS:"
11016 "HEADER:" "HEADERS:"
11017 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11018 "CAPTION:" "LABEL:"
11019 "SETUPFILE:"
11020 "INCLUDE:"
11021 "BIND:"
11022 "MACRO:"))
11024 (defcustom org-structure-template-alist
11025 '(
11038 ("L" "#+LaTeX: "
11042 ("H" "#+HTML: "
11045 ("A" "#+ASCII: ")
11046 ("i" "#+INDEX: ?"
11047 "#+INDEX: ?")
11048 ("I" "#+INCLUDE %file ?"
11050 )
11051 "Structure completion elements.
11052 This is a list of abbreviation keys and values. The value gets inserted
11053 if you type `<' followed by the key and then press the completion key,
11054 usually `M-TAB'. %file will be replaced by a file name after prompting
11055 for the file using completion. The cursor will be placed at the position
11056 of the `?` in the template.
11057 There are two templates for each key, the first uses the original Org syntax,
11058 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11059 the default when the /org-mtags.el/ module has been loaded. See also the
11060 variable `org-mtags-prefer-muse-templates'.
11061 This is an experimental feature, it is undecided if it is going to stay in."
11062 :group 'org-completion
11063 :type '(repeat
11064 (string :tag "Key")
11065 (string :tag "Template")
11066 (string :tag "Muse Template")))
11068 (defun org-try-structure-completion ()
11069 "Try to complete a structure template before point.
11071 expands them."
11072 (let ((l (buffer-substring (point-at-bol) (point)))
11073 a)
11076 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11077 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11078 (match-beginning 1)) a)
11079 t)))
11081 (defun org-complete-expand-structure-template (start cell)
11082 "Expand a structure template."
11083 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11084 (rpl (nth (if musep 2 1) cell))
11085 (ind ""))
11086 (delete-region start (point))
11088 (cond
11089 ((bolp))
11091 (setq ind (buffer-substring (point-at-bol) (point))))
11092 (t (newline))))
11093 (setq start (point))
11094 (if (string-match "%file" rpl)
11095 (setq rpl (replace-match
11096 (concat
11098 (save-match-data
11099 (abbreviate-file-name (read-file-name "Include file: ")))
11101 t t rpl)))
11104 (insert rpl)
11107 ;;;; TODO, DEADLINE, Comments
11109 (defun org-toggle-comment ()
11110 "Change the COMMENT state of an entry."
11111 (interactive)
11112 (save-excursion
11113 (org-back-to-heading)
11114 (let (case-fold-search)
11115 (cond
11116 ((looking-at (format org-heading-keyword-regexp-format
11117 org-comment-string))
11118 (goto-char (match-end 1))
11119 (looking-at (concat " +" org-comment-string))
11120 (replace-match "" t t)
11121 (when (eolp) (insert " ")))
11122 ((looking-at org-outline-regexp)
11123 (goto-char (match-end 0))
11124 (insert org-comment-string " "))))))
11126 (defvar org-last-todo-state-is-todo nil
11127 "This is non-nil when the last TODO state change led to a TODO state.
11128 If the last change removed the TODO tag or switched to DONE, then
11129 this is nil.")
11131 (defvar org-setting-tags nil) ; dynamically skipped
11133 (defvar org-todo-setup-filter-hook nil
11134 "Hook for functions that pre-filter todo specs.
11135 Each function takes a todo spec and returns either nil or the spec
11136 transformed into canonical form." )
11138 (defvar org-todo-get-default-hook nil
11139 "Hook for functions that get a default item for todo.
11140 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11141 nil or a string to be used for the todo mark." )
11143 (defvar org-agenda-headline-snapshot-before-repeat)
11145 (defun org-current-effective-time ()
11146 "Return current time adjusted for `org-extend-today-until' variable"
11147 (let* ((ct (org-current-time))
11148 (dct (decode-time ct))
11149 (ct1
11150 (if (and org-use-effective-time
11151 (< (nth 2 dct) org-extend-today-until))
11152 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11153 ct)))
11154 ct1))
11156 (defun org-todo-yesterday (&optional arg)
11157 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11158 (interactive "P")
11159 (if (eq major-mode 'org-agenda-mode)
11160 (apply 'org-agenda-todo-yesterday arg)
11161 (let* ((hour (third (decode-time
11162 (org-current-time))))
11163 (org-extend-today-until (1+ hour)))
11164 (org-todo arg))))
11166 (defun org-todo (&optional arg)
11167 "Change the TODO state of an item.
11168 The state of an item is given by a keyword at the start of the heading,
11169 like
11170 *** TODO Write paper
11171 *** DONE Call mom
11173 The different keywords are specified in the variable `org-todo-keywords'.
11175 So for this example: when the item starts with TODO, it is changed to DONE.
11176 When it starts with DONE, the DONE is removed. And when neither TODO nor
11177 DONE are present, add TODO at the beginning of the heading.
11180 state.
11181 With numeric prefix arg, switch to that state.
11183 keywords (nextset).
11185 With a numeric prefix arg of 0, inhibit note taking for the change.
11187 For calling through lisp, arg is also interpreted in the following way:
11188 'none -> empty state
11190 'done -> switch to DONE
11191 'nextset -> switch to the next set of keywords
11192 'previousset -> switch to the previous set of keywords
11194 really is a member of `org-todo-keywords'."
11195 (interactive "P")
11196 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11197 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11198 'region-start-level 'region))
11199 org-loop-over-headlines-in-active-region)
11200 (org-map-entries
11201 `(org-todo ,arg)
11202 org-loop-over-headlines-in-active-region
11203 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11204 (if (equal arg '(16)) (setq arg 'nextset))
11205 (let ((org-blocker-hook org-blocker-hook)
11206 (case-fold-search nil))
11207 (when (equal arg '(64))
11208 (setq arg nil org-blocker-hook nil))
11209 (when (and org-blocker-hook
11210 (or org-inhibit-blocking
11211 (org-entry-get nil "NOBLOCKING")))
11212 (setq org-blocker-hook nil))
11213 (save-excursion
11214 (catch 'exit
11215 (org-back-to-heading t)
11216 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11219 (let* ((match-data (match-data))
11220 (startpos (point-at-bol))
11221 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11222 (org-log-done org-log-done)
11223 (org-log-repeat org-log-repeat)
11224 (org-todo-log-states org-todo-log-states)
11225 (org-inhibit-logging
11226 (if (equal arg 0)
11227 (progn (setq arg nil) 'note) org-inhibit-logging))
11228 (this (match-string 1))
11229 (hl-pos (match-beginning 0))
11230 (head (org-get-todo-sequence-head this))
11231 (ass (assoc head org-todo-kwd-alist))
11232 (interpret (nth 1 ass))
11233 (done-word (nth 3 ass))
11234 (final-done-word (nth 4 ass))
11235 (last-state (or this ""))
11236 (completion-ignore-case t)
11237 (member (member this org-todo-keywords-1))
11238 (tail (cdr member))
11239 (state (cond
11240 ((and org-todo-key-trigger
11241 (or (and (equal arg '(4))
11242 (eq org-use-fast-todo-selection 'prefix))
11243 (and (not arg) org-use-fast-todo-selection
11244 (not (eq org-use-fast-todo-selection
11245 'prefix)))))
11246 ;; Use fast selection
11247 (org-fast-todo-selection))
11248 ((and (equal arg '(4))
11249 (or (not org-use-fast-todo-selection)
11250 (not org-todo-key-trigger)))
11251 ;; Read a state with completion
11252 (org-icompleting-read
11253 "State: " (mapcar (lambda(x) (list x))
11254 org-todo-keywords-1)
11255 nil t))
11256 ((eq arg 'right)
11257 (if this
11258 (if tail (car tail) nil)
11259 (car org-todo-keywords-1)))
11260 ((eq arg 'left)
11261 (if (equal member org-todo-keywords-1)
11262 nil
11263 (if this
11264 (nth (- (length org-todo-keywords-1)
11265 (length tail) 2)
11266 org-todo-keywords-1)
11267 (org-last org-todo-keywords-1))))
11268 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11269 (setq arg nil))) ; hack to fall back to cycling
11270 (arg
11271 ;; user or caller requests a specific state
11272 (cond
11273 ((equal arg "") nil)
11274 ((eq arg 'none) nil)
11275 ((eq arg 'done) (or done-word (car org-done-keywords)))
11276 ((eq arg 'nextset)
11277 (or (car (cdr (member head org-todo-heads)))
11278 (car org-todo-heads)))
11279 ((eq arg 'previousset)
11280 (let ((org-todo-heads (reverse org-todo-heads)))
11281 (or (car (cdr (member head org-todo-heads)))
11282 (car org-todo-heads))))
11283 ((car (member arg org-todo-keywords-1)))
11284 ((stringp arg)
11285 (error "State `%s' not valid in this file" arg))
11286 ((nth (1- (prefix-numeric-value arg))
11287 org-todo-keywords-1))))
11288 ((null member) (or head (car org-todo-keywords-1)))
11289 ((equal this final-done-word) nil) ;; -> make empty
11290 ((null tail) nil) ;; -> first entry
11291 ((memq interpret '(type priority))
11292 (if (eq this-command last-command)
11293 (car tail)
11294 (if (> (length tail) 0)
11295 (or done-word (car org-done-keywords))
11296 nil)))
11297 (t
11298 (car tail))))
11299 (state (or
11300 (run-hook-with-args-until-success
11301 'org-todo-get-default-hook state last-state)
11302 state))
11303 (next (if state (concat " " state " ") " "))
11304 (change-plist (list :type 'todo-state-change :from this :to state
11305 :position startpos))
11306 dolog now-done-p)
11307 (when org-blocker-hook
11308 (setq org-last-todo-state-is-todo
11309 (not (member this org-done-keywords)))
11310 (unless (save-excursion
11311 (save-match-data
11312 (org-with-wide-buffer
11313 (run-hook-with-args-until-failure
11314 'org-blocker-hook change-plist))))
11315 (if (org-called-interactively-p 'interactive)
11316 (error "TODO state change from %s to %s blocked" this state)
11317 ;; fail silently
11318 (message "TODO state change from %s to %s blocked" this state)
11319 (throw 'exit nil))))
11320 (store-match-data match-data)
11321 (replace-match next t t)
11322 (unless (pos-visible-in-window-p hl-pos)
11323 (message "TODO state changed to %s" (org-trim next)))
11324 (unless head
11325 (setq head (org-get-todo-sequence-head state)
11326 ass (assoc head org-todo-kwd-alist)
11327 interpret (nth 1 ass)
11328 done-word (nth 3 ass)
11329 final-done-word (nth 4 ass)))
11330 (when (memq arg '(nextset previousset))
11331 (message "Keyword-Set %d/%d: %s"
11332 (- (length org-todo-sets) -1
11333 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11334 (length org-todo-sets)
11335 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11336 (setq org-last-todo-state-is-todo
11337 (not (member state org-done-keywords)))
11338 (setq now-done-p (and (member state org-done-keywords)
11339 (not (member this org-done-keywords))))
11340 (and logging (org-local-logging logging))
11341 (when (and (or org-todo-log-states org-log-done)
11342 (not (eq org-inhibit-logging t))
11343 (not (memq arg '(nextset previousset))))
11344 ;; we need to look at recording a time and note
11345 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11346 (nth 2 (assoc this org-todo-log-states))))
11347 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11348 (setq dolog 'time))
11349 (when (and state
11350 (member state org-not-done-keywords)
11351 (not (member this org-not-done-keywords)))
11352 ;; This is now a todo state and was not one before
11353 ;; If there was a CLOSED time stamp, get rid of it.
11354 (org-add-planning-info nil nil 'closed))
11355 (when (and now-done-p org-log-done)
11356 ;; It is now done, and it was not done before
11357 (org-add-planning-info 'closed (org-current-effective-time))
11358 (if (and (not dolog) (eq 'note org-log-done))
11359 (org-add-log-setup 'done state this 'findpos 'note)))
11360 (when (and state dolog)
11361 ;; This is a non-nil state, and we need to log it
11362 (org-add-log-setup 'state state this 'findpos dolog)))
11363 ;; Fixup tag positioning
11364 (org-todo-trigger-tag-changes state)
11365 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11366 (when org-provide-todo-statistics
11367 (org-update-parent-todo-statistics))
11368 (run-hooks 'org-after-todo-state-change-hook)
11369 (if (and arg (not (member state org-done-keywords)))
11370 (setq head (org-get-todo-sequence-head state)))
11371 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11372 ;; Do we need to trigger a repeat?
11373 (when now-done-p
11374 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11375 ;; This is for the agenda, take a snapshot of the headline.
11376 (save-match-data
11377 (setq org-agenda-headline-snapshot-before-repeat
11378 (org-get-heading))))
11379 (org-auto-repeat-maybe state))
11380 ;; Fixup cursor location if close to the keyword
11381 (if (and (outline-on-heading-p)
11382 (not (bolp))
11383 (save-excursion (beginning-of-line 1)
11384 (looking-at org-todo-line-regexp))
11385 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11386 (progn
11387 (goto-char (or (match-end 2) (match-end 1)))
11388 (and (looking-at " ") (just-one-space))))
11389 (when org-trigger-hook
11390 (save-excursion
11391 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11393 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11394 "Block turning an entry into a TODO, using the hierarchy.
11395 This checks whether the current task should be blocked from state
11396 changes. Such blocking occurs when:
11398 1. The task has children which are not all in a completed state.
11400 2. A task has a parent with the property :ORDERED:, and there
11401 are siblings prior to the current task with incomplete
11402 status.
11404 3. The parent of the task is blocked because it has siblings that should
11405 be done first, or is child of a block grandparent TODO entry."
11407 (if (not org-enforce-todo-dependencies)
11408 t ; if locally turned off don't block
11409 (catch 'dont-block
11410 ;; If this is not a todo state change, or if this entry is already DONE,
11411 ;; do not block
11412 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11413 (member (plist-get change-plist :from)
11414 (cons 'done org-done-keywords))
11415 (member (plist-get change-plist :to)
11416 (cons 'todo org-not-done-keywords))
11417 (not (plist-get change-plist :to)))
11418 (throw 'dont-block t))
11419 ;; If this task has children, and any are undone, it's blocked
11420 (save-excursion
11421 (org-back-to-heading t)
11422 (let ((this-level (funcall outline-level)))
11423 (outline-next-heading)
11424 (let ((child-level (funcall outline-level)))
11425 (while (and (not (eobp))
11426 (> child-level this-level))
11427 ;; this todo has children, check whether they are all
11428 ;; completed
11429 (if (and (not (org-entry-is-done-p))
11430 (org-entry-is-todo-p))
11431 (throw 'dont-block nil))
11432 (outline-next-heading)
11433 (setq child-level (funcall outline-level))))))
11434 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11435 ;; any previous siblings are undone, it's blocked
11436 (save-excursion
11437 (org-back-to-heading t)
11438 (let* ((pos (point))
11439 (parent-pos (and (org-up-heading-safe) (point))))
11440 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11441 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11442 (forward-line 1)
11443 (re-search-forward org-not-done-heading-regexp pos t))
11444 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11445 ;; Search further up the hierarchy, to see if an ancestor is blocked
11446 (while t
11447 (goto-char parent-pos)
11448 (if (not (looking-at org-not-done-heading-regexp))
11449 (throw 'dont-block t)) ; do not block, parent is not a TODO
11450 (setq pos (point))
11451 (setq parent-pos (and (org-up-heading-safe) (point)))
11452 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11453 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11454 (forward-line 1)
11455 (re-search-forward org-not-done-heading-regexp pos t))
11456 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11458 (defcustom org-track-ordered-property-with-tag nil
11459 "Should the ORDERED property also be shown as a tag?
11460 The ORDERED property decides if an entry should require subtasks to be
11461 completed in sequence. Since a property is not very visible, setting
11462 this option means that toggling the ORDERED property with the command
11463 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11464 not relevant for the behavior, but it makes things more visible.
11466 Note that toggling the tag with tags commands will not change the property
11467 and therefore not influence behavior!
11469 This can be t, meaning the tag ORDERED should be used, It can also be a
11470 string to select a different tag for this task."
11471 :group 'org-todo
11472 :type '(choice
11473 (const :tag "No tracking" nil)
11474 (const :tag "Track with ORDERED tag" t)
11475 (string :tag "Use other tag")))
11477 (defun org-toggle-ordered-property ()
11478 "Toggle the ORDERED property of the current entry.
11479 For better visibility, you can track the value of this property with a tag.
11480 See variable `org-track-ordered-property-with-tag'."
11481 (interactive)
11482 (let* ((t1 org-track-ordered-property-with-tag)
11483 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11484 (save-excursion
11485 (org-back-to-heading)
11486 (if (org-entry-get nil "ORDERED")
11487 (progn
11488 (org-delete-property "ORDERED")
11489 (and tag (org-toggle-tag tag 'off))
11490 (message "Subtasks can be completed in arbitrary order"))
11491 (org-entry-put nil "ORDERED" "t")
11492 (and tag (org-toggle-tag tag 'on))
11493 (message "Subtasks must be completed in sequence")))))
11495 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11496 (defun org-block-todo-from-checkboxes (change-plist)
11497 "Block turning an entry into a TODO, using checkboxes.
11498 This checks whether the current task should be blocked from state
11499 changes because there are unchecked boxes in this entry."
11500 (if (not org-enforce-todo-checkbox-dependencies)
11501 t ; if locally turned off don't block
11502 (catch 'dont-block
11503 ;; If this is not a todo state change, or if this entry is already DONE,
11504 ;; do not block
11505 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11506 (member (plist-get change-plist :from)
11507 (cons 'done org-done-keywords))
11508 (member (plist-get change-plist :to)
11509 (cons 'todo org-not-done-keywords))
11510 (not (plist-get change-plist :to)))
11511 (throw 'dont-block t))
11512 ;; If this task has checkboxes that are not checked, it's blocked
11513 (save-excursion
11514 (org-back-to-heading t)
11515 (let ((beg (point)) end)
11516 (outline-next-heading)
11517 (setq end (point))
11518 (goto-char beg)
11519 (if (org-list-search-forward
11520 (concat (org-item-beginning-re)
11523 end t)
11524 (progn
11525 (if (boundp 'org-blocked-by-checkboxes)
11526 (setq org-blocked-by-checkboxes t))
11527 (throw 'dont-block nil)))))
11528 t))) ; do not block
11530 (defun org-entry-blocked-p ()
11531 "Is the current entry blocked?"
11532 (if (org-entry-get nil "NOBLOCKING")
11533 nil ;; Never block this entry
11534 (not
11535 (run-hook-with-args-until-failure
11536 'org-blocker-hook
11537 (list :type 'todo-state-change
11538 :position (point)
11539 :from 'todo
11540 :to 'done)))))
11542 (defun org-update-statistics-cookies (all)
11543 "Update the statistics cookie, either from TODO or from checkboxes.
11544 This should be called with the cursor in a line with a statistics cookie."
11545 (interactive "P")
11546 (if all
11547 (progn
11548 (org-update-checkbox-count 'all)
11549 (org-map-entries 'org-update-parent-todo-statistics))
11550 (if (not (org-at-heading-p))
11551 (org-update-checkbox-count)
11552 (let ((pos (move-marker (make-marker) (point)))
11553 end l1 l2)
11554 (ignore-errors (org-back-to-heading t))
11555 (if (not (org-at-heading-p))
11556 (org-update-checkbox-count)
11557 (setq l1 (org-outline-level))
11558 (setq end (save-excursion
11559 (outline-next-heading)
11560 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11561 (point)))
11562 (if (and (save-excursion
11563 (re-search-forward
11565 (not (save-excursion (re-search-forward
11567 (org-update-checkbox-count)
11568 (if (and l2 (> l2 l1))
11569 (progn
11570 (goto-char end)
11571 (org-update-parent-todo-statistics))
11572 (goto-char pos)
11573 (beginning-of-line 1)
11574 (while (re-search-forward
11576 (point-at-eol) t)
11577 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11578 (goto-char pos)
11579 (move-marker pos nil)))))
11581 (defvar org-entry-property-inherited-from) ;; defined below
11582 (defun org-update-parent-todo-statistics ()
11583 "Update any statistics cookie in the parent of the current headline.
11584 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11585 the entire subtree and this will travel up the hierarchy and update
11586 statistics everywhere."
11587 (let* ((prop (save-excursion (org-up-heading-safe)
11588 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11589 (recursive (or (not org-hierarchical-todo-statistics)
11591 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11592 0))
11593 (first t)
11595 level ltoggle l1 new ndel
11596 (cnt-all 0) (cnt-done 0) is-percent kwd
11597 checkbox-beg ov ovs ove cookie-present)
11598 (catch 'exit
11599 (save-excursion
11600 (beginning-of-line 1)
11601 (setq ltoggle (funcall outline-level))
11602 ;; Three situations are to consider:
11604 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11605 ;; to the top-level ancestor on the headline;
11607 ;; 2. If parent has "recursive" property, repeat up to the
11608 ;; headline setting that property, taking inheritance into
11609 ;; account;
11611 ;; 3. Else, move up to direct parent and proceed only once.
11612 (while (and (setq level (org-up-heading-safe))
11613 (or recursive first)
11614 (>= (point) lim))
11615 (setq first nil cookie-present nil)
11616 (unless (and level
11617 (not (string-match
11619 (downcase (or (org-entry-get nil "COOKIE_DATA")
11620 "")))))
11621 (throw 'exit nil))
11622 (while (re-search-forward box-re (point-at-eol) t)
11623 (setq cnt-all 0 cnt-done 0 cookie-present t)
11624 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11625 (save-match-data
11626 (unless (outline-next-heading) (throw 'exit nil))
11627 (while (and (looking-at org-complex-heading-regexp)
11628 (> (setq l1 (length (match-string 1))) level))
11629 (setq kwd (and (or recursive (= l1 ltoggle))
11630 (match-string 2)))
11631 (if (or (eq org-provide-todo-statistics 'all-headlines)
11632 (and (listp org-provide-todo-statistics)
11633 (or (member kwd org-provide-todo-statistics)
11634 (member kwd org-done-keywords))))
11635 (setq cnt-all (1+ cnt-all))
11636 (if (eq org-provide-todo-statistics t)
11637 (and kwd (setq cnt-all (1+ cnt-all)))))
11638 (and (member kwd org-done-keywords)
11639 (setq cnt-done (1+ cnt-done)))
11640 (outline-next-heading)))
11641 (setq new
11642 (if is-percent
11643 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11644 (format "[%d/%d]" cnt-done cnt-all))
11645 ndel (- (match-end 0) checkbox-beg))
11646 ;; handle overlays when updating cookie from column view
11647 (when (setq ov (car (overlays-at checkbox-beg)))
11648 (setq ovs (overlay-start ov) ove (overlay-end ov))
11649 (delete-overlay ov))
11650 (goto-char checkbox-beg)
11651 (insert new)
11652 (delete-region (point) (+ (point) ndel))
11653 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11654 (when ov (move-overlay ov ovs ove)))
11655 (when cookie-present
11656 (run-hook-with-args 'org-after-todo-statistics-hook
11657 cnt-done (- cnt-all cnt-done))))))
11658 (run-hooks 'org-todo-statistics-hook)))
11660 (defvar org-after-todo-statistics-hook nil
11661 "Hook that is called after a TODO statistics cookie has been updated.
11662 Each function is called with two arguments: the number of not-done entries
11663 and the number of done entries.
11665 For example, the following function, when added to this hook, will switch
11666 an entry to DONE when all children are done, and back to TODO when new
11667 entries are set to a TODO status. Note that this hook is only called
11668 when there is a statistics cookie in the headline!
11670 (defun org-summary-todo (n-done n-not-done)
11672 (let (org-log-done org-log-states) ; turn off logging
11674 ")
11676 (defvar org-todo-statistics-hook nil
11677 "Hook that is run whenever Org thinks TODO statistics should be updated.
11678 This hook runs even if there is no statistics cookie present, in which case
11679 `org-after-todo-statistics-hook' would not run.")
11681 (defun org-todo-trigger-tag-changes (state)
11682 "Apply the changes defined in `org-todo-state-tags-triggers'."
11683 (let ((l org-todo-state-tags-triggers)
11684 changes)
11685 (when (or (not state) (equal state ""))
11686 (setq changes (append changes (cdr (assoc "" l)))))
11687 (when (and (stringp state) (> (length state) 0))
11688 (setq changes (append changes (cdr (assoc state l)))))
11689 (when (member state org-not-done-keywords)
11690 (setq changes (append changes (cdr (assoc 'todo l)))))
11691 (when (member state org-done-keywords)
11692 (setq changes (append changes (cdr (assoc 'done l)))))
11693 (dolist (c changes)
11694 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11696 (defun org-local-logging (value)
11697 "Get logging settings from a property VALUE."
11698 (let* (words w a)
11699 ;; directly set the variables, they are already local.
11700 (setq org-log-done nil
11701 org-log-repeat nil
11702 org-todo-log-states nil)
11703 (setq words (org-split-string value))
11704 (while (setq w (pop words))
11705 (cond
11706 ((setq a (assoc w org-startup-options))
11707 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11708 (set (nth 1 a) (nth 2 a))))
11709 ((setq a (org-extract-log-state-settings w))
11710 (and (member (car a) org-todo-keywords-1)
11711 (push a org-todo-log-states)))))))
11713 (defun org-get-todo-sequence-head (kwd)
11714 "Return the head of the TODO sequence to which KWD belongs.
11715 If KWD is not set, check if there is a text property remembering the
11716 right sequence."
11717 (let (p)
11718 (cond
11719 ((not kwd)
11720 (or (get-text-property (point-at-bol) 'org-todo-head)
11721 (progn
11722 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11723 nil (point-at-eol)))
11724 (get-text-property p 'org-todo-head))))
11725 ((not (member kwd org-todo-keywords-1))
11726 (car org-todo-keywords-1))
11727 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11729 (defun org-fast-todo-selection ()
11730 "Fast TODO keyword selection with single keys.
11731 Returns the new TODO keyword, or nil if no state change should occur."
11732 (let* ((fulltable org-todo-key-alist)
11733 (done-keywords org-done-keywords) ;; needed for the faces.
11734 (maxlen (apply 'max (mapcar
11735 (lambda (x)
11736 (if (stringp (car x)) (string-width (car x)) 0))
11737 fulltable)))
11738 (expert nil)
11739 (fwidth (+ maxlen 3 1 3))
11740 (ncol (/ (- (window-width) 4) fwidth))
11741 tg cnt e c tbl
11742 groups ingroup)
11743 (save-excursion
11744 (save-window-excursion
11745 (if expert
11746 (set-buffer (get-buffer-create " *Org todo*"))
11747 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11748 (erase-buffer)
11749 (org-set-local 'org-done-keywords done-keywords)
11750 (setq tbl fulltable cnt 0)
11751 (while (setq e (pop tbl))
11752 (cond
11753 ((equal e '(:startgroup))
11754 (push '() groups) (setq ingroup t)
11755 (when (not (= cnt 0))
11756 (setq cnt 0)
11758 (insert "{ "))
11759 ((equal e '(:endgroup))
11760 (setq ingroup nil cnt 0)
11762 ((equal e '(:newline))
11763 (when (not (= cnt 0))
11764 (setq cnt 0)
11766 (setq e (car tbl))
11767 (while (equal (car tbl) '(:newline))
11769 (setq tbl (cdr tbl)))))
11770 (t
11771 (setq tg (car e) c (cdr e))
11772 (if ingroup (push tg (car groups)))
11773 (setq tg (org-add-props tg nil 'face
11774 (org-get-todo-face tg)))
11775 (if (and (= cnt 0) (not ingroup)) (insert " "))
11776 (insert "[" c "] " tg (make-string
11777 (- fwidth 4 (length tg)) ?\ ))
11778 (when (= (setq cnt (1+ cnt)) ncol)
11780 (if ingroup (insert " "))
11781 (setq cnt 0)))))
11783 (goto-char (point-min))
11784 (if (not expert) (org-fit-window-to-buffer))
11785 (message "[a-z..]:Set [SPC]:clear")
11786 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11787 (cond
11788 ((or (= c ?\C-g)
11789 (and (= c ?q) (not (rassoc c fulltable))))
11790 (setq quit-flag t))
11791 ((= c ?\ ) nil)
11792 ((setq e (rassoc c fulltable) tg (car e))
11793 tg)
11794 (t (setq quit-flag t)))))))
11796 (defun org-entry-is-todo-p ()
11797 (member (org-get-todo-state) org-not-done-keywords))
11799 (defun org-entry-is-done-p ()
11800 (member (org-get-todo-state) org-done-keywords))
11802 (defun org-get-todo-state ()
11803 (save-excursion
11804 (org-back-to-heading t)
11805 (and (looking-at org-todo-line-regexp)
11806 (match-end 2)
11807 (match-string 2))))
11809 (defun org-at-date-range-p (&optional inactive-ok)
11810 "Is the cursor inside a date range?"
11811 (interactive)
11812 (save-excursion
11813 (catch 'exit
11814 (let ((pos (point)))
11816 (skip-chars-backward "<[")
11817 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11818 (>= (match-end 0) pos)
11819 (throw 'exit t))
11821 (skip-chars-backward "<[")
11822 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11823 (>= (match-end 0) pos)
11824 (throw 'exit t)))
11825 nil)))
11827 (defun org-get-repeat (&optional tagline)
11828 "Check if there is a deadline/schedule with repeater in this entry."
11829 (save-match-data
11830 (save-excursion
11831 (org-back-to-heading t)
11832 (and (re-search-forward (if tagline
11834 org-repeat-re)
11835 (org-entry-end-position) t)
11836 (match-string-no-properties 1)))))
11838 (defvar org-last-changed-timestamp)
11839 (defvar org-last-inserted-timestamp)
11840 (defvar org-log-post-message)
11841 (defvar org-log-note-purpose)
11842 (defvar org-log-note-how)
11843 (defvar org-log-note-extra)
11844 (defun org-auto-repeat-maybe (done-word)
11845 "Check if the current headline contains a repeated deadline/schedule.
11846 If yes, set TODO state back to what it was and change the base date
11847 of repeating deadline/scheduled time stamps to new date.
11848 This function is run automatically after each state change to a DONE state."
11849 ;; last-state is dynamically scoped into this function
11850 (let* ((repeat (org-get-repeat))
11851 (aa (assoc last-state org-todo-kwd-alist))
11852 (interpret (nth 1 aa))
11853 (head (nth 2 aa))
11854 (whata '(("d" . day) ("m" . month) ("y" . year)))
11855 (msg "Entry repeats: ")
11856 (org-log-done nil)
11857 (org-todo-log-states nil)
11858 re type n what ts time to-state)
11859 (when repeat
11860 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11861 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11862 org-todo-repeat-to-state))
11863 (unless (and to-state (member to-state org-todo-keywords-1))
11864 (setq to-state (if (eq interpret 'type) last-state head)))
11865 (org-todo to-state)
11866 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11867 (org-entry-put nil "LAST_REPEAT" (format-time-string
11868 (org-time-stamp-format t t))))
11869 (when org-log-repeat
11870 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11871 (memq 'org-add-log-note post-command-hook))
11872 ;; OK, we are already setup for some record
11873 (if (eq org-log-repeat 'note)
11874 ;; make sure we take a note, not only a time stamp
11875 (setq org-log-note-how 'note))
11876 ;; Set up for taking a record
11877 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11878 last-state
11879 'findpos org-log-repeat)))
11880 (org-back-to-heading t)
11881 (org-add-planning-info nil nil 'closed)
11885 (while (re-search-forward
11886 re (save-excursion (outline-next-heading) (point)) t)
11887 (setq type (if (match-end 1) org-scheduled-string
11888 (if (match-end 3) org-deadline-string "Plain:"))
11889 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11891 (setq n (string-to-number (match-string 2 ts))
11892 what (match-string 3 ts))
11893 (if (equal what "w") (setq n (* n 7) what "d"))
11894 ;; Preparation, see if we need to modify the start date for the change
11895 (when (match-end 1)
11896 (setq time (save-match-data (org-time-string-to-time ts)))
11897 (cond
11898 ((equal (match-string 1 ts) ".")
11899 ;; Shift starting date to today
11900 (org-timestamp-change
11901 (- (org-today) (time-to-days time))
11902 'day))
11903 ((equal (match-string 1 ts) "+")
11904 (let ((nshiftmax 10) (nshift 0))
11905 (while (or (= nshift 0)
11906 (<= (time-to-days time)
11907 (time-to-days (current-time))))
11908 (when (= (incf nshift) nshiftmax)
11909 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11910 (error "Abort")))
11911 (org-timestamp-change n (cdr (assoc what whata)))
11912 (org-at-timestamp-p t)
11913 (setq ts (match-string 1))
11914 (setq time (save-match-data (org-time-string-to-time ts)))))
11915 (org-timestamp-change (- n) (cdr (assoc what whata)))
11916 ;; rematch, so that we have everything in place for the real shift
11917 (org-at-timestamp-p t)
11918 (setq ts (match-string 1))
11920 (org-timestamp-change n (cdr (assoc what whata)))
11921 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11922 (setq org-log-post-message msg)
11923 (message "%s" msg))))
11925 (defun org-show-todo-tree (arg)
11926 "Make a compact tree which shows all headlines marked with TODO.
11927 The tree will show the lines where the regexp matches, and all higher
11928 headlines above the match.
11930 With a numeric prefix N, construct a sparse tree for the Nth element
11931 of `org-todo-keywords-1'."
11932 (interactive "P")
11933 (let ((case-fold-search nil)
11934 (kwd-re
11935 (cond ((null arg) org-not-done-regexp)
11936 ((equal arg '(4))
11937 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11938 (mapcar 'list org-todo-keywords-1))))
11942 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11943 (regexp-quote (nth (1- (prefix-numeric-value arg))
11944 org-todo-keywords-1)))
11945 (t (error "Invalid prefix argument: %s" arg)))))
11946 (message "%d TODO entries found"
11947 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11949 (defun org-deadline (&optional remove time)
11951 With argument REMOVE, remove any deadline from the item.
11952 With argument TIME, set the deadline at the corresponding date. TIME
11954 (interactive "P")
11955 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11956 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11957 'region-start-level 'region))
11958 org-loop-over-headlines-in-active-region)
11959 (org-map-entries
11960 `(org-deadline ',remove ,time)
11961 org-loop-over-headlines-in-active-region
11962 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11963 (let* ((old-date (org-entry-get nil "DEADLINE"))
11964 (repeater (and old-date
11965 (string-match
11967 old-date)
11968 (match-string 1 old-date))))
11969 (if remove
11970 (progn
11971 (when (and old-date org-log-redeadline)
11972 (org-add-log-setup 'deldeadline nil old-date 'findpos
11973 org-log-redeadline))
11974 (org-remove-timestamp-with-keyword org-deadline-string)
11975 (message "Item no longer has a deadline."))
11976 (org-add-planning-info 'deadline time 'closed)
11977 (when (and old-date org-log-redeadline
11978 (not (equal old-date
11979 (substring org-last-inserted-timestamp 1 -1))))
11980 (org-add-log-setup 'redeadline nil old-date 'findpos
11981 org-log-redeadline))
11982 (when repeater
11983 (save-excursion
11984 (org-back-to-heading t)
11985 (when (re-search-forward (concat org-deadline-string " "
11986 org-last-inserted-timestamp)
11987 (save-excursion
11988 (outline-next-heading) (point)) t)
11989 (goto-char (1- (match-end 0)))
11990 (insert " " repeater)
11991 (setq org-last-inserted-timestamp
11992 (concat (substring org-last-inserted-timestamp 0 -1)
11993 " " repeater
11994 (substring org-last-inserted-timestamp -1))))))
11995 (message "Deadline on %s" org-last-inserted-timestamp)))))
11997 (defun org-schedule (&optional remove time)
11998 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11999 With argument REMOVE, remove any scheduling date from the item.
12000 With argument TIME, scheduled at the corresponding date. TIME can
12002 (interactive "P")
12003 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12004 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12005 'region-start-level 'region))
12006 org-loop-over-headlines-in-active-region)
12007 (org-map-entries
12008 `(org-schedule ',remove ,time)
12009 org-loop-over-headlines-in-active-region
12010 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12011 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12012 (repeater (and old-date
12013 (string-match
12015 old-date)
12016 (match-string 1 old-date))))
12017 (if remove
12018 (progn
12019 (when (and old-date org-log-reschedule)
12020 (org-add-log-setup 'delschedule nil old-date 'findpos
12021 org-log-reschedule))
12022 (org-remove-timestamp-with-keyword org-scheduled-string)
12023 (message "Item is no longer scheduled."))
12024 (org-add-planning-info 'scheduled time 'closed)
12025 (when (and old-date org-log-reschedule
12026 (not (equal old-date
12027 (substring org-last-inserted-timestamp 1 -1))))
12028 (org-add-log-setup 'reschedule nil old-date 'findpos
12029 org-log-reschedule))
12030 (when repeater
12031 (save-excursion
12032 (org-back-to-heading t)
12033 (when (re-search-forward (concat org-scheduled-string " "
12034 org-last-inserted-timestamp)
12035 (save-excursion
12036 (outline-next-heading) (point)) t)
12037 (goto-char (1- (match-end 0)))
12038 (insert " " repeater)
12039 (setq org-last-inserted-timestamp
12040 (concat (substring org-last-inserted-timestamp 0 -1)
12041 " " repeater
12042 (substring org-last-inserted-timestamp -1))))))
12043 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12045 (defun org-get-scheduled-time (pom &optional inherit)
12046 "Get the scheduled time as a time tuple, of a format suitable
12047 for calling org-schedule with, or if there is no scheduling,
12048 returns nil."
12049 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12050 (when time
12051 (apply 'encode-time (org-parse-time-string time)))))
12053 (defun org-get-deadline-time (pom &optional inherit)
12054 "Get the deadline as a time tuple, of a format suitable for
12055 calling org-deadline with, or if there is no scheduling, returns
12056 nil."
12057 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12058 (when time
12059 (apply 'encode-time (org-parse-time-string time)))))
12061 (defun org-remove-timestamp-with-keyword (keyword)
12062 "Remove all time stamps with KEYWORD in the current entry."
12064 beg)
12065 (save-excursion
12066 (org-back-to-heading t)
12067 (setq beg (point))
12068 (outline-next-heading)
12069 (while (re-search-backward re beg t)
12070 (replace-match "")
12072 (equal (char-before) ?\ ))
12073 (backward-delete-char 1)
12075 (point-at-bol) (point-at-eol)))
12076 (delete-region (point-at-bol)
12077 (min (point-max) (1+ (point-at-eol))))))))))
12079 (defun org-add-planning-info (what &optional time &rest remove)
12080 "Insert new timestamp with keyword in the line directly after the headline.
12081 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12082 If non is given, the user is prompted for a date.
12083 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12084 be removed."
12085 (interactive)
12086 (let (org-time-was-given org-end-time-was-given ts
12087 end default-time default-input)
12089 (catch 'exit
12090 (when (and (memq what '(scheduled deadline))
12091 (or (not time)
12092 (and (stringp time)
12093 (string-match "^[-+]+[0-9]" time))))
12094 ;; Try to get a default date/time from existing timestamp
12095 (save-excursion
12096 (org-back-to-heading t)
12097 (setq end (save-excursion (outline-next-heading) (point)))
12098 (when (re-search-forward (if (eq what 'scheduled)
12099 org-scheduled-time-regexp
12100 org-deadline-time-regexp)
12101 end t)
12102 (setq ts (match-string 1)
12103 default-time
12104 (apply 'encode-time (org-parse-time-string ts))
12105 default-input (and ts (org-get-compact-tod ts))))))
12106 (when what
12107 (setq time
12108 (if (stringp time)
12109 ;; This is a string (relative or absolute), set proper date
12110 (apply 'encode-time
12111 (org-read-date-analyze
12112 time default-time (decode-time default-time)))
12113 ;; If necessary, get the time from the user
12114 (or time (org-read-date nil 'to-time nil nil
12115 default-time default-input)))))
12117 (when (and org-insert-labeled-timestamps-at-point
12118 (member what '(scheduled deadline)))
12119 (insert
12120 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12121 (org-insert-time-stamp time org-time-was-given
12122 nil nil nil (list org-end-time-was-given))
12123 (setq what nil))
12124 (save-excursion
12125 (save-restriction
12126 (let (col list elt ts buffer-invisibility-spec)
12127 (org-back-to-heading t)
12129 (goto-char (match-end 1))
12130 (setq col (current-column))
12131 (goto-char (match-end 0))
12133 (when (and (not what)
12134 (not (looking-at
12136 org-keyword-time-not-clock-regexp))))
12137 ;; Nothing to add, nothing to remove...... :-)
12138 (throw 'exit nil))
12139 (if (and (not (looking-at org-outline-regexp))
12142 (not (equal (match-string 1) org-clock-string)))
12143 (narrow-to-region (match-beginning 0) (match-end 0))
12145 (backward-char 1)
12146 (narrow-to-region (point) (point))
12147 (and org-adapt-indentation (org-indent-to-column col)))
12148 ;; Check if we have to remove something.
12149 (setq list (cons what remove))
12150 (while list
12151 (setq elt (pop list))
12152 (when (or (and (eq elt 'scheduled)
12153 (re-search-forward org-scheduled-time-regexp nil t))
12154 (and (eq elt 'deadline)
12155 (re-search-forward org-deadline-time-regexp nil t))
12156 (and (eq elt 'closed)
12157 (re-search-forward org-closed-time-regexp nil t)))
12158 (replace-match "")
12159 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12161 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12162 (when what
12163 (insert
12164 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12165 (cond ((eq what 'scheduled) org-scheduled-string)
12166 ((eq what 'deadline) org-deadline-string)
12167 ((eq what 'closed) org-closed-string))
12168 " ")
12169 (setq ts (org-insert-time-stamp
12170 time
12171 (or org-time-was-given
12172 (and (eq what 'closed) org-log-done-with-time))
12173 (eq what 'closed)
12174 nil nil (list org-end-time-was-given)))
12175 (insert
12176 (if (not (or (bolp) (eq (char-before) ?\ )
12177 (memq (char-after) '(32 10))
12178 (eobp))) " " ""))
12179 (end-of-line 1))
12180 (goto-char (point-min))
12181 (widen)
12184 (delete-region (1- (point)) (point-at-eol)))
12185 ts))))))
12187 (defvar org-log-note-marker (make-marker))
12188 (defvar org-log-note-purpose nil)
12189 (defvar org-log-note-state nil)
12190 (defvar org-log-note-previous-state nil)
12191 (defvar org-log-note-how nil)
12192 (defvar org-log-note-extra nil)
12193 (defvar org-log-note-window-configuration nil)
12194 (defvar org-log-note-return-to (make-marker))
12195 (defvar org-log-note-effective-time nil
12196 "Remembered current time so that dynamically scoped
12197 `org-extend-today-until' affects tha timestamps in state change
12198 log")
12200 (defvar org-log-post-message nil
12201 "Message to be displayed after a log note has been stored.
12202 The auto-repeater uses this.")
12204 (defun org-add-note ()
12205 "Add a note to the current entry.
12206 This is done in the same way as adding a state change note."
12207 (interactive)
12208 (org-add-log-setup 'note nil nil 'findpos nil))
12210 (defvar org-property-end-re)
12211 (defun org-add-log-setup (&optional purpose state prev-state
12212 findpos how extra)
12213 "Set up the post command hook to take a note.
12214 If this is about to TODO state change, the new state is expected in STATE.
12215 When FINDPOS is non-nil, find the correct position for the note in
12216 the current entry. If not, assume that it can be inserted at point.
12217 HOW is an indicator what kind of note should be created.
12218 EXTRA is additional text that will be inserted into the notes buffer."
12219 (let* ((org-log-into-drawer (org-log-into-drawer))
12220 (drawer (cond ((stringp org-log-into-drawer)
12221 org-log-into-drawer)
12222 (org-log-into-drawer "LOGBOOK")
12223 (t nil))))
12224 (save-restriction
12225 (save-excursion
12226 (when findpos
12227 (org-back-to-heading t)
12228 (narrow-to-region (point) (save-excursion
12229 (outline-next-heading) (point)))
12233 (goto-char (match-end 0))
12234 (cond
12235 (drawer
12237 nil t)
12238 (progn
12239 (goto-char (match-end 0))
12240 (or org-log-states-order-reversed
12241 (and (re-search-forward org-property-end-re nil t)
12242 (goto-char (1- (match-beginning 0))))))
12244 (beginning-of-line 0)
12245 (org-indent-line-function)
12246 (beginning-of-line 2)
12247 (org-indent-line-function)
12248 (end-of-line 0)))
12249 ((and org-log-state-notes-insert-after-drawers
12250 (save-excursion
12251 (forward-line) (looking-at org-drawer-regexp)))
12252 (forward-line)
12253 (while (looking-at org-drawer-regexp)
12254 (goto-char (match-end 0))
12255 (re-search-forward org-property-end-re (point-max) t)
12256 (forward-line))
12257 (forward-line -1)))
12258 (unless org-log-states-order-reversed
12260 (org-skip-over-state-notes)
12262 (move-marker org-log-note-marker (point))
12263 (setq org-log-note-purpose purpose
12264 org-log-note-state state
12265 org-log-note-previous-state prev-state
12266 org-log-note-how how
12267 org-log-note-extra extra
12268 org-log-note-effective-time (org-current-effective-time))
12269 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12271 (defun org-skip-over-state-notes ()
12272 "Skip past the list of State notes in an entry."
12274 (when (ignore-errors (goto-char (org-in-item-p)))
12275 (let* ((struct (org-list-struct))
12276 (prevs (org-list-prevs-alist struct)))
12278 (goto-char (or (org-list-get-next-item (point) struct prevs)
12279 (org-list-get-item-end (point) struct)))))))
12281 (defun org-add-log-note (&optional purpose)
12282 "Pop up a window for taking a note, and add this note later at point."
12283 (remove-hook 'post-command-hook 'org-add-log-note)
12284 (setq org-log-note-window-configuration (current-window-configuration))
12285 (delete-other-windows)
12286 (move-marker org-log-note-return-to (point))
12287 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12288 (goto-char org-log-note-marker)
12289 (org-switch-to-buffer-other-window "*Org Note*")
12290 (erase-buffer)
12291 (if (memq org-log-note-how '(time state))
12292 (let (current-prefix-arg) (org-store-log-note))
12293 (let ((org-inhibit-startup t)) (org-mode))
12294 (insert (format "# Insert note for %s.
12296 (cond
12297 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12298 ((eq org-log-note-purpose 'done) "closed todo item")
12299 ((eq org-log-note-purpose 'state)
12301 (or org-log-note-previous-state "")
12302 (or org-log-note-state "")))
12303 ((eq org-log-note-purpose 'reschedule)
12304 "rescheduling")
12305 ((eq org-log-note-purpose 'delschedule)
12306 "no longer scheduled")
12307 ((eq org-log-note-purpose 'redeadline)
12308 "changing deadline")
12309 ((eq org-log-note-purpose 'deldeadline)
12310 "removing deadline")
12311 ((eq org-log-note-purpose 'refile)
12312 "refiling")
12313 ((eq org-log-note-purpose 'note)
12314 "this entry")
12315 (t (error "This should not happen")))))
12316 (if org-log-note-extra (insert org-log-note-extra))
12317 (org-set-local 'org-finish-function 'org-store-log-note)
12318 (run-hooks 'org-log-buffer-setup-hook)))
12320 (defvar org-note-abort nil) ; dynamically scoped
12321 (defun org-store-log-note ()
12322 "Finish taking a log note, and insert it to where it belongs."
12323 (let ((txt (buffer-string))
12324 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12325 lines ind bul)
12326 (kill-buffer (current-buffer))
12328 (setq txt (replace-match "" t t txt)))
12330 (setq txt (replace-match "" t t txt)))
12333 (setq note
12334 (org-replace-escapes
12335 note
12336 (list (cons "%u" (user-login-name))
12337 (cons "%U" user-full-name)
12338 (cons "%t" (format-time-string
12339 (org-time-stamp-format 'long 'inactive)
12340 org-log-note-effective-time))
12341 (cons "%T" (format-time-string
12342 (org-time-stamp-format 'long nil)
12343 org-log-note-effective-time))
12344 (cons "%d" (format-time-string
12345 (org-time-stamp-format nil 'inactive)
12346 org-log-note-effective-time))
12347 (cons "%D" (format-time-string
12348 (org-time-stamp-format nil nil)
12349 org-log-note-effective-time))
12350 (cons "%s" (if org-log-note-state
12352 ""))
12353 (cons "%S" (if org-log-note-previous-state
12357 (push note lines))
12358 (when (or current-prefix-arg org-note-abort)
12359 (when org-log-into-drawer
12360 (org-remove-empty-drawer-at
12361 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12362 org-log-note-marker))
12363 (setq lines nil))
12364 (when lines
12365 (with-current-buffer (marker-buffer org-log-note-marker)
12366 (save-excursion
12367 (goto-char org-log-note-marker)
12368 (move-marker org-log-note-marker nil)
12369 (end-of-line 1)
12371 (setq ind (save-excursion
12372 (if (ignore-errors (goto-char (org-in-item-p)))
12373 (let ((struct (org-list-struct)))
12374 (org-list-get-ind
12375 (org-list-get-top-point struct) struct))
12377 (cond
12378 ((and (org-at-heading-p)
12379 org-adapt-indentation)
12380 (1+ (org-current-level)))
12381 ((org-at-heading-p) 0)
12382 (t (org-get-indentation))))))
12383 (setq bul (org-list-bullet-string "-"))
12384 (org-indent-line-to ind)
12385 (insert bul (pop lines))
12386 (let ((ind-body (+ (length bul) ind)))
12387 (while lines
12389 (org-indent-line-to ind-body)
12390 (insert (pop lines))))
12391 (message "Note stored")
12392 (org-back-to-heading t)
12393 (org-cycle-hide-drawers 'children)))))
12394 (set-window-configuration org-log-note-window-configuration)
12395 (with-current-buffer (marker-buffer org-log-note-return-to)
12396 (goto-char org-log-note-return-to))
12397 (move-marker org-log-note-return-to nil)
12398 (and org-log-post-message (message "%s" org-log-post-message)))
12400 (defun org-remove-empty-drawer-at (drawer pos)
12401 "Remove an empty drawer DRAWER at position POS.
12402 POS may also be a marker."
12403 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12404 (save-excursion
12405 (save-restriction
12406 (widen)
12407 (goto-char pos)
12408 (if (org-in-regexp
12410 (replace-match ""))))))
12412 (defun org-sparse-tree (&optional arg)
12413 "Create a sparse tree, prompt for the details.
12414 This command can create sparse trees. You first need to select the type
12415 of match used to create the tree:
12417 t Show all TODO entries.
12418 T Show entries with a specific TODO keyword.
12419 m Show entries selected by a tags/property match.
12420 p Enter a property name and its value (both with completion on existing
12421 names/values) and show entries with that property.
12422 r Show entries matching a regular expression (`/' can be used as well)
12423 d Show deadlines due within `org-deadline-warning-days'.
12424 b Show deadlines and scheduled items before a date.
12425 a Show deadlines and scheduled items after a date."
12426 (interactive "P")
12427 (let (ans kwd value)
12428 (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")
12429 (setq ans (read-char-exclusive))
12430 (cond
12431 ((equal ans ?d)
12432 (call-interactively 'org-check-deadlines))
12433 ((equal ans ?b)
12434 (call-interactively 'org-check-before-date))
12435 ((equal ans ?a)
12436 (call-interactively 'org-check-after-date))
12437 ((equal ans ?D)
12438 (call-interactively 'org-check-dates-range))
12439 ((equal ans ?t)
12440 (org-show-todo-tree nil))
12441 ((equal ans ?T)
12442 (org-show-todo-tree '(4)))
12443 ((member ans '(?T ?m))
12444 (call-interactively 'org-match-sparse-tree))
12445 ((member ans '(?p ?P))
12446 (setq kwd (org-icompleting-read "Property: "
12447 (mapcar 'list (org-buffer-property-keys))))
12448 (setq value (org-icompleting-read "Value: "
12449 (mapcar 'list (org-property-values kwd))))
12452 (org-match-sparse-tree arg (concat kwd "=" value)))
12453 ((member ans '(?r ?R ?/))
12454 (call-interactively 'org-occur))
12457 (defvar org-occur-highlights nil
12458 "List of overlays used for occur matches.")
12459 (make-variable-buffer-local 'org-occur-highlights)
12460 (defvar org-occur-parameters nil
12461 "Parameters of the active org-occur calls.
12462 This is a list, each call to org-occur pushes as cons cell,
12463 containing the regular expression and the callback, onto the list.
12464 The list can contain several entries if `org-occur' has been called
12465 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12466 will only contain one set of parameters. When the highlights are
12467 removed (for example with `C-c C-c', or with the next edit (depending
12468 on `org-remove-highlights-with-change'), this variable is emptied
12469 as well.")
12470 (make-variable-buffer-local 'org-occur-parameters)
12472 (defun org-occur (regexp &optional keep-previous callback)
12473 "Make a compact tree which shows all matches of REGEXP.
12474 The tree will show the lines where the regexp matches, and all higher
12475 headlines above the match. It will also show the heading after the match,
12476 to make sure editing the matching entry is easy.
12477 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12478 call to `org-occur' will be kept, to allow stacking of calls to this
12479 command.
12480 If CALLBACK is non-nil, it is a function which is called to confirm
12481 that the match should indeed be shown."
12483 (when (equal regexp "")
12484 (error "Regexp cannot be empty"))
12485 (unless keep-previous
12486 (org-remove-occur-highlights nil nil t))
12487 (push (cons regexp callback) org-occur-parameters)
12488 (let ((cnt 0))
12489 (save-excursion
12490 (goto-char (point-min))
12491 (if (or (not keep-previous) ; do not want to keep
12492 (not org-occur-highlights)) ; no previous matches
12493 ;; hide everything
12494 (org-overview))
12495 (while (re-search-forward regexp nil t)
12496 (when (or (not callback)
12497 (save-match-data (funcall callback)))
12498 (setq cnt (1+ cnt))
12499 (when org-highlight-sparse-tree-matches
12500 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12501 (org-show-context 'occur-tree))))
12502 (when org-remove-highlights-with-change
12503 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12504 nil 'local))
12505 (unless org-sparse-tree-open-archived-trees
12506 (org-hide-archived-subtrees (point-min) (point-max)))
12507 (run-hooks 'org-occur-hook)
12508 (if (org-called-interactively-p 'interactive)
12509 (message "%d match(es) for regexp %s" cnt regexp))
12510 cnt))
12512 (defun org-occur-next-match (&optional n reset)
12513 "Function for `next-error-function' to find sparse tree matches.
12514 N is the number of matches to move, when negative move backwards.
12515 RESET is entirely ignored - this function always goes back to the
12516 starting point when no match is found."
12517 (let* ((limit (if (< n 0) (point-min) (point-max)))
12518 (search-func (if (< n 0)
12519 'previous-single-char-property-change
12520 'next-single-char-property-change))
12521 (n (abs n))
12522 (pos (point))
12523 p1)
12524 (catch 'exit
12525 (while (setq p1 (funcall search-func (point) 'org-type))
12526 (when (equal p1 limit)
12527 (goto-char pos)
12528 (error "No more matches"))
12529 (when (equal (get-char-property p1 'org-type) 'org-occur)
12530 (setq n (1- n))
12531 (when (= n 0)
12532 (goto-char p1)
12533 (throw 'exit (point))))
12534 (goto-char p1))
12535 (goto-char p1)
12536 (error "No more matches"))))
12538 (defun org-show-context (&optional key)
12539 "Make sure point and context are visible.
12540 How much context is shown depends upon the variables
12541 `org-show-hierarchy-above', `org-show-following-heading',
12542 `org-show-entry-below' and `org-show-siblings'."
12543 (let ((heading-p (org-at-heading-p t))
12544 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12545 (following-p (org-get-alist-option org-show-following-heading key))
12546 (entry-p (org-get-alist-option org-show-entry-below key))
12547 (siblings-p (org-get-alist-option org-show-siblings key)))
12548 (catch 'exit
12549 ;; Show heading or entry text
12550 (if (and heading-p (not entry-p))
12551 (org-flag-heading nil) ; only show the heading
12552 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12553 (org-show-hidden-entry))) ; show entire entry
12554 (when following-p
12555 ;; Show next sibling, or heading below text
12556 (save-excursion
12557 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12558 (org-flag-heading nil))))
12559 (when siblings-p (org-show-siblings))
12560 (when hierarchy-p
12561 ;; show all higher headings, possibly with siblings
12562 (save-excursion
12563 (while (and (condition-case nil
12564 (progn (org-up-heading-all 1) t)
12565 (error nil))
12566 (not (bobp)))
12567 (org-flag-heading nil)
12568 (when siblings-p (org-show-siblings))))))))
12570 (defvar org-reveal-start-hook nil
12571 "Hook run before revealing a location.")
12573 (defun org-reveal (&optional siblings)
12574 "Show current entry, hierarchy above it, and the following headline.
12575 This can be used to show a consistent set of context around locations
12576 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12577 not t for the search context.
12579 With optional argument SIBLINGS, on each level of the hierarchy all
12580 siblings are shown. This repairs the tree structure to what it would
12581 look like when opened with hierarchical calls to `org-cycle'.
12583 go to the parent and show the
12584 entire tree."
12585 (interactive "P")
12586 (run-hooks 'org-reveal-start-hook)
12587 (let ((org-show-hierarchy-above t)
12588 (org-show-following-heading t)
12589 (org-show-siblings (if siblings t org-show-siblings)))
12590 (org-show-context nil))
12591 (when (equal siblings '(16))
12592 (save-excursion
12593 (when (org-up-heading-safe)
12594 (org-show-subtree)
12595 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12597 (defun org-highlight-new-match (beg end)
12598 "Highlight from BEG to END and mark the highlight is an occur headline."
12599 (let ((ov (make-overlay beg end)))
12600 (overlay-put ov 'face 'secondary-selection)
12601 (overlay-put ov 'org-type 'org-occur)
12602 (push ov org-occur-highlights)))
12604 (defun org-remove-occur-highlights (&optional beg end noremove)
12605 "Remove the occur highlights from the buffer.
12606 BEG and END are ignored. If NOREMOVE is nil, remove this function
12607 from the `before-change-functions' in the current buffer."
12608 (interactive)
12609 (unless org-inhibit-highlight-removal
12610 (mapc 'delete-overlay org-occur-highlights)
12611 (setq org-occur-highlights nil)
12612 (setq org-occur-parameters nil)
12613 (unless noremove
12614 (remove-hook 'before-change-functions
12615 'org-remove-occur-highlights 'local))))
12617 ;;;; Priorities
12620 "Regular expression matching the priority indicator.")
12622 (defvar org-remove-priority-next-time nil)
12624 (defun org-priority-up ()
12625 "Increase the priority of the current item."
12626 (interactive)
12627 (org-priority 'up))
12629 (defun org-priority-down ()
12630 "Decrease the priority of the current item."
12631 (interactive)
12632 (org-priority 'down))
12634 (defun org-priority (&optional action)
12635 "Change the priority of an item by ARG.
12636 ACTION can be `set', `up', `down', or a character."
12637 (interactive)
12638 (unless org-enable-priority-commands
12639 (error "Priority commands are disabled"))
12640 (setq action (or action 'set))
12641 (let (current new news have remove)
12642 (save-excursion
12643 (org-back-to-heading t)
12644 (if (looking-at org-priority-regexp)
12645 (setq current (string-to-char (match-string 2))
12646 have t))
12647 (cond
12648 ((eq action 'remove)
12649 (setq remove t new ?\ ))
12650 ((or (eq action 'set)
12651 (if (featurep 'xemacs) (characterp action) (integerp action)))
12652 (if (not (eq action 'set))
12653 (setq new action)
12654 (message "Priority %c-%c, SPC to remove: "
12655 org-highest-priority org-lowest-priority)
12656 (save-match-data
12657 (setq new (read-char-exclusive))))
12658 (if (and (= (upcase org-highest-priority) org-highest-priority)
12659 (= (upcase org-lowest-priority) org-lowest-priority))
12660 (setq new (upcase new)))
12661 (cond ((equal new ?\ ) (setq remove t))
12662 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12663 (error "Priority must be between `%c' and `%c'"
12664 org-highest-priority org-lowest-priority))))
12665 ((eq action 'up)
12666 (setq new (if have
12667 (1- current) ; normal cycling
12668 ;; last priority was empty
12669 (if (eq last-command this-command)
12670 org-lowest-priority ; wrap around empty to lowest
12671 ;; default
12672 (if org-priority-start-cycle-with-default
12673 org-default-priority
12674 (1- org-default-priority))))))
12675 ((eq action 'down)
12676 (setq new (if have
12677 (1+ current) ; normal cycling
12678 ;; last priority was empty
12679 (if (eq last-command this-command)
12680 org-highest-priority ; wrap around empty to highest
12681 ;; default
12682 (if org-priority-start-cycle-with-default
12683 org-default-priority
12684 (1+ org-default-priority))))))
12685 (t (error "Invalid action")))
12686 (if (or (< (upcase new) org-highest-priority)
12687 (> (upcase new) org-lowest-priority))
12688 (if (and (memq action '(up down))
12689 (not have) (not (eq last-command this-command)))
12690 ;; `new' is from default priority
12691 (error
12692 "The default can not be set, see `org-default-priority' why")
12693 ;; normal cycling: `new' is beyond highest/lowest priority
12694 ;; and is wrapped around to the empty priority
12695 (setq remove t)))
12696 (setq news (format "%c" new))
12697 (if have
12698 (if remove
12699 (replace-match "" t t nil 1)
12700 (replace-match news t t nil 2))
12701 (if remove
12702 (error "No priority cookie found in line")
12703 (let ((case-fold-search nil))
12704 (looking-at org-todo-line-regexp))
12705 (if (match-end 2)
12706 (progn
12707 (goto-char (match-end 2))
12708 (insert " [#" news "]"))
12709 (goto-char (match-beginning 3))
12710 (insert "[#" news "] "))))
12711 (org-preserve-lc (org-set-tags nil 'align)))
12712 (if remove
12713 (message "Priority removed")
12714 (message "Priority of current item set to %s" news))))
12716 (defun org-get-priority (s)
12717 "Find priority cookie and return priority."
12718 (if (functionp org-get-priority-function)
12719 (funcall org-get-priority-function)
12720 (save-match-data
12721 (if (not (string-match org-priority-regexp s))
12722 (* 1000 (- org-lowest-priority org-default-priority))
12723 (* 1000 (- org-lowest-priority
12724 (string-to-char (match-string 2 s))))))))
12726 ;;;; Tags
12728 (defvar org-agenda-archives-mode)
12729 (defvar org-map-continue-from nil
12730 "Position from where mapping should continue.
12731 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12733 (defvar org-scanner-tags nil
12734 "The current tag list while the tags scanner is running.")
12735 (defvar org-trust-scanner-tags nil
12736 "Should `org-get-tags-at' use the tags for the scanner.
12737 This is for internal dynamical scoping only.
12738 When this is non-nil, the function `org-get-tags-at' will return the value
12739 of `org-scanner-tags' instead of building the list by itself. This
12740 can lead to large speed-ups when the tags scanner is used in a file with
12741 many entries, and when the list of tags is retrieved, for example to
12742 obtain a list of properties. Building the tags list for each entry in such
12743 a file becomes an N^2 operation - but with this variable set, it scales
12744 as N.")
12746 (defun org-scan-tags (action matcher &optional todo-only start-level)
12747 "Scan headline tags with inheritance and produce output ACTION.
12749 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12750 or `agenda' to produce an entry list for an agenda view. It can also be
12751 a Lisp form or a function that should be called at each matched headline, in
12752 this case the return value is a list of all return values from these calls.
12754 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12755 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12756 only lines with a TODO keyword are included in the output.
12758 START-LEVEL can be a string with asterisks, reducing the scope to
12759 headlines matching this string."
12760 (require 'org-agenda)
12761 (let* ((re (concat "^"
12762 (if start-level
12763 ;; Get the correct level to match
12765 org-outline-regexp)
12768 (org-re
12770 (props (list 'face 'default
12771 'done-face 'org-agenda-done
12772 'undone-face 'default
12773 'mouse-face 'highlight
12774 'org-not-done-regexp org-not-done-regexp
12775 'org-todo-regexp org-todo-regexp
12776 'org-complex-heading-regexp org-complex-heading-regexp
12777 'help-echo
12778 (format "mouse-2 or RET jump to org file %s"
12779 (abbreviate-file-name
12780 (or (buffer-file-name (buffer-base-buffer))
12781 (buffer-name (buffer-base-buffer)))))))
12782 (case-fold-search nil)
12783 (org-map-continue-from nil)
12784 lspos tags tags-list
12785 (tags-alist (list (cons 0 org-file-tags)))
12786 (llast 0) rtn rtn1 level category i txt
12787 todo marker entry priority)
12788 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12789 (setq action (list 'lambda nil action)))
12790 (save-excursion
12791 (goto-char (point-min))
12792 (when (eq action 'sparse-tree)
12793 (org-overview)
12794 (org-remove-occur-highlights))
12795 (while (re-search-forward re nil t)
12796 (setq org-map-continue-from nil)
12797 (catch :skip
12798 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12799 tags (if (match-end 4) (org-match-string-no-properties 4)))
12800 (goto-char (setq lspos (match-beginning 0)))
12801 (setq level (org-reduced-level (funcall outline-level))
12802 category (org-get-category))
12803 (setq i llast llast level)
12804 ;; remove tag lists from same and sublevels
12805 (while (>= i level)
12806 (when (setq entry (assoc i tags-alist))
12807 (setq tags-alist (delete entry tags-alist)))
12808 (setq i (1- i)))
12809 ;; add the next tags
12810 (when tags
12811 (setq tags (org-split-string tags ":")
12812 tags-alist
12813 (cons (cons level tags) tags-alist)))
12814 ;; compile tags for current headline
12815 (setq tags-list
12816 (if org-use-tag-inheritance
12817 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12818 tags)
12819 org-scanner-tags tags-list)
12820 (when org-use-tag-inheritance
12821 (setcdr (car tags-alist)
12822 (mapcar (lambda (x)
12823 (setq x (copy-sequence x))
12824 (org-add-prop-inherited x))
12825 (cdar tags-alist))))
12826 (when (and tags org-use-tag-inheritance
12827 (or (not (eq t org-use-tag-inheritance))
12828 org-tags-exclude-from-inheritance))
12829 ;; selective inheritance, remove uninherited ones
12830 (setcdr (car tags-alist)
12831 (org-remove-uninherited-tags (cdar tags-alist))))
12832 (when (and
12834 ;; eval matcher only when the todo condition is OK
12835 (and (or (not todo-only) (member todo org-not-done-keywords))
12836 (let ((case-fold-search t)) (eval matcher)))
12838 ;; Call the skipper, but return t if it does not skip,
12839 ;; so that the `and' form continues evaluating
12840 (progn
12841 (unless (eq action 'sparse-tree) (org-agenda-skip))
12842 t)
12844 ;; Check if timestamps are deselecting this entry
12845 (or (not todo-only)
12846 (and (member todo org-not-done-keywords)
12847 (or (not org-agenda-tags-todo-honor-ignore-options)
12848 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12850 ;; Extra check for the archive tag
12851 ;; FIXME: Does the skipper already do this????
12852 (or
12853 (not (member org-archive-tag tags-list))
12854 ;; we have an archive tag, should we use this anyway?
12855 (or (not org-agenda-skip-archived-trees)
12856 (and (eq action 'agenda) org-agenda-archives-mode))))
12858 ;; select this headline
12860 (cond
12861 ((eq action 'sparse-tree)
12862 (and org-highlight-sparse-tree-matches
12863 (org-get-heading) (match-end 0)
12864 (org-highlight-new-match
12865 (match-beginning 0) (match-beginning 1)))
12866 (org-show-context 'tags-tree))
12867 ((eq action 'agenda)
12868 (setq txt (org-agenda-format-item
12869 ""
12870 (concat
12871 (if (eq org-tags-match-list-sublevels 'indented)
12872 (make-string (1- level) ?.) "")
12873 (org-get-heading))
12874 category
12875 tags-list
12876 )
12877 priority (org-get-priority txt))
12878 (goto-char lspos)
12879 (setq marker (org-agenda-new-marker))
12880 (org-add-props txt props
12881 'org-marker marker 'org-hd-marker marker 'org-category category
12882 'todo-state todo
12883 'priority priority 'type "tagsmatch")
12884 (push txt rtn))
12885 ((functionp action)
12886 (setq org-map-continue-from nil)
12887 (save-excursion
12888 (setq rtn1 (funcall action))
12889 (push rtn1 rtn)))
12890 (t (error "Invalid action")))
12892 ;; if we are to skip sublevels, jump to end of subtree
12893 (unless org-tags-match-list-sublevels
12894 (org-end-of-subtree t)
12895 (backward-char 1))))
12896 ;; Get the correct position from where to continue
12897 (if org-map-continue-from
12898 (goto-char org-map-continue-from)
12899 (and (= (point) lspos) (end-of-line 1)))))
12900 (when (and (eq action 'sparse-tree)
12901 (not org-sparse-tree-open-archived-trees))
12902 (org-hide-archived-subtrees (point-min) (point-max)))
12903 (nreverse rtn)))
12905 (defun org-remove-uninherited-tags (tags)
12906 "Remove all tags that are not inherited from the list TAGS."
12907 (cond
12908 ((eq org-use-tag-inheritance t)
12909 (if org-tags-exclude-from-inheritance
12910 (org-delete-all org-tags-exclude-from-inheritance tags)
12911 tags))
12912 ((not org-use-tag-inheritance) nil)
12913 ((stringp org-use-tag-inheritance)
12914 (delq nil (mapcar
12915 (lambda (x)
12916 (if (and (string-match org-use-tag-inheritance x)
12917 (not (member x org-tags-exclude-from-inheritance)))
12918 x nil))
12919 tags)))
12920 ((listp org-use-tag-inheritance)
12921 (delq nil (mapcar
12922 (lambda (x)
12923 (if (member x org-use-tag-inheritance) x nil))
12924 tags)))))
12926 (defvar todo-only) ;; dynamically scoped
12928 (defun org-match-sparse-tree (&optional todo-only match)
12929 "Create a sparse tree according to tags string MATCH.
12930 MATCH can contain positive and negative selection of tags, like
12932 If optional argument TODO-ONLY is non-nil, only select lines that are
12933 also TODO lines."
12934 (interactive "P")
12935 (org-prepare-agenda-buffers (list (current-buffer)))
12936 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12938 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12940 (defvar org-cached-props nil)
12941 (defun org-cached-entry-get (pom property)
12942 (if (or (eq t org-use-property-inheritance)
12943 (and (stringp org-use-property-inheritance)
12944 (string-match org-use-property-inheritance property))
12945 (and (listp org-use-property-inheritance)
12946 (member property org-use-property-inheritance)))
12947 ;; Caching is not possible, check it directly
12948 (org-entry-get pom property 'inherit)
12949 ;; Get all properties, so that we can do complicated checks easily
12950 (cdr (assoc property (or org-cached-props
12951 (setq org-cached-props
12952 (org-entry-properties pom)))))))
12954 (defun org-global-tags-completion-table (&optional files)
12955 "Return the list of all tags in all agenda buffer/files.
12956 Optional FILES argument is a list of files to which can be used
12957 instead of the agenda files."
12958 (save-excursion
12959 (org-uniquify
12960 (delq nil
12961 (apply 'append
12962 (mapcar
12963 (lambda (file)
12964 (set-buffer (find-file-noselect file))
12965 (append (org-get-buffer-tags)
12966 (mapcar (lambda (x) (if (stringp (car-safe x))
12967 (list (car-safe x)) nil))
12968 org-tag-alist)))
12969 (if (and files (car files))
12970 files
12971 (org-agenda-files))))))))
12973 (defun org-make-tags-matcher (match)
12974 "Create the TAGS/TODO matcher form for the selection string MATCH."
12975 ;; todo-only is scoped dynamically into this function, and the function
12976 ;; may change it if the matcher asks for it.
12977 (unless match
12978 ;; Get a new match request, with completion
12979 (let ((org-last-tags-completion-table
12980 (org-global-tags-completion-table)))
12981 (setq match (org-completing-read-no-i
12982 "Match: " 'org-tags-completion-function nil nil nil
12983 'org-tags-history))))
12985 ;; Parse the string and create a lisp form
12986 (let ((match0 match)
12987 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12988 minus tag mm
12989 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12990 orterms term orlist re-p str-p level-p level-op time-p
12991 prop-p pn pv po gv rest)
12992 (if (string-match "/+" match)
12993 ;; match contains also a todo-matching request
12994 (progn
12995 (setq tagsmatch (substring match 0 (match-beginning 0))
12996 todomatch (substring match (match-end 0)))
12997 (if (string-match "^!" todomatch)
12998 (setq todo-only t todomatch (substring todomatch 1)))
13000 (setq todomatch nil)))
13001 ;; only matching tags
13002 (setq tagsmatch match todomatch nil))
13004 ;; Make the tags matcher
13006 (setq tagsmatcher t)
13007 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13008 (while (setq term (pop orterms))
13010 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13011 (while (string-match re term)
13012 (setq rest (substring term (match-end 0))
13013 minus (and (match-end 1)
13014 (equal (match-string 1 term) "-"))
13015 tag (save-match-data (replace-regexp-in-string
13017 (match-string 2 term)))
13018 re-p (equal (string-to-char tag) ?{)
13019 level-p (match-end 4)
13020 prop-p (match-end 5)
13021 mm (cond
13022 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13023 (level-p
13024 (setq level-op (org-op-to-function (match-string 3 term)))
13025 `(,level-op level ,(string-to-number
13026 (match-string 4 term))))
13027 (prop-p
13028 (setq pn (match-string 5 term)
13029 po (match-string 6 term)
13030 pv (match-string 7 term)
13031 re-p (equal (string-to-char pv) ?{)
13033 time-p (save-match-data
13035 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13036 (if time-p (setq pv (org-matcher-time pv)))
13037 (setq po (org-op-to-function po (if time-p 'time str-p)))
13038 (cond
13039 ((equal pn "CATEGORY")
13040 (setq gv '(get-text-property (point) 'org-category)))
13041 ((equal pn "TODO")
13042 (setq gv 'todo))
13043 (t
13044 (setq gv `(org-cached-entry-get nil ,pn))))
13045 (if re-p
13046 (if (eq po 'org<>)
13047 `(not (string-match ,pv (or ,gv "")))
13048 `(string-match ,pv (or ,gv "")))
13049 (if str-p
13050 `(,po (or ,gv "") ,pv)
13051 `(,po (string-to-number (or ,gv ""))
13052 ,(string-to-number pv) ))))
13053 (t `(member ,tag tags-list)))
13054 mm (if minus (list 'not mm) mm)
13055 term rest)
13056 (push mm tagsmatcher))
13057 (push (if (> (length tagsmatcher) 1)
13058 (cons 'and tagsmatcher)
13059 (car tagsmatcher))
13060 orlist)
13061 (setq tagsmatcher nil))
13062 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13063 (setq tagsmatcher
13064 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13065 ;; Make the todo matcher
13067 (setq todomatcher t)
13068 (setq orterms (org-split-string todomatch "|") orlist nil)
13069 (while (setq term (pop orterms))
13070 (while (string-match re term)
13071 (setq minus (and (match-end 1)
13072 (equal (match-string 1 term) "-"))
13073 kwd (match-string 2 term)
13074 re-p (equal (string-to-char kwd) ?{)
13075 term (substring term (match-end 0))
13076 mm (if re-p
13077 `(string-match ,(substring kwd 1 -1) todo)
13078 (list 'equal 'todo kwd))
13079 mm (if minus (list 'not mm) mm))
13080 (push mm todomatcher))
13081 (push (if (> (length todomatcher) 1)
13082 (cons 'and todomatcher)
13083 (car todomatcher))
13084 orlist)
13085 (setq todomatcher nil))
13086 (setq todomatcher (if (> (length orlist) 1)
13087 (cons 'or orlist) (car orlist))))
13089 ;; Return the string and lisp forms of the matcher
13090 (setq matcher (if todomatcher
13091 (list 'and tagsmatcher todomatcher)
13092 tagsmatcher))
13093 (cons match0 matcher)))
13095 (defun org-op-to-function (op &optional stringp)
13096 "Turn an operator into the appropriate function."
13097 (setq op
13098 (cond
13099 ((equal op "<" ) '(< string< org-time<))
13100 ((equal op ">" ) '(> org-string> org-time>))
13101 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13102 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13103 ((member op '("=" "==")) '(= string= org-time=))
13104 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13105 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13107 (defun org<> (a b) (not (= a b)))
13108 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13109 (defun org-string>= (a b) (not (string< a b)))
13110 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13111 (defun org-string<> (a b) (not (string= a b)))
13112 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= 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) (org<> a b)))
13118 (defun org-2ft (s)
13119 "Convert S to a floating point time.
13120 If S is already a number, just return it. If it is a string, parse
13121 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13122 (cond
13123 ((numberp s) s)
13124 ((stringp s)
13125 (condition-case nil
13126 (float-time (apply 'encode-time (org-parse-time-string s)))
13127 (error 0.)))
13128 (t 0.)))
13130 (defun org-time-today ()
13131 "Time in seconds today at 0:00.
13132 Returns the float number of seconds since the beginning of the
13133 epoch to the beginning of today (00:00)."
13134 (float-time (apply 'encode-time
13135 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13137 (defun org-matcher-time (s)
13138 "Interpret a time comparison value."
13139 (save-match-data
13140 (cond
13141 ((string= s "<now>") (float-time))
13142 ((string= s "<today>") (org-time-today))
13143 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13144 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13146 (+ (org-time-today)
13147 (* (string-to-number (match-string 1 s))
13148 (cdr (assoc (match-string 2 s)
13149 '(("d" . 86400.0) ("w" . 604800.0)
13150 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13151 (t (org-2ft s)))))
13153 (defun org-match-any-p (re list)
13154 "Does re match any element of list?"
13155 (setq list (mapcar (lambda (x) (string-match re x)) list))
13156 (delq nil list))
13158 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13159 (defvar org-tags-overlay (make-overlay 1 1))
13160 (org-detach-overlay org-tags-overlay)
13162 (defun org-get-local-tags-at (&optional pos)
13163 "Get a list of tags defined in the current headline."
13164 (org-get-tags-at pos 'local))
13166 (defun org-get-local-tags ()
13167 "Get a list of tags defined in the current headline."
13168 (org-get-tags-at nil 'local))
13170 (defun org-get-tags-at (&optional pos local)
13171 "Get a list of all headline tags applicable at POS.
13172 POS defaults to point. If tags are inherited, the list contains
13173 the targets in the same sequence as the headlines appear, i.e.
13174 the tags of the current headline come last.
13175 When LOCAL is non-nil, only return tags from the current headline,
13176 ignore inherited ones."
13177 (interactive)
13178 (if (and org-trust-scanner-tags
13179 (or (not pos) (equal pos (point)))
13180 (not local))
13181 org-scanner-tags
13182 (let (tags ltags lastpos parent)
13183 (save-excursion
13184 (save-restriction
13185 (widen)
13186 (goto-char (or pos (point)))
13187 (save-match-data
13188 (catch 'done
13189 (condition-case nil
13190 (progn
13191 (org-back-to-heading t)
13192 (while (not (equal lastpos (point)))
13193 (setq lastpos (point))
13194 (when (looking-at
13196 (setq ltags (org-split-string
13197 (org-match-string-no-properties 1) ":"))
13198 (when parent
13199 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13200 (setq tags (append
13201 (if parent
13202 (org-remove-uninherited-tags ltags)
13203 ltags)
13204 tags)))
13205 (or org-use-tag-inheritance (throw 'done t))
13206 (if local (throw 'done t))
13207 (or (org-up-heading-safe) (error nil))
13208 (setq parent t)))
13209 (error nil)))))
13210 (if local
13211 tags
13212 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13214 (defun org-add-prop-inherited (s)
13215 (add-text-properties 0 (length s) '(inherited t) s)
13216 s)
13218 (defun org-toggle-tag (tag &optional onoff)
13219 "Toggle the tag TAG for the current line.
13220 If ONOFF is `on' or `off', don't toggle but set to this state."
13221 (let (res current)
13222 (save-excursion
13223 (org-back-to-heading t)
13225 (point-at-eol) t)
13226 (progn
13227 (setq current (match-string 1))
13228 (replace-match ""))
13229 (setq current ""))
13230 (setq current (nreverse (org-split-string current ":")))
13231 (cond
13232 ((eq onoff 'on)
13233 (setq res t)
13234 (or (member tag current) (push tag current)))
13235 ((eq onoff 'off)
13236 (or (not (member tag current)) (setq current (delete tag current))))
13237 (t (if (member tag current)
13238 (setq current (delete tag current))
13239 (setq res t)
13240 (push tag current))))
13241 (end-of-line 1)
13242 (if current
13243 (progn
13244 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13245 (org-set-tags nil t))
13246 (delete-horizontal-space))
13247 (run-hooks 'org-after-tags-change-hook))
13248 res))
13250 (defun org-align-tags-here (to-col)
13251 ;; Assumes that this is a headline
13252 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13253 (beginning-of-line 1)
13255 (< pos (match-beginning 2)))
13256 (progn
13257 (setq tags-l (- (match-end 2) (match-beginning 2)))
13258 (goto-char (match-beginning 1))
13259 (insert " ")
13260 (delete-region (point) (1+ (match-beginning 2)))
13261 (setq ncol (max (current-column)
13262 (1+ col)
13263 (if (> to-col 0)
13264 to-col
13265 (- (abs to-col) tags-l))))
13266 (setq p (point))
13267 (insert (make-string (- ncol (current-column)) ?\ ))
13268 (setq ncol (current-column))
13269 (when indent-tabs-mode (tabify p (point-at-eol)))
13270 (org-move-to-column (min ncol col) t))
13271 (goto-char pos))))
13273 (defun org-set-tags-command (&optional arg just-align)
13274 "Call the set-tags command for the current entry."
13275 (interactive "P")
13276 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13277 (org-set-tags arg just-align)
13278 (save-excursion
13279 (org-back-to-heading t)
13280 (org-set-tags arg just-align))))
13282 (defun org-set-tags-to (data)
13283 "Set the tags of the current entry to DATA, replacing the current tags.
13284 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13285 If DATA is nil or the empty string, any tags will be removed."
13286 (interactive "sTags: ")
13287 (setq data
13288 (cond
13289 ((eq data nil) "")
13290 ((equal data "") "")
13291 ((stringp data)
13292 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13293 ":"))
13294 ((listp data)
13295 (concat ":" (mapconcat 'identity data ":") ":"))
13296 (t nil)))
13297 (when data
13298 (save-excursion
13299 (org-back-to-heading t)
13300 (when (looking-at org-complex-heading-regexp)
13301 (if (match-end 5)
13302 (progn
13303 (goto-char (match-beginning 5))
13304 (insert data)
13305 (delete-region (point) (point-at-eol))
13306 (org-set-tags nil 'align))
13307 (goto-char (point-at-eol))
13308 (insert " " data)
13309 (org-set-tags nil 'align)))
13310 (beginning-of-line 1)
13312 (delete-region (match-beginning 1) (match-end 1))))))
13314 (defun org-align-all-tags ()
13315 "Align the tags i all headings."
13316 (interactive)
13317 (save-excursion
13318 (or (ignore-errors (org-back-to-heading t))
13319 (outline-next-heading))
13320 (if (org-at-heading-p)
13321 (org-set-tags t)
13322 (message "No headings"))))
13324 (defvar org-indent-indentation-per-level)
13325 (defun org-set-tags (&optional arg just-align)
13326 "Set the tags for the current headline.
13327 With prefix ARG, realign all tags in headings in the current buffer."
13328 (interactive "P")
13329 (let* ((re org-outline-regexp-bol)
13330 (current (unless arg (org-get-tags-string)))
13331 (col (current-column))
13332 (org-setting-tags t)
13333 table current-tags inherited-tags ; computed below when needed
13334 tags p0 c0 c1 rpl di tc level)
13335 (if arg
13336 (save-excursion
13337 (goto-char (point-min))
13338 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13339 (while (re-search-forward re nil t)
13340 (org-set-tags nil t)
13341 (end-of-line 1)))
13342 (message "All tags realigned to column %d" org-tags-column))
13343 (if just-align
13344 (setq tags current)
13345 ;; Get a new set of tags from the user
13346 (save-excursion
13347 (setq table (append org-tag-persistent-alist
13348 (or org-tag-alist (org-get-buffer-tags))
13349 (and
13350 org-complete-tags-always-offer-all-agenda-tags
13351 (org-global-tags-completion-table
13352 (org-agenda-files))))
13353 org-last-tags-completion-table table
13354 current-tags (org-split-string current ":")
13355 inherited-tags (nreverse
13356 (nthcdr (length current-tags)
13357 (nreverse (org-get-tags-at))))
13358 tags
13359 (if (or (eq t org-use-fast-tag-selection)
13360 (and org-use-fast-tag-selection
13361 (delq nil (mapcar 'cdr table))))
13362 (org-fast-tag-selection
13363 current-tags inherited-tags table
13364 (if org-fast-tag-selection-include-todo
13365 org-todo-key-alist))
13366 (let ((org-add-colon-after-tag-completion t))
13367 (org-trim
13368 (org-icompleting-read "Tags: "
13369 'org-tags-completion-function
13370 nil nil current 'org-tags-history))))))
13371 (while (string-match "[-+&]+" tags)
13372 ;; No boolean logic, just a list
13373 (setq tags (replace-match ":" t t tags))))
13375 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13377 (if org-tags-sort-function
13378 (setq tags (mapconcat 'identity
13379 (sort (org-split-string
13380 tags (org-re "[^[:alnum:]_@#%]+"))
13381 org-tags-sort-function) ":")))
13384 (setq tags "")
13385 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13386 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13388 ;; Insert new tags at the correct column
13389 (beginning-of-line 1)
13390 (setq level (or (and (looking-at org-outline-regexp)
13391 (- (match-end 0) (point) 1))
13392 1))
13393 (cond
13394 ((and (equal current "") (equal tags "")))
13395 ((re-search-forward
13397 (point-at-eol) t)
13398 (if (equal tags "")
13399 (setq rpl "")
13400 (goto-char (match-beginning 0))
13401 (setq c0 (current-column)
13402 ;; compute offset for the case of org-indent-mode active
13403 di (if org-indent-mode
13404 (* (1- org-indent-indentation-per-level) (1- level))
13405 0)
13406 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13407 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13408 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13409 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13410 (replace-match rpl t t)
13411 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13412 tags)
13413 (t (error "Tags alignment failed")))
13414 (org-move-to-column col)
13415 (unless just-align
13416 (run-hooks 'org-after-tags-change-hook)))))
13418 (defun org-change-tag-in-region (beg end tag off)
13419 "Add or remove TAG for each entry in the region.
13420 This works in the agenda, and also in an org-mode buffer."
13421 (interactive
13422 (list (region-beginning) (region-end)
13423 (let ((org-last-tags-completion-table
13424 (if (eq major-mode 'org-mode)
13425 (org-get-buffer-tags)
13426 (org-global-tags-completion-table))))
13427 (org-icompleting-read
13428 "Tag: " 'org-tags-completion-function nil nil nil
13429 'org-tags-history))
13430 (progn
13432 (equal (read-char-exclusive) ?r))))
13433 (if (fboundp 'deactivate-mark) (deactivate-mark))
13434 (let ((agendap (equal major-mode 'org-agenda-mode))
13435 l1 l2 m buf pos newhead (cnt 0))
13436 (goto-char end)
13437 (setq l2 (1- (org-current-line)))
13438 (goto-char beg)
13439 (setq l1 (org-current-line))
13440 (loop for l from l1 to l2 do
13441 (org-goto-line l)
13442 (setq m (get-text-property (point) 'org-hd-marker))
13443 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13444 (and agendap m))
13445 (setq buf (if agendap (marker-buffer m) (current-buffer))
13446 pos (if agendap m (point)))
13447 (with-current-buffer buf
13448 (save-excursion
13449 (save-restriction
13450 (goto-char pos)
13451 (setq cnt (1+ cnt))
13452 (org-toggle-tag tag (if off 'off 'on))
13453 (setq newhead (org-get-heading)))))
13454 (and agendap (org-agenda-change-all-lines newhead m))))
13455 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13457 (defun org-tags-completion-function (string predicate &optional flag)
13458 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13459 (confirm (lambda (x) (stringp (car x)))))
13461 (setq s1 (match-string 1 string)
13462 s2 (match-string 2 string))
13463 (setq s1 "" s2 string))
13464 (cond
13465 ((eq flag nil)
13466 ;; try completion
13467 (setq rtn (try-completion s2 ctable confirm))
13468 (if (stringp rtn)
13469 (setq rtn
13470 (concat s1 s2 (substring rtn (length s2))
13471 (if (and org-add-colon-after-tag-completion
13472 (assoc rtn ctable))
13473 ":" ""))))
13474 rtn)
13475 ((eq flag t)
13476 ;; all-completions
13477 (all-completions s2 ctable confirm)
13478 )
13479 ((eq flag 'lambda)
13480 ;; exact match?
13481 (assoc s2 ctable)))
13482 ))
13484 (defun org-fast-tag-insert (kwd tags face &optional end)
13485 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13486 (insert (format "%-12s" (concat kwd ":"))
13487 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13488 (or end "")))
13490 (defun org-fast-tag-show-exit (flag)
13491 (save-excursion
13492 (org-goto-line 3)
13494 (replace-match ""))
13495 (when flag
13496 (end-of-line 1)
13497 (org-move-to-column (- (window-width) 19) t)
13498 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13500 (defun org-set-current-tags-overlay (current prefix)
13501 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13502 (if (featurep 'xemacs)
13503 (org-overlay-display org-tags-overlay (concat prefix s)
13504 'secondary-selection)
13505 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13506 (org-overlay-display org-tags-overlay (concat prefix s)))))
13508 (defvar org-last-tag-selection-key nil)
13509 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13510 "Fast tag selection with single keys.
13511 CURRENT is the current list of tags in the headline, INHERITED is the
13512 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13513 possibly with grouping information. TODO-TABLE is a similar table with
13514 TODO keywords, should these have keys assigned to them.
13515 If the keys are nil, a-z are automatically assigned.
13516 Returns the new tags string, or nil to not change the current settings."
13517 (let* ((fulltable (append table todo-table))
13518 (maxlen (apply 'max (mapcar
13519 (lambda (x)
13520 (if (stringp (car x)) (string-width (car x)) 0))
13521 fulltable)))
13522 (buf (current-buffer))
13523 (expert (eq org-fast-tag-selection-single-key 'expert))
13524 (buffer-tags nil)
13525 (fwidth (+ maxlen 3 1 3))
13526 (ncol (/ (- (window-width) 4) fwidth))
13527 (i-face 'org-done)
13528 (c-face 'org-todo)
13529 tg cnt e c char c1 c2 ntable tbl rtn
13530 ov-start ov-end ov-prefix
13531 (exit-after-next org-fast-tag-selection-single-key)
13532 (done-keywords org-done-keywords)
13533 groups ingroup)
13534 (save-excursion
13535 (beginning-of-line 1)
13536 (if (looking-at
13538 (setq ov-start (match-beginning 1)
13539 ov-end (match-end 1)
13540 ov-prefix "")
13541 (setq ov-start (1- (point-at-eol))
13542 ov-end (1+ ov-start))
13544 (setq ov-prefix
13545 (concat
13546 (buffer-substring (1- (point)) (point))
13547 (if (> (current-column) org-tags-column)
13548 " "
13549 (make-string (- org-tags-column (current-column)) ?\ ))))))
13550 (move-overlay org-tags-overlay ov-start ov-end)
13551 (save-window-excursion
13552 (if expert
13553 (set-buffer (get-buffer-create " *Org tags*"))
13554 (delete-other-windows)
13555 (split-window-vertically)
13556 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13557 (erase-buffer)
13558 (org-set-local 'org-done-keywords done-keywords)
13561 (org-fast-tag-show-exit exit-after-next)
13562 (org-set-current-tags-overlay current ov-prefix)
13563 (setq tbl fulltable char ?a cnt 0)
13564 (while (setq e (pop tbl))
13565 (cond
13566 ((equal (car e) :startgroup)
13567 (push '() groups) (setq ingroup t)
13568 (when (not (= cnt 0))
13569 (setq cnt 0)
13571 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13572 ((equal (car e) :endgroup)
13573 (setq ingroup nil cnt 0)
13575 ((equal e '(:newline))
13576 (when (not (= cnt 0))
13577 (setq cnt 0)
13579 (setq e (car tbl))
13580 (while (equal (car tbl) '(:newline))
13582 (setq tbl (cdr tbl)))))
13583 (t
13584 (setq tg (copy-sequence (car e)) c2 nil)
13585 (if (cdr e)
13586 (setq c (cdr e))
13587 ;; automatically assign a character.
13588 (setq c1 (string-to-char
13589 (downcase (substring
13590 tg (if (= (string-to-char tg) ?@) 1 0)))))
13591 (if (or (rassoc c1 ntable) (rassoc c1 table))
13592 (while (or (rassoc char ntable) (rassoc char table))
13593 (setq char (1+ char)))
13594 (setq c2 c1))
13595 (setq c (or c2 char)))
13596 (if ingroup (push tg (car groups)))
13597 (setq tg (org-add-props tg nil 'face
13598 (cond
13599 ((not (assoc tg table))
13600 (org-get-todo-face tg))
13601 ((member tg current) c-face)
13602 ((member tg inherited) i-face)
13603 (t nil))))
13604 (if (and (= cnt 0) (not ingroup)) (insert " "))
13605 (insert "[" c "] " tg (make-string
13606 (- fwidth 4 (length tg)) ?\ ))
13607 (push (cons tg c) ntable)
13608 (when (= (setq cnt (1+ cnt)) ncol)
13610 (if ingroup (insert " "))
13611 (setq cnt 0)))))
13612 (setq ntable (nreverse ntable))
13614 (goto-char (point-min))
13615 (if (not expert) (org-fit-window-to-buffer))
13616 (setq rtn
13617 (catch 'exit
13618 (while t
13619 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13620 (if (not groups) "no " "")
13621 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13622 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13623 (setq org-last-tag-selection-key c)
13624 (cond
13626 ((= c ?!)
13627 (setq groups (not groups))
13628 (goto-char (point-min))
13629 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13630 ((= c ?\C-c)
13631 (if (not expert)
13632 (org-fast-tag-show-exit
13633 (setq exit-after-next (not exit-after-next)))
13634 (setq expert nil)
13635 (delete-other-windows)
13636 (set-window-buffer (split-window-vertically) " *Org tags*")
13637 (org-switch-to-buffer-other-window " *Org tags*")
13638 (org-fit-window-to-buffer)))
13639 ((or (= c ?\C-g)
13640 (and (= c ?q) (not (rassoc c ntable))))
13641 (org-detach-overlay org-tags-overlay)
13642 (setq quit-flag t))
13643 ((= c ?\ )
13644 (setq current nil)
13645 (if exit-after-next (setq exit-after-next 'now)))
13647 (condition-case nil
13648 (setq tg (org-icompleting-read
13649 "Tag: "
13650 (or buffer-tags
13651 (with-current-buffer buf
13652 (org-get-buffer-tags)))))
13653 (quit (setq tg "")))
13655 (add-to-list 'buffer-tags (list tg))
13656 (if (member tg current)
13657 (setq current (delete tg current))
13658 (push tg current)))
13659 (if exit-after-next (setq exit-after-next 'now)))
13660 ((setq e (rassoc c todo-table) tg (car e))
13661 (with-current-buffer buf
13662 (save-excursion (org-todo tg)))
13663 (if exit-after-next (setq exit-after-next 'now)))
13664 ((setq e (rassoc c ntable) tg (car e))
13665 (if (member tg current)
13666 (setq current (delete tg current))
13667 (loop for g in groups do
13668 (if (member tg g)
13669 (mapc (lambda (x)
13670 (setq current (delete x current)))
13671 g)))
13672 (push tg current))
13673 (if exit-after-next (setq exit-after-next 'now))))
13675 ;; Create a sorted list
13676 (setq current
13677 (sort current
13678 (lambda (a b)
13679 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13680 (if (eq exit-after-next 'now) (throw 'exit t))
13681 (goto-char (point-min))
13682 (beginning-of-line 2)
13683 (delete-region (point) (point-at-eol))
13684 (org-fast-tag-insert "Current" current c-face)
13685 (org-set-current-tags-overlay current ov-prefix)
13686 (while (re-search-forward
13688 (setq tg (match-string 1))
13689 (add-text-properties
13690 (match-beginning 1) (match-end 1)
13691 (list 'face
13692 (cond
13693 ((member tg current) c-face)
13694 ((member tg inherited) i-face)
13695 (t (get-text-property (match-beginning 1) 'face))))))
13696 (goto-char (point-min)))))
13697 (org-detach-overlay org-tags-overlay)
13698 (if rtn
13699 (mapconcat 'identity current ":")
13700 nil))))
13702 (defun org-get-tags-string ()
13703 "Get the TAGS string in the current headline."
13704 (unless (org-at-heading-p t)
13705 (error "Not on a heading"))
13706 (save-excursion
13707 (beginning-of-line 1)
13709 (org-match-string-no-properties 1)
13710 "")))
13712 (defun org-get-tags ()
13713 "Get the list of tags specified in the current headline."
13714 (org-split-string (org-get-tags-string) ":"))
13716 (defun org-get-buffer-tags ()
13717 "Get a table of all tags used in the buffer, for completion."
13718 (let (tags)
13719 (save-excursion
13720 (goto-char (point-min))
13721 (while (re-search-forward
13723 (when (equal (char-after (point-at-bol 0)) ?*)
13724 (mapc (lambda (x) (add-to-list 'tags x))
13725 (org-split-string (org-match-string-no-properties 1) ":")))))
13726 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13727 (mapcar 'list tags)))
13729 ;;;; The mapping API
13731 ;;;###autoload
13732 (defun org-map-entries (func &optional match scope &rest skip)
13733 "Call FUNC at each headline selected by MATCH in SCOPE.
13735 FUNC is a function or a lisp form. The function will be called without
13736 arguments, with the cursor positioned at the beginning of the headline.
13737 The return values of all calls to the function will be collected and
13738 returned as a list.
13740 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13741 does not need to preserve point. After evaluation, the cursor will be
13742 moved to the end of the line (presumably of the headline of the
13743 processed entry) and search continues from there. Under some
13744 circumstances, this may not produce the wanted results. For example,
13745 if you have removed (e.g. archived) the current (sub)tree it could
13746 mean that the next entry will be skipped entirely. In such cases, you
13747 can specify the position from where search should continue by making
13748 FUNC set the variable `org-map-continue-from' to the desired buffer
13749 position.
13751 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13752 Only headlines that are matched by this query will be considered during
13753 the iteration. When MATCH is nil or t, all headlines will be
13754 visited by the iteration.
13756 SCOPE determines the scope of this command. It can be any of:
13758 nil The current buffer, respecting the restriction if any
13759 tree The subtree started with the entry at point
13760 region The entries within the active region, if any
13761 region-start-level
13762 The entries within the active region, but only those at
13763 the same level than the first one.
13764 file The current buffer, without restriction
13765 file-with-archives
13766 The current buffer, and any archives associated with it
13767 agenda All agenda files
13768 agenda-with-archives
13769 All agenda files with any archive files associated with them
13770 \(file1 file2 ...)
13771 If this is a list, all files in the list will be scanned
13773 The remaining args are treated as settings for the skipping facilities of
13774 the scanner. The following items can be given here:
13776 archive skip trees with the archive tag.
13777 comment skip trees with the COMMENT keyword
13778 function or Emacs Lisp form:
13779 will be used as value for `org-agenda-skip-function', so whenever
13780 the function returns t, FUNC will not be called for that
13781 entry and search will continue from the point where the
13782 function leaves it.
13784 If your function needs to retrieve the tags including inherited tags
13785 at the *current* entry, you can use the value of the variable
13786 `org-scanner-tags' which will be much faster than getting the value
13787 with `org-get-tags-at'. If your function gets properties with
13788 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13789 to t around the call to `org-entry-properties' to get the same speedup.
13790 Note that if your function moves around to retrieve tags and properties at
13791 a *different* entry, you cannot use these techniques."
13792 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13793 (not (org-region-active-p)))
13794 (let* ((org-agenda-archives-mode nil) ; just to make sure
13795 (org-agenda-skip-archived-trees (memq 'archive skip))
13796 (org-agenda-skip-comment-trees (memq 'comment skip))
13797 (org-agenda-skip-function
13798 (car (org-delete-all '(comment archive) skip)))
13799 (org-tags-match-list-sublevels t)
13800 (start-level (eq scope 'region-start-level))
13801 matcher file res
13802 org-todo-keywords-for-agenda
13803 org-done-keywords-for-agenda
13804 org-todo-keyword-alist-for-agenda
13805 org-drawers-for-agenda
13806 org-tag-alist-for-agenda)
13808 (cond
13809 ((eq match t) (setq matcher t))
13810 ((eq match nil) (setq matcher t))
13811 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13813 (save-excursion
13814 (save-restriction
13815 (cond ((eq scope 'tree)
13816 (org-back-to-heading t)
13817 (org-narrow-to-subtree)
13818 (setq scope nil))
13819 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13820 (org-region-active-p))
13821 ;; If needed, set start-level to a string like "2"
13822 (when start-level
13823 (save-excursion
13824 (goto-char (region-beginning))
13825 (unless (org-at-heading-p) (outline-next-heading))
13826 (setq start-level (org-current-level))))
13827 (narrow-to-region (region-beginning)
13828 (save-excursion
13829 (goto-char (region-end))
13830 (unless (and (bolp) (org-at-heading-p))
13831 (outline-next-heading))
13832 (point)))
13833 (setq scope nil)))
13835 (if (not scope)
13836 (progn
13837 (org-prepare-agenda-buffers
13838 (list (buffer-file-name (current-buffer))))
13839 (setq res (org-scan-tags func matcher nil start-level)))
13840 ;; Get the right scope
13841 (cond
13842 ((and scope (listp scope) (symbolp (car scope)))
13843 (setq scope (eval scope)))
13844 ((eq scope 'agenda)
13845 (setq scope (org-agenda-files t)))
13846 ((eq scope 'agenda-with-archives)
13847 (setq scope (org-agenda-files t))
13848 (setq scope (org-add-archive-files scope)))
13849 ((eq scope 'file)
13850 (setq scope (list (buffer-file-name))))
13851 ((eq scope 'file-with-archives)
13852 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13853 (org-prepare-agenda-buffers scope)
13854 (while (setq file (pop scope))
13855 (with-current-buffer (org-find-base-buffer-visiting file)
13856 (save-excursion
13857 (save-restriction
13858 (widen)
13859 (goto-char (point-min))
13860 (setq res (append res (org-scan-tags func matcher))))))))))
13861 res)))
13863 ;;;; Properties
13865 ;;; Setting and retrieving properties
13867 (defconst org-special-properties
13868 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13869 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13870 "The special properties valid in Org-mode.
13872 These are properties that are not defined in the property drawer,
13873 but in some other way.")
13875 (defconst org-default-properties
13876 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13877 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13878 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13879 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13880 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13881 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13882 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13883 "Some properties that are used by Org-mode for various purposes.
13884 Being in this list makes sure that they are offered for completion.")
13887 "Regular expression matching the first line of a property drawer.")
13890 "Regular expression matching the last line of a property drawer.")
13893 "Regular expression matching the first line of a property drawer.")
13896 "Regular expression matching the first line of a property drawer.")
13898 (defconst org-property-drawer-re
13901 "Matches an entire property drawer.")
13903 (defconst org-clock-drawer-re
13906 "Matches an entire clock drawer.")
13908 (defsubst org-re-property (property)
13909 "Return a regexp matching PROPERTY.
13910 Match group 1 will be set to the value "
13913 (defun org-property-action ()
13914 "Do an action on properties."
13915 (interactive)
13916 (let (c)
13917 (org-at-property-p)
13918 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13919 (setq c (read-char-exclusive))
13920 (cond
13921 ((equal c ?s)
13922 (call-interactively 'org-set-property))
13923 ((equal c ?d)
13924 (call-interactively 'org-delete-property))
13925 ((equal c ?D)
13926 (call-interactively 'org-delete-property-globally))
13927 ((equal c ?c)
13928 (call-interactively 'org-compute-property-at-point))
13929 (t (error "No such property action %c" c)))))
13931 (defun org-set-effort (&optional value)
13932 "Set the effort property of the current entry.
13933 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13934 allowed value."
13935 (interactive "P")
13936 (if (equal value 0) (setq value 10))
13937 (let* ((completion-ignore-case t)
13938 (prop org-effort-property)
13939 (cur (org-entry-get nil prop))
13940 (allowed (org-property-get-allowed-values nil prop 'table))
13941 (existing (mapcar 'list (org-property-values prop)))
13942 rpl
13943 (val (cond
13944 ((stringp value) value)
13945 ((and allowed (integerp value))
13946 (or (car (nth (1- value) allowed))
13947 (car (org-last allowed))))
13948 (allowed
13949 (message "Select 1-9,0, [RET%s]: %s"
13950 (if cur (concat "=" cur) "")
13951 (mapconcat 'car allowed " "))
13952 (setq rpl (read-char-exclusive))
13954 cur
13955 (setq rpl (- rpl ?0))
13956 (if (equal rpl 0) (setq rpl 10))
13957 (if (and (> rpl 0) (<= rpl (length allowed)))
13958 (car (nth (1- rpl) allowed))
13959 (org-completing-read "Effort: " allowed nil))))
13960 (t
13961 (let (org-completion-use-ido org-completion-use-iswitchb)
13962 (org-completing-read
13964 (concat "[" cur "]") "")
13965 ": ")
13966 existing nil nil "" nil cur))))))
13967 (unless (equal (org-entry-get nil prop) val)
13968 (org-entry-put nil prop val))
13969 (message "%s is now %s" prop val)))
13971 (defun org-at-property-p ()
13972 "Is cursor inside a property drawer?"
13973 (save-excursion
13974 (beginning-of-line 1)
13976 (save-match-data ;; Used by calling procedures
13977 (let ((p (point))
13978 (range (unless (org-before-first-heading-p)
13979 (org-get-property-block))))
13980 (and range (<= (car range) p) (< p (cdr range))))))))
13982 (defun org-get-property-block (&optional beg end force)
13983 "Return the (beg . end) range of the body of the property drawer.
13984 BEG and END can be beginning and end of subtree, if not given
13985 they will be found.
13986 If the drawer does not exist and FORCE is non-nil, create the drawer."
13987 (catch 'exit
13988 (save-excursion
13989 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13990 (end (or end (progn (outline-next-heading) (point)))))
13991 (goto-char beg)
13992 (if (re-search-forward org-property-start-re end t)
13993 (setq beg (1+ (match-end 0)))
13994 (if force
13995 (save-excursion
13996 (org-insert-property-drawer)
13997 (setq end (progn (outline-next-heading) (point))))
13998 (throw 'exit nil))
13999 (goto-char beg)
14000 (if (re-search-forward org-property-start-re end t)
14001 (setq beg (1+ (match-end 0)))))
14002 (if (re-search-forward org-property-end-re end t)
14003 (setq end (match-beginning 0))
14004 (or force (throw 'exit nil))
14005 (goto-char beg)
14006 (setq end beg)
14007 (org-indent-line-function)
14009 (cons beg end)))))
14011 (defun org-entry-properties (&optional pom which specific)
14012 "Get all properties of the entry at point-or-marker POM.
14013 This includes the TODO keyword, the tags, time strings for deadline,
14014 scheduled, and clocking, and any additional properties defined in the
14015 entry. The return value is an alist, keys may occur multiple times
14016 if the property key was used several times.
14017 POM may also be nil, in which case the current entry is used.
14018 If WHICH is nil or `all', get all properties. If WHICH is
14019 `special' or `standard', only get that subclass. If WHICH
14020 is a string only get exactly this property. SPECIFIC can be a string, the
14021 specific property we are interested in. Specifying it can speed
14022 things up because then unnecessary parsing is avoided."
14023 (setq which (or which 'all))
14024 (org-with-point-at pom
14025 (let ((clockstr (substring org-clock-string 0 -1))
14026 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14027 (case-fold-search nil)
14028 beg end range props sum-props key key1 value string clocksum)
14029 (save-excursion
14030 (when (condition-case nil
14031 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14032 (error nil))
14033 (setq beg (point))
14034 (setq sum-props (get-text-property (point) 'org-summaries))
14035 (setq clocksum (get-text-property (point) :org-clock-minutes))
14036 (outline-next-heading)
14037 (setq end (point))
14038 (when (memq which '(all special))
14039 ;; Get the special properties, like TODO and tags
14040 (goto-char beg)
14041 (when (and (or (not specific) (string= specific "TODO"))
14042 (looking-at org-todo-line-regexp) (match-end 2))
14043 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14044 (when (and (or (not specific) (string= specific "PRIORITY"))
14045 (looking-at org-priority-regexp))
14046 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14047 (when (or (not specific) (string= specific "FILE"))
14048 (push (cons "FILE" buffer-file-name) props))
14049 (when (and (or (not specific) (string= specific "TAGS"))
14050 (setq value (org-get-tags-string))
14052 (push (cons "TAGS" value) props))
14053 (when (and (or (not specific) (string= specific "ALLTAGS"))
14054 (setq value (org-get-tags-at)))
14055 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14056 ":"))
14057 props))
14058 (when (or (not specific) (string= specific "BLOCKED"))
14059 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14060 (when (or (not specific)
14061 (member specific
14062 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14063 "TIMESTAMP" "TIMESTAMP_IA")))
14064 (catch 'match
14065 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14066 (setq key (if (match-end 1)
14067 (substring (org-match-string-no-properties 1)
14068 0 -1))
14069 string (if (equal key clockstr)
14070 (org-no-properties
14071 (org-trim
14072 (buffer-substring
14073 (match-beginning 3) (goto-char
14074 (point-at-eol)))))
14075 (substring (org-match-string-no-properties 3)
14076 1 -1)))
14077 ;; Get the correct property name from the key. This is
14078 ;; necessary if the user has configured time keywords.
14079 (setq key1 (concat key ":"))
14080 (cond
14081 ((not key)
14082 (setq key
14083 (if (= (char-after (match-beginning 3)) ?\[)
14084 "TIMESTAMP_IA" "TIMESTAMP")))
14085 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14086 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14087 ((equal key1 org-closed-string) (setq key "CLOSED"))
14088 ((equal key1 org-clock-string) (setq key "CLOCK")))
14089 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14090 (progn
14091 (push (cons key string) props)
14092 ;; no need to search further if match is found
14093 (throw 'match t))
14094 (when (or (equal key "CLOCK") (not (assoc key props)))
14095 (push (cons key string) props))))))
14096 )
14098 (when (memq which '(all standard))
14099 ;; Get the standard properties, like :PROP: ...
14100 (setq range (org-get-property-block beg end))
14101 (when range
14102 (goto-char (car range))
14103 (while (re-search-forward
14105 (cdr range) t)
14106 (setq key (org-match-string-no-properties 1)
14107 value (org-trim (or (org-match-string-no-properties 2) "")))
14108 (unless (member key excluded)
14109 (push (cons key (or value "")) props)))))
14110 (if clocksum
14111 (push (cons "CLOCKSUM"
14112 (org-columns-number-to-string (/ (float clocksum) 60.)
14113 'add_times))
14114 props))
14115 (unless (assoc "CATEGORY" props)
14116 (push (cons "CATEGORY" (org-get-category)) props))
14117 (append sum-props (nreverse props)))))))
14119 (defun org-entry-get (pom property &optional inherit literal-nil)
14120 "Get value of PROPERTY for entry at point-or-marker POM.
14121 If INHERIT is non-nil and the entry does not have the property,
14122 then also check higher levels of the hierarchy.
14123 If INHERIT is the symbol `selective', use inheritance only if the setting
14124 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14125 If the property is present but empty, the return value is the empty string.
14126 If the property is not present at all, nil is returned.
14129 do not interpret it as the list atom nil. This is used for inheritance
14131 (org-with-point-at pom
14132 (if (and inherit (if (eq inherit 'selective)
14133 (org-property-inherit-p property)
14134 t))
14135 (org-entry-get-with-inheritance property literal-nil)
14136 (if (member property org-special-properties)
14137 ;; We need a special property. Use `org-entry-properties' to
14138 ;; retrieve it, but specify the wanted property
14139 (cdr (assoc property (org-entry-properties nil 'special property)))
14140 (let ((range (unless (org-before-first-heading-p)
14141 (org-get-property-block))))
14142 (when (and range (goto-char (car range)))
14143 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14144 (cond
14145 ((re-search-forward
14146 (org-re-property property) (cdr range) t)
14147 (if (match-end 1) (org-match-string-no-properties 1) ""))
14148 ((re-search-forward
14149 (org-re-property (concat property "+")) (cdr range) t)
14150 (cdr (assoc
14151 property
14152 (org-update-property-plist
14153 (concat property "+")
14154 (if (match-end 1) (org-match-string-no-properties 1) "")
14155 (list (or (assoc property org-file-properties)
14156 (assoc property org-global-properties)
14157 (assoc property org-global-properties-fixed)
14158 ))))))))))))))
14160 (defun org-property-or-variable-value (var &optional inherit)
14161 "Check if there is a property fixing the value of VAR.
14162 If yes, return this value. If not, return the current value of the variable."
14163 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14165 (read prop)
14166 (symbol-value var))))
14168 (defun org-entry-delete (pom property)
14169 "Delete the property PROPERTY from entry at point-or-marker POM."
14170 (org-with-point-at pom
14171 (if (member property org-special-properties)
14172 nil ; cannot delete these properties.
14173 (let ((range (org-get-property-block)))
14174 (if (and range
14175 (goto-char (car range))
14176 (re-search-forward
14177 (org-re-property property)
14178 (cdr range) t))
14179 (progn
14180 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14181 t)
14182 nil)))))
14184 ;; Multi-values properties are properties that contain multiple values
14185 ;; These values are assumed to be single words, separated by whitespace.
14186 (defun org-entry-add-to-multivalued-property (pom property value)
14187 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14188 (let* ((old (org-entry-get pom property))
14190 (setq value (org-entry-protect-space value))
14191 (unless (member value values)
14192 (setq values (cons value values))
14193 (org-entry-put pom property
14194 (mapconcat 'identity values " ")))))
14196 (defun org-entry-remove-from-multivalued-property (pom property value)
14197 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14198 (let* ((old (org-entry-get pom property))
14200 (setq value (org-entry-protect-space value))
14201 (when (member value values)
14202 (setq values (delete value values))
14203 (org-entry-put pom property
14204 (mapconcat 'identity values " ")))))
14206 (defun org-entry-member-in-multivalued-property (pom property value)
14207 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14208 (let* ((old (org-entry-get pom property))
14210 (setq value (org-entry-protect-space value))
14211 (member value values)))
14213 (defun org-entry-get-multivalued-property (pom property)
14214 "Return a list of values in a multivalued property."
14215 (let* ((value (org-entry-get pom property))
14217 (mapcar 'org-entry-restore-space values)))
14219 (defun org-entry-put-multivalued-property (pom property &rest values)
14220 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14221 VALUES should be a list of strings. Spaces will be protected."
14222 (org-entry-put pom property
14223 (mapconcat 'org-entry-protect-space values " "))
14224 (let* ((value (org-entry-get pom property))
14226 (mapcar 'org-entry-restore-space values)))
14228 (defun org-entry-protect-space (s)
14229 "Protect spaces and newline in string S."
14230 (while (string-match " " s)
14231 (setq s (replace-match "%20" t t s)))
14233 (setq s (replace-match "%0A" t t s)))
14234 s)
14236 (defun org-entry-restore-space (s)
14237 "Restore spaces and newline in string S."
14238 (while (string-match "%20" s)
14239 (setq s (replace-match " " t t s)))
14240 (while (string-match "%0A" s)
14242 s)
14244 (defvar org-entry-property-inherited-from (make-marker)
14245 "Marker pointing to the entry from where a property was inherited.
14246 Each call to `org-entry-get-with-inheritance' will set this marker to the
14247 location of the entry where the inheritance search matched. If there was
14248 no match, the marker will point nowhere.
14249 Note that also `org-entry-get' calls this function, if the INHERIT flag
14250 is set.")
14252 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14253 "Get entry property, and search higher levels if not present.
14254 The search will stop at the first ancestor which has the property defined.
14256 should be considered as undefined (this is the meaning of nil here).
14258 (move-marker org-entry-property-inherited-from nil)
14259 (let (tmp)
14260 (unless (org-before-first-heading-p)
14261 (save-excursion
14262 (save-restriction
14263 (widen)
14264 (catch 'ex
14265 (while t
14266 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14267 (org-back-to-heading t)
14268 (move-marker org-entry-property-inherited-from (point))
14269 (throw 'ex tmp))
14270 (or (org-up-heading-safe) (throw 'ex nil)))))))
14271 (setq tmp (or tmp
14272 (cdr (assoc property org-file-properties))
14273 (cdr (assoc property org-global-properties))
14274 (cdr (assoc property org-global-properties-fixed))))
14275 (if literal-nil tmp (org-not-nil tmp))))
14277 (defvar org-property-changed-functions nil
14278 "Hook called when the value of a property has changed.
14279 Each hook function should accept two arguments, the name of the property
14280 and the new value.")
14282 (defun org-entry-put (pom property value)
14283 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14284 (org-with-point-at pom
14285 (org-back-to-heading t)
14286 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14287 range)
14288 (cond
14289 ((equal property "TODO")
14291 (not (member value org-todo-keywords-1)))
14293 (if (or (not value)
14295 (setq value 'none))
14296 (org-todo value)
14297 (org-set-tags nil 'align))
14298 ((equal property "PRIORITY")
14300 (string-to-char value) ?\ ))
14301 (org-set-tags nil 'align))
14302 ((equal property "SCHEDULED")
14303 (if (re-search-forward org-scheduled-time-regexp end t)
14304 (cond
14305 ((eq value 'earlier) (org-timestamp-change -1 'day))
14306 ((eq value 'later) (org-timestamp-change 1 'day))
14307 (t (call-interactively 'org-schedule)))
14308 (call-interactively 'org-schedule)))
14309 ((equal property "DEADLINE")
14310 (if (re-search-forward org-deadline-time-regexp end t)
14311 (cond
14312 ((eq value 'earlier) (org-timestamp-change -1 'day))
14313 ((eq value 'later) (org-timestamp-change 1 'day))
14314 (t (call-interactively 'org-deadline)))
14315 (call-interactively 'org-deadline)))
14316 ((member property org-special-properties)
14317 (error "The %s property can not yet be set with `org-entry-put'"
14318 property))
14319 (t ; a non-special property
14320 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14321 (setq range (org-get-property-block beg end 'force))
14322 (goto-char (car range))
14323 (if (re-search-forward
14324 (org-re-property property) (cdr range) t)
14325 (progn
14326 (delete-region (match-beginning 0) (match-end 0))
14327 (goto-char (match-beginning 0)))
14328 (goto-char (cdr range))
14330 (backward-char 1)
14331 (org-indent-line-function))
14332 (insert ":" property ":")
14333 (and value (insert " " value))
14334 (org-indent-line-function)))))
14335 (run-hook-with-args 'org-property-changed-functions property value)))
14337 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14338 "Get all property keys in the current buffer.
14339 With INCLUDE-SPECIALS, also list the special properties that reflect things
14340 like tags and TODO state.
14341 With INCLUDE-DEFAULTS, also include properties that has special meaning
14342 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14343 and others.
14344 With INCLUDE-COLUMNS, also include property names given in COLUMN
14345 formats in the current buffer."
14346 (let (rtn range cfmt s p)
14347 (save-excursion
14348 (save-restriction
14349 (widen)
14350 (goto-char (point-min))
14351 (while (re-search-forward org-property-start-re nil t)
14352 (setq range (org-get-property-block))
14353 (goto-char (car range))
14354 (while (re-search-forward
14356 (cdr range) t)
14357 (add-to-list 'rtn (org-match-string-no-properties 1)))
14358 (outline-next-heading))))
14360 (when include-specials
14361 (setq rtn (append org-special-properties rtn)))
14363 (when include-defaults
14364 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14365 (add-to-list 'rtn org-effort-property))
14367 (when include-columns
14368 (save-excursion
14369 (save-restriction
14370 (widen)
14371 (goto-char (point-min))
14372 (while (re-search-forward
14374 nil t)
14375 (setq cfmt (match-string 2) s 0)
14377 cfmt s)
14378 (setq s (match-end 0)
14379 p (match-string 1 cfmt))
14380 (unless (or (equal p "ITEM")
14381 (member p org-special-properties))
14382 (add-to-list 'rtn (match-string 1 cfmt))))))))
14384 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14386 (defun org-property-values (key)
14387 "Return a list of all values of property KEY in the current buffer."
14388 (save-excursion
14389 (save-restriction
14390 (widen)
14391 (goto-char (point-min))
14392 (let ((re (org-re-property key))
14393 values)
14394 (while (re-search-forward re nil t)
14395 (add-to-list 'values (org-trim (match-string 1))))
14396 (delete "" values)))))
14398 (defun org-insert-property-drawer ()
14399 "Insert a property drawer into the current entry."
14400 (interactive)
14401 (org-back-to-heading t)
14402 (looking-at org-outline-regexp)
14403 (let ((indent (if org-adapt-indentation
14404 (- (match-end 0)(match-beginning 0))
14405 0))
14406 (beg (point))
14408 end hiddenp)
14409 (outline-next-heading)
14410 (setq end (point))
14411 (goto-char beg)
14412 (while (re-search-forward re end t))
14413 (setq hiddenp (outline-invisible-p))
14414 (end-of-line 1)
14417 (if (member (match-string 1) '("CLOCK:" ":END:"))
14418 ;; just skip this line
14419 (beginning-of-line 2)
14420 ;; Drawer start, find the end
14422 (beginning-of-line 1)))
14423 (org-skip-over-state-notes)
14425 (if (eq (char-before) ?*) (forward-char 1))
14427 (beginning-of-line 0)
14428 (org-indent-to-column indent)
14429 (beginning-of-line 2)
14430 (org-indent-to-column indent)
14431 (beginning-of-line 0)
14432 (if hiddenp
14433 (save-excursion
14434 (org-back-to-heading t)
14435 (hide-entry))
14436 (org-flag-drawer t))))
14438 (defvar org-property-set-functions-alist nil
14439 "Property set function alist.
14440 Each entry should have the following format:
14442 (PROPERTY . READ-FUNCTION)
14444 The read function will be called with the same argument as
14445 `org-completing-read'.")
14447 (defun org-set-property-function (property)
14448 "Get the function that should be used to set PROPERTY.
14449 This is computed according to `org-property-set-functions-alist'."
14450 (or (cdr (assoc property org-property-set-functions-alist))
14451 'org-completing-read))
14453 (defun org-read-property-value (property)
14454 "Read PROPERTY value from user."
14455 (let* ((completion-ignore-case t)
14456 (allowed (org-property-get-allowed-values nil property 'table))
14457 (cur (org-entry-get nil property))
14458 (prompt (concat property " value"
14460 (concat " [" cur "]") "") ": "))
14461 (set-function (org-set-property-function property))
14462 (val (if allowed
14463 (funcall set-function prompt allowed nil
14464 (not (get-text-property 0 'org-unrestricted
14465 (caar allowed))))
14466 (let (org-completion-use-ido org-completion-use-iswitchb)
14467 (funcall set-function prompt
14468 (mapcar 'list (org-property-values property))
14469 nil nil "" nil cur)))))
14470 (if (equal val "")
14471 cur
14472 val)))
14474 (defvar org-last-set-property nil)
14475 (defun org-read-property-name ()
14476 "Read a property name."
14477 (let* ((completion-ignore-case t)
14478 (keys (org-buffer-property-keys nil t t))
14479 (default-prop (or (save-excursion
14480 (save-match-data
14481 (beginning-of-line)
14483 (null (string= (match-string 1) "END"))
14484 (match-string 1))))
14485 org-last-set-property))
14486 (property (org-icompleting-read
14487 (concat "Property"
14488 (if default-prop (concat " [" default-prop "]") "")
14489 ": ")
14490 (mapcar 'list keys)
14491 nil nil nil nil
14492 default-prop
14493 )))
14494 (if (member property keys)
14495 property
14496 (or (cdr (assoc (downcase property)
14497 (mapcar (lambda (x) (cons (downcase x) x))
14498 keys)))
14499 property))))
14501 (defun org-set-property (property value)
14502 "In the current entry, set PROPERTY to VALUE.
14503 When called interactively, this will prompt for a property name, offering
14504 completion on existing and default properties. And then it will prompt
14505 for a value, offering completion either on allowed values (via an inherited
14506 xxx_ALL property) or on existing values in other instances of this property
14507 in the current file."
14508 (interactive (list nil nil))
14509 (let* ((property (or property (org-read-property-name)))
14510 (value (or value (org-read-property-value property)))
14511 (fn (assoc property org-properties-postprocess-alist)))
14512 (setq org-last-set-property property)
14513 ;; Possibly postprocess the inserted value:
14514 (when fn (setq value (funcall (cadr fn) value)))
14515 (unless (equal (org-entry-get nil property) value)
14516 (org-entry-put nil property value))))
14518 (defun org-delete-property (property)
14519 "In the current entry, delete PROPERTY."
14520 (interactive
14521 (let* ((completion-ignore-case t)
14522 (prop (org-icompleting-read "Property: "
14523 (org-entry-properties nil 'standard))))
14524 (list prop)))
14525 (message "Property %s %s" property
14526 (if (org-entry-delete nil property)
14527 "deleted"
14528 "was not present in the entry")))
14530 (defun org-delete-property-globally (property)
14531 "Remove PROPERTY globally, from all entries."
14532 (interactive
14533 (let* ((completion-ignore-case t)
14534 (prop (org-icompleting-read
14535 "Globally remove property: "
14536 (mapcar 'list (org-buffer-property-keys)))))
14537 (list prop)))
14538 (save-excursion
14539 (save-restriction
14540 (widen)
14541 (goto-char (point-min))
14542 (let ((cnt 0))
14543 (while (re-search-forward
14544 (org-re-property property)
14545 nil t)
14546 (setq cnt (1+ cnt))
14547 (replace-match ""))
14550 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14552 (defun org-compute-property-at-point ()
14553 "Compute the property at point.
14554 This looks for an enclosing column format, extracts the operator and
14555 then applies it to the property in the column format's scope."
14556 (interactive)
14557 (unless (org-at-property-p)
14558 (error "Not at a property"))
14559 (let ((prop (org-match-string-no-properties 2)))
14560 (org-columns-get-format-and-top-level)
14561 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14562 (error "No operator defined for property %s" prop))
14563 (org-columns-compute prop)))
14565 (defvar org-property-allowed-value-functions nil
14566 "Hook for functions supplying allowed values for a specific property.
14567 The functions must take a single argument, the name of the property, and
14569 the values, this means that these values are intended as defaults for
14570 completion, but that other values should be allowed too.
14571 The functions must return nil if they are not responsible for this
14572 property.")
14574 (defun org-property-get-allowed-values (pom property &optional table)
14575 "Get allowed values for the property PROPERTY.
14576 When TABLE is non-nil, return an alist that can directly be used for
14577 completion."
14578 (let (vals)
14579 (cond
14580 ((equal property "TODO")
14581 (setq vals (org-with-point-at pom
14582 (append org-todo-keywords-1 '("")))))
14583 ((equal property "PRIORITY")
14584 (let ((n org-lowest-priority))
14585 (while (>= n org-highest-priority)
14586 (push (char-to-string n) vals)
14587 (setq n (1- n)))))
14588 ((member property org-special-properties))
14589 ((setq vals (run-hook-with-args-until-success
14590 'org-property-allowed-value-functions property)))
14591 (t
14592 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14594 (setq vals (car (read-from-string (concat "(" vals ")"))))
14595 (setq vals (mapcar (lambda (x)
14596 (cond ((stringp x) x)
14597 ((numberp x) (number-to-string x))
14598 ((symbolp x) (symbol-name x))
14599 (t "???")))
14600 vals)))))
14601 (when (member ":ETC" vals)
14602 (setq vals (remove ":ETC" vals))
14603 (org-add-props (car vals) '(org-unrestricted t)))
14604 (if table (mapcar 'list vals) vals)))
14606 (defun org-property-previous-allowed-value (&optional previous)
14607 "Switch to the next allowed value for this property."
14608 (interactive)
14609 (org-property-next-allowed-value t))
14611 (defun org-property-next-allowed-value (&optional previous)
14612 "Switch to the next allowed value for this property."
14613 (interactive)
14614 (unless (org-at-property-p)
14615 (error "Not at a property"))
14616 (let* ((key (match-string 2))
14617 (value (match-string 3))
14618 (allowed (or (org-property-get-allowed-values (point) key)
14619 (and (member value '("[ ]" "[-]" "[X]"))
14620 '("[ ]" "[X]"))))
14621 nval)
14622 (unless allowed
14623 (error "Allowed values for this property have not been defined"))
14624 (if previous (setq allowed (reverse allowed)))
14625 (if (member value allowed)
14626 (setq nval (car (cdr (member value allowed)))))
14627 (setq nval (or nval (car allowed)))
14628 (if (equal nval value)
14629 (error "Only one allowed value for this property"))
14630 (org-at-property-p)
14631 (replace-match (concat " :" key ": " nval) t t)
14632 (org-indent-line-function)
14633 (beginning-of-line 1)
14635 (run-hook-with-args 'org-property-changed-functions key nval)))
14637 (defun org-find-olp (path &optional this-buffer)
14638 "Return a marker pointing to the entry at outline path OLP.
14639 If anything goes wrong, throw an error.
14640 You can wrap this call to catch the error like this:
14642 (condition-case msg
14643 (org-mobile-locate-entry (match-string 4))
14644 (error (nth 1 msg)))
14646 The return value will then be either a string with the error message,
14647 or a marker if everything is OK.
14649 If THIS-BUFFER is set, the outline path does not contain a file,
14650 only headings."
14651 (let* ((file (if this-buffer buffer-file-name (pop path)))
14652 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14653 (level 1)
14654 (lmin 1)
14655 (lmax 1)
14656 limit re end found pos heading cnt flevel)
14657 (unless buffer (error "File not found :%s" file))
14658 (with-current-buffer buffer
14659 (save-excursion
14660 (save-restriction
14661 (widen)
14662 (setq limit (point-max))
14663 (goto-char (point-min))
14664 (while (setq heading (pop path))
14665 (setq re (format org-complex-heading-regexp-format
14666 (regexp-quote heading)))
14667 (setq cnt 0 pos (point))
14668 (while (re-search-forward re end t)
14669 (setq level (- (match-end 1) (match-beginning 1)))
14670 (if (and (>= level lmin) (<= level lmax))
14671 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14672 (when (= cnt 0) (error "Heading not found on level %d: %s"
14673 lmax heading))
14674 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14675 lmax heading))
14676 (goto-char found)
14677 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14678 (setq end (save-excursion (org-end-of-subtree t t))))
14679 (when (org-at-heading-p)
14680 (move-marker (make-marker) (point))))))))
14682 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14683 "Find node HEADING in BUFFER.
14684 Return a marker to the heading if it was found, or nil if not.
14685 If POS-ONLY is set, return just the position instead of a marker.
14687 The heading text must match exact, but it may have a TODO keyword,
14688 a priority cookie and tags in the standard locations."
14689 (with-current-buffer (or buffer (current-buffer))
14690 (save-excursion
14691 (save-restriction
14692 (widen)
14693 (goto-char (point-min))
14694 (let (case-fold-search)
14695 (if (re-search-forward
14696 (format org-complex-heading-regexp-format
14697 (regexp-quote heading)) nil t)
14698 (if pos-only
14699 (match-beginning 0)
14700 (move-marker (make-marker) (match-beginning 0)))))))))
14702 (defun org-find-exact-heading-in-directory (heading &optional dir)
14703 "Find Org node headline HEADING in all .org files in directory DIR.
14704 When the target headline is found, return a marker to this location."
14705 (let ((files (directory-files (or dir default-directory)
14707 file visiting m buffer)
14708 (catch 'found
14709 (while (setq file (pop files))
14710 (message "trying %s" file)
14711 (setq visiting (org-find-base-buffer-visiting file))
14712 (setq buffer (or visiting (find-file-noselect file)))
14713 (setq m (org-find-exact-headline-in-buffer
14714 heading buffer))
14715 (when (and (not m) (not visiting)) (kill-buffer buffer))
14716 (and m (throw 'found m))))))
14718 (defun org-find-entry-with-id (ident)
14719 "Locate the entry that contains the ID property with exact value IDENT.
14720 IDENT can be a string, a symbol or a number, this function will search for
14721 the string representation of it.
14722 Return the position where this entry starts, or nil if there is no such entry."
14723 (interactive "sID: ")
14724 (let ((id (cond
14725 ((stringp ident) ident)
14726 ((symbol-name ident) (symbol-name ident))
14727 ((numberp ident) (number-to-string ident))
14728 (t (error "IDENT %s must be a string, symbol or number" ident))))
14729 (case-fold-search nil))
14730 (save-excursion
14731 (save-restriction
14732 (widen)
14733 (goto-char (point-min))
14734 (when (re-search-forward
14736 nil t)
14737 (org-back-to-heading t)
14738 (point))))))
14740 ;;;; Timestamps
14742 (defvar org-last-changed-timestamp nil)
14743 (defvar org-last-inserted-timestamp nil
14744 "The last time stamp inserted with `org-insert-time-stamp'.")
14745 (defvar org-time-was-given) ; dynamically scoped parameter
14746 (defvar org-end-time-was-given) ; dynamically scoped parameter
14747 (defvar org-ts-what) ; dynamically scoped parameter
14749 (defun org-time-stamp (arg &optional inactive)
14750 "Prompt for a date/time and insert a time stamp.
14751 If the user specifies a time like HH:MM, or if this command is called
14752 with a prefix argument, the time stamp will contain date and time.
14753 Otherwise, only the date will be included. All parts of a date not
14754 specified by the user will be filled in from the current date/time.
14755 So if you press just return without typing anything, the time stamp
14756 will represent the current date/time. If there is already a timestamp
14757 at the cursor, it will be modified."
14758 (interactive "P")
14759 (let* ((ts nil)
14760 (default-time
14761 ;; Default time is either today, or, when entering a range,
14762 ;; the range start.
14763 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14764 (save-excursion
14765 (re-search-backward
14767 (- (point) 20) t)))
14768 (apply 'encode-time (org-parse-time-string (match-string 1)))
14769 (current-time)))
14770 (default-input (and ts (org-get-compact-tod ts)))
14771 (repeater (save-excursion
14772 (save-match-data
14773 (beginning-of-line)
14774 (when (re-search-forward
14776 (save-excursion (progn (end-of-line) (point))) t)
14777 (match-string 0)))))
14778 org-time-was-given org-end-time-was-given time)
14779 (cond
14780 ((and (org-at-timestamp-p t)
14781 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14782 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14783 (insert "--")
14784 (setq time (let ((this-command this-command))
14785 (org-read-date arg 'totime nil nil
14786 default-time default-input)))
14787 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14788 ((org-at-timestamp-p t)
14789 (setq time (let ((this-command this-command))
14790 (org-read-date arg 'totime nil nil default-time default-input)))
14791 (when (org-at-timestamp-p t) ; just to get the match data
14792 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14793 (replace-match "")
14794 (setq org-last-changed-timestamp
14795 (org-insert-time-stamp
14796 time (or org-time-was-given arg)
14797 inactive nil nil (list org-end-time-was-given)))
14798 (when repeater (goto-char (1- (point))) (insert " " repeater)
14799 (setq org-last-changed-timestamp
14800 (concat (substring org-last-inserted-timestamp 0 -1)
14801 " " repeater ">"))))
14802 (message "Timestamp updated"))
14803 (t
14804 (setq time (let ((this-command this-command))
14805 (org-read-date arg 'totime nil nil default-time default-input)))
14806 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14807 nil nil (list org-end-time-was-given))))))
14809 ;; FIXME: can we use this for something else, like computing time differences?
14810 (defun org-get-compact-tod (s)
14811 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14812 (let* ((t1 (match-string 1 s))
14813 (h1 (string-to-number (match-string 2 s)))
14814 (m1 (string-to-number (match-string 3 s)))
14815 (t2 (and (match-end 4) (match-string 5 s)))
14816 (h2 (and t2 (string-to-number (match-string 6 s))))
14817 (m2 (and t2 (string-to-number (match-string 7 s))))
14818 dh dm)
14819 (if (not t2)
14820 t1
14821 (setq dh (- h2 h1) dm (- m2 m1))
14822 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14823 (concat t1 "+" (number-to-string dh)
14824 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14826 (defun org-time-stamp-inactive (&optional arg)
14827 "Insert an inactive time stamp.
14828 An inactive time stamp is enclosed in square brackets instead of angle
14829 brackets. It is inactive in the sense that it does not trigger agenda entries,
14830 does not link to the calendar and cannot be changed with the S-cursor keys.
14831 So these are more for recording a certain time/date."
14832 (interactive "P")
14833 (org-time-stamp arg 'inactive))
14835 (defvar org-date-ovl (make-overlay 1 1))
14836 (overlay-put org-date-ovl 'face 'org-warning)
14837 (org-detach-overlay org-date-ovl)
14839 (defvar org-ans1) ; dynamically scoped parameter
14840 (defvar org-ans2) ; dynamically scoped parameter
14842 (defvar org-plain-time-of-day-regexp) ; defined below
14844 (defvar org-overriding-default-time nil) ; dynamically scoped
14845 (defvar org-read-date-overlay nil)
14846 (defvar org-dcst nil) ; dynamically scoped
14847 (defvar org-read-date-history nil)
14848 (defvar org-read-date-final-answer nil)
14849 (defvar org-read-date-analyze-futurep nil)
14850 (defvar org-read-date-analyze-forced-year nil)
14852 (defun org-read-date (&optional with-time to-time from-string prompt
14853 default-time default-input)
14854 "Read a date, possibly a time, and make things smooth for the user.
14855 The prompt will suggest to enter an ISO date, but you can also enter anything
14856 which will at least partially be understood by `parse-time-string'.
14857 Unrecognized parts of the date will default to the current day, month, year,
14858 hour and minute. If this command is called to replace a timestamp at point,
14859 or to enter the second timestamp of a range, the default time is taken
14860 from the existing stamp. Furthermore, the command prefers the future,
14861 so if you are giving a date where the year is not given, and the day-month
14862 combination is already past in the current year, it will assume you
14863 mean next year. For details, see the manual. A few examples:
14865 3-2-5 --> 2003-02-05
14866 feb 15 --> currentyear-02-15
14867 2/15 --> currentyear-02-15
14868 sep 12 9 --> 2009-09-12
14869 12:45 --> today 12:45
14870 22 sept 0:34 --> currentyear-09-22 0:34
14871 12 --> currentyear-currentmonth-12
14872 Fri --> nearest Friday (today or later)
14873 etc.
14875 Furthermore you can specify a relative date by giving, as the *first* thing
14876 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14877 change in days weeks, months, years.
14878 With a single plus or minus, the date is relative to today. With a double
14879 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14880 +4d --> four days from today
14881 +4 --> same as above
14882 +2w --> two weeks from today
14883 ++5 --> five days from default date
14885 The function understands only English month and weekday abbreviations,
14886 but this can be configured with the variables `parse-time-months' and
14887 `parse-time-weekdays'.
14889 While prompting, a calendar is popped up - you can also select the
14890 date with the mouse (button 1). The calendar shows a period of three
14891 months. To scroll it to other months, use the keys `>' and `<'.
14892 If you don't like the calendar, turn it off with
14893 \(setq org-read-date-popup-calendar nil)
14895 With optional argument TO-TIME, the date will immediately be converted
14896 to an internal time.
14897 With an optional argument WITH-TIME, the prompt will suggest to also
14898 insert a time. Note that when WITH-TIME is not set, you can still
14899 enter a time, and this function will inform the calling routine about
14900 this change. The calling routine may then choose to change the format
14901 used to insert the time stamp into the buffer to include the time.
14902 With optional argument FROM-STRING, read from this string instead from
14903 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14904 the time/date that is used for everything that is not specified by the
14905 user."
14906 (require 'parse-time)
14907 (let* ((org-time-stamp-rounding-minutes
14908 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14909 (org-dcst org-display-custom-times)
14910 (ct (org-current-time))
14911 (def (or org-overriding-default-time default-time ct))
14912 (defdecode (decode-time def))
14913 (dummy (progn
14914 (when (< (nth 2 defdecode) org-extend-today-until)
14915 (setcar (nthcdr 2 defdecode) -1)
14916 (setcar (nthcdr 1 defdecode) 59)
14917 (setq def (apply 'encode-time defdecode)
14918 defdecode (decode-time def)))))
14919 (calendar-frame-setup nil)
14920 (calendar-setup nil)
14921 (calendar-move-hook nil)
14922 (calendar-view-diary-initially-flag nil)
14923 (calendar-view-holidays-initially-flag nil)
14924 (timestr (format-time-string
14925 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14926 (prompt (concat (if prompt (concat prompt " ") "")
14927 (format "Date+time [%s]: " timestr)))
14928 ans (org-ans0 "") org-ans1 org-ans2 final)
14930 (cond
14931 (from-string (setq ans from-string))
14932 (org-read-date-popup-calendar
14933 (save-excursion
14934 (save-window-excursion
14935 (calendar)
14936 (unwind-protect
14937 (progn
14938 (calendar-forward-day (- (time-to-days def)
14939 (calendar-absolute-from-gregorian
14940 (calendar-current-date))))
14941 (org-eval-in-calendar nil t)
14942 (let* ((old-map (current-local-map))
14943 (map (copy-keymap calendar-mode-map))
14944 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14945 (org-defkey map (kbd "RET") 'org-calendar-select)
14946 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14947 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14948 (org-defkey minibuffer-local-map [(meta shift left)]
14949 (lambda () (interactive)
14950 (org-eval-in-calendar '(calendar-backward-month 1))))
14951 (org-defkey minibuffer-local-map [(meta shift right)]
14952 (lambda () (interactive)
14953 (org-eval-in-calendar '(calendar-forward-month 1))))
14954 (org-defkey minibuffer-local-map [(meta shift up)]
14955 (lambda () (interactive)
14956 (org-eval-in-calendar '(calendar-backward-year 1))))
14957 (org-defkey minibuffer-local-map [(meta shift down)]
14958 (lambda () (interactive)
14959 (org-eval-in-calendar '(calendar-forward-year 1))))
14960 (org-defkey minibuffer-local-map [?\e (shift left)]
14961 (lambda () (interactive)
14962 (org-eval-in-calendar '(calendar-backward-month 1))))
14963 (org-defkey minibuffer-local-map [?\e (shift right)]
14964 (lambda () (interactive)
14965 (org-eval-in-calendar '(calendar-forward-month 1))))
14966 (org-defkey minibuffer-local-map [?\e (shift up)]
14967 (lambda () (interactive)
14968 (org-eval-in-calendar '(calendar-backward-year 1))))
14969 (org-defkey minibuffer-local-map [?\e (shift down)]
14970 (lambda () (interactive)
14971 (org-eval-in-calendar '(calendar-forward-year 1))))
14972 (org-defkey minibuffer-local-map [(shift up)]
14973 (lambda () (interactive)
14974 (org-eval-in-calendar '(calendar-backward-week 1))))
14975 (org-defkey minibuffer-local-map [(shift down)]
14976 (lambda () (interactive)
14977 (org-eval-in-calendar '(calendar-forward-week 1))))
14978 (org-defkey minibuffer-local-map [(shift left)]
14979 (lambda () (interactive)
14980 (org-eval-in-calendar '(calendar-backward-day 1))))
14981 (org-defkey minibuffer-local-map [(shift right)]
14982 (lambda () (interactive)
14983 (org-eval-in-calendar '(calendar-forward-day 1))))
14984 (org-defkey minibuffer-local-map ">"
14985 (lambda () (interactive)
14986 (org-eval-in-calendar '(scroll-calendar-left 1))))
14987 (org-defkey minibuffer-local-map "<"
14988 (lambda () (interactive)
14989 (org-eval-in-calendar '(scroll-calendar-right 1))))
14990 (org-defkey minibuffer-local-map "\C-v"
14991 (lambda () (interactive)
14992 (org-eval-in-calendar
14993 '(calendar-scroll-left-three-months 1))))
14994 (org-defkey minibuffer-local-map "\M-v"
14995 (lambda () (interactive)
14996 (org-eval-in-calendar
14997 '(calendar-scroll-right-three-months 1))))
14998 (run-hooks 'org-read-date-minibuffer-setup-hook)
14999 (unwind-protect
15000 (progn
15001 (use-local-map map)
15002 (add-hook 'post-command-hook 'org-read-date-display)
15003 (setq org-ans0 (read-string prompt default-input
15004 'org-read-date-history nil))
15005 ;; org-ans0: from prompt
15006 ;; org-ans1: from mouse click
15007 ;; org-ans2: from calendar motion
15008 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15009 (remove-hook 'post-command-hook 'org-read-date-display)
15010 (use-local-map old-map)
15011 (when org-read-date-overlay
15012 (delete-overlay org-read-date-overlay)
15013 (setq org-read-date-overlay nil)))))
15014 (bury-buffer "*Calendar*")))))
15016 (t ; Naked prompt only
15017 (unwind-protect
15018 (setq ans (read-string prompt default-input
15019 'org-read-date-history timestr))
15020 (when org-read-date-overlay
15021 (delete-overlay org-read-date-overlay)
15022 (setq org-read-date-overlay nil)))))
15024 (setq final (org-read-date-analyze ans def defdecode))
15026 (when org-read-date-analyze-forced-year
15027 (message "Year was forced into %s"
15028 (if org-read-date-force-compatible-dates
15029 "compatible range (1970-2037)"
15030 "range representable on this machine"))
15031 (ding))
15033 ;; One round trip to get rid of 34th of August and stuff like that....
15034 (setq final (decode-time (apply 'encode-time final)))
15036 (setq org-read-date-final-answer ans)
15038 (if to-time
15039 (apply 'encode-time final)
15040 (if (and (boundp 'org-time-was-given) org-time-was-given)
15041 (format "%04d-%02d-%02d %02d:%02d"
15042 (nth 5 final) (nth 4 final) (nth 3 final)
15043 (nth 2 final) (nth 1 final))
15044 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15046 (defvar def)
15047 (defvar defdecode)
15048 (defvar with-time)
15049 (defun org-read-date-display ()
15050 "Display the current date prompt interpretation in the minibuffer."
15051 (when org-read-date-display-live
15052 (when org-read-date-overlay
15053 (delete-overlay org-read-date-overlay))
15054 (let ((p (point)))
15055 (end-of-line 1)
15056 (while (not (equal (buffer-substring
15057 (max (point-min) (- (point) 4)) (point))
15058 " "))
15059 (insert " "))
15060 (goto-char p))
15061 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15062 " " (or org-ans1 org-ans2)))
15063 (org-end-time-was-given nil)
15064 (f (org-read-date-analyze ans def defdecode))
15065 (fmts (if org-dcst
15066 org-time-stamp-custom-formats
15067 org-time-stamp-formats))
15068 (fmt (if (or with-time
15069 (and (boundp 'org-time-was-given) org-time-was-given))
15070 (cdr fmts)
15071 (car fmts)))
15072 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15073 (when (and org-end-time-was-given
15074 (string-match org-plain-time-of-day-regexp txt))
15075 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15076 org-end-time-was-given
15077 (substring txt (match-end 0)))))
15078 (when org-read-date-analyze-futurep
15079 (setq txt (concat txt " (=>F)")))
15080 (setq org-read-date-overlay
15081 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15082 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15084 (defun org-read-date-analyze (ans def defdecode)
15085 "Analyze the combined answer of the date prompt."
15086 ;; FIXME: cleanup and comment
15087 (let ((nowdecode (decode-time (current-time)))
15088 delta deltan deltaw deltadef year month day
15089 hour minute second wday pm h2 m2 tl wday1
15090 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15091 (setq org-read-date-analyze-futurep nil
15092 org-read-date-analyze-forced-year nil)
15094 (setq ans "+0"))
15096 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15097 (setq ans (replace-match "" t t ans)
15098 deltan (car delta)
15099 deltaw (nth 1 delta)
15100 deltadef (nth 2 delta)))
15102 ;; Check if there is an iso week date in there
15103 ;; If yes, store the info and postpone interpreting it until the rest
15104 ;; of the parsing is done
15105 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15106 (setq iso-year (if (match-end 1)
15107 (org-small-year-to-year
15108 (string-to-number (match-string 1 ans))))
15109 iso-weekday (if (match-end 3)
15110 (string-to-number (match-string 3 ans)))
15111 iso-week (string-to-number (match-string 2 ans)))
15112 (setq ans (replace-match "" t t ans)))
15114 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15115 (when (string-match
15117 (setq year (if (match-end 2)
15118 (string-to-number (match-string 2 ans))
15119 (progn (setq kill-year t)
15120 (string-to-number (format-time-string "%Y"))))
15121 month (string-to-number (match-string 3 ans))
15122 day (string-to-number (match-string 4 ans)))
15123 (if (< year 100) (setq year (+ 2000 year)))
15125 t nil ans)))
15127 ;; Help matching dotted european dates
15128 (when (string-match
15129 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15130 (setq year (if (match-end 3)
15131 (string-to-number (match-string 3 ans))
15132 (progn (setq kill-year t)
15133 (string-to-number (format-time-string "%Y"))))
15134 day (string-to-number (match-string 1 ans))
15135 month (string-to-number (match-string 2 ans))
15137 t nil ans)))
15139 ;; Help matching american dates, like 5/30 or 5/30/7
15140 (when (string-match
15141 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15142 (setq year (if (match-end 4)
15143 (string-to-number (match-string 4 ans))
15144 (progn (setq kill-year t)
15145 (string-to-number (format-time-string "%Y"))))
15146 month (string-to-number (match-string 1 ans))
15147 day (string-to-number (match-string 2 ans)))
15148 (if (< year 100) (setq year (+ 2000 year)))
15150 t nil ans)))
15151 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15152 ;; If there is a time with am/pm, and *no* time without it, we convert
15153 ;; so that matching will be successful.
15154 (loop for i from 1 to 2 do ; twice, for end time as well
15157 (setq hour (string-to-number (match-string 1 ans))
15158 minute (if (match-end 3)
15159 (string-to-number (match-string 3 ans))
15160 0)
15161 pm (equal ?p
15162 (string-to-char (downcase (match-string 4 ans)))))
15163 (if (and (= hour 12) (not pm))
15164 (setq hour 0)
15165 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15166 (setq ans (replace-match (format "%02d:%02d" hour minute)
15167 t t ans))))
15169 ;; Check if a time range is given as a duration
15170 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15171 (setq hour (string-to-number (match-string 1 ans))
15172 h2 (+ hour (string-to-number (match-string 3 ans)))
15173 minute (string-to-number (match-string 2 ans))
15174 m2 (+ minute (if (match-end 5) (string-to-number
15175 (match-string 5 ans))0)))
15176 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15177 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15178 t t ans)))
15180 ;; Check if there is a time range
15181 (when (boundp 'org-end-time-was-given)
15182 (setq org-time-was-given nil)
15183 (when (and (string-match org-plain-time-of-day-regexp ans)
15184 (match-end 8))
15185 (setq org-end-time-was-given (match-string 8 ans))
15186 (setq ans (concat (substring ans 0 (match-beginning 7))
15187 (substring ans (match-end 7))))))
15189 (setq tl (parse-time-string ans)
15190 day (or (nth 3 tl) (nth 3 defdecode))
15191 month (or (nth 4 tl)
15192 (if (and org-read-date-prefer-future
15193 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15194 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15195 (nth 4 defdecode)))
15196 year (or (and (not kill-year) (nth 5 tl))
15197 (if (and org-read-date-prefer-future
15198 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15199 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15200 (nth 5 defdecode)))
15201 hour (or (nth 2 tl) (nth 2 defdecode))
15202 minute (or (nth 1 tl) (nth 1 defdecode))
15203 second (or (nth 0 tl) 0)
15204 wday (nth 6 tl))
15206 (when (and (eq org-read-date-prefer-future 'time)
15207 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15208 (equal day (nth 3 nowdecode))
15209 (equal month (nth 4 nowdecode))
15210 (equal year (nth 5 nowdecode))
15211 (nth 2 tl)
15212 (or (< (nth 2 tl) (nth 2 nowdecode))
15213 (and (= (nth 2 tl) (nth 2 nowdecode))
15214 (nth 1 tl)
15215 (< (nth 1 tl) (nth 1 nowdecode)))))
15216 (setq day (1+ day)
15217 futurep t))
15219 ;; Special date definitions below
15220 (cond
15221 (iso-week
15222 ;; There was an iso week
15223 (require 'cal-iso)
15224 (setq futurep nil)
15225 (setq year (or iso-year year)
15226 day (or iso-weekday wday 1)
15227 wday nil ; to make sure that the trigger below does not match
15228 iso-date (calendar-gregorian-from-absolute
15229 (calendar-absolute-from-iso
15230 (list iso-week day year))))
15231 ; FIXME: Should we also push ISO weeks into the future?
15232 ; (when (and org-read-date-prefer-future
15233 ; (not iso-year)
15234 ; (< (calendar-absolute-from-gregorian iso-date)
15235 ; (time-to-days (current-time))))
15236 ; (setq year (1+ year)
15237 ; iso-date (calendar-gregorian-from-absolute
15238 ; (calendar-absolute-from-iso
15239 ; (list iso-week day year)))))
15240 (setq month (car iso-date)
15241 year (nth 2 iso-date)
15242 day (nth 1 iso-date)))
15243 (deltan
15244 (setq futurep nil)
15245 (unless deltadef
15246 (let ((now (decode-time (current-time))))
15247 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15248 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15249 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15250 ((equal deltaw "m") (setq month (+ month deltan)))
15251 ((equal deltaw "y") (setq year (+ year deltan)))))
15252 ((and wday (not (nth 3 tl)))
15253 (setq futurep nil)
15254 ;; Weekday was given, but no day, so pick that day in the week
15255 ;; on or after the derived date.
15256 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15257 (unless (equal wday wday1)
15258 (setq day (+ day (% (- wday wday1 -7) 7))))))
15259 (if (and (boundp 'org-time-was-given)
15260 (nth 2 tl))
15261 (setq org-time-was-given t))
15262 (if (< year 100) (setq year (+ 2000 year)))
15263 ;; Check of the date is representable
15264 (if org-read-date-force-compatible-dates
15265 (progn
15266 (if (< year 1970)
15267 (setq year 1970 org-read-date-analyze-forced-year t))
15268 (if (> year 2037)
15269 (setq year 2037 org-read-date-analyze-forced-year t)))
15270 (condition-case nil
15271 (ignore (encode-time second minute hour day month year))
15272 (error
15273 (setq year (nth 5 defdecode))
15274 (setq org-read-date-analyze-forced-year t))))
15275 (setq org-read-date-analyze-futurep futurep)
15276 (list second minute hour day month year)))
15278 (defvar parse-time-weekdays)
15280 (defun org-read-date-get-relative (s today default)
15281 "Check string S for special relative date string.
15282 TODAY and DEFAULT are internal times, for today and for a default.
15283 Return shift list (N what def-flag)
15285 N is the number of WHATs to shift.
15286 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15287 the DEFAULT date rather than TODAY."
15288 (require 'parse-time)
15289 (when (and
15290 (string-match
15291 (concat
15296 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15297 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15298 (string-to-char (substring (match-string 1 s) -1))
15299 ?+))
15300 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15301 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15302 (what (if (match-end 3) (match-string 3 s) "d"))
15303 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15304 (date (if rel default today))
15305 (wday (nth 6 (decode-time date)))
15306 delta)
15307 (if wday1
15308 (progn
15309 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15310 (if (= dir ?-) (setq delta (- delta 7)))
15311 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15312 (list delta "d" rel))
15313 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15315 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15316 "Turn a user-specified date into the internal representation.
15317 The internal representation needed by the calendar is (month day year).
15318 This is a wrapper to handle the brain-dead convention in calendar that
15319 user function argument order change dependent on argument order."
15320 (if (boundp 'calendar-date-style)
15321 (cond
15322 ((eq calendar-date-style 'american)
15323 (list arg1 arg2 arg3))
15324 ((eq calendar-date-style 'european)
15325 (list arg2 arg1 arg3))
15326 ((eq calendar-date-style 'iso)
15327 (list arg2 arg3 arg1)))
15328 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15329 (if (org-bound-and-true-p european-calendar-style)
15330 (list arg2 arg1 arg3)
15331 (list arg1 arg2 arg3)))))
15333 (defun org-eval-in-calendar (form &optional keepdate)
15334 "Eval FORM in the calendar window and return to current window.
15335 Also, store the cursor date in variable org-ans2."
15336 (let ((sf (selected-frame))
15337 (sw (selected-window)))
15338 (select-window (get-buffer-window "*Calendar*" t))
15339 (eval form)
15340 (when (and (not keepdate) (calendar-cursor-to-date))
15341 (let* ((date (calendar-cursor-to-date))
15342 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15343 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15344 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15345 (select-window sw)
15346 (org-select-frame-set-input-focus sf)))
15348 (defun org-calendar-select ()
15349 "Return to `org-read-date' with the date currently selected.
15350 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15351 (interactive)
15352 (when (calendar-cursor-to-date)
15353 (let* ((date (calendar-cursor-to-date))
15354 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15355 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15356 (if (active-minibuffer-window) (exit-minibuffer))))
15358 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15359 "Insert a date stamp for the date given by the internal TIME.
15360 WITH-HM means use the stamp format that includes the time of the day.
15361 INACTIVE means use square brackets instead of angular ones, so that the
15362 stamp will not contribute to the agenda.
15363 PRE and POST are optional strings to be inserted before and after the
15364 stamp.
15365 The command returns the inserted time stamp."
15366 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15367 stamp)
15368 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15369 (insert-before-markers (or pre ""))
15370 (when (listp extra)
15371 (setq extra (car extra))
15372 (if (and (stringp extra)
15374 (setq extra (format "-%02d:%02d"
15375 (string-to-number (match-string 1 extra))
15376 (string-to-number (match-string 2 extra))))
15377 (setq extra nil)))
15378 (when extra
15379 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15380 (insert-before-markers (setq stamp (format-time-string fmt time)))
15381 (insert-before-markers (or post ""))
15382 (setq org-last-inserted-timestamp stamp)))
15384 (defun org-toggle-time-stamp-overlays ()
15385 "Toggle the use of custom time stamp formats."
15386 (interactive)
15387 (setq org-display-custom-times (not org-display-custom-times))
15388 (unless org-display-custom-times
15389 (let ((p (point-min)) (bmp (buffer-modified-p)))
15390 (while (setq p (next-single-property-change p 'display))
15391 (if (and (get-text-property p 'display)
15392 (eq (get-text-property p 'face) 'org-date))
15393 (remove-text-properties
15394 p (setq p (next-single-property-change p 'display))
15395 '(display t))))
15396 (set-buffer-modified-p bmp)))
15397 (if (featurep 'xemacs)
15398 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15399 (org-restart-font-lock)
15400 (setq org-table-may-need-update t)
15401 (if org-display-custom-times
15402 (message "Time stamps are overlaid with custom format")
15403 (message "Time stamp overlays removed")))
15405 (defun org-display-custom-time (beg end)
15406 "Overlay modified time stamp format over timestamp between BEG and END."
15407 (let* ((ts (buffer-substring beg end))
15408 t1 w1 with-hm tf time str w2 (off 0))
15409 (save-match-data
15410 (setq t1 (org-parse-time-string ts t))
15411 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15412 (setq off (- (match-end 0) (match-beginning 0)))))
15413 (setq end (- end off))
15414 (setq w1 (- end beg)
15415 with-hm (and (nth 1 t1) (nth 2 t1))
15416 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15417 time (org-fix-decoded-time t1)
15418 str (org-add-props
15419 (format-time-string
15420 (substring tf 1 -1) (apply 'encode-time time))
15421 nil 'mouse-face 'highlight)
15422 w2 (length str))
15423 (if (not (= w2 w1))
15424 (add-text-properties (1+ beg) (+ 2 beg)
15425 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15426 (if (featurep 'xemacs)
15427 (progn
15428 (put-text-property beg end 'invisible t)
15429 (put-text-property beg end 'end-glyph (make-glyph str)))
15430 (put-text-property beg end 'display str))))
15432 (defun org-translate-time (string)
15433 "Translate all timestamps in STRING to custom format.
15434 But do this only if the variable `org-display-custom-times' is set."
15435 (when org-display-custom-times
15436 (save-match-data
15437 (let* ((start 0)
15438 (re org-ts-regexp-both)
15439 t1 with-hm inactive tf time str beg end)
15440 (while (setq start (string-match re string start))
15441 (setq beg (match-beginning 0)
15442 end (match-end 0)
15443 t1 (save-match-data
15444 (org-parse-time-string (substring string beg end) t))
15445 with-hm (and (nth 1 t1) (nth 2 t1))
15446 inactive (equal (substring string beg (1+ beg)) "[")
15447 tf (funcall (if with-hm 'cdr 'car)
15448 org-time-stamp-custom-formats)
15449 time (org-fix-decoded-time t1)
15450 str (format-time-string
15451 (concat
15452 (if inactive "[" "<") (substring tf 1 -1)
15453 (if inactive "]" ">"))
15454 (apply 'encode-time time))
15455 string (replace-match str t t string)
15456 start (+ start (length str)))))))
15457 string)
15459 (defun org-fix-decoded-time (time)
15460 "Set 0 instead of nil for the first 6 elements of time.
15461 Don't touch the rest."
15462 (let ((n 0))
15463 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15465 (defun org-days-to-time (timestamp-string)
15466 "Difference between TIMESTAMP-STRING and now in days."
15467 (- (time-to-days (org-time-string-to-time timestamp-string))
15468 (time-to-days (current-time))))
15470 (defun org-deadline-close (timestamp-string &optional ndays)
15471 "Is the time in TIMESTAMP-STRING close to the current date?"
15472 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15473 (and (< (org-days-to-time timestamp-string) ndays)
15474 (not (org-entry-is-done-p))))
15476 (defun org-get-wdays (ts)
15477 "Get the deadline lead time appropriate for timestring TS."
15478 (cond
15479 ((<= org-deadline-warning-days 0)
15480 ;; 0 or negative, enforce this value no matter what
15481 (- org-deadline-warning-days))
15483 ;; lead time is specified.
15484 (floor (* (string-to-number (match-string 1 ts))
15485 (cdr (assoc (match-string 2 ts)
15486 '(("d" . 1) ("w" . 7)
15487 ("m" . 30.4) ("y" . 365.25)))))))
15488 ;; go for the default.
15489 (t org-deadline-warning-days)))
15491 (defun org-calendar-select-mouse (ev)
15492 "Return to `org-read-date' with the date currently selected.
15493 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15494 (interactive "e")
15495 (mouse-set-point ev)
15496 (when (calendar-cursor-to-date)
15497 (let* ((date (calendar-cursor-to-date))
15498 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15499 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15500 (if (active-minibuffer-window) (exit-minibuffer))))
15502 (defun org-check-deadlines (ndays)
15503 "Check if there are any deadlines due or past due.
15504 A deadline is considered due if it happens within `org-deadline-warning-days'
15505 days from today's date. If the deadline appears in an entry marked DONE,
15506 it is not shown. The prefix arg NDAYS can be used to test that many
15508 (interactive "P")
15509 (let* ((org-warn-days
15510 (cond
15511 ((equal ndays '(4)) 100000)
15512 (ndays (prefix-numeric-value ndays))
15513 (t (abs org-deadline-warning-days))))
15514 (case-fold-search nil)
15516 (callback
15517 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15519 (message "%d deadlines past-due or due within %d days"
15520 (org-occur regexp nil callback)
15521 org-warn-days)))
15523 (defun org-check-before-date (date)
15524 "Check if there are deadlines or scheduled entries before DATE."
15525 (interactive (list (org-read-date)))
15526 (let ((case-fold-search nil)
15530 (callback
15531 (lambda () (time-less-p
15532 (org-time-string-to-time (match-string 2))
15533 (org-time-string-to-time date)))))
15534 (message "%d entries before %s"
15535 (org-occur regexp nil callback) date)))
15537 (defun org-check-after-date (date)
15538 "Check if there are deadlines or scheduled entries after DATE."
15539 (interactive (list (org-read-date)))
15540 (let ((case-fold-search nil)
15544 (callback
15545 (lambda () (not
15546 (time-less-p
15547 (org-time-string-to-time (match-string 2))
15548 (org-time-string-to-time date))))))
15549 (message "%d entries after %s"
15550 (org-occur regexp nil callback) date)))
15552 (defun org-check-dates-range (start-date end-date)
15553 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15554 (interactive (list (org-read-date nil nil nil "Range starts")
15555 (org-read-date nil nil nil "Range end")))
15556 (let ((case-fold-search nil)
15560 (callback
15561 (lambda ()
15562 (let ((match (match-string 2)))
15563 (and
15564 (not (time-less-p
15565 (org-time-string-to-time match)
15566 (org-time-string-to-time start-date)))
15567 (time-less-p
15568 (org-time-string-to-time match)
15569 (org-time-string-to-time end-date)))))))
15570 (message "%d entries between %s and %s"
15571 (org-occur regexp nil callback) start-date end-date)))
15573 (defun org-evaluate-time-range (&optional to-buffer)
15574 "Evaluate a time range by computing the difference between start and end.
15575 Normally the result is just printed in the echo area, but with prefix arg
15576 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15577 If the time range is actually in a table, the result is inserted into the
15578 next column.
15579 For time difference computation, a year is assumed to be exactly 365
15580 days in order to avoid rounding problems."
15581 (interactive "P")
15582 (or
15583 (org-clock-update-time-maybe)
15584 (save-excursion
15585 (unless (org-at-date-range-p t)
15586 (goto-char (point-at-bol))
15587 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15588 (if (not (org-at-date-range-p t))
15589 (error "Not at a time-stamp range, and none found in current line")))
15590 (let* ((ts1 (match-string 1))
15591 (ts2 (match-string 2))
15592 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15593 (match-end (match-end 0))
15594 (time1 (org-time-string-to-time ts1))
15595 (time2 (org-time-string-to-time ts2))
15596 (t1 (org-float-time time1))
15597 (t2 (org-float-time time2))
15598 (diff (abs (- t2 t1)))
15599 (negative (< (- t2 t1) 0))
15600 ;; (ys (floor (* 365 24 60 60)))
15601 (ds (* 24 60 60))
15602 (hs (* 60 60))
15603 (fy "%dy %dd %02d:%02d")
15604 (fy1 "%dy %dd")
15605 (fd "%dd %02d:%02d")
15606 (fd1 "%dd")
15607 (fh "%02d:%02d")
15608 y d h m align)
15609 (if havetime
15610 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15611 y 0
15612 d (floor (/ diff ds)) diff (mod diff ds)
15613 h (floor (/ diff hs)) diff (mod diff hs)
15614 m (floor (/ diff 60)))
15615 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15616 y 0
15617 d (floor (+ (/ diff ds) 0.5))
15618 h 0 m 0))
15619 (if (not to-buffer)
15620 (message "%s" (org-make-tdiff-string y d h m))
15621 (if (org-at-table-p)
15622 (progn
15623 (goto-char match-end)
15624 (setq align t)
15625 (and (looking-at " *|") (goto-char (match-end 0))))
15626 (goto-char match-end))
15627 (if (looking-at
15629 (replace-match ""))
15630 (if negative (insert " -"))
15631 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15632 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15633 (insert " " (format fh h m))))
15634 (if align (org-table-align))
15635 (message "Time difference inserted")))))
15637 (defun org-make-tdiff-string (y d h m)
15638 (let ((fmt "")
15639 (l nil))
15640 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15641 l (push y l)))
15642 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15643 l (push d l)))
15644 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15645 l (push h l)))
15646 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15647 l (push m l)))
15648 (apply 'format fmt (nreverse l))))
15650 (defun org-time-string-to-time (s &optional buffer pos)
15651 (condition-case errdata
15652 (apply 'encode-time (org-parse-time-string s))
15654 s (if (not (and buffer pos))
15655 ""
15656 (format " at %d in buffer `%s'" pos buffer))
15657 (cdr errdata)))))
15659 (defun org-time-string-to-seconds (s)
15660 (org-float-time (org-time-string-to-time s)))
15662 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15663 "Convert a time stamp to an absolute day number.
15664 If there is a specifier for a cyclic time stamp, get the closest date to
15665 DAYNR.
15666 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15667 The variable date is bound by the calendar when this is called."
15668 (cond
15670 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15671 daynr
15672 (+ daynr 1000)))
15674 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15675 (time-to-days (current-time))) (match-string 0 s)
15676 prefer show-all))
15677 (t (time-to-days
15678 (condition-case errdata
15679 (apply 'encode-time (org-parse-time-string s))
15681 s (if (not (and buffer pos))
15682 ""
15683 (format " at %d in buffer `%s'" pos buffer))
15684 (cdr errdata))))))))
15686 (defun org-days-to-iso-week (days)
15687 "Return the iso week number."
15688 (require 'cal-iso)
15689 (car (calendar-iso-from-absolute days)))
15691 (defun org-small-year-to-year (year)
15692 "Convert 2-digit years into 4-digit years.
15693 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15694 The year 2000 cannot be abbreviated. Any year larger than 99
15695 is returned unchanged."
15696 (if (< year 38)
15697 (setq year (+ 2000 year))
15698 (if (< year 100)
15699 (setq year (+ 1900 year))))
15700 year)
15702 (defun org-time-from-absolute (d)
15703 "Return the time corresponding to date D.
15704 D may be an absolute day number, or a calendar-type list (month day year)."
15705 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15706 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15708 (defun org-calendar-holiday ()
15709 "List of holidays, for Diary display in Org-mode."
15710 (require 'holidays)
15711 (let ((hl (funcall
15712 (if (fboundp 'calendar-check-holidays)
15713 'calendar-check-holidays 'check-calendar-holidays) date)))
15714 (if hl (mapconcat 'identity hl "; "))))
15716 (defun org-diary-sexp-entry (sexp entry date)
15717 "Process a SEXP diary ENTRY for DATE."
15718 (require 'diary-lib)
15719 (let ((result (if calendar-debug-sexp
15720 (let ((stack-trace-on-error t))
15721 (eval (car (read-from-string sexp))))
15722 (condition-case nil
15723 (eval (car (read-from-string sexp)))
15724 (error
15725 (beep)
15726 (message "Bad sexp at line %d in %s: %s"
15727 (org-current-line)
15728 (buffer-file-name) sexp)
15729 (sleep-for 2))))))
15730 (cond ((stringp result) (split-string result "; "))
15731 ((and (consp result)
15732 (not (consp (cdr result)))
15733 (stringp (cdr result))) (cdr result))
15734 ((and (consp result)
15735 (stringp (car result))) result)
15736 (result entry)
15737 (t nil))))
15739 (defun org-diary-to-ical-string (frombuf)
15740 "Get iCalendar entries from diary entries in buffer FROMBUF.
15741 This uses the icalendar.el library."
15742 (let* ((tmpdir (if (featurep 'xemacs)
15743 (temp-directory)
15744 temporary-file-directory))
15745 (tmpfile (make-temp-name
15746 (expand-file-name "orgics" tmpdir)))
15747 buf rtn b e)
15748 (with-current-buffer frombuf
15749 (icalendar-export-region (point-min) (point-max) tmpfile)
15750 (setq buf (find-buffer-visiting tmpfile))
15751 (set-buffer buf)
15752 (goto-char (point-min))
15753 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15754 (setq b (match-beginning 0)))
15755 (goto-char (point-max))
15756 (if (re-search-backward "^END:VEVENT" nil t)
15757 (setq e (match-end 0)))
15759 (kill-buffer buf)
15760 (delete-file tmpfile)
15761 rtn))
15763 (defun org-closest-date (start current change prefer show-all)
15764 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15765 When PREFER is `past', return a date that is either CURRENT or past.
15766 When PREFER is `future', return a date that is either CURRENT or future.
15767 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15768 ;; Make the proper lists from the dates
15769 (catch 'exit
15770 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15771 dn dw sday cday n1 n2 n0
15772 d m y y1 y2 date1 date2 nmonths nm ny m2)
15774 (setq start (org-date-to-gregorian start)
15775 current (org-date-to-gregorian
15776 (if show-all
15777 current
15778 (time-to-days (current-time))))
15779 sday (calendar-absolute-from-gregorian start)
15780 cday (calendar-absolute-from-gregorian current))
15782 (if (<= cday sday) (throw 'exit sday))
15785 (setq dn (string-to-number (match-string 1 change))
15786 dw (cdr (assoc (match-string 2 change) a1)))
15787 (error "Invalid change specifier: %s" change))
15788 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15789 (cond
15790 ((eq dw 'day)
15791 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15792 n2 (+ n1 dn)))
15793 ((eq dw 'year)
15794 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15795 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15796 (setq date1 (list m d y1)
15797 n1 (calendar-absolute-from-gregorian date1)
15798 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15799 n2 (calendar-absolute-from-gregorian date2)))
15800 ((eq dw 'month)
15801 ;; approx number of month between the two dates
15802 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15803 ;; How often does dn fit in there?
15804 (setq d (nth 1 start) m (car start) y (nth 2 start)
15805 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15806 m (+ m nm)
15807 ny (floor (/ m 12))
15808 y (+ y ny)
15809 m (- m (* ny 12)))
15810 (while (> m 12) (setq m (- m 12) y (1+ y)))
15811 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15812 (setq m2 (+ m dn) y2 y)
15813 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15814 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15815 (while (<= n2 cday)
15816 (setq n1 n2 m m2 y y2)
15817 (setq m2 (+ m dn) y2 y)
15818 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15819 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15820 ;; Make sure n1 is the earlier date
15821 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15822 (if show-all
15823 (cond
15824 ((eq prefer 'past) (if (= cday n2) n2 n1))
15825 ((eq prefer 'future) (if (= cday n1) n1 n2))
15826 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15827 (cond
15828 ((eq prefer 'past) (if (= cday n2) n2 n1))
15829 ((eq prefer 'future) (if (= cday n1) n1 n2))
15830 (t (if (= cday n1) n1 n2)))))))
15832 (defun org-date-to-gregorian (date)
15833 "Turn any specification of DATE into a Gregorian date for the calendar."
15834 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15835 ((and (listp date) (= (length date) 3)) date)
15836 ((stringp date)
15837 (setq date (org-parse-time-string date))
15838 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15839 ((listp date)
15840 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15842 (defun org-parse-time-string (s &optional nodefault)
15843 "Parse the standard Org-mode time string.
15844 This should be a lot faster than the normal `parse-time-string'.
15845 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15846 hour and minute fields will be nil if not given."
15847 (if (string-match org-ts-regexp0 s)
15848 (list 0
15849 (if (or (match-beginning 8) (not nodefault))
15850 (string-to-number (or (match-string 8 s) "0")))
15851 (if (or (match-beginning 7) (not nodefault))
15852 (string-to-number (or (match-string 7 s) "0")))
15853 (string-to-number (match-string 4 s))
15854 (string-to-number (match-string 3 s))
15855 (string-to-number (match-string 2 s))
15856 nil nil nil)
15857 (error "Not a standard Org-mode time string: %s" s)))
15859 (defun org-timestamp-up (&optional arg)
15860 "Increase the date item at the cursor by one.
15861 If the cursor is on the year, change the year. If it is on the month,
15862 the day or the time, change that.
15863 With prefix ARG, change by that many units."
15864 (interactive "p")
15865 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15867 (defun org-timestamp-down (&optional arg)
15868 "Decrease the date item at the cursor by one.
15869 If the cursor is on the year, change the year. If it is on the month,
15870 the day or the time, change that.
15871 With prefix ARG, change by that many units."
15872 (interactive "p")
15873 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15875 (defun org-timestamp-up-day (&optional arg)
15876 "Increase the date in the time stamp by one day.
15877 With prefix ARG, change that many days."
15878 (interactive "p")
15879 (if (and (not (org-at-timestamp-p t))
15880 (org-at-heading-p))
15881 (org-todo 'up)
15882 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15884 (defun org-timestamp-down-day (&optional arg)
15885 "Decrease the date in the time stamp by one day.
15886 With prefix ARG, change that many days."
15887 (interactive "p")
15888 (if (and (not (org-at-timestamp-p t))
15889 (org-at-heading-p))
15890 (org-todo 'down)
15891 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15893 (defun org-at-timestamp-p (&optional inactive-ok)
15894 "Determine if the cursor is in or at a timestamp."
15895 (interactive)
15896 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15897 (pos (point))
15898 (ans (or (looking-at tsr)
15899 (save-excursion
15901 (if (> (point) (point-min)) (backward-char 1))
15902 (and (looking-at tsr)
15903 (> (- (match-end 0) pos) -1))))))
15904 (and ans
15905 (boundp 'org-ts-what)
15906 (setq org-ts-what
15907 (cond
15908 ((= pos (match-beginning 0)) 'bracket)
15909 ;; Point is considered to be "on the bracket" whether
15910 ;; it's really on it or right after it.
15911 ((or (= pos (1- (match-end 0)))
15912 (= pos (match-end 0))) 'bracket)
15913 ((org-pos-in-match-range pos 2) 'year)
15914 ((org-pos-in-match-range pos 3) 'month)
15915 ((org-pos-in-match-range pos 7) 'hour)
15916 ((org-pos-in-match-range pos 8) 'minute)
15917 ((or (org-pos-in-match-range pos 4)
15918 (org-pos-in-match-range pos 5)) 'day)
15919 ((and (> pos (or (match-end 8) (match-end 5)))
15920 (< pos (match-end 0)))
15921 (- pos (or (match-end 8) (match-end 5))))
15922 (t 'day))))
15923 ans))
15925 (defun org-toggle-timestamp-type ()
15926 "Toggle the type (<active> or [inactive]) of a time stamp."
15927 (interactive)
15928 (when (org-at-timestamp-p t)
15929 (let ((beg (match-beginning 0)) (end (match-end 0))
15930 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15931 (save-excursion
15932 (goto-char beg)
15933 (while (re-search-forward "[][<>]" end t)
15934 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15935 t t)))
15936 (message "Timestamp is now %sactive"
15937 (if (equal (char-after beg) ?<) "" "in")))))
15939 (defun org-timestamp-change (n &optional what updown)
15940 "Change the date in the time stamp at point.
15941 The date will be changed by N times WHAT. WHAT can be `day', `month',
15942 `year', `minute', `second'. If WHAT is not given, the cursor position
15943 in the timestamp determines what will be changed."
15944 (let ((origin (point)) origin-cat
15945 with-hm inactive
15946 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15947 org-ts-what
15948 extra rem
15949 ts time time0)
15950 (if (not (org-at-timestamp-p t))
15951 (error "Not at a timestamp"))
15952 (if (and (not what) (eq org-ts-what 'bracket))
15953 (org-toggle-timestamp-type)
15954 ;; Point isn't on brackets. Remember the part of the time-stamp
15955 ;; the point was in. Indeed, size of time-stamps may change,
15956 ;; but point must be kept in the same category nonetheless.
15957 (setq origin-cat org-ts-what)
15958 (if (and (not what) (not (eq org-ts-what 'day))
15959 org-display-custom-times
15960 (get-text-property (point) 'display)
15961 (not (get-text-property (1- (point)) 'display)))
15962 (setq org-ts-what 'day))
15963 (setq org-ts-what (or what org-ts-what)
15964 inactive (= (char-after (match-beginning 0)) ?\[)
15965 ts (match-string 0))
15966 (replace-match "")
15967 (if (string-match
15969 ts)
15970 (setq extra (match-string 1 ts)))
15972 (setq with-hm t))
15973 (setq time0 (org-parse-time-string ts))
15974 (when (and updown
15975 (eq org-ts-what 'minute)
15976 (not current-prefix-arg))
15977 ;; This looks like s-up and s-down. Change by one rounding step.
15978 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15979 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15980 (setcar (cdr time0) (+ (nth 1 time0)
15981 (if (> n 0) (- rem) (- dm rem))))))
15982 (setq time
15983 (encode-time (or (car time0) 0)
15984 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15985 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15986 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15987 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15988 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15989 (nthcdr 6 time0)))
15990 (when (and (member org-ts-what '(hour minute))
15991 extra
15993 (setq extra (org-modify-ts-extra
15994 extra
15995 (if (eq org-ts-what 'hour) 2 5)
15996 n dm)))
15997 (when (integerp org-ts-what)
15998 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15999 (if (eq what 'calendar)
16000 (let ((cal-date (org-get-date-from-calendar)))
16001 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16002 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16003 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16004 (setcar time0 (or (car time0) 0))
16005 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16006 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16007 (setq time (apply 'encode-time time0))))
16008 ;; Insert the new time-stamp, and ensure point stays in the same
16009 ;; category as before (i.e. not after the last position in that
16010 ;; category).
16011 (let ((pos (point)))
16012 ;; Stay before inserted string. `save-excursion' is of no use.
16013 (setq org-last-changed-timestamp
16014 (org-insert-time-stamp time with-hm inactive nil nil extra))
16015 (goto-char pos))
16016 (save-match-data
16017 (looking-at org-ts-regexp3)
16018 (goto-char (cond
16019 ;; `day' category ends before `hour' if any, or at
16020 ;; the end of the day name.
16021 ((eq origin-cat 'day)
16022 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16023 ((eq origin-cat 'hour) (min (match-end 7) origin))
16024 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16025 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16026 ;; `year' and `month' have both fixed size: point
16027 ;; couldn't have moved into another part.
16028 (t origin))))
16029 ;; Update clock if on a CLOCK line.
16030 (org-clock-update-time-maybe)
16031 ;; Try to recenter the calendar window, if any.
16032 (if (and org-calendar-follow-timestamp-change
16033 (get-buffer-window "*Calendar*" t)
16034 (memq org-ts-what '(day month year)))
16035 (org-recenter-calendar (time-to-days time))))))
16037 (defun org-modify-ts-extra (s pos n dm)
16038 "Change the different parts of the lead-time and repeat fields in timestamp."
16039 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16040 ng h m new rem)
16041 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16042 (cond
16043 ((or (org-pos-in-match-range pos 2)
16044 (org-pos-in-match-range pos 3))
16045 (setq m (string-to-number (match-string 3 s))
16046 h (string-to-number (match-string 2 s)))
16047 (if (org-pos-in-match-range pos 2)
16048 (setq h (+ h n))
16049 (setq n (* dm (org-no-warnings (signum n))))
16050 (when (not (= 0 (setq rem (% m dm))))
16051 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16052 (setq m (+ m n)))
16053 (if (< m 0) (setq m (+ m 60) h (1- h)))
16054 (if (> m 59) (setq m (- m 60) h (1+ h)))
16055 (setq h (min 24 (max 0 h)))
16056 (setq ng 1 new (format "-%02d:%02d" h m)))
16057 ((org-pos-in-match-range pos 6)
16058 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16059 ((org-pos-in-match-range pos 5)
16060 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16062 ((org-pos-in-match-range pos 9)
16063 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16064 ((org-pos-in-match-range pos 8)
16065 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16067 (when ng
16068 (setq s (concat
16069 (substring s 0 (match-beginning ng))
16070 new
16071 (substring s (match-end ng))))))
16072 s))
16074 (defun org-recenter-calendar (date)
16075 "If the calendar is visible, recenter it to DATE."
16076 (let* ((win (selected-window))
16077 (cwin (get-buffer-window "*Calendar*" t))
16078 (calendar-move-hook nil))
16079 (when cwin
16080 (select-window cwin)
16081 (calendar-goto-date (if (listp date) date
16082 (calendar-gregorian-from-absolute date)))
16083 (select-window win))))
16085 (defun org-goto-calendar (&optional arg)
16086 "Go to the Emacs calendar at the current date.
16087 If there is a time stamp in the current line, go to that date.
16088 A prefix ARG can be used to force the current date."
16089 (interactive "P")
16090 (let ((tsr org-ts-regexp) diff
16091 (calendar-move-hook nil)
16092 (calendar-view-holidays-initially-flag nil)
16093 (calendar-view-diary-initially-flag nil))
16094 (if (or (org-at-timestamp-p)
16095 (save-excursion
16096 (beginning-of-line 1)
16097 (looking-at (concat ".*" tsr))))
16098 (let ((d1 (time-to-days (current-time)))
16099 (d2 (time-to-days
16100 (org-time-string-to-time (match-string 1)))))
16101 (setq diff (- d2 d1))))
16102 (calendar)
16103 (calendar-goto-today)
16104 (if (and diff (not arg)) (calendar-forward-day diff))))
16106 (defun org-get-date-from-calendar ()
16107 "Return a list (month day year) of date at point in calendar."
16108 (with-current-buffer "*Calendar*"
16109 (save-match-data
16110 (calendar-cursor-to-date))))
16112 (defun org-date-from-calendar ()
16113 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16114 If there is already a time stamp at the cursor position, update it."
16115 (interactive)
16116 (if (org-at-timestamp-p t)
16117 (org-timestamp-change 0 'calendar)
16118 (let ((cal-date (org-get-date-from-calendar)))
16119 (org-insert-time-stamp
16120 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16122 (defun org-minutes-to-hh:mm-string (m)
16123 "Compute H:MM from a number of minutes."
16124 (let ((h (/ m 60)))
16125 (setq m (- m (* 60 h)))
16126 (format org-time-clocksum-format h m)))
16128 (defun org-hh:mm-string-to-minutes (s)
16129 "Convert a string H:MM to a number of minutes.
16130 If the string is just a number, interpret it as minutes.
16131 In fact, the first hh:mm or number in the string will be taken,
16132 there can be extra stuff in the string.
16133 If no number is found, the return value is 0."
16134 (cond
16135 ((integerp s) s)
16137 (+ (* (string-to-number (match-string 1 s)) 60)
16138 (string-to-number (match-string 2 s))))
16140 (string-to-number (match-string 1 s)))
16141 (t 0)))
16143 (defcustom org-effort-durations
16144 `(("h" . 60)
16145 ("d" . ,(* 60 8))
16146 ("w" . ,(* 60 8 5))
16147 ("m" . ,(* 60 8 5 4))
16148 ("y" . ,(* 60 8 5 40)))
16149 "Conversion factor to minutes for an effort modifier.
16151 Each entry has the form (MODIFIER . MINUTES).
16153 In an effort string, a number followed by MODIFIER is multiplied
16154 by the specified number of MINUTES to obtain an effort in
16155 minutes.
16159 :group 'org-agenda
16160 :type '(alist :key-type (string :tag "Modifier")
16161 :value-type (number :tag "Minutes")))
16163 (defun org-duration-string-to-minutes (s)
16164 "Convert a duration string S to minutes.
16166 A bare number is interpreted as minutes, modifiers can be set by
16167 customizing `org-effort-durations' (which see).
16169 Entries containing a colon are interpreted as H:MM by
16170 `org-hh:mm-string-to-minutes'."
16171 (let ((result 0)
16173 (regexp-opt (mapcar 'car org-effort-durations))
16175 (while (string-match re s)
16176 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16177 (string-to-number (match-string 1 s))))
16178 (setq s (replace-match "" nil t s)))
16179 (incf result (org-hh:mm-string-to-minutes s))
16180 result))
16182 ;;;; Files
16184 (defun org-save-all-org-buffers ()
16185 "Save all Org-mode buffers without user confirmation."
16186 (interactive)
16187 (message "Saving all Org-mode buffers...")
16188 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16189 (when (featurep 'org-id) (org-id-locations-save))
16190 (message "Saving all Org-mode buffers... done"))
16192 (defun org-revert-all-org-buffers ()
16193 "Revert all Org-mode buffers.
16194 Prompt for confirmation when there are unsaved changes.
16195 Be sure you know what you are doing before letting this function
16196 overwrite your changes.
16198 This function is useful in a setup where one tracks org files
16199 with a version control system, to revert on one machine after pulling
16200 changes from another. I believe the procedure must be like this:
16202 1. M-x org-save-all-org-buffers
16203 2. Pull changes from the other machine, resolve conflicts
16204 3. M-x org-revert-all-org-buffers"
16205 (interactive)
16206 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16207 (error "Abort"))
16208 (save-excursion
16209 (save-window-excursion
16210 (mapc
16211 (lambda (b)
16212 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16213 (with-current-buffer b buffer-file-name))
16214 (org-pop-to-buffer-same-window b)
16215 (revert-buffer t 'no-confirm)))
16216 (buffer-list))
16217 (when (and (featurep 'org-id) org-id-track-globally)
16218 (org-id-locations-load)))))
16220 ;;;; Agenda files
16222 ;;;###autoload
16223 (defun org-switchb (&optional arg)
16224 "Switch between Org buffers.
16225 With one prefix argument, restrict available buffers to files.
16226 With two prefix arguments, restrict available buffers to agenda files.
16228 Defaults to `iswitchb' for buffer name completion.
16229 Set `org-completion-use-ido' to make it use ido instead."
16230 (interactive "P")
16231 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16232 ((equal arg '(16)) (org-buffer-list 'agenda))
16233 (t (org-buffer-list))))
16234 (org-completion-use-iswitchb org-completion-use-iswitchb)
16235 (org-completion-use-ido org-completion-use-ido))
16236 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16237 (setq org-completion-use-iswitchb t))
16238 (org-pop-to-buffer-same-window
16239 (org-icompleting-read "Org buffer: "
16240 (mapcar 'list (mapcar 'buffer-name blist))
16241 nil t))))
16243 ;;; Define some older names previously used for this functionality
16244 ;;;###autoload
16245 (defalias 'org-ido-switchb 'org-switchb)
16246 ;;;###autoload
16247 (defalias 'org-iswitchb 'org-switchb)
16249 (defun org-buffer-list (&optional predicate exclude-tmp)
16250 "Return a list of Org buffers.
16251 PREDICATE can be `export', `files' or `agenda'.
16253 export restrict the list to Export buffers.
16254 files restrict the list to buffers visiting Org files.
16255 agenda restrict the list to buffers visiting agenda files.
16257 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16258 (let* ((bfn nil)
16259 (agenda-files (and (eq predicate 'agenda)
16260 (mapcar 'file-truename (org-agenda-files t))))
16261 (filter
16262 (cond
16263 ((eq predicate 'files)
16264 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16265 ((eq predicate 'export)
16266 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16267 ((eq predicate 'agenda)
16268 (lambda (b)
16269 (with-current-buffer b
16270 (and (eq major-mode 'org-mode)
16271 (setq bfn (buffer-file-name b))
16272 (member (file-truename bfn) agenda-files)))))
16273 (t (lambda (b) (with-current-buffer b
16274 (or (eq major-mode 'org-mode)
16275 (string-match "\*Org .*Export"
16276 (buffer-name b)))))))))
16277 (delq nil
16278 (mapcar
16279 (lambda(b)
16280 (if (and (funcall filter b)
16281 (or (not exclude-tmp)
16282 (not (string-match "tmp" (buffer-name b)))))
16283 b
16284 nil))
16285 (buffer-list)))))
16287 (defun org-agenda-files (&optional unrestricted archives)
16288 "Get the list of agenda files.
16289 Optional UNRESTRICTED means return the full list even if a restriction
16290 is currently in place.
16291 When ARCHIVES is t, include all archive files that are really being
16292 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16293 `org-agenda-archives-mode' is t."
16294 (let ((files
16295 (cond
16296 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16297 ((stringp org-agenda-files) (org-read-agenda-file-list))
16298 ((listp org-agenda-files) org-agenda-files)
16299 (t (error "Invalid value of `org-agenda-files'")))))
16300 (setq files (apply 'append
16301 (mapcar (lambda (f)
16302 (if (file-directory-p f)
16303 (directory-files
16304 f t org-agenda-file-regexp)
16305 (list f)))
16306 files)))
16307 (when org-agenda-skip-unavailable-files
16308 (setq files (delq nil
16309 (mapcar (function
16310 (lambda (file)
16311 (and (file-readable-p file) file)))
16312 files))))
16313 (when (or (eq archives t)
16314 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16315 (setq files (org-add-archive-files files)))
16316 files))
16318 (defun org-agenda-file-p (&optional file)
16319 "Return non-nil, if FILE is an agenda file.
16320 If FILE is omitted, use the file associated with the current
16321 buffer."
16322 (member (or file (buffer-file-name))
16323 (org-agenda-files t)))
16325 (defun org-edit-agenda-file-list ()
16326 "Edit the list of agenda files.
16327 Depending on setup, this either uses customize to edit the variable
16328 `org-agenda-files', or it visits the file that is holding the list. In the
16329 latter case, the buffer is set up in a way that saving it automatically kills
16330 the buffer and restores the previous window configuration."
16331 (interactive)
16332 (if (stringp org-agenda-files)
16333 (let ((cw (current-window-configuration)))
16334 (find-file org-agenda-files)
16335 (org-set-local 'org-window-configuration cw)
16336 (org-add-hook 'after-save-hook
16337 (lambda ()
16338 (set-window-configuration
16339 (prog1 org-window-configuration
16340 (kill-buffer (current-buffer))))
16341 (org-install-agenda-files-menu)
16342 (message "New agenda file list installed"))
16343 nil 'local)
16344 (message "%s" (substitute-command-keys
16346 (customize-variable 'org-agenda-files)))
16348 (defun org-store-new-agenda-file-list (list)
16349 "Set new value for the agenda file list and save it correctly."
16350 (if (stringp org-agenda-files)
16351 (let ((fe (org-read-agenda-file-list t)) b u)
16352 (while (setq b (find-buffer-visiting org-agenda-files))
16353 (kill-buffer b))
16354 (with-temp-file org-agenda-files
16355 (insert
16356 (mapconcat
16357 (lambda (f) ;; Keep un-expanded entries.
16358 (if (setq u (assoc f fe))
16359 (cdr u)
16360 f))
16363 (let ((org-mode-hook nil) (org-inhibit-startup t)
16364 (org-insert-mode-line-in-empty-file nil))
16365 (setq org-agenda-files list)
16366 (customize-save-variable 'org-agenda-files org-agenda-files))))
16368 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16369 "Read the list of agenda files from a file.
16370 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16371 filenames, used by `org-store-new-agenda-file-list' to write back
16372 un-expanded file names."
16373 (when (file-directory-p org-agenda-files)
16374 (error "`org-agenda-files' cannot be a single directory"))
16375 (when (stringp org-agenda-files)
16376 (with-temp-buffer
16377 (insert-file-contents org-agenda-files)
16378 (mapcar
16379 (lambda (f)
16380 (let ((e (expand-file-name (substitute-in-file-name f)
16381 org-directory)))
16382 (if pair-with-expansion
16383 (cons e f)
16384 e)))
16387 ;;;###autoload
16388 (defun org-cycle-agenda-files ()
16389 "Cycle through the files in `org-agenda-files'.
16390 If the current buffer visits an agenda file, find the next one in the list.
16391 If the current buffer does not, find the first agenda file."
16392 (interactive)
16393 (let* ((fs (org-agenda-files t))
16394 (files (append fs (list (car fs))))
16395 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16396 file)
16397 (unless files (error "No agenda files"))
16398 (catch 'exit
16399 (while (setq file (pop files))
16400 (if (equal (file-truename file) tcf)
16401 (when (car files)
16402 (find-file (car files))
16403 (throw 'exit t))))
16404 (find-file (car fs)))
16405 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16407 (defun org-agenda-file-to-front (&optional to-end)
16408 "Move/add the current file to the top of the agenda file list.
16409 If the file is not present in the list, it is added to the front. If it is
16410 present, it is moved there. With optional argument TO-END, add/move to the
16411 end of the list."
16412 (interactive "P")
16413 (let ((org-agenda-skip-unavailable-files nil)
16414 (file-alist (mapcar (lambda (x)
16415 (cons (file-truename x) x))
16416 (org-agenda-files t)))
16417 (ctf (file-truename buffer-file-name))
16418 x had)
16419 (setq x (assoc ctf file-alist) had x)
16421 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16422 (if to-end
16423 (setq file-alist (append (delq x file-alist) (list x)))
16424 (setq file-alist (cons x (delq x file-alist))))
16425 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16426 (org-install-agenda-files-menu)
16427 (message "File %s to %s of agenda file list"
16428 (if had "moved" "added") (if to-end "end" "front"))))
16430 (defun org-remove-file (&optional file)
16431 "Remove current file from the list of files in variable `org-agenda-files'.
16432 These are the files which are being checked for agenda entries.
16433 Optional argument FILE means use this file instead of the current."
16434 (interactive)
16435 (let* ((org-agenda-skip-unavailable-files nil)
16436 (file (or file buffer-file-name))
16437 (true-file (file-truename file))
16438 (afile (abbreviate-file-name file))
16439 (files (delq nil (mapcar
16440 (lambda (x)
16441 (if (equal true-file
16442 (file-truename x))
16443 nil x))
16444 (org-agenda-files t)))))
16445 (if (not (= (length files) (length (org-agenda-files t))))
16446 (progn
16447 (org-store-new-agenda-file-list files)
16448 (org-install-agenda-files-menu)
16449 (message "Removed file: %s" afile))
16450 (message "File was not in list: %s (not removed)" afile))))
16452 (defun org-file-menu-entry (file)
16453 (vector file (list 'find-file file) t))
16455 (defun org-check-agenda-file (file)
16456 "Make sure FILE exists. If not, ask user what to do."
16457 (when (not (file-exists-p file))
16458 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16459 (abbreviate-file-name file))
16460 (let ((r (downcase (read-char-exclusive))))
16461 (cond
16462 ((equal r ?r)
16463 (org-remove-file file)
16464 (throw 'nextfile t))
16465 (t (error "Abort"))))))
16467 (defun org-get-agenda-file-buffer (file)
16468 "Get a buffer visiting FILE. If the buffer needs to be created, add
16469 it to the list of buffers which might be released later."
16470 (let ((buf (org-find-base-buffer-visiting file)))
16471 (if buf
16472 buf ; just return it
16473 ;; Make a new buffer and remember it
16474 (setq buf (find-file-noselect file))
16475 (if buf (push buf org-agenda-new-buffers))
16476 buf)))
16478 (defun org-release-buffers (blist)
16479 "Release all buffers in list, asking the user for confirmation when needed.
16480 When a buffer is unmodified, it is just killed. When modified, it is saved
16481 \(if the user agrees) and then killed."
16482 (let (buf file)
16483 (while (setq buf (pop blist))
16484 (setq file (buffer-file-name buf))
16485 (when (and (buffer-modified-p buf)
16486 file
16487 (y-or-n-p (format "Save file %s? " file)))
16488 (with-current-buffer buf (save-buffer)))
16489 (kill-buffer buf))))
16491 (defun org-prepare-agenda-buffers (files)
16492 "Create buffers for all agenda files, protect archived trees and comments."
16493 (interactive)
16494 (let ((pa '(:org-archived t))
16495 (pc '(:org-comment t))
16496 (pall '(:org-archived t :org-comment t))
16497 (inhibit-read-only t)
16498 (rea (concat ":" org-archive-tag ":"))
16499 bmp file re)
16500 (save-excursion
16501 (save-restriction
16502 (while (setq file (pop files))
16503 (catch 'nextfile
16504 (if (bufferp file)
16505 (set-buffer file)
16506 (org-check-agenda-file file)
16507 (set-buffer (org-get-agenda-file-buffer file)))
16508 (widen)
16509 (setq bmp (buffer-modified-p))
16510 (org-refresh-category-properties)
16511 (setq org-todo-keywords-for-agenda
16512 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16513 (setq org-done-keywords-for-agenda
16514 (append org-done-keywords-for-agenda org-done-keywords))
16515 (setq org-todo-keyword-alist-for-agenda
16516 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16517 (setq org-drawers-for-agenda
16518 (append org-drawers-for-agenda org-drawers))
16519 (setq org-tag-alist-for-agenda
16520 (append org-tag-alist-for-agenda org-tag-alist))
16522 (save-excursion
16523 (remove-text-properties (point-min) (point-max) pall)
16524 (when org-agenda-skip-archived-trees
16525 (goto-char (point-min))
16526 (while (re-search-forward rea nil t)
16527 (if (org-at-heading-p t)
16528 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16529 (goto-char (point-min))
16530 (setq re (format org-heading-keyword-regexp-format
16531 org-comment-string))
16532 (while (re-search-forward re nil t)
16533 (add-text-properties
16534 (match-beginning 0) (org-end-of-subtree t) pc)))
16535 (set-buffer-modified-p bmp)))))
16536 (setq org-todo-keywords-for-agenda
16537 (org-uniquify org-todo-keywords-for-agenda))
16538 (setq org-todo-keyword-alist-for-agenda
16539 (org-uniquify org-todo-keyword-alist-for-agenda)
16540 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16542 ;;;; Embedded LaTeX
16544 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16545 "Keymap for the minor `org-cdlatex-mode'.")
16547 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16548 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16549 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16550 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16551 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16553 (defvar org-cdlatex-texmathp-advice-is-done nil
16554 "Flag remembering if we have applied the advice to texmathp already.")
16556 (define-minor-mode org-cdlatex-mode
16557 "Toggle the minor `org-cdlatex-mode'.
16558 This mode supports entering LaTeX environment and math in LaTeX fragments
16559 in Org-mode.
16561 nil " OCDL" nil
16562 (when org-cdlatex-mode
16563 (require 'cdlatex)
16564 (run-hooks 'cdlatex-mode-hook)
16565 (cdlatex-compute-tables))
16566 (unless org-cdlatex-texmathp-advice-is-done
16567 (setq org-cdlatex-texmathp-advice-is-done t)
16568 (defadvice texmathp (around org-math-always-on activate)
16569 "Always return t in org-mode buffers.
16570 This is because we want to insert math symbols without dollars even outside
16571 the LaTeX math segments. If Orgmode thinks that point is actually inside
16572 an embedded LaTeX fragment, let texmathp do its job.
16574 (interactive)
16575 (let (p)
16576 (cond
16577 ((not (eq major-mode 'org-mode)) ad-do-it)
16578 ((eq this-command 'cdlatex-math-symbol)
16579 (setq ad-return-value t
16580 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16581 (t
16582 (let ((p (org-inside-LaTeX-fragment-p)))
16583 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16584 (setq ad-return-value t
16585 texmathp-why '("Org-mode embedded math" . 0))
16586 (if p ad-do-it)))))))))
16588 (defun turn-on-org-cdlatex ()
16589 "Unconditionally turn on `org-cdlatex-mode'."
16590 (org-cdlatex-mode 1))
16592 (defun org-inside-LaTeX-fragment-p ()
16593 "Test if point is inside a LaTeX fragment.
16595 sequence appearing also before point.
16596 Even though the matchers for math are configurable, this function assumes
16598 delimiters are skipped when they have been removed by customization.
16599 The return value is nil, or a cons cell with the delimiter and the
16600 position of this delimiter.
16602 This function does a reasonably good job, but can locally be fooled by
16603 for example currency specifications. For example it will assume being in
16605 fragments that are properly closed, but during editing, we have to live
16606 with the uncertainty caused by missing closing delimiters. This function
16607 looks only before point, not after."
16608 (catch 'exit
16609 (let ((pos (point))
16610 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16611 (lim (progn
16613 (point)))
16614 dd-on str (start 0) m re)
16615 (goto-char pos)
16616 (when dodollar
16618 re (nth 1 (assoc "$" org-latex-regexps)))
16619 (while (string-match re str start)
16620 (cond
16621 ((= (match-end 0) (length str))
16622 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16623 ((= (match-end 0) (- (length str) 5))
16624 (throw 'exit nil))
16625 (t (setq start (match-end 0))))))
16626 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16627 (goto-char pos)
16628 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16629 (and (match-beginning 2) (throw 'exit nil))
16630 ;; count $$
16632 (setq dd-on (not dd-on)))
16633 (goto-char pos)
16634 (if dd-on (cons "$$" m))))))
16636 (defun org-inside-latex-macro-p ()
16637 "Is point inside a LaTeX macro or its arguments?"
16638 (save-match-data
16639 (org-in-regexp
16642 (defun org-try-cdlatex-tab ()
16643 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16644 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16645 - inside a LaTeX fragment, or
16646 - after the first word in a line, where an abbreviation expansion could
16647 insert a LaTeX environment."
16648 (when org-cdlatex-mode
16649 (cond
16650 ;; Before any word on the line: No expansion possible.
16652 ;; Just after first word on the line: Expand it. Make sure it
16653 ;; cannot happen on headlines, though.
16654 ((save-excursion
16655 (skip-chars-backward "a-zA-Z0-9*")
16657 (and (bolp) (not (org-at-heading-p))))
16658 (cdlatex-tab) t)
16659 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16661 (defun org-cdlatex-underscore-caret (&optional arg)
16662 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16663 Revert to the normal definition outside of these fragments."
16664 (interactive "P")
16665 (if (org-inside-LaTeX-fragment-p)
16666 (call-interactively 'cdlatex-sub-superscript)
16667 (let (org-cdlatex-mode)
16668 (call-interactively (key-binding (vector last-input-event))))))
16670 (defun org-cdlatex-math-modify (&optional arg)
16671 "Execute `cdlatex-math-modify' in LaTeX fragments.
16672 Revert to the normal definition outside of these fragments."
16673 (interactive "P")
16674 (if (org-inside-LaTeX-fragment-p)
16675 (call-interactively 'cdlatex-math-modify)
16676 (let (org-cdlatex-mode)
16677 (call-interactively (key-binding (vector last-input-event))))))
16679 (defvar org-latex-fragment-image-overlays nil
16680 "List of overlays carrying the images of latex fragments.")
16681 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16683 (defun org-remove-latex-fragment-image-overlays ()
16684 "Remove all overlays with LaTeX fragment images in current buffer."
16685 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16686 (setq org-latex-fragment-image-overlays nil))
16688 (defun org-preview-latex-fragment (&optional subtree)
16689 "Preview the LaTeX fragment at point, or all locally or globally.
16690 If the cursor is in a LaTeX fragment, create the image and overlay
16691 it over the source code. If there is no fragment at point, display
16692 all fragments in the current text, from one headline to the next. With
16693 prefix SUBTREE, display all fragments in the current subtree. With a
16695 the cursor is before the first headline,
16696 display all fragments in the buffer.
16698 (interactive "P")
16699 (org-remove-latex-fragment-image-overlays)
16700 (save-excursion
16701 (save-restriction
16702 (let (beg end at msg)
16703 (cond
16704 ((or (equal subtree '(16))
16705 (not (save-excursion
16706 (re-search-backward org-outline-regexp-bol nil t))))
16707 (setq beg (point-min) end (point-max)
16708 msg "Creating images for buffer...%s"))
16709 ((equal subtree '(4))
16710 (org-back-to-heading)
16711 (setq beg (point) end (org-end-of-subtree t)
16712 msg "Creating images for subtree...%s"))
16713 (t
16714 (if (setq at (org-inside-LaTeX-fragment-p))
16715 (goto-char (max (point-min) (- (cdr at) 2)))
16716 (org-back-to-heading))
16717 (setq beg (point) end (progn (outline-next-heading) (point))
16718 msg (if at "Creating image...%s"
16719 "Creating images for entry...%s"))))
16720 (message msg "")
16721 (narrow-to-region beg end)
16722 (goto-char beg)
16723 (org-format-latex
16724 (concat "ltxpng/" (file-name-sans-extension
16725 (file-name-nondirectory
16726 buffer-file-name)))
16727 default-directory 'overlays msg at 'forbuffer 'dvipng)
16728 (message msg "done. Use `C-c C-c' to remove images.")))))
16730 (defvar org-latex-regexps
16732 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16735 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16739 "Regular expressions for matching embedded LaTeX.")
16741 (defvar org-export-have-math nil) ;; dynamic scoping
16742 (defun org-format-latex (prefix &optional dir overlays msg at
16743 forbuffer processing-type)
16744 "Replace LaTeX fragments with links to an image, and produce images.
16745 Some of the options can be changed using the variable
16746 `org-format-latex-options'."
16747 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16748 (let* ((prefixnodir (file-name-nondirectory prefix))
16749 (absprefix (expand-file-name prefix dir))
16750 (todir (file-name-directory absprefix))
16751 (opt org-format-latex-options)
16752 (matchers (plist-get opt :matchers))
16753 (re-list org-latex-regexps)
16754 (org-format-latex-header-extra
16755 (plist-get (org-infile-export-plist) :latex-header-extra))
16756 (cnt 0) txt hash link beg end re e checkdir
16757 executables-checked string
16758 m n block-type block linkfile movefile ov)
16759 ;; Check the different regular expressions
16760 (while (setq e (pop re-list))
16761 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16763 (when (member m matchers)
16764 (goto-char (point-min))
16765 (while (re-search-forward re nil t)
16766 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16767 (not (get-text-property (match-beginning n)
16768 'org-protected))
16769 (or (not overlays)
16770 (not (eq (get-char-property (match-beginning n)
16771 'org-overlay-type)
16772 'org-latex-overlay))))
16773 (setq org-export-have-math t)
16774 (cond
16775 ((eq processing-type 'verbatim)
16776 ;; Leave the text verbatim, just protect it
16777 (add-text-properties (match-beginning n) (match-end n)
16778 '(org-protected t)))
16779 ((eq processing-type 'mathjax)
16780 ;; Prepare for MathJax processing
16781 (setq string (match-string n))
16782 (if (member m '("$" "$1"))
16783 (save-excursion
16784 (delete-region (match-beginning n) (match-end n))
16785 (goto-char (match-beginning n))
16788 '(org-protected t))))
16789 (add-text-properties (match-beginning n) (match-end n)
16790 '(org-protected t))))
16791 ((eq processing-type 'dvipng)
16792 ;; Process to an image
16793 (setq txt (match-string n)
16794 beg (match-beginning n) end (match-end n)
16795 cnt (1+ cnt))
16796 (let (print-length print-level) ; make sure full list is printed
16797 (setq hash (sha1 (prin1-to-string
16798 (list org-format-latex-header
16799 org-format-latex-header-extra
16800 org-export-latex-default-packages-alist
16801 org-export-latex-packages-alist
16802 org-format-latex-options
16803 forbuffer txt)))
16804 linkfile (format "%s_%s.png" prefix hash)
16805 movefile (format "%s_%s.png" absprefix hash)))
16806 (setq link (concat block "[[file:" linkfile "]]" block))
16807 (if msg (message msg cnt))
16808 (goto-char beg)
16809 (unless checkdir ; make sure the directory exists
16810 (setq checkdir t)
16811 (or (file-directory-p todir) (make-directory todir t)))
16813 (unless executables-checked
16814 (org-check-external-command
16815 "latex" "needed to convert LaTeX fragments to images")
16816 (org-check-external-command
16817 "dvipng" "needed to convert LaTeX fragments to images")
16818 (setq executables-checked t))
16820 (unless (file-exists-p movefile)
16821 (org-create-formula-image
16822 txt movefile opt forbuffer))
16823 (if overlays
16824 (progn
16825 (mapc (lambda (o)
16826 (if (eq (overlay-get o 'org-overlay-type)
16827 'org-latex-overlay)
16828 (delete-overlay o)))
16829 (overlays-in beg end))
16830 (setq ov (make-overlay beg end))
16831 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16832 (if (featurep 'xemacs)
16833 (progn
16834 (overlay-put ov 'invisible t)
16835 (overlay-put
16836 ov 'end-glyph
16837 (make-glyph (vector 'png :file movefile))))
16838 (overlay-put
16839 ov 'display
16840 (list 'image :type 'png :file movefile :ascent 'center)))
16841 (push ov org-latex-fragment-image-overlays)
16842 (goto-char end))
16843 (delete-region beg end)
16844 (insert (org-add-props link
16845 (list 'org-latex-src
16846 (replace-regexp-in-string
16848 'org-latex-src-embed-type
16849 (if block-type 'paragraph 'character))))))
16850 ((eq processing-type 'mathml)
16851 ;; Process to MathML
16852 (unless executables-checked
16853 (unless (save-match-data (org-format-latex-mathml-available-p))
16854 (error "LaTeX to MathML converter not configured"))
16855 (setq executables-checked t))
16856 (setq txt (match-string n)
16857 beg (match-beginning n) end (match-end n)
16858 cnt (1+ cnt))
16859 (if msg (message msg cnt))
16860 (goto-char beg)
16861 (delete-region beg end)
16862 (insert (org-format-latex-as-mathml
16863 txt block-type prefix dir)))
16864 (t
16865 (error "Unknown conversion type %s for latex fragments"
16866 processing-type)))))))))
16868 (defun org-create-math-formula (latex-frag &optional mathml-file)
16869 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16870 Use `org-latex-to-mathml-convert-command'. If the conversion is
16872 elements otherwise return nil. When MATHML-FILE is specified,
16873 write the results in to that file. When invoked as an
16874 interactive command, prompt for LATEX-FRAG, with initial value
16875 set to the current active region and echo the results for user
16876 inspection."
16877 (interactive (list (let ((frag (when (region-active-p)
16878 (buffer-substring-no-properties
16879 (region-beginning) (region-end)))))
16880 (read-string "LaTeX Fragment: " frag nil frag))))
16881 (unless latex-frag (error "Invalid latex-frag"))
16882 (let* ((tmp-in-file (file-relative-name
16883 (make-temp-name (expand-file-name "ltxmathml-in"))))
16884 (ignore (write-region latex-frag nil tmp-in-file))
16885 (tmp-out-file (file-relative-name
16886 (make-temp-name (expand-file-name "ltxmathml-out"))))
16887 (cmd (format-spec
16888 org-latex-to-mathml-convert-command
16889 `((?j . ,(shell-quote-argument
16890 (expand-file-name org-latex-to-mathml-jar-file)))
16891 (?I . ,(shell-quote-argument tmp-in-file))
16892 (?o . ,(shell-quote-argument tmp-out-file)))))
16893 mathml shell-command-output)
16894 (when (org-called-interactively-p 'any)
16895 (unless (org-format-latex-mathml-available-p)
16896 (error "LaTeX to MathML converter not configured")))
16897 (message "Running %s" cmd)
16898 (setq shell-command-output (shell-command-to-string cmd))
16899 (setq mathml
16900 (when (file-readable-p tmp-out-file)
16901 (with-current-buffer (find-file-noselect tmp-out-file t)
16902 (goto-char (point-min))
16903 (when (re-search-forward
16904 (concat
16905 (regexp-quote
16908 (regexp-quote "</math>")) nil t)
16909 (prog1 (match-string 0) (kill-buffer))))))
16910 (cond
16911 (mathml
16912 (setq mathml
16914 (when mathml-file
16915 (write-region mathml nil mathml-file))
16916 (when (org-called-interactively-p 'any)
16917 (message mathml)))
16918 ((message "LaTeX to MathML conversion failed")
16919 (message shell-command-output)))
16920 (delete-file tmp-in-file)
16921 (when (file-exists-p tmp-out-file)
16922 (delete-file tmp-out-file))
16923 mathml))
16925 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16926 prefix &optional dir)
16927 "Use `org-create-math-formula' but check local cache first."
16928 (let* ((absprefix (expand-file-name prefix dir))
16929 (print-length nil) (print-level nil)
16930 (formula-id (concat
16931 "formula-"
16932 (sha1
16933 (prin1-to-string
16934 (list latex-frag
16935 org-latex-to-mathml-convert-command)))))
16936 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16937 (formula-cache-dir (file-name-directory formula-cache)))
16939 (unless (file-directory-p formula-cache-dir)
16940 (make-directory formula-cache-dir t))
16942 (unless (file-exists-p formula-cache)
16943 (org-create-math-formula latex-frag formula-cache))
16945 (if (file-exists-p formula-cache)
16946 ;; Successful conversion. Return the link to MathML file.
16947 (org-add-props
16948 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16950 'org-latex-src-embed-type (if latex-frag-type
16951 'paragraph 'character)))
16952 ;; Failed conversion. Return the LaTeX fragment verbatim
16953 (add-text-properties
16954 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16955 latex-frag)))
16957 ;; This function borrows from Ganesh Swami's latex2png.el
16958 (defun org-create-formula-image (string tofile options buffer)
16959 "This calls dvipng."
16960 (require 'org-latex)
16961 (let* ((tmpdir (if (featurep 'xemacs)
16962 (temp-directory)
16963 temporary-file-directory))
16964 (texfilebase (make-temp-name
16965 (expand-file-name "orgtex" tmpdir)))
16966 (texfile (concat texfilebase ".tex"))
16967 (dvifile (concat texfilebase ".dvi"))
16968 (pngfile (concat texfilebase ".png"))
16969 (fnh (if (featurep 'xemacs)
16970 (font-height (get-face-font 'default))
16971 (face-attribute 'default :height nil)))
16972 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16973 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16974 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16975 "Black"))
16976 (bg (or (plist-get options (if buffer :background :html-background))
16977 "Transparent")))
16978 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16979 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16980 (with-temp-file texfile
16981 (insert (org-splice-latex-header
16982 org-format-latex-header
16983 org-export-latex-default-packages-alist
16984 org-export-latex-packages-alist t
16985 org-format-latex-header-extra))
16987 (require 'org-latex)
16988 (org-export-latex-fix-inputenc))
16989 (let ((dir default-directory))
16990 (condition-case nil
16991 (progn
16992 (cd tmpdir)
16993 (call-process "latex" nil nil nil texfile))
16994 (error nil))
16995 (cd dir))
16996 (if (not (file-exists-p dvifile))
16997 (progn (message "Failed to create dvi file from %s" texfile) nil)
16998 (condition-case nil
16999 (call-process "dvipng" nil nil nil
17000 "-fg" fg "-bg" bg
17001 "-D" dpi
17002 ;;"-x" scale "-y" scale
17003 "-T" "tight"
17004 "-o" pngfile
17005 dvifile)
17006 (error nil))
17007 (if (not (file-exists-p pngfile))
17008 (if org-format-latex-signal-error
17009 (error "Failed to create png file from %s" texfile)
17010 (message "Failed to create png file from %s" texfile)
17011 nil)
17012 ;; Use the requested file name and clean up
17013 (copy-file pngfile tofile 'replace)
17014 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17015 (delete-file (concat texfilebase e)))
17016 pngfile))))
17018 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17019 "Fill a LaTeX header template TPL.
17020 In the template, the following place holders will be recognized:
17023 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17025 [NO-PACKAGES] do not include PKG
17026 [EXTRA] the string EXTRA
17027 [NO-EXTRA] do not include EXTRA
17029 For backward compatibility, if both the positive and the negative place
17031 assumed to be present at the end of the template.
17032 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17033 EXTRA is a string.
17034 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17035 (let (rpl (end ""))
17037 (setq rpl (if (or (match-end 1) (not def-pkg))
17038 "" (org-latex-packages-to-string def-pkg snippets-p t))
17039 tpl (replace-match rpl t t tpl))
17040 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17043 (setq rpl (if (or (match-end 1) (not pkg))
17044 "" (org-latex-packages-to-string pkg snippets-p t))
17045 tpl (replace-match rpl t t tpl))
17046 (if pkg (setq end
17048 (org-latex-packages-to-string pkg snippets-p)))))
17051 (setq rpl (if (or (match-end 1) (not extra))
17053 tpl (replace-match rpl t t tpl))
17059 tpl)))
17061 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17063 (setq pkg (mapconcat (lambda(p)
17064 (cond
17065 ((stringp p) p)
17066 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17067 (format "%% Package %s omitted" (cadr p)))
17068 ((equal "" (car p))
17070 (t
17072 (car p) (cadr p)))))
17073 pkg
17077 (defun org-dvipng-color (attr)
17078 "Return an rgb color specification for dvipng."
17079 (apply 'format "rgb %s %s %s"
17080 (mapcar 'org-normalize-color
17081 (color-values (face-attribute 'default attr nil)))))
17083 (defun org-normalize-color (value)
17084 "Return string to be used as color value for an RGB component."
17085 (format "%g" (/ value 65535.0)))
17087 ;; Image display
17090 (defvar org-inline-image-overlays nil)
17091 (make-variable-buffer-local 'org-inline-image-overlays)
17093 (defun org-toggle-inline-images (&optional include-linked)
17094 "Toggle the display of inline images.
17095 INCLUDE-LINKED is passed to `org-display-inline-images'."
17096 (interactive "P")
17097 (if org-inline-image-overlays
17098 (progn
17099 (org-remove-inline-images)
17100 (message "Inline image display turned off"))
17101 (org-display-inline-images include-linked)
17102 (if org-inline-image-overlays
17103 (message "%d images displayed inline"
17104 (length org-inline-image-overlays))
17105 (message "No images to display inline"))))
17107 (defun org-display-inline-images (&optional include-linked refresh beg end)
17108 "Display inline images.
17109 Normally only links without a description part are inlined, because this
17110 is how it will work for export. When INCLUDE-LINKED is set, also links
17111 with a description part will be inlined. This can be nice for a quick
17112 look at those images, but it does not reflect what exported files will look
17113 like.
17114 When REFRESH is set, refresh existing images between BEG and END.
17115 This will create new image displays only if necessary.
17116 BEG and END default to the buffer boundaries."
17117 (interactive "P")
17118 (unless refresh
17119 (org-remove-inline-images)
17120 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17121 (save-excursion
17122 (save-restriction
17123 (widen)
17124 (setq beg (or beg (point-min)) end (or end (point-max)))
17125 (goto-char (point-min))
17127 (substring (org-image-file-name-regexp) 0 -2)
17129 old file ov img)
17130 (while (re-search-forward re end t)
17131 (setq old (get-char-property-and-overlay (match-beginning 1)
17132 'org-image-overlay))
17133 (setq file (expand-file-name
17134 (concat (or (match-string 3) "") (match-string 4))))
17135 (when (file-exists-p file)
17136 (if (and (car-safe old) refresh)
17137 (image-refresh (overlay-get (cdr old) 'display))
17138 (setq img (save-match-data (create-image file)))
17139 (when img
17140 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17141 (overlay-put ov 'display img)
17142 (overlay-put ov 'face 'default)
17143 (overlay-put ov 'org-image-overlay t)
17144 (overlay-put ov 'modification-hooks
17145 (list 'org-display-inline-modification-hook))
17146 (push ov org-inline-image-overlays)))))))))
17148 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17149 "Remove inline-display overlay if a corresponding region is modified."
17150 (let ((inhibit-modification-hooks t))
17151 (when (and ov after)
17152 (delete ov org-inline-image-overlays)
17153 (delete-overlay ov))))
17155 (defun org-remove-inline-images ()
17156 "Remove inline display of images."
17157 (interactive)
17158 (mapc 'delete-overlay org-inline-image-overlays)
17159 (setq org-inline-image-overlays nil))
17161 ;;;; Key bindings
17163 ;; Outline functions from `outline-mode-prefix-map'
17164 ;; that can be remapped in Org:
17165 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17166 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17167 (define-key org-mode-map [remap outline-forward-same-level]
17168 'org-forward-same-level)
17169 (define-key org-mode-map [remap outline-backward-same-level]
17170 'org-backward-same-level)
17171 (define-key org-mode-map [remap show-branches]
17172 'org-kill-note-or-show-branches)
17173 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17174 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17175 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17177 ;; Outline functions from `outline-mode-prefix-map'
17178 ;; that can not be remapped in Org:
17179 ;; - the column "key binding" shows whether the Outline function is still
17180 ;; available in Org mode on the same key that it has been bound to in
17181 ;; Outline mode:
17182 ;; - "overridden": key used for a different functionality in Org mode
17183 ;; - else: key still bound to the same Outline function in Org mode
17184 ;; | Outline function | key binding | Org replacement |
17185 ;; |------------------------------------+-------------+-----------------------|
17186 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17187 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17188 ;; | `show-children' | `C-c C-i' | visibility cycling |
17189 ;; | `hide-subtree' | overridden | visibility cycling |
17190 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17191 ;; | `hide-body' | overridden | no replacement |
17192 ;; | `show-all' | overridden | no replacement |
17193 ;; | `hide-entry' | overridden | visibility cycling |
17194 ;; | `show-entry' | overridden | no replacement |
17195 ;; | `hide-leaves' | overridden | no replacement |
17196 ;; | `hide-sublevels' | overridden | no replacement |
17197 ;; | `hide-other' | overridden | no replacement |
17198 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17199 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17201 ;; Make `C-c C-x' a prefix key
17202 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17204 ;; TAB key with modifiers
17205 (org-defkey org-mode-map "\C-i" 'org-cycle)
17206 (org-defkey org-mode-map [(tab)] 'org-cycle)
17207 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17208 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17210 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17211 ;; The following line is necessary under Suse GNU/Linux
17212 (unless (featurep 'xemacs)
17213 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17214 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17215 (define-key org-mode-map [backtab] 'org-shifttab)
17217 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17218 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17219 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17221 ;; Cursor keys with modifiers
17222 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17223 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17224 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17225 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17227 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17228 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17229 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17230 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17232 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17233 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17234 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17235 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17237 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17238 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17239 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17240 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17242 ;; Babel keys
17243 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17244 (mapc (lambda (pair)
17245 (define-key org-babel-map (car pair) (cdr pair)))
17246 org-babel-key-bindings)
17248 ;;; Extra keys for tty access.
17249 ;; We only set them when really needed because otherwise the
17250 ;; menus don't show the simple keys
17252 (when (or org-use-extra-keys
17253 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17254 (not window-system))
17255 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17256 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17257 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17258 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17259 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17260 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17261 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17262 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17263 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17264 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17265 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17266 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17267 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17268 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17269 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17270 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17271 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17272 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17273 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17274 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17275 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17276 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17277 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17278 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17279 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17280 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17281 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17282 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17284 ;; All the other keys
17286 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17287 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17288 (if (boundp 'narrow-map)
17289 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17290 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17291 (if (boundp 'narrow-map)
17292 (org-defkey narrow-map "b" 'org-narrow-to-block)
17293 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17294 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17295 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17296 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17297 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17298 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17299 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17300 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17301 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17302 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17303 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17304 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17305 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17306 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17307 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17308 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17309 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17311 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17312 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17313 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17314 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17315 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17316 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17317 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17318 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17319 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17320 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17321 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17322 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17323 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17324 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17325 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17326 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17327 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17328 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17329 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17330 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17332 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17333 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17334 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17335 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17336 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17337 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17338 (org-defkey org-mode-map "\C-c^" 'org-sort)
17339 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17340 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17341 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17342 (org-defkey org-mode-map "\C-m" 'org-return)
17343 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17344 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17345 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17346 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17347 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17348 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17349 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17350 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17351 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17352 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17353 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17354 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17355 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17356 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17357 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17358 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17359 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17360 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17361 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17362 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17363 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17364 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17366 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17367 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17368 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17369 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17371 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17372 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17373 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17374 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17375 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17376 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17377 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17378 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17379 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17380 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17382 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17383 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17384 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17385 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17386 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17387 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17388 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17390 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17391 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17392 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17393 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17394 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17396 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17398 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17400 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17401 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17403 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17406 (when (featurep 'xemacs)
17407 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17410 (defconst org-speed-commands-default
17411 '(
17412 ("Outline Navigation")
17413 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17414 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17415 ("f" . (org-speed-move-safe 'org-forward-same-level))
17416 ("b" . (org-speed-move-safe 'org-backward-same-level))
17417 ("u" . (org-speed-move-safe 'outline-up-heading))
17418 ("j" . org-goto)
17419 ("g" . (org-refile t))
17420 ("Outline Visibility")
17421 ("c" . org-cycle)
17422 ("C" . org-shifttab)
17423 (" " . org-display-outline-path)
17424 ("Outline Structure Editing")
17425 ("U" . org-shiftmetaup)
17426 ("D" . org-shiftmetadown)
17427 ("r" . org-metaright)
17428 ("l" . org-metaleft)
17429 ("R" . org-shiftmetaright)
17430 ("L" . org-shiftmetaleft)
17431 ("i" . (progn (forward-char 1) (call-interactively
17432 'org-insert-heading-respect-content)))
17433 ("^" . org-sort)
17434 ("w" . org-refile)
17435 ("a" . org-archive-subtree-default-with-confirmation)
17436 ("." . org-mark-subtree)
17437 ("Clock Commands")
17438 ("I" . org-clock-in)
17439 ("O" . org-clock-out)
17440 ("Meta Data Editing")
17441 ("t" . org-todo)
17442 ("0" . (org-priority ?\ ))
17443 ("1" . (org-priority ?A))
17444 ("2" . (org-priority ?B))
17445 ("3" . (org-priority ?C))
17446 (";" . org-set-tags-command)
17447 ("e" . org-set-effort)
17448 ("Agenda Views etc")
17449 ("v" . org-agenda)
17450 ("/" . org-sparse-tree)
17451 ("Misc")
17452 ("o" . org-open-at-point)
17453 ("?" . org-speed-command-help)
17454 ("<" . (org-agenda-set-restriction-lock 'subtree))
17455 (">" . (org-agenda-remove-restriction-lock))
17456 )
17457 "The default speed commands.")
17459 (defun org-print-speed-command (e)
17460 (if (> (length (car e)) 1)
17461 (progn
17463 (princ (car e))
17465 (princ (make-string (length (car e)) ?-))
17467 (princ (car e))
17468 (princ " ")
17469 (if (symbolp (cdr e))
17470 (princ (symbol-name (cdr e)))
17471 (prin1 (cdr e)))
17474 (defun org-speed-command-help ()
17475 "Show the available speed commands."
17476 (interactive)
17477 (if (not org-use-speed-commands)
17478 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17479 (with-output-to-temp-buffer "*Help*"
17481 (mapc 'org-print-speed-command org-speed-commands-user)
17484 (mapc 'org-print-speed-command org-speed-commands-default))
17485 (with-current-buffer "*Help*"
17486 (setq truncate-lines t))))
17488 (defun org-speed-move-safe (cmd)
17489 "Execute CMD, but make sure that the cursor always ends up in a headline.
17490 If not, return to the original position and throw an error."
17491 (interactive)
17492 (let ((pos (point)))
17493 (call-interactively cmd)
17494 (unless (and (bolp) (org-at-heading-p))
17495 (goto-char pos)
17496 (error "Boundary reached while executing %s" cmd))))
17498 (defvar org-self-insert-command-undo-counter 0)
17500 (defvar org-table-auto-blank-field) ; defined in org-table.el
17501 (defvar org-speed-command nil)
17503 (defun org-speed-command-default-hook (keys)
17504 "Hook for activating single-letter speed commands.
17505 `org-speed-commands-default' specifies a minimal command set.
17506 Use `org-speed-commands-user' for further customization."
17507 (when (or (and (bolp) (looking-at org-outline-regexp))
17508 (and (functionp org-use-speed-commands)
17509 (funcall org-use-speed-commands)))
17510 (cdr (assoc keys (append org-speed-commands-user
17511 org-speed-commands-default)))))
17513 (defun org-babel-speed-command-hook (keys)
17514 "Hook for activating single-letter code block commands."
17515 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17516 (cdr (assoc keys org-babel-key-bindings))))
17518 (defcustom org-speed-command-hook
17519 '(org-speed-command-default-hook org-babel-speed-command-hook)
17520 "Hook for activating speed commands at strategic locations.
17521 Hook functions are called in sequence until a valid handler is
17522 found.
17524 Each hook takes a single argument, a user-pressed command key
17525 which is also a `self-insert-command' from the global map.
17527 Within the hook, examine the cursor position and the command key
17528 and return nil or a valid handler as appropriate. Handler could
17529 be one of an interactive command, a function, or a form.
17531 Set `org-use-speed-commands' to non-nil value to enable this
17532 hook. The default setting is `org-speed-command-default-hook'."
17533 :group 'org-structure
17534 :type 'hook)
17536 (defun org-self-insert-command (N)
17537 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17538 If the cursor is in a table looking at whitespace, the whitespace is
17539 overwritten, and the table is not marked as requiring realignment."
17540 (interactive "p")
17541 (org-check-before-invisible-edit 'insert)
17542 (cond
17543 ((and org-use-speed-commands
17544 (setq org-speed-command
17545 (run-hook-with-args-until-success
17546 'org-speed-command-hook (this-command-keys))))
17547 (cond
17548 ((commandp org-speed-command)
17549 (setq this-command org-speed-command)
17550 (call-interactively org-speed-command))
17551 ((functionp org-speed-command)
17552 (funcall org-speed-command))
17553 ((and org-speed-command (listp org-speed-command))
17554 (eval org-speed-command))
17555 (t (let (org-use-speed-commands)
17556 (call-interactively 'org-self-insert-command)))))
17557 ((and
17558 (org-table-p)
17559 (progn
17560 ;; check if we blank the field, and if that triggers align
17561 (and (featurep 'org-table) org-table-auto-blank-field
17562 (member last-command
17563 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17565 ;; got extra space, this field does not determine column width
17566 (let (org-table-may-need-update) (org-table-blank-field))
17567 ;; no extra space, this field may determine column width
17568 (org-table-blank-field)))
17569 t)
17570 (eq N 1)
17572 (let (org-table-may-need-update)
17573 (goto-char (1- (match-end 0)))
17574 (delete-char -1)
17575 (goto-char (match-beginning 0))
17576 (self-insert-command N)))
17577 (t
17578 (setq org-table-may-need-update t)
17579 (self-insert-command N)
17580 (org-fix-tags-on-the-fly)
17581 (if org-self-insert-cluster-for-undo
17582 (if (not (eq last-command 'org-self-insert-command))
17583 (setq org-self-insert-command-undo-counter 1)
17584 (if (>= org-self-insert-command-undo-counter 20)
17585 (setq org-self-insert-command-undo-counter 1)
17586 (and (> org-self-insert-command-undo-counter 0)
17587 buffer-undo-list (listp buffer-undo-list)
17588 (not (cadr buffer-undo-list)) ; remove nil entry
17589 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17590 (setq org-self-insert-command-undo-counter
17591 (1+ org-self-insert-command-undo-counter))))))))
17593 (defun org-check-before-invisible-edit (kind)
17594 "Check is editing if kind KIND would be dangerous with invisible text around.
17595 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17596 ;; First, try to get out of here as quickly as possible, to reduce overhead
17597 (if (and org-catch-invisible-edits
17598 (or (not (boundp 'visible-mode)) (not visible-mode))
17599 (or (get-char-property (point) 'invisible)
17600 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17601 ;; OK, we need to take a closer look
17602 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17603 (invisible-before-point (if (bobp) nil (get-char-property
17604 (1- (point)) 'invisible)))
17605 (border-and-ok-direction
17606 (or
17607 ;; Check if we are acting predictably before invisible text
17608 (and invisible-at-point (not invisible-before-point)
17609 (memq kind '(insert delete-backward)))
17610 ;; Check if we are acting predictably after invisible text
17611 ;; This works not well, and I have turned it off. It seems
17612 ;; better to always show and stop after invisible text.
17613 ;; (and (not invisible-at-point) invisible-before-point
17614 ;; (memq kind '(insert delete)))
17615 )))
17617 (when (or (memq invisible-at-point '(outline org-hide-block))
17618 (memq invisible-before-point '(outline org-hide-block)))
17619 (if (eq org-catch-invisible-edits 'error)
17620 (error "Editing in invisible areas is prohibited - make visible first"))
17621 ;; Make the area visible
17622 (save-excursion
17623 (if invisible-before-point
17624 (goto-char (previous-single-char-property-change
17625 (point) 'invisible)))
17626 (org-cycle))
17627 (cond
17628 ((eq org-catch-invisible-edits 'show)
17629 ;; That's it, we do the edit after showing
17630 (message
17631 "Unfolding invisible region around point before editing")
17632 (sit-for 1))
17633 ((and (eq org-catch-invisible-edits 'smart)
17634 border-and-ok-direction)
17635 (message "Unfolding invisible region around point before editing"))
17636 (t
17637 ;; Don't do the edit, make the user repeat it in full visibility
17638 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17640 (defun org-fix-tags-on-the-fly ()
17641 (when (and (equal (char-after (point-at-bol)) ?*)
17642 (org-at-heading-p))
17643 (org-align-tags-here org-tags-column)))
17645 (defun org-delete-backward-char (N)
17646 "Like `delete-backward-char', insert whitespace at field end in tables.
17647 When deleting backwards, in tables this function will insert whitespace in
17649 still be marked for re-alignment if the field did fill the entire column,
17650 because, in this case the deletion might narrow the column."
17651 (interactive "p")
17652 (org-check-before-invisible-edit 'delete-backward)
17653 (if (and (org-table-p)
17654 (eq N 1)
17655 (string-match "|" (buffer-substring (point-at-bol) (point)))
17656 (looking-at ".*?|"))
17657 (let ((pos (point))
17659 (c org-table-may-need-update))
17660 (backward-delete-char N)
17661 (if (not overwrite-mode)
17662 (progn
17663 (skip-chars-forward "^|")
17664 (insert " ")
17665 (goto-char (1- pos))))
17666 ;; noalign: if there were two spaces at the end, this field
17667 ;; does not determine the width of the column.
17668 (if noalign (setq org-table-may-need-update c)))
17669 (backward-delete-char N)
17670 (org-fix-tags-on-the-fly)))
17672 (defun org-delete-char (N)
17673 "Like `delete-char', but insert whitespace at field end in tables.
17674 When deleting characters, in tables this function will insert whitespace in
17676 still be marked for re-alignment if the field did fill the entire column,
17677 because, in this case the deletion might narrow the column."
17678 (interactive "p")
17679 (org-check-before-invisible-edit 'delete)
17680 (if (and (org-table-p)
17681 (not (bolp))
17682 (not (= (char-after) ?|))
17683 (eq N 1))
17684 (if (looking-at ".*?|")
17685 (let ((pos (point))
17687 (c org-table-may-need-update))
17688 (replace-match (concat
17689 (substring (match-string 0) 1 -1)
17690 " |"))
17691 (goto-char pos)
17692 ;; noalign: if there were two spaces at the end, this field
17693 ;; does not determine the width of the column.
17694 (if noalign (setq org-table-may-need-update c)))
17695 (delete-char N))
17696 (delete-char N)
17697 (org-fix-tags-on-the-fly)))
17699 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17700 (put 'org-self-insert-command 'delete-selection t)
17701 (put 'orgtbl-self-insert-command 'delete-selection t)
17702 (put 'org-delete-char 'delete-selection 'supersede)
17703 (put 'org-delete-backward-char 'delete-selection 'supersede)
17704 (put 'org-yank 'delete-selection 'yank)
17706 ;; Make `flyspell-mode' delay after some commands
17707 (put 'org-self-insert-command 'flyspell-delayed t)
17708 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17709 (put 'org-delete-char 'flyspell-delayed t)
17710 (put 'org-delete-backward-char 'flyspell-delayed t)
17712 ;; Make pabbrev-mode expand after org-mode commands
17713 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17714 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17716 ;; How to do this: Measure non-white length of current string
17717 ;; If equal to column width, we should realign.
17719 (defun org-remap (map &rest commands)
17720 "In MAP, remap the functions given in COMMANDS.
17721 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17722 (let (new old)
17723 (while commands
17724 (setq old (pop commands) new (pop commands))
17725 (if (fboundp 'command-remapping)
17726 (org-defkey map (vector 'remap old) new)
17727 (substitute-key-definition old new map global-map)))))
17729 (when (eq org-enable-table-editor 'optimized)
17730 ;; If the user wants maximum table support, we need to hijack
17731 ;; some standard editing functions
17732 (org-remap org-mode-map
17733 'self-insert-command 'org-self-insert-command
17734 'delete-char 'org-delete-char
17735 'delete-backward-char 'org-delete-backward-char)
17736 (org-defkey org-mode-map "|" 'org-force-self-insert))
17738 (defvar org-ctrl-c-ctrl-c-hook nil
17739 "Hook for functions attaching themselves to `C-c C-c'.
17741 This can be used to add additional functionality to the C-c C-c
17742 key which executes context-dependent commands. This hook is run
17743 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17744 run after the last test.
17746 Each function will be called with no arguments. The function
17747 must check if the context is appropriate for it to act. If yes,
17748 it should do its thing and then return a non-nil value. If the
17749 context is wrong, just do nothing and return nil.")
17751 (defvar org-ctrl-c-ctrl-c-final-hook nil
17752 "Hook for functions attaching themselves to `C-c C-c'.
17754 This can be used to add additional functionality to the C-c C-c
17755 key which executes context-dependent commands. This hook is run
17756 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17757 before the first test.
17759 Each function will be called with no arguments. The function
17760 must check if the context is appropriate for it to act. If yes,
17761 it should do its thing and then return a non-nil value. If the
17762 context is wrong, just do nothing and return nil.")
17764 (defvar org-tab-first-hook nil
17765 "Hook for functions to attach themselves to TAB.
17766 See `org-ctrl-c-ctrl-c-hook' for more information.
17767 This hook runs as the first action when TAB is pressed, even before
17768 `org-cycle' messes around with the `outline-regexp' to cater for
17769 inline tasks and plain list item folding.
17770 If any function in this hook returns t, any other actions that
17771 would have been caused by TAB (such as table field motion or visibility
17772 cycling) will not occur.")
17774 (defvar org-tab-after-check-for-table-hook nil
17775 "Hook for functions to attach themselves to TAB.
17776 See `org-ctrl-c-ctrl-c-hook' for more information.
17777 This hook runs after it has been established that the cursor is not in a
17778 table, but before checking if the cursor is in a headline or if global cycling
17779 should be done.
17780 If any function in this hook returns t, not other actions like visibility
17781 cycling will be done.")
17783 (defvar org-tab-after-check-for-cycling-hook nil
17784 "Hook for functions to attach themselves to TAB.
17785 See `org-ctrl-c-ctrl-c-hook' for more information.
17786 This hook runs after it has been established that not table field motion and
17787 not visibility should be done because of current context. This is probably
17788 the place where a package like yasnippets can hook in.")
17790 (defvar org-tab-before-tab-emulation-hook nil
17791 "Hook for functions to attach themselves to TAB.
17792 See `org-ctrl-c-ctrl-c-hook' for more information.
17793 This hook runs after every other options for TAB have been exhausted, but
17796 (defvar org-metaleft-hook nil
17797 "Hook for functions attaching themselves to `M-left'.
17798 See `org-ctrl-c-ctrl-c-hook' for more information.")
17799 (defvar org-metaright-hook nil
17800 "Hook for functions attaching themselves to `M-right'.
17801 See `org-ctrl-c-ctrl-c-hook' for more information.")
17802 (defvar org-metaup-hook nil
17803 "Hook for functions attaching themselves to `M-up'.
17804 See `org-ctrl-c-ctrl-c-hook' for more information.")
17805 (defvar org-metadown-hook nil
17806 "Hook for functions attaching themselves to `M-down'.
17807 See `org-ctrl-c-ctrl-c-hook' for more information.")
17808 (defvar org-shiftmetaleft-hook nil
17809 "Hook for functions attaching themselves to `M-S-left'.
17810 See `org-ctrl-c-ctrl-c-hook' for more information.")
17811 (defvar org-shiftmetaright-hook nil
17812 "Hook for functions attaching themselves to `M-S-right'.
17813 See `org-ctrl-c-ctrl-c-hook' for more information.")
17814 (defvar org-shiftmetaup-hook nil
17815 "Hook for functions attaching themselves to `M-S-up'.
17816 See `org-ctrl-c-ctrl-c-hook' for more information.")
17817 (defvar org-shiftmetadown-hook nil
17818 "Hook for functions attaching themselves to `M-S-down'.
17819 See `org-ctrl-c-ctrl-c-hook' for more information.")
17820 (defvar org-metareturn-hook nil
17821 "Hook for functions attaching themselves to `M-RET'.
17822 See `org-ctrl-c-ctrl-c-hook' for more information.")
17823 (defvar org-shiftup-hook nil
17824 "Hook for functions attaching themselves to `S-up'.
17825 See `org-ctrl-c-ctrl-c-hook' for more information.")
17826 (defvar org-shiftup-final-hook nil
17827 "Hook for functions attaching themselves to `S-up'.
17828 This one runs after all other options except shift-select have been excluded.
17829 See `org-ctrl-c-ctrl-c-hook' for more information.")
17830 (defvar org-shiftdown-hook nil
17831 "Hook for functions attaching themselves to `S-down'.
17832 See `org-ctrl-c-ctrl-c-hook' for more information.")
17833 (defvar org-shiftdown-final-hook nil
17834 "Hook for functions attaching themselves to `S-down'.
17835 This one runs after all other options except shift-select have been excluded.
17836 See `org-ctrl-c-ctrl-c-hook' for more information.")
17837 (defvar org-shiftleft-hook nil
17838 "Hook for functions attaching themselves to `S-left'.
17839 See `org-ctrl-c-ctrl-c-hook' for more information.")
17840 (defvar org-shiftleft-final-hook nil
17841 "Hook for functions attaching themselves to `S-left'.
17842 This one runs after all other options except shift-select have been excluded.
17843 See `org-ctrl-c-ctrl-c-hook' for more information.")
17844 (defvar org-shiftright-hook nil
17845 "Hook for functions attaching themselves to `S-right'.
17846 See `org-ctrl-c-ctrl-c-hook' for more information.")
17847 (defvar org-shiftright-final-hook nil
17848 "Hook for functions attaching themselves to `S-right'.
17849 This one runs after all other options except shift-select have been excluded.
17850 See `org-ctrl-c-ctrl-c-hook' for more information.")
17852 (defun org-modifier-cursor-error ()
17853 "Throw an error, a modified cursor command was applied in wrong context."
17854 (error "This command is active in special context like tables, headlines or items"))
17856 (defun org-shiftselect-error ()
17857 "Throw an error because Shift-Cursor command was applied in wrong context."
17858 (if (and (boundp 'shift-select-mode) shift-select-mode)
17859 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17860 (error "This command works only in special context like headlines or timestamps")))
17862 (defun org-call-for-shift-select (cmd)
17863 (let ((this-command-keys-shift-translated t))
17864 (call-interactively cmd)))
17866 (defun org-shifttab (&optional arg)
17867 "Global visibility cycling or move to previous table field.
17868 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17869 on context.
17870 See the individual commands for more information."
17871 (interactive "P")
17872 (cond
17873 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17874 ((integerp arg)
17875 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17876 (message "Content view to level: %d" arg)
17877 (org-content (prefix-numeric-value arg2))
17878 (setq org-cycle-global-status 'overview)))
17879 (t (call-interactively 'org-global-cycle))))
17881 (defun org-shiftmetaleft ()
17882 "Promote subtree or delete table column.
17883 Calls `org-promote-subtree', `org-outdent-item',
17884 or `org-table-delete-column', depending on context.
17885 See the individual commands for more information."
17886 (interactive)
17887 (cond
17888 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17889 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17890 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17891 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17892 (t (org-modifier-cursor-error))))
17894 (defun org-shiftmetaright ()
17895 "Demote subtree or insert table column.
17896 Calls `org-demote-subtree', `org-indent-item',
17897 or `org-table-insert-column', depending on context.
17898 See the individual commands for more information."
17899 (interactive)
17900 (cond
17901 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17902 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17903 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17904 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17905 (t (org-modifier-cursor-error))))
17907 (defun org-shiftmetaup (&optional arg)
17908 "Move subtree up or kill table row.
17909 Calls `org-move-subtree-up' or `org-table-kill-row' or
17910 `org-move-item-up' depending on context. See the individual commands
17911 for more information."
17912 (interactive "P")
17913 (cond
17914 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17915 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17916 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17917 ((org-at-item-p) (call-interactively 'org-move-item-up))
17918 (t (org-modifier-cursor-error))))
17920 (defun org-shiftmetadown (&optional arg)
17921 "Move subtree down or insert table row.
17922 Calls `org-move-subtree-down' or `org-table-insert-row' or
17923 `org-move-item-down', depending on context. See the individual
17924 commands for more information."
17925 (interactive "P")
17926 (cond
17927 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17928 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17929 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17930 ((org-at-item-p) (call-interactively 'org-move-item-down))
17931 (t (org-modifier-cursor-error))))
17933 (defsubst org-hidden-tree-error ()
17934 (error
17935 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17937 (defun org-metaleft (&optional arg)
17938 "Promote heading or move table column to left.
17939 Calls `org-do-promote' or `org-table-move-column', depending on context.
17940 With no specific context, calls the Emacs default `backward-word'.
17941 See the individual commands for more information."
17942 (interactive "P")
17943 (cond
17944 ((run-hook-with-args-until-success 'org-metaleft-hook))
17945 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17946 ((org-with-limited-levels
17947 (or (org-at-heading-p)
17948 (and (org-region-active-p)
17949 (save-excursion
17950 (goto-char (region-beginning))
17951 (org-at-heading-p)))))
17952 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17953 (call-interactively 'org-do-promote))
17954 ;; At an inline task.
17955 ((org-at-heading-p)
17956 (call-interactively 'org-inlinetask-promote))
17957 ((or (org-at-item-p)
17958 (and (org-region-active-p)
17959 (save-excursion
17960 (goto-char (region-beginning))
17961 (org-at-item-p))))
17962 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17963 (call-interactively 'org-outdent-item))
17964 (t (call-interactively 'backward-word))))
17966 (defun org-metaright (&optional arg)
17967 "Demote subtree or move table column to right.
17968 Calls `org-do-demote' or `org-table-move-column', depending on context.
17969 With no specific context, calls the Emacs default `forward-word'.
17970 See the individual commands for more information."
17971 (interactive "P")
17972 (cond
17973 ((run-hook-with-args-until-success 'org-metaright-hook))
17974 ((org-at-table-p) (call-interactively 'org-table-move-column))
17975 ((org-with-limited-levels
17976 (or (org-at-heading-p)
17977 (and (org-region-active-p)
17978 (save-excursion
17979 (goto-char (region-beginning))
17980 (org-at-heading-p)))))
17981 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17982 (call-interactively 'org-do-demote))
17983 ;; At an inline task.
17984 ((org-at-heading-p)
17985 (call-interactively 'org-inlinetask-demote))
17986 ((or (org-at-item-p)
17987 (and (org-region-active-p)
17988 (save-excursion
17989 (goto-char (region-beginning))
17990 (org-at-item-p))))
17991 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17992 (call-interactively 'org-indent-item))
17993 (t (call-interactively 'forward-word))))
17995 (defun org-check-for-hidden (what)
17996 "Check if there are hidden headlines/items in the current visual line.
17997 WHAT can be either `headlines' or `items'. If the current line is
17998 an outline or item heading and it has a folded subtree below it,
17999 this function returns t, nil otherwise."
18000 (let ((re (cond
18001 ((eq what 'headlines) org-outline-regexp-bol)
18002 ((eq what 'items) (org-item-beginning-re))
18003 (t (error "This should not happen"))))
18004 beg end)
18005 (save-excursion
18006 (catch 'exit
18007 (unless (org-region-active-p)
18008 (setq beg (point-at-bol))
18009 (beginning-of-line 2)
18010 (while (and (not (eobp)) ;; this is like `next-line'
18011 (get-char-property (1- (point)) 'invisible))
18012 (beginning-of-line 2))
18013 (setq end (point))
18014 (goto-char beg)
18015 (goto-char (point-at-eol))
18016 (setq end (max end (point)))
18017 (while (re-search-forward re end t)
18018 (if (get-char-property (match-beginning 0) 'invisible)
18019 (throw 'exit t))))
18020 nil))))
18022 (defun org-metaup (&optional arg)
18023 "Move subtree up or move table row up.
18024 Calls `org-move-subtree-up' or `org-table-move-row' or
18025 `org-move-item-up', depending on context. See the individual commands
18026 for more information."
18027 (interactive "P")
18028 (cond
18029 ((run-hook-with-args-until-success 'org-metaup-hook))
18030 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18031 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18032 ((org-at-item-p) (call-interactively 'org-move-item-up))
18033 (t (transpose-lines 1) (beginning-of-line -1))))
18035 (defun org-metadown (&optional arg)
18036 "Move subtree down or move table row down.
18037 Calls `org-move-subtree-down' or `org-table-move-row' or
18038 `org-move-item-down', depending on context. See the individual
18039 commands for more information."
18040 (interactive "P")
18041 (cond
18042 ((run-hook-with-args-until-success 'org-metadown-hook))
18043 ((org-at-table-p) (call-interactively 'org-table-move-row))
18044 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18045 ((org-at-item-p) (call-interactively 'org-move-item-down))
18046 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18048 (defun org-shiftup (&optional arg)
18049 "Increase item in timestamp or increase priority of current headline.
18050 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18051 depending on context. See the individual commands for more information."
18052 (interactive "P")
18053 (cond
18054 ((run-hook-with-args-until-success 'org-shiftup-hook))
18055 ((and org-support-shift-select (org-region-active-p))
18056 (org-call-for-shift-select 'previous-line))
18057 ((org-at-timestamp-p t)
18058 (call-interactively (if org-edit-timestamp-down-means-later
18059 'org-timestamp-down 'org-timestamp-up)))
18060 ((and (not (eq org-support-shift-select 'always))
18061 org-enable-priority-commands
18062 (org-at-heading-p))
18063 (call-interactively 'org-priority-up))
18064 ((and (not org-support-shift-select) (org-at-item-p))
18065 (call-interactively 'org-previous-item))
18066 ((org-clocktable-try-shift 'up arg))
18067 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18068 (org-support-shift-select
18069 (org-call-for-shift-select 'previous-line))
18070 (t (org-shiftselect-error))))
18072 (defun org-shiftdown (&optional arg)
18073 "Decrease item in timestamp or decrease priority of current headline.
18074 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18075 depending on context. See the individual commands for more information."
18076 (interactive "P")
18077 (cond
18078 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18079 ((and org-support-shift-select (org-region-active-p))
18080 (org-call-for-shift-select 'next-line))
18081 ((org-at-timestamp-p t)
18082 (call-interactively (if org-edit-timestamp-down-means-later
18083 'org-timestamp-up 'org-timestamp-down)))
18084 ((and (not (eq org-support-shift-select 'always))
18085 org-enable-priority-commands
18086 (org-at-heading-p))
18087 (call-interactively 'org-priority-down))
18088 ((and (not org-support-shift-select) (org-at-item-p))
18089 (call-interactively 'org-next-item))
18090 ((org-clocktable-try-shift 'down arg))
18091 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18092 (org-support-shift-select
18093 (org-call-for-shift-select 'next-line))
18094 (t (org-shiftselect-error))))
18096 (defun org-shiftright (&optional arg)
18097 "Cycle the thing at point or in the current line, depending on context.
18098 Depending on context, this does one of the following:
18100 - switch a timestamp at point one day into the future
18101 - on a headline, switch to the next TODO keyword.
18102 - on an item, switch entire list to the next bullet type
18103 - on a property line, switch to the next allowed value
18104 - on a clocktable definition line, move time block into the future"
18105 (interactive "P")
18106 (cond
18107 ((run-hook-with-args-until-success 'org-shiftright-hook))
18108 ((and org-support-shift-select (org-region-active-p))
18109 (org-call-for-shift-select 'forward-char))
18110 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18111 ((and (not (eq org-support-shift-select 'always))
18112 (org-at-heading-p))
18113 (let ((org-inhibit-logging
18114 (not org-treat-S-cursor-todo-selection-as-state-change))
18115 (org-inhibit-blocking
18116 (not org-treat-S-cursor-todo-selection-as-state-change)))
18117 (org-call-with-arg 'org-todo 'right)))
18118 ((or (and org-support-shift-select
18119 (not (eq org-support-shift-select 'always))
18120 (org-at-item-bullet-p))
18121 (and (not org-support-shift-select) (org-at-item-p)))
18122 (org-call-with-arg 'org-cycle-list-bullet nil))
18123 ((and (not (eq org-support-shift-select 'always))
18124 (org-at-property-p))
18125 (call-interactively 'org-property-next-allowed-value))
18126 ((org-clocktable-try-shift 'right arg))
18127 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18128 (org-support-shift-select
18129 (org-call-for-shift-select 'forward-char))
18130 (t (org-shiftselect-error))))
18132 (defun org-shiftleft (&optional arg)
18133 "Cycle the thing at point or in the current line, depending on context.
18134 Depending on context, this does one of the following:
18136 - switch a timestamp at point one day into the past
18137 - on a headline, switch to the previous TODO keyword.
18138 - on an item, switch entire list to the previous bullet type
18139 - on a property line, switch to the previous allowed value
18140 - on a clocktable definition line, move time block into the past"
18141 (interactive "P")
18142 (cond
18143 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18144 ((and org-support-shift-select (org-region-active-p))
18145 (org-call-for-shift-select 'backward-char))
18146 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18147 ((and (not (eq org-support-shift-select 'always))
18148 (org-at-heading-p))
18149 (let ((org-inhibit-logging
18150 (not org-treat-S-cursor-todo-selection-as-state-change))
18151 (org-inhibit-blocking
18152 (not org-treat-S-cursor-todo-selection-as-state-change)))
18153 (org-call-with-arg 'org-todo 'left)))
18154 ((or (and org-support-shift-select
18155 (not (eq org-support-shift-select 'always))
18156 (org-at-item-bullet-p))
18157 (and (not org-support-shift-select) (org-at-item-p)))
18158 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18159 ((and (not (eq org-support-shift-select 'always))
18160 (org-at-property-p))
18161 (call-interactively 'org-property-previous-allowed-value))
18162 ((org-clocktable-try-shift 'left arg))
18163 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18164 (org-support-shift-select
18165 (org-call-for-shift-select 'backward-char))
18166 (t (org-shiftselect-error))))
18168 (defun org-shiftcontrolright ()
18169 "Switch to next TODO set."
18170 (interactive)
18171 (cond
18172 ((and org-support-shift-select (org-region-active-p))
18173 (org-call-for-shift-select 'forward-word))
18174 ((and (not (eq org-support-shift-select 'always))
18175 (org-at-heading-p))
18176 (org-call-with-arg 'org-todo 'nextset))
18177 (org-support-shift-select
18178 (org-call-for-shift-select 'forward-word))
18179 (t (org-shiftselect-error))))
18181 (defun org-shiftcontrolleft ()
18182 "Switch to previous TODO set."
18183 (interactive)
18184 (cond
18185 ((and org-support-shift-select (org-region-active-p))
18186 (org-call-for-shift-select 'backward-word))
18187 ((and (not (eq org-support-shift-select 'always))
18188 (org-at-heading-p))
18189 (org-call-with-arg 'org-todo 'previousset))
18190 (org-support-shift-select
18191 (org-call-for-shift-select 'backward-word))
18192 (t (org-shiftselect-error))))
18194 (defun org-shiftcontrolup ()
18195 "Change timestamps synchronously up in CLOCK log lines."
18196 (interactive)
18197 (cond ((and (not org-support-shift-select)
18198 (org-at-clock-log-p)
18199 (org-at-timestamp-p t))
18200 (org-clock-timestamps-up))
18201 (t (org-shiftselect-error))))
18203 (defun org-shiftcontroldown ()
18204 "Change timestamps synchronously down in CLOCK log lines."
18205 (interactive)
18206 (cond ((and (not org-support-shift-select)
18207 (org-at-clock-log-p)
18208 (org-at-timestamp-p t))
18209 (org-clock-timestamps-down))
18210 (t (org-shiftselect-error))))
18212 (defun org-ctrl-c-ret ()
18213 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18214 (interactive)
18215 (cond
18216 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18217 (t (call-interactively 'org-insert-heading))))
18219 (defun org-find-visible ()
18220 (let ((s (point)))
18221 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18222 (get-char-property s 'invisible)))
18223 s))
18224 (defun org-find-invisible ()
18225 (let ((s (point)))
18226 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18227 (not (get-char-property s 'invisible))))
18228 s))
18230 (defun org-copy-visible (beg end)
18231 "Copy the visible parts of the region."
18232 (interactive "r")
18233 (let (snippets s)
18234 (save-excursion
18235 (save-restriction
18236 (narrow-to-region beg end)
18237 (setq s (goto-char (point-min)))
18238 (while (not (= (point) (point-max)))
18239 (goto-char (org-find-invisible))
18240 (push (buffer-substring s (point)) snippets)
18241 (setq s (goto-char (org-find-visible))))))
18242 (kill-new (apply 'concat (nreverse snippets)))))
18244 (defun org-copy-special ()
18245 "Copy region in table or copy current subtree.
18246 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18247 See the individual commands for more information."
18248 (interactive)
18249 (call-interactively
18250 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18252 (defun org-cut-special ()
18253 "Cut region in table or cut current subtree.
18254 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18255 See the individual commands for more information."
18256 (interactive)
18257 (call-interactively
18258 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18260 (defun org-paste-special (arg)
18261 "Paste rectangular region into table, or past subtree relative to level.
18262 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18263 See the individual commands for more information."
18264 (interactive "P")
18265 (if (org-at-table-p)
18266 (org-table-paste-rectangle)
18267 (org-paste-subtree arg)))
18269 (defun org-edit-special (&optional arg)
18270 "Call a special editor for the stuff at point.
18271 When at a table, call the formula editor with `org-table-edit-formulas'.
18272 When at the first line of an src example, call `org-edit-src-code'.
18273 When in an #+include line, visit the include file. Otherwise call
18274 `ffap' to visit the file at point."
18275 (interactive)
18276 ;; possibly prep session before editing source
18277 (when arg
18278 (let* ((info (org-babel-get-src-block-info))
18279 (lang (nth 0 info))
18280 (params (nth 2 info))
18281 (session (cdr (assoc :session params))))
18282 (when (and info session) ;; we are in a source-code block with a session
18283 (funcall
18284 (intern (concat "org-babel-prep-session:" lang)) session params))))
18285 (cond ;; proceed with `org-edit-special'
18286 ((save-excursion
18287 (beginning-of-line 1)
18288 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18289 (find-file (org-trim (match-string 1))))
18290 ((org-edit-src-code))
18291 ((org-edit-fixed-width-region))
18292 ((org-at-table.el-p)
18293 (org-edit-src-code))
18294 ((or (org-at-table-p)
18295 (save-excursion
18296 (beginning-of-line 1)
18298 (call-interactively 'org-table-edit-formulas))
18299 (t (call-interactively 'ffap))))
18301 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18302 (defun org-ctrl-c-ctrl-c (&optional arg)
18303 "Set tags in headline, or update according to changed information at point.
18305 This command does many different things, depending on context:
18307 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18308 this is what we do.
18310 - If the cursor is on a statistics cookie, update it.
18312 - If the cursor is in a headline, prompt for tags and insert them
18313 into the current line, aligned to `org-tags-column'. When called
18314 with prefix arg, realign all tags in the current buffer.
18316 - If the cursor is in one of the special #+KEYWORD lines, this
18317 triggers scanning the buffer for these lines and updating the
18318 information.
18320 - If the cursor is inside a table, realign the table. This command
18321 works even if the automatic table editor has been turned off.
18323 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18324 the entire table.
18326 - If the cursor is at a footnote reference or definition, jump to
18327 the corresponding definition or references, respectively.
18329 - If the cursor is a the beginning of a dynamic block, update it.
18331 - If the current buffer is a capture buffer, close note and file it.
18333 - If the cursor is on a <<<target>>>, update radio targets and
18334 corresponding links in this buffer.
18336 - If the cursor is on a numbered item in a plain list, renumber the
18337 ordered list.
18339 - If the cursor is on a checkbox, toggle it.
18341 - If the cursor is on a code block, evaluate it. The variable
18342 `org-confirm-babel-evaluate' can be used to control prompting
18343 before code block evaluation, by default every code block
18344 evaluation requires confirmation. Code block evaluation can be
18345 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18346 (interactive "P")
18347 (let ((org-enable-table-editor t))
18348 (cond
18349 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18350 org-occur-highlights
18351 org-latex-fragment-image-overlays)
18352 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18353 (org-remove-occur-highlights)
18354 (org-remove-latex-fragment-image-overlays)
18355 (message "Temporary highlights/overlays removed from current buffer"))
18356 ((and (local-variable-p 'org-finish-function (current-buffer))
18357 (fboundp org-finish-function))
18358 (funcall org-finish-function))
18359 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18360 ((org-in-regexp org-ts-regexp-both)
18361 (org-timestamp-change 0 'day))
18362 ((or (looking-at org-property-start-re)
18363 (org-at-property-p))
18364 (call-interactively 'org-property-action))
18365 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18367 (or (org-at-heading-p) (org-at-item-p)))
18368 (call-interactively 'org-update-statistics-cookies))
18369 ((org-at-heading-p) (call-interactively 'org-set-tags))
18370 ((org-at-table.el-p)
18371 (message "Use C-c ' to edit table.el tables"))
18372 ((org-at-table-p)
18373 (org-table-maybe-eval-formula)
18374 (if arg
18375 (call-interactively 'org-table-recalculate)
18376 (org-table-maybe-recalculate-line))
18377 (call-interactively 'org-table-align)
18378 (orgtbl-send-table 'maybe))
18379 ((or (org-footnote-at-reference-p)
18380 (org-footnote-at-definition-p))
18381 (call-interactively 'org-footnote-action))
18382 ((org-at-item-checkbox-p)
18383 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18384 ;; list only if at top item.
18385 (let* ((cbox (match-string 1))
18386 (struct (org-list-struct))
18387 (old-struct (copy-tree struct))
18388 (parents (org-list-parents-alist struct))
18389 (orderedp (org-entry-get nil "ORDERED"))
18390 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18391 block-item)
18392 ;; Use a light version of `org-toggle-checkbox' to avoid
18393 ;; computing list structure twice.
18394 (let ((new-box (cond
18395 ((equal arg '(16)) "[-]")
18396 ((equal arg '(4)) nil)
18397 ((equal "[X]" cbox) "[ ]")
18398 (t "[X]"))))
18399 (if (and firstp arg)
18400 ;; If at first item of sub-list, remove check-box from
18401 ;; every item at the same level.
18402 (mapc
18403 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18404 (org-list-get-all-items
18405 (point-at-bol) struct (org-list-prevs-alist struct)))
18406 (org-list-set-checkbox (point-at-bol) struct new-box)))
18407 ;; Replicate `org-list-write-struct', while grabbing a return
18408 ;; value from `org-list-struct-fix-box'.
18409 (org-list-struct-fix-ind struct parents 2)
18410 (org-list-struct-fix-item-end struct)
18411 (let ((prevs (org-list-prevs-alist struct)))
18412 (org-list-struct-fix-bul struct prevs)
18413 (org-list-struct-fix-ind struct parents)
18414 (setq block-item
18415 (org-list-struct-fix-box struct parents prevs orderedp)))
18416 (org-list-struct-apply-struct struct old-struct)
18417 (org-update-checkbox-count-maybe)
18418 (when block-item
18419 (message
18420 "Checkboxes were removed due to unchecked box at line %d"
18421 (org-current-line block-item)))
18422 (when firstp (org-list-send-list 'maybe))))
18423 ((org-at-item-p)
18424 ;; Cursor at an item: repair list. Do checkbox related actions
18425 ;; only if function was called with an argument. Send list only
18426 ;; if at top item.
18427 (let* ((struct (org-list-struct))
18428 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18429 old-struct)
18430 (when arg
18431 (setq old-struct (copy-tree struct))
18432 (if firstp
18433 ;; If at first item of sub-list, add check-box to every
18434 ;; item at the same level.
18435 (mapc
18436 (lambda (pos)
18437 (unless (org-list-get-checkbox pos struct)
18438 (org-list-set-checkbox pos struct "[ ]")))
18439 (org-list-get-all-items
18440 (point-at-bol) struct (org-list-prevs-alist struct)))
18441 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18442 (org-list-write-struct
18443 struct (org-list-parents-alist struct) old-struct)
18444 (when arg (org-update-checkbox-count-maybe))
18445 (when firstp (org-list-send-list 'maybe))))
18446 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18447 ;; Dynamic block
18448 (beginning-of-line 1)
18449 (save-excursion (org-update-dblock)))
18450 ((save-excursion
18451 (beginning-of-line 1)
18453 (cond
18454 ((equal (match-string 1) "TBLFM")
18455 ;; Recalculate the table before this line
18456 (save-excursion
18457 (beginning-of-line 1)
18459 (if (org-at-table-p)
18460 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18461 (t
18462 (let ((org-inhibit-startup-visibility-stuff t)
18463 (org-startup-align-all-tables nil))
18464 (when (boundp 'org-table-coordinate-overlays)
18465 (mapc 'delete-overlay org-table-coordinate-overlays)
18466 (setq org-table-coordinate-overlays nil))
18467 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18468 (message "Local setup has been refreshed"))))
18469 ((org-clock-update-time-maybe))
18470 (t
18471 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18472 (error "C-c C-c can do nothing useful at this location"))))))
18474 (defun org-mode-restart ()
18475 "Restart Org-mode, to scan again for special lines.
18476 Also updates the keyword regular expressions."
18477 (interactive)
18478 (org-mode)
18479 (message "Org-mode restarted"))
18481 (defun org-kill-note-or-show-branches ()
18482 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18483 (interactive)
18484 (if (not org-finish-function)
18485 (progn
18486 (hide-subtree)
18487 (call-interactively 'show-branches))
18488 (let ((org-note-abort t))
18489 (funcall org-finish-function))))
18491 (defun org-return (&optional indent)
18492 "Goto next table row or insert a newline.
18493 Calls `org-table-next-row' or `newline', depending on context.
18494 See the individual commands for more information."
18495 (interactive)
18496 (cond
18497 ((bobp) (if indent (newline-and-indent) (newline)))
18498 ((org-at-table-p)
18499 (org-table-justify-field-maybe)
18500 (call-interactively 'org-table-next-row))
18501 ;; when `newline-and-indent' is called within a list, make sure
18502 ;; text moved stays inside the item.
18503 ((and (org-in-item-p) indent)
18504 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18505 (progn
18506 (save-match-data (newline))
18507 (org-indent-line-to (length (match-string 0))))
18508 (let ((ind (org-get-indentation)))
18509 (newline)
18510 (if (org-looking-back org-list-end-re)
18511 (org-indent-line-function)
18512 (org-indent-line-to ind)))))
18513 ((and org-return-follows-link
18514 (let ((tprop (get-text-property (point) 'face)))
18515 (or (eq tprop 'org-link)
18516 (and (listp tprop) (memq 'org-link tprop)))))
18517 (call-interactively 'org-open-at-point))
18518 ((and (org-at-heading-p)
18519 (looking-at
18521 (org-show-entry)
18522 (end-of-line 1)
18523 (newline))
18524 (t (if indent (newline-and-indent) (newline)))))
18526 (defun org-return-indent ()
18527 "Goto next table row or insert a newline and indent.
18528 Calls `org-table-next-row' or `newline-and-indent', depending on
18529 context. See the individual commands for more information."
18530 (interactive)
18531 (org-return t))
18533 (defun org-ctrl-c-star ()
18534 "Compute table, or change heading status of lines.
18535 Calls `org-table-recalculate' or `org-toggle-heading',
18536 depending on context."
18537 (interactive)
18538 (cond
18539 ((org-at-table-p)
18540 (call-interactively 'org-table-recalculate))
18541 (t
18542 ;; Convert all lines in region to list items
18543 (call-interactively 'org-toggle-heading))))
18545 (defun org-ctrl-c-minus ()
18546 "Insert separator line in table or modify bullet status of line.
18547 Also turns a plain line or a region of lines into list items.
18548 Calls `org-table-insert-hline', `org-toggle-item', or
18549 `org-cycle-list-bullet', depending on context."
18550 (interactive)
18551 (cond
18552 ((org-at-table-p)
18553 (call-interactively 'org-table-insert-hline))
18554 ((org-region-active-p)
18555 (call-interactively 'org-toggle-item))
18556 ((org-in-item-p)
18557 (call-interactively 'org-cycle-list-bullet))
18558 (t
18559 (call-interactively 'org-toggle-item))))
18561 (defun org-toggle-item (arg)
18562 "Convert headings or normal lines to items, items to normal lines.
18563 If there is no active region, only the current line is considered.
18565 If the first non blank line in the region is an headline, convert
18566 all headlines to items, shifting text accordingly.
18568 If it is an item, convert all items to normal lines.
18570 If it is normal text, change region into an item. With a prefix
18571 argument ARG, change each line in region into an item."
18572 (interactive "P")
18573 (let ((shift-text
18574 (function
18575 ;; Shift text in current section to IND, from point to END.
18576 ;; The function leaves point to END line.
18577 (lambda (ind end)
18578 (let ((min-i 1000) (end (copy-marker end)))
18579 ;; First determine the minimum indentation (MIN-I) of
18580 ;; the text.
18581 (save-excursion
18582 (catch 'exit
18583 (while (< (point) end)
18584 (let ((i (org-get-indentation)))
18585 (cond
18586 ;; Skip blank lines and inline tasks.
18588 ((looking-at org-outline-regexp-bol))
18589 ;; We can't find less than 0 indentation.
18590 ((zerop i) (throw 'exit (setq min-i 0)))
18591 ((< i min-i) (setq min-i i))))
18592 (forward-line))))
18593 ;; Then indent each line so that a line indented to
18594 ;; MIN-I becomes indented to IND. Ignore blank lines
18595 ;; and inline tasks in the process.
18596 (let ((delta (- ind min-i)))
18597 (while (< (point) end)
18599 (looking-at org-outline-regexp-bol))
18600 (org-indent-line-to (+ (org-get-indentation) delta)))
18601 (forward-line)))))))
18602 (skip-blanks
18603 (function
18604 ;; Return beginning of first non-blank line, starting from
18605 ;; line at POS.
18606 (lambda (pos)
18607 (save-excursion
18608 (goto-char pos)
18610 (point-at-bol)))))
18611 beg end)
18612 ;; Determine boundaries of changes.
18613 (if (org-region-active-p)
18614 (setq beg (funcall skip-blanks (region-beginning))
18615 end (copy-marker (region-end)))
18616 (setq beg (funcall skip-blanks (point-at-bol))
18617 end (copy-marker (point-at-eol))))
18618 ;; Depending on the starting line, choose an action on the text
18619 ;; between BEG and END.
18620 (org-with-limited-levels
18621 (save-excursion
18622 (goto-char beg)
18623 (cond
18624 ;; Case 1. Start at an item: de-itemize. Note that it only
18625 ;; happens when a region is active: `org-ctrl-c-minus'
18626 ;; would call `org-cycle-list-bullet' otherwise.
18627 ((org-at-item-p)
18628 (while (< (point) end)
18629 (when (org-at-item-p)
18631 (delete-region (point) (match-end 0)))
18632 (forward-line)))
18633 ;; Case 2. Start at an heading: convert to items.
18634 ((org-at-heading-p)
18635 (let* ((bul (org-list-bullet-string "-"))
18636 (bul-len (length bul))
18637 ;; Indentation of the first heading. It should be
18638 ;; relative to the indentation of its parent, if any.
18639 (start-ind (save-excursion
18640 (cond
18641 ((not org-adapt-indentation) 0)
18642 ((not (outline-previous-heading)) 0)
18643 (t (length (match-string 0))))))
18644 ;; Level of first heading. Further headings will be
18645 ;; compared to it to determine hierarchy in the list.
18646 (ref-level (org-reduced-level (org-outline-level))))
18647 (while (< (point) end)
18648 (let* ((level (org-reduced-level (org-outline-level)))
18649 (delta (max 0 (- level ref-level))))
18650 ;; If current headline is less indented than the first
18651 ;; one, set it as reference, in order to preserve
18652 ;; subtrees.
18653 (when (< level ref-level) (setq ref-level level))
18654 (replace-match bul t t)
18655 (org-indent-line-to (+ start-ind (* delta bul-len)))
18656 ;; Ensure all text down to END (or SECTION-END) belongs
18657 ;; to the newly created item.
18658 (let ((section-end (save-excursion
18659 (or (outline-next-heading) (point)))))
18660 (forward-line)
18661 (funcall shift-text
18662 (+ start-ind (* (1+ delta) bul-len))
18663 (min end section-end)))))))
18664 ;; Case 3. Normal line with ARG: turn each non-item line into
18665 ;; an item.
18666 (arg
18667 (while (< (point) end)
18668 (unless (or (org-at-heading-p) (org-at-item-p))
18670 (replace-match
18672 (forward-line)))
18673 ;; Case 4. Normal line without ARG: make the first line of
18674 ;; region an item, and shift indentation of others
18675 ;; lines to set them as item's body.
18676 (t (let* ((bul (org-list-bullet-string "-"))
18677 (bul-len (length bul))
18678 (ref-ind (org-get-indentation)))
18680 (insert bul)
18681 (forward-line)
18682 (while (< (point) end)
18683 ;; Ensure that lines less indented than first one
18684 ;; still get included in item body.
18685 (funcall shift-text
18686 (+ ref-ind bul-len)
18687 (min end (save-excursion (or (outline-next-heading)
18688 (point)))))
18689 (forward-line)))))))))
18691 (defun org-toggle-heading (&optional nstars)
18692 "Convert headings to normal text, or items or text to headings.
18693 If there is no active region, only the current line is considered.
18695 If the first non blank line is an headline, remove the stars from
18696 all headlines in the region.
18698 If it is a plain list item, turn all plain list items into headings.
18700 If it is a normal line, turn each and every normal line (i.e. not
18701 an heading or an item) in the region into a heading.
18703 When converting a line into a heading, the number of stars is chosen
18704 such that the lines become children of the current entry. However,
18705 when a prefix argument is given, its value determines the number of
18706 stars to add."
18707 (interactive "P")
18708 (let ((skip-blanks
18709 (function
18710 ;; Return beginning of first non-blank line, starting from
18711 ;; line at POS.
18712 (lambda (pos)
18713 (save-excursion
18714 (goto-char pos)
18716 (point-at-bol)))))
18717 beg end)
18718 ;; Determine boundaries of changes. If region ends at a bol, do
18719 ;; not consider the last line to be in the region.
18720 (if (org-region-active-p)
18721 (setq beg (funcall skip-blanks (region-beginning))
18722 end (copy-marker (save-excursion
18723 (goto-char (region-end))
18724 (if (bolp) (point) (point-at-eol)))))
18725 (setq beg (funcall skip-blanks (point-at-bol))
18726 end (copy-marker (point-at-eol))))
18727 ;; Ensure inline tasks don't count as headings.
18728 (org-with-limited-levels
18729 (save-excursion
18730 (goto-char beg)
18731 (cond
18732 ;; Case 1. Started at an heading: de-star headings.
18733 ((org-at-heading-p)
18734 (while (< (point) end)
18735 (when (org-at-heading-p t)
18736 (looking-at org-outline-regexp) (replace-match ""))
18737 (forward-line)))
18738 ;; Case 2. Started at an item: change items into headlines.
18739 ;; One star will be added by `org-list-to-subtree'.
18740 ((org-at-item-p)
18741 (let* ((stars (make-string
18742 (if nstars
18743 ;; subtract the star that will be added again by
18744 ;; `org-list-to-subtree'
18745 (1- (prefix-numeric-value current-prefix-arg))
18746 (or (org-current-level) 0))
18747 ?*))
18748 (add-stars
18749 (cond (nstars "") ; stars from prefix only
18750 ((equal stars "") "") ; before first heading
18751 (org-odd-levels-only "*") ; inside heading, odd
18752 (t "")))) ; inside heading, oddeven
18753 (while (< (point) end)
18754 (when (org-at-item-p)
18755 ;; Pay attention to cases when region ends before list.
18756 (let* ((struct (org-list-struct))
18757 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18758 (save-restriction
18759 (narrow-to-region (point) list-end)
18760 (insert
18761 (org-list-to-subtree
18762 (org-list-parse-list t)
18763 '(:istart (concat stars add-stars (funcall get-stars depth))
18764 :icount (concat stars add-stars (funcall get-stars depth))))))))
18765 (forward-line))))
18766 ;; Case 3. Started at normal text: make every line an heading,
18767 ;; skipping headlines and items.
18768 (t (let* ((stars (make-string
18769 (if nstars
18770 (prefix-numeric-value current-prefix-arg)
18771 (or (org-current-level) 0))
18772 ?*))
18773 (add-stars
18774 (cond (nstars "") ; stars from prefix only
18775 ((equal stars "") "*") ; before first heading
18776 (org-odd-levels-only "**") ; inside heading, odd
18777 (t "*"))) ; inside heading, oddeven
18778 (rpl (concat stars add-stars " ")))
18779 (while (< (point) end)
18780 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18782 (replace-match (concat rpl (match-string 2))))
18783 (forward-line)))))))))
18785 (defun org-meta-return (&optional arg)
18786 "Insert a new heading or wrap a region in a table.
18787 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18788 See the individual commands for more information."
18789 (interactive "P")
18790 (cond
18791 ((run-hook-with-args-until-success 'org-metareturn-hook))
18792 ((org-at-table-p)
18793 (call-interactively 'org-table-wrap-region))
18794 (t (call-interactively 'org-insert-heading))))
18796 ;;; Menu entries
18798 ;; Define the Org-mode menus
18799 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18800 '("Tbl"
18801 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18802 ["Next Field" org-cycle (org-at-table-p)]
18803 ["Previous Field" org-shifttab (org-at-table-p)]
18804 ["Next Row" org-return (org-at-table-p)]
18805 "--"
18806 ["Blank Field" org-table-blank-field (org-at-table-p)]
18807 ["Edit Field" org-table-edit-field (org-at-table-p)]
18808 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18809 "--"
18810 ("Column"
18811 ["Move Column Left" org-metaleft (org-at-table-p)]
18812 ["Move Column Right" org-metaright (org-at-table-p)]
18813 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18814 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18815 ("Row"
18816 ["Move Row Up" org-metaup (org-at-table-p)]
18817 ["Move Row Down" org-metadown (org-at-table-p)]
18818 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18819 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18820 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18821 "--"
18822 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18823 ("Rectangle"
18824 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18825 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18826 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18827 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18828 "--"
18829 ("Calculate"
18830 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18831 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18832 ["Edit Formulas" org-edit-special (org-at-table-p)]
18833 "--"
18834 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18835 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18836 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18837 "--"
18838 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18839 "--"
18840 ["Sum Column/Rectangle" org-table-sum
18841 (or (org-at-table-p) (org-region-active-p))]
18842 ["Which Column?" org-table-current-column (org-at-table-p)])
18843 ["Debug Formulas"
18844 org-table-toggle-formula-debugger
18845 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18846 ["Show Col/Row Numbers"
18847 org-table-toggle-coordinate-overlays
18848 :style toggle
18849 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18850 "--"
18851 ["Create" org-table-create (and (not (org-at-table-p))
18852 org-enable-table-editor)]
18853 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18854 ["Import from File" org-table-import (not (org-at-table-p))]
18855 ["Export to File" org-table-export (org-at-table-p)]
18856 "--"
18857 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18859 (easy-menu-define org-org-menu org-mode-map "Org menu"
18860 '("Org"
18861 ("Show/Hide"
18862 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18863 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18864 ["Sparse Tree..." org-sparse-tree t]
18865 ["Reveal Context" org-reveal t]
18866 ["Show All" show-all t]
18867 "--"
18868 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18869 "--"
18870 ["New Heading" org-insert-heading t]
18871 ("Navigate Headings"
18872 ["Up" outline-up-heading t]
18873 ["Next" outline-next-visible-heading t]
18874 ["Previous" outline-previous-visible-heading t]
18875 ["Next Same Level" outline-forward-same-level t]
18876 ["Previous Same Level" outline-backward-same-level t]
18877 "--"
18878 ["Jump" org-goto t])
18879 ("Edit Structure"
18880 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18881 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18882 "--"
18883 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18884 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18885 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18886 "--"
18887 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18888 "--"
18889 ["Copy visible text" org-copy-visible t]
18890 "--"
18891 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18892 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18893 ["Demote Heading" org-metaright (not (org-at-table-p))]
18894 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18895 "--"
18896 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18897 "--"
18898 ["Convert to odd levels" org-convert-to-odd-levels t]
18899 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18900 ("Editing"
18901 ["Emphasis..." org-emphasize t]
18902 ["Edit Source Example" org-edit-special t]
18903 "--"
18904 ["Footnote new/jump" org-footnote-action t]
18905 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18906 ("Archive"
18907 ["Archive (default method)" org-archive-subtree-default t]
18908 "--"
18909 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18910 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18911 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18912 )
18913 "--"
18914 ("Hyperlinks"
18915 ["Store Link (Global)" org-store-link t]
18916 ["Find existing link to here" org-occur-link-in-agenda-files t]
18917 ["Insert Link" org-insert-link t]
18918 ["Follow Link" org-open-at-point t]
18919 "--"
18920 ["Next link" org-next-link t]
18921 ["Previous link" org-previous-link t]
18922 "--"
18923 ["Descriptive Links"
18924 org-toggle-link-display
18925 :style radio
18926 :selected org-descriptive-links
18927 ]
18928 ["Literal Links"
18929 org-toggle-link-display
18930 :style radio
18931 :selected (not org-descriptive-links)])
18932 "--"
18933 ("TODO Lists"
18934 ["TODO/DONE/-" org-todo t]
18935 ("Select keyword"
18936 ["Next keyword" org-shiftright (org-at-heading-p)]
18937 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18938 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18939 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18940 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18941 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18942 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18943 "--"
18944 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18945 :selected org-enforce-todo-dependencies :style toggle :active t]
18946 "Settings for tree at point"
18947 ["Do Children sequentially" org-toggle-ordered-property :style radio
18948 :selected (org-entry-get nil "ORDERED")
18949 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18950 ["Do Children parallel" org-toggle-ordered-property :style radio
18951 :selected (not (org-entry-get nil "ORDERED"))
18952 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18953 "--"
18954 ["Set Priority" org-priority t]
18955 ["Priority Up" org-shiftup t]
18956 ["Priority Down" org-shiftdown t]
18957 "--"
18958 ["Get news from all feeds" org-feed-update-all t]
18959 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18960 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18961 ("TAGS and Properties"
18962 ["Set Tags" org-set-tags-command t]
18963 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18964 "--"
18965 ["Set property" org-set-property t]
18966 ["Column view of properties" org-columns t]
18967 ["Insert Column View DBlock" org-insert-columns-dblock t])
18968 ("Dates and Scheduling"
18969 ["Timestamp" org-time-stamp t]
18970 ["Timestamp (inactive)" org-time-stamp-inactive t]
18971 ("Change Date"
18972 ["1 Day Later" org-shiftright t]
18973 ["1 Day Earlier" org-shiftleft t]
18974 ["1 ... Later" org-shiftup t]
18975 ["1 ... Earlier" org-shiftdown t])
18976 ["Compute Time Range" org-evaluate-time-range t]
18977 ["Schedule Item" org-schedule t]
18978 ["Deadline" org-deadline t]
18979 "--"
18980 ["Custom time format" org-toggle-time-stamp-overlays
18981 :style radio :selected org-display-custom-times]
18982 "--"
18983 ["Goto Calendar" org-goto-calendar t]
18984 ["Date from Calendar" org-date-from-calendar t]
18985 "--"
18986 ["Start/Restart Timer" org-timer-start t]
18987 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18988 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18989 ["Insert Timer String" org-timer t]
18990 ["Insert Timer Item" org-timer-item t])
18991 ("Logging work"
18992 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18993 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18994 ["Clock out" org-clock-out t]
18995 ["Clock cancel" org-clock-cancel t]
18996 "--"
18997 ["Mark as default task" org-clock-mark-default-task t]
18998 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18999 ["Goto running clock" org-clock-goto t]
19000 "--"
19001 ["Display times" org-clock-display t]
19002 ["Create clock table" org-clock-report t]
19003 "--"
19004 ["Record DONE time"
19005 (progn (setq org-log-done (not org-log-done))
19006 (message "Switching to %s will %s record a timestamp"
19007 (car org-done-keywords)
19008 (if org-log-done "automatically" "not")))
19009 :style toggle :selected org-log-done])
19010 "--"
19011 ["Agenda Command..." org-agenda t]
19012 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19013 ("File List for Agenda")
19014 ("Special views current file"
19015 ["TODO Tree" org-show-todo-tree t]
19016 ["Check Deadlines" org-check-deadlines t]
19017 ["Timeline" org-timeline t]
19018 ["Tags/Property tree" org-match-sparse-tree t])
19019 "--"
19020 ["Export/Publish..." org-export t]
19021 ("LaTeX"
19022 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19023 :selected org-cdlatex-mode]
19024 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19025 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19026 ["Modify math symbol" org-cdlatex-math-modify
19027 (org-inside-LaTeX-fragment-p)]
19028 ["Insert citation" org-reftex-citation t]
19029 "--"
19030 ["Template for BEAMER" org-insert-beamer-options-template t])
19031 "--"
19032 ("MobileOrg"
19033 ["Push Files and Views" org-mobile-push t]
19034 ["Get Captured and Flagged" org-mobile-pull t]
19035 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19036 "--"
19037 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19038 "--"
19039 ("Documentation"
19040 ["Show Version" org-version t]
19041 ["Info Documentation" org-info t])
19042 ("Customize"
19043 ["Browse Org Group" org-customize t]
19044 "--"
19045 ["Expand This Menu" org-create-customize-menu
19046 (fboundp 'customize-menu-create)])
19047 ["Send bug report" org-submit-bug-report t]
19048 "--"
19049 ("Refresh/Reload"
19050 ["Refresh setup current buffer" org-mode-restart t]
19051 ["Reload Org (after update)" org-reload t]
19052 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19053 ))
19055 (defun org-info (&optional node)
19056 "Read documentation for Org-mode in the info system.
19057 With optional NODE, go directly to that node."
19058 (interactive)
19059 (info (format "(org)%s" (or node ""))))
19061 ;;;###autoload
19062 (defun org-submit-bug-report ()
19063 "Submit a bug report on Org-mode via mail.
19065 Don't hesitate to report any problems or inaccurate documentation.
19067 If you don't have setup sending mail from (X)Emacs, please copy the
19068 output buffer into your mail program, as it gives us important
19069 information about your Org-mode version and configuration."
19070 (interactive)
19071 (require 'reporter)
19072 (org-load-modules-maybe)
19073 (org-require-autoloaded-modules)
19074 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19075 (reporter-submit-bug-report
19076 "emacs-orgmode@gnu.org"
19077 (org-version)
19078 (let (list)
19079 (save-window-excursion
19080 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19081 (delete-other-windows)
19082 (erase-buffer)
19083 (insert "You are about to submit a bug report to the Org-mode mailing list.
19085 We would like to add your full Org-mode and Outline configuration to the
19086 bug report. This greatly simplifies the work of the maintainer and
19087 other experts on the mailing list.
19089 HOWEVER, some variables you have customized may contain private
19090 information. The names of customers, colleagues, or friends, might
19091 appear in the form of file names, tags, todo states, or search strings.
19092 If you answer yes to the prompt, you might want to check and remove
19093 such private information before sending the email.")
19094 (add-text-properties (point-min) (point-max) '(face org-warning))
19095 (when (yes-or-no-p "Include your Org-mode configuration ")
19096 (mapatoms
19097 (lambda (v)
19098 (and (boundp v)
19100 (or (and (symbol-value v)
19102 (and
19103 (get v 'custom-type) (get v 'standard-value)
19104 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19105 (push v list)))))
19106 (kill-buffer (get-buffer "*Warn about privacy*"))
19107 list))
19108 nil nil
19109 "Remember to cover the basics, that is, what you expected to happen and
19110 what in fact did happen. You don't know how to make a good report? See
19112 http://orgmode.org/manual/Feedback.html#Feedback
19114 Your bug report will be posted to the Org-mode mailing list.
19115 ------------------------------------------------------------------------")
19116 (save-excursion
19121 (defun org-install-agenda-files-menu ()
19122 (let ((bl (buffer-list)))
19123 (save-excursion
19124 (while bl
19125 (set-buffer (pop bl))
19126 (if (eq major-mode 'org-mode) (setq bl nil)))
19127 (when (eq major-mode 'org-mode)
19128 (easy-menu-change
19129 '("Org") "File List for Agenda"
19130 (append
19131 (list
19132 ["Edit File List" (org-edit-agenda-file-list) t]
19133 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19134 ["Remove Current File from List" org-remove-file t]
19135 ["Cycle through agenda files" org-cycle-agenda-files t]
19136 ["Occur in all agenda files" org-occur-in-agenda-files t]
19137 "--")
19138 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19140 ;;;; Documentation
19142 ;;;###autoload
19143 (defun org-require-autoloaded-modules ()
19144 (interactive)
19145 (mapc 'require
19146 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19147 org-docbook org-exp org-html org-icalendar
19148 org-id org-latex
19149 org-publish org-remember org-table
19150 org-timer org-xoxo)))
19152 ;;;###autoload
19153 (defun org-reload (&optional uncompiled)
19154 "Reload all org lisp files.
19155 With prefix arg UNCOMPILED, load the uncompiled versions."
19156 (interactive "P")
19157 (require 'find-func)
19159 (dir-org (file-name-directory (org-find-library-name "org")))
19160 (dir-org-contrib (ignore-errors
19161 (file-name-directory
19162 (org-find-library-name "org-contribdir"))))
19163 (babel-files
19164 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19165 (append (list nil "comint" "eval" "exp" "keys"
19166 "lob" "ref" "table" "tangle")
19167 (delq nil
19168 (mapcar
19169 (lambda (lang)
19170 (when (cdr lang) (symbol-name (car lang))))
19171 org-babel-load-languages)))))
19172 (files
19173 (append (directory-files dir-org t file-re)
19174 babel-files
19175 (and dir-org-contrib
19176 (directory-files dir-org-contrib t file-re))))
19177 (remove-re (concat (if (featurep 'xemacs)
19178 "org-colview" "org-colview-xemacs")
19180 (setq files (mapcar 'file-name-sans-extension files))
19181 (setq files (mapcar
19182 (lambda (x) (if (string-match remove-re x) nil x))
19183 files))
19184 (setq files (delq nil files))
19185 (mapc
19186 (lambda (f)
19187 (when (featurep (intern (file-name-nondirectory f)))
19188 (if (and (not uncompiled)
19189 (file-exists-p (concat f ".elc")))
19190 (load (concat f ".elc") nil nil t)
19191 (load (concat f ".el") nil nil t))))
19192 files))
19193 (org-version))
19195 ;;;###autoload
19196 (defun org-customize ()
19197 "Call the customize function with org as argument."
19198 (interactive)
19199 (org-load-modules-maybe)
19200 (org-require-autoloaded-modules)
19201 (customize-browse 'org))
19203 (defun org-create-customize-menu ()
19204 "Create a full customization menu for Org-mode, insert it into the menu."
19205 (interactive)
19206 (org-load-modules-maybe)
19207 (org-require-autoloaded-modules)
19208 (if (fboundp 'customize-menu-create)
19209 (progn
19210 (easy-menu-change
19211 '("Org") "Customize"
19212 `(["Browse Org group" org-customize t]
19213 "--"
19214 ,(customize-menu-create 'org)
19215 ["Set" Custom-set t]
19216 ["Save" Custom-save t]
19217 ["Reset to Current" Custom-reset-current t]
19218 ["Reset to Saved" Custom-reset-saved t]
19219 ["Reset to Standard Settings" Custom-reset-standard t]))
19221 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19223 ;;;; Miscellaneous stuff
19225 ;;; Generally useful functions
19227 (defun org-get-at-bol (property)
19228 "Get text property PROPERTY at beginning of line."
19229 (get-text-property (point-at-bol) property))
19231 (defun org-find-text-property-in-string (prop s)
19232 "Return the first non-nil value of property PROP in string S."
19233 (or (get-text-property 0 prop s)
19234 (get-text-property (or (next-single-property-change 0 prop s) 0)
19235 prop s)))
19237 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19238 "Display the given MESSAGE as a warning."
19239 (if (fboundp 'display-warning)
19240 (display-warning 'org message
19241 (if (featurep 'xemacs) 'warning :warning))
19242 (let ((buf (get-buffer-create "*Org warnings*")))
19243 (with-current-buffer buf
19244 (goto-char (point-max))
19245 (insert "Warning (Org): " message)
19246 (unless (bolp)
19247 (newline)))
19248 (display-buffer buf)
19249 (sit-for 0))))
19251 (defun org-eval (form)
19252 "Eval FORM and return result."
19253 (condition-case error
19254 (eval form)
19255 (error (format "%%![Error: %s]" error))))
19257 (defun org-in-commented-line ()
19258 "Is point in a line starting with `#'?"
19259 (equal (char-after (point-at-bol)) ?#))
19261 (defun org-in-indented-comment-line ()
19262 "Is point in a line starting with `#' after some white space?"
19263 (save-excursion
19264 (save-match-data
19265 (goto-char (point-at-bol))
19268 (defun org-in-verbatim-emphasis ()
19269 (save-match-data
19270 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19272 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19273 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19274 (if (and marker (marker-buffer marker)
19275 (buffer-live-p (marker-buffer marker)))
19276 (progn
19277 (org-pop-to-buffer-same-window (marker-buffer marker))
19278 (if (or (> marker (point-max)) (< marker (point-min)))
19279 (widen))
19280 (goto-char marker)
19281 (org-show-context 'org-goto))
19282 (if bookmark
19283 (bookmark-jump bookmark)
19284 (error "Cannot find location"))))
19286 (defun org-quote-csv-field (s)
19287 "Quote field for inclusion in CSV material."
19290 s))
19292 (defun org-force-self-insert (N)
19293 "Needed to enforce self-insert under remapping."
19294 (interactive "p")
19295 (self-insert-command N))
19297 (defun org-string-width (s)
19298 "Compute width of string, ignoring invisible characters.
19299 This ignores character with invisibility property `org-link', and also
19300 characters with property `org-cwidth', because these will become invisible
19301 upon the next fontification round."
19302 (let (b l)
19303 (when (or (eq t buffer-invisibility-spec)
19304 (assq 'org-link buffer-invisibility-spec))
19305 (while (setq b (text-property-any 0 (length s)
19306 'invisible 'org-link s))
19307 (setq s (concat (substring s 0 b)
19308 (substring s (or (next-single-property-change
19309 b 'invisible s) (length s)))))))
19310 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19311 (setq s (concat (substring s 0 b)
19312 (substring s (or (next-single-property-change
19313 b 'org-cwidth s) (length s))))))
19314 (setq l (string-width s) b -1)
19315 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19316 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19317 l))
19319 (defun org-shorten-string (s maxlength)
19320 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19321 If the string is shorter or has length MAXLENGTH, just return the
19322 original string. If it is longer, the functions finds a space in the
19323 string, breaks this string off at that locations and adds three dots
19324 as ellipsis. Including the ellipsis, the string will not be longer
19325 than MAXLENGTH. If finding a good breaking point in the string does
19326 not work, the string is just chopped off in the middle of a word
19327 if necessary."
19328 (if (<= (length s) maxlength)
19329 s
19330 (let* ((n (max (- maxlength 4) 1))
19332 (if (string-match re s)
19333 (concat (match-string 1 s) "...")
19334 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19336 (defun org-get-indentation (&optional line)
19337 "Get the indentation of the current line, interpreting tabs.
19338 When LINE is given, assume it represents a line and compute its indentation."
19339 (if line
19340 (if (string-match "^ *" (org-remove-tabs line))
19341 (match-end 0))
19342 (save-excursion
19343 (beginning-of-line 1)
19345 (current-column))))
19347 (defun org-get-string-indentation (s)
19348 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19349 (let ((n -1) (i 0) (w tab-width) c)
19350 (catch 'exit
19351 (while (< (setq n (1+ n)) (length s))
19352 (setq c (aref s n))
19353 (cond ((= c ?\ ) (setq i (1+ i)))
19355 (t (throw 'exit t)))))
19356 i))
19358 (defun org-remove-tabs (s &optional width)
19359 "Replace tabulators in S with spaces.
19360 Assumes that s is a single line, starting in column 0."
19361 (setq width (or width tab-width))
19363 (setq s (replace-match
19364 (make-string
19365 (- (* width (/ (+ (match-beginning 0) width) width))
19366 (match-beginning 0)) ?\ )
19367 t t s)))
19368 s)
19370 (defun org-fix-indentation (line ind)
19371 "Fix indentation in LINE.
19372 IND is a cons cell with target and minimum indentation.
19373 If the current indentation in LINE is smaller than the minimum,
19374 leave it alone. If it is larger than ind, set it to the target."
19375 (let* ((l (org-remove-tabs line))
19376 (i (org-get-indentation l))
19377 (i1 (car ind)) (i2 (cdr ind)))
19378 (if (>= i i2) (setq l (substring line i2)))
19379 (if (> i1 0)
19380 (concat (make-string i1 ?\ ) l)
19381 l)))
19383 (defun org-remove-indentation (code &optional n)
19384 "Remove the maximum common indentation from the lines in CODE.
19385 N may optionally be the number of spaces to remove."
19386 (with-temp-buffer
19387 (insert code)
19388 (org-do-remove-indentation n)
19389 (buffer-string)))
19391 (defun org-do-remove-indentation (&optional n)
19392 "Remove the maximum common indentation from the buffer."
19393 (untabify (point-min) (point-max))
19394 (let ((min 10000) re)
19395 (if n
19396 (setq min n)
19397 (goto-char (point-min))
19399 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19400 (unless (or (= min 0) (= min 10000))
19402 (goto-char (point-min))
19403 (while (re-search-forward re nil t)
19404 (replace-match "")
19405 (end-of-line 1))
19406 min)))
19408 (defun org-fill-template (template alist)
19409 "Find each %key of ALIST in TEMPLATE and replace it."
19410 (let ((case-fold-search nil)
19411 entry key value)
19412 (setq alist (sort (copy-sequence alist)
19413 (lambda (a b) (< (length (car a)) (length (car b))))))
19414 (while (setq entry (pop alist))
19415 (setq template
19416 (replace-regexp-in-string
19417 (concat "%" (regexp-quote (car entry)))
19418 (cdr entry) template t t)))
19419 template))
19421 (defun org-base-buffer (buffer)
19422 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19423 (if (not buffer)
19424 buffer
19425 (or (buffer-base-buffer buffer)
19426 buffer)))
19428 (defun org-trim (s)
19429 "Remove whitespace at beginning and end of string."
19432 s)
19434 (defun org-wrap (string &optional width lines)
19435 "Wrap string to either a number of lines, or a width in characters.
19436 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19437 that costs. If there is a word longer than WIDTH, the text is actually
19438 wrapped to the length of that word.
19439 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19440 many lines, whatever width that takes.
19441 The return value is a list of lines, without newlines at the end."
19443 (maxword (apply 'max (mapcar 'org-string-width words)))
19444 w ll)
19445 (cond (width
19446 (org-do-wrap words (max maxword width)))
19447 (lines
19448 (setq w maxword)
19449 (setq ll (org-do-wrap words maxword))
19450 (if (<= (length ll) lines)
19451 ll
19452 (setq ll words)
19453 (while (> (length ll) lines)
19454 (setq w (1+ w))
19455 (setq ll (org-do-wrap words w)))
19456 ll))
19457 (t (error "Cannot wrap this")))))
19459 (defun org-do-wrap (words width)
19460 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19461 (let (lines line)
19462 (while words
19463 (setq line (pop words))
19464 (while (and words (< (+ (length line) (length (car words))) width))
19465 (setq line (concat line " " (pop words))))
19466 (setq lines (push line lines)))
19467 (nreverse lines)))
19469 (defun org-split-string (string &optional separators)
19470 "Splits STRING into substrings at SEPARATORS.
19471 No empty strings are returned if there are matches at the beginning
19472 and end of string."
19474 (start 0)
19475 notfirst
19476 (list nil))
19477 (while (and (string-match rexp string
19478 (if (and notfirst
19479 (= start (match-beginning 0))
19480 (< start (length string)))
19481 (1+ start) start))
19482 (< (match-beginning 0) (length string)))
19483 (setq notfirst t)
19484 (or (eq (match-beginning 0) 0)
19485 (and (eq (match-beginning 0) (match-end 0))
19486 (eq (match-beginning 0) start))
19487 (setq list
19488 (cons (substring string start (match-beginning 0))
19489 list)))
19490 (setq start (match-end 0)))
19491 (or (eq start (length string))
19492 (setq list
19493 (cons (substring string start)
19494 list)))
19495 (nreverse list)))
19497 (defun org-quote-vert (s)
19499 (while (string-match "|" s)
19501 s)
19503 (defun org-uuidgen-p (s)
19504 "Is S an ID created by UUIDGEN?"
19505 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19507 (defun org-in-src-block-p nil
19508 "Whether point is in a code source block."
19509 (let (ov)
19510 (when (setq ov (overlays-at (point)))
19511 (memq 'org-block-background
19512 (overlay-properties
19513 (car ov))))))
19515 (defun org-context ()
19516 "Return a list of contexts of the current cursor position.
19517 If several contexts apply, all are returned.
19518 Each context entry is a list with a symbol naming the context, and
19519 two positions indicating start and end of the context. Possible
19520 contexts are:
19522 :headline anywhere in a headline
19523 :headline-stars on the leading stars in a headline
19524 :todo-keyword on a TODO keyword (including DONE) in a headline
19525 :tags on the TAGS in a headline
19526 :priority on the priority cookie in a headline
19527 :item on the first line of a plain list item
19528 :item-bullet on the bullet/number of a plain list item
19529 :checkbox on the checkbox in a plain list item
19530 :table in an org-mode table
19531 :table-special on a special filed in a table
19532 :table-table in a table.el table
19533 :clocktable in a clocktable
19534 :src-block in a source block
19535 :link on a hyperlink
19536 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19537 :target on a <<target>>
19538 :radio-target on a <<<radio-target>>>
19539 :latex-fragment on a LaTeX fragment
19540 :latex-preview on a LaTeX fragment with overlaid preview image
19542 This function expects the position to be visible because it uses font-lock
19543 faces as a help to recognize the following contexts: :table-special, :link,
19544 and :keyword."
19545 (let* ((f (get-text-property (point) 'face))
19546 (faces (if (listp f) f (list f)))
19547 (case-fold-search t)
19548 (p (point)) clist o)
19549 ;; First the large context
19550 (cond
19551 ((org-at-heading-p t)
19552 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19553 (when (progn
19554 (beginning-of-line 1)
19555 (looking-at org-todo-line-tags-regexp))
19556 (push (org-point-in-group p 1 :headline-stars) clist)
19557 (push (org-point-in-group p 2 :todo-keyword) clist)
19558 (push (org-point-in-group p 4 :tags) clist))
19559 (goto-char p)
19562 (push (org-point-in-group p 0 :priority) clist)))
19564 ((org-at-item-p)
19565 (push (org-point-in-group p 2 :item-bullet) clist)
19566 (push (list :item (point-at-bol)
19567 (save-excursion (org-end-of-item) (point)))
19568 clist)
19569 (and (org-at-item-checkbox-p)
19570 (push (org-point-in-group p 0 :checkbox) clist)))
19572 ((org-at-table-p)
19573 (push (list :table (org-table-begin) (org-table-end)) clist)
19574 (if (memq 'org-formula faces)
19575 (push (list :table-special
19576 (previous-single-property-change p 'face)
19577 (next-single-property-change p 'face)) clist)))
19578 ((org-at-table-p 'any)
19579 (push (list :table-table) clist)))
19580 (goto-char p)
19582 ;; New the "medium" contexts: clocktables, source blocks
19583 (cond ((org-in-clocktable-p)
19584 (push (list :clocktable
19586 (search-backward "#+BEGIN: clocktable" nil t))
19587 (match-beginning 0))
19589 (match-end 0))) clist))
19590 ((org-in-src-block-p)
19591 (push (list :src-block
19593 (search-backward "#+BEGIN_SRC" nil t))
19594 (match-beginning 0))
19595 (and (search-forward "#+END_SRC" nil t)
19596 (match-beginning 0))) clist)))
19597 (goto-char p)
19599 ;; Now the small context
19600 (cond
19601 ((org-at-timestamp-p)
19602 (push (org-point-in-group p 0 :timestamp) clist))
19603 ((memq 'org-link faces)
19604 (push (list :link
19605 (previous-single-property-change p 'face)
19606 (next-single-property-change p 'face)) clist))
19607 ((memq 'org-special-keyword faces)
19608 (push (list :keyword
19609 (previous-single-property-change p 'face)
19610 (next-single-property-change p 'face)) clist))
19611 ((org-at-target-p)
19612 (push (org-point-in-group p 0 :target) clist)
19613 (goto-char (1- (match-beginning 0)))
19614 (if (looking-at org-radio-target-regexp)
19615 (push (org-point-in-group p 0 :radio-target) clist))
19616 (goto-char p))
19617 ((setq o (car (delq nil
19618 (mapcar
19619 (lambda (x)
19620 (if (memq x org-latex-fragment-image-overlays) x))
19621 (overlays-at (point))))))
19622 (push (list :latex-fragment
19623 (overlay-start o) (overlay-end o)) clist)
19624 (push (list :latex-preview
19625 (overlay-start o) (overlay-end o)) clist))
19626 ((org-inside-LaTeX-fragment-p)
19627 ;; FIXME: positions wrong.
19628 (push (list :latex-fragment (point) (point)) clist)))
19630 (setq clist (nreverse (delq nil clist)))
19631 clist))
19633 ;; FIXME: Compare with at-regexp-p Do we need both?
19634 (defun org-in-regexp (re &optional nlines visually)
19635 "Check if point is inside a match of regexp.
19636 Normally only the current line is checked, but you can include NLINES extra
19637 lines both before and after point into the search.
19638 If VISUALLY is set, require that the cursor is not after the match but
19639 really on, so that the block visually is on the match."
19640 (catch 'exit
19641 (let ((pos (point))
19642 (eol (point-at-eol (+ 1 (or nlines 0))))
19643 (inc (if visually 1 0)))
19644 (save-excursion
19645 (beginning-of-line (- 1 (or nlines 0)))
19646 (while (re-search-forward re eol t)
19647 (if (and (<= (match-beginning 0) pos)
19648 (>= (+ inc (match-end 0)) pos))
19649 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19651 (defun org-at-regexp-p (regexp)
19652 "Is point inside a match of REGEXP in the current line?"
19653 (catch 'exit
19654 (save-excursion
19655 (let ((pos (point)) (end (point-at-eol)))
19656 (beginning-of-line 1)
19657 (while (re-search-forward regexp end t)
19658 (if (and (<= (match-beginning 0) pos)
19659 (>= (match-end 0) pos))
19660 (throw 'exit t)))
19661 nil))))
19663 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19664 "Non-nil when point is between matches of START-RE and END-RE.
19666 Also return a non-nil value when point is on one of the matches.
19668 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19669 buffer positions. Default values are the positions of headlines
19670 surrounding the point.
19672 The functions returns a cons cell whose car (resp. cdr) is the
19673 position before START-RE (resp. after END-RE)."
19674 (save-match-data
19675 (let ((pos (point))
19676 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19677 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19678 beg end)
19679 (save-excursion
19680 ;; Point is on a block when on START-RE or if START-RE can be
19681 ;; found before it...
19682 (and (or (org-at-regexp-p start-re)
19683 (re-search-backward start-re limit-up t))
19684 (setq beg (match-beginning 0))
19685 ;; ... and END-RE after it...
19686 (goto-char (match-end 0))
19687 (re-search-forward end-re limit-down t)
19688 (> (setq end (match-end 0)) pos)
19689 ;; ... without another START-RE in-between.
19690 (goto-char (match-beginning 0))
19691 (not (re-search-backward start-re (1+ beg) t))
19692 ;; Return value.
19693 (cons beg end))))))
19695 (defun org-in-block-p (names)
19696 "Non-nil when point belongs to a block whose name belongs to NAMES.
19698 NAMES is a list of strings containing names of blocks.
19700 Return first block name matched, or nil. Beware that in case of
19701 nested blocks, the returned name may not belong to the closest
19702 block from point."
19703 (save-match-data
19704 (catch 'exit
19705 (let ((case-fold-search t)
19706 (lim-up (save-excursion (outline-previous-heading)))
19707 (lim-down (save-excursion (outline-next-heading))))
19708 (mapc (lambda (name)
19709 (let ((n (regexp-quote name)))
19710 (when (org-between-regexps-p
19713 lim-up lim-down)
19714 (throw 'exit n))))
19715 names))
19716 nil)))
19718 (defun org-occur-in-agenda-files (regexp &optional nlines)
19719 "Call `multi-occur' with buffers for all agenda files."
19721 (let* ((files (org-agenda-files))
19722 (tnames (mapcar 'file-truename files))
19723 (extra org-agenda-text-search-extra-files)
19724 f)
19725 (when (eq (car extra) 'agenda-archives)
19726 (setq extra (cdr extra))
19727 (setq files (org-add-archive-files files)))
19728 (while (setq f (pop extra))
19729 (unless (member (file-truename f) tnames)
19730 (add-to-list 'files f 'append)
19731 (add-to-list 'tnames (file-truename f) 'append)))
19732 (multi-occur
19733 (mapcar (lambda (x)
19734 (with-current-buffer
19735 (or (get-file-buffer x) (find-file-noselect x))
19736 (widen)
19737 (current-buffer)))
19738 files)
19739 regexp)))
19741 (if (boundp 'occur-mode-find-occurrence-hook)
19742 ;; Emacs 23
19743 (add-hook 'occur-mode-find-occurrence-hook
19744 (lambda ()
19745 (when (eq major-mode 'org-mode)
19746 (org-reveal))))
19747 ;; Emacs 22
19748 (defadvice occur-mode-goto-occurrence
19749 (after org-occur-reveal activate)
19750 (and (eq major-mode 'org-mode) (org-reveal)))
19751 (defadvice occur-mode-goto-occurrence-other-window
19752 (after org-occur-reveal activate)
19753 (and (eq major-mode 'org-mode) (org-reveal)))
19754 (defadvice occur-mode-display-occurrence
19755 (after org-occur-reveal activate)
19756 (when (eq major-mode 'org-mode)
19757 (let ((pos (occur-mode-find-occurrence)))
19758 (with-current-buffer (marker-buffer pos)
19759 (save-excursion
19760 (goto-char pos)
19761 (org-reveal)))))))
19763 (defun org-occur-link-in-agenda-files ()
19764 "Create a link and search for it in the agendas.
19765 The link is not stored in `org-stored-links', it is just created
19766 for the search purpose."
19767 (interactive)
19768 (let ((link (condition-case nil
19769 (org-store-link nil)
19770 (error "Unable to create a link to here"))))
19771 (org-occur-in-agenda-files (regexp-quote link))))
19773 (defun org-uniquify (list)
19774 "Remove duplicate elements from LIST."
19775 (let (res)
19776 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19777 res))
19779 (defun org-delete-all (elts list)
19780 "Remove all elements in ELTS from LIST."
19781 (while elts
19782 (setq list (delete (pop elts) list)))
19783 list)
19785 (defun org-count (cl-item cl-seq)
19786 "Count the number of occurrences of ITEM in SEQ.
19787 Taken from `count' in cl-seq.el with all keyword arguments removed."
19788 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19789 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19790 (while (< cl-start cl-end)
19791 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19792 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19793 (setq cl-start (1+ cl-start)))
19794 cl-count))
19796 (defun org-remove-if (predicate seq)
19797 "Remove everything from SEQ that fulfills PREDICATE."
19798 (let (res e)
19799 (while seq
19800 (setq e (pop seq))
19801 (if (not (funcall predicate e)) (push e res)))
19802 (nreverse res)))
19804 (defun org-remove-if-not (predicate seq)
19805 "Remove everything from SEQ that does not fulfill PREDICATE."
19806 (let (res e)
19807 (while seq
19808 (setq e (pop seq))
19809 (if (funcall predicate e) (push e res)))
19810 (nreverse res)))
19812 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19813 "Reduce two-argument FUNCTION across SEQ.
19814 Taken from `reduce' in cl-seq.el with all keyword arguments but
19816 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19817 (cadr (memq :initial-value cl-keys)))
19818 (cl-seq (pop cl-seq))
19819 (t (funcall cl-func)))))
19820 (while cl-seq
19821 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19822 cl-accum))
19824 (defun org-back-over-empty-lines ()
19825 "Move backwards over whitespace, to the beginning of the first empty line.
19826 Returns the number of empty lines passed."
19827 (let ((pos (point)))
19828 (if (cdr (assoc 'heading org-blank-before-new-entry))
19830 (unless (eobp)
19831 (forward-line -1)))
19832 (beginning-of-line 2)
19833 (goto-char (min (point) pos))
19834 (count-lines (point) pos)))
19836 (defun org-skip-whitespace ()
19839 (defun org-point-in-group (point group &optional context)
19840 "Check if POINT is in match-group GROUP.
19841 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19842 match. If the match group does not exist or point is not inside it,
19843 return nil."
19844 (and (match-beginning group)
19845 (>= point (match-beginning group))
19846 (<= point (match-end group))
19847 (if context
19848 (list context (match-beginning group) (match-end group))
19849 t)))
19851 (defun org-switch-to-buffer-other-window (&rest args)
19852 "Switch to buffer in a second window on the current frame.
19853 In particular, do not allow pop-up frames.
19854 Returns the newly created buffer."
19855 (let (pop-up-frames special-display-buffer-names special-display-regexps
19856 special-display-function)
19857 (apply 'switch-to-buffer-other-window args)))
19859 (defun org-combine-plists (&rest plists)
19860 "Create a single property list from all plists in PLISTS.
19861 The process starts by copying the first list, and then setting properties
19862 from the other lists. Settings in the last list are the most significant
19863 ones and overrule settings in the other lists."
19864 (let ((rtn (copy-sequence (pop plists)))
19865 p v ls)
19866 (while plists
19867 (setq ls (pop plists))
19868 (while ls
19869 (setq p (pop ls) v (pop ls))
19870 (setq rtn (plist-put rtn p v))))
19871 rtn))
19873 (defun org-move-line-down (arg)
19874 "Move the current line down. With prefix argument, move it past ARG lines."
19875 (interactive "p")
19876 (let ((col (current-column))
19877 beg end pos)
19878 (beginning-of-line 1) (setq beg (point))
19879 (beginning-of-line 2) (setq end (point))
19880 (beginning-of-line (+ 1 arg))
19881 (setq pos (move-marker (make-marker) (point)))
19882 (insert (delete-and-extract-region beg end))
19883 (goto-char pos)
19884 (org-move-to-column col)))
19886 (defun org-move-line-up (arg)
19887 "Move the current line up. With prefix argument, move it past ARG lines."
19888 (interactive "p")
19889 (let ((col (current-column))
19890 beg end pos)
19891 (beginning-of-line 1) (setq beg (point))
19892 (beginning-of-line 2) (setq end (point))
19893 (beginning-of-line (- arg))
19894 (setq pos (move-marker (make-marker) (point)))
19895 (insert (delete-and-extract-region beg end))
19896 (goto-char pos)
19897 (org-move-to-column col)))
19899 (defun org-replace-escapes (string table)
19900 "Replace %-escapes in STRING with values in TABLE.
19902 The sequences in STRING may contain normal field width and padding information,
19904 so values can contain further %-escapes if they are define later in TABLE."
19905 (let ((tbl (copy-alist table))
19906 (case-fold-search nil)
19907 (pchg 0)
19908 e re rpl)
19909 (while (setq e (pop tbl))
19910 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19911 (when (and (cdr e) (string-match re (cdr e)))
19912 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19913 (safe "SREF"))
19914 (add-text-properties 0 3 (list 'sref sref) safe)
19915 (setcdr e (replace-match safe t t (cdr e)))))
19916 (while (string-match re string)
19917 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19918 (cdr e)))
19919 (setq string (replace-match rpl t t string))))
19920 (while (setq pchg (next-property-change pchg string))
19921 (let ((sref (get-text-property pchg 'sref string)))
19922 (when (and sref (string-match "SREF" string pchg))
19923 (setq string (replace-match sref t t string)))))
19924 string))
19926 (defun org-sublist (list start end)
19927 "Return a section of LIST, from START to END.
19928 Counting starts at 1."
19929 (let (rtn (c start))
19930 (setq list (nthcdr (1- start) list))
19931 (while (and list (<= c end))
19932 (push (pop list) rtn)
19933 (setq c (1+ c)))
19934 (nreverse rtn)))
19936 (defun org-find-base-buffer-visiting (file)
19937 "Like `find-buffer-visiting' but always return the base buffer and
19938 not an indirect buffer."
19939 (let ((buf (or (get-file-buffer file)
19940 (find-buffer-visiting file))))
19941 (if buf
19942 (or (buffer-base-buffer buf) buf)
19943 nil)))
19945 (defun org-image-file-name-regexp (&optional extensions)
19946 "Return regexp matching the file names of images.
19947 If EXTENSIONS is given, only match these."
19948 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19949 (image-file-name-regexp)
19950 (let ((image-file-name-extensions
19951 (or extensions
19952 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19953 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19955 (regexp-opt (nconc (mapcar 'upcase
19956 image-file-name-extensions)
19957 image-file-name-extensions)
19958 t)
19961 (defun org-file-image-p (file &optional extensions)
19962 "Return non-nil if FILE is an image."
19963 (save-match-data
19964 (string-match (org-image-file-name-regexp extensions) file)))
19966 (defun org-get-cursor-date ()
19967 "Return the date at cursor in as a time.
19968 This works in the calendar and in the agenda, anywhere else it just
19969 returns the current time."
19970 (let (date day defd)
19971 (cond
19972 ((eq major-mode 'calendar-mode)
19973 (setq date (calendar-cursor-to-date)
19974 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19975 ((eq major-mode 'org-agenda-mode)
19976 (setq day (get-text-property (point) 'day))
19977 (if day
19978 (setq date (calendar-gregorian-from-absolute day)
19979 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19980 (nth 2 date))))))
19981 (or defd (current-time))))
19983 (defvar org-agenda-action-marker (make-marker)
19984 "Marker pointing to the entry for the next agenda action.")
19986 (defun org-mark-entry-for-agenda-action ()
19987 "Mark the current entry as target of an agenda action.
19988 Agenda actions are actions executed from the agenda with the key `k',
19989 which make use of the date at the cursor."
19990 (interactive)
19991 (move-marker org-agenda-action-marker
19992 (save-excursion (org-back-to-heading t) (point))
19993 (current-buffer))
19994 (message
19995 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19997 (defun org-mark-subtree ()
19998 "Mark the current subtree.
19999 This puts point at the start of the current subtree, and mark at the end.
20001 If point is in an inline task, mark that task instead."
20002 (interactive)
20003 (let ((inline-task-p
20004 (and (featurep 'org-inlinetask)
20005 (org-inlinetask-in-task-p)))
20006 (beg))
20007 ;; Get beginning of subtree
20008 (cond
20009 (inline-task-p (org-inlinetask-goto-beginning))
20010 ((org-at-heading-p) (beginning-of-line))
20011 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20012 (setq beg (point))
20013 ;; Get end of it
20014 (if inline-task-p
20015 (org-inlinetask-goto-end)
20016 (org-end-of-subtree))
20017 ;; Mark zone
20018 (push-mark (point) nil t)
20019 (goto-char beg)))
20021 ;;; Paragraph filling stuff.
20022 ;; We want this to be just right, so use the full arsenal.
20024 (defun org-indent-line-function ()
20025 "Indent line depending on context."
20026 (interactive)
20027 (let* ((pos (point))
20028 (itemp (org-at-item-p))
20029 (case-fold-search t)
20031 (inline-task-p (and (featurep 'org-inlinetask)
20032 (org-inlinetask-in-task-p)))
20033 (inline-re (and inline-task-p
20034 (org-inlinetask-outline-regexp)))
20035 column)
20036 (beginning-of-line 1)
20037 (cond
20038 ;; Comments
20039 ((looking-at "# ") (setq column 0))
20040 ;; Headings
20041 ((looking-at org-outline-regexp) (setq column 0))
20042 ;; Included files
20044 ;; Footnote definition
20045 ((looking-at org-footnote-definition-re) (setq column 0))
20046 ;; Literal examples
20048 (setq column (org-get-indentation))) ; do nothing
20049 ;; Lists
20050 ((ignore-errors (goto-char (org-in-item-p)))
20051 (setq column (if itemp
20052 (org-get-indentation)
20053 (org-list-item-body-column (point))))
20054 (goto-char pos))
20055 ;; Drawers
20057 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20058 (save-excursion
20059 (goto-char (1- (match-beginning 1)))
20060 (setq column (current-column))))
20061 ;; Special blocks
20063 (save-excursion
20064 (re-search-backward
20066 (setq column (org-get-indentation (match-string 0))))
20069 (save-excursion
20071 (setq column
20072 (cond ((equal (downcase (match-string 1)) "src")
20073 ;; src blocks: let `org-edit-src-exit' handle them
20074 (org-get-indentation))
20075 ((equal (downcase (match-string 1)) "example")
20076 (max (org-get-indentation)
20077 (org-get-indentation (match-string 0))))
20078 (t
20079 (org-get-indentation (match-string 0))))))
20080 ;; This line has nothing special, look at the previous relevant
20081 ;; line to compute indentation
20082 (t
20083 (beginning-of-line 0)
20084 (while (and (not (bobp))
20085 (not (looking-at org-drawer-regexp))
20086 ;; When point started in an inline task, do not move
20087 ;; above task starting line.
20088 (not (and inline-task-p (looking-at inline-re)))
20089 ;; Skip drawers, blocks, empty lines, verbatim,
20090 ;; comments, tables, footnotes definitions, lists,
20091 ;; inline tasks.
20093 (re-search-backward org-drawer-regexp nil t))
20097 (looking-at org-footnote-definition-re)
20098 (and (ignore-errors (goto-char (org-in-item-p)))
20099 (goto-char
20100 (org-list-get-top-point (org-list-struct))))
20101 (and (not inline-task-p)
20102 (featurep 'org-inlinetask)
20103 (org-inlinetask-in-task-p)
20104 (or (org-inlinetask-goto-beginning) t))))
20105 (beginning-of-line 0))
20106 (cond
20107 ;; There was an heading above.
20109 (if (not org-adapt-indentation)
20110 (setq column 0)
20111 (goto-char (match-end 0))
20112 (setq column (current-column))))
20113 ;; A drawer had started and is unfinished
20114 ((looking-at org-drawer-regexp)
20115 (goto-char (1- (match-beginning 1)))
20116 (setq column (current-column)))
20117 ;; Else, nothing noticeable found: get indentation and go on.
20118 (t (setq column (org-get-indentation))))))
20119 ;; Now apply indentation and move cursor accordingly
20120 (goto-char pos)
20121 (if (<= (current-column) (current-indentation))
20122 (org-indent-line-to column)
20123 (save-excursion (org-indent-line-to column)))
20124 ;; Special polishing for properties, see `org-property-format'
20125 (setq column (current-column))
20126 (beginning-of-line 1)
20127 (if (looking-at
20129 (replace-match (concat (match-string 1)
20130 (format org-property-format
20131 (match-string 2) (match-string 3)))
20132 t t))
20133 (org-move-to-column column)))
20135 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20136 "Variable to store copy of `adaptive-fill-regexp'.
20137 Since `adaptive-fill-regexp' is set to never match, we need to
20138 store a backup of its value before entering `org-mode' so that
20139 the functionality can be provided as a fall-back.")
20141 (defun org-set-autofill-regexps ()
20142 (interactive)
20143 ;; In the paragraph separator we include headlines, because filling
20144 ;; text in a line directly attached to a headline would otherwise
20145 ;; fill the headline as well.
20148 ;; The paragraph starter includes hand-formatted lists.
20149 (org-set-local
20150 'paragraph-start
20151 (concat
20160 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20161 ;; But only if the user has not turned off tables or fixed-width regions
20162 (org-set-local
20163 'auto-fill-inhibit-regexp
20164 (concat org-outline-regexp
20167 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20168 (concat
20170 (if org-enable-table-editor "|" "")
20171 (if org-enable-fixed-width-editor ":" "")
20172 "]"))))
20173 ;; We use our own fill-paragraph function, to make sure that tables
20174 ;; and fixed-width regions are not wrapped. That function will pass
20175 ;; through to `fill-paragraph' when appropriate.
20176 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20177 ;; Prevent auto-fill from inserting unwanted new items.
20178 (if (boundp 'fill-nobreak-predicate)
20179 (org-set-local 'fill-nobreak-predicate
20180 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20181 fill-nobreak-predicate
20182 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20183 ;; Adaptive filling: To get full control, first make sure that
20184 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20185 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20186 (org-set-local 'org-adaptive-fill-regexp-backup
20187 adaptive-fill-regexp))
20189 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20190 (org-set-local 'adaptive-fill-function
20191 'org-adaptive-fill-function)
20192 (org-set-local
20193 'align-mode-rules-list
20194 '((org-in-buffer-settings
20196 (modes . '(org-mode))))))
20198 (defun org-fill-item-nobreak-p ()
20199 "Non-nil when a line break at point would insert a new item."
20200 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20202 (defun org-fill-paragraph (&optional justify)
20203 "Re-align a table, pass through to fill-paragraph if no table."
20204 (let ((table-p (org-at-table-p))
20205 (table.el-p (org-at-table.el-p))
20206 (itemp (org-in-item-p)))
20207 (cond ((and (equal (char-after (point-at-bol)) ?*)
20208 (save-excursion (goto-char (point-at-bol))
20209 (looking-at org-outline-regexp)))
20210 t) ; skip headlines
20211 (table.el-p t) ; skip table.el tables
20212 (table-p (org-table-align) t) ; align Org tables
20213 (itemp ; align text in items
20214 (let* ((struct (save-excursion (goto-char itemp)
20215 (org-list-struct)))
20216 (parents (org-list-parents-alist struct))
20217 (children (org-list-get-children itemp struct parents))
20218 beg end prev next prefix)
20219 ;; Determine in which part of item point is: before
20220 ;; first child, after last child, between two
20221 ;; sub-lists, or simply in item if there's no child.
20222 (cond
20223 ((not children)
20224 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20225 beg itemp
20226 end (org-list-get-item-end itemp struct)))
20227 ((< (point) (setq next (car children)))
20228 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20229 beg itemp
20230 end next))
20231 ((> (point) (setq prev (car (last children))))
20232 (setq beg (org-list-get-item-end prev struct)
20233 end (org-list-get-item-end itemp struct)
20234 prefix (save-excursion
20235 (goto-char beg)
20237 (make-string (current-column) ?\ ))))
20238 (t (catch 'exit
20239 (while (setq next (pop children))
20240 (if (> (point) next)
20241 (setq prev next)
20242 (setq beg (org-list-get-item-end prev struct)
20243 end next
20244 prefix (save-excursion
20245 (goto-char beg)
20247 (make-string (current-column) ?\ )))
20248 (throw 'exit nil))))))
20249 ;; Use `fill-paragraph' with buffer narrowed to item
20250 ;; without any child, and with our computed PREFIX.
20251 (flet ((fill-context-prefix (from to &optional flr) prefix))
20252 (save-restriction
20253 (narrow-to-region beg end)
20254 (save-excursion (fill-paragraph justify)))) t))
20255 ;; Special case where point is not in a list but is on
20256 ;; a paragraph adjacent to a list: make sure this paragraph
20257 ;; doesn't get merged with the end of the list by narrowing
20258 ;; buffer first.
20259 ((save-excursion (forward-paragraph -1)
20260 (setq itemp (org-in-item-p)))
20261 (let ((struct (save-excursion (goto-char itemp)
20262 (org-list-struct))))
20263 (save-restriction
20264 (narrow-to-region (org-list-get-bottom-point struct)
20265 (save-excursion (forward-paragraph 1)
20266 (point)))
20267 (fill-paragraph justify) t)))
20268 ;; Else simply call `fill-paragraph'.
20269 (t nil))))
20271 ;; For reference, this is the default value of adaptive-fill-regexp
20274 (defun org-adaptive-fill-function ()
20275 "Return a fill prefix for org-mode files."
20276 (let (itemp)
20277 (save-excursion
20278 (cond
20279 ;; Comment line
20281 (match-string-no-properties 0))
20282 ;; Plain list item
20283 ((org-at-item-p)
20284 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20285 ;; Point is in a list after `backward-paragraph': original
20286 ;; point wasn't in the list, or filling would have been taken
20287 ;; care of by `org-auto-fill-function', but the list and the
20288 ;; real paragraph are not separated by a blank line. Thus, move
20289 ;; point after the list to go back to real paragraph and
20290 ;; determine fill-prefix.
20291 ((setq itemp (org-in-item-p))
20292 (goto-char itemp)
20293 (let* ((struct (org-list-struct))
20294 (bottom (org-list-get-bottom-point struct)))
20295 (goto-char bottom)
20296 (make-string (org-get-indentation) ?\ )))
20297 ;; Other text
20298 ((looking-at org-adaptive-fill-regexp-backup)
20299 (match-string-no-properties 0))))))
20301 (defun org-auto-fill-function ()
20302 "Auto-fill function."
20303 (let (itemp prefix)
20304 ;; When in a list, compute an appropriate fill-prefix and make
20305 ;; sure it will be used by `do-auto-fill'.
20306 (if (setq itemp (org-in-item-p))
20307 (progn
20308 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20309 (flet ((fill-context-prefix (from to &optional flr) prefix))
20310 (do-auto-fill)))
20311 ;; Else just use `do-auto-fill'.
20312 (do-auto-fill))))
20314 ;;; Other stuff.
20316 (defun org-toggle-fixed-width-section (arg)
20317 "Toggle the fixed-width export.
20318 If there is no active region, the QUOTE keyword at the current headline is
20319 inserted or removed. When present, it causes the text between this headline
20320 and the next to be exported as fixed-width text, and unmodified.
20321 If there is an active region, this command adds or removes a colon as the
20322 first character of this line. If the first character of a line is a colon,
20323 this line is also exported in fixed-width font."
20324 (interactive "P")
20325 (let* ((cc 0)
20326 (regionp (org-region-active-p))
20327 (beg (if regionp (region-beginning) (point)))
20328 (end (if regionp (region-end)))
20329 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20330 (case-fold-search nil)
20332 off)
20333 (if regionp
20334 (save-excursion
20335 (goto-char beg)
20336 (setq cc (current-column))
20337 (beginning-of-line 1)
20338 (setq off (looking-at re))
20339 (while (> nlines 0)
20340 (setq nlines (1- nlines))
20341 (beginning-of-line 1)
20342 (cond
20343 (arg
20344 (org-move-to-column cc t)
20346 (forward-line -1))
20347 ((and off (looking-at re))
20348 (replace-match "" t t nil 1))
20349 ((not off) (org-move-to-column cc t) (insert ": ")))
20350 (forward-line 1)))
20351 (save-excursion
20352 (org-back-to-heading)
20353 (cond
20354 ((looking-at (format org-heading-keyword-regexp-format
20355 org-quote-string))
20356 (goto-char (match-end 1))
20357 (looking-at (concat " +" org-quote-string))
20358 (replace-match "" t t)
20359 (when (eolp) (insert " ")))
20360 ((looking-at org-outline-regexp)
20361 (goto-char (match-end 0))
20362 (insert org-quote-string " ")))))))
20364 (defun org-reftex-citation ()
20365 "Use reftex-citation to insert a citation into the buffer.
20366 This looks for a line like
20368 #+BIBLIOGRAPHY: foo plain option:-d
20370 and derives from it that foo.bib is the bibliography file relevant
20371 for this document. It then installs the necessary environment for RefTeX
20372 to work in this buffer and calls `reftex-citation' to insert a citation
20373 into the buffer.
20375 Export of such citations to both LaTeX and HTML is handled by the contributed
20376 package org-exp-bibtex by Taru Karttunen."
20377 (interactive)
20378 (let ((reftex-docstruct-symbol 'rds)
20380 rds bib)
20381 (save-excursion
20382 (save-restriction
20383 (widen)
20384 (let ((case-fold-search t)
20386 (if (not (save-excursion
20387 (or (re-search-forward re nil t)
20388 (re-search-backward re nil t))))
20389 (error "No bibliography defined in file")
20390 (setq bib (concat (match-string 1) ".bib")
20391 rds (list (list 'bib bib)))))))
20392 (call-interactively 'reftex-citation)))
20394 ;;;; Functions extending outline functionality
20396 (defun org-beginning-of-line (&optional arg)
20397 "Go to the beginning of the current line. If that is invisible, continue
20398 to a visible line beginning. This makes the function of C-a more intuitive.
20399 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20400 first attempt, and only move to after the tags when the cursor is already
20401 beyond the end of the headline."
20402 (interactive "P")
20403 (let ((pos (point))
20404 (special (if (consp org-special-ctrl-a/e)
20405 (car org-special-ctrl-a/e)
20406 org-special-ctrl-a/e))
20407 refpos)
20408 (if (org-bound-and-true-p line-move-visual)
20409 (beginning-of-visual-line 1)
20410 (beginning-of-line 1))
20411 (if (and arg (fboundp 'move-beginning-of-line))
20412 (call-interactively 'move-beginning-of-line)
20413 (if (bobp)
20414 nil
20415 (backward-char 1)
20416 (if (org-truely-invisible-p)
20417 (while (and (not (bobp)) (org-truely-invisible-p))
20418 (backward-char 1)
20419 (beginning-of-line 1))
20420 (forward-char 1))))
20421 (when special
20422 (cond
20423 ((and (looking-at org-complex-heading-regexp)
20424 (= (char-after (match-end 1)) ?\ ))
20425 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20426 (point-at-eol)))
20427 (goto-char
20428 (if (eq special t)
20429 (cond ((> pos refpos) refpos)
20430 ((= pos (point)) refpos)
20431 (t (point)))
20432 (cond ((> pos (point)) (point))
20433 ((not (eq last-command this-command)) (point))
20434 (t refpos)))))
20435 ((org-at-item-p)
20436 (goto-char
20437 (if (eq special t)
20438 (cond ((> pos (match-end 0)) (match-end 0))
20439 ((= pos (point)) (match-end 0))
20440 (t (point)))
20441 (cond ((> pos (point)) (point))
20442 ((not (eq last-command this-command)) (point))
20443 (t (match-end 0))))))))
20444 (org-no-warnings
20445 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20447 (defun org-end-of-line (&optional arg)
20448 "Go to the end of the line.
20449 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20450 first attempt, and only move to after the tags when the cursor is already
20451 beyond the end of the headline."
20452 (interactive "P")
20453 (let ((special (if (consp org-special-ctrl-a/e)
20454 (cdr org-special-ctrl-a/e)
20455 org-special-ctrl-a/e)))
20456 (cond
20457 ((or (not special) arg
20458 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20459 (call-interactively
20460 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20461 ((fboundp 'move-end-of-line) 'move-end-of-line)
20462 (t 'end-of-line))))
20463 ((org-at-heading-p)
20464 (let ((pos (point)))
20465 (beginning-of-line 1)
20467 (if (eq special t)
20468 (if (or (< pos (match-beginning 1))
20469 (= pos (match-end 0)))
20470 (goto-char (match-beginning 1))
20471 (goto-char (match-end 0)))
20472 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20473 (goto-char (match-end 0))
20474 (goto-char (match-beginning 1))))
20475 (call-interactively (if (fboundp 'move-end-of-line)
20476 'move-end-of-line
20477 'end-of-line)))))
20478 ((org-at-drawer-p)
20479 (move-end-of-line 1)
20480 (when (overlays-at (1- (point))) (backward-char 1)))
20481 ;; At an item: Move before any hidden text.
20482 (t (call-interactively 'end-of-line)))
20483 (org-no-warnings
20484 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20486 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20487 (define-key org-mode-map "\C-e" 'org-end-of-line)
20489 (defun org-backward-sentence (&optional arg)
20490 "Go to beginning of sentence, or beginning of table field.
20491 This will call `backward-sentence' or `org-table-beginning-of-field',
20492 depending on context."
20493 (interactive "P")
20494 (cond
20495 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20496 (t (call-interactively 'backward-sentence))))
20498 (defun org-forward-sentence (&optional arg)
20499 "Go to end of sentence, or end of table field.
20500 This will call `forward-sentence' or `org-table-end-of-field',
20501 depending on context."
20502 (interactive "P")
20503 (cond
20504 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20505 (t (call-interactively 'forward-sentence))))
20507 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20508 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20510 (defun org-kill-line (&optional arg)
20511 "Kill line, to tags or end of line."
20512 (interactive "P")
20513 (cond
20514 ((or (not org-special-ctrl-k)
20515 (bolp)
20516 (not (org-at-heading-p)))
20517 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20518 org-ctrl-k-protect-subtree)
20519 (if (or (eq org-ctrl-k-protect-subtree 'error)
20520 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20521 (error "C-k aborted - would kill hidden subtree")))
20522 (call-interactively
20523 (if visual-line-mode 'kill-visual-line 'kill-line)))
20525 (kill-region (point) (match-beginning 1))
20526 (org-set-tags nil t))
20527 (t (kill-region (point) (point-at-eol)))))
20529 (define-key org-mode-map "\C-k" 'org-kill-line)
20531 (defun org-yank (&optional arg)
20532 "Yank. If the kill is a subtree, treat it specially.
20533 This command will look at the current kill and check if is a single
20534 subtree, or a series of subtrees[1]. If it passes the test, and if the
20535 cursor is at the beginning of a line or after the stars of a currently
20536 empty headline, then the yank is handled specially. How exactly depends
20537 on the value of the following variables, both set by default.
20539 org-yank-folded-subtrees
20540 When set, the subtree(s) will be folded after insertion, but only
20541 if doing so would now swallow text after the yanked text.
20543 org-yank-adjusted-subtrees
20544 When set, the subtree will be promoted or demoted in order to
20545 fit into the local outline tree structure, which means that the level
20546 will be adjusted so that it becomes the smaller one of the two
20547 *visible* surrounding headings.
20549 Any prefix to this command will cause `yank' to be called directly with
20551 will just
20552 plainly yank the text as it is.
20554 \[1] The test checks if the first non-white line is a heading
20555 and if there are no other headings with fewer stars."
20556 (interactive "P")
20557 (org-yank-generic 'yank arg))
20559 (defun org-yank-generic (command arg)
20560 "Perform some yank-like command.
20562 This function implements the behavior described in the `org-yank'
20563 documentation. However, it has been generalized to work for any
20564 interactive command with similar behavior."
20566 ;; pretend to be command COMMAND
20567 (setq this-command command)
20569 (if arg
20570 (call-interactively command)
20572 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20573 (and (org-kill-is-subtree-p)
20574 (or (bolp)
20576 (string-match
20578 (buffer-substring (point-at-bol) (point)))))))
20579 swallowp)
20580 (cond
20581 ((and subtreep org-yank-folded-subtrees)
20582 (let ((beg (point))
20583 end)
20584 (if (and subtreep org-yank-adjusted-subtrees)
20585 (org-paste-subtree nil nil 'for-yank)
20586 (call-interactively command))
20588 (setq end (point))
20589 (goto-char beg)
20590 (when (and (bolp) subtreep
20591 (not (setq swallowp
20592 (org-yank-folding-would-swallow-text beg end))))
20593 (org-with-limited-levels
20594 (or (looking-at org-outline-regexp)
20595 (re-search-forward org-outline-regexp-bol end t))
20596 (while (and (< (point) end) (looking-at org-outline-regexp))
20597 (hide-subtree)
20598 (org-cycle-show-empty-lines 'folded)
20599 (condition-case nil
20600 (outline-forward-same-level 1)
20601 (error (goto-char end))))))
20602 (when swallowp
20603 (message
20604 "Inserted text not folded because that would swallow text"))
20606 (goto-char end)
20608 (beginning-of-line 1)
20609 (push-mark beg 'nomsg)))
20610 ((and subtreep org-yank-adjusted-subtrees)
20611 (let ((beg (point-at-bol)))
20612 (org-paste-subtree nil nil 'for-yank)
20613 (push-mark beg 'nomsg)))
20614 (t
20615 (call-interactively command))))))
20617 (defun org-yank-folding-would-swallow-text (beg end)
20618 "Would hide-subtree at BEG swallow any text after END?"
20619 (let (level)
20620 (org-with-limited-levels
20621 (save-excursion
20622 (goto-char beg)
20623 (when (or (looking-at org-outline-regexp)
20624 (re-search-forward org-outline-regexp-bol end t))
20625 (setq level (org-outline-level)))
20626 (goto-char end)
20628 (if (or (eobp)
20629 (and (bolp) (looking-at org-outline-regexp)
20630 (<= (org-outline-level) level)))
20631 nil ; Nothing would be swallowed
20632 t))))) ; something would swallow
20634 (define-key org-mode-map "\C-y" 'org-yank)
20636 (defun org-truely-invisible-p ()
20637 "Check if point is at a character currently not visible.
20638 This version does not only check the character property, but also
20639 `visible-mode'."
20640 ;; Early versions of noutline don't have `outline-invisible-p'.
20641 (if (org-bound-and-true-p visible-mode)
20642 nil
20643 (outline-invisible-p)))
20645 (defun org-invisible-p2 ()
20646 "Check if point is at a character currently not visible."
20647 (save-excursion
20648 (if (and (eolp) (not (bobp))) (backward-char 1))
20649 ;; Early versions of noutline don't have `outline-invisible-p'.
20650 (outline-invisible-p)))
20652 (defun org-back-to-heading (&optional invisible-ok)
20653 "Call `outline-back-to-heading', but provide a better error message."
20654 (condition-case nil
20655 (outline-back-to-heading invisible-ok)
20656 (error (error "Before first headline at position %d in buffer %s"
20657 (point) (current-buffer)))))
20659 (defun org-beginning-of-defun ()
20660 "Go to the beginning of the subtree, i.e. back to the heading."
20661 (org-back-to-heading))
20662 (defun org-end-of-defun ()
20663 "Go to the end of the subtree."
20664 (org-end-of-subtree nil t))
20666 (defun org-before-first-heading-p ()
20667 "Before first heading?"
20668 (save-excursion
20669 (end-of-line)
20670 (null (re-search-backward org-outline-regexp-bol nil t))))
20672 (defun org-at-heading-p (&optional ignored)
20673 (outline-on-heading-p t))
20674 ;; Compatibility alias with Org versions < 7.8.03
20675 (defalias 'org-on-heading-p 'org-at-heading-p)
20677 (defun org-at-drawer-p nil
20678 "Whether point is at a drawer."
20679 (save-excursion
20680 (move-beginning-of-line 1)
20681 (looking-at org-drawer-regexp)))
20683 (defun org-point-at-end-of-empty-headline ()
20684 "If point is at the end of an empty headline, return t, else nil.
20685 If the heading only contains a TODO keyword, it is still still considered
20686 empty."
20688 (save-excursion
20689 (beginning-of-line 1)
20690 (let ((case-fold-search nil))
20691 (looking-at org-todo-line-regexp)))
20692 (string= (match-string 3) "")))
20694 (defun org-at-heading-or-item-p ()
20695 (or (org-at-heading-p) (org-at-item-p)))
20697 (defun org-at-target-p ()
20698 (or (org-in-regexp org-radio-target-regexp)
20699 (org-in-regexp org-target-regexp)))
20700 ;; Compatibility alias with Org versions < 7.8.03
20701 (defalias 'org-on-target-p 'org-at-target-p)
20703 (defun org-up-heading-all (arg)
20704 "Move to the heading line of which the present line is a subheading.
20705 This function considers both visible and invisible heading lines.
20706 With argument, move up ARG levels."
20707 (if (fboundp 'outline-up-heading-all)
20708 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20709 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20711 (defun org-up-heading-safe ()
20712 "Move to the heading line of which the present line is a subheading.
20713 This version will not throw an error. It will return the level of the
20714 headline found, or nil if no higher level is found.
20716 Also, this function will be a lot faster than `outline-up-heading',
20717 because it relies on stars being the outline starters. This can really
20718 make a significant difference in outlines with very many siblings."
20719 (let (start-level re)
20720 (org-back-to-heading t)
20721 (setq start-level (funcall outline-level))
20722 (if (equal start-level 1)
20723 nil
20725 (if (re-search-backward re nil t)
20726 (funcall outline-level)))))
20728 (defun org-first-sibling-p ()
20729 "Is this heading the first child of its parents?"
20730 (interactive)
20731 (let ((re org-outline-regexp-bol)
20732 level l)
20733 (unless (org-at-heading-p t)
20734 (error "Not at a heading"))
20735 (setq level (funcall outline-level))
20736 (save-excursion
20737 (if (not (re-search-backward re nil t))
20738 t
20739 (setq l (funcall outline-level))
20740 (< l level)))))
20742 (defun org-goto-sibling (&optional previous)
20743 "Goto the next sibling, even if it is invisible.
20744 When PREVIOUS is set, go to the previous sibling instead. Returns t
20745 when a sibling was found. When none is found, return nil and don't
20746 move point."
20747 (let ((fun (if previous 're-search-backward 're-search-forward))
20748 (pos (point))
20749 (re org-outline-regexp-bol)
20750 level l)
20751 (when (condition-case nil (org-back-to-heading t) (error nil))
20752 (setq level (funcall outline-level))
20753 (catch 'exit
20754 (or previous (forward-char 1))
20755 (while (funcall fun re nil t)
20756 (setq l (funcall outline-level))
20757 (when (< l level) (goto-char pos) (throw 'exit nil))
20758 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20759 (goto-char pos)
20760 nil))))
20762 (defun org-show-siblings ()
20763 "Show all siblings of the current headline."
20764 (save-excursion
20765 (while (org-goto-sibling) (org-flag-heading nil)))
20766 (save-excursion
20767 (while (org-goto-sibling 'previous)
20768 (org-flag-heading nil))))
20770 (defun org-goto-first-child ()
20771 "Goto the first child, even if it is invisible.
20772 Return t when a child was found. Otherwise don't move point and
20773 return nil."
20774 (let (level (pos (point)) (re org-outline-regexp-bol))
20775 (when (condition-case nil (org-back-to-heading t) (error nil))
20776 (setq level (outline-level))
20777 (forward-char 1)
20778 (if (and (re-search-forward re nil t) (> (outline-level) level))
20779 (progn (goto-char (match-beginning 0)) t)
20780 (goto-char pos) nil))))
20782 (defun org-show-hidden-entry ()
20783 "Show an entry where even the heading is hidden."
20784 (save-excursion
20785 (org-show-entry)))
20787 (defun org-flag-heading (flag &optional entry)
20788 "Flag the current heading. FLAG non-nil means make invisible.
20789 When ENTRY is non-nil, show the entire entry."
20790 (save-excursion
20791 (org-back-to-heading t)
20792 ;; Check if we should show the entire entry
20793 (if entry
20794 (progn
20795 (org-show-entry)
20796 (save-excursion
20797 (and (outline-next-heading)
20798 (org-flag-heading nil))))
20799 (outline-flag-region (max (point-min) (1- (point)))
20800 (save-excursion (outline-end-of-heading) (point))
20801 flag))))
20803 (defun org-get-next-sibling ()
20804 "Move to next heading of the same level, and return point.
20805 If there is no such heading, return nil.
20806 This is like outline-next-sibling, but invisible headings are ok."
20807 (let ((level (funcall outline-level)))
20808 (outline-next-heading)
20809 (while (and (not (eobp)) (> (funcall outline-level) level))
20810 (outline-next-heading))
20811 (if (or (eobp) (< (funcall outline-level) level))
20812 nil
20813 (point))))
20815 (defun org-get-last-sibling ()
20816 "Move to previous heading of the same level, and return point.
20817 If there is no such heading, return nil."
20818 (let ((opoint (point))
20819 (level (funcall outline-level)))
20820 (outline-previous-heading)
20821 (when (and (/= (point) opoint) (outline-on-heading-p t))
20822 (while (and (> (funcall outline-level) level)
20823 (not (bobp)))
20824 (outline-previous-heading))
20825 (if (< (funcall outline-level) level)
20826 nil
20827 (point)))))
20829 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20830 ;; This contains an exact copy of the original function, but it uses
20831 ;; `org-back-to-heading', to make it work also in invisible
20832 ;; trees. And is uses an invisible-OK argument.
20833 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20834 ;; Furthermore, when used inside Org, finding the end of a large subtree
20835 ;; with many children and grandchildren etc, this can be much faster
20836 ;; than the outline version.
20837 (org-back-to-heading invisible-OK)
20838 (let ((first t)
20839 (level (funcall outline-level)))
20840 (if (and (eq major-mode 'org-mode) (< level 1000))
20841 ;; A true heading (not a plain list item), in Org-mode
20842 ;; This means we can easily find the end by looking
20843 ;; only for the right number of stars. Using a regexp to do
20844 ;; this is so much faster than using a Lisp loop.
20846 (forward-char 1)
20847 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20848 ;; something else, do it the slow way
20849 (while (and (not (eobp))
20850 (or first (> (funcall outline-level) level)))
20851 (setq first nil)
20852 (outline-next-heading)))
20853 (unless to-heading
20855 (progn
20856 ;; Go to end of line before heading
20857 (forward-char -1)
20859 ;; leave blank line before heading
20860 (forward-char -1))))))
20861 (point))
20863 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20864 "Use Org version in org-mode, for dramatic speed-up."
20865 (if (eq major-mode 'org-mode)
20866 (progn
20867 (org-end-of-subtree nil t)
20868 (unless (eobp) (backward-char 1)))
20869 ad-do-it))
20871 (defun org-end-of-meta-data-and-drawers ()
20872 "Jump to the first text after meta data and drawers in the current entry.
20873 This will move over empty lines, lines with planning time stamps,
20874 clocking lines, and drawers."
20875 (org-back-to-heading t)
20876 (let ((end (save-excursion (outline-next-heading) (point)))
20879 (forward-line 1)
20880 (while (re-search-forward re end t)
20881 (if (not (match-end 1))
20882 ;; empty or planning line
20883 (forward-line 1)
20884 ;; a drawer, find the end
20886 (forward-line 1)))
20888 (point)))
20890 (defun org-forward-same-level (arg &optional invisible-ok)
20891 "Move forward to the arg'th subheading at same level as this one.
20892 Stop at the first and last subheadings of a superior heading.
20893 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20894 it wil also look at invisible ones."
20895 (interactive "p")
20896 (org-back-to-heading invisible-ok)
20897 (org-at-heading-p)
20898 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20900 l)
20901 (forward-char 1)
20902 (while (> arg 0)
20903 (while (and (re-search-forward re nil 'move)
20904 (setq l (- (match-end 0) (match-beginning 0) 1))
20905 (= l level)
20906 (not invisible-ok)
20907 (progn (backward-char 1) (outline-invisible-p)))
20908 (if (< l level) (setq arg 1)))
20909 (setq arg (1- arg)))
20910 (beginning-of-line 1)))
20912 (defun org-backward-same-level (arg &optional invisible-ok)
20913 "Move backward to the arg'th subheading at same level as this one.
20914 Stop at the first and last subheadings of a superior heading."
20915 (interactive "p")
20916 (org-back-to-heading)
20917 (org-at-heading-p)
20918 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20920 l)
20921 (while (> arg 0)
20922 (while (and (re-search-backward re nil 'move)
20923 (setq l (- (match-end 0) (match-beginning 0) 1))
20924 (= l level)
20925 (not invisible-ok)
20926 (outline-invisible-p))
20927 (if (< l level) (setq arg 1)))
20928 (setq arg (1- arg)))))
20930 (defun org-show-subtree ()
20931 "Show everything after this heading at deeper levels."
20932 (outline-flag-region
20933 (point)
20934 (save-excursion
20935 (org-end-of-subtree t t))
20936 nil))
20938 (defun org-show-entry ()
20939 "Show the body directly following this heading.
20940 Show the heading too, if it is currently invisible."
20941 (interactive)
20942 (save-excursion
20943 (condition-case nil
20944 (progn
20945 (org-back-to-heading t)
20946 (outline-flag-region
20947 (max (point-min) (1- (point)))
20948 (save-excursion
20949 (if (re-search-forward
20951 (match-beginning 1)
20952 (point-max)))
20953 nil)
20954 (org-cycle-hide-drawers 'children))
20955 (error nil))))
20957 (defun org-make-options-regexp (kwds &optional extra)
20958 "Make a regular expression for keyword lines."
20959 (concat
20960 "^"
20967 ;; Make isearch reveal the necessary context
20968 (defun org-isearch-end ()
20969 "Reveal context after isearch exits."
20970 (when isearch-success ; only if search was successful
20971 (if (featurep 'xemacs)
20972 ;; Under XEmacs, the hook is run in the correct place,
20973 ;; we directly show the context.
20974 (org-show-context 'isearch)
20975 ;; In Emacs the hook runs *before* restoring the overlays.
20976 ;; So we have to use a one-time post-command-hook to do this.
20977 ;; (Emacs 22 has a special variable, see function `org-mode')
20978 (unless (and (boundp 'isearch-mode-end-hook-quit)
20979 isearch-mode-end-hook-quit)
20980 ;; Only when the isearch was not quitted.
20981 (org-add-hook 'post-command-hook 'org-isearch-post-command
20982 'append 'local)))))
20984 (defun org-isearch-post-command ()
20985 "Remove self from hook, and show context."
20986 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20987 (org-show-context 'isearch))
20990 ;;;; Integration with and fixes for other packages
20992 ;;; Imenu support
20994 (defvar org-imenu-markers nil
20995 "All markers currently used by Imenu.")
20996 (make-variable-buffer-local 'org-imenu-markers)
20998 (defun org-imenu-new-marker (&optional pos)
20999 "Return a new marker for use by Imenu, and remember the marker."
21000 (let ((m (make-marker)))
21001 (move-marker m (or pos (point)))
21002 (push m org-imenu-markers)
21003 m))
21005 (defun org-imenu-get-tree ()
21006 "Produce the index for Imenu."
21007 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21008 (setq org-imenu-markers nil)
21009 (let* ((n org-imenu-depth)
21010 (re (concat "^" (org-get-limited-outline-regexp)))
21011 (subs (make-vector (1+ n) nil))
21012 (last-level 0)
21013 m level head)
21014 (save-excursion
21015 (save-restriction
21016 (widen)
21017 (goto-char (point-max))
21018 (while (re-search-backward re nil t)
21019 (setq level (org-reduced-level (funcall outline-level)))
21020 (when (<= level n)
21021 (looking-at org-complex-heading-regexp)
21022 (setq head (org-link-display-format
21023 (org-match-string-no-properties 4))
21024 m (org-imenu-new-marker))
21025 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21026 (if (>= level last-level)
21027 (push (cons head m) (aref subs level))
21028 (push (cons head (aref subs (1+ level))) (aref subs level))
21029 (loop for i from (1+ level) to n do (aset subs i nil)))
21030 (setq last-level level)))))
21031 (aref subs 1)))
21033 (eval-after-load "imenu"
21034 '(progn
21035 (add-hook 'imenu-after-jump-hook
21036 (lambda ()
21037 (if (eq major-mode 'org-mode)
21038 (org-show-context 'org-goto))))))
21040 (defun org-link-display-format (link)
21041 "Replace a link with either the description, or the link target
21042 if no description is present"
21043 (save-match-data
21044 (if (string-match org-bracket-link-analytic-regexp link)
21045 (replace-match (if (match-end 5)
21046 (match-string 5 link)
21047 (concat (match-string 1 link)
21048 (match-string 3 link)))
21049 nil t link)
21050 link)))
21052 (defun org-toggle-link-display ()
21053 "Toggle the literal or descriptive display of links."
21054 (interactive)
21055 (if org-descriptive-links
21056 (progn (org-remove-from-invisibility-spec '(org-link))
21057 (org-restart-font-lock)
21058 (setq org-descriptive-links nil))
21059 (progn (add-to-invisibility-spec '(org-link))
21060 (org-restart-font-lock)
21061 (setq org-descriptive-links t))))
21063 ;; Speedbar support
21065 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21066 "Overlay marking the agenda restriction line in speedbar.")
21067 (overlay-put org-speedbar-restriction-lock-overlay
21068 'face 'org-agenda-restriction-lock)
21069 (overlay-put org-speedbar-restriction-lock-overlay
21070 'help-echo "Agendas are currently limited to this item.")
21071 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21073 (defun org-speedbar-set-agenda-restriction ()
21074 "Restrict future agenda commands to the location at point in speedbar.
21076 (interactive)
21077 (require 'org-agenda)
21078 (let (p m tp np dir txt)
21079 (cond
21080 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21081 'org-imenu t))
21082 (setq m (get-text-property p 'org-imenu-marker))
21083 (with-current-buffer (marker-buffer m)
21084 (goto-char m)
21085 (org-agenda-set-restriction-lock 'subtree)))
21086 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21087 'speedbar-function 'speedbar-find-file))
21088 (setq tp (previous-single-property-change
21089 (1+ p) 'speedbar-function)
21090 np (next-single-property-change
21091 tp 'speedbar-function)
21092 dir (speedbar-line-directory)
21093 txt (buffer-substring-no-properties (or tp (point-min))
21094 (or np (point-max))))
21095 (with-current-buffer (find-file-noselect
21096 (let ((default-directory dir))
21097 (expand-file-name txt)))
21098 (unless (eq major-mode 'org-mode)
21099 (error "Cannot restrict to non-Org-mode file"))
21100 (org-agenda-set-restriction-lock 'file)))
21101 (t (error "Don't know how to restrict Org-mode's agenda")))
21102 (move-overlay org-speedbar-restriction-lock-overlay
21103 (point-at-bol) (point-at-eol))
21104 (setq current-prefix-arg nil)
21105 (org-agenda-maybe-redo)))
21107 (eval-after-load "speedbar"
21108 '(progn
21109 (speedbar-add-supported-extension ".org")
21110 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21111 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21112 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21113 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21114 (add-hook 'speedbar-visiting-tag-hook
21115 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21117 ;;; Fixes and Hacks for problems with other packages
21119 ;; Make flyspell not check words in links, to not mess up our keymap
21120 (defun org-mode-flyspell-verify ()
21121 "Don't let flyspell put overlays at active buttons, or on
21122 {todo,all-time,additional-option-like}-keywords."
21123 (let ((pos (max (1- (point)) (point-min)))
21124 (word (thing-at-point 'word)))
21125 (and (not (get-text-property pos 'keymap))
21126 (not (get-text-property pos 'org-no-flyspell))
21127 (not (member word org-todo-keywords-1))
21128 (not (member word org-all-time-keywords))
21129 (not (member word org-additional-option-like-keywords)))))
21131 (defun org-remove-flyspell-overlays-in (beg end)
21132 "Remove flyspell overlays in region."
21133 (and (org-bound-and-true-p flyspell-mode)
21134 (fboundp 'flyspell-delete-region-overlays)
21135 (flyspell-delete-region-overlays beg end))
21136 (add-text-properties beg end '(org-no-flyspell t)))
21138 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21139 (eval-after-load "bookmark"
21140 '(if (boundp 'bookmark-after-jump-hook)
21141 ;; We can use the hook
21142 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21143 ;; Hook not available, use advice
21144 (defadvice bookmark-jump (after org-make-visible activate)
21145 "Make the position visible."
21146 (org-bookmark-jump-unhide))))
21148 ;; Make sure saveplace shows the location if it was hidden
21149 (eval-after-load "saveplace"
21150 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21151 "Make the position visible."
21152 (org-bookmark-jump-unhide)))
21154 ;; Make sure ecb shows the location if it was hidden
21155 (eval-after-load "ecb"
21156 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21157 "Make hierarchy visible when jumping into location from ECB tree buffer."
21158 (if (eq major-mode 'org-mode)
21159 (org-show-context))))
21161 (defun org-bookmark-jump-unhide ()
21162 "Unhide the current position, to show the bookmark location."
21163 (and (eq major-mode 'org-mode)
21164 (or (outline-invisible-p)
21165 (save-excursion (goto-char (max (point-min) (1- (point))))
21166 (outline-invisible-p)))
21167 (org-show-context 'bookmark-jump)))
21169 ;; Make session.el ignore our circular variable
21170 (eval-after-load "session"
21171 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21173 ;;;; Experimental code
21175 (defun org-closed-in-range ()
21176 "Sparse tree of items closed in a certain time range.
21177 Still experimental, may disappear in the future."
21178 (interactive)
21179 ;; Get the time interval from the user.
21180 (let* ((time1 (org-float-time
21181 (org-read-date nil 'to-time nil "Starting date: ")))
21182 (time2 (org-float-time
21183 (org-read-date nil 'to-time nil "End date:")))
21184 ;; callback function
21185 (callback (lambda ()
21186 (let ((time
21187 (org-float-time
21188 (apply 'encode-time
21189 (org-parse-time-string
21190 (match-string 1))))))
21191 ;; check if time in interval
21192 (and (>= time time1) (<= time time2))))))
21193 ;; make tree, check each match with the callback
21196 ;;;; Finish up
21198 (provide 'org)
21200 (run-hooks 'org-load-hook)
21202 ;;; org.el ends here