| blob | 61cef0a83e267dbdabe4b57ce1d413f906b29033 |
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
1019 keyword. In an item, this will be the position after bullet and
1020 check-box, if any. When the cursor is already at that position,
1021 another `C-a' will bring it to the beginning of the line.
1023 `C-e' will jump to the end of the headline, ignoring the presence
1024 of tags in the headline. A second `C-e' will then jump to the
1025 true end of the line, after any tags. This also means that, when
1026 this variable is non-nil, `C-e' also will never jump beyond the
1027 end of the heading of a folded section, i.e. not after the
1028 ellipses.
1030 When set to the symbol `reversed', the first `C-a' or `C-e' works
1031 normally, going to the true line boundary first. Only a directly
1032 following, identical keypress will bring the cursor to the
1033 special positions.
1035 This may also be a cons cell where the behavior for `C-a' and
1036 `C-e' is set separately."
1055 "Non-nil means `C-k' will behave specially in headlines.
1056 When nil, `C-k' will call the default `kill-line' command.
1057 When t, the following will happen while the cursor is in the headline:
1059 - When the cursor is at the beginning of a headline, kill the entire
1060 line and possible the folded subtree below the line.
1061 - When in the middle of the headline text, kill the headline up to the tags.
1062 - When after the headline text, kill the tags."
1067 "Non-nil means, do not delete a hidden subtree with C-k.
1068 When set to the symbol `error', simply throw an error when C-k is
1069 used to kill (part-of) a headline that has hidden text behind it.
1070 Any other non-nil value will result in a query to the user, if it is
1071 OK to kill that hidden subtree. When nil, kill without remorse."
1079 "Check if in invisible region before inserting or deleting a character.
1080 Valid values are:
1082 nil Do not check, so just do invisible edits.
1083 error Throw an error and do nothing.
1084 show Make point visible, and do the requested edit.
1085 show-and-error Make point visible, then throw an error and abort the edit.
1086 smart Make point visible, and do insertion/deletion if it is
1087 adjacent to visible text and the change feels predictable.
1088 Never delete a previously invisible character or add in the
1089 middle or right after an invisible region. Basically, this
1090 allows insertion and backward-delete right before ellipses.
1091 FIXME: maybe in this case we should not even show?"
1101 "Non-nil means when yanking subtrees, fold them.
1102 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1103 it starts with a heading and all other headings in it are either children
1104 or siblings, then fold all the subtrees. However, do this only if no
1105 text after the yank would be swallowed into a folded tree by this action."
1110 "Non-nil means when yanking subtrees, adjust the level.
1111 With this setting, `org-paste-subtree' is used to insert the subtree, see
1112 this function for details."
1117 "Non-nil means M-RET will split the line at the cursor position.
1118 When nil, it will go to the end of the line before making a
1119 new line.
1120 You may also set this option in a different way for different
1121 contexts. Valid contexts are:
1123 headline when creating a new headline
1124 item when creating a new item
1125 table in a table field
1126 default the value to be used for all contexts not explicitly
1127 customized"
1144 "Non-nil means insert new headings after the current subtree.
1145 When nil, the new heading is created directly after the current line.
1148 for the duration of the command."
1154 "Should `org-insert-heading' leave a blank line before new heading/item?
1155 The value is an alist, with `heading' and `plain-list-item' as CAR,
1156 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1157 which case Org will look at the surrounding headings/items and try to
1158 make an intelligent decision whether to insert a blank line or not.
1160 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1161 set, the setting here is ignored and no empty line is inserted, to avoid
1162 breaking the list structure."
1175 "Hook being run after inserting a new heading."
1181 This currently only means they are never auto-wrapped.
1182 When nil, such lines will be treated like ordinary lines.
1183 See also the QUOTE keyword."
1188 "Non-nil means typing characters in `org-goto' starts incremental search."
1193 "Options concerning sparse trees in Org-mode."
1198 "Non-nil means highlight all matches that define a sparse tree.
1199 The highlights will automatically disappear the next time the buffer is
1200 changed by an edit command."
1205 "Non-nil means any change to the buffer will remove temporary highlights.
1206 Such highlights are created by `org-occur' and `org-clock-display'.
1207 When nil, `C-c C-c needs to be used to get rid of the highlights.
1208 The highlights created by `org-preview-latex-fragment' always need
1209 `C-c C-c' to be removed."
1216 "Hook that is run after `org-occur' has constructed a sparse tree.
1217 This can be used to recenter the window to show as much of the structure
1218 as possible."
1223 "Options concerning imenu and speedbar in Org-mode."
1228 "The maximum level for Imenu access to Org-mode headlines.
1229 This also applied for speedbar access."
1234 "Options concerning tables in Org-mode."
1240 When nil, such lines will be treated like ordinary lines.
1242 When equal to the symbol `optimized', the table editor will be optimized to
1243 do the following:
1244 - Automatic overwrite mode in front of whitespace in table fields.
1245 This makes the structure of the table stay in tact as long as the edited
1246 field does not exceed the column width.
1247 - Minimize the number of realigns. Normally, the table is aligned each time
1248 TAB or RET are pressed to move to another field. With optimization this
1249 happens only if changes to a field might have changed the column width.
1250 Optimization requires replacing the functions `self-insert-command',
1251 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1252 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1253 very good at guessing when a re-align will be necessary, but you can always
1256 If you would like to use the optimized version in Org-mode, but the
1257 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1259 This variable can be used to turn on and off the table editor during a session,
1260 but in order to toggle optimization, a restart is required.
1262 See also the variable `org-table-auto-blank-field'."
1270 "Non-nil means cluster self-insert commands for undo when possible.
1271 If this is set, then, like in the Emacs command loop, 20 consecutive
1272 characters will be undone together.
1273 This is configurable, because there is some impact on typing performance."
1278 "Non-nil means TAB will automatically notice a table.el table.
1279 When it sees such a table, it moves point into it and - if necessary -
1280 calls `table-recognize-table'."
1285 "Options concerning links in Org-mode."
1290 "Buffer-local version of `org-link-abbrev-alist', which see.
1295 "Alist of link abbreviations.
1296 The car of each element is a string, to be replaced at the start of a link.
1298 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1300 [[linkkey:tag][description]]
1302 The 'linkkey' must be a word word, starting with a letter, followed
1303 by letters, numbers, '-' or '_'.
1305 If REPLACE is a string, the tag will simply be appended to create the link.
1308 be inserted at that point (see the function `url-hexify-string').
1310 REPLACE may also be a function that will be called with the tag as the
1311 only argument to create the link, which should be returned as a string.
1313 See the manual for examples."
1323 "Non-nil means Org will display descriptive links.
1324 E.g. [[http://orgmode.org][Org website]] will be displayed as
1326 description. When set to `nil', Org will display the full links
1327 literally.
1329 You can interactively set the value of this variable by calling
1330 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1335 "How the path name in file links should be stored.
1336 Valid values are:
1338 relative Relative to the current directory, i.e. the directory of the file
1339 into which the link is being inserted.
1340 absolute Absolute path, if possible with ~ for home directory.
1341 noabbrev Absolute path, no abbreviation of home directory.
1342 adaptive Use relative path for files in the current directory and sub-
1343 directories of it. For other files, use an absolute path."
1352 "Types of links that should be activated in Org-mode files.
1353 This is a list of symbols, each leading to the activation of a certain link
1354 type. In principle, it does not hurt to turn on most link types - there may
1355 be a small gain when turning off unused link types. The types are:
1357 bracket The recommended [[link][description]] or [[link]] links with hiding.
1358 angle Links in angular brackets that may contain whitespace like
1359 <bbdb:Carsten Dominik>.
1360 plain Plain links in normal text, no whitespace, like http://google.com.
1361 radio Text that is matched by a radio target, see manual for details.
1362 tag Tag settings in a headline (link to tag search).
1363 date Time stamps (link to calendar).
1364 footnote Footnote labels.
1366 Changing this variable requires a restart of Emacs to become effective."
1378 "Function to use to generate link descriptions from links.
1379 If nil the link location will be used. This function must take
1380 two parameters; the first is the link and the second the
1381 description `org-insert-link' has generated, and should return the
1382 description to use."
1387 "Options concerning storing links in Org-mode."
1392 "Format of the description part of a link to an email or usenet message.
1393 The following %-escapes will be replaced by corresponding information:
1401 %s subject
1402 %d date
1403 %m message-id.
1405 You may use normal field width specification between the % and the letter.
1406 This is for example useful to limit the length of the subject.
1420 It should match if the message is from the user him/herself."
1425 "Non-nil means storing a link to an Org file will use entry IDs.
1427 Note that before this variable is even considered, org-id must be loaded,
1428 so please customize `org-modules' and turn it on.
1430 The variable can have the following values:
1432 t Create an ID if needed to make a link to the current entry.
1434 create-if-interactive
1435 If `org-store-link' is called directly (interactively, as a user
1436 command), do create an ID to support the link. But when doing the
1437 job for remember, only use the ID if it already exists. The
1438 purpose of this setting is to avoid proliferation of unwanted
1439 IDs, just because you happen to be in an Org file when you
1440 call `org-remember' that automatically and preemptively
1441 creates a link. If you do want to get an ID link in a remember
1442 template to an entry not having an ID, create it first by
1443 explicitly creating a link to it, using `C-c C-l' first.
1445 create-if-interactive-and-no-custom-id
1446 Like create-if-interactive, but do not create an ID if there is
1447 a CUSTOM_ID property defined in the entry. This is the default.
1449 use-existing
1450 Use existing ID, do not create one.
1452 nil Never use an ID to make a link, instead link using a text search for
1453 the headline text."
1458 create-if-interactive)
1460 create-if-interactive-and-no-custom-id)
1465 "Non-nil means file links from `org-store-link' contain context.
1466 A search string will be added to the file name with :: as separator and
1467 used to find the context when the link is activated by the command
1468 `org-open-at-point'. When this option is t, the entire active region
1469 will be placed in the search string of the file link. If set to a
1470 positive integer, only the first n lines of context will be stored.
1473 negates this setting for the duration of the command."
1478 "Non-nil means keep link in list for entire session.
1480 The command `org-store-link' adds a link pointing to the current
1481 location to an internal list. These links accumulate during a session.
1482 The command `org-insert-link' can be used to insert links into any
1483 Org-mode file (offering completion for all stored links). When this
1485 will be removed from the list, to make completing the unused links
1486 more efficient."
1491 "Options concerning following links in Org-mode."
1496 "Function to translate links with different syntax to Org syntax.
1497 This can be used to translate links created for example by the Planner
1498 or emacs-wiki packages to Org syntax.
1499 The function must accept two parameters, a TYPE containing the link
1501 which is everything after the link protocol. It should return a cons
1502 with possibly modified values of type and path.
1503 Org contains a function for this, so if you set this variable to
1504 `org-translate-link-from-planner', you should be able follow many
1505 links created by planner."
1510 "Hook that is run after a link has been followed."
1515 "Non-nil means on links TAB will follow the link.
1516 Needs to be set before org.el is loaded.
1517 This really should not be used, it does not make sense, and the
1518 implementation is bad."
1523 "Non-nil means on links RET will follow the link."
1529 "Non-nil means mouse-1 on a link will follow the link.
1530 A longer mouse click will still set point. Does not work on XEmacs.
1531 Needs to be set before org.el is loaded."
1536 "Number of different positions to be recorded in the ring.
1537 Changing this requires a restart of Emacs to work correctly."
1542 "Non-nil means internal links in Org files must exactly match a headline.
1543 When nil, the link search tries to match a phrase with all words
1544 in the search text."
1550 query-to-create)))
1558 "Setup the frame configuration for following links.
1559 When following a link with Emacs, it may often be useful to display
1560 this link in another window or frame. This variable can be used to
1561 set this up for the different types of links.
1562 For VM, use any of
1563 `vm-visit-folder'
1564 `vm-visit-folder-other-window'
1565 `vm-visit-folder-other-frame'
1566 For Gnus, use any of
1567 `gnus'
1568 `gnus-other-frame'
1569 `org-gnus-no-new-news'
1570 For FILE, use any of
1571 `find-file'
1572 `find-file-other-window'
1573 `find-file-other-frame'
1574 For Wanderlust use any of
1575 `wl'
1576 `wl-other-frame'
1577 For the calendar, use the variable `calendar-setup'.
1578 For BBDB, it is currently only possible to display the matches in
1579 another window."
1603 "Non-nil means use indirect buffer to display infile links.
1604 Activating internal links (from one location in a file to another location
1605 in the same file) normally just jumps to the location. When the link is
1607 is displayed in
1608 another window. When this option is set, the other window actually displays
1609 an indirect buffer clone of the current buffer, to avoid any visibility
1610 changes to the current buffer."
1615 "Non-nil means `org-open-file' will open non-existing files.
1616 When nil, an error will be generated.
1617 This variable applies only to external applications because they
1618 might choke on non-existing files. If the link is to a file that
1619 will be opened in Emacs, the variable is ignored."
1624 "Non-nil means a link to a directory really means to index.org.
1625 When nil, following a directory link will run dired or open a finder/explorer
1626 window on that directory."
1631 "Function and arguments to call for following mailto links.
1632 This is a list with the first element being a Lisp function, and the
1633 remaining elements being arguments to the function. In string arguments,
1634 %a will be replaced by the address, and %s will be replaced by the subject
1635 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1644 "Non-nil means ask for confirmation before executing shell links.
1645 Shell links can be dangerous: just think about a link
1647 [[shell:rm -rf ~/*][Google Search]]
1650 but really it would remove your entire home directory.
1651 Therefore we advise against setting this variable to nil.
1652 Just change it to `y-or-n-p' if you want to confirm with a
1660 'safe-local-variable
1664 "A regexp to skip confirmation for shell links."
1669 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1670 Elisp links can be dangerous: just think about a link
1675 but really it would remove your entire home directory.
1676 Therefore we advise against setting this variable to nil.
1677 Just change it to `y-or-n-p' if you want to confirm with a
1685 'safe-local-variable
1689 "A regexp to skip confirmation for Elisp links."
1697 "Default file applications on a UNIX or GNU/Linux system.
1708 "Default file applications on a MacOS X system.
1710 for some files for which the OS does not have a good default.
1718 'mswindows-shell-execute
1723 'mswindows-shell-execute
1726 "Default file applications on a Windows NT system.
1731 '(
1736 )
1737 "External applications for opening `file:path' items in a document.
1738 Org-mode uses system defaults for different file types, but
1739 you can use this variable to set the application for a given file
1740 extension. The entries in this list are cons cells where the car identifies
1741 files and the cdr the corresponding command. Possible values for the
1742 file identifier are
1744 ways, depending on its contents:
1746 - Alphanumeric characters only:
1747 Match links with this file extension.
1749 to open PDFs with evince.
1751 - Regular expression: Match links where the
1752 filename matches the regexp. If you want to
1753 use groups here, use shy groups.
1757 to open *.html and *.xhtml with firefox.
1759 - Regular expression which contains (non-shy) groups:
1761 anything after that, matches the regexp.
1762 In a custom command string, %1, %2, etc. are replaced with
1763 the parts of the link that were matched by the groups.
1764 For backwards compatibility, if a command string is given
1765 that does not use any of the group matches, this case is
1766 handled identically to the second one (i.e. match against
1767 file name only).
1768 In a custom lisp form, you can access the group matches with
1769 (match-string n link).
1772 to open [[file:document.pdf::5]] with evince at page 5.
1774 `directory' Matches a directory
1775 `remote' Matches a remote file, accessible through tramp or efs.
1776 Remote files most likely should be visited through Emacs
1777 because external applications cannot handle such paths.
1778 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1779 so all files Emacs knows how to handle. Using this with
1780 command `emacs' will open most files in Emacs. Beware that this
1781 will also open html files inside Emacs, unless you add
1783 t Default for files not matched by any of the other options.
1784 `system' The system command to open files, like `open' on Windows
1785 and Mac OS X, and mailcap under GNU/Linux. This is the command
1786 that will be selected if you call `C-c C-o' with a double
1789 Possible values for the command are:
1790 `emacs' The file will be visited by the current Emacs process.
1791 `default' Use the default application for this file type, which is the
1792 association for t in the list, most likely in the system-specific
1793 part.
1794 This can be used to overrule an unwanted setting in the
1795 system-specific variable.
1797 This command is specified by the entry whose car is `system'.
1798 Most likely, the system-specific version of this variable
1799 does define this command, but you can overrule/replace it
1800 here.
1801 string A command to be executed by a shell; %s will be replaced
1802 by the path to the file.
1803 sexp A Lisp form which will be evaluated. The file path will
1804 be available in the Lisp variable `file'.
1805 For more examples, see the system specific constants
1806 `org-file-apps-defaults-macosx'
1807 `org-file-apps-defaults-windowsnt'
1808 `org-file-apps-defaults-gnu'."
1818 auto-mode))
1829 "Options concerning refiling entries in Org-mode."
1834 "Directory with org files.
1835 This is just a default location to look for Org files. There is no need
1836 at all to put your files into this directory. It is only used in the
1837 following situations:
1839 1. When a remember template specifies a target file that is not an
1840 absolute path. The path will then be interpreted relative to
1841 `org-directory'
1842 2. When a remember note is filed away in an interactive way (when exiting the
1843 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1844 with `org-directory' as the default path."
1850 "Default target for storing notes.
1851 Used as a fall back file for org-remember.el and org-capture.el, for
1852 templates that do not specify a target file."
1857 file))
1860 "The default interface to be used for `org-goto'.
1861 Allowed values are:
1862 outline The interface shows an outline of the relevant file
1863 and the correct heading is found by moving through
1864 the outline or by searching with incremental search.
1865 outline-path-completion Headlines in the current buffer are offered via
1866 completion. This is the interface also used by
1867 the refile command."
1874 "Maximum target level when running `org-goto' with refile interface."
1879 "Non-nil means store new notes at the beginning of a file or entry.
1880 When nil, new notes will be filed to the end of a file or entry.
1881 This can also be a list with cons cells of regular expressions that
1882 are matched against file names, and values."
1892 "Information to record when a task is refiled.
1894 Possible values are:
1896 nil Don't add anything
1897 time Add a time stamp to the task
1898 note Prompt for a note and add it with template `org-log-note-headings'
1900 This option can also be set with on a per-file-basis with
1902 #+STARTUP: nologrefile
1903 #+STARTUP: logrefile
1904 #+STARTUP: lognoterefile
1906 You can have local logging settings for a subtree by setting the LOGGING
1907 property to one or more of these keywords.
1909 When bulk-refiling from the agenda, the value `note' is forbidden and
1910 will temporarily be changed to `time'."
1920 This is a list of cons cells. Each cell contains:
1921 - a specification of the files to be considered, either a list of files,
1922 or a symbol whose function or variable value will be used to retrieve
1923 a file name or a list of file names. If you use `org-agenda-files' for
1924 that, all agenda files will be scanned for targets. Nil means consider
1925 headings in the current buffer.
1926 - A specification of how to find candidate refile targets. This may be
1927 any of:
1929 This tag has to be present in all target headlines, inheritance will
1930 not be considered.
1932 todo keyword.
1934 headlines that are refiling targets.
1935 - a cons cell (:level . N). Any headline of level N is considered 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.
1938 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1939 Note that, when `org-odd-levels-only' is set, level corresponds to
1940 order in hierarchy, not to the number of stars.
1942 Each element of this list generates a set of possible targets.
1943 The union of these sets is presented (with completion) to
1944 the user by `org-refile'.
1946 You can set the variable `org-refile-target-verify-function' to a function
1947 to verify each headline found by the simple criteria above.
1949 When this variable is nil, all top-level headlines in the current buffer
1950 are used, equivalent to the value `((nil . (:level . 1))'."
1966 "Function to verify if the headline at point should be a refile target.
1967 The function will be called without arguments, with point at the
1968 beginning of the headline. It should return t and leave point
1969 where it is if the headline is a valid target for refiling.
1971 If the target should not be selected, the function must return nil.
1972 In addition to this, it may move point to a place from where the search
1973 should be continued. For example, the function may decide that the entire
1974 subtree of the current entry should be excluded and move point to the end
1975 of the subtree."
1980 "Non-nil means cache refile targets to speed up the process.
1981 The cache for a particular file will be updated automatically when
1982 the buffer has been killed, or when any of the marker used for flagging
1983 refile targets no longer points at a live buffer.
1984 If you have added new entries to a buffer that might themselves be targets,
1985 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1986 find that easier, `C-u C-u C-u C-c C-w'."
1991 "Non-nil means provide refile targets as paths.
1992 So a level 3 headline will be available as level1/level2/level3.
1994 When the value is `file', also include the file name (without directory)
1995 into the path. In this case, you can also stop the completion after
1996 the file name, to get entries inserted as top level in the file.
1998 When `full-file-path', include the full file path."
2007 "Non-nil means complete the outline path in hierarchical steps.
2008 When Org-mode uses the refile interface to select an outline path
2009 \(see variable `org-refile-use-outline-path'), the completion of
2010 the path can be done is a single go, or if can be done in steps down
2011 the headline hierarchy. Going in steps is probably the best if you
2012 do not use a special completion package like `ido' or `icicles'.
2013 However, when using these packages, going in one step can be very
2014 fast, while still showing the whole path to the entry."
2019 "Non-nil means allow to create new nodes as refile targets.
2021 of an existing node. When the value of this variable is `confirm',
2022 new node creation must be confirmed by the user (recommended)
2023 When nil, the completion must match an existing entry.
2025 Note that, if the new heading is not seen by the criteria
2026 listed in `org-refile-targets', multiple instances of the same
2027 heading would be created by trying again to file under the new
2028 heading."
2036 "Non-nil means also refile active region within a subtree.
2038 By default `org-refile' doesn't allow refiling regions if they
2039 don't contain a set of subtrees, but it might be convenient to
2040 do so sometimes: in that case, the first line of the region is
2041 converted to a headline before refiling."
2046 "Options concerning TODO items in Org-mode."
2051 "Options concerning Progress logging in Org-mode."
2058 "The available interpretation symbols for customizing `org-todo-keywords'.
2062 "List of TODO entry keyword sequences and their interpretation.
2065 Each sequence starts with a symbol, either `sequence' or `type',
2066 indicating if the keywords should be interpreted as a sequence of
2067 action steps, or as different types of TODO items. The first
2068 keywords are states requiring action - these states will select a headline
2069 for inclusion into the global TODO list Org-mode produces. If one of
2072 the last keyword is treated as the only DONE state of the sequence.
2075 additional state where no keyword is present. For details about this
2076 cycling, see the manual.
2078 TODO keywords and interpretation can also be set on a per-file basis with
2079 the special #+SEQ_TODO and #+TYP_TODO lines.
2081 Each keyword can optionally specify a character for fast state selection
2082 \(in combination with the variable `org-use-fast-todo-selection')
2083 and specifiers for state change logging, using the same syntax
2086 indicates to record a time stamp each time this state is selected.
2088 Each keyword may also specify if a timestamp or a note should be
2089 recorded when entering or leaving the state, by adding additional
2090 characters in the parenthesis after the keyword. This looks like this:
2092 record only the time of the state change. With X and Y being either
2094 Y when leaving the state if and only if the *target* state does not
2095 define X. You may omit any of the fast-selection key or X or /Y,
2096 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2098 For backward compatibility, this variable may also be just a list
2099 of keywords - in this case the interpretation (sequence or type) will be
2100 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2110 ;;Quick and dirty way to see
2111 ;;`org-todo-interpretations'. This takes the
2112 ;;place of item arguments
2113 :convert-widget
2120 org-todo-interpretation-widgets))
2121 widget))
2152 "Controls how TODO keywords are interpreted.
2153 This variable is in principle obsolete and is only used for
2154 backward compatibility, if the interpretation of todo keywords is
2155 not given already in `org-todo-keywords'. See that variable for
2156 more information."
2163 "Non-nil means use the fast todo selection scheme with C-c C-t.
2164 This variable describes if and under what circumstances the cycling
2165 mechanism for TODO keywords will be replaced by a single-key, direct
2166 selection scheme.
2168 When nil, fast selection is never used.
2170 When the symbol `prefix', it will be used when `org-todo' is called with
2171 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2172 in an agenda buffer.
2174 When t, fast selection is used by default. In this case, the prefix
2175 argument forces cycling instead.
2177 In all cases, the special interface is only used if access keys have actually
2178 been assigned by the user, i.e. if keywords in the configuration are followed
2179 by a letter in parenthesis, like TODO(t)."
2187 "Non-nil means update todo statistics after insert and toggle.
2188 ALL-HEADLINES means update todo statistics by including headlines
2189 with no TODO keyword as well, counting them as not done.
2190 A list of TODO keywords means the same, but skip keywords that are
2191 not in this list.
2193 When this is set, todo statistics is updated in the parent of the
2194 current entry each time a todo state is changed."
2204 "Non-nil means TODO statistics covers just direct children.
2205 When nil, all entries in the subtree are considered.
2206 This has only an effect if `org-provide-todo-statistics' is set.
2207 To set this to nil for only a single subtree, use a COOKIE_DATA
2213 "Hook which is run after the state of a TODO item was changed.
2214 The new state (a string with a TODO keyword, or nil) is available in the
2215 Lisp variable `state'."
2220 "Hook for functions that are allowed to block a state change.
2222 Each function gets as its single argument a property list, see
2223 `org-trigger-hook' for more information about this list.
2225 If any of the functions in this hook returns nil, the state change
2229 "Hook for functions that are triggered by a state change.
2231 Each function gets as its single argument a property list with at least
2232 the following elements:
2234 (:type type-of-change :position pos-at-entry-start
2235 :from old-state :to new-state)
2237 Depending on the type, more properties may be present.
2239 This mechanism is currently implemented for:
2241 TODO state changes
2242 ------------------
2243 :type todo-state-change
2244 :from previous state (keyword as a string), or nil, or a symbol
2245 'todo' or 'done', to indicate the general type of state.
2249 "Non-nil means undone TODO entries will block switching the parent to DONE.
2250 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2251 be blocked if any prior sibling is not yet done.
2252 Finally, if the parent is blocked because of ordered siblings of its own,
2253 the child will also be blocked.
2254 This variable needs to be set before org.el is loaded, and you need to
2255 restart Emacs after a change to make the change effective. The only way
2256 to change is while Emacs is running is through the customize interface."
2268 "Non-nil means unchecked boxes will block switching the parent to DONE.
2269 When this is nil, checkboxes have no influence on switching TODO states.
2270 When non-nil, you first need to check off all check boxes before the TODO
2271 entry can be switched to DONE.
2272 This variable needs to be set before org.el is loaded, and you need to
2273 restart Emacs after a change to make the change effective. The only way
2274 to change is while Emacs is running is through the customize interface."
2286 "Non-nil means inserting a TODO heading is treated as state change.
2288 logging will apply if appropriate. When nil, the new TODO item will
2289 be inserted directly, and no logging will take place."
2294 "Non-nil means switching TODO states with S-cursor counts as state change.
2295 This is the default behavior. However, setting this to nil allows a
2296 convenient way to select a TODO state and bypass any logging associated
2297 with that."
2302 "Tag changes that should be triggered by TODO state changes.
2303 This is a list. Each entry is
2305 (state-change (tag . flag) .......)
2307 State-change can be a string with a state, and empty string to indicate the
2308 state that has no TODO keyword, or it can be one of the symbols `todo'
2309 or `done', meaning any not-done or done state, respectively."
2323 "Information to record when a task moves to the DONE state.
2325 Possible values are:
2327 nil Don't add anything, just change the keyword
2328 time Add a time stamp to the task
2329 note Prompt for a note and add it with template `org-log-note-headings'
2331 This option can also be set with on a per-file-basis with
2333 #+STARTUP: nologdone
2334 #+STARTUP: logdone
2335 #+STARTUP: lognotedone
2337 You can have local logging settings for a subtree by setting the LOGGING
2338 property to one or more of these keywords."
2346 ;; Normalize old uses of org-log-done.
2353 "Information to record when the scheduling date of a tasks is modified.
2355 Possible values are:
2357 nil Don't add anything, just change the date
2358 time Add a time stamp to the task
2359 note Prompt for a note and add it with template `org-log-note-headings'
2361 This option can also be set with on a per-file-basis with
2363 #+STARTUP: nologreschedule
2364 #+STARTUP: logreschedule
2365 #+STARTUP: lognotereschedule"
2374 "Information to record when the deadline date of a tasks is modified.
2376 Possible values are:
2378 nil Don't add anything, just change the date
2379 time Add a time stamp to the task
2380 note Prompt for a note and add it with template `org-log-note-headings'
2382 This option can also be set with on a per-file-basis with
2384 #+STARTUP: nologredeadline
2385 #+STARTUP: logredeadline
2386 #+STARTUP: lognoteredeadline
2388 You can have local logging settings for a subtree by setting the LOGGING
2389 property to one or more of these keywords."
2398 "Non-nil means record a note when clocking out of an item.
2399 This can also be configured on a per-file basis by adding one of
2400 the following lines anywhere in the buffer:
2402 #+STARTUP: lognoteclock-out
2403 #+STARTUP: nolognoteclock-out"
2409 "Non-nil means the CLOSED time stamp will contain date and time.
2410 When nil, only the date will be recorded."
2424 "Headings for notes added to entries.
2425 The value is an alist, with the car being a symbol indicating the note
2426 context, and the cdr is the heading to be used. The heading may also be the
2427 empty string.
2428 %t in the heading will be replaced by a time stamp.
2429 %T will be an active time stamp instead the default inactive one
2430 %d will be replaced by a short-format time stamp.
2431 %D will be replaced by an active short-format time stamp.
2432 %s will be replaced by the new TODO state, in double quotes.
2433 %S will be replaced by the old TODO state, in double quotes.
2434 %u will be replaced by the user name.
2435 %U will be replaced by the full user name.
2437 In fact, it is not a good idea to change the `state' entry, because
2438 agenda log mode depends on the format of these entries."
2444 "Heading when changing todo state (todo sequence only)"
2458 "Non-nil means insert state change notes and time stamps into a drawer.
2459 When nil, state changes notes will be inserted after the headline and
2460 any scheduling and clock lines, but not inside a drawer.
2462 The value of this variable should be the name of the drawer to use.
2463 LOGBOOK is proposed as the default drawer for this purpose, you can
2464 also set this to a string to define the drawer of your choice.
2468 If this variable is set, `org-log-state-notes-insert-after-drawers'
2469 will be ignored.
2471 You can set the property LOG_INTO_DRAWER to overrule this setting for
2472 a subtree."
2484 "Return the value of `org-log-into-drawer', but let properties overrule.
2485 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2486 used instead of the default value."
2494 "Non-nil means insert state change notes after any drawers in entry.
2495 Only the drawers that *immediately* follow the headline and the
2496 deadline/scheduled line are skipped.
2497 When nil, insert notes right after the heading and perhaps the line
2498 with deadline/scheduling if present.
2500 This variable will have no effect if `org-log-into-drawer' is
2501 set."
2507 "Non-nil means the latest state note will be directly after heading.
2508 When nil, the state change notes will be ordered according to time."
2514 "The TODO state to which a repeater should return the repeating task.
2515 By default this is the first task in a TODO sequence, or the previous state
2516 in a TODO_TYP set. But you can specify another task here.
2517 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2523 "Non-nil means record moving through the DONE state when triggering repeat.
2524 An auto-repeating task is immediately switched back to TODO when
2527 record a closing note, there will be no record of the task moving
2528 through DONE. This variable forces taking a note anyway.
2530 nil Don't force a record
2531 time Record a time stamp
2532 note Record a note
2534 This option can also be set with on a per-file-basis with
2536 #+STARTUP: logrepeat
2537 #+STARTUP: lognoterepeat
2538 #+STARTUP: nologrepeat
2540 You can have local logging settings for a subtree by setting the LOGGING
2541 property to one or more of these keywords."
2551 "Priorities in Org-mode."
2556 "Non-nil means priority commands are active.
2557 When nil, these commands will be disabled, so that you never accidentally
2558 set a priority."
2563 "The highest priority of TODO items. A character like ?A, ?B etc.
2564 Must have a smaller ASCII number than `org-lowest-priority'."
2569 "The lowest priority of TODO items. A character like ?A, ?B etc.
2570 Must have a larger ASCII number than `org-highest-priority'."
2575 "The default priority of TODO items.
2576 This is the priority an item gets if no explicit priority is given.
2577 When starting to cycle on an empty priority the first step in the cycle
2578 depends on `org-priority-start-cycle-with-default'. The resulting first
2579 step priority must not exceed the range from `org-highest-priority' to
2580 `org-lowest-priority' which means that `org-default-priority' has to be
2581 in this range exclusive or inclusive the range boundaries. Else the
2582 first step refuses to set the default and the second will fall back
2583 to (depending on the command used) the highest or lowest priority."
2588 "Non-nil means start with default priority when starting to cycle.
2589 When this is nil, the first step in the cycle will be (depending on the
2590 command used) one higher or lower than the default priority.
2591 See also `org-default-priority'."
2596 "Function to extract the priority from a string.
2597 The string is normally the headline. If this is nil Org computes the
2598 priority from the priority cookie like [#A] in the headline. It returns
2599 an integer, increasing by 1000 for each priority level.
2600 The user can set a different function here, which should take a string
2601 as an argument and return the numeric priority."
2606 "Options concerning time stamps and deadlines in Org-mode."
2611 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2612 When nil, these labeled time stamps are forces into the second line of an
2613 entry, just after the headline. When scheduling from the global TODO list,
2614 the time stamp will always be forced into the second line."
2619 "Formats for `format-time-string' which are used for time stamps.
2623 "Number of minutes to round time stamps to.
2624 These are two values, the first applies when first creating a time stamp.
2625 The second applies when changing it with the commands `S-up' and `S-down'.
2626 When changing the time stamp, this means that it will change in steps
2627 of N minutes, as given by the second value.
2629 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2630 numbers should be factors of 60, so for example 5, 10, 15.
2632 When this is larger than 1, you can still force an exact time stamp by using
2633 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2634 and by using a prefix arg to `S-up/down' to specify the exact number
2635 of minutes to shift."
2645 ;; Normalize old customizations of this variable.
2649 org-time-stamp-rounding-minutes)))
2652 "Non-nil means overlay custom formats over all time stamps.
2653 The formats are defined through the variable `org-time-stamp-custom-formats'.
2654 To turn this on on a per-file basis, insert anywhere in the file:
2655 #+STARTUP: customtime"
2663 "Custom formats for time stamps. See `format-time-string' for the syntax.
2664 These are overlaid over the default ISO format if the variable
2665 `org-display-custom-times' is set. Time like %H:%M should be at the
2666 end of the second format. The custom formats are also honored by export
2667 commands, if custom time display is turned on at the time of export."
2672 "Get the right format for a time string."
2677 f)))
2680 "The format string used when creating CLOCKSUM lines.
2681 This is also used when org-mode generates a time duration."
2687 org-mode generates a time duration."
2692 "The format string used when creating CLOCKSUM lines, or when
2693 org-mode generates a time duration."
2698 "No. of days before expiration during which a deadline becomes active.
2699 This variable governs the display in sparse trees and in the agenda.
2700 When 0 or negative, it means use this number (the absolute value of it)
2701 even if a deadline has a different individual lead time specified.
2703 Custom commands can set this variable in the options section."
2709 "Non-nil means assume future for incomplete date input from user.
2710 This affects the following situations:
2711 1. The user gives a month but not a year.
2714 2. The user gives a day, but no month.
2717 it will be considered as *this* month.
2719 If you set this variable to the symbol `time', then also the following
2720 will work:
2722 3. If the user gives a time, but no day. If the time is before now,
2723 to will be interpreted as tomorrow.
2725 Currently none of this works for ISO week specifications.
2727 When this option is nil, the current day, month and year will always be
2728 used as defaults.
2730 See also `org-agenda-jump-prefer-future'."
2738 "Should the agenda jump command prefer the future for incomplete dates?
2739 The default is to do the same as configured in `org-read-date-prefer-future'.
2740 But you can also set a deviating value here.
2741 This may t or nil, or the symbol `org-read-date-prefer-future'."
2746 org-read-date-prefer-future)
2751 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2753 Depending on the system Emacs is running on, certain dates cannot
2754 be represented with the type used internally to represent time.
2755 Dates between 1970-1-1 and 2038-1-1 can always be represented
2756 correctly. Some systems allow for earlier dates, some for later,
2757 some for both. One way to find out it to insert any date into an
2758 Org buffer, putting the cursor on the year and hitting S-up and
2759 S-down to test the range.
2761 When this variable is set to t, the date/time prompt will not let
2762 you specify dates outside the 1970-2037 range, so it is certain that
2763 these dates will work in whatever version of Emacs you are
2764 running, and also that you can move a file from one Emacs implementation
2765 to another. WHenever Org is forcing the year for you, it will display
2766 a message and beep.
2768 When this variable is nil, Org will check if the date is
2769 representable in the specific Emacs implementation you are using.
2770 If not, it will force a year, usually the current year, and beep
2771 to remind you. Currently this setting is not recommended because
2772 the likelihood that you will open your Org files in an Emacs that
2773 has limited date range is not negligible.
2775 A workaround for this problem is to use diary sexp dates for time
2776 stamps outside of this range."
2781 "Non-nil means display current interpretation of date prompt live.
2782 This display will be in an overlay, in the minibuffer."
2787 "Non-nil means pop up a calendar when prompting for a date.
2788 In the calendar, the date can be selected with mouse-1. However, the
2789 minibuffer will also be active, and you can simply enter the date as well.
2790 When nil, only the minibuffer will be available."
2798 "Hook to be used to set up keys for the date/time interface.
2799 Add key definitions to `minibuffer-local-map', which will be a temporary
2800 copy."
2805 "The hour when your day really ends. Must be an integer.
2806 This has influence for the following applications:
2808 the time given here, the day recognized as TODAY is actually yesterday.
2809 - When a date is read from the user and it is still before the time given
2810 here, the current date and time will be assumed to be yesterday, 23:59.
2811 Also, timestamps inserted in remember templates follow this rule.
2813 IMPORTANT: This is a feature whose implementation is and likely will
2814 remain incomplete. Really, it is only here because past midnight seems to
2815 be the favorite working time of John Wiegley :-)"
2820 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2821 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2823 23:59 of the previous day."
2828 "Non-nil means S-down will increase the time in a time stamp.
2829 When nil, S-up will increase."
2834 "Non-nil means make the calendar window follow timestamp changes.
2835 When a timestamp is modified and the calendar window is visible, it will be
2836 moved to the new date."
2841 "Options concerning tags in Org-mode."
2846 "List of tags allowed in Org-mode files.
2847 When this list is nil, Org-mode will base TAG input on what is already in the
2848 buffer.
2849 The value of this variable is an alist, the car of each entry must be a
2850 keyword as a string, the cdr may be a character that is used to select
2851 that tag through the fast-tag-selection interface.
2852 See the manual for details."
2867 "List of tags that will always appear in all Org-mode files.
2868 This is in addition to any in buffer settings or customizations
2869 of `org-tag-alist'.
2870 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2871 The value of this variable is an alist, the car of each entry must be a
2872 keyword as a string, the cdr may be a character that is used to select
2873 that tag through the fast-tag-selection interface.
2874 See the manual for details.
2875 To disable these tags on a per-file basis, insert anywhere in the file:
2876 #+STARTUP: noptag"
2887 "If non-nil, always offer completion for all tags of all agenda files.
2888 Instead of customizing this variable directly, you might want to
2889 set it locally for capture buffers, because there no list of
2890 tags in that file can be created dynamically (there are none).
2892 (add-hook 'org-capture-mode-hook
2893 (lambda ()
2894 (set (make-local-variable
2895 'org-complete-tags-always-offer-all-agenda-tags)
2896 t)))"
2901 "List of tags that can be inherited by all entries in the file.
2902 The tags will be inherited if the variable `org-use-tag-inheritance'
2903 says they should be.
2907 "Non-nil means use fast tag selection scheme.
2908 This is a special interface to select and deselect tags with single keys.
2909 When nil, fast selection is never used.
2910 When the symbol `auto', fast selection is used if and only if selection
2911 characters for tags have been configured, either through the variable
2912 `org-tag-alist' or through a #+TAGS line in the buffer.
2913 When t, fast selection is always used and selection keys are assigned
2914 automatically if necessary."
2922 "Non-nil means fast tag selection exits after first change.
2923 When nil, you have to press RET to exit it.
2924 During fast tag selection, you can toggle this flag with `C-c'.
2925 This variable can also have the value `expert'. In this case, the window
2926 displaying the tags menu is not even shown, until you press C-c again."
2934 "Non-nil means fast tags selection interface will also offer TODO states.
2938 "The column to which tags should be indented in a headline.
2939 If this number is positive, it specifies the column. If it is negative,
2940 it means that the tags should be flushright to that column. For example,
2941 -80 works well for a normal 80 character screen.
2942 When 0, place tags directly after headline text, with only one space in
2943 between."
2948 "Non-nil keeps tags aligned when modifying headlines.
2949 Some operations (i.e. demoting) change the length of a headline and
2950 therefore shift the tags around. With this option turned on, after
2951 each such operation the tags are again aligned to `org-tags-column'."
2956 "Non-nil means tags in levels apply also for sublevels.
2957 When nil, only the tags directly given in a specific line apply there.
2958 This may also be a list of tags that should be inherited, or a regexp that
2959 matches tags that should be inherited. Additional control is possible
2960 with the variable `org-tags-exclude-from-inheritance' which gives an
2961 explicit list of tags to be excluded from inheritance., even if the value of
2962 `org-use-tag-inheritance' would select it for inheritance.
2964 If this option is t, a match early-on in a tree can lead to a large
2965 number of matches in the subtree when constructing the agenda or creating
2966 a sparse tree. If you only want to see the first match in a tree during
2967 a search, check out the variable `org-tags-match-list-sublevels'."
2976 "List of tags that should never be inherited.
2977 This is a way to exclude a few tags from inheritance. For way to do
2978 the opposite, to actively allow inheritance for selected tags,
2979 see the variable `org-use-tag-inheritance'."
2984 "Check if TAG is one that should be inherited."
2996 "Non-nil means list also sublevels of headlines matching a search.
2997 This variable applies to tags/property searches, and also to stuck
2998 projects because this search is based on a tags match as well.
3000 When set to the symbol `indented', sublevels are indented with
3001 leading dots.
3003 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3004 the sublevels of a headline matching a tag search often also match
3005 the same search. Listing all of them can create very long lists.
3006 Setting this variable to nil causes subtrees of a match to be skipped.
3008 This variable is semi-obsolete and probably should always be true. It
3009 is better to limit inheritance to certain tags using the variables
3010 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3018 "When set, tags are sorted using this function as a comparator."
3034 "Options concerning properties in Org-mode."
3039 "How property key/value pairs should be formatted by `indent-line'.
3040 When `indent-line' hits a property definition, it will format the line
3041 according to this format, mainly to make sure that the values are
3042 lined-up with respect to each other."
3047 "Alist of properties and functions to adjust inserted values.
3048 Elements of this alist must be of the form
3050 ([string] [function])
3052 where [string] must be a property name and [function] must be a
3053 lambda expression: this lambda expression must take one argument,
3054 the value to adjust, and return the new value as a string.
3058 and the clock summary:
3061 (let ((clocksum (org-clock-sum-current-item))
3062 (effort (org-duration-string-to-minutes
3064 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3069 "Non-nil means properties apply also for sublevels.
3071 This setting is chiefly used during property searches. Turning it on can
3072 cause significant overhead when doing a search, which is why it is not
3073 on by default.
3075 When nil, only the properties directly given in the current entry count.
3076 When t, every property is inherited. The value may also be a list of
3077 properties that should have inheritance, or a regular expression matching
3078 properties that should be inherited.
3080 However, note that some special properties use inheritance under special
3081 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3083 for valid values of a property.
3085 Note for programmers:
3086 When querying an entry with `org-entry-get', you can control if inheritance
3087 should be used. By default, `org-entry-get' looks only at the local
3088 properties. You can request inheritance by setting the inherit argument
3089 to t (to force inheritance) or to `selective' (to respect the setting
3090 in this variable)."
3099 "Check if PROPERTY is one that should be inherited."
3110 "The default column format, if no other format has been defined.
3111 This variable can be set on the per-file basis by inserting a line
3113 #+COLUMNS: %25ITEM ....."
3118 "The ellipses to be used when a field in column view is truncated.
3119 When this is the empty string, as many characters as possible are shown,
3120 but then there will be no visual indication that the field has been truncated.
3121 When this is a string of length N, the last N characters of a truncated
3122 field are replaced by this string. If the column is narrower than the
3123 ellipses string, only part of the ellipses string will be shown."
3128 "Function that modifies values for display in column view.
3129 For example, it can be used to cut out a certain part from a time stamp.
3130 The function must take 2 arguments:
3132 column-title The title of the column (*not* the property name)
3133 value The value that should be modified.
3135 The function should return the value that should be displayed,
3136 or nil if the normal value should be used."
3141 "The property that is being used to keep track of effort estimates.
3142 Effort estimates given in this property need to have the format H:MM."
3150 "List of property/value pairs that can be inherited by any entry.
3152 These are fixed values, for the preset properties. The user variable
3153 that can be used to add to this list is `org-global-properties'.
3155 The entries in this list are cons cells where the car is a property
3156 name and cdr is a string with the value. If the value represents
3161 "List of property/value pairs that can be inherited by any entry.
3163 This list will be combined with the constant `org-global-properties-fixed'.
3165 The entries in this list are cons cells where the car is a property
3166 name and cdr is a string with the value.
3168 You can set buffer-local values for the same purpose in the variable
3169 `org-file-properties' this by adding lines like
3171 #+PROPERTY: NAME VALUE"
3178 "List of property/value pairs that can be inherited by any entry.
3179 Valid for the current buffer.
3184 "Options concerning agenda views in Org-mode."
3189 "Variable used by org files to set a category for agenda display.
3190 Such files should use a file variable to set it, for example
3194 or contain a special line
3196 #+CATEGORY: ELisp
3198 If the file does not specify a category, then file's base name
3204 "The files to be used for agenda display.
3208 If an entry is a directory, all files in that directory that are matched by
3209 `org-agenda-file-regexp' will be part of the file list.
3211 If the value of the variable is not a list but a single file name, then
3212 the list of agenda files is actually stored and maintained in that file, one
3213 agenda file per line. In this file paths can be given relative to
3214 `org-directory'. Tilde expansion and environment variable substitution
3215 are also made."
3222 "Regular expression to match files for `org-agenda-files'.
3223 If any element in the list in that variable contains a directory instead
3224 of a normal file, all files in that directory that are matched by this
3225 regular expression will be included."
3230 "List of extra files to be searched by text search commands.
3231 These files will be search in addition to the agenda files by the
3232 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3233 Note that these files will only be searched for text search commands,
3234 not for the other agenda views like todo lists, tag searches or the weekly
3235 agenda. This variable is intended to list notes and possibly archive files
3236 that should also be searched by these two commands.
3237 In fact, if the first element in the list is the symbol `agenda-archives',
3238 than all archive files of all agenda files will be added to the search
3239 scope."
3250 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3251 A nil value means to remove them, after a query, from the list."
3256 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3257 The command `org-calendar-goto-agenda' will be bound to this key. The
3258 default is the character `c' because then `c' can be used to switch back and
3259 forth between agenda and calendar."
3264 "The key to be installed in `calendar-mode-map' for agenda-action.
3265 The command `org-agenda-action' will be bound to this key. The
3266 default is the character `k' because we use the same key in the agenda."
3271 "The key to be installed in `calendar-mode-map' for adding diary entries.
3272 This option is irrelevant until `org-agenda-diary-file' has been configured
3273 to point to an Org-mode file. When that is the case, the command
3274 `org-agenda-diary-entry' will be bound to the key given here, by default
3275 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3276 if you want to continue doing this, you need to change this to a different
3277 key."
3282 "File to which to add new entries with the `i' key in agenda and calendar.
3283 When this is the symbol `diary-file', the functionality in the Emacs
3284 calendar will be used to add entries to the `diary-file'. But when this
3285 points to a file, `org-agenda-diary-entry' will be used instead."
3301 org-calendar-insert-diary-entry-key
3305 "Options for embedding LaTeX code into Org-mode."
3313 "Options for creating images from LaTeX fragments.
3314 This is a property list with the following properties:
3316 `default' means use the foreground of the default face.
3318 `default' means use the background of the default face.
3319 :scale a scaling factor for the size of the images, to get more pixels
3320 :html-foreground, :html-background, :html-scale
3321 the same numbers for HTML export.
3322 :matchers a list indicating which matchers should be used to
3323 find LaTeX fragments. Valid members of this list are:
3334 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3335 When nil, just push out a message."
3340 Use this to specify additional executable file say a jar file.
3342 When using MathToWeb as the converter, specify the full-path to
3343 your mathtoweb.jar file."
3350 "Command to convert LaTeX fragments to MathML.
3351 Replace format-specifiers in the command as noted below and use
3352 `shell-command' to convert LaTeX to MathML.
3353 %j: Executable file in fully expanded form as specified by
3354 `org-latex-to-mathml-jar-file'.
3355 %I: Input LaTeX file in fully expanded form
3356 %o: Output MathML file
3357 This command is used by `org-create-math-formula'.
3359 When using MathToWeb as the converter, set this to
3367 "Return t if `org-latex-to-mathml-convert-command' is usable."
3370 org-latex-to-mathml-convert-command)
3372 org-latex-to-mathml-convert-command))))
3377 t))))))
3384 \[PACKAGES]
3385 \[DEFAULT-PACKAGES]
3386 % The settings below are copied from fullpage.sty
3399 "The document header used for processing LaTeX fragments.
3400 It is imperative that this header make sure that no page number
3401 appears on the page. The package defined in the variables
3402 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3404 will be appended."
3411 "Set the packages alist and make sure it has 3 elements per entry."
3415 x))
3416 val)))
3420 "Get the packages alist and make sure it has 3 elements per entry."
3424 x))
3427 ;; The following variables are defined here because is it also used
3428 ;; when formatting latex fragments. Originally it was part of the
3429 ;; LaTeX exporter, which is why the name includes "export".
3446 )
3447 "Alist of default packages to be inserted in the header.
3448 Change this only if one of the packages here causes an incompatibility
3449 with another package you are using.
3450 The packages in this list are needed by one part or another of Org-mode
3451 to function properly.
3453 - inputenc, fontenc: for basic font and character selection
3454 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3455 for interpreting the entities in `org-entities'. You can skip some of these
3456 packages if you don't use any of the symbols in it.
3457 - graphicx: for including images
3458 - float, wrapfig: for figure placement
3459 - longtable: for long tables
3460 - hyperref: for cross references
3462 Therefore you should not modify this variable unless you know what you
3463 are doing. The one reason to change it anyway is that you might be loading
3464 some other package that conflicts with one of the default packages.
3466 If SNIPPET-FLAG is t, the package also needs to be included when
3467 compiling LaTeX snippets into images for inclusion into HTML."
3480 "Alist of packages to be inserted in every LaTeX header.
3481 These will be inserted after `org-export-latex-default-packages-alist'.
3483 SNIPPET-FLAG, when t, indicates that this package is also needed when
3484 turning LaTeX snippets into images for inclusion into HTML.
3485 Make sure that you only list packages here which:
3486 - you want in every file
3487 - do not conflict with the default packages in
3488 `org-export-latex-default-packages-alist'
3489 - do not conflict with the setup in `org-format-latex-header'."
3503 "Settings for Org-mode appearance."
3508 "Non-nil means fontify only the stars in each headline.
3509 When nil, the entire headline is fontified.
3510 Changing it requires restart of `font-lock-mode' to become effective
3511 also in regions already fontified."
3516 "Non-nil means hide the first N-1 stars in a headline.
3517 This works by using the face `org-hide' for these stars. This
3518 face is white for a light background, and black for a dark
3519 background. You may have to customize the face `org-hide' to
3520 make this work.
3521 Changing it requires restart of `font-lock-mode' to become effective
3522 also in regions already fontified.
3523 You may also set this on a per-file basis by adding one of the following
3524 lines to the buffer:
3526 #+STARTUP: hidestars
3527 #+STARTUP: showstars"
3532 "List of symbols corresponding to keywords to be hidden the org buffer.
3533 For example, a value '(title) for this list will make the document's title
3534 appear in the buffer without the initial #+TITLE: keyword."
3542 "Non-nil means change the face of a headline if it is marked DONE.
3543 Normally, only the TODO/DONE keyword indicates the state of a headline.
3544 When this is non-nil, the headline after the keyword is set to the
3545 `org-headline-done' as an additional indication."
3550 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3551 Changing this variable requires a restart of Emacs to take effect."
3556 "Non-nil means fontify the whole line for headings.
3557 This is useful when setting a background color for the
3558 org-level-* faces."
3563 "Non-nil means fontify what is treated specially by the exporters."
3568 "Non-nil mean font-lock should hide the emphasis marker characters."
3573 "Non-nil means show entities as UTF8 characters.
3579 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3584 "Regular expression for matching emphasis.
3585 After a match, the match groups contain these elements:
3586 0 The match of the full regular expression, including the characters
3587 before and after the proper match
3588 1 The character before the proper match, or empty at beginning of line
3589 2 The proper match, including the leading and trailing markers
3590 3 The leading marker like * or /, indicating the type of highlighting
3591 4 The text between the emphasis markers, not including the markers
3598 "Set variable and compute the emphasis regular expression."
3602 org-emphasis-alist org-emphasis-regexp-components)
3614 ;; make sure special characters appear at the right position in the class
3626 ;; Make the regexp
3634 body1
3646 body1
3654 "Components used to build the regular expression for emphasis.
3655 This is a list with five entries. Terminology: In an emphasis string
3659 specify what is allowed/forbidden in each part:
3661 pre Chars allowed as prematch. Beginning of line will be allowed too.
3662 post Chars allowed as postmatch. End of line will be allowed too.
3663 border The chars *forbidden* as border characters.
3665 non-shy groups here, and don't allow newline here.
3666 newline The maximum number of newlines allowed in an emphasis exp.
3668 Use customize to modify this, or restart Emacs after changing it."
3687 )
3688 "Special syntax for emphasized text.
3689 Text starting and ending with a special character will be emphasized, for
3690 example *bold*, _underlined_ and /italic/. This variable sets the marker
3691 characters, the face to be used by font-lock for highlighting in Org-mode
3692 Emacs buffers, and the HTML tags to be used for this.
3693 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3694 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3695 Use customize to modify this, or restart Emacs after changing it."
3710 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3713 ;;; Miscellaneous options
3716 "Completion in Org-mode."
3721 "Non-nil means use ido completion wherever possible.
3722 Note that `ido-mode' must be active for this variable to be relevant.
3723 If you decide to turn this variable on, you might well want to turn off
3724 `org-outline-path-complete-in-steps'.
3725 See also `org-completion-use-iswitchb'."
3730 "Non-nil means use iswitchb completion wherever possible.
3731 Note that `iswitchb-mode' must be active for this variable to be relevant.
3732 If you decide to turn this variable on, you might well want to turn off
3733 `org-outline-path-complete-in-steps'.
3734 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3740 Normal means, no org-mode-specific context."
3744 ;;; Functions and variables from their packages
3745 ;; Declared here to avoid compiler warnings
3747 ;; XEmacs only
3753 ;; Emacs only
3756 ;; Various packages
3775 org-agenda-format-item "org-agenda"
3806 ;;; Autoload and prepare some org modules
3808 ;; Some table stuff that needs to be defined here, because it is used
3809 ;; by the functions setting up org-mode or checking for table context.
3822 "Detect the first line outside a table when searching from within it.
3825 ;; Autoload the functions in org-table.el that are needed by functions here.
3830 org-table-convert org-table-convert-region org-table-copy-down
3831 org-table-copy-region org-table-create
3832 org-table-create-or-convert-from-region
3833 org-table-create-with-table.el org-table-current-dline
3834 org-table-cut-region org-table-delete-column org-table-edit-field
3835 org-table-edit-formulas org-table-end org-table-eval-formula
3836 org-table-export org-table-field-info
3837 org-table-get-stored-formulas org-table-goto-column
3838 org-table-hline-and-move org-table-import org-table-insert-column
3839 org-table-insert-hline org-table-insert-row org-table-iterate
3840 org-table-justify-field-maybe org-table-kill-row
3841 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3842 org-table-move-column org-table-move-column-left
3843 org-table-move-column-right org-table-move-row
3844 org-table-move-row-down org-table-move-row-up
3845 org-table-next-field org-table-next-row org-table-paste-rectangle
3846 org-table-previous-field org-table-recalculate
3847 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3848 org-table-toggle-coordinate-overlays
3849 org-table-toggle-formula-debugger org-table-wrap-region
3850 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3851 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3852 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3855 "Return t if the cursor is inside an org-type table.
3856 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3861 org-table-line-regexp)))
3862 nil))
3866 "Return t if and only if we are at a table.el table."
3872 "If there is a table.el table nearby, recognize it and move into it."
3878 nil
3888 t
3893 t)
3894 nil)
3895 nil))
3898 "Return t if the cursor is inside a hline in a table."
3903 nil))
3908 "Apply FUNCTION to the start of all tables in the buffer."
3924 ;; Declare and autoload functions from org-exp.el & Co
3932 org-insert-export-options-template
3933 org-table-clean-before-export))
3936 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3937 org-export-region-as-ascii))
3940 org-replace-region-by-latex org-export-region-as-latex
3941 org-export-as-latex org-export-as-pdf
3942 org-export-as-pdf-and-open))
3945 org-export-as-html-batch org-export-as-html-to-buffer
3946 org-replace-region-by-html org-export-region-as-html
3947 org-export-as-html))
3950 org-replace-region-by-docbook org-export-region-as-docbook
3951 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3952 org-export-as-docbook))
3955 org-export-icalendar-all-agenda-files
3956 org-export-icalendar-combine-agenda-files))
3960 ;; Declare and autoload functions from org-agenda.el
3965 org-todo-list org-tags-view org-agenda-list-stuck-projects
3966 org-diary org-agenda-to-appt
3967 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3969 ;; Autoload org-remember
3974 org-remember-apply-template org-remember org-remember-handler)))
3979 org-capture-import-remember-templates)))
3981 ;; Autoload org-clock.el
3996 "Return non-nil if clock is currently running.
3997 The return value is actually the clock marker."
4002 "org-clock"
4004 org-clock-goto org-clock-sum org-clock-display
4005 org-clock-remove-overlays org-clock-report
4006 org-clocktable-shift org-dblock-write:clocktable
4007 org-get-clocktable org-resolve-clocks)))
4010 "If this is a CLOCK line, update it and return t.
4011 Otherwise, return nil."
4020 ts te h m s neg)
4023 nil)
4028 ;; The clock is running here
4049 t))))))
4052 "Check if the current buffer contains the running clock.
4053 If yes, offer to stop it and to save the buffer with the changes."
4062 "Check if this line starts a clock table, if yes, shift the time block."
4066 ;; Autoload org-timer.el
4070 "org-timer"
4072 org-timer-change-times-in-region
4073 org-timer-set-timer
4074 org-timer-reset-timers
4075 org-timer-show-remaining-time)))
4077 ;; Autoload org-feed.el
4081 "org-feed"
4085 ;; Autoload org-indent.el
4087 ;; Define the variable already here, to make sure we have it.
4089 "Non-nil if Org-Indent mode is enabled.
4094 "org-indent"
4097 ;; Autoload org-mobile.el
4101 "org-mobile"
4104 ;; Autoload archiving code
4105 ;; The stuff that is needed for cycling and tags has to be defined here.
4108 "Options concerning archiving in Org-mode."
4113 "The location where subtrees should be archived.
4115 The value of this variable is a string, consisting of two parts,
4116 separated by a double-colon. The first part is a filename and
4117 the second part is a headline.
4119 When the filename is omitted, archiving happens in the same file.
4120 %s in the filename will be replaced by the current file
4121 name (without the directory part). Archiving to a different file
4122 is useful to keep archived entries from contributing to the
4123 Org-mode Agenda.
4125 The archived entries will be filed as subtrees of the specified
4126 headline. When the headline is omitted, the subtrees are simply
4127 filed away at the end of the file, as top-level entries. Also in
4128 the heading you can use %s to represent the file name, this can be
4129 useful when using the same archive for a number of different files.
4131 Here are a few examples:
4133 If the current file is Projects.org, archive in file
4134 Projects.org_archive, as top-level trees. This is the default.
4137 Archive in the current file, under the top-level headline
4141 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4144 Archive in file ~/org/archive.org (absolute path), under headlines
4148 Archive in file ./basement (relative path), as level 3 trees
4151 You may set this option on a per-file basis by adding to the buffer a
4152 line like
4154 #+ARCHIVE: basement::** Finished Tasks
4156 You may also define it locally for a subtree by setting an ARCHIVE property
4157 in the entry. If such a property is found in an entry, or anywhere up
4158 the hierarchy, it will be used."
4163 "The tag that marks a subtree as archived.
4164 An archived subtree does not open during visibility cycling, and does
4165 not contribute to the agenda listings.
4166 After changing this, font-lock must be restarted in the relevant buffers to
4167 get the proper fontification."
4173 "Non-nil means the agenda will skip any items located in archived trees.
4174 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4175 variable is no longer recommended, you should leave it at the value t.
4176 Instead, use the key `v' to cycle the archives-mode in the agenda."
4182 "Non-nil means ignore archived trees when creating column view."
4188 "Non-nil means `org-cycle' will open archived trees.
4189 An archived tree is a tree marked with the tag ARCHIVE.
4190 When nil, archived trees will stay folded. You can still open them with
4191 normal outline commands like `show-all', but not with the cycling commands."
4197 "Non-nil means sparse tree construction shows matches in archived trees.
4198 When nil, matches in these trees are highlighted, but the trees are kept in
4199 collapsed state."
4205 "Re-hide all archived subtrees after a visibility state change."
4216 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4219 "Cycle subtree even if it is archived."
4226 "Re-hide all archived subtrees after a visibility state change."
4241 flag)))
4248 org-archive-to-archive-sibling org-toggle-archive-tag
4249 org-archive-subtree-default
4250 org-archive-subtree-default-with-confirmation)))
4252 ;; Autoload Column View Code
4260 org-columns-compute org-agenda-columns org-columns-remove-overlays
4263 ;; Autoload ID code
4271 org-id-get-with-outline-path-completion
4272 org-id-get-with-outline-drilling org-id-store-link
4273 org-id-goto org-id-find org-id-store-link))
4275 ;; Autoload Plotting Code
4280 ;;; Variables for pre-computed regular expressions, all buffer local
4298 "Matches a headline and puts everything into groups:
4299 group 1: the stars
4300 group 2: The todo keyword, maybe
4301 group 3: Priority cookie
4302 group 4: True headline
4306 "Printf format to make regexp to match an exact headline.
4307 This regexp will match the headline of any node which has the
4308 exact headline text that is put into the format, but may have any
4312 "Matches a headline and puts TODO state into group 2 if present.
4361 "Regular expression to match a plain time or time range.
4362 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4363 groups carry important information:
4364 0 the full match
4365 1 the first time, range or not
4373 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4374 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4375 groups carry important information:
4376 0 the full match
4377 7 hours of duration
4386 "Regular expression to match a timestamp time or time range.
4387 After a match, the following groups carry important information:
4388 0 the full match
4389 1 date plus weekday, for back referencing to make sure both times are on the same day
4390 2 the first time, range or not
4445 "Variable associated with STARTUP options for org-mode.
4446 Each element is a list of three items: The startup options as written
4447 in the #+STARTUP line, the corresponding variable, and the value to
4448 set this variable to if the option is found. An optional forth element PUSH
4452 "Update PROPS with KEY and VAL."
4466 "Printf format for a regexp matching an headline with some keyword.
4467 This regexp will match the headline of any node which has the
4468 exact keyword that is put into the format. The keyword isn't in
4472 "Printf format for a regexp matching an headline, possibly with some keyword.
4473 This regexp can match any headline with the specified keyword, or
4474 without a keyword. The keyword isn't in any group by default,
4478 "Precompute regular expressions for current buffer."
4498 kwds kws0 kwsa key log value cat arch tags const links hw dws
4499 tail sep kws1 prio props ftags drawers beamer-p
4521 ;; general TODO-like setup
4533 links)))
4540 props))))
4545 ftags
4555 l var val)
4585 ;; search for property blocks
4594 props)))))))
4611 ;; Process the TODO keywords
4613 ;; Use the global values as if they had been given locally.
4625 kws)))
4628 kwsa nil
4631 ;; 1 2
4639 kw)
4641 kws0)
4658 ;; Process the constants
4666 ;; Process the tags.
4677 tgs))
4685 ;; Compute the regular expressions and other local variables.
4686 ;; Using `org-outline-regexp-bol' would complicate them much,
4687 ;; because of the fixed white space at the end of that string.
4695 org-drawer-regexp
4699 org-not-done-keywords
4701 org-todo-regexp
4705 org-not-done-regexp
4709 org-not-done-heading-regexp
4711 org-todo-line-regexp
4713 org-complex-heading-regexp
4720 org-complex-heading-regexp-format
4725 ;; Stats cookies can be stuck to body.
4732 org-todo-line-tags-regexp
4739 org-deadline-time-regexp
4741 org-deadline-line-regexp
4743 org-scheduled-regexp
4745 org-scheduled-time-regexp
4747 org-closed-time-regexp
4749 org-keyword-time-regexp
4755 org-keyword-time-not-clock-regexp
4761 org-maybe-keyword-time-regexp
4767 org-planning-or-clock-line-re
4772 org-all-time-keywords
4775 org-clock-string org-closed-string))
4776 )
4781 "Return the contents of FILE, as a string."
4795 "Extract the log state setting from a TODO keyword string.
4809 "Remove a pair of parenthesis at the end of each string in LIST."
4813 x))
4814 list))
4817 "Assign fast keys to a keyword-key alist.
4818 Respect keys that are already there."
4836 ;;; Some variables used in various places
4843 "Function to be called when `C-c C-c' is used.
4847 ;; FIXME: Occasionally check by commenting these, to make sure
4848 ;; no other functions uses these, forgetting to let-bind them.
4853 ;; Defined somewhere in this file, but used before definition.
4859 ;;;; Define the Org-mode
4862 (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"))
4865 ;; We use a before-change function to check if a table might need
4866 ;; an update.
4868 "Indicates that a table might need an update.
4869 This variable is set by `org-before-change-function'.
4872 "Every change indicates that a table might need an update."
4882 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4883 ;; some places -- e.g. see the macro org-with-limited-levels.
4884 ;;
4885 ;; In Org buffers, the value of `outline-regexp' is that of
4886 ;; `org-outline-regexp'. The only function still directly relying on
4887 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4888 ;; job when `orgstruct-mode' is active.
4892 "Regexp to match Org headlines.
4893 This is similar to `org-outline-regexp' but additionally makes
4897 "Matches an headline, putting stars and text into groups.
4900 ;;;###autoload
4902 "Outline-based notes management and organizer, alias
4905 Org-mode develops organizational tasks around a NOTES file which
4906 contains information about projects as plain text. Org-mode is
4907 implemented on top of outline-mode, which is ideal to keep the content
4908 of large files well structured. It supports ToDo items, deadlines and
4909 time stamps, which magically appear in the diary listing of the Emacs
4910 calendar. Tables are easily created with a built-in table editor.
4911 Plain text URL-like links connect to websites, emails (VM), Usenet
4912 messages (Gnus), BBDB entries, and any files related to the project.
4913 For printing and sharing of notes, an Org-mode file (or a part of it)
4914 can be exported as a structured ASCII or HTML file.
4916 The following commands are available:
4920 ;; Get rid of Outline menus, they are not needed
4921 ;; Need to do this here because define-derived-mode sets up
4922 ;; the keymap so late. Still, it is a waste to call this each time
4923 ;; we switch another buffer into org-mode.
4926 ;; Assume this is Greg's port, it uses easymenu
4952 org-display-table 4
4955 org-ellipsis)))
4960 ;; tag faces set outside customize.... force initialization.
4962 ;; Calc embedded
4968 ;; Activate before-change-function
4972 ;; Check for running clock before killing a buffer
4974 ;; Paragraphs and auto-filling
4978 ;; Beginning/end of defun
4981 ;; Next error for sparse trees
4983 ;; Make sure dependence stuff works reliably, even for users who set it
4984 ;; too late :-(
4996 ;; Comment characters
5000 ;; Align options lines
5002 'align-mode-rules-list
5007 ;; Imenu
5011 ;; Make isearch reveal context
5014 ;; Emacs 21 and XEmacs make use of the hook
5016 ;; Emacs 22 deals with this through a special variable
5020 ;; Turn on org-beamer-mode?
5023 ;; Setup the pcomplete hooks
5036 ;; If empty file that did not turn on org-mode automatically, make it to.
5061 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5071 "Return today date, considering `org-extend-today-until'."
5076 ;;;; Font-Lock stuff, including the activators
5107 "Regular expression used to analyze links.
5108 Here is what the match groups contain after a match:
5109 1: http:
5110 2: http
5111 3: path
5112 4: [desc]
5120 "Number of stacked braces for sub/superscript matching.
5121 This has to be set before loading org.el to be effective."
5126 "Create a regular expression which will match a balanced sexp.
5127 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5128 as single character strings.
5129 The regexp returned will match the entire expression including the
5130 delimiters. It will also define a single group which contains the
5131 match except for the outermost delimiters. The maximum depth of
5132 stacked delimiters is N. Escaping delimiters is not possible."
5161 "Update the link regular expressions.
5162 This should be called after the variable `org-link-types' has changed."
5166 org-link-re-with-space
5172 org-link-re-with-space2
5178 org-link-re-with-space3
5183 org-angle-link-re
5189 org-plain-link-re
5193 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5194 org-bracket-link-regexp
5196 org-bracket-link-analytic-regexp
5204 org-bracket-link-analytic-regexp++
5212 org-any-link-re
5221 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5223 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5224 "Regular expression matching time strings for analysis.
5225 This one does not require the space after the date, so it can be used
5227 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5243 "Regular expression matching a time stamp or time stamp range.
5249 "Run through the buffer and add overlays to emphasized strings."
5258 'face
5271 rtn))
5274 "Insert or change an emphasis, i.e. a font like bold or italic.
5275 If there is an active region, change that region to a new emphasis.
5276 If there is no region, just insert the marker characters and position
5277 the cursor between them.
5278 CHAR should be either the marker character, or the first character of the
5279 HTML tag associated with that emphasis. If CHAR is a space, the means
5280 to remove the emphasis of the selected region.
5281 If char is not given (for example in an interactive call) it
5282 will be prompted for."
5333 "Run through the buffer and add overlays to links."
5342 nil
5348 t)))))
5356 t)))
5359 "When non-nil, fontify code in code blocks."
5370 "Fontify #+ lines and blocks, in the correct ways."
5373 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5374 limit t)
5382 end end1 quoting block-type ovl)
5385 ;; a single line of backend-specific content
5393 ; for backend-specific code
5394 t)
5396 ;; Truly a block
5408 beg end
5416 ;; remove old background overlays
5421 ;; add a background overlay
5435 t))
5448 ;; just any other in-buffer setting, but not indented
5452 t)
5460 t)
5468 "Run through the buffer and add overlays to links."
5476 t)))
5479 "Run through the buffer and add overlays to footnotes."
5486 'keymap org-mouse-map
5487 'help-echo
5489 "Footnote definition"
5491 'font-lock-fontified t
5492 'font-lock-multiline t
5496 "Run through the buffer and add overlays to bracketed links."
5500 ;; FIXME: above we should remove the escapes.
5501 ;; but that requires another match, protecting match data,
5502 ;; a lot of overhead for font-lock.
5509 ;; We need to remove the invisible property here. Table narrowing
5510 ;; may have made some of this invisible.
5528 t)))
5531 "Run through the buffer and add overlays to dates."
5543 t)))
5552 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5556 "Run through the buffer and add overlays to target matches."
5564 'keymap org-mouse-map
5568 t)))))
5571 "Find all radio targets in this file and update the regular expression."
5586 t)))
5593 ;; This should be with the exporter code, but we also use if for font-locking
5603 "Compute regular expression for stuff treated specially by exporters."
5610 org-latex-regexps)))
5638 org-entities)))
5642 org-latex-entities)
5643 nil))
5645 ))
5646 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5649 org-export-html-special-string-regexps)))
5654 ))))
5656 'org-latex-and-specials-regexp
5661 "Run through the buffer and add overlays to links."
5665 limit t))
5679 rtn)))
5682 "Restart `font-lock-mode', to force refontification."
5688 "Return a list of all targets in this file.
5689 With optional argument RADIO, only find radio targets."
5691 rtn)
5696 rtn)))
5699 "Make regular expression matching all strings in TARGETS.
5700 The regular expression finds the targets also if there is a line break
5701 between words."
5710 x)
5711 targets
5723 t)))
5726 "Compute the outline level of the heading at point.
5727 This function assumes that the cursor is at the beginning of a line matched
5728 by `outline-regexp'. Otherwise it returns garbage.
5729 If this is called at a normal headline, the level is the number of stars.
5730 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5737 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5744 "Functions that can manipulate `org-font-lock-extra-keywords'.
5745 This is called after `org-font-lock-extra-keywords' is defined, but before
5746 it is installed to be used by font lock. This can be useful if something
5757 ;; Call the hook
5759 ;; Headlines
5766 ;; Table lines
5769 ;; Table internals
5774 ;; Drawers
5777 ;; Properties
5781 ;; Links
5791 ;; TODO keyword
5793 org-todo-regexp)
5795 ;; DONE
5803 nil)
5804 ;; Priorities
5806 ;; Tags
5808 ;; Special keywords
5813 ;; Emphasis
5818 ;; Checkboxes
5819 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5824 ;; Description list items
5827 ;; ARCHIVEd headings
5829 org-outline-regexp-bol
5832 ;; Specials
5836 ;; Code
5838 ;; COMMENT
5845 ;; Blocks and meta lines
5847 )))
5850 ;; Now set the full font-lock-keywords
5857 "Toggle the composition display of entities as UTF8 characters."
5869 "Find an entity to fontify."
5875 limit t)
5887 nil))))
5890 "Fontify string S like in Org-mode."
5902 "Get the right face for match N in font-lock matching of headlines."
5915 "Get the right face for a TODO keyword KWD.
5916 If KWD is a number, get the corresponding match group."
5924 "Create a face list that inherits INHERIT, but sets the foreground color.
5925 When FACE-OR-COLOR is not a string, just return it."
5929 face-or-color)
5930 face-or-color))
5933 "Add the special tag faces."
5942 "Add the special priority faces."
5949 org-priority-faces)))
5954 "Get the right face for a TODO keyword KWD.
5955 If KWD is a number, get the corresponding match group."
5962 "Remove fontification and activation overlays from links."
5967 deactivate-mark buffer-file-name buffer-file-truename)
5971 invisible t intangible t
5972 org-no-flyspell t org-emphasis t))
5982 "Remove specific display properties that have been added by font lock.
5983 The will remove the raise properties that are used to show superscripts
5984 and subscripts."
5994 "Add raise properties to sub/superscripts."
5998 org-match-substring-regexp
5999 org-match-substring-with-braces-regexp)
6000 limit t)
6010 ;; FIXME: Should we go back one character here, for a_b^c
6011 ;; (goto-char (1- pos)) ;????????????????????
6013 t
6015 'display
6031 t)))))
6033 ;;;; Visibility cycling, including org-goto and indirect buffer
6035 ;;; Cycling
6042 ;;;###autoload
6047 "TAB-action and visibility cycling for Org-mode.
6049 This is the command invoked in Org-mode by the TAB key. Its main purpose
6050 is outline visibility cycling, but it also invokes other actions
6051 in special contexts.
6053 - When this function is called with a prefix argument, rotate the entire
6054 buffer through 3 states (global cycling)
6055 1. OVERVIEW: Show only top-level headlines.
6056 2. CONTENTS: Show all headlines of all levels, but no body text.
6057 3. SHOW ALL: Show everything.
6058 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6059 determined by the variable `org-startup-folded', and by any VISIBILITY
6060 properties in the buffer.
6061 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6062 including any drawers.
6064 - When inside a table, re-align the table and move to the next field.
6066 - When point is at the beginning of a headline, rotate the subtree started
6067 by this line through 3 different states (local cycling)
6068 1. FOLDED: Only the main headline is shown.
6069 2. CHILDREN: The main headline and the direct children are shown.
6070 From this state, you can move to one of the children
6071 and zoom in further.
6072 3. SUBTREE: Show the entire subtree, including body text.
6073 If there is no subtree, switch directly from CHILDREN to FOLDED.
6075 - When point is at the beginning of an empty headline and the variable
6076 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6077 of the headline by demoting and promoting it to likely levels. This
6078 speeds up creation document structure by pressing TAB once or several
6079 times right after creating a new headline.
6081 - When there is a numeric prefix, go up to a heading with level ARG, do
6082 a `show-subtree' and return to the previous cursor position. If ARG
6083 is negative, go up that many levels.
6085 - When point is not at the beginning of a headline, execute the global
6086 binding for TAB, which is re-indenting the line. See the option
6087 `org-cycle-emulate-tab' for details.
6089 - Special case: if point is at the beginning of the buffer and there is
6090 no headline in line 1, this function will act as if called with prefix arg
6091 (C-u TAB, same as S-TAB) also when called without prefix arg.
6092 But only if also the variable `org-cycle-global-at-bob' is t."
6102 org-inlinetask-min-level
6107 limit-level)))
6110 outline-regexp
6118 org-cycle-hook))
6122 ;; special case: use global cycling
6136 ;; Table: enter it or move to the next field.
6147 ;; Global cycling: delegate to `org-cycle-internal-global'.
6150 ;; Drawers: delegate to `org-flag-drawer'.
6158 ;; Show-subtree, ARG levels up from here.
6166 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6174 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6181 ;; From there: TAB emulation and template completion.
6203 t
6212 "Do the global cycling action."
6216 ;; We just created the overview - now do table of contents
6217 ;; This can be slow in very large buffers, so indicate action
6227 ;; We just showed the table of contents - now show everything
6235 ;; Default action: go to overview
6243 "Do the local cycling action."
6245 ;; First, determine end of headline (EOH), end of subtree or item
6246 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6270 ;; Determine end invisible part of buffer (EOL)
6272 ;; XEmacs doesn't have `next-single-char-property-change'
6282 ;; Find out what to do next and set `this-command'
6285 ;; Nothing is hidden behind this heading
6297 org-cycle-skip-children-state-if-no-children))))
6298 ;; Entire subtree is hidden in one line: children view
6304 ;; Fold every list in subtree to top-level items.
6326 ;; We just showed the children, or no children are there,
6327 ;; now show everything.
6334 ;; Default action: hide the subtree.
6341 ;;;###autoload
6343 "Cycle the global visibility. For details see `org-cycle'.
6345 With a numeric prefix, show all headlines up to that level."
6361 "Set the visibility required by startup options and properties."
6376 "Switch subtree visibilities according to :VISIBILITY: property."
6383 nil t)
6407 ;; This function uses outline-regexp instead of the more fundamental
6408 ;; org-outline-regexp so that org-cycle-global works outside of Org
6409 ;; buffers, where outline-regexp is needed.
6411 "Switch to overview mode, showing only top-level headlines.
6412 Really, this shows all headlines with level equal or greater than the level
6413 of the first headline in the buffer. This is important, because if the
6414 first headline is not level one, then (hide-sublevels 1) gives confusing
6415 results."
6426 "Show all headlines in the buffer, like a table of contents.
6427 With numerical argument N, show content up to level N."
6430 ;; Visit all headings and show their offspring
6437 t)
6446 "Adjust the window after a change in outline visibility.
6447 This function is the default value of the hook `org-cycle-hook'."
6457 "Remove outline overlays that do not contain non-white stuff."
6467 "Fix visibility issues after moving a subtree."
6468 ;; First, find a reasonable region to look at:
6469 ;; Start two siblings above, end three below
6487 ;; Properly fold already folded siblings
6498 "Show empty lines above all visible headlines.
6499 The region to be covered depends on STATE when called through
6500 `org-cycle-hook'. Lisp program can use t for STATE to get the
6501 entire buffer covered. Note that an empty line is only shown if there
6502 are at least `org-cycle-separator-lines' empty lines before the headline."
6512 beg end b e)
6536 ;; Never hide empty lines at the end of the file.
6546 "Move to the parent and re-show empty lines before visible headlines."
6552 "Return `org-agenda-files' list, plus all open org-mode files.
6553 This is useful for operations that need to scan all of a user's
6554 open and agenda-wise Org files."
6562 files))
6565 "Return the beginning position of the current entry."
6569 "Return the end position of the current entry."
6573 "Re-hide all drawers after a visibility state change."
6599 "Is the end of the current subtree visible?"
6604 "Move cursor to the first headline and recenter the headline.
6605 Optional argument N means put the headline into the Nth line of the window."
6611 ;;; Saving and restoring visibility
6614 "Return a list of the locations of all outline overlays.
6615 These are overlays with the `invisible' property value `outline'.
6616 The return value is a list of cons cells, with start and stop
6617 positions for each overlay.
6618 If USE-MARKERS is set, return the positions as markers."
6636 "Create visibility overlays for all positions in DATA.
6637 DATA should have been made by `org-outline-overlay-data'."
6645 data)))))
6647 ;;; Folding of blocks
6654 "Call FUNCTION at the head of all source blocks in the current buffer.
6655 Optional arguments START and END can be used to limit the range."
6667 "Toggle the visibility of all blocks in the current buffer."
6671 "Fold all blocks in the current buffer."
6677 "Unfold all blocks in the current buffer."
6683 "Toggle visibility of block at point."
6694 "Toggle the visibility of the current block."
6701 ov)
6717 ;; make the block accessible to isearch
6719 ov 'isearch-open-invisible
6730 ;; org-tab-after-check-for-cycling-hook
6732 ;; Remove overlays when changing major mode
6737 ;;; Org-goto
6743 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6759 nil)
6760 (org-defkey map "q" 'org-goto-quit)
6761 (org-defkey map "n" 'outline-next-visible-heading)
6762 (org-defkey map "p" 'outline-previous-visible-heading)
6763 (org-defkey map "f" 'outline-forward-same-level)
6764 (org-defkey map "b" 'outline-backward-same-level)
6765 (org-defkey map "u" 'outline-up-heading))
6766 (org-defkey map "/" 'org-occur)
6767 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6768 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6769 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6770 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6771 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6772 map))
6774 (defconst org-goto-help
6775 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6776 RET=jump to location [Q]uit and return to previous location
6777 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6779 (defvar org-goto-start-pos) ; dynamically scoped parameter
6781 ;; FIXME: Docstring does not mention both interfaces
6782 (defun org-goto (&optional alternative-interface)
6783 "Look up a different location in the current file, keeping current visibility.
6785 When you want look-up or go to a different location in a document, the
6786 fastest way is often to fold the entire buffer and then dive into the tree.
6787 This method has the disadvantage, that the previous location will be folded,
6788 which may not be what you want.
6790 This command works around this by showing a copy of the current buffer
6791 in an indirect buffer, in overview mode. You can dive into the tree in
6792 that copy, use org-occur and incremental search to find a location.
6793 When pressing RET or `Q', the command returns to the original buffer in
6794 which the visibility is still unchanged. After RET is will also jump to
6795 the location selected in the indirect buffer and expose the headline
6796 hierarchy above."
6797 (interactive "P")
6798 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6799 (org-refile-use-outline-path t)
6800 (org-refile-target-verify-function nil)
6801 (interface
6802 (if (not alternative-interface)
6803 org-goto-interface
6804 (if (eq org-goto-interface 'outline)
6805 'outline-path-completion
6806 'outline)))
6807 (org-goto-start-pos (point))
6808 (selected-point
6809 (if (eq interface 'outline)
6810 (car (org-get-location (current-buffer) org-goto-help))
6811 (let ((pa (org-refile-get-location "Goto")))
6812 (org-refile-check-position pa)
6813 (nth 3 pa)))))
6814 (if selected-point
6815 (progn
6816 (org-mark-ring-push org-goto-start-pos)
6817 (goto-char selected-point)
6818 (if (or (outline-invisible-p) (org-invisible-p2))
6819 (org-show-context 'org-goto)))
6820 (message "Quit"))))
6822 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6823 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6824 (defvar org-goto-local-auto-isearch-map) ; defined below
6826 (defun org-get-location (buf help)
6827 "Let the user select a location in the Org-mode buffer BUF.
6828 This function uses a recursive edit. It returns the selected position
6829 or nil."
6830 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6831 (isearch-hide-immediately nil)
6832 (isearch-search-fun-function
6833 (lambda () 'org-goto-local-search-headings))
6834 (org-goto-selected-point org-goto-exit-command)
6835 (pop-up-frames nil)
6836 (special-display-buffer-names nil)
6837 (special-display-regexps nil)
6838 (special-display-function nil))
6839 (save-excursion
6840 (save-window-excursion
6841 (delete-other-windows)
6842 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6843 (org-pop-to-buffer-same-window
6844 (condition-case nil
6845 (make-indirect-buffer (current-buffer) "*org-goto*")
6846 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6847 (with-output-to-temp-buffer "*Help*"
6848 (princ help))
6849 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6850 (setq buffer-read-only nil)
6851 (let ((org-startup-truncated t)
6852 (org-startup-folded nil)
6853 (org-startup-align-all-tables nil))
6854 (org-mode)
6855 (org-overview))
6856 (setq buffer-read-only t)
6857 (if (and (boundp 'org-goto-start-pos)
6858 (integer-or-marker-p org-goto-start-pos))
6859 (let ((org-show-hierarchy-above t)
6860 (org-show-siblings t)
6861 (org-show-following-heading t))
6862 (goto-char org-goto-start-pos)
6863 (and (outline-invisible-p) (org-show-context)))
6864 (goto-char (point-min)))
6865 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6866 (message "Select location and press RET")
6867 (use-local-map org-goto-map)
6868 (recursive-edit)
6869 ))
6870 (kill-buffer "*org-goto*")
6871 (cons org-goto-selected-point org-goto-exit-command)))
6873 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6874 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6875 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6876 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6878 (defun org-goto-local-search-headings (string bound noerror)
6879 "Search and make sure that any matches are in headlines."
6880 (catch 'return
6881 (while (if isearch-forward
6882 (search-forward string bound noerror)
6883 (search-backward string bound noerror))
6884 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6885 (and (member :headline context)
6886 (not (member :tags context))))
6887 (throw 'return (point))))))
6889 (defun org-goto-local-auto-isearch ()
6890 "Start isearch."
6891 (interactive)
6892 (goto-char (point-min))
6893 (let ((keys (this-command-keys)))
6894 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6895 (isearch-mode t)
6896 (isearch-process-search-char (string-to-char keys)))))
6898 (defun org-goto-ret (&optional arg)
6899 "Finish `org-goto' by going to the new location."
6900 (interactive "P")
6901 (setq org-goto-selected-point (point)
6902 org-goto-exit-command 'return)
6903 (throw 'exit nil))
6905 (defun org-goto-left ()
6906 "Finish `org-goto' by going to the new location."
6907 (interactive)
6908 (if (org-at-heading-p)
6909 (progn
6910 (beginning-of-line 1)
6911 (setq org-goto-selected-point (point)
6912 org-goto-exit-command 'left)
6913 (throw 'exit nil))
6914 (error "Not on a heading")))
6916 (defun org-goto-right ()
6917 "Finish `org-goto' by going to the new location."
6918 (interactive)
6919 (if (org-at-heading-p)
6920 (progn
6921 (setq org-goto-selected-point (point)
6922 org-goto-exit-command 'right)
6923 (throw 'exit nil))
6924 (error "Not on a heading")))
6926 (defun org-goto-quit ()
6927 "Finish `org-goto' without cursor motion."
6928 (interactive)
6929 (setq org-goto-selected-point nil)
6930 (setq org-goto-exit-command 'quit)
6931 (throw 'exit nil))
6933 ;;; Indirect buffer display of subtrees
6935 (defvar org-indirect-dedicated-frame nil
6936 "This is the frame being used for indirect tree display.")
6937 (defvar org-last-indirect-buffer nil)
6939 (defun org-tree-to-indirect-buffer (&optional arg)
6940 "Create indirect buffer and narrow it to current subtree.
6941 With numerical prefix ARG, go up to this level and then take that tree.
6942 If ARG is negative, go up that many levels.
6943 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6944 indirect buffer previously made with this command, to avoid proliferation of
6945 indirect buffers. However, when you call the command with a \
6947 when `org-indirect-buffer-display' is `new-frame', the last buffer
6948 is kept so that you can work with several indirect buffers at the same time.
6949 If `org-indirect-buffer-display' is `dedicated-frame', the \
6951 requests that a new frame be made for the new buffer, so that the dedicated
6952 frame is not changed."
6953 (interactive "P")
6954 (let ((cbuf (current-buffer))
6955 (cwin (selected-window))
6956 (pos (point))
6957 beg end level heading ibuf)
6958 (save-excursion
6959 (org-back-to-heading t)
6960 (when (numberp arg)
6961 (setq level (org-outline-level))
6962 (if (< arg 0) (setq arg (+ level arg)))
6963 (while (> (setq level (org-outline-level)) arg)
6964 (outline-up-heading 1 t)))
6965 (setq beg (point)
6966 heading (org-get-heading))
6967 (org-end-of-subtree t t)
6968 (if (org-at-heading-p) (backward-char 1))
6969 (setq end (point)))
6970 (if (and (buffer-live-p org-last-indirect-buffer)
6971 (not (eq org-indirect-buffer-display 'new-frame))
6972 (not arg))
6973 (kill-buffer org-last-indirect-buffer))
6974 (setq ibuf (org-get-indirect-buffer cbuf)
6975 org-last-indirect-buffer ibuf)
6976 (cond
6977 ((or (eq org-indirect-buffer-display 'new-frame)
6978 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6979 (select-frame (make-frame))
6980 (delete-other-windows)
6981 (org-pop-to-buffer-same-window ibuf)
6982 (org-set-frame-title heading))
6983 ((eq org-indirect-buffer-display 'dedicated-frame)
6984 (raise-frame
6985 (select-frame (or (and org-indirect-dedicated-frame
6986 (frame-live-p org-indirect-dedicated-frame)
6987 org-indirect-dedicated-frame)
6988 (setq org-indirect-dedicated-frame (make-frame)))))
6989 (delete-other-windows)
6990 (org-pop-to-buffer-same-window ibuf)
6991 (org-set-frame-title (concat "Indirect: " heading)))
6992 ((eq org-indirect-buffer-display 'current-window)
6993 (org-pop-to-buffer-same-window ibuf))
6994 ((eq org-indirect-buffer-display 'other-window)
6995 (pop-to-buffer ibuf))
6996 (t (error "Invalid value")))
6997 (if (featurep 'xemacs)
6998 (save-excursion (org-mode) (turn-on-font-lock)))
6999 (narrow-to-region beg end)
7000 (show-all)
7001 (goto-char pos)
7002 (run-hook-with-args 'org-cycle-hook 'all)
7003 (and (window-live-p cwin) (select-window cwin))))
7005 (defun org-get-indirect-buffer (&optional buffer)
7006 (setq buffer (or buffer (current-buffer)))
7007 (let ((n 1) (base (buffer-name buffer)) bname)
7008 (while (buffer-live-p
7009 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7010 (setq n (1+ n)))
7011 (condition-case nil
7012 (make-indirect-buffer buffer bname 'clone)
7013 (error (make-indirect-buffer buffer bname)))))
7015 (defun org-set-frame-title (title)
7016 "Set the title of the current frame to the string TITLE."
7017 ;; FIXME: how to name a single frame in XEmacs???
7018 (unless (featurep 'xemacs)
7019 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7021 ;;;; Structure editing
7023 ;;; Inserting headlines
7025 (defun org-previous-line-empty-p ()
7026 (save-excursion
7027 (and (not (bobp))
7028 (or (beginning-of-line 0) t)
7029 (save-match-data
7032 (defun org-insert-heading (&optional force-heading invisible-ok)
7033 "Insert a new heading or item with same depth at point.
7034 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7035 If point is at the beginning of a headline, insert a sibling before the
7036 current headline. If point is not at the beginning, split the line,
7037 create the new headline with the text in the current line after point
7038 \(but see also the variable `org-M-RET-may-split-line').
7040 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7041 This is important for non-interactive uses of the command."
7042 (interactive "P")
7043 (if (or (= (buffer-size) 0)
7044 (and (not (save-excursion
7045 (and (ignore-errors (org-back-to-heading invisible-ok))
7046 (org-at-heading-p))))
7047 (or force-heading (not (org-in-item-p)))))
7048 (progn
7050 (run-hooks 'org-insert-heading-hook))
7051 (when (or force-heading (not (org-insert-item)))
7052 (let* ((empty-line-p nil)
7053 (level nil)
7054 (on-heading (org-at-heading-p))
7055 (head (save-excursion
7056 (condition-case nil
7057 (progn
7058 (org-back-to-heading invisible-ok)
7059 (when (and (not on-heading)
7060 (featurep 'org-inlinetask)
7061 (integerp org-inlinetask-min-level)
7062 (>= (length (match-string 0))
7063 org-inlinetask-min-level))
7064 ;; Find a heading level before the inline task
7065 (while (and (setq level (org-up-heading-safe))
7066 (>= level org-inlinetask-min-level)))
7067 (if (org-at-heading-p)
7068 (org-back-to-heading invisible-ok)
7069 (error "This should not happen")))
7070 (setq empty-line-p (org-previous-line-empty-p))
7071 (match-string 0))
7072 (error "*"))))
7073 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7074 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7075 pos hide-previous previous-pos)
7076 (cond
7077 ((and (org-at-heading-p) (bolp)
7078 (or (bobp)
7079 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7080 ;; insert before the current line
7081 (open-line (if blank 2 1)))
7082 ((and (bolp)
7083 (not org-insert-heading-respect-content)
7084 (or (bobp)
7085 (save-excursion
7086 (backward-char 1) (not (outline-invisible-p)))))
7087 ;; insert right here
7088 nil)
7089 (t
7090 ;; somewhere in the line
7091 (save-excursion
7092 (setq previous-pos (point-at-bol))
7093 (end-of-line)
7094 (setq hide-previous (outline-invisible-p)))
7095 (and org-insert-heading-respect-content (org-show-subtree))
7096 (let ((split
7097 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7098 (save-excursion
7099 (let ((p (point)))
7100 (goto-char (point-at-bol))
7101 (and (looking-at org-complex-heading-regexp)
7102 (match-beginning 4)
7103 (> p (match-beginning 4)))))))
7104 tags pos)
7105 (cond
7106 (org-insert-heading-respect-content
7107 (org-end-of-subtree nil t)
7108 (when (featurep 'org-inlinetask)
7109 (while (and (not (eobp))
7111 (>= (length (match-string 1))
7112 org-inlinetask-min-level))
7113 (org-end-of-subtree nil t)))
7114 (or (bolp) (newline))
7115 (or (org-previous-line-empty-p)
7116 (and blank (newline)))
7117 (open-line 1))
7118 ((org-at-heading-p)
7119 (when hide-previous
7120 (show-children)
7121 (org-show-entry))
7123 (setq tags (and (match-end 2) (match-string 2)))
7124 (and (match-end 1)
7125 (delete-region (match-beginning 1) (match-end 1)))
7126 (setq pos (point-at-bol))
7127 (or split (end-of-line 1))
7128 (delete-horizontal-space)
7130 (buffer-substring (point-at-bol) (point)))
7131 (insert " "))
7132 (newline (if blank 2 1))
7133 (when tags
7134 (save-excursion
7135 (goto-char pos)
7136 (end-of-line 1)
7137 (insert " " tags)
7138 (org-set-tags nil 'align))))
7139 (t
7140 (or split (end-of-line 1))
7141 (newline (if blank 2 1)))))))
7142 (insert head) (just-one-space)
7143 (setq pos (point))
7144 (end-of-line 1)
7145 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7146 (when (and org-insert-heading-respect-content hide-previous)
7147 (save-excursion
7148 (goto-char previous-pos)
7149 (hide-subtree)))
7150 (run-hooks 'org-insert-heading-hook)))))
7152 (defun org-get-heading (&optional no-tags no-todo)
7153 "Return the heading of the current entry, without the stars.
7154 When NO-TAGS is non-nil, don't include tags.
7155 When NO-TODO is non-nil, don't include TODO keywords."
7156 (save-excursion
7157 (org-back-to-heading t)
7158 (cond
7159 ((and no-tags no-todo)
7160 (looking-at org-complex-heading-regexp)
7161 (match-string 4))
7162 (no-tags
7163 (looking-at (concat org-outline-regexp
7166 (match-string 1))
7167 (no-todo
7168 (looking-at org-todo-line-regexp)
7169 (match-string 3))
7170 (t (looking-at org-heading-regexp)
7171 (match-string 2)))))
7173 (defun org-heading-components ()
7174 "Return the components of the current heading.
7175 This is a list with the following elements:
7176 - the level as an integer
7177 - the reduced level, different if `org-odd-levels-only' is set.
7178 - the TODO keyword, or nil
7179 - the priority character, like ?A, or nil if no priority is given
7180 - the headline text itself, or the tags string if no headline text
7181 - the tags string, or nil."
7182 (save-excursion
7183 (org-back-to-heading t)
7184 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7185 (list (length (match-string 1))
7186 (org-reduced-level (length (match-string 1)))
7187 (org-match-string-no-properties 2)
7188 (and (match-end 3) (aref (match-string 3) 2))
7189 (org-match-string-no-properties 4)
7190 (org-match-string-no-properties 5)))))
7192 (defun org-get-entry ()
7193 "Get the entry text, after heading, entire subtree."
7194 (save-excursion
7195 (org-back-to-heading t)
7196 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7198 (defun org-insert-heading-after-current ()
7199 "Insert a new heading with same level as current, after current subtree."
7200 (interactive)
7201 (org-back-to-heading)
7202 (org-insert-heading)
7203 (org-move-subtree-down)
7204 (end-of-line 1))
7206 (defun org-insert-heading-respect-content ()
7207 (interactive)
7208 (let ((org-insert-heading-respect-content t))
7209 (org-insert-heading t)))
7211 (defun org-insert-todo-heading-respect-content (&optional force-state)
7212 (interactive "P")
7213 (let ((org-insert-heading-respect-content t))
7214 (org-insert-todo-heading force-state t)))
7216 (defun org-insert-todo-heading (arg &optional force-heading)
7217 "Insert a new heading with the same level and TODO state as current heading.
7218 If the heading has no TODO state, or if the state is DONE, use the first
7219 state (TODO by default). Also with prefix arg, force first state."
7220 (interactive "P")
7221 (when (or force-heading (not (org-insert-item 'checkbox)))
7222 (org-insert-heading force-heading)
7223 (save-excursion
7224 (org-back-to-heading)
7225 (outline-previous-heading)
7226 (looking-at org-todo-line-regexp))
7227 (let*
7228 ((new-mark-x
7229 (if (or arg
7230 (not (match-beginning 2))
7231 (member (match-string 2) org-done-keywords))
7232 (car org-todo-keywords-1)
7233 (match-string 2)))
7234 (new-mark
7235 (or
7236 (run-hook-with-args-until-success
7237 'org-todo-get-default-hook new-mark-x nil)
7238 new-mark-x)))
7239 (beginning-of-line 1)
7240 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7241 (if org-treat-insert-todo-heading-as-state-change
7242 (org-todo new-mark)
7243 (insert new-mark " "))))
7244 (when org-provide-todo-statistics
7245 (org-update-parent-todo-statistics))))
7247 (defun org-insert-subheading (arg)
7248 "Insert a new subheading and demote it.
7249 Works for outline headings and for plain lists alike."
7250 (interactive "P")
7251 (org-insert-heading arg)
7252 (cond
7253 ((org-at-heading-p) (org-do-demote))
7254 ((org-at-item-p) (org-indent-item))))
7256 (defun org-insert-todo-subheading (arg)
7257 "Insert a new subheading with TODO keyword or checkbox and demote it.
7258 Works for outline headings and for plain lists alike."
7259 (interactive "P")
7260 (org-insert-todo-heading arg)
7261 (cond
7262 ((org-at-heading-p) (org-do-demote))
7263 ((org-at-item-p) (org-indent-item))))
7265 ;;; Promotion and Demotion
7267 (defvar org-after-demote-entry-hook nil
7268 "Hook run after an entry has been demoted.
7269 The cursor will be at the beginning of the entry.
7270 When a subtree is being demoted, the hook will be called for each node.")
7272 (defvar org-after-promote-entry-hook nil
7273 "Hook run after an entry has been promoted.
7274 The cursor will be at the beginning of the entry.
7275 When a subtree is being promoted, the hook will be called for each node.")
7277 (defun org-promote-subtree ()
7278 "Promote the entire subtree.
7279 See also `org-promote'."
7280 (interactive)
7281 (save-excursion
7282 (org-with-limited-levels (org-map-tree 'org-promote)))
7283 (org-fix-position-after-promote))
7285 (defun org-demote-subtree ()
7286 "Demote the entire subtree. See `org-demote'.
7287 See also `org-promote'."
7288 (interactive)
7289 (save-excursion
7290 (org-with-limited-levels (org-map-tree 'org-demote)))
7291 (org-fix-position-after-promote))
7294 (defun org-do-promote ()
7295 "Promote the current heading higher up the tree.
7296 If the region is active in `transient-mark-mode', promote all headings
7297 in the region."
7298 (interactive)
7299 (save-excursion
7300 (if (org-region-active-p)
7301 (org-map-region 'org-promote (region-beginning) (region-end))
7302 (org-promote)))
7303 (org-fix-position-after-promote))
7305 (defun org-do-demote ()
7306 "Demote the current heading lower down the tree.
7307 If the region is active in `transient-mark-mode', demote all headings
7308 in the region."
7309 (interactive)
7310 (save-excursion
7311 (if (org-region-active-p)
7312 (org-map-region 'org-demote (region-beginning) (region-end))
7313 (org-demote)))
7314 (org-fix-position-after-promote))
7316 (defun org-fix-position-after-promote ()
7317 "Make sure that after pro/demotion cursor position is right."
7318 (let ((pos (point)))
7319 (when (save-excursion
7320 (beginning-of-line 1)
7321 (looking-at org-todo-line-regexp)
7322 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7323 (cond ((eobp) (insert " "))
7324 ((eolp) (insert " "))
7325 ((equal (char-after) ?\ ) (forward-char 1))))))
7327 (defun org-current-level ()
7328 "Return the level of the current entry, or nil if before the first headline.
7329 The level is the number of stars at the beginning of the headline."
7330 (save-excursion
7331 (org-with-limited-levels
7332 (if (ignore-errors (org-back-to-heading t))
7333 (funcall outline-level)))))
7335 (defun org-get-previous-line-level ()
7336 "Return the outline depth of the last headline before the current line.
7337 Returns 0 for the first headline in the buffer, and nil if before the
7338 first headline."
7339 (let ((current-level (org-current-level))
7340 (prev-level (when (> (line-number-at-pos) 1)
7341 (save-excursion
7342 (beginning-of-line 0)
7343 (org-current-level)))))
7344 (cond ((null current-level) nil) ; Before first headline
7345 ((null prev-level) 0) ; At first headline
7346 (prev-level))))
7348 (defun org-reduced-level (l)
7349 "Compute the effective level of a heading.
7350 This takes into account the setting of `org-odd-levels-only'."
7351 (cond
7352 ((zerop l) 0)
7353 (org-odd-levels-only (1+ (floor (/ l 2))))
7354 (t l)))
7356 (defun org-level-increment ()
7357 "Return the number of stars that will be added or removed at a
7358 time to headlines when structure editing, based on the value of
7359 `org-odd-levels-only'."
7360 (if org-odd-levels-only 2 1))
7362 (defun org-get-valid-level (level &optional change)
7363 "Rectify a level change under the influence of `org-odd-levels-only'
7364 LEVEL is a current level, CHANGE is by how much the level should be
7365 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7366 even level numbers will become the next higher odd number."
7367 (if org-odd-levels-only
7368 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7369 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7370 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7371 (max 1 (+ level (or change 0)))))
7373 (if (boundp 'define-obsolete-function-alias)
7374 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7375 (define-obsolete-function-alias 'org-get-legal-level
7376 'org-get-valid-level)
7377 (define-obsolete-function-alias 'org-get-legal-level
7378 'org-get-valid-level "23.1")))
7380 (defun org-promote ()
7381 "Promote the current heading higher up the tree.
7382 If the region is active in `transient-mark-mode', promote all headings
7383 in the region."
7384 (org-back-to-heading t)
7385 (let* ((level (save-match-data (funcall outline-level)))
7386 (after-change-functions (remove 'flyspell-after-change-function
7387 after-change-functions))
7388 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7389 (diff (abs (- level (length up-head) -1))))
7390 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7391 (replace-match up-head nil t)
7392 ;; Fixup tag positioning
7393 (and org-auto-align-tags (org-set-tags nil t))
7394 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7395 (run-hooks 'org-after-promote-entry-hook)))
7397 (defun org-demote ()
7398 "Demote the current heading lower down the tree.
7399 If the region is active in `transient-mark-mode', demote all headings
7400 in the region."
7401 (org-back-to-heading t)
7402 (let* ((level (save-match-data (funcall outline-level)))
7403 (after-change-functions (remove 'flyspell-after-change-function
7404 after-change-functions))
7405 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7406 (diff (abs (- level (length down-head) -1))))
7407 (replace-match down-head nil t)
7408 ;; Fixup tag positioning
7409 (and org-auto-align-tags (org-set-tags nil t))
7410 (if org-adapt-indentation (org-fixup-indentation diff))
7411 (run-hooks 'org-after-demote-entry-hook)))
7413 (defun org-cycle-level ()
7414 "Cycle the level of an empty headline through possible states.
7415 This goes first to child, then to parent, level, then up the hierarchy.
7416 After top level, it switches back to sibling level."
7417 (interactive)
7418 (let ((org-adapt-indentation nil))
7419 (when (org-point-at-end-of-empty-headline)
7420 (setq this-command 'org-cycle-level) ; Only needed for caching
7421 (let ((cur-level (org-current-level))
7422 (prev-level (org-get-previous-line-level)))
7423 (cond
7424 ;; If first headline in file, promote to top-level.
7425 ((= prev-level 0)
7426 (loop repeat (/ (- cur-level 1) (org-level-increment))
7427 do (org-do-promote)))
7428 ;; If same level as prev, demote one.
7429 ((= prev-level cur-level)
7430 (org-do-demote))
7431 ;; If parent is top-level, promote to top level if not already.
7432 ((= prev-level 1)
7433 (loop repeat (/ (- cur-level 1) (org-level-increment))
7434 do (org-do-promote)))
7435 ;; If top-level, return to prev-level.
7436 ((= cur-level 1)
7437 (loop repeat (/ (- prev-level 1) (org-level-increment))
7438 do (org-do-demote)))
7439 ;; If less than prev-level, promote one.
7440 ((< cur-level prev-level)
7441 (org-do-promote))
7442 ;; If deeper than prev-level, promote until higher than
7443 ;; prev-level.
7444 ((> cur-level prev-level)
7445 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7446 do (org-do-promote))))
7447 t))))
7449 (defun org-map-tree (fun)
7450 "Call FUN for every heading underneath the current one."
7451 (org-back-to-heading)
7452 (let ((level (funcall outline-level)))
7453 (save-excursion
7454 (funcall fun)
7455 (while (and (progn
7456 (outline-next-heading)
7457 (> (funcall outline-level) level))
7458 (not (eobp)))
7459 (funcall fun)))))
7461 (defun org-map-region (fun beg end)
7462 "Call FUN for every heading between BEG and END."
7463 (let ((org-ignore-region t))
7464 (save-excursion
7465 (setq end (copy-marker end))
7466 (goto-char beg)
7467 (if (and (re-search-forward org-outline-regexp-bol nil t)
7468 (< (point) end))
7469 (funcall fun))
7470 (while (and (progn
7471 (outline-next-heading)
7472 (< (point) end))
7473 (not (eobp)))
7474 (funcall fun)))))
7476 (defvar org-property-end-re) ; silence byte-compiler
7477 (defun org-fixup-indentation (diff)
7478 "Change the indentation in the current entry by DIFF.
7479 However, if any line in the current entry has no indentation, or if it
7480 would end up with no indentation after the change, nothing at all is done."
7481 (save-excursion
7482 (let ((end (save-excursion (outline-next-heading)
7483 (point-marker)))
7484 (prohibit (if (> diff 0)
7487 col)
7488 (unless (save-excursion (end-of-line 1)
7489 (re-search-forward prohibit end t))
7490 (while (and (< (point) end)
7492 (goto-char (match-end 0))
7493 (setq col (current-column))
7494 (if (< diff 0) (replace-match ""))
7495 (org-indent-to-column (+ diff col))))
7496 (move-marker end nil))))
7498 (defun org-convert-to-odd-levels ()
7499 "Convert an org-mode file with all levels allowed to one with odd levels.
7500 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7501 level 5 etc."
7502 (interactive)
7503 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7504 (let ((outline-level 'org-outline-level)
7505 (org-odd-levels-only nil) n)
7506 (save-excursion
7507 (goto-char (point-min))
7509 (setq n (- (length (match-string 0)) 2))
7510 (while (>= (setq n (1- n)) 0)
7511 (org-demote))
7512 (end-of-line 1))))))
7514 (defun org-convert-to-oddeven-levels ()
7515 "Convert an org-mode file with only odd levels to one with odd/even levels.
7516 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7517 file contains a section with an even level, conversion would
7518 destroy the structure of the file. An error is signaled in this
7519 case."
7520 (interactive)
7521 (goto-char (point-min))
7522 ;; First check if there are no even levels
7524 (org-show-context t)
7525 (error "Not all levels are odd in this file. Conversion not possible"))
7526 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7527 (let ((outline-regexp org-outline-regexp)
7528 (outline-level 'org-outline-level)
7529 (org-odd-levels-only nil) n)
7530 (save-excursion
7531 (goto-char (point-min))
7533 (setq n (/ (1- (length (match-string 0))) 2))
7534 (while (>= (setq n (1- n)) 0)
7535 (org-promote))
7536 (end-of-line 1))))))
7538 (defun org-tr-level (n)
7539 "Make N odd if required."
7540 (if org-odd-levels-only (1+ (/ n 2)) n))
7542 ;;; Vertical tree motion, cutting and pasting of subtrees
7544 (defun org-move-subtree-up (&optional arg)
7545 "Move the current subtree up past ARG headlines of the same level."
7546 (interactive "p")
7547 (org-move-subtree-down (- (prefix-numeric-value arg))))
7549 (defun org-move-subtree-down (&optional arg)
7550 "Move the current subtree down past ARG headlines of the same level."
7551 (interactive "p")
7552 (setq arg (prefix-numeric-value arg))
7553 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7554 'org-get-last-sibling))
7555 (ins-point (make-marker))
7556 (cnt (abs arg))
7557 (col (current-column))
7558 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7559 ;; Select the tree
7560 (org-back-to-heading)
7561 (setq beg0 (point))
7562 (save-excursion
7563 (setq ne-beg (org-back-over-empty-lines))
7564 (setq beg (point)))
7565 (save-match-data
7566 (save-excursion (outline-end-of-heading)
7567 (setq folded (outline-invisible-p)))
7568 (outline-end-of-subtree))
7569 (outline-next-heading)
7570 (setq ne-end (org-back-over-empty-lines))
7571 (setq end (point))
7572 (goto-char beg0)
7573 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7574 ;; include less whitespace
7575 (save-excursion
7576 (goto-char beg)
7577 (forward-line (- ne-beg ne-end))
7578 (setq beg (point))))
7579 ;; Find insertion point, with error handling
7580 (while (> cnt 0)
7581 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7582 (progn (goto-char beg0)
7583 (error "Cannot move past superior level or buffer limit")))
7584 (setq cnt (1- cnt)))
7585 (if (> arg 0)
7586 ;; Moving forward - still need to move over subtree
7587 (progn (org-end-of-subtree t t)
7588 (save-excursion
7589 (org-back-over-empty-lines)
7590 (or (bolp) (newline)))))
7591 (setq ne-ins (org-back-over-empty-lines))
7592 (move-marker ins-point (point))
7593 (setq txt (buffer-substring beg end))
7594 (org-save-markers-in-region beg end)
7595 (delete-region beg end)
7596 (org-remove-empty-overlays-at beg)
7597 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7598 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7600 (let ((bbb (point)))
7601 (insert-before-markers txt)
7602 (org-reinstall-markers-in-region bbb)
7603 (move-marker ins-point bbb))
7605 (setq ins-end (point))
7606 (goto-char ins-point)
7607 (org-skip-whitespace)
7608 (when (and (< arg 0)
7609 (org-first-sibling-p)
7610 (> ne-ins ne-beg))
7611 ;; Move whitespace back to beginning
7612 (save-excursion
7613 (goto-char ins-end)
7614 (let ((kill-whole-line t))
7615 (kill-line (- ne-ins ne-beg)) (point)))
7617 (move-marker ins-point nil)
7618 (if folded
7619 (hide-subtree)
7620 (org-show-entry)
7621 (show-children)
7622 (org-cycle-hide-drawers 'children))
7623 (org-clean-visibility-after-subtree-move)
7624 ;; move back to the initial column we were at
7625 (move-to-column col)))
7627 (defvar org-subtree-clip ""
7628 "Clipboard for cut and paste of subtrees.
7629 This is actually only a copy of the kill, because we use the normal kill
7630 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7632 (defvar org-subtree-clip-folded nil
7633 "Was the last copied subtree folded?
7634 This is used to fold the tree back after pasting.")
7636 (defun org-cut-subtree (&optional n)
7637 "Cut the current subtree into the clipboard.
7638 With prefix arg N, cut this many sequential subtrees.
7639 This is a short-hand for marking the subtree and then cutting it."
7640 (interactive "p")
7641 (org-copy-subtree n 'cut))
7643 (defun org-copy-subtree (&optional n cut force-store-markers)
7644 "Cut the current subtree into the clipboard.
7645 With prefix arg N, cut this many sequential subtrees.
7646 This is a short-hand for marking the subtree and then copying it.
7647 If CUT is non-nil, actually cut the subtree.
7648 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7649 of some markers in the region, even if CUT is non-nil. This is
7650 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7651 (interactive "p")
7652 (let (beg end folded (beg0 (point)))
7653 (if (org-called-interactively-p 'any)
7654 (org-back-to-heading nil) ; take what looks like a subtree
7655 (org-back-to-heading t)) ; take what is really there
7656 (org-back-over-empty-lines)
7657 (setq beg (point))
7659 (save-match-data
7660 (save-excursion (outline-end-of-heading)
7661 (setq folded (outline-invisible-p)))
7662 (condition-case nil
7663 (org-forward-same-level (1- n) t)
7664 (error nil))
7665 (org-end-of-subtree t t))
7666 (org-back-over-empty-lines)
7667 (setq end (point))
7668 (goto-char beg0)
7669 (when (> end beg)
7670 (setq org-subtree-clip-folded folded)
7671 (when (or cut force-store-markers)
7672 (org-save-markers-in-region beg end))
7673 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7674 (setq org-subtree-clip (current-kill 0))
7675 (message "%s: Subtree(s) with %d characters"
7676 (if cut "Cut" "Copied")
7677 (length org-subtree-clip)))))
7679 (defun org-paste-subtree (&optional level tree for-yank)
7680 "Paste the clipboard as a subtree, with modification of headline level.
7681 The entire subtree is promoted or demoted in order to match a new headline
7682 level.
7684 If the cursor is at the beginning of a headline, the same level as
7685 that headline is used to paste the tree
7687 If not, the new level is derived from the *visible* headings
7688 before and after the insertion point, and taken to be the inferior headline
7689 level of the two. So if the previous visible heading is level 3 and the
7690 next is level 4 (or vice versa), level 4 will be used for insertion.
7691 This makes sure that the subtree remains an independent subtree and does
7692 not swallow low level entries.
7694 You can also force a different level, either by using a numeric prefix
7695 argument, or by inserting the heading marker by hand. For example, if the
7698 If optional TREE is given, use this text instead of the kill ring.
7700 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7701 move back over whitespace before inserting, and move point to the end of
7702 the inserted text when done."
7703 (interactive "P")
7704 (setq tree (or tree (and kill-ring (current-kill 0))))
7705 (unless (org-kill-is-subtree-p tree)
7706 (error "%s"
7707 (substitute-command-keys
7709 (org-with-limited-levels
7710 (let* ((visp (not (outline-invisible-p)))
7711 (txt tree)
7713 (old-level (if (string-match org-outline-regexp-bol txt)
7714 (- (match-end 0) (match-beginning 0) 1)
7715 -1))
7716 (force-level (cond (level (prefix-numeric-value level))
7718 (string-match
7720 (point-at-bol) (point))))
7721 (- (match-end 1) (match-beginning 1)))
7722 ((and (bolp)
7723 (looking-at org-outline-regexp))
7724 (- (match-end 0) (point) 1))
7725 (t nil)))
7726 (previous-level (save-excursion
7727 (condition-case nil
7728 (progn
7729 (outline-previous-visible-heading 1)
7730 (if (looking-at ^re_)
7731 (- (match-end 0) (match-beginning 0) 1)
7732 1))
7733 (error 1))))
7734 (next-level (save-excursion
7735 (condition-case nil
7736 (progn
7737 (or (looking-at org-outline-regexp)
7738 (outline-next-visible-heading 1))
7739 (if (looking-at ^re_)
7740 (- (match-end 0) (match-beginning 0) 1)
7741 1))
7742 (error 1))))
7743 (new-level (or force-level (max previous-level next-level)))
7744 (shift (if (or (= old-level -1)
7745 (= new-level -1)
7746 (= old-level new-level))
7747 0
7748 (- new-level old-level)))
7749 (delta (if (> shift 0) -1 1))
7750 (func (if (> shift 0) 'org-demote 'org-promote))
7751 (org-odd-levels-only nil)
7752 beg end newend)
7753 ;; Remove the forced level indicator
7754 (if force-level
7755 (delete-region (point-at-bol) (point)))
7756 ;; Paste
7757 (beginning-of-line (if (bolp) 1 2))
7758 (unless for-yank (org-back-over-empty-lines))
7759 (setq beg (point))
7760 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7761 (insert-before-markers txt)
7763 (setq newend (point))
7764 (org-reinstall-markers-in-region beg)
7765 (setq end (point))
7766 (goto-char beg)
7768 (setq beg (point))
7769 (if (and (outline-invisible-p) visp)
7770 (save-excursion (outline-show-heading)))
7771 ;; Shift if necessary
7772 (unless (= shift 0)
7773 (save-restriction
7774 (narrow-to-region beg end)
7775 (while (not (= shift 0))
7776 (org-map-region func (point-min) (point-max))
7777 (setq shift (+ delta shift)))
7778 (goto-char (point-min))
7779 (setq newend (point-max))))
7780 (when (or (org-called-interactively-p 'interactive) for-yank)
7781 (message "Clipboard pasted as level %d subtree" new-level))
7782 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7783 kill-ring
7784 (eq org-subtree-clip (current-kill 0))
7785 org-subtree-clip-folded)
7786 ;; The tree was folded before it was killed/copied
7787 (hide-subtree))
7788 (and for-yank (goto-char newend)))))
7790 (defun org-kill-is-subtree-p (&optional txt)
7791 "Check if the current kill is an outline subtree, or a set of trees.
7792 Returns nil if kill does not start with a headline, or if the first
7793 headline level is not the largest headline level in the tree.
7794 So this will actually accept several entries of equal levels as well,
7795 which is OK for `org-paste-subtree'.
7796 If optional TXT is given, check this string instead of the current kill."
7797 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7798 (re (org-get-limited-outline-regexp))
7799 (^re (concat "^" re))
7800 (start-level (and kill
7801 (string-match
7803 kill)
7804 (- (match-end 2) (match-beginning 2) 1)))
7805 (start (1+ (or (match-beginning 2) -1))))
7806 (if (not start-level)
7807 (progn
7808 nil) ;; does not even start with a heading
7809 (catch 'exit
7810 (while (setq start (string-match ^re kill (1+ start)))
7811 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7812 (throw 'exit nil)))
7813 t))))
7815 (defvar org-markers-to-move nil
7816 "Markers that should be moved with a cut-and-paste operation.
7817 Those markers are stored together with their positions relative to
7818 the start of the region.")
7820 (defun org-save-markers-in-region (beg end)
7821 "Check markers in region.
7822 If these markers are between BEG and END, record their position relative
7823 to BEG, so that after moving the block of text, we can put the markers back
7824 into place.
7825 This function gets called just before an entry or tree gets cut from the
7826 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7827 called immediately, to move the markers with the entries."
7828 (setq org-markers-to-move nil)
7829 (when (featurep 'org-clock)
7830 (org-clock-save-markers-for-cut-and-paste beg end))
7831 (when (featurep 'org-agenda)
7832 (org-agenda-save-markers-for-cut-and-paste beg end)))
7834 (defun org-check-and-save-marker (marker beg end)
7835 "Check if MARKER is between BEG and END.
7836 If yes, remember the marker and the distance to BEG."
7837 (when (and (marker-buffer marker)
7838 (equal (marker-buffer marker) (current-buffer)))
7839 (if (and (>= marker beg) (< marker end))
7840 (push (cons marker (- marker beg)) org-markers-to-move))))
7842 (defun org-reinstall-markers-in-region (beg)
7843 "Move all remembered markers to their position relative to BEG."
7844 (mapc (lambda (x)
7845 (move-marker (car x) (+ beg (cdr x))))
7846 org-markers-to-move)
7847 (setq org-markers-to-move nil))
7849 (defun org-narrow-to-subtree ()
7850 "Narrow buffer to the current subtree."
7851 (interactive)
7852 (save-excursion
7853 (save-match-data
7854 (org-with-limited-levels
7855 (narrow-to-region
7856 (progn (org-back-to-heading t) (point))
7857 (progn (org-end-of-subtree t t)
7858 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7859 (point)))))))
7861 (defun org-narrow-to-block ()
7862 "Narrow buffer to the current block."
7863 (interactive)
7864 (let* ((case-fold-search t)
7867 (if blockp
7868 (narrow-to-region (car blockp) (cdr blockp))
7869 (error "Not in a block"))))
7871 (eval-when-compile
7872 (defvar org-property-drawer-re))
7874 (defvar org-property-start-re) ;; defined below
7875 (defun org-clone-subtree-with-time-shift (n &optional shift)
7876 "Clone the task (subtree) at point N times.
7877 The clones will be inserted as siblings.
7879 In interactive use, the user will be prompted for the number of
7880 clones to be produced, and for a time SHIFT, which may be a
7881 repeater as used in time stamps, for example `+3d'.
7883 When a valid repeater is given and the entry contains any time
7884 stamps, the clones will become a sequence in time, with time
7885 stamps in the subtree shifted for each clone produced. If SHIFT
7886 is nil or the empty string, time stamps will be left alone. The
7887 ID property of the original subtree is removed.
7889 If the original subtree did contain time stamps with a repeater,
7890 the following will happen:
7891 - the repeater will be removed in each clone
7892 - an additional clone will be produced, with the current, unshifted
7893 date(s) in the entry.
7894 - the original entry will be placed *after* all the clones, with
7895 repeater intact.
7896 - the start days in the repeater in the original entry will be shifted
7897 to past the last clone.
7898 I this way you can spell out a number of instances of a repeating task,
7899 and still retain the repeater to cover future instances of the task."
7900 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7901 (let (beg end template task idprop
7902 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7903 (drawer-re org-drawer-regexp))
7904 (if (not (and (integerp n) (> n 0)))
7905 (error "Invalid number of replications %s" n))
7908 shift)))
7909 (error "Invalid shift specification %s" shift))
7910 (when doshift
7911 (setq shift-n (string-to-number (match-string 1 shift))
7912 shift-what (cdr (assoc (match-string 2 shift)
7913 '(("d" . day) ("w" . week)
7914 ("m" . month) ("y" . year))))))
7915 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7916 (setq nmin 1 nmax n)
7917 (org-back-to-heading t)
7918 (setq beg (point))
7919 (setq idprop (org-entry-get nil "ID"))
7920 (org-end-of-subtree t t)
7922 (setq end (point))
7923 (setq template (buffer-substring beg end))
7924 (when (and doshift
7926 (delete-region beg end)
7927 (setq end beg)
7928 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7929 (goto-char end)
7930 (loop for n from nmin to nmax do
7931 ;; prepare clone
7932 (with-temp-buffer
7933 (insert template)
7934 (org-mode)
7935 (goto-char (point-min))
7936 (org-show-subtree)
7937 (and idprop (if org-clone-delete-id
7938 (org-entry-delete nil "ID")
7939 (org-id-get-create t)))
7940 (unless (= n 0)
7942 (kill-whole-line))
7943 (goto-char (point-min))
7944 (while (re-search-forward drawer-re nil t)
7945 (mapc (lambda (d)
7946 (org-remove-empty-drawer-at d (point))) org-drawers)))
7947 (goto-char (point-min))
7948 (when doshift
7949 (while (re-search-forward org-ts-regexp-both nil t)
7950 (org-timestamp-change (* n shift-n) shift-what))
7951 (unless (= n n-no-remove)
7952 (goto-char (point-min))
7953 (while (re-search-forward org-ts-regexp nil t)
7954 (save-excursion
7955 (goto-char (match-beginning 0))
7957 (delete-region (match-beginning 1) (match-end 1)))))))
7958 (setq task (buffer-string)))
7959 (insert task))
7960 (goto-char beg)))
7962 ;;; Outline Sorting
7964 (defun org-sort (with-case)
7965 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7966 Optional argument WITH-CASE means sort case-sensitively."
7967 (interactive "P")
7968 (cond
7969 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7970 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7971 (t
7972 (org-call-with-arg 'org-sort-entries with-case))))
7974 (defun org-sort-remove-invisible (s)
7975 (remove-text-properties 0 (length s) org-rm-props s)
7976 (while (string-match org-bracket-link-regexp s)
7977 (setq s (replace-match (if (match-end 2)
7978 (match-string 3 s)
7979 (match-string 1 s)) t t s)))
7980 s)
7982 (defvar org-priority-regexp) ; defined later in the file
7984 (defvar org-after-sorting-entries-or-items-hook nil
7985 "Hook that is run after a bunch of entries or items have been sorted.
7986 When children are sorted, the cursor is in the parent line when this
7987 hook gets called. When a region or a plain list is sorted, the cursor
7988 will be in the first entry of the sorted region/list.")
7990 (defun org-sort-entries
7991 (&optional with-case sorting-type getkey-func compare-func property)
7992 "Sort entries on a certain level of an outline tree.
7993 If there is an active region, the entries in the region are sorted.
7994 Else, if the cursor is before the first entry, sort the top-level items.
7995 Else, the children of the entry at point are sorted.
7997 Sorting can be alphabetically, numerically, by date/time as given by
7998 a time stamp, by a property or by priority.
8000 The command prompts for the sorting type unless it has been given to the
8001 function through the SORTING-TYPE argument, which needs to be a character,
8002 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8003 precise meaning of each character:
8005 n Numerically, by converting the beginning of the entry/item to a number.
8006 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8007 t By date/time, either the first active time stamp in the entry, or, if
8008 none exist, by the first inactive one.
8009 s By the scheduled date/time.
8010 d By deadline date/time.
8011 c By creation time, which is assumed to be the first inactive time stamp
8012 at the beginning of a line.
8013 p By priority according to the cookie.
8014 r By the value of a property.
8016 Capital letters will reverse the sort order.
8018 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8019 called with point at the beginning of the record. It must return either
8020 a string or a number that should serve as the sorting key for that record.
8022 Comparing entries ignores case by default. However, with an optional argument
8023 WITH-CASE, the sorting considers case as well."
8024 (interactive "P")
8025 (let ((case-func (if with-case 'identity 'downcase))
8026 start beg end stars re re2
8027 txt what tmp)
8028 ;; Find beginning and end of region to sort
8029 (cond
8030 ((org-region-active-p)
8031 ;; we will sort the region
8032 (setq end (region-end)
8033 what "region")
8034 (goto-char (region-beginning))
8035 (if (not (org-at-heading-p)) (outline-next-heading))
8036 (setq start (point)))
8037 ((or (org-at-heading-p)
8038 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8039 ;; we will sort the children of the current headline
8040 (org-back-to-heading)
8041 (setq start (point)
8042 end (progn (org-end-of-subtree t t)
8044 (org-back-over-empty-lines)
8045 (point))
8046 what "children")
8047 (goto-char start)
8048 (show-subtree)
8049 (outline-next-heading))
8050 (t
8051 ;; we will sort the top-level entries in this file
8052 (goto-char (point-min))
8053 (or (org-at-heading-p) (outline-next-heading))
8054 (setq start (point))
8055 (goto-char (point-max))
8056 (beginning-of-line 1)
8058 ;; File ends in a non-white line
8059 (end-of-line 1)
8061 (setq end (point-max))
8062 (setq what "top-level")
8063 (goto-char start)
8064 (show-all)))
8066 (setq beg (point))
8067 (if (>= beg end) (error "Nothing to sort"))
8070 (setq stars (match-string 1)
8071 re (concat "^" (regexp-quote stars) " +")
8073 txt (buffer-substring beg end))
8075 (if (and (not (equal stars "*")) (string-match re2 txt))
8076 (error "Region to sort contains a level above the first entry"))
8078 (unless sorting-type
8079 (message
8080 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8082 A/N/T/S/D/C/P/O/F means reversed:"
8083 what)
8084 (setq sorting-type (read-char-exclusive))
8086 (and (= (downcase sorting-type) ?f)
8087 (setq getkey-func
8088 (org-icompleting-read "Sort using function: "
8089 obarray 'fboundp t nil nil))
8090 (setq getkey-func (intern getkey-func)))
8092 (and (= (downcase sorting-type) ?r)
8093 (setq property
8094 (org-icompleting-read "Property: "
8095 (mapcar 'list (org-buffer-property-keys t))
8096 nil t))))
8098 (message "Sorting entries...")
8100 (save-restriction
8101 (narrow-to-region start end)
8102 (let ((dcst (downcase sorting-type))
8103 (case-fold-search nil)
8104 (now (current-time)))
8105 (sort-subr
8106 (/= dcst sorting-type)
8107 ;; This function moves to the beginning character of the "record" to
8108 ;; be sorted.
8109 (lambda nil
8110 (if (re-search-forward re nil t)
8111 (goto-char (match-beginning 0))
8112 (goto-char (point-max))))
8113 ;; This function moves to the last character of the "record" being
8114 ;; sorted.
8115 (lambda nil
8116 (save-match-data
8117 (condition-case nil
8118 (outline-forward-same-level 1)
8119 (error
8120 (goto-char (point-max))))))
8121 ;; This function returns the value that gets sorted against.
8122 (lambda nil
8123 (cond
8124 ((= dcst ?n)
8125 (if (looking-at org-complex-heading-regexp)
8126 (string-to-number (match-string 4))
8127 nil))
8128 ((= dcst ?a)
8129 (if (looking-at org-complex-heading-regexp)
8130 (funcall case-func (match-string 4))
8131 nil))
8132 ((= dcst ?t)
8133 (let ((end (save-excursion (outline-next-heading) (point))))
8134 (if (or (re-search-forward org-ts-regexp end t)
8135 (re-search-forward org-ts-regexp-both end t))
8136 (org-time-string-to-seconds (match-string 0))
8137 (org-float-time now))))
8138 ((= dcst ?c)
8139 (let ((end (save-excursion (outline-next-heading) (point))))
8140 (if (re-search-forward
8142 end t)
8143 (org-time-string-to-seconds (match-string 0))
8144 (org-float-time now))))
8145 ((= dcst ?s)
8146 (let ((end (save-excursion (outline-next-heading) (point))))
8147 (if (re-search-forward org-scheduled-time-regexp end t)
8148 (org-time-string-to-seconds (match-string 1))
8149 (org-float-time now))))
8150 ((= dcst ?d)
8151 (let ((end (save-excursion (outline-next-heading) (point))))
8152 (if (re-search-forward org-deadline-time-regexp end t)
8153 (org-time-string-to-seconds (match-string 1))
8154 (org-float-time now))))
8155 ((= dcst ?p)
8156 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8157 (string-to-char (match-string 2))
8158 org-default-priority))
8159 ((= dcst ?r)
8160 (or (org-entry-get nil property) ""))
8161 ((= dcst ?o)
8162 (if (looking-at org-complex-heading-regexp)
8163 (- 9999 (length (member (match-string 2)
8164 org-todo-keywords-1)))))
8165 ((= dcst ?f)
8166 (if getkey-func
8167 (progn
8168 (setq tmp (funcall getkey-func))
8169 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8170 tmp)
8171 (error "Invalid key function `%s'" getkey-func)))
8172 (t (error "Invalid sorting type `%c'" sorting-type))))
8173 nil
8174 (cond
8175 ((= dcst ?a) 'string<)
8176 ((= dcst ?f) compare-func)
8177 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8178 (t nil)))))
8179 (run-hooks 'org-after-sorting-entries-or-items-hook)
8180 (message "Sorting entries...done")))
8182 (defun org-do-sort (table what &optional with-case sorting-type)
8183 "Sort TABLE of WHAT according to SORTING-TYPE.
8184 The user will be prompted for the SORTING-TYPE if the call to this
8185 function does not specify it. WHAT is only for the prompt, to indicate
8186 what is being sorted. The sorting key will be extracted from
8187 the car of the elements of the table.
8188 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8189 (unless sorting-type
8190 (message
8191 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8192 what)
8193 (setq sorting-type (read-char-exclusive)))
8194 (let ((dcst (downcase sorting-type))
8195 extractfun comparefun)
8196 ;; Define the appropriate functions
8197 (cond
8198 ((= dcst ?n)
8199 (setq extractfun 'string-to-number
8200 comparefun (if (= dcst sorting-type) '< '>)))
8201 ((= dcst ?a)
8202 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8203 (lambda(x) (downcase (org-sort-remove-invisible x))))
8204 comparefun (if (= dcst sorting-type)
8205 'string<
8206 (lambda (a b) (and (not (string< a b))
8207 (not (string= a b)))))))
8208 ((= dcst ?t)
8209 (setq extractfun
8210 (lambda (x)
8211 (if (or (string-match org-ts-regexp x)
8212 (string-match org-ts-regexp-both x))
8213 (org-float-time
8214 (org-time-string-to-time (match-string 0 x)))
8215 0))
8216 comparefun (if (= dcst sorting-type) '< '>)))
8217 (t (error "Invalid sorting type `%c'" sorting-type)))
8219 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8220 table)
8221 (lambda (a b) (funcall comparefun (car a) (car b))))))
8224 ;;; The orgstruct minor mode
8226 ;; Define a minor mode which can be used in other modes in order to
8227 ;; integrate the org-mode structure editing commands.
8229 ;; This is really a hack, because the org-mode structure commands use
8230 ;; keys which normally belong to the major mode. Here is how it
8231 ;; works: The minor mode defines all the keys necessary to operate the
8232 ;; structure commands, but wraps the commands into a function which
8233 ;; tests if the cursor is currently at a headline or a plain list
8234 ;; item. If that is the case, the structure command is used,
8235 ;; temporarily setting many Org-mode variables like regular
8236 ;; expressions for filling etc. However, when any of those keys is
8237 ;; used at a different location, function uses `key-binding' to look
8238 ;; up if the key has an associated command in another currently active
8239 ;; keymap (minor modes, major mode, global), and executes that
8240 ;; command. There might be problems if any of the keys is otherwise
8241 ;; used as a prefix key.
8243 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8244 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8245 ;; addresses this by checking explicitly for both bindings.
8247 (defvar orgstruct-mode-map (make-sparse-keymap)
8248 "Keymap for the minor `orgstruct-mode'.")
8250 (defvar org-local-vars nil
8251 "List of local variables, for use by `orgstruct-mode'.")
8253 ;;;###autoload
8254 (define-minor-mode orgstruct-mode
8255 "Toggle the minor mode `orgstruct-mode'.
8256 This mode is for using Org-mode structure commands in other
8257 modes. The following keys behave as if Org-mode were active, if
8258 the cursor is on a headline, or on a plain list item (both as
8259 defined by Org-mode).
8261 M-up Move entry/item up
8262 M-down Move entry/item down
8263 M-left Promote
8264 M-right Demote
8265 M-S-up Move entry/item up
8266 M-S-down Move entry/item down
8267 M-S-left Promote subtree
8268 M-S-right Demote subtree
8269 M-q Fill paragraph and items like in Org-mode
8270 C-c ^ Sort entries
8271 C-c - Cycle list bullet
8272 TAB Cycle item visibility
8273 M-RET Insert new heading/item
8274 S-M-RET Insert new TODO heading / Checkbox item
8275 C-c C-c Set tags / toggle checkbox"
8276 nil " OrgStruct" nil
8277 (org-load-modules-maybe)
8278 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8280 ;;;###autoload
8281 (defun turn-on-orgstruct ()
8282 "Unconditionally turn on `orgstruct-mode'."
8283 (orgstruct-mode 1))
8285 (defun orgstruct++-mode (&optional arg)
8286 "Toggle `orgstruct-mode', the enhanced version of it.
8287 In addition to setting orgstruct-mode, this also exports all indentation
8288 and autofilling variables from org-mode into the buffer. It will also
8289 recognize item context in multiline items.
8290 Note that turning off orgstruct-mode will *not* remove the
8291 indentation/paragraph settings. This can only be done by refreshing the
8293 (interactive "P")
8294 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8295 (if (< arg 1)
8296 (orgstruct-mode -1)
8297 (orgstruct-mode 1)
8298 (let (var val)
8299 (mapc
8300 (lambda (x)
8301 (when (string-match
8303 (symbol-name (car x)))
8304 (setq var (car x) val (nth 1 x))
8305 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8306 org-local-vars)
8307 (org-set-local 'orgstruct-is-++ t))))
8309 (defvar orgstruct-is-++ nil
8310 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8311 (make-variable-buffer-local 'orgstruct-is-++)
8313 ;;;###autoload
8314 (defun turn-on-orgstruct++ ()
8315 "Unconditionally turn on `orgstruct++-mode'."
8316 (orgstruct++-mode 1))
8318 (defun orgstruct-error ()
8319 "Error when there is no default binding for a structure key."
8320 (interactive)
8321 (error "This key has no function outside structure elements"))
8323 (defun orgstruct-setup ()
8324 "Setup orgstruct keymaps."
8325 (let ((nfunc 0)
8326 (bindings
8327 (list
8328 '([(meta up)] org-metaup)
8329 '([(meta down)] org-metadown)
8330 '([(meta left)] org-metaleft)
8331 '([(meta right)] org-metaright)
8332 '([(meta shift up)] org-shiftmetaup)
8333 '([(meta shift down)] org-shiftmetadown)
8334 '([(meta shift left)] org-shiftmetaleft)
8335 '([(meta shift right)] org-shiftmetaright)
8336 '([?\e (up)] org-metaup)
8337 '([?\e (down)] org-metadown)
8338 '([?\e (left)] org-metaleft)
8339 '([?\e (right)] org-metaright)
8340 '([?\e (shift up)] org-shiftmetaup)
8341 '([?\e (shift down)] org-shiftmetadown)
8342 '([?\e (shift left)] org-shiftmetaleft)
8343 '([?\e (shift right)] org-shiftmetaright)
8344 '([(shift up)] org-shiftup)
8345 '([(shift down)] org-shiftdown)
8346 '([(shift left)] org-shiftleft)
8347 '([(shift right)] org-shiftright)
8348 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8349 '("\M-q" fill-paragraph)
8350 '("\C-c^" org-sort)
8351 '("\C-c-" org-cycle-list-bullet)))
8352 elt key fun cmd)
8353 (while (setq elt (pop bindings))
8354 (setq nfunc (1+ nfunc))
8355 (setq key (org-key (car elt))
8356 fun (nth 1 elt)
8357 cmd (orgstruct-make-binding fun nfunc key))
8358 (org-defkey orgstruct-mode-map key cmd))
8360 ;; Special treatment needed for TAB and RET
8361 (org-defkey orgstruct-mode-map [(tab)]
8362 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8363 (org-defkey orgstruct-mode-map "\C-i"
8364 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8366 (org-defkey orgstruct-mode-map "\M-\C-m"
8367 (orgstruct-make-binding 'org-insert-heading 105
8368 "\M-\C-m" [(meta return)]))
8369 (org-defkey orgstruct-mode-map [(meta return)]
8370 (orgstruct-make-binding 'org-insert-heading 106
8371 [(meta return)] "\M-\C-m"))
8373 (org-defkey orgstruct-mode-map [(shift meta return)]
8374 (orgstruct-make-binding 'org-insert-todo-heading 107
8375 [(meta return)] "\M-\C-m"))
8377 (org-defkey orgstruct-mode-map "\e\C-m"
8378 (orgstruct-make-binding 'org-insert-heading 108
8379 "\e\C-m" [?\e (return)]))
8380 (org-defkey orgstruct-mode-map [?\e (return)]
8381 (orgstruct-make-binding 'org-insert-heading 109
8382 [?\e (return)] "\e\C-m"))
8383 (org-defkey orgstruct-mode-map [?\e (shift return)]
8384 (orgstruct-make-binding 'org-insert-todo-heading 110
8385 [?\e (return)] "\e\C-m"))
8387 (unless org-local-vars
8388 (setq org-local-vars (org-get-local-variables)))
8390 t))
8392 (defun orgstruct-make-binding (fun n &rest keys)
8393 "Create a function for binding in the structure minor mode.
8394 FUN is the command to call inside a table. N is used to create a unique
8395 command name. KEYS are keys that should be checked in for a command
8396 to execute outside of tables."
8397 (eval
8398 (list 'defun
8399 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8400 '(arg)
8402 "Outside of structure, run the binding of `"
8403 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8404 "'.")
8405 '(interactive "p")
8406 (list 'if
8407 `(org-context-p 'headline 'item
8408 (and orgstruct-is-++
8409 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8410 'item-body))
8411 (list 'org-run-like-in-org-mode (list 'quote fun))
8412 (list 'let '(orgstruct-mode)
8413 (list 'call-interactively
8414 (append '(or)
8415 (mapcar (lambda (k)
8416 (list 'key-binding k))
8417 keys)
8418 '('orgstruct-error))))))))
8420 (defun org-context-p (&rest contexts)
8421 "Check if local context is any of CONTEXTS.
8422 Possible values in the list of contexts are `table', `headline', and `item'."
8423 (let ((pos (point)))
8424 (goto-char (point-at-bol))
8425 (prog1 (or (and (memq 'table contexts)
8427 (and (memq 'headline contexts)
8428 (looking-at org-outline-regexp))
8429 (and (memq 'item contexts)
8431 (and (memq 'item-body contexts)
8432 (org-in-item-p)))
8433 (goto-char pos))))
8435 (defun org-get-local-variables ()
8436 "Return a list of all local variables in an org-mode buffer."
8437 (let (varlist)
8438 (with-current-buffer (get-buffer-create "*Org tmp*")
8439 (erase-buffer)
8440 (org-mode)
8441 (setq varlist (buffer-local-variables)))
8442 (kill-buffer "*Org tmp*")
8443 (delq nil
8444 (mapcar
8445 (lambda (x)
8446 (setq x
8447 (if (symbolp x)
8448 (list x)
8449 (list (car x) (list 'quote (cdr x)))))
8450 (if (string-match
8451 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8452 (symbol-name (car x)))
8453 x nil))
8454 varlist))))
8456 (defun org-clone-local-variables (from-buffer &optional regexp)
8457 "Clone local variables from FROM-BUFFER.
8458 Optional argument REGEXP selects variables to clone."
8459 (mapc
8460 (lambda (pair)
8461 (and (symbolp (car pair))
8462 (or (null regexp)
8463 (string-match regexp (symbol-name (car pair))))
8464 (set (make-local-variable (car pair))
8465 (cdr pair))))
8466 (buffer-local-variables from-buffer)))
8468 ;;;###autoload
8469 (defun org-run-like-in-org-mode (cmd)
8470 "Run a command, pretending that the current buffer is in Org-mode.
8471 This will temporarily bind local variables that are typically bound in
8472 Org-mode to the values they have in Org-mode, and then interactively
8473 call CMD."
8474 (org-load-modules-maybe)
8475 (unless org-local-vars
8476 (setq org-local-vars (org-get-local-variables)))
8477 (eval (list 'let org-local-vars
8478 (list 'call-interactively (list 'quote cmd)))))
8480 ;;;; Archiving
8482 (defun org-get-category (&optional pos force-refresh)
8483 "Get the category applying to position POS."
8484 (if force-refresh (org-refresh-category-properties))
8485 (let ((pos (or pos (point))))
8486 (or (get-text-property pos 'org-category)
8487 (progn (org-refresh-category-properties)
8488 (get-text-property pos 'org-category)))))
8490 (defun org-refresh-category-properties ()
8491 "Refresh category text properties in the buffer."
8492 (let ((def-cat (cond
8493 ((null org-category)
8494 (if buffer-file-name
8495 (file-name-sans-extension
8496 (file-name-nondirectory buffer-file-name))
8497 "???"))
8498 ((symbolp org-category) (symbol-name org-category))
8499 (t org-category)))
8500 beg end cat pos optionp)
8501 (org-unmodified
8502 (save-excursion
8503 (save-restriction
8504 (widen)
8505 (goto-char (point-min))
8506 (put-text-property (point) (point-max) 'org-category def-cat)
8507 (while (re-search-forward
8509 (setq pos (match-end 0)
8510 optionp (equal (char-after (match-beginning 0)) ?#)
8511 cat (org-trim (match-string 2)))
8512 (if optionp
8513 (setq beg (point-at-bol) end (point-max))
8514 (org-back-to-heading t)
8515 (setq beg (point) end (org-end-of-subtree t t)))
8516 (put-text-property beg end 'org-category cat)
8517 (put-text-property beg end 'org-category-position beg)
8518 (goto-char pos)))))))
8521 ;;;; Link Stuff
8523 ;;; Link abbreviations
8525 (defun org-link-expand-abbrev (link)
8526 "Apply replacements as defined in `org-link-abbrev-alist."
8528 (let* ((key (match-string 1 link))
8529 (as (or (assoc key org-link-abbrev-alist-local)
8530 (assoc key org-link-abbrev-alist)))
8531 (tag (and (match-end 2) (match-string 3 link)))
8532 rpl)
8533 (if (not as)
8534 link
8535 (setq rpl (cdr as))
8536 (cond
8537 ((symbolp rpl) (funcall rpl tag))
8538 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8539 ((string-match "%h" rpl)
8540 (replace-match (url-hexify-string (or tag "")) t t rpl))
8541 (t (concat rpl tag)))))
8542 link))
8544 ;;; Storing and inserting links
8546 (defvar org-insert-link-history nil
8547 "Minibuffer history for links inserted with `org-insert-link'.")
8549 (defvar org-stored-links nil
8550 "Contains the links stored with `org-store-link'.")
8552 (defvar org-store-link-plist nil
8553 "Plist with info about the most recently link created with `org-store-link'.")
8555 (defvar org-link-protocols nil
8556 "Link protocols added to Org-mode using `org-add-link-type'.")
8558 (defvar org-store-link-functions nil
8559 "List of functions that are called to create and store a link.
8560 Each function will be called in turn until one returns a non-nil
8561 value. Each function should check if it is responsible for creating
8562 this link (for example by looking at the major mode).
8563 If not, it must exit and return nil.
8564 If yes, it should return a non-nil value after a calling
8565 `org-store-link-props' with a list of properties and values.
8566 Special properties are:
8570 This is obligatory as well.
8571 :description Optional default description for the second pair
8572 of brackets in an Org-mode link. The user can still change
8573 this when inserting this link into an Org-mode buffer.
8575 In addition to these, any additional properties can be specified
8576 and then used in remember templates.")
8578 (defun org-add-link-type (type &optional follow export)
8579 "Add TYPE to the list of `org-link-types'.
8580 Re-compute all regular expressions depending on `org-link-types'
8582 FOLLOW and EXPORT are two functions.
8584 FOLLOW should take the link path as the single argument and do whatever
8585 is necessary to follow the link, for example find a file or display
8586 a mail message.
8588 EXPORT should format the link path for export to one of the export formats.
8589 It should be a function accepting three arguments:
8592 desc the description of the link, if any, or a description added by
8593 org-export-normalize-links if there is none
8594 format the export format, a symbol like `html' or `latex' or `ascii'..
8596 The function may use the FORMAT information to return different values
8597 depending on the format. The return value will be put literally into
8598 the exported file. If the return value is nil, this means Org should
8599 do what it normally does with links which do not have EXPORT defined.
8601 Org-mode has a built-in default for exporting links. If you are happy with
8602 this default, there is no need to define an export function for the link
8603 type. For a simple example of an export function, see `org-bbdb.el'."
8604 (add-to-list 'org-link-types type t)
8605 (org-make-link-regexps)
8606 (if (assoc type org-link-protocols)
8607 (setcdr (assoc type org-link-protocols) (list follow export))
8608 (push (list type follow export) org-link-protocols)))
8610 (defvar org-agenda-buffer-name)
8612 ;;;###autoload
8613 (defun org-store-link (arg)
8615 This link is added to `org-stored-links' and can later be inserted
8618 For some link types, a prefix arg is interpreted:
8619 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8620 For file links, arg negates `org-context-in-file-links'."
8621 (interactive "P")
8622 (org-load-modules-maybe)
8623 (setq org-store-link-plist nil) ; reset
8624 (org-with-limited-levels
8625 (let (link cpltxt desc description search txt custom-id agenda-link)
8626 (cond
8628 ((run-hook-with-args-until-success 'org-store-link-functions)
8629 (setq link (plist-get org-store-link-plist :link)
8630 desc (or (plist-get org-store-link-plist :description) link)))
8632 ((equal (buffer-name) "*Org Edit Src Example*")
8633 (let (label gc)
8634 (while (or (not label)
8635 (save-excursion
8636 (save-restriction
8637 (widen)
8638 (goto-char (point-min))
8639 (re-search-forward
8640 (regexp-quote (format org-coderef-label-format label))
8641 nil t))))
8642 (when label (message "Label exists already") (sit-for 2))
8643 (setq label (read-string "Code line label: " label)))
8644 (end-of-line 1)
8645 (setq link (format org-coderef-label-format label))
8646 (setq gc (- 79 (length link)))
8647 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8648 (insert link)
8649 (setq link (concat "(" label ")") desc nil)))
8651 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8652 ;; We are in the agenda, link to referenced location
8653 (let ((m (or (get-text-property (point) 'org-hd-marker)
8654 (get-text-property (point) 'org-marker))))
8655 (when m
8656 (org-with-point-at m
8657 (setq agenda-link
8658 (if (org-called-interactively-p 'any)
8659 (call-interactively 'org-store-link)
8660 (org-store-link nil)))))))
8662 ((eq major-mode 'calendar-mode)
8663 (let ((cd (calendar-cursor-to-date)))
8664 (setq link
8665 (format-time-string
8666 (car org-time-stamp-formats)
8667 (apply 'encode-time
8668 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8669 nil nil nil))))
8670 (org-store-link-props :type "calendar" :date cd)))
8672 ((eq major-mode 'w3-mode)
8673 (setq cpltxt (if (and (buffer-name)
8674 (not (string-match "Untitled" (buffer-name))))
8675 (buffer-name)
8676 (url-view-url t))
8677 link (org-make-link (url-view-url t)))
8678 (org-store-link-props :type "w3" :url (url-view-url t)))
8680 ((eq major-mode 'w3m-mode)
8681 (setq cpltxt (or w3m-current-title w3m-current-url)
8682 link (org-make-link w3m-current-url))
8683 (org-store-link-props :type "w3m" :url (url-view-url t)))
8685 ((setq search (run-hook-with-args-until-success
8686 'org-create-file-search-functions))
8687 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8688 "::" search))
8689 (setq cpltxt (or description link)))
8691 ((eq major-mode 'image-mode)
8692 (setq cpltxt (concat "file:"
8693 (abbreviate-file-name buffer-file-name))
8694 link (org-make-link cpltxt))
8695 (org-store-link-props :type "image" :file buffer-file-name))
8697 ((eq major-mode 'dired-mode)
8698 ;; link to the file in the current line
8699 (let ((file (dired-get-filename nil t)))
8700 (setq file (if file
8701 (abbreviate-file-name
8702 (expand-file-name (dired-get-filename nil t)))
8703 ;; otherwise, no file so use current directory.
8704 default-directory))
8705 (setq cpltxt (concat "file:" file)
8706 link (org-make-link cpltxt))))
8708 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8709 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8710 (cond
8712 (setq cpltxt
8713 (concat "file:"
8714 (abbreviate-file-name
8715 (buffer-file-name (buffer-base-buffer)))
8716 "::" (match-string 1))
8717 link (org-make-link cpltxt)))
8718 ((and (featurep 'org-id)
8719 (or (eq org-link-to-org-use-id t)
8720 (and (eq org-link-to-org-use-id 'create-if-interactive)
8721 (org-called-interactively-p 'any))
8722 (and (eq org-link-to-org-use-id
8723 'create-if-interactive-and-no-custom-id)
8724 (org-called-interactively-p 'any)
8725 (not custom-id))
8726 (and org-link-to-org-use-id
8727 (org-entry-get nil "ID"))))
8728 ;; We can make a link using the ID.
8729 (setq link (condition-case nil
8730 (prog1 (org-id-store-link)
8731 (setq desc (plist-get org-store-link-plist
8732 :description)))
8733 (error
8734 ;; probably before first headline, link to file only
8735 (concat "file:"
8736 (abbreviate-file-name
8737 (buffer-file-name (buffer-base-buffer))))))))
8738 (t
8739 ;; Just link to current headline
8740 (setq cpltxt (concat "file:"
8741 (abbreviate-file-name
8742 (buffer-file-name (buffer-base-buffer)))))
8743 ;; Add a context search string
8744 (when (org-xor org-context-in-file-links arg)
8745 (setq txt (cond
8746 ((org-at-heading-p) nil)
8747 ((org-region-active-p)
8748 (buffer-substring (region-beginning) (region-end)))
8749 (t nil)))
8751 (setq cpltxt
8752 (concat cpltxt "::"
8753 (condition-case nil
8754 (org-make-org-heading-search-string txt)
8755 (error "")))
8756 desc (or (nth 4 (ignore-errors
8757 (org-heading-components))) "NONE"))))
8759 (setq cpltxt (substring cpltxt 0 -2)))
8760 (setq link (org-make-link cpltxt)))))
8762 ((buffer-file-name (buffer-base-buffer))
8763 ;; Just link to this file here.
8764 (setq cpltxt (concat "file:"
8765 (abbreviate-file-name
8766 (buffer-file-name (buffer-base-buffer)))))
8767 ;; Add a context string
8768 (when (org-xor org-context-in-file-links arg)
8769 (setq txt (if (org-region-active-p)
8770 (buffer-substring (region-beginning) (region-end))
8771 (buffer-substring (point-at-bol) (point-at-eol))))
8772 ;; Only use search option if there is some text.
8774 (setq cpltxt
8775 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8776 desc "NONE")))
8777 (setq link (org-make-link cpltxt)))
8779 ((org-called-interactively-p 'interactive)
8780 (error "Cannot link to a buffer which is not visiting a file"))
8782 (t (setq link nil)))
8784 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8785 (setq link (or link cpltxt)
8786 desc (or desc cpltxt))
8787 (if (equal desc "NONE") (setq desc nil))
8789 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8790 (progn
8791 (setq org-stored-links
8792 (cons (list link desc) org-stored-links))
8793 (message "Stored: %s" (or desc link))
8794 (when custom-id
8795 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8796 "::#" custom-id))
8797 (setq org-stored-links
8798 (cons (list link desc) org-stored-links))))
8799 (or agenda-link (and link (org-make-link-string link desc)))))))
8801 (defun org-store-link-props (&rest plist)
8802 "Store link properties, extract names and addresses."
8803 (let (x adr)
8804 (when (setq x (plist-get plist :from))
8805 (setq adr (mail-extract-address-components x))
8806 (setq plist (plist-put plist :fromname (car adr)))
8807 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8808 (when (setq x (plist-get plist :to))
8809 (setq adr (mail-extract-address-components x))
8810 (setq plist (plist-put plist :toname (car adr)))
8811 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8812 (let ((from (plist-get plist :from))
8813 (to (plist-get plist :to)))
8814 (when (and from to org-from-is-user-regexp)
8815 (setq plist
8816 (plist-put plist :fromto
8817 (if (string-match org-from-is-user-regexp from)
8818 (concat "to %t")
8819 (concat "from %f"))))))
8820 (setq org-store-link-plist plist))
8822 (defun org-add-link-props (&rest plist)
8823 "Add these properties to the link property list."
8824 (let (key value)
8825 (while plist
8826 (setq key (pop plist) value (pop plist))
8827 (setq org-store-link-plist
8828 (plist-put org-store-link-plist key value)))))
8830 (defun org-email-link-description (&optional fmt)
8831 "Return the description part of an email link.
8832 This takes information from `org-store-link-plist' and formats it
8833 according to FMT (default from `org-email-link-description-format')."
8834 (setq fmt (or fmt org-email-link-description-format))
8835 (let* ((p org-store-link-plist)
8836 (to (plist-get p :toaddress))
8837 (from (plist-get p :fromaddress))
8838 (table
8839 (list
8840 (cons "%c" (plist-get p :fromto))
8841 (cons "%F" (plist-get p :from))
8842 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8843 (cons "%T" (plist-get p :to))
8844 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8845 (cons "%s" (plist-get p :subject))
8846 (cons "%d" (plist-get p :date))
8847 (cons "%m" (plist-get p :message-id)))))
8848 (when (string-match "%c" fmt)
8849 ;; Check if the user wrote this message
8850 (if (and org-from-is-user-regexp from to
8851 (save-match-data (string-match org-from-is-user-regexp from)))
8852 (setq fmt (replace-match "to %t" t t fmt))
8853 (setq fmt (replace-match "from %f" t t fmt))))
8854 (org-replace-escapes fmt table)))
8856 (defun org-make-org-heading-search-string (&optional string heading)
8857 "Make search string for STRING or current headline."
8858 (interactive)
8859 (let ((s (or string (org-get-heading)))
8860 (lines org-context-in-file-links))
8861 (unless (and string (not heading))
8862 ;; We are using a headline, clean up garbage in there.
8863 (if (string-match org-todo-regexp s)
8864 (setq s (replace-match "" t t s)))
8866 (setq s (replace-match "" t t s)))
8867 (setq s (org-trim s))
8870 (setq s (replace-match "" t t s)))
8871 (while (string-match org-ts-regexp s)
8872 (setq s (replace-match "" t t s))))
8873 (or string (setq s (concat "*" s))) ; Add * for headlines
8874 (when (and string (integerp lines) (> lines 0))
8876 (when (< lines (length slines))
8877 (setq s (mapconcat
8878 'identity
8879 (reverse (nthcdr (- (length slines) lines)
8883 (defun org-make-link (&rest strings)
8884 "Concatenate STRINGS."
8885 (apply 'concat strings))
8887 (defun org-make-link-string (link &optional description)
8888 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8890 (error "Empty link"))
8891 (when (and description
8892 (stringp description)
8894 (setq description nil))
8895 (when (stringp description)
8896 ;; Remove brackets from the description, they are fatal.
8898 (setq description (replace-match "{" t t description)))
8900 (setq description (replace-match "}" t t description))))
8901 (when (equal link description)
8902 ;; No description needed, it is identical
8903 (setq description nil))
8904 (when (and (not description)
8905 (not (string-match (org-image-file-name-regexp) link))
8906 (not (equal link (org-link-escape link))))
8907 (setq description (org-extract-attributes link)))
8908 (setq link
8909 (cond ((string-match (org-image-file-name-regexp) link) link)
8910 ((string-match org-link-types-re link)
8911 (concat (match-string 1 link)
8912 (org-link-escape (substring link (match-end 1)))))
8913 (t (org-link-escape link))))
8914 (concat "[[" link "]"
8915 (if description (concat "[" description "]") "")
8916 "]"))
8918 (defconst org-link-escape-chars
8919 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8920 "List of characters that should be escaped in link.
8921 This is the list that is used for internal purposes.")
8923 (defvar org-url-encoding-use-url-hexify nil)
8925 (defconst org-link-escape-chars-browser
8926 '(?\ )
8927 "List of escapes for characters that are problematic in links.
8928 This is the list that is used before handing over to the browser.")
8930 (defun org-link-escape (text &optional table merge)
8931 "Return percent escaped representation of TEXT.
8932 TEXT is a string with the text to escape.
8933 Optional argument TABLE is a list with characters that should be
8934 escaped. When nil, `org-link-escape-chars' is used.
8935 If optional argument MERGE is set, merge TABLE into
8936 `org-link-escape-chars'."
8937 (if (and org-url-encoding-use-url-hexify (not table))
8938 (url-hexify-string text)
8939 (cond
8940 ((and table merge)
8941 (mapc (lambda (defchr)
8942 (unless (member defchr table)
8943 (setq table (cons defchr table)))) org-link-escape-chars))
8944 ((null table)
8945 (setq table org-link-escape-chars)))
8946 (mapconcat
8947 (lambda (char)
8948 (if (or (member char table)
8949 (< char 32) (= char 37) (> char 126))
8950 (mapconcat (lambda (sequence-element)
8951 (format "%%%.2X" sequence-element))
8952 (or (encode-coding-char char 'utf-8)
8953 (error "Unable to percent escape character: %s"
8954 (char-to-string char))) "")
8955 (char-to-string char))) text "")))
8957 (defun org-link-unescape (str)
8958 "Unhex hexified Unicode strings as returned from the JavaScript function
8959 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8960 (unless (and (null str) (string= "" str))
8961 (let ((pos 0) (case-fold-search t) unhexed)
8963 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8964 (setq str (replace-match unhexed t t str))
8965 (setq pos (+ pos (length unhexed))))))
8966 str)
8968 (defun org-link-unescape-compound (hex)
8969 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8970 Note: this function also decodes single byte encodings like
8972 (save-match-data
8973 (let* ((bytes (cdr (split-string hex "%")))
8974 (ret "")
8975 (eat 0)
8976 (sum 0))
8977 (while bytes
8978 (let* ((val (string-to-number (pop bytes) 16))
8979 (shift-xor
8980 (if (= 0 eat)
8981 (cond
8982 ((>= val 252) (cons 6 252))
8983 ((>= val 248) (cons 5 248))
8984 ((>= val 240) (cons 4 240))
8985 ((>= val 224) (cons 3 224))
8986 ((>= val 192) (cons 2 192))
8987 (t (cons 0 0)))
8988 (cons 6 128))))
8989 (if (>= val 192) (setq eat (car shift-xor)))
8990 (setq val (logxor val (cdr shift-xor)))
8991 (setq sum (+ (lsh sum (car shift-xor)) val))
8992 (if (> eat 0) (setq eat (- eat 1)))
8993 (cond
8994 ((= 0 eat) ;multi byte
8995 (setq ret (concat ret (org-char-to-string sum)))
8996 (setq sum 0))
8997 ((not bytes) ; single byte(s)
8998 (setq ret (org-link-unescape-single-byte-sequence hex))))
8999 )) ;; end (while bytes
9000 ret )))
9002 (defun org-link-unescape-single-byte-sequence (hex)
9003 "Unhexify hex-encoded single byte character sequences."
9004 (mapconcat (lambda (byte)
9005 (char-to-string (string-to-number byte 16)))
9006 (cdr (split-string hex "%")) ""))
9008 (defun org-xor (a b)
9009 "Exclusive or."
9010 (if a (not b) b))
9012 (defun org-fixup-message-id-for-http (s)
9013 "Replace special characters in a message id, so it can be used in an http query."
9014 (when (string-match "%" s)
9015 (setq s (mapconcat (lambda (c)
9016 (if (eq c ?%)
9017 "%25"
9018 (char-to-string c)))
9019 s "")))
9020 (while (string-match "<" s)
9021 (setq s (replace-match "%3C" t t s)))
9022 (while (string-match ">" s)
9023 (setq s (replace-match "%3E" t t s)))
9024 (while (string-match "@" s)
9025 (setq s (replace-match "%40" t t s)))
9026 s)
9028 ;;;###autoload
9029 (defun org-insert-link-global ()
9030 "Insert a link like Org-mode does.
9031 This command can be called in any mode to insert a link in Org-mode syntax."
9032 (interactive)
9033 (org-load-modules-maybe)
9034 (org-run-like-in-org-mode 'org-insert-link))
9036 (defun org-insert-link (&optional complete-file link-location default-description)
9037 "Insert a link. At the prompt, enter the link.
9039 Completion can be used to insert any of the link protocol prefixes like
9040 http or ftp in use.
9042 The history can be used to select a link previously stored with
9043 `org-store-link'. When the empty string is entered (i.e. if you just
9044 press RET at the prompt), the link defaults to the most recently
9045 stored link. As SPC triggers completion in the minibuffer, you need to
9046 use M-SPC or C-q SPC to force the insertion of a space character.
9048 You will also be prompted for a description, and if one is given, it will
9049 be displayed in the buffer instead of the link.
9051 If there is already a link at point, this command will allow you to edit link
9052 and description parts.
9055 be selected using completion. The path to the file will be relative to the
9056 current directory if the file is in the current directory or a subdirectory.
9057 Otherwise, the link will be the absolute path as completed in the minibuffer
9058 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9059 option `org-link-file-path-type'.
9062 the current directory or below.
9065 `org-keep-stored-link-after-insertion'.
9067 If `org-make-link-description-function' is non-nil, this function will be
9068 called with the link target, and the result will be the default
9069 link description.
9071 If the LINK-LOCATION parameter is non-nil, this value will be
9072 used as the link location instead of reading one interactively.
9074 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9075 be used as the default description."
9076 (interactive "P")
9077 (let* ((wcf (current-window-configuration))
9078 (region (if (org-region-active-p)
9079 (buffer-substring (region-beginning) (region-end))))
9080 (remove (and region (list (region-beginning) (region-end))))
9081 (desc region)
9082 tmphist ; byte-compile incorrectly complains about this
9083 (link link-location)
9084 entry file all-prefixes)
9085 (cond
9086 (link-location) ; specified by arg, just use it.
9087 ((org-in-regexp org-bracket-link-regexp 1)
9088 ;; We do have a link at point, and we are going to edit it.
9089 (setq remove (list (match-beginning 0) (match-end 0)))
9090 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9091 (setq link (read-string "Link: "
9092 (org-link-unescape
9093 (org-match-string-no-properties 1)))))
9094 ((or (org-in-regexp org-angle-link-re)
9095 (org-in-regexp org-plain-link-re))
9096 ;; Convert to bracket link
9097 (setq remove (list (match-beginning 0) (match-end 0))
9098 link (read-string "Link: "
9099 (org-remove-angle-brackets (match-string 0)))))
9100 ((member complete-file '((4) (16)))
9101 ;; Completing read for file names.
9102 (setq link (org-file-complete-link complete-file)))
9103 (t
9104 ;; Read link, with completion for stored links.
9105 (with-output-to-temp-buffer "*Org Links*"
9106 (princ "Insert a link.
9108 (when org-stored-links
9110 (princ (mapconcat
9111 (lambda (x)
9112 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9114 (let ((cw (selected-window)))
9115 (select-window (get-buffer-window "*Org Links*" 'visible))
9116 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9117 (unless (pos-visible-in-window-p (point-max))
9118 (org-fit-window-to-buffer))
9119 (and (window-live-p cw) (select-window cw)))
9120 ;; Fake a link history, containing the stored links.
9121 (setq tmphist (append (mapcar 'car org-stored-links)
9122 org-insert-link-history))
9123 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9124 (mapcar 'car org-link-abbrev-alist)
9125 org-link-types))
9126 (unwind-protect
9127 (progn
9128 (setq link
9129 (let ((org-completion-use-ido nil)
9130 (org-completion-use-iswitchb nil))
9131 (org-completing-read
9132 "Link: "
9133 (append
9134 (mapcar (lambda (x) (list (concat x ":")))
9135 all-prefixes)
9136 (mapcar 'car org-stored-links))
9137 nil nil nil
9138 'tmphist
9139 (car (car org-stored-links)))))
9141 (error "No link selected"))
9142 (if (or (member link all-prefixes)
9143 (and (equal ":" (substring link -1))
9144 (member (substring link 0 -1) all-prefixes)
9145 (setq link (substring link 0 -1))))
9146 (setq link (org-link-try-special-completion link))))
9147 (set-window-configuration wcf)
9148 (kill-buffer "*Org Links*"))
9149 (setq entry (assoc link org-stored-links))
9150 (or entry (push link org-insert-link-history))
9151 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9152 (not org-keep-stored-link-after-insertion))
9153 (setq org-stored-links (delq (assoc link org-stored-links)
9154 org-stored-links)))
9155 (setq desc (or desc (nth 1 entry)))))
9157 (if (string-match org-plain-link-re link)
9158 ;; URL-like link, normalize the use of angular brackets.
9159 (setq link (org-make-link (org-remove-angle-brackets link))))
9161 ;; Check if we are linking to the current file with a search option
9162 ;; If yes, simplify the link by using only the search option.
9163 (when (and buffer-file-name
9165 (let* ((path (match-string 1 link))
9166 (case-fold-search nil)
9167 (search (match-string 2 link)))
9168 (save-match-data
9169 (if (equal (file-truename buffer-file-name) (file-truename path))
9170 ;; We are linking to this same file, with a search option
9171 (setq link search)))))
9173 ;; Check if we can/should use a relative path. If yes, simplify the link
9175 (let* ((type (match-string 1 link))
9176 (path (match-string 2 link))
9177 (origpath path)
9178 (case-fold-search nil))
9179 (cond
9180 ((or (eq org-link-file-path-type 'absolute)
9181 (equal complete-file '(16)))
9182 (setq path (abbreviate-file-name (expand-file-name path))))
9183 ((eq org-link-file-path-type 'noabbrev)
9184 (setq path (expand-file-name path)))
9185 ((eq org-link-file-path-type 'relative)
9186 (setq path (file-relative-name path)))
9187 (t
9188 (save-match-data
9189 (if (string-match (concat "^" (regexp-quote
9190 (expand-file-name
9191 (file-name-as-directory
9192 default-directory))))
9193 (expand-file-name path))
9194 ;; We are linking a file with relative path name.
9195 (setq path (substring (expand-file-name path)
9196 (match-end 0)))
9197 (setq path (abbreviate-file-name (expand-file-name path)))))))
9198 (setq link (concat type path))
9199 (if (equal desc origpath)
9200 (setq desc path))))
9202 (if org-make-link-description-function
9203 (setq desc (funcall org-make-link-description-function link desc))
9204 (if default-description (setq desc default-description)))
9206 (setq desc (read-string "Description: " desc))
9208 (if remove (apply 'delete-region remove))
9209 (insert (org-make-link-string link desc))))
9211 (defun org-link-try-special-completion (type)
9212 "If there is completion support for link type TYPE, offer it."
9213 (let ((fun (intern (concat "org-" type "-complete-link"))))
9214 (if (functionp fun)
9215 (funcall fun)
9216 (read-string "Link (no completion support): " (concat type ":")))))
9218 (defun org-file-complete-link (&optional arg)
9219 "Create a file link using completion."
9220 (let (file link)
9221 (setq file (read-file-name "File: "))
9222 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9223 (pwd1 (file-name-as-directory (abbreviate-file-name
9224 (expand-file-name ".")))))
9225 (cond
9226 ((equal arg '(16))
9227 (setq link (org-make-link
9228 "file:"
9229 (abbreviate-file-name (expand-file-name file)))))
9231 (setq link (org-make-link "file:" (match-string 1 file))))
9233 (expand-file-name file))
9234 (setq link (org-make-link
9235 "file:" (match-string 1 (expand-file-name file)))))
9236 (t (setq link (org-make-link "file:" file)))))
9237 link))
9239 (defun org-completing-read (&rest args)
9240 "Completing-read with SPACE being a normal character."
9241 (let ((enable-recursive-minibuffers t)
9242 (minibuffer-local-completion-map
9243 (copy-keymap minibuffer-local-completion-map)))
9244 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9245 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9246 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9247 (apply 'org-icompleting-read args)))
9249 (defun org-completing-read-no-i (&rest args)
9250 (let (org-completion-use-ido org-completion-use-iswitchb)
9251 (apply 'org-completing-read args)))
9253 (defun org-iswitchb-completing-read (prompt choices &rest args)
9254 "Use iswitch as a completing-read replacement to choose from choices.
9255 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9256 from."
9257 (let* ((iswitchb-use-virtual-buffers nil)
9258 (iswitchb-make-buflist-hook
9259 (lambda ()
9260 (setq iswitchb-temp-buflist choices))))
9261 (iswitchb-read-buffer prompt)))
9263 (defun org-icompleting-read (&rest args)
9264 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9265 (org-without-partial-completion
9266 (if (and org-completion-use-ido
9267 (fboundp 'ido-completing-read)
9268 (boundp 'ido-mode) ido-mode
9269 (listp (second args)))
9270 (let ((ido-enter-matching-directory nil))
9271 (apply 'ido-completing-read (concat (car args))
9272 (if (consp (car (nth 1 args)))
9273 (mapcar 'car (nth 1 args))
9274 (nth 1 args))
9275 (cddr args)))
9276 (if (and org-completion-use-iswitchb
9277 (boundp 'iswitchb-mode) iswitchb-mode
9278 (listp (second args)))
9279 (apply 'org-iswitchb-completing-read (concat (car args))
9280 (if (consp (car (nth 1 args)))
9281 (mapcar 'car (nth 1 args))
9282 (nth 1 args))
9283 (cddr args))
9284 (apply 'completing-read args)))))
9286 (defun org-extract-attributes (s)
9287 "Extract the attributes cookie from a string and set as text property."
9288 (let (a attr (start 0) key value)
9289 (save-match-data
9291 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9293 (setq key (match-string 1 a) value (match-string 2 a)
9294 start (match-end 0)
9295 attr (plist-put attr (intern key) value))))
9296 (org-add-props s nil 'org-attr attr))
9297 s))
9299 (defun org-extract-attributes-from-string (tag)
9300 (let (key value attr)
9302 (setq key (match-string 1 tag) value (match-string 2 tag)
9303 tag (replace-match "" t t tag)
9304 attr (plist-put attr (intern key) value)))
9305 (cons tag attr)))
9307 (defun org-attributes-to-string (plist)
9308 "Format a property list into an HTML attribute list."
9309 (let ((s "") key value)
9310 (while plist
9311 (setq key (pop plist) value (pop plist))
9312 (and value
9314 s))
9316 ;;; Opening/following a link
9318 (defvar org-link-search-failed nil)
9320 (defvar org-open-link-functions nil
9321 "Hook for functions finding a plain text link.
9322 These functions must take a single argument, the link content.
9323 They will be called for links that look like [[link text][description]]
9327 These functions will be called *before* Org attempts to resolve the
9328 link by doing text searches in the current buffer - so if you want a
9330 handle this as a special case.
9332 When the function does handle the link, it must return a non-nil value.
9333 If it decides that it is not responsible for this link, it must return
9334 nil to indicate that that Org-mode can continue with other options
9335 like exact and fuzzy text search.")
9337 (defun org-next-link ()
9338 "Move forward to the next link.
9339 If the link is in hidden text, expose it."
9340 (interactive)
9341 (when (and org-link-search-failed (eq this-command last-command))
9342 (goto-char (point-min))
9343 (message "Link search wrapped back to beginning of buffer"))
9344 (setq org-link-search-failed nil)
9345 (let* ((pos (point))
9346 (ct (org-context))
9347 (a (assoc :link ct)))
9348 (if a (goto-char (nth 2 a)))
9349 (if (re-search-forward org-any-link-re nil t)
9350 (progn
9351 (goto-char (match-beginning 0))
9352 (if (outline-invisible-p) (org-show-context)))
9353 (goto-char pos)
9354 (setq org-link-search-failed t)
9355 (error "No further link found"))))
9357 (defun org-previous-link ()
9358 "Move backward to the previous link.
9359 If the link is in hidden text, expose it."
9360 (interactive)
9361 (when (and org-link-search-failed (eq this-command last-command))
9362 (goto-char (point-max))
9363 (message "Link search wrapped back to end of buffer"))
9364 (setq org-link-search-failed nil)
9365 (let* ((pos (point))
9366 (ct (org-context))
9367 (a (assoc :link ct)))
9368 (if a (goto-char (nth 1 a)))
9369 (if (re-search-backward org-any-link-re nil t)
9370 (progn
9371 (goto-char (match-beginning 0))
9372 (if (outline-invisible-p) (org-show-context)))
9373 (goto-char pos)
9374 (setq org-link-search-failed t)
9375 (error "No further link found"))))
9377 (defun org-translate-link (s)
9378 "Translate a link string if a translation function has been defined."
9379 (if (and org-link-translation-function
9380 (fboundp org-link-translation-function)
9382 (progn
9383 (setq s (funcall org-link-translation-function
9384 (match-string 1) (match-string 2)))
9385 (concat (car s) ":" (cdr s)))
9386 s))
9388 (defun org-translate-link-from-planner (type path)
9389 "Translate a link from Emacs Planner syntax so that Org can follow it.
9390 This is still an experimental function, your mileage may vary."
9391 (cond
9392 ((member type '("http" "https" "news" "ftp"))
9393 ;; standard Internet links are the same.
9394 nil)
9395 ((and (equal type "irc") (string-match "^//" path))
9396 ;; Planner has two / at the beginning of an irc link, we have 1.
9397 ;; We should have zero, actually....
9398 (setq path (substring path 1)))
9399 ((and (equal type "lisp") (string-match "^/" path))
9400 ;; Planner has a slash, we do not.
9401 (setq type "elisp" path (substring path 1)))
9403 ;; A typical message link. Planner has the id after the final slash,
9404 ;; we separate it with a hash mark
9405 (setq path (concat (match-string 1 path) "#"
9406 (org-remove-angle-brackets (match-string 2 path)))))
9407 )
9408 (cons type path))
9410 (defun org-find-file-at-mouse (ev)
9411 "Open file link or URL at mouse."
9412 (interactive "e")
9413 (mouse-set-point ev)
9414 (org-open-at-point 'in-emacs))
9416 (defun org-open-at-mouse (ev)
9417 "Open file link or URL at mouse.
9418 See the docstring of `org-open-file' for details."
9419 (interactive "e")
9420 (mouse-set-point ev)
9421 (if (eq major-mode 'org-agenda-mode)
9422 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9423 (org-open-at-point))
9425 (defvar org-window-config-before-follow-link nil
9426 "The window configuration before following a link.
9427 This is saved in case the need arises to restore it.")
9429 (defvar org-open-link-marker (make-marker)
9430 "Marker pointing to the location where `org-open-at-point; was called.")
9432 ;;;###autoload
9433 (defun org-open-at-point-global ()
9434 "Follow a link like Org-mode does.
9435 This command can be called in any mode to follow a link that has
9436 Org-mode syntax."
9437 (interactive)
9438 (org-run-like-in-org-mode 'org-open-at-point))
9440 ;;;###autoload
9441 (defun org-open-link-from-string (s &optional arg reference-buffer)
9442 "Open a link in the string S, as if it was in Org-mode."
9444 (let ((reference-buffer (or reference-buffer (current-buffer))))
9445 (with-temp-buffer
9446 (let ((org-inhibit-startup t))
9447 (org-mode)
9448 (insert s)
9449 (goto-char (point-min))
9450 (when reference-buffer
9451 (setq org-link-abbrev-alist-local
9452 (with-current-buffer reference-buffer
9453 org-link-abbrev-alist-local)))
9454 (org-open-at-point arg reference-buffer)))))
9456 (defvar org-open-at-point-functions nil
9457 "Hook that is run when following a link at point.
9459 Functions in this hook must return t if they identify and follow
9460 a link at point. If they don't find anything interesting at point,
9461 they must return nil.")
9463 (defun org-open-at-point (&optional arg reference-buffer)
9464 "Open link at or after point.
9465 If there is no link at point, this function will search forward up to
9466 the end of the current line.
9467 Normally, files will be opened by an appropriate application. If the
9468 optional prefix argument ARG is non-nil, Emacs will visit the file.
9469 With a double prefix argument, try to open outside of Emacs, in the
9470 application the system uses for this file type."
9471 (interactive "P")
9472 ;; if in a code block, then open the block's results
9473 (unless (call-interactively #'org-babel-open-src-block-result)
9474 (org-load-modules-maybe)
9475 (move-marker org-open-link-marker (point))
9476 (setq org-window-config-before-follow-link (current-window-configuration))
9477 (org-remove-occur-highlights nil nil t)
9478 (cond
9479 ((and (org-at-heading-p)
9480 (not (org-in-regexp
9485 (not (get-text-property (point) 'org-linked-text)))
9486 (or (org-offer-links-in-entry arg)
9487 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9488 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9489 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9490 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9491 (not (org-in-regexp org-bracket-link-regexp)))
9492 (org-footnote-action))
9493 (t
9494 (let (type path link line search (pos (point)))
9495 (catch 'match
9496 (save-excursion
9498 (when (org-in-regexp org-bracket-link-regexp 1)
9499 (setq link (org-extract-attributes
9500 (org-link-unescape (org-match-string-no-properties 1))))
9502 (setq link (replace-match " " t t link)))
9503 (setq link (org-link-expand-abbrev link))
9504 (cond
9505 ((or (file-name-absolute-p link)
9507 (setq type "file" path link))
9508 ((string-match org-link-re-with-space3 link)
9509 (setq type (match-string 1 link) path (match-string 2 link)))
9510 (t (setq type "thisfile" path link)))
9511 (throw 'match t)))
9513 (when (get-text-property (point) 'org-linked-text)
9514 (setq type "thisfile"
9515 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9516 (1+ (point)) (point))
9517 path (buffer-substring
9518 (or (previous-single-property-change pos 'org-linked-text)
9519 (point-min))
9520 (or (next-single-property-change pos 'org-linked-text)
9521 (point-max))))
9522 (throw 'match t))
9524 (save-excursion
9525 (when (or (org-in-regexp org-angle-link-re)
9526 (org-in-regexp org-plain-link-re))
9527 (setq type (match-string 1)
9528 path (org-link-unescape (match-string 2)))
9529 (throw 'match t)))
9530 (save-excursion
9532 (setq type "tags"
9533 path (match-string 1))
9534 (while (string-match ":" path)
9535 (setq path (replace-match "+" t t path)))
9536 (throw 'match t)))
9538 (setq type "tree-match"
9539 path (match-string 1))
9540 (throw 'match t)))
9541 (unless path
9542 (error "No link found"))
9544 ;; switch back to reference buffer
9545 ;; needed when if called in a temporary buffer through
9546 ;; org-open-link-from-string
9547 (with-current-buffer (or reference-buffer (current-buffer))
9549 ;; Remove any trailing spaces in path
9551 (setq path (replace-match "" t t path)))
9552 (if (and org-link-translation-function
9553 (fboundp org-link-translation-function))
9554 ;; Check if we need to translate the link
9555 (let ((tmp (funcall org-link-translation-function type path)))
9556 (setq type (car tmp) path (cdr tmp))))
9558 (cond
9560 ((assoc type org-link-protocols)
9561 (funcall (nth 1 (assoc type org-link-protocols)) path))
9563 ((equal type "mailto")
9564 (let ((cmd (car org-link-mailto-program))
9565 (args (cdr org-link-mailto-program)) args1
9566 (address path) (subject "") a)
9568 (setq address (match-string 1 path)
9569 subject (org-link-escape (match-string 2 path))))
9570 (while args
9571 (cond
9572 ((not (stringp (car args))) (push (pop args) args1))
9573 (t (setq a (pop args))
9574 (if (string-match "%a" a)
9575 (setq a (replace-match address t t a)))
9576 (if (string-match "%s" a)
9577 (setq a (replace-match subject t t a)))
9578 (push a args1))))
9579 (apply cmd (nreverse args1))))
9581 ((member type '("http" "https" "ftp" "news"))
9582 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9583 (org-link-escape
9584 path org-link-escape-chars-browser)
9585 path))))
9587 ((string= type "doi")
9588 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9589 (org-link-escape
9590 path org-link-escape-chars-browser)
9591 path))))
9593 ((member type '("message"))
9594 (browse-url (concat type ":" path)))
9596 ((string= type "tags")
9597 (org-tags-view arg path))
9599 ((string= type "tree-match")
9602 ((string= type "file")
9604 (setq line (string-to-number (match-string 1 path))
9605 path (substring path 0 (match-beginning 0)))
9607 (setq search (match-string 1 path)
9608 path (substring path 0 (match-beginning 0)))))
9609 (if (string-match "[*?{]" (file-name-nondirectory path))
9610 (dired path)
9611 (org-open-file path arg line search)))
9613 ((string= type "shell")
9614 (let ((cmd path))
9615 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9616 (string-match org-confirm-shell-link-not-regexp cmd))
9617 (not org-confirm-shell-link-function)
9618 (funcall org-confirm-shell-link-function
9620 (org-add-props cmd nil
9621 'face 'org-warning))))
9622 (progn
9623 (message "Executing %s" cmd)
9624 (shell-command cmd))
9625 (error "Abort"))))
9627 ((string= type "elisp")
9628 (let ((cmd path))
9629 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9630 (string-match org-confirm-elisp-link-not-regexp cmd))
9631 (not org-confirm-elisp-link-function)
9632 (funcall org-confirm-elisp-link-function
9634 (org-add-props cmd nil
9635 'face 'org-warning))))
9636 (message "%s => %s" cmd
9637 (if (equal (string-to-char cmd) ?\()
9638 (eval (read cmd))
9639 (call-interactively (read cmd))))
9640 (error "Abort"))))
9642 ((and (string= type "thisfile")
9643 (run-hook-with-args-until-success
9644 'org-open-link-functions path)))
9646 ((string= type "thisfile")
9647 (if arg
9648 (switch-to-buffer-other-window
9649 (org-get-buffer-for-internal-link (current-buffer)))
9650 (org-mark-ring-push))
9651 (let ((cmd `(org-link-search
9652 ,path
9653 ,(cond ((equal arg '(4)) ''occur)
9654 ((equal arg '(16)) ''org-occur)
9655 (t nil))
9656 ,pos)))
9657 (condition-case nil (let ((org-link-search-inhibit-query t))
9658 (eval cmd))
9659 (error (progn (widen) (eval cmd))))))
9661 (t
9662 (browse-url-at-point)))))))
9663 (move-marker org-open-link-marker nil)
9664 (run-hook-with-args 'org-follow-link-hook)))
9666 (defun org-offer-links-in-entry (&optional nth zero)
9667 "Offer links in the current entry and follow the selected link.
9668 If there is only one link, follow it immediately as well.
9669 If NTH is an integer, immediately pick the NTH link found.
9670 If ZERO is a string, check also this string for a link, and if
9671 there is one, offer it as link number zero."
9675 (cnt ?0)
9676 (in-emacs (if (integerp nth) nil nth))
9677 have-zero end links link c)
9678 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9679 (push (match-string 0 zero) links)
9680 (setq cnt (1- cnt) have-zero t))
9681 (save-excursion
9682 (org-back-to-heading t)
9683 (setq end (save-excursion (outline-next-heading) (point)))
9684 (while (re-search-forward re end t)
9685 (push (match-string 0) links))
9686 (setq links (org-uniquify (reverse links))))
9688 (cond
9689 ((null links)
9690 (message "No links"))
9691 ((equal (length links) 1)
9692 (setq link (list (car links))))
9693 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9694 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9695 (t ; we have to select a link
9696 (save-excursion
9697 (save-window-excursion
9698 (delete-other-windows)
9699 (with-output-to-temp-buffer "*Select Link*"
9700 (mapc (lambda (l)
9701 (if (not (string-match org-bracket-link-regexp l))
9703 (org-remove-angle-brackets l)))
9704 (if (match-end 3)
9706 (match-string 3 l) (match-string 1 l)))
9708 (match-string 1 l))))))
9709 links))
9710 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9711 (message "Select link to open, RET to open all:")
9712 (setq c (read-char-exclusive))
9713 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9714 (when (equal c ?q) (error "Abort"))
9715 (if (equal c ?\C-m)
9716 (setq link links)
9717 (setq nth (- c ?0))
9718 (if have-zero (setq nth (1+ nth)))
9719 (unless (and (integerp nth) (>= (length links) nth))
9720 (error "Invalid link selection"))
9721 (setq link (list (nth (1- nth) links))))))
9722 (if link
9723 (let ((buf (current-buffer)))
9724 (dolist (l link)
9725 (org-open-link-from-string l in-emacs buf))
9726 t)
9727 nil)))
9729 ;; Add special file links that specify the way of opening
9731 (org-add-link-type "file+sys" 'org-open-file-with-system)
9732 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9733 (defun org-open-file-with-system (path)
9734 "Open file at PATH using the system way of opening it."
9735 (org-open-file path 'system))
9736 (defun org-open-file-with-emacs (path)
9737 "Open file at PATH in Emacs."
9738 (org-open-file path 'emacs))
9739 (defun org-remove-file-link-modifiers ()
9740 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9741 (goto-char (point-min))
9743 (org-if-unprotected
9744 (replace-match "file:" t t))))
9745 (eval-after-load "org-exp"
9746 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9747 'org-remove-file-link-modifiers))
9749 ;;;; Time estimates
9751 (defun org-get-effort (&optional pom)
9752 "Get the effort estimate for the current entry."
9753 (org-entry-get pom org-effort-property))
9755 ;;; File search
9757 (defvar org-create-file-search-functions nil
9758 "List of functions to construct the right search string for a file link.
9759 These functions are called in turn with point at the location to
9760 which the link should point.
9762 A function in the hook should first test if it would like to
9763 handle this file type, for example by checking the `major-mode'
9764 or the file extension. If it decides not to handle this file, it
9765 should just return nil to give other functions a chance. If it
9766 does handle the file, it must return the search string to be used
9767 when following the link. The search string will be part of the
9768 file link, given after a double colon, and `org-open-at-point'
9769 will automatically search for it. If special measures must be
9770 taken to make the search successful, another function should be
9771 added to the companion hook `org-execute-file-search-functions',
9772 which see.
9774 A function in this hook may also use `setq' to set the variable
9775 `description' to provide a suggestion for the descriptive text to
9776 be used for this link when it gets inserted into an Org-mode
9779 (defvar org-execute-file-search-functions nil
9780 "List of functions to execute a file search triggered by a link.
9782 Functions added to this hook must accept a single argument, the
9783 search string that was part of the file link, the part after the
9784 double colon. The function must first check if it would like to
9785 handle this search, for example by checking the `major-mode' or
9786 the file extension. If it decides not to handle this search, it
9787 should just return nil to give other functions a chance. If it
9788 does handle the search, it must return a non-nil value to keep
9789 other functions from trying.
9791 Each function can access the current prefix argument through the
9792 variable `current-prefix-argument'. Note that a single prefix is
9793 used to force opening a link in Emacs, so it may be good to only
9794 use a numeric or double prefix to guide the search function.
9796 In case this is needed, a function in this hook can also restore
9797 the window configuration before `org-open-at-point' was called using:
9799 (set-window-configuration org-window-config-before-follow-link)")
9801 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9802 (defun org-link-search (s &optional type avoid-pos stealth)
9803 "Search for a link search option.
9804 If S is surrounded by forward slashes, it is interpreted as a
9805 regular expression. In org-mode files, this will create an `org-occur'
9806 sparse tree. In ordinary files, `occur' will be used to list matches.
9807 If the current buffer is in `dired-mode', grep will be used to search
9808 in all files. If AVOID-POS is given, ignore matches near that position.
9810 When optional argument STEALTH is non-nil, do not modify
9811 visibility around point, thus ignoring
9812 `org-show-hierarchy-above', `org-show-following-heading' and
9813 `org-show-siblings' variables."
9814 (let ((case-fold-search t)
9818 org-emphasis-alist)
9820 (pos (point))
9821 (pre nil) (post nil)
9822 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9823 (cond
9824 ;; First check if there are any special search functions
9825 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9826 ;; Now try the builtin stuff
9827 ((and (equal (string-to-char s0) ?#)
9828 (> (length s0) 1)
9829 (save-excursion
9830 (goto-char (point-min))
9831 (and
9832 (re-search-forward
9834 (setq type 'dedicated
9835 pos (match-beginning 0))))
9836 ;; There is an exact target for this
9837 (goto-char pos)
9838 (org-back-to-heading t)))
9839 ((save-excursion
9840 (goto-char (point-min))
9841 (and
9842 (re-search-forward
9843 (concat "<<" (regexp-quote s0) ">>") nil t)
9844 (setq type 'dedicated
9845 pos (match-beginning 0))))
9846 ;; There is an exact target for this
9847 (goto-char pos))
9849 (save-excursion
9850 (goto-char (point-min))
9851 (and
9852 (re-search-forward
9853 (concat "[^[]" (regexp-quote
9854 (format org-coderef-label-format
9855 (match-string 1 s0))))
9856 nil t)
9857 (setq type 'dedicated
9858 pos (1+ (match-beginning 0))))))
9859 ;; There is a coderef target for this
9860 (goto-char pos))
9862 ;; A regular expression
9863 (cond
9864 ((eq major-mode 'org-mode)
9865 (org-occur (match-string 1 s)))
9866 ;;((eq major-mode 'dired-mode)
9867 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9868 (t (org-do-occur (match-string 1 s)))))
9869 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9870 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9871 (goto-char (point-min))
9872 (cond
9873 ((let (case-fold-search)
9874 (re-search-forward (format org-complex-heading-regexp-format
9875 (regexp-quote s))
9876 nil t))
9877 ;; OK, found a match
9878 (setq type 'dedicated)
9879 (goto-char (match-beginning 0)))
9880 ((and (not org-link-search-inhibit-query)
9881 (eq org-link-search-must-match-exact-headline 'query-to-create)
9882 (y-or-n-p "No match - create this as a new heading? "))
9883 (goto-char (point-max))
9884 (or (bolp) (newline))
9886 (beginning-of-line 0))
9887 (t
9888 (goto-char pos)
9889 (error "No match"))))
9890 (t
9891 ;; A normal search string
9892 (when (equal (string-to-char s) ?*)
9893 ;; Anchor on headlines, post may include tags.
9896 s (substring s 1)))
9897 (remove-text-properties
9898 0 (length s)
9899 '(face nil mouse-face nil keymap nil fontified nil) s)
9900 ;; Make a series of regular expressions to find a match
9909 re4 (concat "[^a-zA-Z_]" re4_)
9911 re1 (concat pre re2 post)
9912 re3 (concat pre (if pre re4_ re4) post)
9913 re5 (concat pre ".*" re4)
9914 re2 (concat pre re2)
9915 re2a (concat pre (if pre re2a_ re2a))
9916 re4 (concat pre (if pre re4_ re4))
9920 ))
9921 (cond
9922 ((eq type 'org-occur) (org-occur reall))
9923 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9924 (t (goto-char (point-min))
9925 (setq type 'fuzzy)
9926 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9927 (org-search-not-self 1 re1 nil t)
9928 (org-search-not-self 1 re2 nil t)
9929 (org-search-not-self 1 re2a nil t)
9930 (org-search-not-self 1 re3 nil t)
9931 (org-search-not-self 1 re4 nil t)
9932 (org-search-not-self 1 re5 nil t)
9933 )
9934 (goto-char (match-beginning 1))
9935 (goto-char pos)
9936 (error "No match"))))))
9937 (and (eq major-mode 'org-mode)
9938 (not stealth)
9939 (org-show-context 'link-search))
9940 type))
9942 (defun org-search-not-self (group &rest args)
9943 "Execute `re-search-forward', but only accept matches that do not
9944 enclose the position of `org-open-link-marker'."
9945 (let ((m org-open-link-marker))
9946 (catch 'exit
9947 (while (apply 're-search-forward args)
9948 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9949 (goto-char (match-end group))
9950 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9951 (> (match-beginning 0) (marker-position m))
9952 (< (match-end 0) (marker-position m)))
9953 (save-match-data
9954 (or (not (org-in-regexp
9955 org-bracket-link-analytic-regexp 1))
9956 (not (match-end 4)) ; no description
9957 (and (<= (match-beginning 4) (point))
9958 (>= (match-end 4) (point))))))
9959 (throw 'exit (point))))))))
9961 (defun org-get-buffer-for-internal-link (buffer)
9962 "Return a buffer to be used for displaying the link target of internal links."
9963 (cond
9964 ((not org-display-internal-link-with-indirect-buffer)
9965 buffer)
9966 ((string-match "(Clone)$" (buffer-name buffer))
9967 (message "Buffer is already a clone, not making another one")
9968 ;; we also do not modify visibility in this case
9969 buffer)
9970 (t ; make a new indirect buffer for displaying the link
9971 (let* ((bn (buffer-name buffer))
9972 (ibn (concat bn "(Clone)"))
9973 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9974 (with-current-buffer ib (org-overview))
9975 ib))))
9977 (defun org-do-occur (regexp &optional cleanup)
9978 "Call the Emacs command `occur'.
9979 If CLEANUP is non-nil, remove the printout of the regular expression
9980 in the *Occur* buffer. This is useful if the regex is long and not useful
9981 to read."
9982 (occur regexp)
9983 (when cleanup
9984 (let ((cwin (selected-window)) win beg end)
9985 (when (setq win (get-buffer-window "*Occur*"))
9986 (select-window win))
9987 (goto-char (point-min))
9988 (when (re-search-forward "match[a-z]+" nil t)
9989 (setq beg (match-end 0))
9991 (setq end (1- (match-beginning 0)))))
9992 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9993 (goto-char (point-min))
9994 (select-window cwin))))
9996 ;;; The mark ring for links jumps
9998 (defvar org-mark-ring nil
9999 "Mark ring for positions before jumps in Org-mode.")
10000 (defvar org-mark-ring-last-goto nil
10001 "Last position in the mark ring used to go back.")
10002 ;; Fill and close the ring
10003 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10004 (loop for i from 1 to org-mark-ring-length do
10005 (push (make-marker) org-mark-ring))
10006 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10007 org-mark-ring)
10009 (defun org-mark-ring-push (&optional pos buffer)
10010 "Put the current position or POS into the mark ring and rotate it."
10011 (interactive)
10012 (setq pos (or pos (point)))
10013 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10014 (move-marker (car org-mark-ring)
10015 (or pos (point))
10016 (or buffer (current-buffer)))
10017 (message "%s"
10018 (substitute-command-keys
10021 (defun org-mark-ring-goto (&optional n)
10022 "Jump to the previous position in the mark ring.
10023 With prefix arg N, jump back that many stored positions. When
10024 called several times in succession, walk through the entire ring.
10025 Org-mode commands jumping to a different position in the current file,
10026 or to another Org-mode file, automatically push the old position
10027 onto the ring."
10028 (interactive "p")
10029 (let (p m)
10030 (if (eq last-command this-command)
10031 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10032 (setq p org-mark-ring))
10033 (setq org-mark-ring-last-goto p)
10034 (setq m (car p))
10035 (org-pop-to-buffer-same-window (marker-buffer m))
10036 (goto-char m)
10037 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10039 (defun org-remove-angle-brackets (s)
10040 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10041 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10042 s)
10043 (defun org-add-angle-brackets (s)
10044 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10045 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10046 s)
10047 (defun org-remove-double-quotes (s)
10050 s)
10052 ;;; Following specific links
10054 (defun org-follow-timestamp-link ()
10055 (cond
10056 ((org-at-date-range-p t)
10057 (let ((org-agenda-start-on-weekday)
10058 (t1 (match-string 1))
10059 (t2 (match-string 2)))
10060 (setq t1 (time-to-days (org-time-string-to-time t1))
10061 t2 (time-to-days (org-time-string-to-time t2)))
10062 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10063 ((org-at-timestamp-p t)
10064 (org-agenda-list nil (time-to-days (org-time-string-to-time
10065 (substring (match-string 1) 0 10)))
10066 1))
10067 (t (error "This should not happen"))))
10070 ;;; Following file links
10071 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10072 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10073 (declare-function mailcap-mime-info
10074 "mailcap" (string &optional request no-decode))
10075 (defvar org-wait nil)
10076 (defun org-open-file (path &optional in-emacs line search)
10077 "Open the file at PATH.
10078 First, this expands any special file name abbreviations. Then the
10079 configuration variable `org-file-apps' is checked if it contains an
10080 entry for this file type, and if yes, the corresponding command is launched.
10082 If no application is found, Emacs simply visits the file.
10084 With optional prefix argument IN-EMACS, Emacs will visit the file.
10086 prefix arg, Org tries to avoid opening in Emacs
10087 and to use an external application to visit the file.
10089 Optional LINE specifies a line to go to, optional SEARCH a string
10090 to search for. If LINE or SEARCH is given, the file will be
10091 opened in Emacs, unless an entry from org-file-apps that makes
10092 use of groups in a regexp matches.
10094 If you want to change the way frames are used when following a
10095 link, please customize `org-link-frame-setup'.
10097 If the file does not exist, an error is thrown."
10098 (let* ((file (if (equal path "")
10099 buffer-file-name
10100 (substitute-in-file-name (expand-file-name path))))
10101 (file-apps (append org-file-apps (org-default-apps)))
10102 (apps (org-remove-if
10103 'org-file-apps-entry-match-against-dlink-p file-apps))
10104 (apps-dlink (org-remove-if-not
10105 'org-file-apps-entry-match-against-dlink-p file-apps))
10106 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10107 (dirp (if remp nil (file-directory-p file)))
10108 (file (if (and dirp org-open-directory-means-index-dot-org)
10109 (concat (file-name-as-directory file) "index.org")
10110 file))
10111 (a-m-a-p (assq 'auto-mode apps))
10112 (dfile (downcase file))
10113 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10114 (link (cond ((and (eq line nil)
10115 (eq search nil))
10116 file)
10117 (line
10118 (concat file "::" (number-to-string line)))
10119 (search
10120 (concat file "::" search))))
10121 (dlink (downcase link))
10122 (old-buffer (current-buffer))
10123 (old-pos (point))
10124 (old-mode major-mode)
10125 ext cmd link-match-data)
10127 (setq ext (match-string 1 dfile))
10129 (setq ext (match-string 1 dfile))))
10130 (cond
10131 ((member in-emacs '((16) system))
10132 (setq cmd (cdr (assoc 'system apps))))
10133 (in-emacs (setq cmd 'emacs))
10134 (t
10135 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10136 (and dirp (cdr (assoc 'directory apps)))
10137 ; first, try matching against apps-dlink
10138 ; if we get a match here, store the match data for later
10139 (let ((match (assoc-default dlink apps-dlink
10140 'string-match)))
10141 (if match
10142 (progn (setq link-match-data (match-data))
10143 match)
10144 (progn (setq in-emacs (or in-emacs line search))
10145 nil))) ; if we have no match in apps-dlink,
10146 ; always open the file in emacs if line or search
10147 ; is given (for backwards compatibility)
10148 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10149 'string-match)
10150 (cdr (assoc ext apps))
10151 (cdr (assoc t apps))))))
10152 (when (eq cmd 'system)
10153 (setq cmd (cdr (assoc 'system apps))))
10154 (when (eq cmd 'default)
10155 (setq cmd (cdr (assoc t apps))))
10156 (when (eq cmd 'mailcap)
10157 (require 'mailcap)
10158 (mailcap-parse-mailcaps)
10159 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10160 (command (mailcap-mime-info mime-type)))
10161 (if (stringp command)
10162 (setq cmd command)
10163 (setq cmd 'emacs))))
10164 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10165 (not (file-exists-p file))
10166 (not org-open-non-existing-files))
10167 (error "No such file: %s" file))
10168 (cond
10170 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10172 (setq cmd (replace-match "%s" t t cmd)))
10173 (while (string-match "%s" cmd)
10174 (setq cmd (replace-match
10175 (save-match-data
10176 (shell-quote-argument
10177 (convert-standard-filename file)))
10178 t t cmd)))
10180 ;; Replace "%1", "%2" etc. in command with group matches from regex
10181 (save-match-data
10182 (let ((match-index 1)
10183 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10184 (set-match-data link-match-data)
10185 (while (<= match-index number-of-groups)
10186 (let ((regex (concat "%" (number-to-string match-index)))
10187 (replace-with (match-string match-index dlink)))
10188 (while (string-match regex cmd)
10189 (setq cmd (replace-match replace-with t t cmd))))
10190 (setq match-index (+ match-index 1)))))
10192 (save-window-excursion
10193 (start-process-shell-command cmd nil cmd)
10194 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10195 ))
10196 ((or (stringp cmd)
10197 (eq cmd 'emacs))
10198 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10199 (widen)
10200 (if line (org-goto-line line)
10201 (if search (org-link-search search))))
10202 ((consp cmd)
10203 (let ((file (convert-standard-filename file)))
10204 (save-match-data
10205 (set-match-data link-match-data)
10206 (eval cmd))))
10207 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10208 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10209 (or (not (equal old-buffer (current-buffer)))
10210 (not (equal old-pos (point))))
10211 (org-mark-ring-push old-pos old-buffer))))
10213 (defun org-file-apps-entry-match-against-dlink-p (entry)
10214 "This function returns non-nil if `entry' uses a regular
10215 expression which should be matched against the whole link by
10216 org-open-file.
10218 It assumes that is the case when the entry uses a regular
10219 expression which has at least one grouping construct and the
10220 action is either a lisp form or a command string containing
10221 '%1', i.e. using at least one subexpression match as a
10222 parameter."
10223 (let ((selector (car entry))
10224 (action (cdr entry)))
10225 (if (stringp selector)
10226 (and (> (regexp-opt-depth selector) 0)
10227 (or (and (stringp action)
10228 (string-match "%[0-9]" action))
10229 (consp action)))
10230 nil)))
10232 (defun org-default-apps ()
10233 "Return the default applications for this operating system."
10234 (cond
10235 ((eq system-type 'darwin)
10236 org-file-apps-defaults-macosx)
10237 ((eq system-type 'windows-nt)
10238 org-file-apps-defaults-windowsnt)
10239 (t org-file-apps-defaults-gnu)))
10241 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10242 "Convert extensions to regular expressions in the cars of LIST.
10243 Also, weed out any non-string entries, because the return value is used
10244 only for regexp matching.
10245 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10246 point to the symbol `emacs', indicating that the file should
10247 be opened in Emacs."
10248 (append
10249 (delq nil
10250 (mapcar (lambda (x)
10251 (if (not (stringp (car x)))
10252 nil
10254 x
10256 list))
10257 (if add-auto-mode
10258 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10260 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10261 (defun org-file-remote-p (file)
10262 "Test whether FILE specifies a location on a remote system.
10263 Return non-nil if the location is indeed remote.
10267 (cond ((fboundp 'file-remote-p)
10268 (file-remote-p file))
10269 ((fboundp 'tramp-handle-file-remote-p)
10270 (tramp-handle-file-remote-p file))
10271 ((and (boundp 'ange-ftp-name-format)
10272 (string-match (car ange-ftp-name-format) file))
10273 t)
10274 (t nil)))
10277 ;;;; Refiling
10279 (defun org-get-org-file ()
10280 "Read a filename, with default directory `org-directory'."
10281 (let ((default (or org-default-notes-file remember-data-file)))
10282 (read-file-name (format "File name [%s]: " default)
10283 (file-name-as-directory org-directory)
10284 default)))
10286 (defun org-notes-order-reversed-p ()
10287 "Check if the current file should receive notes in reversed order."
10288 (cond
10289 ((not org-reverse-note-order) nil)
10290 ((eq t org-reverse-note-order) t)
10291 ((not (listp org-reverse-note-order)) nil)
10292 (t (catch 'exit
10293 (let ((all org-reverse-note-order)
10294 entry)
10295 (while (setq entry (pop all))
10296 (if (string-match (car entry) buffer-file-name)
10297 (throw 'exit (cdr entry))))
10298 nil)))))
10300 (defvar org-refile-target-table nil
10301 "The list of refile targets, created by `org-refile'.")
10303 (defvar org-agenda-new-buffers nil
10304 "Buffers created to visit agenda files.")
10306 (defvar org-refile-cache nil
10307 "Cache for refile targets.")
10309 (defvar org-refile-markers nil
10310 "All the markers used for caching refile locations.")
10312 (defun org-refile-marker (pos)
10313 "Get a new refile marker, but only if caching is in use."
10314 (if (not org-refile-use-cache)
10315 pos
10316 (let ((m (make-marker)))
10317 (move-marker m pos)
10318 (push m org-refile-markers)
10319 m)))
10321 (defun org-refile-cache-clear ()
10322 "Clear the refile cache and disable all the markers."
10323 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10324 (setq org-refile-markers nil)
10325 (setq org-refile-cache nil)
10326 (message "Refile cache has been cleared"))
10328 (defun org-refile-cache-check-set (set)
10329 "Check if all the markers in the cache still have live buffers."
10330 (let (marker)
10331 (catch 'exit
10332 (while (and set (setq marker (nth 3 (pop set))))
10333 ;; if org-refile-use-outline-path is 'file, marker may be nil
10334 (when (and marker (null (marker-buffer marker)))
10335 (message "not found") (sit-for 3)
10336 (throw 'exit nil)))
10337 t)))
10339 (defun org-refile-cache-put (set &rest identifiers)
10340 "Push the refile targets SET into the cache, under IDENTIFIERS."
10341 (let* ((key (sha1 (prin1-to-string identifiers)))
10342 (entry (assoc key org-refile-cache)))
10343 (if entry
10344 (setcdr entry set)
10345 (push (cons key set) org-refile-cache))))
10347 (defun org-refile-cache-get (&rest identifiers)
10348 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10349 (cond
10350 ((not org-refile-cache) nil)
10351 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10352 (t
10353 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10354 org-refile-cache))))
10355 (and set (org-refile-cache-check-set set) set)))))
10357 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10358 "Produce a table with refile targets."
10359 (let ((case-fold-search nil)
10360 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10361 (entries (or org-refile-targets '((nil . (:level . 1)))))
10362 targets tgs txt re files f desc descre fast-path-p level pos0)
10363 (message "Getting targets...")
10364 (with-current-buffer (or default-buffer (current-buffer))
10365 (while (setq entry (pop entries))
10366 (setq files (car entry) desc (cdr entry))
10367 (setq fast-path-p nil)
10368 (cond
10369 ((null files) (setq files (list (current-buffer))))
10370 ((eq files 'org-agenda-files)
10371 (setq files (org-agenda-files 'unrestricted)))
10372 ((and (symbolp files) (fboundp files))
10373 (setq files (funcall files)))
10374 ((and (symbolp files) (boundp files))
10375 (setq files (symbol-value files))))
10376 (if (stringp files) (setq files (list files)))
10377 (cond
10378 ((eq (car desc) :tag)
10380 ((eq (car desc) :todo)
10382 ((eq (car desc) :regexp)
10383 (setq descre (cdr desc)))
10384 ((eq (car desc) :level)
10386 (if org-odd-levels-only
10387 (1- (* 2 (cdr desc)))
10388 (cdr desc)))
10390 ((eq (car desc) :maxlevel)
10391 (setq fast-path-p t)
10393 (if org-odd-levels-only
10394 (1- (* 2 (cdr desc)))
10395 (cdr desc)))
10397 (t (error "Bad refiling target description %s" desc)))
10398 (while (setq f (pop files))
10399 (with-current-buffer
10400 (if (bufferp f) f (org-get-agenda-file-buffer f))
10401 (or
10402 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10403 (progn
10404 (if (bufferp f) (setq f (buffer-file-name
10405 (buffer-base-buffer f))))
10406 (setq f (and f (expand-file-name f)))
10407 (if (eq org-refile-use-outline-path 'file)
10408 (push (list (file-name-nondirectory f) f nil nil) tgs))
10409 (save-excursion
10410 (save-restriction
10411 (widen)
10412 (goto-char (point-min))
10413 (while (re-search-forward descre nil t)
10414 (goto-char (setq pos0 (point-at-bol)))
10415 (catch 'next
10416 (when org-refile-target-verify-function
10417 (save-match-data
10418 (or (funcall org-refile-target-verify-function)
10419 (throw 'next t))))
10420 (when (and (looking-at org-complex-heading-regexp)
10421 (not (member (match-string 4) excluded-entries))
10422 (match-string 4))
10423 (setq level (org-reduced-level
10424 (- (match-end 1) (match-beginning 1)))
10425 txt (org-link-display-format (match-string 4))
10427 re (format org-complex-heading-regexp-format
10428 (regexp-quote (match-string 4))))
10429 (when org-refile-use-outline-path
10430 (setq txt (mapconcat
10431 'org-protect-slash
10432 (append
10433 (if (eq org-refile-use-outline-path
10434 'file)
10435 (list (file-name-nondirectory
10436 (buffer-file-name
10437 (buffer-base-buffer))))
10438 (if (eq org-refile-use-outline-path
10439 'full-file-path)
10440 (list (buffer-file-name
10441 (buffer-base-buffer)))))
10442 (org-get-outline-path fast-path-p
10443 level txt)
10444 (list txt))
10445 "/")))
10446 (push (list txt f re (org-refile-marker (point)))
10447 tgs)))
10448 (when (= (point) pos0)
10449 ;; verification function has not moved point
10450 (goto-char (point-at-eol))))))))
10451 (when org-refile-use-cache
10452 (org-refile-cache-put tgs (buffer-file-name) descre))
10453 (setq targets (append tgs targets))
10454 ))))
10455 (message "Getting targets...done")
10456 (nreverse targets)))
10458 (defun org-protect-slash (s)
10459 (while (string-match "/" s)
10461 s)
10463 (defvar org-olpa (make-vector 20 nil))
10465 (defun org-get-outline-path (&optional fastp level heading)
10466 "Return the outline path to the current entry, as a list.
10468 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10469 routine which makes outline path derivations for an entire file,
10470 avoiding backtracing. Refile target collection makes use of that."
10471 (if fastp
10472 (progn
10473 (if (> level 19)
10474 (error "Outline path failure, more than 19 levels"))
10475 (loop for i from level upto 19 do
10476 (aset org-olpa i nil))
10477 (prog1
10478 (delq nil (append org-olpa nil))
10479 (aset org-olpa level heading)))
10480 (let (rtn case-fold-search)
10481 (save-excursion
10482 (save-restriction
10483 (widen)
10484 (while (org-up-heading-safe)
10485 (when (looking-at org-complex-heading-regexp)
10486 (push (org-match-string-no-properties 4) rtn)))
10487 rtn)))))
10489 (defun org-format-outline-path (path &optional width prefix)
10490 "Format the outline path PATH for display.
10491 Width is the maximum number of characters that is available.
10492 Prefix is a prefix to be included in the returned string,
10493 such as the file name."
10494 (setq width (or width 79))
10495 (if prefix (setq width (- width (length prefix))))
10496 (if (not path)
10497 (or prefix "")
10498 (let* ((nsteps (length path))
10499 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10500 (maxwidth (if (<= total-width width)
10501 10000 ;; everything fits
10502 ;; we need to shorten the level headings
10503 (/ (- width nsteps) nsteps)))
10504 (org-odd-levels-only nil)
10505 (n 0)
10506 (total (1+ (length prefix))))
10507 (setq maxwidth (max maxwidth 10))
10508 (concat prefix
10509 (mapconcat
10510 (lambda (h)
10511 (setq n (1+ n))
10512 (if (and (= n nsteps) (< maxwidth 10000))
10513 (setq maxwidth (- total-width total)))
10514 (if (< (length h) maxwidth)
10515 (progn (setq total (+ total (length h) 1)) h)
10516 (setq h (substring h 0 (- maxwidth 2))
10517 total (+ total maxwidth 1))
10519 (setq h (substring h 0 (match-beginning 0))))
10520 (setq h (concat h "..")))
10521 (org-add-props h nil 'face
10522 (nth (% (1- n) org-n-level-faces)
10523 org-level-faces))
10524 h)
10525 path "/")))))
10527 (defun org-display-outline-path (&optional file current)
10528 "Display the current outline path in the echo area."
10529 (interactive "P")
10530 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10531 (case-fold-search nil)
10532 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10533 (if current (setq path (append path
10534 (save-excursion
10535 (org-back-to-heading t)
10536 (if (looking-at org-complex-heading-regexp)
10537 (list (match-string 4)))))))
10538 (message "%s"
10539 (org-format-outline-path
10540 path
10541 (1- (frame-width))
10542 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10544 (defvar org-refile-history nil
10545 "History for refiling operations.")
10547 (defvar org-after-refile-insert-hook nil
10548 "Hook run after `org-refile' has inserted its stuff at the new location.
10549 Note that this is still *before* the stuff will be removed from
10550 the *old* location.")
10552 (defvar org-capture-last-stored-marker)
10553 (defun org-refile (&optional goto default-buffer rfloc)
10554 "Move the entry or entries at point to another heading.
10555 The list of target headings is compiled using the information in
10556 `org-refile-targets', which see.
10558 At the target location, the entry is filed as a subitem of the target
10559 heading. Depending on `org-reverse-note-order', the new subitem will
10560 either be the first or the last subitem.
10562 If there is an active region, all entries in that region will be moved.
10563 However, the region must fulfill the requirement that the first heading
10564 is the first one sets the top-level of the moved text - at most siblings
10565 below it are allowed.
10567 With prefix arg GOTO, the command will only visit the target location
10568 and not actually move anything.
10571 go to the location where the last refiling operation has put the subtree.
10572 With a prefix argument of `2', refile to the running clock.
10574 RFLOC can be a refile location obtained in a different way.
10576 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10578 If you are using target caching (see `org-refile-use-cache'),
10579 You have to clear the target cache in order to find new targets.
10580 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10581 prefix argument (`C-u C-u C-u C-c C-w')."
10583 (interactive "P")
10584 (if (member goto '(0 (64)))
10585 (org-refile-cache-clear)
10586 (let* ((cbuf (current-buffer))
10587 (regionp (org-region-active-p))
10588 (region-start (and regionp (region-beginning)))
10589 (region-end (and regionp (region-end)))
10590 (region-length (and regionp (- region-end region-start)))
10591 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10592 pos it nbuf file re level reversed)
10593 (setq last-command nil)
10594 (when regionp
10595 (goto-char region-start)
10596 (or (bolp) (goto-char (point-at-bol)))
10597 (setq region-start (point))
10598 (unless (or (org-kill-is-subtree-p
10599 (buffer-substring region-start region-end))
10600 (prog1 org-refile-active-region-within-subtree
10601 (org-toggle-heading)))
10602 (error "The region is not a (sequence of) subtree(s)")))
10603 (if (equal goto '(16))
10604 (org-refile-goto-last-stored)
10605 (when (or
10606 (and (equal goto 2)
10607 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10608 (prog1
10609 (setq it (list (or org-clock-heading "running clock")
10610 (buffer-file-name
10611 (marker-buffer org-clock-hd-marker))
10612 ""
10613 (marker-position org-clock-hd-marker)))
10614 (setq goto nil)))
10615 (setq it (or rfloc
10616 (let (heading-text)
10617 (save-excursion
10618 (unless goto
10619 (org-back-to-heading t)
10620 (setq heading-text
10621 (nth 4 (org-heading-components))))
10622 (org-refile-get-location
10623 (cond (goto "Goto")
10624 (regionp "Refile region to")
10627 default-buffer
10628 org-refile-allow-creating-parent-nodes
10629 goto))))))
10630 (setq file (nth 1 it)
10631 re (nth 2 it)
10632 pos (nth 3 it))
10633 (if (and (not goto)
10634 pos
10635 (equal (buffer-file-name) file)
10636 (if regionp
10637 (and (>= pos region-start)
10638 (<= pos region-end))
10639 (and (>= pos (point))
10640 (< pos (save-excursion
10641 (org-end-of-subtree t t))))))
10642 (error "Cannot refile to position inside the tree or region"))
10644 (setq nbuf (or (find-buffer-visiting file)
10645 (find-file-noselect file)))
10646 (if goto
10647 (progn
10648 (org-pop-to-buffer-same-window nbuf)
10649 (goto-char pos)
10650 (org-show-context 'org-goto))
10651 (if regionp
10652 (progn
10653 (org-kill-new (buffer-substring region-start region-end))
10654 (org-save-markers-in-region region-start region-end))
10655 (org-copy-subtree 1 nil t))
10656 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10657 (find-file-noselect file)))
10658 (setq reversed (org-notes-order-reversed-p))
10659 (save-excursion
10660 (save-restriction
10661 (widen)
10662 (if pos
10663 (progn
10664 (goto-char pos)
10665 (looking-at org-outline-regexp)
10666 (setq level (org-get-valid-level (funcall outline-level) 1))
10667 (goto-char
10668 (if reversed
10669 (or (outline-next-heading) (point-max))
10670 (or (save-excursion (org-get-next-sibling))
10671 (org-end-of-subtree t t)
10672 (point-max)))))
10673 (setq level 1)
10674 (if (not reversed)
10675 (goto-char (point-max))
10676 (goto-char (point-min))
10677 (or (outline-next-heading) (goto-char (point-max)))))
10678 (if (not (bolp)) (newline))
10679 (org-paste-subtree level)
10680 (when org-log-refile
10681 (org-add-log-setup 'refile nil nil 'findpos
10682 org-log-refile)
10683 (unless (eq org-log-refile 'note)
10684 (save-excursion (org-add-log-note))))
10685 (and org-auto-align-tags (org-set-tags nil t))
10686 (bookmark-set "org-refile-last-stored")
10687 ;; If we are refiling for capture, make sure that the
10688 ;; last-capture pointers point here
10689 (when (org-bound-and-true-p org-refile-for-capture)
10690 (bookmark-set "org-capture-last-stored-marker")
10691 (move-marker org-capture-last-stored-marker (point)))
10692 (if (fboundp 'deactivate-mark) (deactivate-mark))
10693 (run-hooks 'org-after-refile-insert-hook))))
10694 (if regionp
10695 (delete-region (point) (+ (point) region-length))
10696 (org-cut-subtree))
10697 (when (featurep 'org-inlinetask)
10698 (org-inlinetask-remove-END-maybe))
10699 (setq org-markers-to-move nil)
10702 (defun org-refile-goto-last-stored ()
10703 "Go to the location where the last refile was stored."
10704 (interactive)
10705 (bookmark-jump "org-refile-last-stored")
10706 (message "This is the location of the last refile"))
10708 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10709 no-exclude)
10710 "Prompt the user for a refile location, using PROMPT.
10711 PROMPT should not be suffixed with a colon and a space, because
10712 this function appends the default value from
10713 `org-refile-history' automatically, if that is not empty.
10714 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10715 this is used for the GOTO interface."
10716 (let ((org-refile-targets org-refile-targets)
10717 (org-refile-use-outline-path org-refile-use-outline-path)
10718 excluded-entries)
10719 (when (and (eq major-mode 'org-mode)
10720 (not org-refile-use-cache)
10721 (not no-exclude))
10722 (org-map-tree
10723 (lambda()
10724 (setq excluded-entries
10725 (append excluded-entries (list (org-get-heading t t)))))))
10726 (setq org-refile-target-table
10727 (org-refile-get-targets default-buffer excluded-entries)))
10728 (unless org-refile-target-table
10729 (error "No refile targets"))
10730 (let* ((prompt (concat prompt
10731 (and (car org-refile-history)
10732 (concat " (default " (car org-refile-history) ")"))
10733 ": "))
10734 (cbuf (current-buffer))
10735 (partial-completion-mode nil)
10736 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10737 (cfunc (if (and org-refile-use-outline-path
10738 org-outline-path-complete-in-steps)
10739 'org-olpath-completing-read
10740 'org-icompleting-read))
10741 (extra (if org-refile-use-outline-path "/" ""))
10742 (filename (and cfn (expand-file-name cfn)))
10743 (tbl (mapcar
10744 (lambda (x)
10745 (if (and (not (member org-refile-use-outline-path
10746 '(file full-file-path)))
10747 (not (equal filename (nth 1 x))))
10748 (cons (concat (car x) extra " ("
10749 (file-name-nondirectory (nth 1 x)) ")")
10750 (cdr x))
10751 (cons (concat (car x) extra) (cdr x))))
10752 org-refile-target-table))
10753 (completion-ignore-case t)
10754 pa answ parent-target child parent old-hist)
10755 (setq old-hist org-refile-history)
10756 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10757 nil 'org-refile-history (car org-refile-history)))
10758 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10759 (org-refile-check-position pa)
10760 (if pa
10761 (progn
10762 (when (or (not org-refile-history)
10763 (not (eq old-hist org-refile-history))
10764 (not (equal (car pa) (car org-refile-history))))
10765 (setq org-refile-history
10766 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10767 org-refile-history
10768 (cdr org-refile-history))))
10769 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10770 (pop org-refile-history)))
10771 pa)
10773 (progn
10774 (setq parent (match-string 1 answ)
10775 child (match-string 2 answ))
10776 (setq parent-target (or (assoc parent tbl)
10777 (assoc (concat parent "/") tbl)))
10778 (when (and parent-target
10779 (or (eq new-nodes t)
10780 (and (eq new-nodes 'confirm)
10782 child)))))
10783 (org-refile-new-child parent-target child)))
10784 (error "Invalid target location")))))
10786 (defun org-refile-check-position (refile-pointer)
10787 "Check if the refile pointer matches the readline to which it points."
10788 (let* ((file (nth 1 refile-pointer))
10789 (re (nth 2 refile-pointer))
10790 (pos (nth 3 refile-pointer))
10791 buffer)
10792 (when (org-string-nw-p re)
10793 (setq buffer (if (markerp pos)
10794 (marker-buffer pos)
10795 (or (find-buffer-visiting file)
10796 (find-file-noselect file))))
10797 (with-current-buffer buffer
10798 (save-excursion
10799 (save-restriction
10800 (widen)
10801 (goto-char pos)
10802 (beginning-of-line 1)
10803 (unless (org-looking-at-p re)
10804 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10806 (defun org-refile-new-child (parent-target child)
10807 "Use refile target PARENT-TARGET to add new CHILD below it."
10808 (unless parent-target
10809 (error "Cannot find parent for new node"))
10810 (let ((file (nth 1 parent-target))
10811 (pos (nth 3 parent-target))
10812 level)
10813 (with-current-buffer (or (find-buffer-visiting file)
10814 (find-file-noselect file))
10815 (save-excursion
10816 (save-restriction
10817 (widen)
10818 (if pos
10819 (goto-char pos)
10820 (goto-char (point-max))
10821 (if (not (bolp)) (newline)))
10822 (when (looking-at org-outline-regexp)
10823 (setq level (funcall outline-level))
10824 (org-end-of-subtree t t))
10825 (org-back-over-empty-lines)
10827 (if pos (org-get-valid-level level 1) 1) ?*)
10829 (beginning-of-line 0)
10830 (list (concat (car parent-target) "/" child) file "" (point)))))))
10832 (defun org-olpath-completing-read (prompt collection &rest args)
10833 "Read an outline path like a file name."
10834 (let ((thetable collection)
10835 (org-completion-use-ido nil) ; does not work with ido.
10836 (org-completion-use-iswitchb nil)) ; or iswitchb
10837 (apply
10838 'org-icompleting-read prompt
10839 (lambda (string predicate &optional flag)
10840 (let (rtn r f (l (length string)))
10841 (cond
10842 ((eq flag nil)
10843 ;; try completion
10844 (try-completion string thetable))
10845 ((eq flag t)
10846 ;; all-completions
10847 (setq rtn (all-completions string thetable predicate))
10848 (mapcar
10849 (lambda (x)
10850 (setq r (substring x l))
10851 (if (string-match " ([^)]*)$" x)
10852 (setq f (match-string 0 x))
10853 (setq f ""))
10854 (if (string-match "/" r)
10855 (concat string (substring r 0 (match-end 0)) f)
10856 x))
10857 rtn))
10858 ((eq flag 'lambda)
10859 ;; exact match?
10860 (assoc string thetable)))
10861 ))
10862 args)))
10864 ;;;; Dynamic blocks
10866 (defun org-find-dblock (name)
10867 "Find the first dynamic block with name NAME in the buffer.
10868 If not found, stay at current position and return nil."
10869 (let (pos)
10870 (save-excursion
10871 (goto-char (point-min))
10873 nil t)
10874 (match-beginning 0))))
10875 (if pos (goto-char pos))
10876 pos))
10878 (defconst org-dblock-start-re
10880 "Matches the start line of a dynamic block, with parameters.")
10883 "Matches the end of a dynamic block.")
10885 (defun org-create-dblock (plist)
10886 "Create a dynamic block section, with parameters taken from PLIST.
10887 PLIST must contain a :name entry which is used as name of the block."
10889 (end-of-line 1)
10890 (newline))
10891 (let ((col (current-column))
10892 (name (plist-get plist :name)))
10893 (insert "#+BEGIN: " name)
10894 (while plist
10895 (if (eq (car plist) :name)
10896 (setq plist (cddr plist))
10897 (insert " " (prin1-to-string (pop plist)))))
10899 (beginning-of-line -2)))
10901 (defun org-prepare-dblock ()
10902 "Prepare dynamic block for refresh.
10903 This empties the block, puts the cursor at the insert position and returns
10904 the property list including an extra property :name with the block name."
10905 (unless (looking-at org-dblock-start-re)
10906 (error "Not at a dynamic block"))
10907 (let* ((begdel (1+ (match-end 0)))
10908 (name (org-no-properties (match-string 1)))
10909 (params (append (list :name name)
10910 (read (concat "(" (match-string 3) ")")))))
10911 (save-excursion
10912 (beginning-of-line 1)
10914 (setq params (plist-put params :indentation-column (current-column))))
10915 (unless (re-search-forward org-dblock-end-re nil t)
10916 (error "Dynamic block not terminated"))
10917 (setq params
10918 (append params
10919 (list :content (buffer-substring
10920 begdel (match-beginning 0)))))
10921 (delete-region begdel (match-beginning 0))
10922 (goto-char begdel)
10923 (open-line 1)
10924 params))
10926 (defun org-map-dblocks (&optional command)
10927 "Apply COMMAND to all dynamic blocks in the current buffer.
10928 If COMMAND is not given, use `org-update-dblock'."
10929 (let ((cmd (or command 'org-update-dblock)))
10930 (save-excursion
10931 (goto-char (point-min))
10932 (while (re-search-forward org-dblock-start-re nil t)
10933 (goto-char (match-beginning 0))
10934 (save-excursion
10935 (condition-case nil
10936 (funcall cmd)
10937 (error (message "Error during update of dynamic block"))))
10938 (unless (re-search-forward org-dblock-end-re nil t)
10939 (error "Dynamic block not terminated"))))))
10941 (defun org-dblock-update (&optional arg)
10942 "User command for updating dynamic blocks.
10943 Update the dynamic block at point. With prefix ARG, update all dynamic
10944 blocks in the buffer."
10945 (interactive "P")
10946 (if arg
10947 (org-update-all-dblocks)
10948 (or (looking-at org-dblock-start-re)
10949 (org-beginning-of-dblock))
10950 (org-update-dblock)))
10952 (defun org-update-dblock ()
10953 "Update the dynamic block at point.
10954 This means to empty the block, parse for parameters and then call
10955 the correct writing function."
10956 (interactive)
10957 (save-window-excursion
10958 (let* ((pos (point))
10959 (line (org-current-line))
10960 (params (org-prepare-dblock))
10961 (name (plist-get params :name))
10962 (indent (plist-get params :indentation-column))
10963 (cmd (intern (concat "org-dblock-write:" name))))
10964 (message "Updating dynamic block `%s' at line %d..." name line)
10965 (funcall cmd params)
10966 (message "Updating dynamic block `%s' at line %d...done" name line)
10967 (goto-char pos)
10968 (when (and indent (> indent 0))
10969 (setq indent (make-string indent ?\ ))
10970 (save-excursion
10971 (org-beginning-of-dblock)
10972 (forward-line 1)
10973 (while (not (looking-at org-dblock-end-re))
10974 (insert indent)
10975 (beginning-of-line 2))
10976 (when (looking-at org-dblock-end-re)
10978 (replace-match ""))
10979 (insert indent)))))))
10981 (defun org-beginning-of-dblock ()
10982 "Find the beginning of the dynamic block at point.
10983 Error if there is no such block at point."
10984 (let ((pos (point))
10985 beg)
10986 (end-of-line 1)
10987 (if (and (re-search-backward org-dblock-start-re nil t)
10988 (setq beg (match-beginning 0))
10989 (re-search-forward org-dblock-end-re nil t)
10990 (> (match-end 0) pos))
10991 (goto-char beg)
10992 (goto-char pos)
10993 (error "Not in a dynamic block"))))
10995 (defun org-update-all-dblocks ()
10996 "Update all dynamic blocks in the buffer.
10997 This function can be used in a hook."
10998 (interactive)
10999 (when (eq major-mode 'org-mode)
11000 (org-map-dblocks 'org-update-dblock)))
11003 ;;;; Completion
11005 (defconst org-additional-option-like-keywords
11006 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11007 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11008 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11009 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11010 "BEGIN:" "END:"
11011 "ORGTBL" "TBLFM:" "TBLNAME:"
11012 "BEGIN_EXAMPLE" "END_EXAMPLE"
11013 "BEGIN_QUOTE" "END_QUOTE"
11014 "BEGIN_VERSE" "END_VERSE"
11015 "BEGIN_CENTER" "END_CENTER"
11016 "BEGIN_SRC" "END_SRC"
11017 "BEGIN_RESULT" "END_RESULT"
11018 "NAME:" "RESULTS:"
11019 "HEADER:" "HEADERS:"
11020 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11021 "CAPTION:" "LABEL:"
11022 "SETUPFILE:"
11023 "INCLUDE:"
11024 "BIND:"
11025 "MACRO:"))
11027 (defcustom org-structure-template-alist
11028 '(
11041 ("L" "#+LaTeX: "
11045 ("H" "#+HTML: "
11048 ("A" "#+ASCII: ")
11049 ("i" "#+INDEX: ?"
11050 "#+INDEX: ?")
11051 ("I" "#+INCLUDE %file ?"
11053 )
11054 "Structure completion elements.
11055 This is a list of abbreviation keys and values. The value gets inserted
11056 if you type `<' followed by the key and then press the completion key,
11057 usually `M-TAB'. %file will be replaced by a file name after prompting
11058 for the file using completion. The cursor will be placed at the position
11059 of the `?` in the template.
11060 There are two templates for each key, the first uses the original Org syntax,
11061 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11062 the default when the /org-mtags.el/ module has been loaded. See also the
11063 variable `org-mtags-prefer-muse-templates'."
11064 :group 'org-completion
11065 :type '(repeat
11066 (string :tag "Key")
11067 (string :tag "Template")
11068 (string :tag "Muse Template")))
11070 (defun org-try-structure-completion ()
11071 "Try to complete a structure template before point.
11073 expands them."
11074 (let ((l (buffer-substring (point-at-bol) (point)))
11075 a)
11078 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11079 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11080 (match-beginning 1)) a)
11081 t)))
11083 (defun org-complete-expand-structure-template (start cell)
11084 "Expand a structure template."
11085 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11086 (rpl (nth (if musep 2 1) cell))
11087 (ind ""))
11088 (delete-region start (point))
11090 (cond
11091 ((bolp))
11093 (setq ind (buffer-substring (point-at-bol) (point))))
11094 (t (newline))))
11095 (setq start (point))
11096 (if (string-match "%file" rpl)
11097 (setq rpl (replace-match
11098 (concat
11100 (save-match-data
11101 (abbreviate-file-name (read-file-name "Include file: ")))
11103 t t rpl)))
11106 (insert rpl)
11109 ;;;; TODO, DEADLINE, Comments
11111 (defun org-toggle-comment ()
11112 "Change the COMMENT state of an entry."
11113 (interactive)
11114 (save-excursion
11115 (org-back-to-heading)
11116 (let (case-fold-search)
11117 (cond
11118 ((looking-at (format org-heading-keyword-regexp-format
11119 org-comment-string))
11120 (goto-char (match-end 1))
11121 (looking-at (concat " +" org-comment-string))
11122 (replace-match "" t t)
11123 (when (eolp) (insert " ")))
11124 ((looking-at org-outline-regexp)
11125 (goto-char (match-end 0))
11126 (insert org-comment-string " "))))))
11128 (defvar org-last-todo-state-is-todo nil
11129 "This is non-nil when the last TODO state change led to a TODO state.
11130 If the last change removed the TODO tag or switched to DONE, then
11131 this is nil.")
11133 (defvar org-setting-tags nil) ; dynamically skipped
11135 (defvar org-todo-setup-filter-hook nil
11136 "Hook for functions that pre-filter todo specs.
11137 Each function takes a todo spec and returns either nil or the spec
11138 transformed into canonical form." )
11140 (defvar org-todo-get-default-hook nil
11141 "Hook for functions that get a default item for todo.
11142 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11143 nil or a string to be used for the todo mark." )
11145 (defvar org-agenda-headline-snapshot-before-repeat)
11147 (defun org-current-effective-time ()
11148 "Return current time adjusted for `org-extend-today-until' variable"
11149 (let* ((ct (org-current-time))
11150 (dct (decode-time ct))
11151 (ct1
11152 (if (and org-use-effective-time
11153 (< (nth 2 dct) org-extend-today-until))
11154 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11155 ct)))
11156 ct1))
11158 (defun org-todo-yesterday (&optional arg)
11159 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11160 (interactive "P")
11161 (if (eq major-mode 'org-agenda-mode)
11162 (apply 'org-agenda-todo-yesterday arg)
11163 (let* ((hour (third (decode-time
11164 (org-current-time))))
11165 (org-extend-today-until (1+ hour)))
11166 (org-todo arg))))
11168 (defun org-todo (&optional arg)
11169 "Change the TODO state of an item.
11170 The state of an item is given by a keyword at the start of the heading,
11171 like
11172 *** TODO Write paper
11173 *** DONE Call mom
11175 The different keywords are specified in the variable `org-todo-keywords'.
11177 So for this example: when the item starts with TODO, it is changed to DONE.
11178 When it starts with DONE, the DONE is removed. And when neither TODO nor
11179 DONE are present, add TODO at the beginning of the heading.
11182 state.
11183 With numeric prefix arg, switch to that state.
11185 keywords (nextset).
11187 With a numeric prefix arg of 0, inhibit note taking for the change.
11189 For calling through lisp, arg is also interpreted in the following way:
11190 'none -> empty state
11192 'done -> switch to DONE
11193 'nextset -> switch to the next set of keywords
11194 'previousset -> switch to the previous set of keywords
11196 really is a member of `org-todo-keywords'."
11197 (interactive "P")
11198 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11199 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11200 'region-start-level 'region))
11201 org-loop-over-headlines-in-active-region)
11202 (org-map-entries
11203 `(org-todo ,arg)
11204 org-loop-over-headlines-in-active-region
11205 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11206 (if (equal arg '(16)) (setq arg 'nextset))
11207 (let ((org-blocker-hook org-blocker-hook)
11208 (case-fold-search nil))
11209 (when (equal arg '(64))
11210 (setq arg nil org-blocker-hook nil))
11211 (when (and org-blocker-hook
11212 (or org-inhibit-blocking
11213 (org-entry-get nil "NOBLOCKING")))
11214 (setq org-blocker-hook nil))
11215 (save-excursion
11216 (catch 'exit
11217 (org-back-to-heading t)
11218 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11221 (let* ((match-data (match-data))
11222 (startpos (point-at-bol))
11223 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11224 (org-log-done org-log-done)
11225 (org-log-repeat org-log-repeat)
11226 (org-todo-log-states org-todo-log-states)
11227 (org-inhibit-logging
11228 (if (equal arg 0)
11229 (progn (setq arg nil) 'note) org-inhibit-logging))
11230 (this (match-string 1))
11231 (hl-pos (match-beginning 0))
11232 (head (org-get-todo-sequence-head this))
11233 (ass (assoc head org-todo-kwd-alist))
11234 (interpret (nth 1 ass))
11235 (done-word (nth 3 ass))
11236 (final-done-word (nth 4 ass))
11237 (last-state (or this ""))
11238 (completion-ignore-case t)
11239 (member (member this org-todo-keywords-1))
11240 (tail (cdr member))
11241 (state (cond
11242 ((and org-todo-key-trigger
11243 (or (and (equal arg '(4))
11244 (eq org-use-fast-todo-selection 'prefix))
11245 (and (not arg) org-use-fast-todo-selection
11246 (not (eq org-use-fast-todo-selection
11247 'prefix)))))
11248 ;; Use fast selection
11249 (org-fast-todo-selection))
11250 ((and (equal arg '(4))
11251 (or (not org-use-fast-todo-selection)
11252 (not org-todo-key-trigger)))
11253 ;; Read a state with completion
11254 (org-icompleting-read
11255 "State: " (mapcar (lambda(x) (list x))
11256 org-todo-keywords-1)
11257 nil t))
11258 ((eq arg 'right)
11259 (if this
11260 (if tail (car tail) nil)
11261 (car org-todo-keywords-1)))
11262 ((eq arg 'left)
11263 (if (equal member org-todo-keywords-1)
11264 nil
11265 (if this
11266 (nth (- (length org-todo-keywords-1)
11267 (length tail) 2)
11268 org-todo-keywords-1)
11269 (org-last org-todo-keywords-1))))
11270 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11271 (setq arg nil))) ; hack to fall back to cycling
11272 (arg
11273 ;; user or caller requests a specific state
11274 (cond
11275 ((equal arg "") nil)
11276 ((eq arg 'none) nil)
11277 ((eq arg 'done) (or done-word (car org-done-keywords)))
11278 ((eq arg 'nextset)
11279 (or (car (cdr (member head org-todo-heads)))
11280 (car org-todo-heads)))
11281 ((eq arg 'previousset)
11282 (let ((org-todo-heads (reverse org-todo-heads)))
11283 (or (car (cdr (member head org-todo-heads)))
11284 (car org-todo-heads))))
11285 ((car (member arg org-todo-keywords-1)))
11286 ((stringp arg)
11287 (error "State `%s' not valid in this file" arg))
11288 ((nth (1- (prefix-numeric-value arg))
11289 org-todo-keywords-1))))
11290 ((null member) (or head (car org-todo-keywords-1)))
11291 ((equal this final-done-word) nil) ;; -> make empty
11292 ((null tail) nil) ;; -> first entry
11293 ((memq interpret '(type priority))
11294 (if (eq this-command last-command)
11295 (car tail)
11296 (if (> (length tail) 0)
11297 (or done-word (car org-done-keywords))
11298 nil)))
11299 (t
11300 (car tail))))
11301 (state (or
11302 (run-hook-with-args-until-success
11303 'org-todo-get-default-hook state last-state)
11304 state))
11305 (next (if state (concat " " state " ") " "))
11306 (change-plist (list :type 'todo-state-change :from this :to state
11307 :position startpos))
11308 dolog now-done-p)
11309 (when org-blocker-hook
11310 (setq org-last-todo-state-is-todo
11311 (not (member this org-done-keywords)))
11312 (unless (save-excursion
11313 (save-match-data
11314 (org-with-wide-buffer
11315 (run-hook-with-args-until-failure
11316 'org-blocker-hook change-plist))))
11317 (if (org-called-interactively-p 'interactive)
11318 (error "TODO state change from %s to %s blocked" this state)
11319 ;; fail silently
11320 (message "TODO state change from %s to %s blocked" this state)
11321 (throw 'exit nil))))
11322 (store-match-data match-data)
11323 (replace-match next t t)
11324 (unless (pos-visible-in-window-p hl-pos)
11325 (message "TODO state changed to %s" (org-trim next)))
11326 (unless head
11327 (setq head (org-get-todo-sequence-head state)
11328 ass (assoc head org-todo-kwd-alist)
11329 interpret (nth 1 ass)
11330 done-word (nth 3 ass)
11331 final-done-word (nth 4 ass)))
11332 (when (memq arg '(nextset previousset))
11333 (message "Keyword-Set %d/%d: %s"
11334 (- (length org-todo-sets) -1
11335 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11336 (length org-todo-sets)
11337 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11338 (setq org-last-todo-state-is-todo
11339 (not (member state org-done-keywords)))
11340 (setq now-done-p (and (member state org-done-keywords)
11341 (not (member this org-done-keywords))))
11342 (and logging (org-local-logging logging))
11343 (when (and (or org-todo-log-states org-log-done)
11344 (not (eq org-inhibit-logging t))
11345 (not (memq arg '(nextset previousset))))
11346 ;; we need to look at recording a time and note
11347 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11348 (nth 2 (assoc this org-todo-log-states))))
11349 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11350 (setq dolog 'time))
11351 (when (and state
11352 (member state org-not-done-keywords)
11353 (not (member this org-not-done-keywords)))
11354 ;; This is now a todo state and was not one before
11355 ;; If there was a CLOSED time stamp, get rid of it.
11356 (org-add-planning-info nil nil 'closed))
11357 (when (and now-done-p org-log-done)
11358 ;; It is now done, and it was not done before
11359 (org-add-planning-info 'closed (org-current-effective-time))
11360 (if (and (not dolog) (eq 'note org-log-done))
11361 (org-add-log-setup 'done state this 'findpos 'note)))
11362 (when (and state dolog)
11363 ;; This is a non-nil state, and we need to log it
11364 (org-add-log-setup 'state state this 'findpos dolog)))
11365 ;; Fixup tag positioning
11366 (org-todo-trigger-tag-changes state)
11367 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11368 (when org-provide-todo-statistics
11369 (org-update-parent-todo-statistics))
11370 (run-hooks 'org-after-todo-state-change-hook)
11371 (if (and arg (not (member state org-done-keywords)))
11372 (setq head (org-get-todo-sequence-head state)))
11373 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11374 ;; Do we need to trigger a repeat?
11375 (when now-done-p
11376 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11377 ;; This is for the agenda, take a snapshot of the headline.
11378 (save-match-data
11379 (setq org-agenda-headline-snapshot-before-repeat
11380 (org-get-heading))))
11381 (org-auto-repeat-maybe state))
11382 ;; Fixup cursor location if close to the keyword
11383 (if (and (outline-on-heading-p)
11384 (not (bolp))
11385 (save-excursion (beginning-of-line 1)
11386 (looking-at org-todo-line-regexp))
11387 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11388 (progn
11389 (goto-char (or (match-end 2) (match-end 1)))
11390 (and (looking-at " ") (just-one-space))))
11391 (when org-trigger-hook
11392 (save-excursion
11393 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11395 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11396 "Block turning an entry into a TODO, using the hierarchy.
11397 This checks whether the current task should be blocked from state
11398 changes. Such blocking occurs when:
11400 1. The task has children which are not all in a completed state.
11402 2. A task has a parent with the property :ORDERED:, and there
11403 are siblings prior to the current task with incomplete
11404 status.
11406 3. The parent of the task is blocked because it has siblings that should
11407 be done first, or is child of a block grandparent TODO entry."
11409 (if (not org-enforce-todo-dependencies)
11410 t ; if locally turned off don't block
11411 (catch 'dont-block
11412 ;; If this is not a todo state change, or if this entry is already DONE,
11413 ;; do not block
11414 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11415 (member (plist-get change-plist :from)
11416 (cons 'done org-done-keywords))
11417 (member (plist-get change-plist :to)
11418 (cons 'todo org-not-done-keywords))
11419 (not (plist-get change-plist :to)))
11420 (throw 'dont-block t))
11421 ;; If this task has children, and any are undone, it's blocked
11422 (save-excursion
11423 (org-back-to-heading t)
11424 (let ((this-level (funcall outline-level)))
11425 (outline-next-heading)
11426 (let ((child-level (funcall outline-level)))
11427 (while (and (not (eobp))
11428 (> child-level this-level))
11429 ;; this todo has children, check whether they are all
11430 ;; completed
11431 (if (and (not (org-entry-is-done-p))
11432 (org-entry-is-todo-p))
11433 (throw 'dont-block nil))
11434 (outline-next-heading)
11435 (setq child-level (funcall outline-level))))))
11436 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11437 ;; any previous siblings are undone, it's blocked
11438 (save-excursion
11439 (org-back-to-heading t)
11440 (let* ((pos (point))
11441 (parent-pos (and (org-up-heading-safe) (point))))
11442 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11443 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11444 (forward-line 1)
11445 (re-search-forward org-not-done-heading-regexp pos t))
11446 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11447 ;; Search further up the hierarchy, to see if an ancestor is blocked
11448 (while t
11449 (goto-char parent-pos)
11450 (if (not (looking-at org-not-done-heading-regexp))
11451 (throw 'dont-block t)) ; do not block, parent is not a TODO
11452 (setq pos (point))
11453 (setq parent-pos (and (org-up-heading-safe) (point)))
11454 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11455 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11456 (forward-line 1)
11457 (re-search-forward org-not-done-heading-regexp pos t))
11458 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11460 (defcustom org-track-ordered-property-with-tag nil
11461 "Should the ORDERED property also be shown as a tag?
11462 The ORDERED property decides if an entry should require subtasks to be
11463 completed in sequence. Since a property is not very visible, setting
11464 this option means that toggling the ORDERED property with the command
11465 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11466 not relevant for the behavior, but it makes things more visible.
11468 Note that toggling the tag with tags commands will not change the property
11469 and therefore not influence behavior!
11471 This can be t, meaning the tag ORDERED should be used, It can also be a
11472 string to select a different tag for this task."
11473 :group 'org-todo
11474 :type '(choice
11475 (const :tag "No tracking" nil)
11476 (const :tag "Track with ORDERED tag" t)
11477 (string :tag "Use other tag")))
11479 (defun org-toggle-ordered-property ()
11480 "Toggle the ORDERED property of the current entry.
11481 For better visibility, you can track the value of this property with a tag.
11482 See variable `org-track-ordered-property-with-tag'."
11483 (interactive)
11484 (let* ((t1 org-track-ordered-property-with-tag)
11485 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11486 (save-excursion
11487 (org-back-to-heading)
11488 (if (org-entry-get nil "ORDERED")
11489 (progn
11490 (org-delete-property "ORDERED")
11491 (and tag (org-toggle-tag tag 'off))
11492 (message "Subtasks can be completed in arbitrary order"))
11493 (org-entry-put nil "ORDERED" "t")
11494 (and tag (org-toggle-tag tag 'on))
11495 (message "Subtasks must be completed in sequence")))))
11497 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11498 (defun org-block-todo-from-checkboxes (change-plist)
11499 "Block turning an entry into a TODO, using checkboxes.
11500 This checks whether the current task should be blocked from state
11501 changes because there are unchecked boxes in this entry."
11502 (if (not org-enforce-todo-checkbox-dependencies)
11503 t ; if locally turned off don't block
11504 (catch 'dont-block
11505 ;; If this is not a todo state change, or if this entry is already DONE,
11506 ;; do not block
11507 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11508 (member (plist-get change-plist :from)
11509 (cons 'done org-done-keywords))
11510 (member (plist-get change-plist :to)
11511 (cons 'todo org-not-done-keywords))
11512 (not (plist-get change-plist :to)))
11513 (throw 'dont-block t))
11514 ;; If this task has checkboxes that are not checked, it's blocked
11515 (save-excursion
11516 (org-back-to-heading t)
11517 (let ((beg (point)) end)
11518 (outline-next-heading)
11519 (setq end (point))
11520 (goto-char beg)
11521 (if (org-list-search-forward
11522 (concat (org-item-beginning-re)
11525 end t)
11526 (progn
11527 (if (boundp 'org-blocked-by-checkboxes)
11528 (setq org-blocked-by-checkboxes t))
11529 (throw 'dont-block nil)))))
11530 t))) ; do not block
11532 (defun org-entry-blocked-p ()
11533 "Is the current entry blocked?"
11534 (if (org-entry-get nil "NOBLOCKING")
11535 nil ;; Never block this entry
11536 (not
11537 (run-hook-with-args-until-failure
11538 'org-blocker-hook
11539 (list :type 'todo-state-change
11540 :position (point)
11541 :from 'todo
11542 :to 'done)))))
11544 (defun org-update-statistics-cookies (all)
11545 "Update the statistics cookie, either from TODO or from checkboxes.
11546 This should be called with the cursor in a line with a statistics cookie."
11547 (interactive "P")
11548 (if all
11549 (progn
11550 (org-update-checkbox-count 'all)
11551 (org-map-entries 'org-update-parent-todo-statistics))
11552 (if (not (org-at-heading-p))
11553 (org-update-checkbox-count)
11554 (let ((pos (move-marker (make-marker) (point)))
11555 end l1 l2)
11556 (ignore-errors (org-back-to-heading t))
11557 (if (not (org-at-heading-p))
11558 (org-update-checkbox-count)
11559 (setq l1 (org-outline-level))
11560 (setq end (save-excursion
11561 (outline-next-heading)
11562 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11563 (point)))
11564 (if (and (save-excursion
11565 (re-search-forward
11567 (not (save-excursion (re-search-forward
11569 (org-update-checkbox-count)
11570 (if (and l2 (> l2 l1))
11571 (progn
11572 (goto-char end)
11573 (org-update-parent-todo-statistics))
11574 (goto-char pos)
11575 (beginning-of-line 1)
11576 (while (re-search-forward
11578 (point-at-eol) t)
11579 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11580 (goto-char pos)
11581 (move-marker pos nil)))))
11583 (defvar org-entry-property-inherited-from) ;; defined below
11584 (defun org-update-parent-todo-statistics ()
11585 "Update any statistics cookie in the parent of the current headline.
11586 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11587 the entire subtree and this will travel up the hierarchy and update
11588 statistics everywhere."
11589 (let* ((prop (save-excursion (org-up-heading-safe)
11590 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11591 (recursive (or (not org-hierarchical-todo-statistics)
11593 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11594 0))
11595 (first t)
11597 level ltoggle l1 new ndel
11598 (cnt-all 0) (cnt-done 0) is-percent kwd
11599 checkbox-beg ov ovs ove cookie-present)
11600 (catch 'exit
11601 (save-excursion
11602 (beginning-of-line 1)
11603 (setq ltoggle (funcall outline-level))
11604 ;; Three situations are to consider:
11606 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11607 ;; to the top-level ancestor on the headline;
11609 ;; 2. If parent has "recursive" property, repeat up to the
11610 ;; headline setting that property, taking inheritance into
11611 ;; account;
11613 ;; 3. Else, move up to direct parent and proceed only once.
11614 (while (and (setq level (org-up-heading-safe))
11615 (or recursive first)
11616 (>= (point) lim))
11617 (setq first nil cookie-present nil)
11618 (unless (and level
11619 (not (string-match
11621 (downcase (or (org-entry-get nil "COOKIE_DATA")
11622 "")))))
11623 (throw 'exit nil))
11624 (while (re-search-forward box-re (point-at-eol) t)
11625 (setq cnt-all 0 cnt-done 0 cookie-present t)
11626 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11627 (save-match-data
11628 (unless (outline-next-heading) (throw 'exit nil))
11629 (while (and (looking-at org-complex-heading-regexp)
11630 (> (setq l1 (length (match-string 1))) level))
11631 (setq kwd (and (or recursive (= l1 ltoggle))
11632 (match-string 2)))
11633 (if (or (eq org-provide-todo-statistics 'all-headlines)
11634 (and (listp org-provide-todo-statistics)
11635 (or (member kwd org-provide-todo-statistics)
11636 (member kwd org-done-keywords))))
11637 (setq cnt-all (1+ cnt-all))
11638 (if (eq org-provide-todo-statistics t)
11639 (and kwd (setq cnt-all (1+ cnt-all)))))
11640 (and (member kwd org-done-keywords)
11641 (setq cnt-done (1+ cnt-done)))
11642 (outline-next-heading)))
11643 (setq new
11644 (if is-percent
11645 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11646 (format "[%d/%d]" cnt-done cnt-all))
11647 ndel (- (match-end 0) checkbox-beg))
11648 ;; handle overlays when updating cookie from column view
11649 (when (setq ov (car (overlays-at checkbox-beg)))
11650 (setq ovs (overlay-start ov) ove (overlay-end ov))
11651 (delete-overlay ov))
11652 (goto-char checkbox-beg)
11653 (insert new)
11654 (delete-region (point) (+ (point) ndel))
11655 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11656 (when ov (move-overlay ov ovs ove)))
11657 (when cookie-present
11658 (run-hook-with-args 'org-after-todo-statistics-hook
11659 cnt-done (- cnt-all cnt-done))))))
11660 (run-hooks 'org-todo-statistics-hook)))
11662 (defvar org-after-todo-statistics-hook nil
11663 "Hook that is called after a TODO statistics cookie has been updated.
11664 Each function is called with two arguments: the number of not-done entries
11665 and the number of done entries.
11667 For example, the following function, when added to this hook, will switch
11668 an entry to DONE when all children are done, and back to TODO when new
11669 entries are set to a TODO status. Note that this hook is only called
11670 when there is a statistics cookie in the headline!
11672 (defun org-summary-todo (n-done n-not-done)
11674 (let (org-log-done org-log-states) ; turn off logging
11676 ")
11678 (defvar org-todo-statistics-hook nil
11679 "Hook that is run whenever Org thinks TODO statistics should be updated.
11680 This hook runs even if there is no statistics cookie present, in which case
11681 `org-after-todo-statistics-hook' would not run.")
11683 (defun org-todo-trigger-tag-changes (state)
11684 "Apply the changes defined in `org-todo-state-tags-triggers'."
11685 (let ((l org-todo-state-tags-triggers)
11686 changes)
11687 (when (or (not state) (equal state ""))
11688 (setq changes (append changes (cdr (assoc "" l)))))
11689 (when (and (stringp state) (> (length state) 0))
11690 (setq changes (append changes (cdr (assoc state l)))))
11691 (when (member state org-not-done-keywords)
11692 (setq changes (append changes (cdr (assoc 'todo l)))))
11693 (when (member state org-done-keywords)
11694 (setq changes (append changes (cdr (assoc 'done l)))))
11695 (dolist (c changes)
11696 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11698 (defun org-local-logging (value)
11699 "Get logging settings from a property VALUE."
11700 (let* (words w a)
11701 ;; directly set the variables, they are already local.
11702 (setq org-log-done nil
11703 org-log-repeat nil
11704 org-todo-log-states nil)
11705 (setq words (org-split-string value))
11706 (while (setq w (pop words))
11707 (cond
11708 ((setq a (assoc w org-startup-options))
11709 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11710 (set (nth 1 a) (nth 2 a))))
11711 ((setq a (org-extract-log-state-settings w))
11712 (and (member (car a) org-todo-keywords-1)
11713 (push a org-todo-log-states)))))))
11715 (defun org-get-todo-sequence-head (kwd)
11716 "Return the head of the TODO sequence to which KWD belongs.
11717 If KWD is not set, check if there is a text property remembering the
11718 right sequence."
11719 (let (p)
11720 (cond
11721 ((not kwd)
11722 (or (get-text-property (point-at-bol) 'org-todo-head)
11723 (progn
11724 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11725 nil (point-at-eol)))
11726 (get-text-property p 'org-todo-head))))
11727 ((not (member kwd org-todo-keywords-1))
11728 (car org-todo-keywords-1))
11729 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11731 (defun org-fast-todo-selection ()
11732 "Fast TODO keyword selection with single keys.
11733 Returns the new TODO keyword, or nil if no state change should occur."
11734 (let* ((fulltable org-todo-key-alist)
11735 (done-keywords org-done-keywords) ;; needed for the faces.
11736 (maxlen (apply 'max (mapcar
11737 (lambda (x)
11738 (if (stringp (car x)) (string-width (car x)) 0))
11739 fulltable)))
11740 (expert nil)
11741 (fwidth (+ maxlen 3 1 3))
11742 (ncol (/ (- (window-width) 4) fwidth))
11743 tg cnt e c tbl
11744 groups ingroup)
11745 (save-excursion
11746 (save-window-excursion
11747 (if expert
11748 (set-buffer (get-buffer-create " *Org todo*"))
11749 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11750 (erase-buffer)
11751 (org-set-local 'org-done-keywords done-keywords)
11752 (setq tbl fulltable cnt 0)
11753 (while (setq e (pop tbl))
11754 (cond
11755 ((equal e '(:startgroup))
11756 (push '() groups) (setq ingroup t)
11757 (when (not (= cnt 0))
11758 (setq cnt 0)
11760 (insert "{ "))
11761 ((equal e '(:endgroup))
11762 (setq ingroup nil cnt 0)
11764 ((equal e '(:newline))
11765 (when (not (= cnt 0))
11766 (setq cnt 0)
11768 (setq e (car tbl))
11769 (while (equal (car tbl) '(:newline))
11771 (setq tbl (cdr tbl)))))
11772 (t
11773 (setq tg (car e) c (cdr e))
11774 (if ingroup (push tg (car groups)))
11775 (setq tg (org-add-props tg nil 'face
11776 (org-get-todo-face tg)))
11777 (if (and (= cnt 0) (not ingroup)) (insert " "))
11778 (insert "[" c "] " tg (make-string
11779 (- fwidth 4 (length tg)) ?\ ))
11780 (when (= (setq cnt (1+ cnt)) ncol)
11782 (if ingroup (insert " "))
11783 (setq cnt 0)))))
11785 (goto-char (point-min))
11786 (if (not expert) (org-fit-window-to-buffer))
11787 (message "[a-z..]:Set [SPC]:clear")
11788 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11789 (cond
11790 ((or (= c ?\C-g)
11791 (and (= c ?q) (not (rassoc c fulltable))))
11792 (setq quit-flag t))
11793 ((= c ?\ ) nil)
11794 ((setq e (rassoc c fulltable) tg (car e))
11795 tg)
11796 (t (setq quit-flag t)))))))
11798 (defun org-entry-is-todo-p ()
11799 (member (org-get-todo-state) org-not-done-keywords))
11801 (defun org-entry-is-done-p ()
11802 (member (org-get-todo-state) org-done-keywords))
11804 (defun org-get-todo-state ()
11805 (save-excursion
11806 (org-back-to-heading t)
11807 (and (looking-at org-todo-line-regexp)
11808 (match-end 2)
11809 (match-string 2))))
11811 (defun org-at-date-range-p (&optional inactive-ok)
11812 "Is the cursor inside a date range?"
11813 (interactive)
11814 (save-excursion
11815 (catch 'exit
11816 (let ((pos (point)))
11818 (skip-chars-backward "<[")
11819 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11820 (>= (match-end 0) pos)
11821 (throw 'exit t))
11823 (skip-chars-backward "<[")
11824 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11825 (>= (match-end 0) pos)
11826 (throw 'exit t)))
11827 nil)))
11829 (defun org-get-repeat (&optional tagline)
11830 "Check if there is a deadline/schedule with repeater in this entry."
11831 (save-match-data
11832 (save-excursion
11833 (org-back-to-heading t)
11834 (and (re-search-forward (if tagline
11836 org-repeat-re)
11837 (org-entry-end-position) t)
11838 (match-string-no-properties 1)))))
11840 (defvar org-last-changed-timestamp)
11841 (defvar org-last-inserted-timestamp)
11842 (defvar org-log-post-message)
11843 (defvar org-log-note-purpose)
11844 (defvar org-log-note-how)
11845 (defvar org-log-note-extra)
11846 (defun org-auto-repeat-maybe (done-word)
11847 "Check if the current headline contains a repeated deadline/schedule.
11848 If yes, set TODO state back to what it was and change the base date
11849 of repeating deadline/scheduled time stamps to new date.
11850 This function is run automatically after each state change to a DONE state."
11851 ;; last-state is dynamically scoped into this function
11852 (let* ((repeat (org-get-repeat))
11853 (aa (assoc last-state org-todo-kwd-alist))
11854 (interpret (nth 1 aa))
11855 (head (nth 2 aa))
11856 (whata '(("d" . day) ("m" . month) ("y" . year)))
11857 (msg "Entry repeats: ")
11858 (org-log-done nil)
11859 (org-todo-log-states nil)
11860 re type n what ts time to-state)
11861 (when repeat
11862 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11863 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11864 org-todo-repeat-to-state))
11865 (unless (and to-state (member to-state org-todo-keywords-1))
11866 (setq to-state (if (eq interpret 'type) last-state head)))
11867 (org-todo to-state)
11868 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11869 (org-entry-put nil "LAST_REPEAT" (format-time-string
11870 (org-time-stamp-format t t))))
11871 (when org-log-repeat
11872 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11873 (memq 'org-add-log-note post-command-hook))
11874 ;; OK, we are already setup for some record
11875 (if (eq org-log-repeat 'note)
11876 ;; make sure we take a note, not only a time stamp
11877 (setq org-log-note-how 'note))
11878 ;; Set up for taking a record
11879 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11880 last-state
11881 'findpos org-log-repeat)))
11882 (org-back-to-heading t)
11883 (org-add-planning-info nil nil 'closed)
11887 (while (re-search-forward
11888 re (save-excursion (outline-next-heading) (point)) t)
11889 (setq type (if (match-end 1) org-scheduled-string
11890 (if (match-end 3) org-deadline-string "Plain:"))
11891 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11893 (setq n (string-to-number (match-string 2 ts))
11894 what (match-string 3 ts))
11895 (if (equal what "w") (setq n (* n 7) what "d"))
11896 ;; Preparation, see if we need to modify the start date for the change
11897 (when (match-end 1)
11898 (setq time (save-match-data (org-time-string-to-time ts)))
11899 (cond
11900 ((equal (match-string 1 ts) ".")
11901 ;; Shift starting date to today
11902 (org-timestamp-change
11903 (- (org-today) (time-to-days time))
11904 'day))
11905 ((equal (match-string 1 ts) "+")
11906 (let ((nshiftmax 10) (nshift 0))
11907 (while (or (= nshift 0)
11908 (<= (time-to-days time)
11909 (time-to-days (current-time))))
11910 (when (= (incf nshift) nshiftmax)
11911 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11912 (error "Abort")))
11913 (org-timestamp-change n (cdr (assoc what whata)))
11914 (org-at-timestamp-p t)
11915 (setq ts (match-string 1))
11916 (setq time (save-match-data (org-time-string-to-time ts)))))
11917 (org-timestamp-change (- n) (cdr (assoc what whata)))
11918 ;; rematch, so that we have everything in place for the real shift
11919 (org-at-timestamp-p t)
11920 (setq ts (match-string 1))
11922 (org-timestamp-change n (cdr (assoc what whata)))
11923 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11924 (setq org-log-post-message msg)
11925 (message "%s" msg))))
11927 (defun org-show-todo-tree (arg)
11928 "Make a compact tree which shows all headlines marked with TODO.
11929 The tree will show the lines where the regexp matches, and all higher
11930 headlines above the match.
11932 With a numeric prefix N, construct a sparse tree for the Nth element
11933 of `org-todo-keywords-1'."
11934 (interactive "P")
11935 (let ((case-fold-search nil)
11936 (kwd-re
11937 (cond ((null arg) org-not-done-regexp)
11938 ((equal arg '(4))
11939 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11940 (mapcar 'list org-todo-keywords-1))))
11944 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11945 (regexp-quote (nth (1- (prefix-numeric-value arg))
11946 org-todo-keywords-1)))
11947 (t (error "Invalid prefix argument: %s" arg)))))
11948 (message "%d TODO entries found"
11949 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11951 (defun org-deadline (&optional remove time)
11953 With argument REMOVE, remove any deadline from the item.
11954 With argument TIME, set the deadline at the corresponding date. TIME
11956 (interactive "P")
11957 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11958 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11959 'region-start-level 'region))
11960 org-loop-over-headlines-in-active-region)
11961 (org-map-entries
11962 `(org-deadline ',remove ,time)
11963 org-loop-over-headlines-in-active-region
11964 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11965 (let* ((old-date (org-entry-get nil "DEADLINE"))
11966 (repeater (and old-date
11967 (string-match
11969 old-date)
11970 (match-string 1 old-date))))
11971 (if remove
11972 (progn
11973 (when (and old-date org-log-redeadline)
11974 (org-add-log-setup 'deldeadline nil old-date 'findpos
11975 org-log-redeadline))
11976 (org-remove-timestamp-with-keyword org-deadline-string)
11977 (message "Item no longer has a deadline."))
11978 (org-add-planning-info 'deadline time 'closed)
11979 (when (and old-date org-log-redeadline
11980 (not (equal old-date
11981 (substring org-last-inserted-timestamp 1 -1))))
11982 (org-add-log-setup 'redeadline nil old-date 'findpos
11983 org-log-redeadline))
11984 (when repeater
11985 (save-excursion
11986 (org-back-to-heading t)
11987 (when (re-search-forward (concat org-deadline-string " "
11988 org-last-inserted-timestamp)
11989 (save-excursion
11990 (outline-next-heading) (point)) t)
11991 (goto-char (1- (match-end 0)))
11992 (insert " " repeater)
11993 (setq org-last-inserted-timestamp
11994 (concat (substring org-last-inserted-timestamp 0 -1)
11995 " " repeater
11996 (substring org-last-inserted-timestamp -1))))))
11997 (message "Deadline on %s" org-last-inserted-timestamp)))))
11999 (defun org-schedule (&optional remove time)
12000 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12001 With argument REMOVE, remove any scheduling date from the item.
12002 With argument TIME, scheduled at the corresponding date. TIME can
12004 (interactive "P")
12005 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12006 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12007 'region-start-level 'region))
12008 org-loop-over-headlines-in-active-region)
12009 (org-map-entries
12010 `(org-schedule ',remove ,time)
12011 org-loop-over-headlines-in-active-region
12012 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12013 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12014 (repeater (and old-date
12015 (string-match
12017 old-date)
12018 (match-string 1 old-date))))
12019 (if remove
12020 (progn
12021 (when (and old-date org-log-reschedule)
12022 (org-add-log-setup 'delschedule nil old-date 'findpos
12023 org-log-reschedule))
12024 (org-remove-timestamp-with-keyword org-scheduled-string)
12025 (message "Item is no longer scheduled."))
12026 (org-add-planning-info 'scheduled time 'closed)
12027 (when (and old-date org-log-reschedule
12028 (not (equal old-date
12029 (substring org-last-inserted-timestamp 1 -1))))
12030 (org-add-log-setup 'reschedule nil old-date 'findpos
12031 org-log-reschedule))
12032 (when repeater
12033 (save-excursion
12034 (org-back-to-heading t)
12035 (when (re-search-forward (concat org-scheduled-string " "
12036 org-last-inserted-timestamp)
12037 (save-excursion
12038 (outline-next-heading) (point)) t)
12039 (goto-char (1- (match-end 0)))
12040 (insert " " repeater)
12041 (setq org-last-inserted-timestamp
12042 (concat (substring org-last-inserted-timestamp 0 -1)
12043 " " repeater
12044 (substring org-last-inserted-timestamp -1))))))
12045 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12047 (defun org-get-scheduled-time (pom &optional inherit)
12048 "Get the scheduled time as a time tuple, of a format suitable
12049 for calling org-schedule with, or if there is no scheduling,
12050 returns nil."
12051 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12052 (when time
12053 (apply 'encode-time (org-parse-time-string time)))))
12055 (defun org-get-deadline-time (pom &optional inherit)
12056 "Get the deadline as a time tuple, of a format suitable for
12057 calling org-deadline with, or if there is no scheduling, returns
12058 nil."
12059 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12060 (when time
12061 (apply 'encode-time (org-parse-time-string time)))))
12063 (defun org-remove-timestamp-with-keyword (keyword)
12064 "Remove all time stamps with KEYWORD in the current entry."
12066 beg)
12067 (save-excursion
12068 (org-back-to-heading t)
12069 (setq beg (point))
12070 (outline-next-heading)
12071 (while (re-search-backward re beg t)
12072 (replace-match "")
12074 (equal (char-before) ?\ ))
12075 (backward-delete-char 1)
12077 (point-at-bol) (point-at-eol)))
12078 (delete-region (point-at-bol)
12079 (min (point-max) (1+ (point-at-eol))))))))))
12081 (defun org-add-planning-info (what &optional time &rest remove)
12082 "Insert new timestamp with keyword in the line directly after the headline.
12083 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12084 If non is given, the user is prompted for a date.
12085 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12086 be removed."
12087 (interactive)
12088 (let (org-time-was-given org-end-time-was-given ts
12089 end default-time default-input)
12091 (catch 'exit
12092 (when (and (memq what '(scheduled deadline))
12093 (or (not time)
12094 (and (stringp time)
12095 (string-match "^[-+]+[0-9]" time))))
12096 ;; Try to get a default date/time from existing timestamp
12097 (save-excursion
12098 (org-back-to-heading t)
12099 (setq end (save-excursion (outline-next-heading) (point)))
12100 (when (re-search-forward (if (eq what 'scheduled)
12101 org-scheduled-time-regexp
12102 org-deadline-time-regexp)
12103 end t)
12104 (setq ts (match-string 1)
12105 default-time
12106 (apply 'encode-time (org-parse-time-string ts))
12107 default-input (and ts (org-get-compact-tod ts))))))
12108 (when what
12109 (setq time
12110 (if (stringp time)
12111 ;; This is a string (relative or absolute), set proper date
12112 (apply 'encode-time
12113 (org-read-date-analyze
12114 time default-time (decode-time default-time)))
12115 ;; If necessary, get the time from the user
12116 (or time (org-read-date nil 'to-time nil nil
12117 default-time default-input)))))
12119 (when (and org-insert-labeled-timestamps-at-point
12120 (member what '(scheduled deadline)))
12121 (insert
12122 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12123 (org-insert-time-stamp time org-time-was-given
12124 nil nil nil (list org-end-time-was-given))
12125 (setq what nil))
12126 (save-excursion
12127 (save-restriction
12128 (let (col list elt ts buffer-invisibility-spec)
12129 (org-back-to-heading t)
12131 (goto-char (match-end 1))
12132 (setq col (current-column))
12133 (goto-char (match-end 0))
12135 (when (and (not what)
12136 (not (looking-at
12138 org-keyword-time-not-clock-regexp))))
12139 ;; Nothing to add, nothing to remove...... :-)
12140 (throw 'exit nil))
12141 (if (and (not (looking-at org-outline-regexp))
12144 (not (equal (match-string 1) org-clock-string)))
12145 (narrow-to-region (match-beginning 0) (match-end 0))
12147 (backward-char 1)
12148 (narrow-to-region (point) (point))
12149 (and org-adapt-indentation (org-indent-to-column col)))
12150 ;; Check if we have to remove something.
12151 (setq list (cons what remove))
12152 (while list
12153 (setq elt (pop list))
12154 (when (or (and (eq elt 'scheduled)
12155 (re-search-forward org-scheduled-time-regexp nil t))
12156 (and (eq elt 'deadline)
12157 (re-search-forward org-deadline-time-regexp nil t))
12158 (and (eq elt 'closed)
12159 (re-search-forward org-closed-time-regexp nil t)))
12160 (replace-match "")
12161 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12163 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12164 (when what
12165 (insert
12166 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12167 (cond ((eq what 'scheduled) org-scheduled-string)
12168 ((eq what 'deadline) org-deadline-string)
12169 ((eq what 'closed) org-closed-string))
12170 " ")
12171 (setq ts (org-insert-time-stamp
12172 time
12173 (or org-time-was-given
12174 (and (eq what 'closed) org-log-done-with-time))
12175 (eq what 'closed)
12176 nil nil (list org-end-time-was-given)))
12177 (insert
12178 (if (not (or (bolp) (eq (char-before) ?\ )
12179 (memq (char-after) '(32 10))
12180 (eobp))) " " ""))
12181 (end-of-line 1))
12182 (goto-char (point-min))
12183 (widen)
12186 (delete-region (1- (point)) (point-at-eol)))
12187 ts))))))
12189 (defvar org-log-note-marker (make-marker))
12190 (defvar org-log-note-purpose nil)
12191 (defvar org-log-note-state nil)
12192 (defvar org-log-note-previous-state nil)
12193 (defvar org-log-note-how nil)
12194 (defvar org-log-note-extra nil)
12195 (defvar org-log-note-window-configuration nil)
12196 (defvar org-log-note-return-to (make-marker))
12197 (defvar org-log-note-effective-time nil
12198 "Remembered current time so that dynamically scoped
12199 `org-extend-today-until' affects tha timestamps in state change
12200 log")
12202 (defvar org-log-post-message nil
12203 "Message to be displayed after a log note has been stored.
12204 The auto-repeater uses this.")
12206 (defun org-add-note ()
12207 "Add a note to the current entry.
12208 This is done in the same way as adding a state change note."
12209 (interactive)
12210 (org-add-log-setup 'note nil nil 'findpos nil))
12212 (defvar org-property-end-re)
12213 (defun org-add-log-setup (&optional purpose state prev-state
12214 findpos how extra)
12215 "Set up the post command hook to take a note.
12216 If this is about to TODO state change, the new state is expected in STATE.
12217 When FINDPOS is non-nil, find the correct position for the note in
12218 the current entry. If not, assume that it can be inserted at point.
12219 HOW is an indicator what kind of note should be created.
12220 EXTRA is additional text that will be inserted into the notes buffer."
12221 (let* ((org-log-into-drawer (org-log-into-drawer))
12222 (drawer (cond ((stringp org-log-into-drawer)
12223 org-log-into-drawer)
12224 (org-log-into-drawer "LOGBOOK")
12225 (t nil))))
12226 (save-restriction
12227 (save-excursion
12228 (when findpos
12229 (org-back-to-heading t)
12230 (narrow-to-region (point) (save-excursion
12231 (outline-next-heading) (point)))
12235 (goto-char (match-end 0))
12236 (cond
12237 (drawer
12239 nil t)
12240 (progn
12241 (goto-char (match-end 0))
12242 (or org-log-states-order-reversed
12243 (and (re-search-forward org-property-end-re nil t)
12244 (goto-char (1- (match-beginning 0))))))
12246 (beginning-of-line 0)
12247 (org-indent-line-function)
12248 (beginning-of-line 2)
12249 (org-indent-line-function)
12250 (end-of-line 0)))
12251 ((and org-log-state-notes-insert-after-drawers
12252 (save-excursion
12253 (forward-line) (looking-at org-drawer-regexp)))
12254 (forward-line)
12255 (while (looking-at org-drawer-regexp)
12256 (goto-char (match-end 0))
12257 (re-search-forward org-property-end-re (point-max) t)
12258 (forward-line))
12259 (forward-line -1)))
12260 (unless org-log-states-order-reversed
12262 (org-skip-over-state-notes)
12264 (move-marker org-log-note-marker (point))
12265 (setq org-log-note-purpose purpose
12266 org-log-note-state state
12267 org-log-note-previous-state prev-state
12268 org-log-note-how how
12269 org-log-note-extra extra
12270 org-log-note-effective-time (org-current-effective-time))
12271 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12273 (defun org-skip-over-state-notes ()
12274 "Skip past the list of State notes in an entry."
12276 (when (ignore-errors (goto-char (org-in-item-p)))
12277 (let* ((struct (org-list-struct))
12278 (prevs (org-list-prevs-alist struct)))
12280 (goto-char (or (org-list-get-next-item (point) struct prevs)
12281 (org-list-get-item-end (point) struct)))))))
12283 (defun org-add-log-note (&optional purpose)
12284 "Pop up a window for taking a note, and add this note later at point."
12285 (remove-hook 'post-command-hook 'org-add-log-note)
12286 (setq org-log-note-window-configuration (current-window-configuration))
12287 (delete-other-windows)
12288 (move-marker org-log-note-return-to (point))
12289 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12290 (goto-char org-log-note-marker)
12291 (org-switch-to-buffer-other-window "*Org Note*")
12292 (erase-buffer)
12293 (if (memq org-log-note-how '(time state))
12294 (let (current-prefix-arg) (org-store-log-note))
12295 (let ((org-inhibit-startup t)) (org-mode))
12296 (insert (format "# Insert note for %s.
12298 (cond
12299 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12300 ((eq org-log-note-purpose 'done) "closed todo item")
12301 ((eq org-log-note-purpose 'state)
12303 (or org-log-note-previous-state "")
12304 (or org-log-note-state "")))
12305 ((eq org-log-note-purpose 'reschedule)
12306 "rescheduling")
12307 ((eq org-log-note-purpose 'delschedule)
12308 "no longer scheduled")
12309 ((eq org-log-note-purpose 'redeadline)
12310 "changing deadline")
12311 ((eq org-log-note-purpose 'deldeadline)
12312 "removing deadline")
12313 ((eq org-log-note-purpose 'refile)
12314 "refiling")
12315 ((eq org-log-note-purpose 'note)
12316 "this entry")
12317 (t (error "This should not happen")))))
12318 (if org-log-note-extra (insert org-log-note-extra))
12319 (org-set-local 'org-finish-function 'org-store-log-note)
12320 (run-hooks 'org-log-buffer-setup-hook)))
12322 (defvar org-note-abort nil) ; dynamically scoped
12323 (defun org-store-log-note ()
12324 "Finish taking a log note, and insert it to where it belongs."
12325 (let ((txt (buffer-string))
12326 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12327 lines ind bul)
12328 (kill-buffer (current-buffer))
12330 (setq txt (replace-match "" t t txt)))
12332 (setq txt (replace-match "" t t txt)))
12335 (setq note
12336 (org-replace-escapes
12337 note
12338 (list (cons "%u" (user-login-name))
12339 (cons "%U" user-full-name)
12340 (cons "%t" (format-time-string
12341 (org-time-stamp-format 'long 'inactive)
12342 org-log-note-effective-time))
12343 (cons "%T" (format-time-string
12344 (org-time-stamp-format 'long nil)
12345 org-log-note-effective-time))
12346 (cons "%d" (format-time-string
12347 (org-time-stamp-format nil 'inactive)
12348 org-log-note-effective-time))
12349 (cons "%D" (format-time-string
12350 (org-time-stamp-format nil nil)
12351 org-log-note-effective-time))
12352 (cons "%s" (if org-log-note-state
12354 ""))
12355 (cons "%S" (if org-log-note-previous-state
12359 (push note lines))
12360 (when (or current-prefix-arg org-note-abort)
12361 (when org-log-into-drawer
12362 (org-remove-empty-drawer-at
12363 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12364 org-log-note-marker))
12365 (setq lines nil))
12366 (when lines
12367 (with-current-buffer (marker-buffer org-log-note-marker)
12368 (save-excursion
12369 (goto-char org-log-note-marker)
12370 (move-marker org-log-note-marker nil)
12371 (end-of-line 1)
12373 (setq ind (save-excursion
12374 (if (ignore-errors (goto-char (org-in-item-p)))
12375 (let ((struct (org-list-struct)))
12376 (org-list-get-ind
12377 (org-list-get-top-point struct) struct))
12379 (cond
12380 ((and (org-at-heading-p)
12381 org-adapt-indentation)
12382 (1+ (org-current-level)))
12383 ((org-at-heading-p) 0)
12384 (t (org-get-indentation))))))
12385 (setq bul (org-list-bullet-string "-"))
12386 (org-indent-line-to ind)
12387 (insert bul (pop lines))
12388 (let ((ind-body (+ (length bul) ind)))
12389 (while lines
12391 (org-indent-line-to ind-body)
12392 (insert (pop lines))))
12393 (message "Note stored")
12394 (org-back-to-heading t)
12395 (org-cycle-hide-drawers 'children)))))
12396 (set-window-configuration org-log-note-window-configuration)
12397 (with-current-buffer (marker-buffer org-log-note-return-to)
12398 (goto-char org-log-note-return-to))
12399 (move-marker org-log-note-return-to nil)
12400 (and org-log-post-message (message "%s" org-log-post-message)))
12402 (defun org-remove-empty-drawer-at (drawer pos)
12403 "Remove an empty drawer DRAWER at position POS.
12404 POS may also be a marker."
12405 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12406 (save-excursion
12407 (save-restriction
12408 (widen)
12409 (goto-char pos)
12410 (if (org-in-regexp
12412 (replace-match ""))))))
12414 (defun org-sparse-tree (&optional arg)
12415 "Create a sparse tree, prompt for the details.
12416 This command can create sparse trees. You first need to select the type
12417 of match used to create the tree:
12419 t Show all TODO entries.
12420 T Show entries with a specific TODO keyword.
12421 m Show entries selected by a tags/property match.
12422 p Enter a property name and its value (both with completion on existing
12423 names/values) and show entries with that property.
12424 r Show entries matching a regular expression (`/' can be used as well)
12425 d Show deadlines due within `org-deadline-warning-days'.
12426 b Show deadlines and scheduled items before a date.
12427 a Show deadlines and scheduled items after a date."
12428 (interactive "P")
12429 (let (ans kwd value)
12430 (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")
12431 (setq ans (read-char-exclusive))
12432 (cond
12433 ((equal ans ?d)
12434 (call-interactively 'org-check-deadlines))
12435 ((equal ans ?b)
12436 (call-interactively 'org-check-before-date))
12437 ((equal ans ?a)
12438 (call-interactively 'org-check-after-date))
12439 ((equal ans ?D)
12440 (call-interactively 'org-check-dates-range))
12441 ((equal ans ?t)
12442 (org-show-todo-tree nil))
12443 ((equal ans ?T)
12444 (org-show-todo-tree '(4)))
12445 ((member ans '(?T ?m))
12446 (call-interactively 'org-match-sparse-tree))
12447 ((member ans '(?p ?P))
12448 (setq kwd (org-icompleting-read "Property: "
12449 (mapcar 'list (org-buffer-property-keys))))
12450 (setq value (org-icompleting-read "Value: "
12451 (mapcar 'list (org-property-values kwd))))
12454 (org-match-sparse-tree arg (concat kwd "=" value)))
12455 ((member ans '(?r ?R ?/))
12456 (call-interactively 'org-occur))
12459 (defvar org-occur-highlights nil
12460 "List of overlays used for occur matches.")
12461 (make-variable-buffer-local 'org-occur-highlights)
12462 (defvar org-occur-parameters nil
12463 "Parameters of the active org-occur calls.
12464 This is a list, each call to org-occur pushes as cons cell,
12465 containing the regular expression and the callback, onto the list.
12466 The list can contain several entries if `org-occur' has been called
12467 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12468 will only contain one set of parameters. When the highlights are
12469 removed (for example with `C-c C-c', or with the next edit (depending
12470 on `org-remove-highlights-with-change'), this variable is emptied
12471 as well.")
12472 (make-variable-buffer-local 'org-occur-parameters)
12474 (defun org-occur (regexp &optional keep-previous callback)
12475 "Make a compact tree which shows all matches of REGEXP.
12476 The tree will show the lines where the regexp matches, and all higher
12477 headlines above the match. It will also show the heading after the match,
12478 to make sure editing the matching entry is easy.
12479 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12480 call to `org-occur' will be kept, to allow stacking of calls to this
12481 command.
12482 If CALLBACK is non-nil, it is a function which is called to confirm
12483 that the match should indeed be shown."
12485 (when (equal regexp "")
12486 (error "Regexp cannot be empty"))
12487 (unless keep-previous
12488 (org-remove-occur-highlights nil nil t))
12489 (push (cons regexp callback) org-occur-parameters)
12490 (let ((cnt 0))
12491 (save-excursion
12492 (goto-char (point-min))
12493 (if (or (not keep-previous) ; do not want to keep
12494 (not org-occur-highlights)) ; no previous matches
12495 ;; hide everything
12496 (org-overview))
12497 (while (re-search-forward regexp nil t)
12498 (when (or (not callback)
12499 (save-match-data (funcall callback)))
12500 (setq cnt (1+ cnt))
12501 (when org-highlight-sparse-tree-matches
12502 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12503 (org-show-context 'occur-tree))))
12504 (when org-remove-highlights-with-change
12505 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12506 nil 'local))
12507 (unless org-sparse-tree-open-archived-trees
12508 (org-hide-archived-subtrees (point-min) (point-max)))
12509 (run-hooks 'org-occur-hook)
12510 (if (org-called-interactively-p 'interactive)
12511 (message "%d match(es) for regexp %s" cnt regexp))
12512 cnt))
12514 (defun org-occur-next-match (&optional n reset)
12515 "Function for `next-error-function' to find sparse tree matches.
12516 N is the number of matches to move, when negative move backwards.
12517 RESET is entirely ignored - this function always goes back to the
12518 starting point when no match is found."
12519 (let* ((limit (if (< n 0) (point-min) (point-max)))
12520 (search-func (if (< n 0)
12521 'previous-single-char-property-change
12522 'next-single-char-property-change))
12523 (n (abs n))
12524 (pos (point))
12525 p1)
12526 (catch 'exit
12527 (while (setq p1 (funcall search-func (point) 'org-type))
12528 (when (equal p1 limit)
12529 (goto-char pos)
12530 (error "No more matches"))
12531 (when (equal (get-char-property p1 'org-type) 'org-occur)
12532 (setq n (1- n))
12533 (when (= n 0)
12534 (goto-char p1)
12535 (throw 'exit (point))))
12536 (goto-char p1))
12537 (goto-char p1)
12538 (error "No more matches"))))
12540 (defun org-show-context (&optional key)
12541 "Make sure point and context are visible.
12542 How much context is shown depends upon the variables
12543 `org-show-hierarchy-above', `org-show-following-heading',
12544 `org-show-entry-below' and `org-show-siblings'."
12545 (let ((heading-p (org-at-heading-p t))
12546 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12547 (following-p (org-get-alist-option org-show-following-heading key))
12548 (entry-p (org-get-alist-option org-show-entry-below key))
12549 (siblings-p (org-get-alist-option org-show-siblings key)))
12550 (catch 'exit
12551 ;; Show heading or entry text
12552 (if (and heading-p (not entry-p))
12553 (org-flag-heading nil) ; only show the heading
12554 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12555 (org-show-hidden-entry))) ; show entire entry
12556 (when following-p
12557 ;; Show next sibling, or heading below text
12558 (save-excursion
12559 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12560 (org-flag-heading nil))))
12561 (when siblings-p (org-show-siblings))
12562 (when hierarchy-p
12563 ;; show all higher headings, possibly with siblings
12564 (save-excursion
12565 (while (and (condition-case nil
12566 (progn (org-up-heading-all 1) t)
12567 (error nil))
12568 (not (bobp)))
12569 (org-flag-heading nil)
12570 (when siblings-p (org-show-siblings))))))))
12572 (defvar org-reveal-start-hook nil
12573 "Hook run before revealing a location.")
12575 (defun org-reveal (&optional siblings)
12576 "Show current entry, hierarchy above it, and the following headline.
12577 This can be used to show a consistent set of context around locations
12578 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12579 not t for the search context.
12581 With optional argument SIBLINGS, on each level of the hierarchy all
12582 siblings are shown. This repairs the tree structure to what it would
12583 look like when opened with hierarchical calls to `org-cycle'.
12585 go to the parent and show the
12586 entire tree."
12587 (interactive "P")
12588 (run-hooks 'org-reveal-start-hook)
12589 (let ((org-show-hierarchy-above t)
12590 (org-show-following-heading t)
12591 (org-show-siblings (if siblings t org-show-siblings)))
12592 (org-show-context nil))
12593 (when (equal siblings '(16))
12594 (save-excursion
12595 (when (org-up-heading-safe)
12596 (org-show-subtree)
12597 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12599 (defun org-highlight-new-match (beg end)
12600 "Highlight from BEG to END and mark the highlight is an occur headline."
12601 (let ((ov (make-overlay beg end)))
12602 (overlay-put ov 'face 'secondary-selection)
12603 (overlay-put ov 'org-type 'org-occur)
12604 (push ov org-occur-highlights)))
12606 (defun org-remove-occur-highlights (&optional beg end noremove)
12607 "Remove the occur highlights from the buffer.
12608 BEG and END are ignored. If NOREMOVE is nil, remove this function
12609 from the `before-change-functions' in the current buffer."
12610 (interactive)
12611 (unless org-inhibit-highlight-removal
12612 (mapc 'delete-overlay org-occur-highlights)
12613 (setq org-occur-highlights nil)
12614 (setq org-occur-parameters nil)
12615 (unless noremove
12616 (remove-hook 'before-change-functions
12617 'org-remove-occur-highlights 'local))))
12619 ;;;; Priorities
12622 "Regular expression matching the priority indicator.")
12624 (defvar org-remove-priority-next-time nil)
12626 (defun org-priority-up ()
12627 "Increase the priority of the current item."
12628 (interactive)
12629 (org-priority 'up))
12631 (defun org-priority-down ()
12632 "Decrease the priority of the current item."
12633 (interactive)
12634 (org-priority 'down))
12636 (defun org-priority (&optional action)
12637 "Change the priority of an item by ARG.
12638 ACTION can be `set', `up', `down', or a character."
12639 (interactive)
12640 (unless org-enable-priority-commands
12641 (error "Priority commands are disabled"))
12642 (setq action (or action 'set))
12643 (let (current new news have remove)
12644 (save-excursion
12645 (org-back-to-heading t)
12646 (if (looking-at org-priority-regexp)
12647 (setq current (string-to-char (match-string 2))
12648 have t))
12649 (cond
12650 ((eq action 'remove)
12651 (setq remove t new ?\ ))
12652 ((or (eq action 'set)
12653 (if (featurep 'xemacs) (characterp action) (integerp action)))
12654 (if (not (eq action 'set))
12655 (setq new action)
12656 (message "Priority %c-%c, SPC to remove: "
12657 org-highest-priority org-lowest-priority)
12658 (save-match-data
12659 (setq new (read-char-exclusive))))
12660 (if (and (= (upcase org-highest-priority) org-highest-priority)
12661 (= (upcase org-lowest-priority) org-lowest-priority))
12662 (setq new (upcase new)))
12663 (cond ((equal new ?\ ) (setq remove t))
12664 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12665 (error "Priority must be between `%c' and `%c'"
12666 org-highest-priority org-lowest-priority))))
12667 ((eq action 'up)
12668 (setq new (if have
12669 (1- current) ; normal cycling
12670 ;; last priority was empty
12671 (if (eq last-command this-command)
12672 org-lowest-priority ; wrap around empty to lowest
12673 ;; default
12674 (if org-priority-start-cycle-with-default
12675 org-default-priority
12676 (1- org-default-priority))))))
12677 ((eq action 'down)
12678 (setq new (if have
12679 (1+ current) ; normal cycling
12680 ;; last priority was empty
12681 (if (eq last-command this-command)
12682 org-highest-priority ; wrap around empty to highest
12683 ;; default
12684 (if org-priority-start-cycle-with-default
12685 org-default-priority
12686 (1+ org-default-priority))))))
12687 (t (error "Invalid action")))
12688 (if (or (< (upcase new) org-highest-priority)
12689 (> (upcase new) org-lowest-priority))
12690 (if (and (memq action '(up down))
12691 (not have) (not (eq last-command this-command)))
12692 ;; `new' is from default priority
12693 (error
12694 "The default can not be set, see `org-default-priority' why")
12695 ;; normal cycling: `new' is beyond highest/lowest priority
12696 ;; and is wrapped around to the empty priority
12697 (setq remove t)))
12698 (setq news (format "%c" new))
12699 (if have
12700 (if remove
12701 (replace-match "" t t nil 1)
12702 (replace-match news t t nil 2))
12703 (if remove
12704 (error "No priority cookie found in line")
12705 (let ((case-fold-search nil))
12706 (looking-at org-todo-line-regexp))
12707 (if (match-end 2)
12708 (progn
12709 (goto-char (match-end 2))
12710 (insert " [#" news "]"))
12711 (goto-char (match-beginning 3))
12712 (insert "[#" news "] "))))
12713 (org-preserve-lc (org-set-tags nil 'align)))
12714 (if remove
12715 (message "Priority removed")
12716 (message "Priority of current item set to %s" news))))
12718 (defun org-get-priority (s)
12719 "Find priority cookie and return priority."
12720 (if (functionp org-get-priority-function)
12721 (funcall org-get-priority-function)
12722 (save-match-data
12723 (if (not (string-match org-priority-regexp s))
12724 (* 1000 (- org-lowest-priority org-default-priority))
12725 (* 1000 (- org-lowest-priority
12726 (string-to-char (match-string 2 s))))))))
12728 ;;;; Tags
12730 (defvar org-agenda-archives-mode)
12731 (defvar org-map-continue-from nil
12732 "Position from where mapping should continue.
12733 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12735 (defvar org-scanner-tags nil
12736 "The current tag list while the tags scanner is running.")
12737 (defvar org-trust-scanner-tags nil
12738 "Should `org-get-tags-at' use the tags for the scanner.
12739 This is for internal dynamical scoping only.
12740 When this is non-nil, the function `org-get-tags-at' will return the value
12741 of `org-scanner-tags' instead of building the list by itself. This
12742 can lead to large speed-ups when the tags scanner is used in a file with
12743 many entries, and when the list of tags is retrieved, for example to
12744 obtain a list of properties. Building the tags list for each entry in such
12745 a file becomes an N^2 operation - but with this variable set, it scales
12746 as N.")
12748 (defun org-scan-tags (action matcher &optional todo-only start-level)
12749 "Scan headline tags with inheritance and produce output ACTION.
12751 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12752 or `agenda' to produce an entry list for an agenda view. It can also be
12753 a Lisp form or a function that should be called at each matched headline, in
12754 this case the return value is a list of all return values from these calls.
12756 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12757 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12758 only lines with a TODO keyword are included in the output.
12760 START-LEVEL can be a string with asterisks, reducing the scope to
12761 headlines matching this string."
12762 (require 'org-agenda)
12763 (let* ((re (concat "^"
12764 (if start-level
12765 ;; Get the correct level to match
12767 org-outline-regexp)
12770 (org-re
12772 (props (list 'face 'default
12773 'done-face 'org-agenda-done
12774 'undone-face 'default
12775 'mouse-face 'highlight
12776 'org-not-done-regexp org-not-done-regexp
12777 'org-todo-regexp org-todo-regexp
12778 'org-complex-heading-regexp org-complex-heading-regexp
12779 'help-echo
12780 (format "mouse-2 or RET jump to org file %s"
12781 (abbreviate-file-name
12782 (or (buffer-file-name (buffer-base-buffer))
12783 (buffer-name (buffer-base-buffer)))))))
12784 (case-fold-search nil)
12785 (org-map-continue-from nil)
12786 lspos tags tags-list
12787 (tags-alist (list (cons 0 org-file-tags)))
12788 (llast 0) rtn rtn1 level category i txt
12789 todo marker entry priority)
12790 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12791 (setq action (list 'lambda nil action)))
12792 (save-excursion
12793 (goto-char (point-min))
12794 (when (eq action 'sparse-tree)
12795 (org-overview)
12796 (org-remove-occur-highlights))
12797 (while (re-search-forward re nil t)
12798 (setq org-map-continue-from nil)
12799 (catch :skip
12800 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12801 tags (if (match-end 4) (org-match-string-no-properties 4)))
12802 (goto-char (setq lspos (match-beginning 0)))
12803 (setq level (org-reduced-level (funcall outline-level))
12804 category (org-get-category))
12805 (setq i llast llast level)
12806 ;; remove tag lists from same and sublevels
12807 (while (>= i level)
12808 (when (setq entry (assoc i tags-alist))
12809 (setq tags-alist (delete entry tags-alist)))
12810 (setq i (1- i)))
12811 ;; add the next tags
12812 (when tags
12813 (setq tags (org-split-string tags ":")
12814 tags-alist
12815 (cons (cons level tags) tags-alist)))
12816 ;; compile tags for current headline
12817 (setq tags-list
12818 (if org-use-tag-inheritance
12819 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12820 tags)
12821 org-scanner-tags tags-list)
12822 (when org-use-tag-inheritance
12823 (setcdr (car tags-alist)
12824 (mapcar (lambda (x)
12825 (setq x (copy-sequence x))
12826 (org-add-prop-inherited x))
12827 (cdar tags-alist))))
12828 (when (and tags org-use-tag-inheritance
12829 (or (not (eq t org-use-tag-inheritance))
12830 org-tags-exclude-from-inheritance))
12831 ;; selective inheritance, remove uninherited ones
12832 (setcdr (car tags-alist)
12833 (org-remove-uninherited-tags (cdar tags-alist))))
12834 (when (and
12836 ;; eval matcher only when the todo condition is OK
12837 (and (or (not todo-only) (member todo org-not-done-keywords))
12838 (let ((case-fold-search t)) (eval matcher)))
12840 ;; Call the skipper, but return t if it does not skip,
12841 ;; so that the `and' form continues evaluating
12842 (progn
12843 (unless (eq action 'sparse-tree) (org-agenda-skip))
12844 t)
12846 ;; Check if timestamps are deselecting this entry
12847 (or (not todo-only)
12848 (and (member todo org-not-done-keywords)
12849 (or (not org-agenda-tags-todo-honor-ignore-options)
12850 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12852 ;; Extra check for the archive tag
12853 ;; FIXME: Does the skipper already do this????
12854 (or
12855 (not (member org-archive-tag tags-list))
12856 ;; we have an archive tag, should we use this anyway?
12857 (or (not org-agenda-skip-archived-trees)
12858 (and (eq action 'agenda) org-agenda-archives-mode))))
12860 ;; select this headline
12862 (cond
12863 ((eq action 'sparse-tree)
12864 (and org-highlight-sparse-tree-matches
12865 (org-get-heading) (match-end 0)
12866 (org-highlight-new-match
12867 (match-beginning 0) (match-beginning 1)))
12868 (org-show-context 'tags-tree))
12869 ((eq action 'agenda)
12870 (setq txt (org-agenda-format-item
12871 ""
12872 (concat
12873 (if (eq org-tags-match-list-sublevels 'indented)
12874 (make-string (1- level) ?.) "")
12875 (org-get-heading))
12876 category
12877 tags-list
12878 )
12879 priority (org-get-priority txt))
12880 (goto-char lspos)
12881 (setq marker (org-agenda-new-marker))
12882 (org-add-props txt props
12883 'org-marker marker 'org-hd-marker marker 'org-category category
12884 'todo-state todo
12885 'priority priority 'type "tagsmatch")
12886 (push txt rtn))
12887 ((functionp action)
12888 (setq org-map-continue-from nil)
12889 (save-excursion
12890 (setq rtn1 (funcall action))
12891 (push rtn1 rtn)))
12892 (t (error "Invalid action")))
12894 ;; if we are to skip sublevels, jump to end of subtree
12895 (unless org-tags-match-list-sublevels
12896 (org-end-of-subtree t)
12897 (backward-char 1))))
12898 ;; Get the correct position from where to continue
12899 (if org-map-continue-from
12900 (goto-char org-map-continue-from)
12901 (and (= (point) lspos) (end-of-line 1)))))
12902 (when (and (eq action 'sparse-tree)
12903 (not org-sparse-tree-open-archived-trees))
12904 (org-hide-archived-subtrees (point-min) (point-max)))
12905 (nreverse rtn)))
12907 (defun org-remove-uninherited-tags (tags)
12908 "Remove all tags that are not inherited from the list TAGS."
12909 (cond
12910 ((eq org-use-tag-inheritance t)
12911 (if org-tags-exclude-from-inheritance
12912 (org-delete-all org-tags-exclude-from-inheritance tags)
12913 tags))
12914 ((not org-use-tag-inheritance) nil)
12915 ((stringp org-use-tag-inheritance)
12916 (delq nil (mapcar
12917 (lambda (x)
12918 (if (and (string-match org-use-tag-inheritance x)
12919 (not (member x org-tags-exclude-from-inheritance)))
12920 x nil))
12921 tags)))
12922 ((listp org-use-tag-inheritance)
12923 (delq nil (mapcar
12924 (lambda (x)
12925 (if (member x org-use-tag-inheritance) x nil))
12926 tags)))))
12928 (defvar todo-only) ;; dynamically scoped
12930 (defun org-match-sparse-tree (&optional todo-only match)
12931 "Create a sparse tree according to tags string MATCH.
12932 MATCH can contain positive and negative selection of tags, like
12934 If optional argument TODO-ONLY is non-nil, only select lines that are
12935 also TODO lines."
12936 (interactive "P")
12937 (org-prepare-agenda-buffers (list (current-buffer)))
12938 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12940 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12942 (defvar org-cached-props nil)
12943 (defun org-cached-entry-get (pom property)
12944 (if (or (eq t org-use-property-inheritance)
12945 (and (stringp org-use-property-inheritance)
12946 (string-match org-use-property-inheritance property))
12947 (and (listp org-use-property-inheritance)
12948 (member property org-use-property-inheritance)))
12949 ;; Caching is not possible, check it directly
12950 (org-entry-get pom property 'inherit)
12951 ;; Get all properties, so that we can do complicated checks easily
12952 (cdr (assoc property (or org-cached-props
12953 (setq org-cached-props
12954 (org-entry-properties pom)))))))
12956 (defun org-global-tags-completion-table (&optional files)
12957 "Return the list of all tags in all agenda buffer/files.
12958 Optional FILES argument is a list of files to which can be used
12959 instead of the agenda files."
12960 (save-excursion
12961 (org-uniquify
12962 (delq nil
12963 (apply 'append
12964 (mapcar
12965 (lambda (file)
12966 (set-buffer (find-file-noselect file))
12967 (append (org-get-buffer-tags)
12968 (mapcar (lambda (x) (if (stringp (car-safe x))
12969 (list (car-safe x)) nil))
12970 org-tag-alist)))
12971 (if (and files (car files))
12972 files
12973 (org-agenda-files))))))))
12975 (defun org-make-tags-matcher (match)
12976 "Create the TAGS/TODO matcher form for the selection string MATCH."
12977 ;; todo-only is scoped dynamically into this function, and the function
12978 ;; may change it if the matcher asks for it.
12979 (unless match
12980 ;; Get a new match request, with completion
12981 (let ((org-last-tags-completion-table
12982 (org-global-tags-completion-table)))
12983 (setq match (org-completing-read-no-i
12984 "Match: " 'org-tags-completion-function nil nil nil
12985 'org-tags-history))))
12987 ;; Parse the string and create a lisp form
12988 (let ((match0 match)
12989 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12990 minus tag mm
12991 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12992 orterms term orlist re-p str-p level-p level-op time-p
12993 prop-p pn pv po gv rest)
12994 (if (string-match "/+" match)
12995 ;; match contains also a todo-matching request
12996 (progn
12997 (setq tagsmatch (substring match 0 (match-beginning 0))
12998 todomatch (substring match (match-end 0)))
12999 (if (string-match "^!" todomatch)
13000 (setq todo-only t todomatch (substring todomatch 1)))
13002 (setq todomatch nil)))
13003 ;; only matching tags
13004 (setq tagsmatch match todomatch nil))
13006 ;; Make the tags matcher
13008 (setq tagsmatcher t)
13009 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13010 (while (setq term (pop orterms))
13012 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13013 (while (string-match re term)
13014 (setq rest (substring term (match-end 0))
13015 minus (and (match-end 1)
13016 (equal (match-string 1 term) "-"))
13017 tag (save-match-data (replace-regexp-in-string
13019 (match-string 2 term)))
13020 re-p (equal (string-to-char tag) ?{)
13021 level-p (match-end 4)
13022 prop-p (match-end 5)
13023 mm (cond
13024 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13025 (level-p
13026 (setq level-op (org-op-to-function (match-string 3 term)))
13027 `(,level-op level ,(string-to-number
13028 (match-string 4 term))))
13029 (prop-p
13030 (setq pn (match-string 5 term)
13031 po (match-string 6 term)
13032 pv (match-string 7 term)
13033 re-p (equal (string-to-char pv) ?{)
13035 time-p (save-match-data
13037 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13038 (if time-p (setq pv (org-matcher-time pv)))
13039 (setq po (org-op-to-function po (if time-p 'time str-p)))
13040 (cond
13041 ((equal pn "CATEGORY")
13042 (setq gv '(get-text-property (point) 'org-category)))
13043 ((equal pn "TODO")
13044 (setq gv 'todo))
13045 (t
13046 (setq gv `(org-cached-entry-get nil ,pn))))
13047 (if re-p
13048 (if (eq po 'org<>)
13049 `(not (string-match ,pv (or ,gv "")))
13050 `(string-match ,pv (or ,gv "")))
13051 (if str-p
13052 `(,po (or ,gv "") ,pv)
13053 `(,po (string-to-number (or ,gv ""))
13054 ,(string-to-number pv) ))))
13055 (t `(member ,tag tags-list)))
13056 mm (if minus (list 'not mm) mm)
13057 term rest)
13058 (push mm tagsmatcher))
13059 (push (if (> (length tagsmatcher) 1)
13060 (cons 'and tagsmatcher)
13061 (car tagsmatcher))
13062 orlist)
13063 (setq tagsmatcher nil))
13064 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13065 (setq tagsmatcher
13066 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13067 ;; Make the todo matcher
13069 (setq todomatcher t)
13070 (setq orterms (org-split-string todomatch "|") orlist nil)
13071 (while (setq term (pop orterms))
13072 (while (string-match re term)
13073 (setq minus (and (match-end 1)
13074 (equal (match-string 1 term) "-"))
13075 kwd (match-string 2 term)
13076 re-p (equal (string-to-char kwd) ?{)
13077 term (substring term (match-end 0))
13078 mm (if re-p
13079 `(string-match ,(substring kwd 1 -1) todo)
13080 (list 'equal 'todo kwd))
13081 mm (if minus (list 'not mm) mm))
13082 (push mm todomatcher))
13083 (push (if (> (length todomatcher) 1)
13084 (cons 'and todomatcher)
13085 (car todomatcher))
13086 orlist)
13087 (setq todomatcher nil))
13088 (setq todomatcher (if (> (length orlist) 1)
13089 (cons 'or orlist) (car orlist))))
13091 ;; Return the string and lisp forms of the matcher
13092 (setq matcher (if todomatcher
13093 (list 'and tagsmatcher todomatcher)
13094 tagsmatcher))
13095 (cons match0 matcher)))
13097 (defun org-op-to-function (op &optional stringp)
13098 "Turn an operator into the appropriate function."
13099 (setq op
13100 (cond
13101 ((equal op "<" ) '(< string< org-time<))
13102 ((equal op ">" ) '(> org-string> org-time>))
13103 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13104 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13105 ((member op '("=" "==")) '(= string= org-time=))
13106 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13107 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13109 (defun org<> (a b) (not (= a b)))
13110 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13111 (defun org-string>= (a b) (not (string< a b)))
13112 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13113 (defun org-string<> (a b) (not (string= a b)))
13114 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13115 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13116 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13117 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13118 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13119 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13120 (defun org-2ft (s)
13121 "Convert S to a floating point time.
13122 If S is already a number, just return it. If it is a string, parse
13123 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13124 (cond
13125 ((numberp s) s)
13126 ((stringp s)
13127 (condition-case nil
13128 (float-time (apply 'encode-time (org-parse-time-string s)))
13129 (error 0.)))
13130 (t 0.)))
13132 (defun org-time-today ()
13133 "Time in seconds today at 0:00.
13134 Returns the float number of seconds since the beginning of the
13135 epoch to the beginning of today (00:00)."
13136 (float-time (apply 'encode-time
13137 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13139 (defun org-matcher-time (s)
13140 "Interpret a time comparison value."
13141 (save-match-data
13142 (cond
13143 ((string= s "<now>") (float-time))
13144 ((string= s "<today>") (org-time-today))
13145 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13146 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13148 (+ (org-time-today)
13149 (* (string-to-number (match-string 1 s))
13150 (cdr (assoc (match-string 2 s)
13151 '(("d" . 86400.0) ("w" . 604800.0)
13152 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13153 (t (org-2ft s)))))
13155 (defun org-match-any-p (re list)
13156 "Does re match any element of list?"
13157 (setq list (mapcar (lambda (x) (string-match re x)) list))
13158 (delq nil list))
13160 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13161 (defvar org-tags-overlay (make-overlay 1 1))
13162 (org-detach-overlay org-tags-overlay)
13164 (defun org-get-local-tags-at (&optional pos)
13165 "Get a list of tags defined in the current headline."
13166 (org-get-tags-at pos 'local))
13168 (defun org-get-local-tags ()
13169 "Get a list of tags defined in the current headline."
13170 (org-get-tags-at nil 'local))
13172 (defun org-get-tags-at (&optional pos local)
13173 "Get a list of all headline tags applicable at POS.
13174 POS defaults to point. If tags are inherited, the list contains
13175 the targets in the same sequence as the headlines appear, i.e.
13176 the tags of the current headline come last.
13177 When LOCAL is non-nil, only return tags from the current headline,
13178 ignore inherited ones."
13179 (interactive)
13180 (if (and org-trust-scanner-tags
13181 (or (not pos) (equal pos (point)))
13182 (not local))
13183 org-scanner-tags
13184 (let (tags ltags lastpos parent)
13185 (save-excursion
13186 (save-restriction
13187 (widen)
13188 (goto-char (or pos (point)))
13189 (save-match-data
13190 (catch 'done
13191 (condition-case nil
13192 (progn
13193 (org-back-to-heading t)
13194 (while (not (equal lastpos (point)))
13195 (setq lastpos (point))
13196 (when (looking-at
13198 (setq ltags (org-split-string
13199 (org-match-string-no-properties 1) ":"))
13200 (when parent
13201 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13202 (setq tags (append
13203 (if parent
13204 (org-remove-uninherited-tags ltags)
13205 ltags)
13206 tags)))
13207 (or org-use-tag-inheritance (throw 'done t))
13208 (if local (throw 'done t))
13209 (or (org-up-heading-safe) (error nil))
13210 (setq parent t)))
13211 (error nil)))))
13212 (if local
13213 tags
13214 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13216 (defun org-add-prop-inherited (s)
13217 (add-text-properties 0 (length s) '(inherited t) s)
13218 s)
13220 (defun org-toggle-tag (tag &optional onoff)
13221 "Toggle the tag TAG for the current line.
13222 If ONOFF is `on' or `off', don't toggle but set to this state."
13223 (let (res current)
13224 (save-excursion
13225 (org-back-to-heading t)
13227 (point-at-eol) t)
13228 (progn
13229 (setq current (match-string 1))
13230 (replace-match ""))
13231 (setq current ""))
13232 (setq current (nreverse (org-split-string current ":")))
13233 (cond
13234 ((eq onoff 'on)
13235 (setq res t)
13236 (or (member tag current) (push tag current)))
13237 ((eq onoff 'off)
13238 (or (not (member tag current)) (setq current (delete tag current))))
13239 (t (if (member tag current)
13240 (setq current (delete tag current))
13241 (setq res t)
13242 (push tag current))))
13243 (end-of-line 1)
13244 (if current
13245 (progn
13246 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13247 (org-set-tags nil t))
13248 (delete-horizontal-space))
13249 (run-hooks 'org-after-tags-change-hook))
13250 res))
13252 (defun org-align-tags-here (to-col)
13253 ;; Assumes that this is a headline
13254 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13255 (beginning-of-line 1)
13257 (< pos (match-beginning 2)))
13258 (progn
13259 (setq tags-l (- (match-end 2) (match-beginning 2)))
13260 (goto-char (match-beginning 1))
13261 (insert " ")
13262 (delete-region (point) (1+ (match-beginning 2)))
13263 (setq ncol (max (current-column)
13264 (1+ col)
13265 (if (> to-col 0)
13266 to-col
13267 (- (abs to-col) tags-l))))
13268 (setq p (point))
13269 (insert (make-string (- ncol (current-column)) ?\ ))
13270 (setq ncol (current-column))
13271 (when indent-tabs-mode (tabify p (point-at-eol)))
13272 (org-move-to-column (min ncol col) t))
13273 (goto-char pos))))
13275 (defun org-set-tags-command (&optional arg just-align)
13276 "Call the set-tags command for the current entry."
13277 (interactive "P")
13278 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13279 (org-set-tags arg just-align)
13280 (save-excursion
13281 (org-back-to-heading t)
13282 (org-set-tags arg just-align))))
13284 (defun org-set-tags-to (data)
13285 "Set the tags of the current entry to DATA, replacing the current tags.
13286 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13287 If DATA is nil or the empty string, any tags will be removed."
13288 (interactive "sTags: ")
13289 (setq data
13290 (cond
13291 ((eq data nil) "")
13292 ((equal data "") "")
13293 ((stringp data)
13294 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13295 ":"))
13296 ((listp data)
13297 (concat ":" (mapconcat 'identity data ":") ":"))
13298 (t nil)))
13299 (when data
13300 (save-excursion
13301 (org-back-to-heading t)
13302 (when (looking-at org-complex-heading-regexp)
13303 (if (match-end 5)
13304 (progn
13305 (goto-char (match-beginning 5))
13306 (insert data)
13307 (delete-region (point) (point-at-eol))
13308 (org-set-tags nil 'align))
13309 (goto-char (point-at-eol))
13310 (insert " " data)
13311 (org-set-tags nil 'align)))
13312 (beginning-of-line 1)
13314 (delete-region (match-beginning 1) (match-end 1))))))
13316 (defun org-align-all-tags ()
13317 "Align the tags i all headings."
13318 (interactive)
13319 (save-excursion
13320 (or (ignore-errors (org-back-to-heading t))
13321 (outline-next-heading))
13322 (if (org-at-heading-p)
13323 (org-set-tags t)
13324 (message "No headings"))))
13326 (defvar org-indent-indentation-per-level)
13327 (defun org-set-tags (&optional arg just-align)
13328 "Set the tags for the current headline.
13329 With prefix ARG, realign all tags in headings in the current buffer."
13330 (interactive "P")
13331 (let* ((re org-outline-regexp-bol)
13332 (current (unless arg (org-get-tags-string)))
13333 (col (current-column))
13334 (org-setting-tags t)
13335 table current-tags inherited-tags ; computed below when needed
13336 tags p0 c0 c1 rpl di tc level)
13337 (if arg
13338 (save-excursion
13339 (goto-char (point-min))
13340 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13341 (while (re-search-forward re nil t)
13342 (org-set-tags nil t)
13343 (end-of-line 1)))
13344 (message "All tags realigned to column %d" org-tags-column))
13345 (if just-align
13346 (setq tags current)
13347 ;; Get a new set of tags from the user
13348 (save-excursion
13349 (setq table (append org-tag-persistent-alist
13350 (or org-tag-alist (org-get-buffer-tags))
13351 (and
13352 org-complete-tags-always-offer-all-agenda-tags
13353 (org-global-tags-completion-table
13354 (org-agenda-files))))
13355 org-last-tags-completion-table table
13356 current-tags (org-split-string current ":")
13357 inherited-tags (nreverse
13358 (nthcdr (length current-tags)
13359 (nreverse (org-get-tags-at))))
13360 tags
13361 (if (or (eq t org-use-fast-tag-selection)
13362 (and org-use-fast-tag-selection
13363 (delq nil (mapcar 'cdr table))))
13364 (org-fast-tag-selection
13365 current-tags inherited-tags table
13366 (if org-fast-tag-selection-include-todo
13367 org-todo-key-alist))
13368 (let ((org-add-colon-after-tag-completion t))
13369 (org-trim
13370 (org-icompleting-read "Tags: "
13371 'org-tags-completion-function
13372 nil nil current 'org-tags-history))))))
13373 (while (string-match "[-+&]+" tags)
13374 ;; No boolean logic, just a list
13375 (setq tags (replace-match ":" t t tags))))
13377 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13379 (if org-tags-sort-function
13380 (setq tags (mapconcat 'identity
13381 (sort (org-split-string
13382 tags (org-re "[^[:alnum:]_@#%]+"))
13383 org-tags-sort-function) ":")))
13386 (setq tags "")
13387 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13388 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13390 ;; Insert new tags at the correct column
13391 (beginning-of-line 1)
13392 (setq level (or (and (looking-at org-outline-regexp)
13393 (- (match-end 0) (point) 1))
13394 1))
13395 (cond
13396 ((and (equal current "") (equal tags "")))
13397 ((re-search-forward
13399 (point-at-eol) t)
13400 (if (equal tags "")
13401 (setq rpl "")
13402 (goto-char (match-beginning 0))
13403 (setq c0 (current-column)
13404 ;; compute offset for the case of org-indent-mode active
13405 di (if org-indent-mode
13406 (* (1- org-indent-indentation-per-level) (1- level))
13407 0)
13408 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13409 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13410 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13411 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13412 (replace-match rpl t t)
13413 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13414 tags)
13415 (t (error "Tags alignment failed")))
13416 (org-move-to-column col)
13417 (unless just-align
13418 (run-hooks 'org-after-tags-change-hook)))))
13420 (defun org-change-tag-in-region (beg end tag off)
13421 "Add or remove TAG for each entry in the region.
13422 This works in the agenda, and also in an org-mode buffer."
13423 (interactive
13424 (list (region-beginning) (region-end)
13425 (let ((org-last-tags-completion-table
13426 (if (eq major-mode 'org-mode)
13427 (org-get-buffer-tags)
13428 (org-global-tags-completion-table))))
13429 (org-icompleting-read
13430 "Tag: " 'org-tags-completion-function nil nil nil
13431 'org-tags-history))
13432 (progn
13434 (equal (read-char-exclusive) ?r))))
13435 (if (fboundp 'deactivate-mark) (deactivate-mark))
13436 (let ((agendap (equal major-mode 'org-agenda-mode))
13437 l1 l2 m buf pos newhead (cnt 0))
13438 (goto-char end)
13439 (setq l2 (1- (org-current-line)))
13440 (goto-char beg)
13441 (setq l1 (org-current-line))
13442 (loop for l from l1 to l2 do
13443 (org-goto-line l)
13444 (setq m (get-text-property (point) 'org-hd-marker))
13445 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13446 (and agendap m))
13447 (setq buf (if agendap (marker-buffer m) (current-buffer))
13448 pos (if agendap m (point)))
13449 (with-current-buffer buf
13450 (save-excursion
13451 (save-restriction
13452 (goto-char pos)
13453 (setq cnt (1+ cnt))
13454 (org-toggle-tag tag (if off 'off 'on))
13455 (setq newhead (org-get-heading)))))
13456 (and agendap (org-agenda-change-all-lines newhead m))))
13457 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13459 (defun org-tags-completion-function (string predicate &optional flag)
13460 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13461 (confirm (lambda (x) (stringp (car x)))))
13463 (setq s1 (match-string 1 string)
13464 s2 (match-string 2 string))
13465 (setq s1 "" s2 string))
13466 (cond
13467 ((eq flag nil)
13468 ;; try completion
13469 (setq rtn (try-completion s2 ctable confirm))
13470 (if (stringp rtn)
13471 (setq rtn
13472 (concat s1 s2 (substring rtn (length s2))
13473 (if (and org-add-colon-after-tag-completion
13474 (assoc rtn ctable))
13475 ":" ""))))
13476 rtn)
13477 ((eq flag t)
13478 ;; all-completions
13479 (all-completions s2 ctable confirm)
13480 )
13481 ((eq flag 'lambda)
13482 ;; exact match?
13483 (assoc s2 ctable)))
13484 ))
13486 (defun org-fast-tag-insert (kwd tags face &optional end)
13487 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13488 (insert (format "%-12s" (concat kwd ":"))
13489 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13490 (or end "")))
13492 (defun org-fast-tag-show-exit (flag)
13493 (save-excursion
13494 (org-goto-line 3)
13496 (replace-match ""))
13497 (when flag
13498 (end-of-line 1)
13499 (org-move-to-column (- (window-width) 19) t)
13500 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13502 (defun org-set-current-tags-overlay (current prefix)
13503 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13504 (if (featurep 'xemacs)
13505 (org-overlay-display org-tags-overlay (concat prefix s)
13506 'secondary-selection)
13507 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13508 (org-overlay-display org-tags-overlay (concat prefix s)))))
13510 (defvar org-last-tag-selection-key nil)
13511 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13512 "Fast tag selection with single keys.
13513 CURRENT is the current list of tags in the headline, INHERITED is the
13514 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13515 possibly with grouping information. TODO-TABLE is a similar table with
13516 TODO keywords, should these have keys assigned to them.
13517 If the keys are nil, a-z are automatically assigned.
13518 Returns the new tags string, or nil to not change the current settings."
13519 (let* ((fulltable (append table todo-table))
13520 (maxlen (apply 'max (mapcar
13521 (lambda (x)
13522 (if (stringp (car x)) (string-width (car x)) 0))
13523 fulltable)))
13524 (buf (current-buffer))
13525 (expert (eq org-fast-tag-selection-single-key 'expert))
13526 (buffer-tags nil)
13527 (fwidth (+ maxlen 3 1 3))
13528 (ncol (/ (- (window-width) 4) fwidth))
13529 (i-face 'org-done)
13530 (c-face 'org-todo)
13531 tg cnt e c char c1 c2 ntable tbl rtn
13532 ov-start ov-end ov-prefix
13533 (exit-after-next org-fast-tag-selection-single-key)
13534 (done-keywords org-done-keywords)
13535 groups ingroup)
13536 (save-excursion
13537 (beginning-of-line 1)
13538 (if (looking-at
13540 (setq ov-start (match-beginning 1)
13541 ov-end (match-end 1)
13542 ov-prefix "")
13543 (setq ov-start (1- (point-at-eol))
13544 ov-end (1+ ov-start))
13546 (setq ov-prefix
13547 (concat
13548 (buffer-substring (1- (point)) (point))
13549 (if (> (current-column) org-tags-column)
13550 " "
13551 (make-string (- org-tags-column (current-column)) ?\ ))))))
13552 (move-overlay org-tags-overlay ov-start ov-end)
13553 (save-window-excursion
13554 (if expert
13555 (set-buffer (get-buffer-create " *Org tags*"))
13556 (delete-other-windows)
13557 (split-window-vertically)
13558 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13559 (erase-buffer)
13560 (org-set-local 'org-done-keywords done-keywords)
13563 (org-fast-tag-show-exit exit-after-next)
13564 (org-set-current-tags-overlay current ov-prefix)
13565 (setq tbl fulltable char ?a cnt 0)
13566 (while (setq e (pop tbl))
13567 (cond
13568 ((equal (car e) :startgroup)
13569 (push '() groups) (setq ingroup t)
13570 (when (not (= cnt 0))
13571 (setq cnt 0)
13573 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13574 ((equal (car e) :endgroup)
13575 (setq ingroup nil cnt 0)
13577 ((equal e '(:newline))
13578 (when (not (= cnt 0))
13579 (setq cnt 0)
13581 (setq e (car tbl))
13582 (while (equal (car tbl) '(:newline))
13584 (setq tbl (cdr tbl)))))
13585 (t
13586 (setq tg (copy-sequence (car e)) c2 nil)
13587 (if (cdr e)
13588 (setq c (cdr e))
13589 ;; automatically assign a character.
13590 (setq c1 (string-to-char
13591 (downcase (substring
13592 tg (if (= (string-to-char tg) ?@) 1 0)))))
13593 (if (or (rassoc c1 ntable) (rassoc c1 table))
13594 (while (or (rassoc char ntable) (rassoc char table))
13595 (setq char (1+ char)))
13596 (setq c2 c1))
13597 (setq c (or c2 char)))
13598 (if ingroup (push tg (car groups)))
13599 (setq tg (org-add-props tg nil 'face
13600 (cond
13601 ((not (assoc tg table))
13602 (org-get-todo-face tg))
13603 ((member tg current) c-face)
13604 ((member tg inherited) i-face)
13605 (t nil))))
13606 (if (and (= cnt 0) (not ingroup)) (insert " "))
13607 (insert "[" c "] " tg (make-string
13608 (- fwidth 4 (length tg)) ?\ ))
13609 (push (cons tg c) ntable)
13610 (when (= (setq cnt (1+ cnt)) ncol)
13612 (if ingroup (insert " "))
13613 (setq cnt 0)))))
13614 (setq ntable (nreverse ntable))
13616 (goto-char (point-min))
13617 (if (not expert) (org-fit-window-to-buffer))
13618 (setq rtn
13619 (catch 'exit
13620 (while t
13621 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13622 (if (not groups) "no " "")
13623 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13624 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13625 (setq org-last-tag-selection-key c)
13626 (cond
13628 ((= c ?!)
13629 (setq groups (not groups))
13630 (goto-char (point-min))
13631 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13632 ((= c ?\C-c)
13633 (if (not expert)
13634 (org-fast-tag-show-exit
13635 (setq exit-after-next (not exit-after-next)))
13636 (setq expert nil)
13637 (delete-other-windows)
13638 (set-window-buffer (split-window-vertically) " *Org tags*")
13639 (org-switch-to-buffer-other-window " *Org tags*")
13640 (org-fit-window-to-buffer)))
13641 ((or (= c ?\C-g)
13642 (and (= c ?q) (not (rassoc c ntable))))
13643 (org-detach-overlay org-tags-overlay)
13644 (setq quit-flag t))
13645 ((= c ?\ )
13646 (setq current nil)
13647 (if exit-after-next (setq exit-after-next 'now)))
13649 (condition-case nil
13650 (setq tg (org-icompleting-read
13651 "Tag: "
13652 (or buffer-tags
13653 (with-current-buffer buf
13654 (org-get-buffer-tags)))))
13655 (quit (setq tg "")))
13657 (add-to-list 'buffer-tags (list tg))
13658 (if (member tg current)
13659 (setq current (delete tg current))
13660 (push tg current)))
13661 (if exit-after-next (setq exit-after-next 'now)))
13662 ((setq e (rassoc c todo-table) tg (car e))
13663 (with-current-buffer buf
13664 (save-excursion (org-todo tg)))
13665 (if exit-after-next (setq exit-after-next 'now)))
13666 ((setq e (rassoc c ntable) tg (car e))
13667 (if (member tg current)
13668 (setq current (delete tg current))
13669 (loop for g in groups do
13670 (if (member tg g)
13671 (mapc (lambda (x)
13672 (setq current (delete x current)))
13673 g)))
13674 (push tg current))
13675 (if exit-after-next (setq exit-after-next 'now))))
13677 ;; Create a sorted list
13678 (setq current
13679 (sort current
13680 (lambda (a b)
13681 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13682 (if (eq exit-after-next 'now) (throw 'exit t))
13683 (goto-char (point-min))
13684 (beginning-of-line 2)
13685 (delete-region (point) (point-at-eol))
13686 (org-fast-tag-insert "Current" current c-face)
13687 (org-set-current-tags-overlay current ov-prefix)
13688 (while (re-search-forward
13690 (setq tg (match-string 1))
13691 (add-text-properties
13692 (match-beginning 1) (match-end 1)
13693 (list 'face
13694 (cond
13695 ((member tg current) c-face)
13696 ((member tg inherited) i-face)
13697 (t (get-text-property (match-beginning 1) 'face))))))
13698 (goto-char (point-min)))))
13699 (org-detach-overlay org-tags-overlay)
13700 (if rtn
13701 (mapconcat 'identity current ":")
13702 nil))))
13704 (defun org-get-tags-string ()
13705 "Get the TAGS string in the current headline."
13706 (unless (org-at-heading-p t)
13707 (error "Not on a heading"))
13708 (save-excursion
13709 (beginning-of-line 1)
13711 (org-match-string-no-properties 1)
13712 "")))
13714 (defun org-get-tags ()
13715 "Get the list of tags specified in the current headline."
13716 (org-split-string (org-get-tags-string) ":"))
13718 (defun org-get-buffer-tags ()
13719 "Get a table of all tags used in the buffer, for completion."
13720 (let (tags)
13721 (save-excursion
13722 (goto-char (point-min))
13723 (while (re-search-forward
13725 (when (equal (char-after (point-at-bol 0)) ?*)
13726 (mapc (lambda (x) (add-to-list 'tags x))
13727 (org-split-string (org-match-string-no-properties 1) ":")))))
13728 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13729 (mapcar 'list tags)))
13731 ;;;; The mapping API
13733 ;;;###autoload
13734 (defun org-map-entries (func &optional match scope &rest skip)
13735 "Call FUNC at each headline selected by MATCH in SCOPE.
13737 FUNC is a function or a lisp form. The function will be called without
13738 arguments, with the cursor positioned at the beginning of the headline.
13739 The return values of all calls to the function will be collected and
13740 returned as a list.
13742 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13743 does not need to preserve point. After evaluation, the cursor will be
13744 moved to the end of the line (presumably of the headline of the
13745 processed entry) and search continues from there. Under some
13746 circumstances, this may not produce the wanted results. For example,
13747 if you have removed (e.g. archived) the current (sub)tree it could
13748 mean that the next entry will be skipped entirely. In such cases, you
13749 can specify the position from where search should continue by making
13750 FUNC set the variable `org-map-continue-from' to the desired buffer
13751 position.
13753 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13754 Only headlines that are matched by this query will be considered during
13755 the iteration. When MATCH is nil or t, all headlines will be
13756 visited by the iteration.
13758 SCOPE determines the scope of this command. It can be any of:
13760 nil The current buffer, respecting the restriction if any
13761 tree The subtree started with the entry at point
13762 region The entries within the active region, if any
13763 region-start-level
13764 The entries within the active region, but only those at
13765 the same level than the first one.
13766 file The current buffer, without restriction
13767 file-with-archives
13768 The current buffer, and any archives associated with it
13769 agenda All agenda files
13770 agenda-with-archives
13771 All agenda files with any archive files associated with them
13772 \(file1 file2 ...)
13773 If this is a list, all files in the list will be scanned
13775 The remaining args are treated as settings for the skipping facilities of
13776 the scanner. The following items can be given here:
13778 archive skip trees with the archive tag.
13779 comment skip trees with the COMMENT keyword
13780 function or Emacs Lisp form:
13781 will be used as value for `org-agenda-skip-function', so whenever
13782 the function returns t, FUNC will not be called for that
13783 entry and search will continue from the point where the
13784 function leaves it.
13786 If your function needs to retrieve the tags including inherited tags
13787 at the *current* entry, you can use the value of the variable
13788 `org-scanner-tags' which will be much faster than getting the value
13789 with `org-get-tags-at'. If your function gets properties with
13790 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13791 to t around the call to `org-entry-properties' to get the same speedup.
13792 Note that if your function moves around to retrieve tags and properties at
13793 a *different* entry, you cannot use these techniques."
13794 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13795 (not (org-region-active-p)))
13796 (let* ((org-agenda-archives-mode nil) ; just to make sure
13797 (org-agenda-skip-archived-trees (memq 'archive skip))
13798 (org-agenda-skip-comment-trees (memq 'comment skip))
13799 (org-agenda-skip-function
13800 (car (org-delete-all '(comment archive) skip)))
13801 (org-tags-match-list-sublevels t)
13802 (start-level (eq scope 'region-start-level))
13803 matcher file res
13804 org-todo-keywords-for-agenda
13805 org-done-keywords-for-agenda
13806 org-todo-keyword-alist-for-agenda
13807 org-drawers-for-agenda
13808 org-tag-alist-for-agenda)
13810 (cond
13811 ((eq match t) (setq matcher t))
13812 ((eq match nil) (setq matcher t))
13813 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13815 (save-excursion
13816 (save-restriction
13817 (cond ((eq scope 'tree)
13818 (org-back-to-heading t)
13819 (org-narrow-to-subtree)
13820 (setq scope nil))
13821 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13822 (org-region-active-p))
13823 ;; If needed, set start-level to a string like "2"
13824 (when start-level
13825 (save-excursion
13826 (goto-char (region-beginning))
13827 (unless (org-at-heading-p) (outline-next-heading))
13828 (setq start-level (org-current-level))))
13829 (narrow-to-region (region-beginning)
13830 (save-excursion
13831 (goto-char (region-end))
13832 (unless (and (bolp) (org-at-heading-p))
13833 (outline-next-heading))
13834 (point)))
13835 (setq scope nil)))
13837 (if (not scope)
13838 (progn
13839 (org-prepare-agenda-buffers
13840 (list (buffer-file-name (current-buffer))))
13841 (setq res (org-scan-tags func matcher nil start-level)))
13842 ;; Get the right scope
13843 (cond
13844 ((and scope (listp scope) (symbolp (car scope)))
13845 (setq scope (eval scope)))
13846 ((eq scope 'agenda)
13847 (setq scope (org-agenda-files t)))
13848 ((eq scope 'agenda-with-archives)
13849 (setq scope (org-agenda-files t))
13850 (setq scope (org-add-archive-files scope)))
13851 ((eq scope 'file)
13852 (setq scope (list (buffer-file-name))))
13853 ((eq scope 'file-with-archives)
13854 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13855 (org-prepare-agenda-buffers scope)
13856 (while (setq file (pop scope))
13857 (with-current-buffer (org-find-base-buffer-visiting file)
13858 (save-excursion
13859 (save-restriction
13860 (widen)
13861 (goto-char (point-min))
13862 (setq res (append res (org-scan-tags func matcher))))))))))
13863 res)))
13865 ;;;; Properties
13867 ;;; Setting and retrieving properties
13869 (defconst org-special-properties
13870 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13871 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13872 "The special properties valid in Org-mode.
13874 These are properties that are not defined in the property drawer,
13875 but in some other way.")
13877 (defconst org-default-properties
13878 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13879 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13880 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13881 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13882 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13883 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13884 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13885 "Some properties that are used by Org-mode for various purposes.
13886 Being in this list makes sure that they are offered for completion.")
13889 "Regular expression matching the first line of a property drawer.")
13892 "Regular expression matching the last line of a property drawer.")
13895 "Regular expression matching the first line of a property drawer.")
13898 "Regular expression matching the first line of a property drawer.")
13900 (defconst org-property-drawer-re
13903 "Matches an entire property drawer.")
13905 (defconst org-clock-drawer-re
13908 "Matches an entire clock drawer.")
13910 (defsubst org-re-property (property)
13911 "Return a regexp matching PROPERTY.
13912 Match group 1 will be set to the value "
13915 (defun org-property-action ()
13916 "Do an action on properties."
13917 (interactive)
13918 (let (c)
13919 (org-at-property-p)
13920 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13921 (setq c (read-char-exclusive))
13922 (cond
13923 ((equal c ?s)
13924 (call-interactively 'org-set-property))
13925 ((equal c ?d)
13926 (call-interactively 'org-delete-property))
13927 ((equal c ?D)
13928 (call-interactively 'org-delete-property-globally))
13929 ((equal c ?c)
13930 (call-interactively 'org-compute-property-at-point))
13931 (t (error "No such property action %c" c)))))
13933 (defun org-set-effort (&optional value)
13934 "Set the effort property of the current entry.
13935 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13936 allowed value."
13937 (interactive "P")
13938 (if (equal value 0) (setq value 10))
13939 (let* ((completion-ignore-case t)
13940 (prop org-effort-property)
13941 (cur (org-entry-get nil prop))
13942 (allowed (org-property-get-allowed-values nil prop 'table))
13943 (existing (mapcar 'list (org-property-values prop)))
13944 rpl
13945 (val (cond
13946 ((stringp value) value)
13947 ((and allowed (integerp value))
13948 (or (car (nth (1- value) allowed))
13949 (car (org-last allowed))))
13950 (allowed
13951 (message "Select 1-9,0, [RET%s]: %s"
13952 (if cur (concat "=" cur) "")
13953 (mapconcat 'car allowed " "))
13954 (setq rpl (read-char-exclusive))
13956 cur
13957 (setq rpl (- rpl ?0))
13958 (if (equal rpl 0) (setq rpl 10))
13959 (if (and (> rpl 0) (<= rpl (length allowed)))
13960 (car (nth (1- rpl) allowed))
13961 (org-completing-read "Effort: " allowed nil))))
13962 (t
13963 (let (org-completion-use-ido org-completion-use-iswitchb)
13964 (org-completing-read
13966 (concat "[" cur "]") "")
13967 ": ")
13968 existing nil nil "" nil cur))))))
13969 (unless (equal (org-entry-get nil prop) val)
13970 (org-entry-put nil prop val))
13971 (message "%s is now %s" prop val)))
13973 (defun org-at-property-p ()
13974 "Is cursor inside a property drawer?"
13975 (save-excursion
13976 (beginning-of-line 1)
13978 (save-match-data ;; Used by calling procedures
13979 (let ((p (point))
13980 (range (unless (org-before-first-heading-p)
13981 (org-get-property-block))))
13982 (and range (<= (car range) p) (< p (cdr range))))))))
13984 (defun org-get-property-block (&optional beg end force)
13985 "Return the (beg . end) range of the body of the property drawer.
13986 BEG and END can be beginning and end of subtree, if not given
13987 they will be found.
13988 If the drawer does not exist and FORCE is non-nil, create the drawer."
13989 (catch 'exit
13990 (save-excursion
13991 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13992 (end (or end (progn (outline-next-heading) (point)))))
13993 (goto-char beg)
13994 (if (re-search-forward org-property-start-re end t)
13995 (setq beg (1+ (match-end 0)))
13996 (if force
13997 (save-excursion
13998 (org-insert-property-drawer)
13999 (setq end (progn (outline-next-heading) (point))))
14000 (throw 'exit nil))
14001 (goto-char beg)
14002 (if (re-search-forward org-property-start-re end t)
14003 (setq beg (1+ (match-end 0)))))
14004 (if (re-search-forward org-property-end-re end t)
14005 (setq end (match-beginning 0))
14006 (or force (throw 'exit nil))
14007 (goto-char beg)
14008 (setq end beg)
14009 (org-indent-line-function)
14011 (cons beg end)))))
14013 (defun org-entry-properties (&optional pom which specific)
14014 "Get all properties of the entry at point-or-marker POM.
14015 This includes the TODO keyword, the tags, time strings for deadline,
14016 scheduled, and clocking, and any additional properties defined in the
14017 entry. The return value is an alist, keys may occur multiple times
14018 if the property key was used several times.
14019 POM may also be nil, in which case the current entry is used.
14020 If WHICH is nil or `all', get all properties. If WHICH is
14021 `special' or `standard', only get that subclass. If WHICH
14022 is a string only get exactly this property. SPECIFIC can be a string, the
14023 specific property we are interested in. Specifying it can speed
14024 things up because then unnecessary parsing is avoided."
14025 (setq which (or which 'all))
14026 (org-with-point-at pom
14027 (let ((clockstr (substring org-clock-string 0 -1))
14028 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14029 (case-fold-search nil)
14030 beg end range props sum-props key key1 value string clocksum)
14031 (save-excursion
14032 (when (condition-case nil
14033 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14034 (error nil))
14035 (setq beg (point))
14036 (setq sum-props (get-text-property (point) 'org-summaries))
14037 (setq clocksum (get-text-property (point) :org-clock-minutes))
14038 (outline-next-heading)
14039 (setq end (point))
14040 (when (memq which '(all special))
14041 ;; Get the special properties, like TODO and tags
14042 (goto-char beg)
14043 (when (and (or (not specific) (string= specific "TODO"))
14044 (looking-at org-todo-line-regexp) (match-end 2))
14045 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14046 (when (and (or (not specific) (string= specific "PRIORITY"))
14047 (looking-at org-priority-regexp))
14048 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14049 (when (or (not specific) (string= specific "FILE"))
14050 (push (cons "FILE" buffer-file-name) props))
14051 (when (and (or (not specific) (string= specific "TAGS"))
14052 (setq value (org-get-tags-string))
14054 (push (cons "TAGS" value) props))
14055 (when (and (or (not specific) (string= specific "ALLTAGS"))
14056 (setq value (org-get-tags-at)))
14057 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14058 ":"))
14059 props))
14060 (when (or (not specific) (string= specific "BLOCKED"))
14061 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14062 (when (or (not specific)
14063 (member specific
14064 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14065 "TIMESTAMP" "TIMESTAMP_IA")))
14066 (catch 'match
14067 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14068 (setq key (if (match-end 1)
14069 (substring (org-match-string-no-properties 1)
14070 0 -1))
14071 string (if (equal key clockstr)
14072 (org-no-properties
14073 (org-trim
14074 (buffer-substring
14075 (match-beginning 3) (goto-char
14076 (point-at-eol)))))
14077 (substring (org-match-string-no-properties 3)
14078 1 -1)))
14079 ;; Get the correct property name from the key. This is
14080 ;; necessary if the user has configured time keywords.
14081 (setq key1 (concat key ":"))
14082 (cond
14083 ((not key)
14084 (setq key
14085 (if (= (char-after (match-beginning 3)) ?\[)
14086 "TIMESTAMP_IA" "TIMESTAMP")))
14087 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14088 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14089 ((equal key1 org-closed-string) (setq key "CLOSED"))
14090 ((equal key1 org-clock-string) (setq key "CLOCK")))
14091 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14092 (progn
14093 (push (cons key string) props)
14094 ;; no need to search further if match is found
14095 (throw 'match t))
14096 (when (or (equal key "CLOCK") (not (assoc key props)))
14097 (push (cons key string) props))))))
14098 )
14100 (when (memq which '(all standard))
14101 ;; Get the standard properties, like :PROP: ...
14102 (setq range (org-get-property-block beg end))
14103 (when range
14104 (goto-char (car range))
14105 (while (re-search-forward
14107 (cdr range) t)
14108 (setq key (org-match-string-no-properties 1)
14109 value (org-trim (or (org-match-string-no-properties 2) "")))
14110 (unless (member key excluded)
14111 (push (cons key (or value "")) props)))))
14112 (if clocksum
14113 (push (cons "CLOCKSUM"
14114 (org-columns-number-to-string (/ (float clocksum) 60.)
14115 'add_times))
14116 props))
14117 (unless (assoc "CATEGORY" props)
14118 (push (cons "CATEGORY" (org-get-category)) props))
14119 (append sum-props (nreverse props)))))))
14121 (defun org-entry-get (pom property &optional inherit literal-nil)
14122 "Get value of PROPERTY for entry at point-or-marker POM.
14123 If INHERIT is non-nil and the entry does not have the property,
14124 then also check higher levels of the hierarchy.
14125 If INHERIT is the symbol `selective', use inheritance only if the setting
14126 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14127 If the property is present but empty, the return value is the empty string.
14128 If the property is not present at all, nil is returned.
14131 do not interpret it as the list atom nil. This is used for inheritance
14133 (org-with-point-at pom
14134 (if (and inherit (if (eq inherit 'selective)
14135 (org-property-inherit-p property)
14136 t))
14137 (org-entry-get-with-inheritance property literal-nil)
14138 (if (member property org-special-properties)
14139 ;; We need a special property. Use `org-entry-properties' to
14140 ;; retrieve it, but specify the wanted property
14141 (cdr (assoc property (org-entry-properties nil 'special property)))
14142 (let ((range (unless (org-before-first-heading-p)
14143 (org-get-property-block))))
14144 (when (and range (goto-char (car range)))
14145 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14146 (cond
14147 ((re-search-forward
14148 (org-re-property property) (cdr range) t)
14149 (if (match-end 1) (org-match-string-no-properties 1) ""))
14150 ((re-search-forward
14151 (org-re-property (concat property "+")) (cdr range) t)
14152 (cdr (assoc
14153 property
14154 (org-update-property-plist
14155 (concat property "+")
14156 (if (match-end 1) (org-match-string-no-properties 1) "")
14157 (list (or (assoc property org-file-properties)
14158 (assoc property org-global-properties)
14159 (assoc property org-global-properties-fixed)
14160 ))))))))))))))
14162 (defun org-property-or-variable-value (var &optional inherit)
14163 "Check if there is a property fixing the value of VAR.
14164 If yes, return this value. If not, return the current value of the variable."
14165 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14167 (read prop)
14168 (symbol-value var))))
14170 (defun org-entry-delete (pom property)
14171 "Delete the property PROPERTY from entry at point-or-marker POM."
14172 (org-with-point-at pom
14173 (if (member property org-special-properties)
14174 nil ; cannot delete these properties.
14175 (let ((range (org-get-property-block)))
14176 (if (and range
14177 (goto-char (car range))
14178 (re-search-forward
14179 (org-re-property property)
14180 (cdr range) t))
14181 (progn
14182 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14183 t)
14184 nil)))))
14186 ;; Multi-values properties are properties that contain multiple values
14187 ;; These values are assumed to be single words, separated by whitespace.
14188 (defun org-entry-add-to-multivalued-property (pom property value)
14189 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14190 (let* ((old (org-entry-get pom property))
14192 (setq value (org-entry-protect-space value))
14193 (unless (member value values)
14194 (setq values (cons value values))
14195 (org-entry-put pom property
14196 (mapconcat 'identity values " ")))))
14198 (defun org-entry-remove-from-multivalued-property (pom property value)
14199 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14200 (let* ((old (org-entry-get pom property))
14202 (setq value (org-entry-protect-space value))
14203 (when (member value values)
14204 (setq values (delete value values))
14205 (org-entry-put pom property
14206 (mapconcat 'identity values " ")))))
14208 (defun org-entry-member-in-multivalued-property (pom property value)
14209 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14210 (let* ((old (org-entry-get pom property))
14212 (setq value (org-entry-protect-space value))
14213 (member value values)))
14215 (defun org-entry-get-multivalued-property (pom property)
14216 "Return a list of values in a multivalued property."
14217 (let* ((value (org-entry-get pom property))
14219 (mapcar 'org-entry-restore-space values)))
14221 (defun org-entry-put-multivalued-property (pom property &rest values)
14222 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14223 VALUES should be a list of strings. Spaces will be protected."
14224 (org-entry-put pom property
14225 (mapconcat 'org-entry-protect-space values " "))
14226 (let* ((value (org-entry-get pom property))
14228 (mapcar 'org-entry-restore-space values)))
14230 (defun org-entry-protect-space (s)
14231 "Protect spaces and newline in string S."
14232 (while (string-match " " s)
14233 (setq s (replace-match "%20" t t s)))
14235 (setq s (replace-match "%0A" t t s)))
14236 s)
14238 (defun org-entry-restore-space (s)
14239 "Restore spaces and newline in string S."
14240 (while (string-match "%20" s)
14241 (setq s (replace-match " " t t s)))
14242 (while (string-match "%0A" s)
14244 s)
14246 (defvar org-entry-property-inherited-from (make-marker)
14247 "Marker pointing to the entry from where a property was inherited.
14248 Each call to `org-entry-get-with-inheritance' will set this marker to the
14249 location of the entry where the inheritance search matched. If there was
14250 no match, the marker will point nowhere.
14251 Note that also `org-entry-get' calls this function, if the INHERIT flag
14252 is set.")
14254 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14255 "Get entry property, and search higher levels if not present.
14256 The search will stop at the first ancestor which has the property defined.
14258 should be considered as undefined (this is the meaning of nil here).
14260 (move-marker org-entry-property-inherited-from nil)
14261 (let (tmp)
14262 (unless (org-before-first-heading-p)
14263 (save-excursion
14264 (save-restriction
14265 (widen)
14266 (catch 'ex
14267 (while t
14268 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14269 (org-back-to-heading t)
14270 (move-marker org-entry-property-inherited-from (point))
14271 (throw 'ex tmp))
14272 (or (org-up-heading-safe) (throw 'ex nil)))))))
14273 (setq tmp (or tmp
14274 (cdr (assoc property org-file-properties))
14275 (cdr (assoc property org-global-properties))
14276 (cdr (assoc property org-global-properties-fixed))))
14277 (if literal-nil tmp (org-not-nil tmp))))
14279 (defvar org-property-changed-functions nil
14280 "Hook called when the value of a property has changed.
14281 Each hook function should accept two arguments, the name of the property
14282 and the new value.")
14284 (defun org-entry-put (pom property value)
14285 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14286 (org-with-point-at pom
14287 (org-back-to-heading t)
14288 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14289 range)
14290 (cond
14291 ((equal property "TODO")
14293 (not (member value org-todo-keywords-1)))
14295 (if (or (not value)
14297 (setq value 'none))
14298 (org-todo value)
14299 (org-set-tags nil 'align))
14300 ((equal property "PRIORITY")
14302 (string-to-char value) ?\ ))
14303 (org-set-tags nil 'align))
14304 ((equal property "SCHEDULED")
14305 (if (re-search-forward org-scheduled-time-regexp end t)
14306 (cond
14307 ((eq value 'earlier) (org-timestamp-change -1 'day))
14308 ((eq value 'later) (org-timestamp-change 1 'day))
14309 (t (call-interactively 'org-schedule)))
14310 (call-interactively 'org-schedule)))
14311 ((equal property "DEADLINE")
14312 (if (re-search-forward org-deadline-time-regexp end t)
14313 (cond
14314 ((eq value 'earlier) (org-timestamp-change -1 'day))
14315 ((eq value 'later) (org-timestamp-change 1 'day))
14316 (t (call-interactively 'org-deadline)))
14317 (call-interactively 'org-deadline)))
14318 ((member property org-special-properties)
14319 (error "The %s property can not yet be set with `org-entry-put'"
14320 property))
14321 (t ; a non-special property
14322 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14323 (setq range (org-get-property-block beg end 'force))
14324 (goto-char (car range))
14325 (if (re-search-forward
14326 (org-re-property property) (cdr range) t)
14327 (progn
14328 (delete-region (match-beginning 0) (match-end 0))
14329 (goto-char (match-beginning 0)))
14330 (goto-char (cdr range))
14332 (backward-char 1)
14333 (org-indent-line-function))
14334 (insert ":" property ":")
14335 (and value (insert " " value))
14336 (org-indent-line-function)))))
14337 (run-hook-with-args 'org-property-changed-functions property value)))
14339 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14340 "Get all property keys in the current buffer.
14341 With INCLUDE-SPECIALS, also list the special properties that reflect things
14342 like tags and TODO state.
14343 With INCLUDE-DEFAULTS, also include properties that has special meaning
14344 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14345 and others.
14346 With INCLUDE-COLUMNS, also include property names given in COLUMN
14347 formats in the current buffer."
14348 (let (rtn range cfmt s p)
14349 (save-excursion
14350 (save-restriction
14351 (widen)
14352 (goto-char (point-min))
14353 (while (re-search-forward org-property-start-re nil t)
14354 (setq range (org-get-property-block))
14355 (goto-char (car range))
14356 (while (re-search-forward
14358 (cdr range) t)
14359 (add-to-list 'rtn (org-match-string-no-properties 1)))
14360 (outline-next-heading))))
14362 (when include-specials
14363 (setq rtn (append org-special-properties rtn)))
14365 (when include-defaults
14366 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14367 (add-to-list 'rtn org-effort-property))
14369 (when include-columns
14370 (save-excursion
14371 (save-restriction
14372 (widen)
14373 (goto-char (point-min))
14374 (while (re-search-forward
14376 nil t)
14377 (setq cfmt (match-string 2) s 0)
14379 cfmt s)
14380 (setq s (match-end 0)
14381 p (match-string 1 cfmt))
14382 (unless (or (equal p "ITEM")
14383 (member p org-special-properties))
14384 (add-to-list 'rtn (match-string 1 cfmt))))))))
14386 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14388 (defun org-property-values (key)
14389 "Return a list of all values of property KEY in the current buffer."
14390 (save-excursion
14391 (save-restriction
14392 (widen)
14393 (goto-char (point-min))
14394 (let ((re (org-re-property key))
14395 values)
14396 (while (re-search-forward re nil t)
14397 (add-to-list 'values (org-trim (match-string 1))))
14398 (delete "" values)))))
14400 (defun org-insert-property-drawer ()
14401 "Insert a property drawer into the current entry."
14402 (interactive)
14403 (org-insert-drawer "PROPERTIES"))
14405 (defun org-insert-drawer (&optional drawer)
14406 "Insert a drawer into the current entry."
14407 (interactive)
14408 (if (org-region-active-p)
14409 (let ((rbeg (region-beginning))
14410 (rend (region-end))
14411 (drawer (or drawer (completing-read "Drawer: " org-drawers))))
14412 (goto-char rbeg)
14414 (move-beginning-of-line 1)
14415 (indent-for-tab-command)
14416 (goto-char rend)
14417 (move-end-of-line 1)
14419 (move-beginning-of-line 1)
14420 (indent-for-tab-command))
14421 (org-back-to-heading t)
14422 (looking-at org-outline-regexp)
14423 (let ((indent (if org-adapt-indentation
14424 (- (match-end 0) (match-beginning 0))
14425 0))
14426 (beg (point))
14428 (drawer (or drawer (completing-read "Drawer: " org-drawers)))
14429 end hiddenp)
14430 (outline-next-heading)
14431 (setq end (point))
14432 (goto-char beg)
14433 (while (re-search-forward re end t))
14434 (setq hiddenp (outline-invisible-p))
14435 (end-of-line 1)
14438 (if (member (match-string 1) '("CLOCK:" ":END:"))
14439 ;; just skip this line
14440 (beginning-of-line 2)
14441 ;; Drawer start, find the end
14443 (beginning-of-line 1)))
14444 (org-skip-over-state-notes)
14446 (if (eq (char-before) ?*) (forward-char 1))
14448 (beginning-of-line 0)
14449 (org-indent-to-column indent)
14450 (beginning-of-line 2)
14451 (org-indent-to-column indent)
14452 (beginning-of-line 0)
14453 (if hiddenp
14454 (save-excursion
14455 (org-back-to-heading t)
14456 (hide-entry))
14457 (org-flag-drawer t)))))
14459 (defvar org-property-set-functions-alist nil
14460 "Property set function alist.
14461 Each entry should have the following format:
14463 (PROPERTY . READ-FUNCTION)
14465 The read function will be called with the same argument as
14466 `org-completing-read'.")
14468 (defun org-set-property-function (property)
14469 "Get the function that should be used to set PROPERTY.
14470 This is computed according to `org-property-set-functions-alist'."
14471 (or (cdr (assoc property org-property-set-functions-alist))
14472 'org-completing-read))
14474 (defun org-read-property-value (property)
14475 "Read PROPERTY value from user."
14476 (let* ((completion-ignore-case t)
14477 (allowed (org-property-get-allowed-values nil property 'table))
14478 (cur (org-entry-get nil property))
14479 (prompt (concat property " value"
14481 (concat " [" cur "]") "") ": "))
14482 (set-function (org-set-property-function property))
14483 (val (if allowed
14484 (funcall set-function prompt allowed nil
14485 (not (get-text-property 0 'org-unrestricted
14486 (caar allowed))))
14487 (let (org-completion-use-ido org-completion-use-iswitchb)
14488 (funcall set-function prompt
14489 (mapcar 'list (org-property-values property))
14490 nil nil "" nil cur)))))
14491 (if (equal val "")
14492 cur
14493 val)))
14495 (defvar org-last-set-property nil)
14496 (defun org-read-property-name ()
14497 "Read a property name."
14498 (let* ((completion-ignore-case t)
14499 (keys (org-buffer-property-keys nil t t))
14500 (default-prop (or (save-excursion
14501 (save-match-data
14502 (beginning-of-line)
14504 (null (string= (match-string 1) "END"))
14505 (match-string 1))))
14506 org-last-set-property))
14507 (property (org-icompleting-read
14508 (concat "Property"
14509 (if default-prop (concat " [" default-prop "]") "")
14510 ": ")
14511 (mapcar 'list keys)
14512 nil nil nil nil
14513 default-prop
14514 )))
14515 (if (member property keys)
14516 property
14517 (or (cdr (assoc (downcase property)
14518 (mapcar (lambda (x) (cons (downcase x) x))
14519 keys)))
14520 property))))
14522 (defun org-set-property (property value)
14523 "In the current entry, set PROPERTY to VALUE.
14524 When called interactively, this will prompt for a property name, offering
14525 completion on existing and default properties. And then it will prompt
14526 for a value, offering completion either on allowed values (via an inherited
14527 xxx_ALL property) or on existing values in other instances of this property
14528 in the current file."
14529 (interactive (list nil nil))
14530 (let* ((property (or property (org-read-property-name)))
14531 (value (or value (org-read-property-value property)))
14532 (fn (assoc property org-properties-postprocess-alist)))
14533 (setq org-last-set-property property)
14534 ;; Possibly postprocess the inserted value:
14535 (when fn (setq value (funcall (cadr fn) value)))
14536 (unless (equal (org-entry-get nil property) value)
14537 (org-entry-put nil property value))))
14539 (defun org-delete-property (property)
14540 "In the current entry, delete PROPERTY."
14541 (interactive
14542 (let* ((completion-ignore-case t)
14543 (prop (org-icompleting-read "Property: "
14544 (org-entry-properties nil 'standard))))
14545 (list prop)))
14546 (message "Property %s %s" property
14547 (if (org-entry-delete nil property)
14548 "deleted"
14549 "was not present in the entry")))
14551 (defun org-delete-property-globally (property)
14552 "Remove PROPERTY globally, from all entries."
14553 (interactive
14554 (let* ((completion-ignore-case t)
14555 (prop (org-icompleting-read
14556 "Globally remove property: "
14557 (mapcar 'list (org-buffer-property-keys)))))
14558 (list prop)))
14559 (save-excursion
14560 (save-restriction
14561 (widen)
14562 (goto-char (point-min))
14563 (let ((cnt 0))
14564 (while (re-search-forward
14565 (org-re-property property)
14566 nil t)
14567 (setq cnt (1+ cnt))
14568 (replace-match ""))
14571 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14573 (defun org-compute-property-at-point ()
14574 "Compute the property at point.
14575 This looks for an enclosing column format, extracts the operator and
14576 then applies it to the property in the column format's scope."
14577 (interactive)
14578 (unless (org-at-property-p)
14579 (error "Not at a property"))
14580 (let ((prop (org-match-string-no-properties 2)))
14581 (org-columns-get-format-and-top-level)
14582 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14583 (error "No operator defined for property %s" prop))
14584 (org-columns-compute prop)))
14586 (defvar org-property-allowed-value-functions nil
14587 "Hook for functions supplying allowed values for a specific property.
14588 The functions must take a single argument, the name of the property, and
14590 the values, this means that these values are intended as defaults for
14591 completion, but that other values should be allowed too.
14592 The functions must return nil if they are not responsible for this
14593 property.")
14595 (defun org-property-get-allowed-values (pom property &optional table)
14596 "Get allowed values for the property PROPERTY.
14597 When TABLE is non-nil, return an alist that can directly be used for
14598 completion."
14599 (let (vals)
14600 (cond
14601 ((equal property "TODO")
14602 (setq vals (org-with-point-at pom
14603 (append org-todo-keywords-1 '("")))))
14604 ((equal property "PRIORITY")
14605 (let ((n org-lowest-priority))
14606 (while (>= n org-highest-priority)
14607 (push (char-to-string n) vals)
14608 (setq n (1- n)))))
14609 ((member property org-special-properties))
14610 ((setq vals (run-hook-with-args-until-success
14611 'org-property-allowed-value-functions property)))
14612 (t
14613 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14615 (setq vals (car (read-from-string (concat "(" vals ")"))))
14616 (setq vals (mapcar (lambda (x)
14617 (cond ((stringp x) x)
14618 ((numberp x) (number-to-string x))
14619 ((symbolp x) (symbol-name x))
14620 (t "???")))
14621 vals)))))
14622 (when (member ":ETC" vals)
14623 (setq vals (remove ":ETC" vals))
14624 (org-add-props (car vals) '(org-unrestricted t)))
14625 (if table (mapcar 'list vals) vals)))
14627 (defun org-property-previous-allowed-value (&optional previous)
14628 "Switch to the next allowed value for this property."
14629 (interactive)
14630 (org-property-next-allowed-value t))
14632 (defun org-property-next-allowed-value (&optional previous)
14633 "Switch to the next allowed value for this property."
14634 (interactive)
14635 (unless (org-at-property-p)
14636 (error "Not at a property"))
14637 (let* ((key (match-string 2))
14638 (value (match-string 3))
14639 (allowed (or (org-property-get-allowed-values (point) key)
14640 (and (member value '("[ ]" "[-]" "[X]"))
14641 '("[ ]" "[X]"))))
14642 nval)
14643 (unless allowed
14644 (error "Allowed values for this property have not been defined"))
14645 (if previous (setq allowed (reverse allowed)))
14646 (if (member value allowed)
14647 (setq nval (car (cdr (member value allowed)))))
14648 (setq nval (or nval (car allowed)))
14649 (if (equal nval value)
14650 (error "Only one allowed value for this property"))
14651 (org-at-property-p)
14652 (replace-match (concat " :" key ": " nval) t t)
14653 (org-indent-line-function)
14654 (beginning-of-line 1)
14656 (run-hook-with-args 'org-property-changed-functions key nval)))
14658 (defun org-find-olp (path &optional this-buffer)
14659 "Return a marker pointing to the entry at outline path OLP.
14660 If anything goes wrong, throw an error.
14661 You can wrap this call to catch the error like this:
14663 (condition-case msg
14664 (org-mobile-locate-entry (match-string 4))
14665 (error (nth 1 msg)))
14667 The return value will then be either a string with the error message,
14668 or a marker if everything is OK.
14670 If THIS-BUFFER is set, the outline path does not contain a file,
14671 only headings."
14672 (let* ((file (if this-buffer buffer-file-name (pop path)))
14673 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14674 (level 1)
14675 (lmin 1)
14676 (lmax 1)
14677 limit re end found pos heading cnt flevel)
14678 (unless buffer (error "File not found :%s" file))
14679 (with-current-buffer buffer
14680 (save-excursion
14681 (save-restriction
14682 (widen)
14683 (setq limit (point-max))
14684 (goto-char (point-min))
14685 (while (setq heading (pop path))
14686 (setq re (format org-complex-heading-regexp-format
14687 (regexp-quote heading)))
14688 (setq cnt 0 pos (point))
14689 (while (re-search-forward re end t)
14690 (setq level (- (match-end 1) (match-beginning 1)))
14691 (if (and (>= level lmin) (<= level lmax))
14692 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14693 (when (= cnt 0) (error "Heading not found on level %d: %s"
14694 lmax heading))
14695 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14696 lmax heading))
14697 (goto-char found)
14698 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14699 (setq end (save-excursion (org-end-of-subtree t t))))
14700 (when (org-at-heading-p)
14701 (move-marker (make-marker) (point))))))))
14703 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14704 "Find node HEADING in BUFFER.
14705 Return a marker to the heading if it was found, or nil if not.
14706 If POS-ONLY is set, return just the position instead of a marker.
14708 The heading text must match exact, but it may have a TODO keyword,
14709 a priority cookie and tags in the standard locations."
14710 (with-current-buffer (or buffer (current-buffer))
14711 (save-excursion
14712 (save-restriction
14713 (widen)
14714 (goto-char (point-min))
14715 (let (case-fold-search)
14716 (if (re-search-forward
14717 (format org-complex-heading-regexp-format
14718 (regexp-quote heading)) nil t)
14719 (if pos-only
14720 (match-beginning 0)
14721 (move-marker (make-marker) (match-beginning 0)))))))))
14723 (defun org-find-exact-heading-in-directory (heading &optional dir)
14724 "Find Org node headline HEADING in all .org files in directory DIR.
14725 When the target headline is found, return a marker to this location."
14726 (let ((files (directory-files (or dir default-directory)
14728 file visiting m buffer)
14729 (catch 'found
14730 (while (setq file (pop files))
14731 (message "trying %s" file)
14732 (setq visiting (org-find-base-buffer-visiting file))
14733 (setq buffer (or visiting (find-file-noselect file)))
14734 (setq m (org-find-exact-headline-in-buffer
14735 heading buffer))
14736 (when (and (not m) (not visiting)) (kill-buffer buffer))
14737 (and m (throw 'found m))))))
14739 (defun org-find-entry-with-id (ident)
14740 "Locate the entry that contains the ID property with exact value IDENT.
14741 IDENT can be a string, a symbol or a number, this function will search for
14742 the string representation of it.
14743 Return the position where this entry starts, or nil if there is no such entry."
14744 (interactive "sID: ")
14745 (let ((id (cond
14746 ((stringp ident) ident)
14747 ((symbol-name ident) (symbol-name ident))
14748 ((numberp ident) (number-to-string ident))
14749 (t (error "IDENT %s must be a string, symbol or number" ident))))
14750 (case-fold-search nil))
14751 (save-excursion
14752 (save-restriction
14753 (widen)
14754 (goto-char (point-min))
14755 (when (re-search-forward
14757 nil t)
14758 (org-back-to-heading t)
14759 (point))))))
14761 ;;;; Timestamps
14763 (defvar org-last-changed-timestamp nil)
14764 (defvar org-last-inserted-timestamp nil
14765 "The last time stamp inserted with `org-insert-time-stamp'.")
14766 (defvar org-time-was-given) ; dynamically scoped parameter
14767 (defvar org-end-time-was-given) ; dynamically scoped parameter
14768 (defvar org-ts-what) ; dynamically scoped parameter
14770 (defun org-time-stamp (arg &optional inactive)
14771 "Prompt for a date/time and insert a time stamp.
14772 If the user specifies a time like HH:MM, or if this command is called
14773 with a prefix argument, the time stamp will contain date and time.
14774 Otherwise, only the date will be included. All parts of a date not
14775 specified by the user will be filled in from the current date/time.
14776 So if you press just return without typing anything, the time stamp
14777 will represent the current date/time. If there is already a timestamp
14778 at the cursor, it will be modified."
14779 (interactive "P")
14780 (let* ((ts nil)
14781 (default-time
14782 ;; Default time is either today, or, when entering a range,
14783 ;; the range start.
14784 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14785 (save-excursion
14786 (re-search-backward
14788 (- (point) 20) t)))
14789 (apply 'encode-time (org-parse-time-string (match-string 1)))
14790 (current-time)))
14791 (default-input (and ts (org-get-compact-tod ts)))
14792 (repeater (save-excursion
14793 (save-match-data
14794 (beginning-of-line)
14795 (when (re-search-forward
14797 (save-excursion (progn (end-of-line) (point))) t)
14798 (match-string 0)))))
14799 org-time-was-given org-end-time-was-given time)
14800 (cond
14801 ((and (org-at-timestamp-p t)
14802 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14803 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14804 (insert "--")
14805 (setq time (let ((this-command this-command))
14806 (org-read-date arg 'totime nil nil
14807 default-time default-input inactive)))
14808 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14809 ((org-at-timestamp-p t)
14810 (setq time (let ((this-command this-command))
14811 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14812 (when (org-at-timestamp-p t) ; just to get the match data
14813 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14814 (replace-match "")
14815 (setq org-last-changed-timestamp
14816 (org-insert-time-stamp
14817 time (or org-time-was-given arg)
14818 inactive nil nil (list org-end-time-was-given)))
14819 (when repeater (goto-char (1- (point))) (insert " " repeater)
14820 (setq org-last-changed-timestamp
14821 (concat (substring org-last-inserted-timestamp 0 -1)
14822 " " repeater ">"))))
14823 (message "Timestamp updated"))
14824 (t
14825 (setq time (let ((this-command this-command))
14826 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14827 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14828 nil nil (list org-end-time-was-given))))))
14830 ;; FIXME: can we use this for something else, like computing time differences?
14831 (defun org-get-compact-tod (s)
14832 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14833 (let* ((t1 (match-string 1 s))
14834 (h1 (string-to-number (match-string 2 s)))
14835 (m1 (string-to-number (match-string 3 s)))
14836 (t2 (and (match-end 4) (match-string 5 s)))
14837 (h2 (and t2 (string-to-number (match-string 6 s))))
14838 (m2 (and t2 (string-to-number (match-string 7 s))))
14839 dh dm)
14840 (if (not t2)
14841 t1
14842 (setq dh (- h2 h1) dm (- m2 m1))
14843 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14844 (concat t1 "+" (number-to-string dh)
14845 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14847 (defun org-time-stamp-inactive (&optional arg)
14848 "Insert an inactive time stamp.
14849 An inactive time stamp is enclosed in square brackets instead of angle
14850 brackets. It is inactive in the sense that it does not trigger agenda entries,
14851 does not link to the calendar and cannot be changed with the S-cursor keys.
14852 So these are more for recording a certain time/date."
14853 (interactive "P")
14854 (org-time-stamp arg 'inactive))
14856 (defvar org-date-ovl (make-overlay 1 1))
14857 (overlay-put org-date-ovl 'face 'org-warning)
14858 (org-detach-overlay org-date-ovl)
14860 (defvar org-ans1) ; dynamically scoped parameter
14861 (defvar org-ans2) ; dynamically scoped parameter
14863 (defvar org-plain-time-of-day-regexp) ; defined below
14865 (defvar org-overriding-default-time nil) ; dynamically scoped
14866 (defvar org-read-date-overlay nil)
14867 (defvar org-dcst nil) ; dynamically scoped
14868 (defvar org-read-date-history nil)
14869 (defvar org-read-date-final-answer nil)
14870 (defvar org-read-date-analyze-futurep nil)
14871 (defvar org-read-date-analyze-forced-year nil)
14873 (defun org-read-date (&optional with-time to-time from-string prompt
14874 default-time default-input inactive)
14875 "Read a date, possibly a time, and make things smooth for the user.
14876 The prompt will suggest to enter an ISO date, but you can also enter anything
14877 which will at least partially be understood by `parse-time-string'.
14878 Unrecognized parts of the date will default to the current day, month, year,
14879 hour and minute. If this command is called to replace a timestamp at point,
14880 or to enter the second timestamp of a range, the default time is taken
14881 from the existing stamp. Furthermore, the command prefers the future,
14882 so if you are giving a date where the year is not given, and the day-month
14883 combination is already past in the current year, it will assume you
14884 mean next year. For details, see the manual. A few examples:
14886 3-2-5 --> 2003-02-05
14887 feb 15 --> currentyear-02-15
14888 2/15 --> currentyear-02-15
14889 sep 12 9 --> 2009-09-12
14890 12:45 --> today 12:45
14891 22 sept 0:34 --> currentyear-09-22 0:34
14892 12 --> currentyear-currentmonth-12
14893 Fri --> nearest Friday (today or later)
14894 etc.
14896 Furthermore you can specify a relative date by giving, as the *first* thing
14897 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14898 change in days weeks, months, years.
14899 With a single plus or minus, the date is relative to today. With a double
14900 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14901 +4d --> four days from today
14902 +4 --> same as above
14903 +2w --> two weeks from today
14904 ++5 --> five days from default date
14906 The function understands only English month and weekday abbreviations,
14907 but this can be configured with the variables `parse-time-months' and
14908 `parse-time-weekdays'.
14910 While prompting, a calendar is popped up - you can also select the
14911 date with the mouse (button 1). The calendar shows a period of three
14912 months. To scroll it to other months, use the keys `>' and `<'.
14913 If you don't like the calendar, turn it off with
14914 \(setq org-read-date-popup-calendar nil)
14916 With optional argument TO-TIME, the date will immediately be converted
14917 to an internal time.
14918 With an optional argument WITH-TIME, the prompt will suggest to also
14919 insert a time. Note that when WITH-TIME is not set, you can still
14920 enter a time, and this function will inform the calling routine about
14921 this change. The calling routine may then choose to change the format
14922 used to insert the time stamp into the buffer to include the time.
14923 With optional argument FROM-STRING, read from this string instead from
14924 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14925 the time/date that is used for everything that is not specified by the
14926 user."
14927 (require 'parse-time)
14928 (let* ((org-time-stamp-rounding-minutes
14929 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14930 (org-dcst org-display-custom-times)
14931 (ct (org-current-time))
14932 (def (or org-overriding-default-time default-time ct))
14933 (defdecode (decode-time def))
14934 (dummy (progn
14935 (when (< (nth 2 defdecode) org-extend-today-until)
14936 (setcar (nthcdr 2 defdecode) -1)
14937 (setcar (nthcdr 1 defdecode) 59)
14938 (setq def (apply 'encode-time defdecode)
14939 defdecode (decode-time def)))))
14940 (calendar-frame-setup nil)
14941 (calendar-setup nil)
14942 (calendar-move-hook nil)
14943 (calendar-view-diary-initially-flag nil)
14944 (calendar-view-holidays-initially-flag nil)
14945 (timestr (format-time-string
14946 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14947 (prompt (concat (if prompt (concat prompt " ") "")
14948 (format "Date+time [%s]: " timestr)))
14949 ans (org-ans0 "") org-ans1 org-ans2 final)
14951 (cond
14952 (from-string (setq ans from-string))
14953 (org-read-date-popup-calendar
14954 (save-excursion
14955 (save-window-excursion
14956 (calendar)
14957 (unwind-protect
14958 (progn
14959 (calendar-forward-day (- (time-to-days def)
14960 (calendar-absolute-from-gregorian
14961 (calendar-current-date))))
14962 (org-eval-in-calendar nil t)
14963 (let* ((old-map (current-local-map))
14964 (map (copy-keymap calendar-mode-map))
14965 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14966 (org-defkey map (kbd "RET") 'org-calendar-select)
14967 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14968 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14969 (org-defkey minibuffer-local-map [(meta shift left)]
14970 (lambda () (interactive)
14971 (org-eval-in-calendar '(calendar-backward-month 1))))
14972 (org-defkey minibuffer-local-map [(meta shift right)]
14973 (lambda () (interactive)
14974 (org-eval-in-calendar '(calendar-forward-month 1))))
14975 (org-defkey minibuffer-local-map [(meta shift up)]
14976 (lambda () (interactive)
14977 (org-eval-in-calendar '(calendar-backward-year 1))))
14978 (org-defkey minibuffer-local-map [(meta shift down)]
14979 (lambda () (interactive)
14980 (org-eval-in-calendar '(calendar-forward-year 1))))
14981 (org-defkey minibuffer-local-map [?\e (shift left)]
14982 (lambda () (interactive)
14983 (org-eval-in-calendar '(calendar-backward-month 1))))
14984 (org-defkey minibuffer-local-map [?\e (shift right)]
14985 (lambda () (interactive)
14986 (org-eval-in-calendar '(calendar-forward-month 1))))
14987 (org-defkey minibuffer-local-map [?\e (shift up)]
14988 (lambda () (interactive)
14989 (org-eval-in-calendar '(calendar-backward-year 1))))
14990 (org-defkey minibuffer-local-map [?\e (shift down)]
14991 (lambda () (interactive)
14992 (org-eval-in-calendar '(calendar-forward-year 1))))
14993 (org-defkey minibuffer-local-map [(shift up)]
14994 (lambda () (interactive)
14995 (org-eval-in-calendar '(calendar-backward-week 1))))
14996 (org-defkey minibuffer-local-map [(shift down)]
14997 (lambda () (interactive)
14998 (org-eval-in-calendar '(calendar-forward-week 1))))
14999 (org-defkey minibuffer-local-map [(shift left)]
15000 (lambda () (interactive)
15001 (org-eval-in-calendar '(calendar-backward-day 1))))
15002 (org-defkey minibuffer-local-map [(shift right)]
15003 (lambda () (interactive)
15004 (org-eval-in-calendar '(calendar-forward-day 1))))
15005 (org-defkey minibuffer-local-map ">"
15006 (lambda () (interactive)
15007 (org-eval-in-calendar '(scroll-calendar-left 1))))
15008 (org-defkey minibuffer-local-map "<"
15009 (lambda () (interactive)
15010 (org-eval-in-calendar '(scroll-calendar-right 1))))
15011 (org-defkey minibuffer-local-map "\C-v"
15012 (lambda () (interactive)
15013 (org-eval-in-calendar
15014 '(calendar-scroll-left-three-months 1))))
15015 (org-defkey minibuffer-local-map "\M-v"
15016 (lambda () (interactive)
15017 (org-eval-in-calendar
15018 '(calendar-scroll-right-three-months 1))))
15019 (run-hooks 'org-read-date-minibuffer-setup-hook)
15020 (unwind-protect
15021 (progn
15022 (use-local-map map)
15023 (setq org-read-date-inactive inactive)
15024 (add-hook 'post-command-hook 'org-read-date-display)
15025 (setq org-ans0 (read-string prompt default-input
15026 'org-read-date-history nil))
15027 ;; org-ans0: from prompt
15028 ;; org-ans1: from mouse click
15029 ;; org-ans2: from calendar motion
15030 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15031 (remove-hook 'post-command-hook 'org-read-date-display)
15032 (use-local-map old-map)
15033 (when org-read-date-overlay
15034 (delete-overlay org-read-date-overlay)
15035 (setq org-read-date-overlay nil)))))
15036 (bury-buffer "*Calendar*")))))
15038 (t ; Naked prompt only
15039 (unwind-protect
15040 (setq ans (read-string prompt default-input
15041 'org-read-date-history timestr))
15042 (when org-read-date-overlay
15043 (delete-overlay org-read-date-overlay)
15044 (setq org-read-date-overlay nil)))))
15046 (setq final (org-read-date-analyze ans def defdecode))
15048 (when org-read-date-analyze-forced-year
15049 (message "Year was forced into %s"
15050 (if org-read-date-force-compatible-dates
15051 "compatible range (1970-2037)"
15052 "range representable on this machine"))
15053 (ding))
15055 ;; One round trip to get rid of 34th of August and stuff like that....
15056 (setq final (decode-time (apply 'encode-time final)))
15058 (setq org-read-date-final-answer ans)
15060 (if to-time
15061 (apply 'encode-time final)
15062 (if (and (boundp 'org-time-was-given) org-time-was-given)
15063 (format "%04d-%02d-%02d %02d:%02d"
15064 (nth 5 final) (nth 4 final) (nth 3 final)
15065 (nth 2 final) (nth 1 final))
15066 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15068 (defvar def)
15069 (defvar defdecode)
15070 (defvar with-time)
15071 (defvar org-read-date-inactive)
15072 (defun org-read-date-display ()
15073 "Display the current date prompt interpretation in the minibuffer."
15074 (when org-read-date-display-live
15075 (when org-read-date-overlay
15076 (delete-overlay org-read-date-overlay))
15077 (let ((p (point)))
15078 (end-of-line 1)
15079 (while (not (equal (buffer-substring
15080 (max (point-min) (- (point) 4)) (point))
15081 " "))
15082 (insert " "))
15083 (goto-char p))
15084 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15085 " " (or org-ans1 org-ans2)))
15086 (org-end-time-was-given nil)
15087 (f (org-read-date-analyze ans def defdecode))
15088 (fmts (if org-dcst
15089 org-time-stamp-custom-formats
15090 org-time-stamp-formats))
15091 (fmt (if (or with-time
15092 (and (boundp 'org-time-was-given) org-time-was-given))
15093 (cdr fmts)
15094 (car fmts)))
15095 (txt (format-time-string fmt (apply 'encode-time f)))
15096 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15097 (txt (concat "=> " txt)))
15098 (when (and org-end-time-was-given
15099 (string-match org-plain-time-of-day-regexp txt))
15100 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15101 org-end-time-was-given
15102 (substring txt (match-end 0)))))
15103 (when org-read-date-analyze-futurep
15104 (setq txt (concat txt " (=>F)")))
15105 (setq org-read-date-overlay
15106 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15107 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15109 (defun org-read-date-analyze (ans def defdecode)
15110 "Analyze the combined answer of the date prompt."
15111 ;; FIXME: cleanup and comment
15112 (let ((nowdecode (decode-time (current-time)))
15113 delta deltan deltaw deltadef year month day
15114 hour minute second wday pm h2 m2 tl wday1
15115 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15116 (setq org-read-date-analyze-futurep nil
15117 org-read-date-analyze-forced-year nil)
15119 (setq ans "+0"))
15121 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15122 (setq ans (replace-match "" t t ans)
15123 deltan (car delta)
15124 deltaw (nth 1 delta)
15125 deltadef (nth 2 delta)))
15127 ;; Check if there is an iso week date in there
15128 ;; If yes, store the info and postpone interpreting it until the rest
15129 ;; of the parsing is done
15130 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15131 (setq iso-year (if (match-end 1)
15132 (org-small-year-to-year
15133 (string-to-number (match-string 1 ans))))
15134 iso-weekday (if (match-end 3)
15135 (string-to-number (match-string 3 ans)))
15136 iso-week (string-to-number (match-string 2 ans)))
15137 (setq ans (replace-match "" t t ans)))
15139 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15140 (when (string-match
15142 (setq year (if (match-end 2)
15143 (string-to-number (match-string 2 ans))
15144 (progn (setq kill-year t)
15145 (string-to-number (format-time-string "%Y"))))
15146 month (string-to-number (match-string 3 ans))
15147 day (string-to-number (match-string 4 ans)))
15148 (if (< year 100) (setq year (+ 2000 year)))
15150 t nil ans)))
15152 ;; Help matching dotted european dates
15153 (when (string-match
15154 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15155 (setq year (if (match-end 3)
15156 (string-to-number (match-string 3 ans))
15157 (progn (setq kill-year t)
15158 (string-to-number (format-time-string "%Y"))))
15159 day (string-to-number (match-string 1 ans))
15160 month (string-to-number (match-string 2 ans))
15162 t nil ans)))
15164 ;; Help matching american dates, like 5/30 or 5/30/7
15165 (when (string-match
15166 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15167 (setq year (if (match-end 4)
15168 (string-to-number (match-string 4 ans))
15169 (progn (setq kill-year t)
15170 (string-to-number (format-time-string "%Y"))))
15171 month (string-to-number (match-string 1 ans))
15172 day (string-to-number (match-string 2 ans)))
15173 (if (< year 100) (setq year (+ 2000 year)))
15175 t nil ans)))
15176 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15177 ;; If there is a time with am/pm, and *no* time without it, we convert
15178 ;; so that matching will be successful.
15179 (loop for i from 1 to 2 do ; twice, for end time as well
15182 (setq hour (string-to-number (match-string 1 ans))
15183 minute (if (match-end 3)
15184 (string-to-number (match-string 3 ans))
15185 0)
15186 pm (equal ?p
15187 (string-to-char (downcase (match-string 4 ans)))))
15188 (if (and (= hour 12) (not pm))
15189 (setq hour 0)
15190 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15191 (setq ans (replace-match (format "%02d:%02d" hour minute)
15192 t t ans))))
15194 ;; Check if a time range is given as a duration
15195 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15196 (setq hour (string-to-number (match-string 1 ans))
15197 h2 (+ hour (string-to-number (match-string 3 ans)))
15198 minute (string-to-number (match-string 2 ans))
15199 m2 (+ minute (if (match-end 5) (string-to-number
15200 (match-string 5 ans))0)))
15201 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15202 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15203 t t ans)))
15205 ;; Check if there is a time range
15206 (when (boundp 'org-end-time-was-given)
15207 (setq org-time-was-given nil)
15208 (when (and (string-match org-plain-time-of-day-regexp ans)
15209 (match-end 8))
15210 (setq org-end-time-was-given (match-string 8 ans))
15211 (setq ans (concat (substring ans 0 (match-beginning 7))
15212 (substring ans (match-end 7))))))
15214 (setq tl (parse-time-string ans)
15215 day (or (nth 3 tl) (nth 3 defdecode))
15216 month (or (nth 4 tl)
15217 (if (and org-read-date-prefer-future
15218 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15219 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15220 (nth 4 defdecode)))
15221 year (or (and (not kill-year) (nth 5 tl))
15222 (if (and org-read-date-prefer-future
15223 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15224 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15225 (nth 5 defdecode)))
15226 hour (or (nth 2 tl) (nth 2 defdecode))
15227 minute (or (nth 1 tl) (nth 1 defdecode))
15228 second (or (nth 0 tl) 0)
15229 wday (nth 6 tl))
15231 (when (and (eq org-read-date-prefer-future 'time)
15232 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15233 (equal day (nth 3 nowdecode))
15234 (equal month (nth 4 nowdecode))
15235 (equal year (nth 5 nowdecode))
15236 (nth 2 tl)
15237 (or (< (nth 2 tl) (nth 2 nowdecode))
15238 (and (= (nth 2 tl) (nth 2 nowdecode))
15239 (nth 1 tl)
15240 (< (nth 1 tl) (nth 1 nowdecode)))))
15241 (setq day (1+ day)
15242 futurep t))
15244 ;; Special date definitions below
15245 (cond
15246 (iso-week
15247 ;; There was an iso week
15248 (require 'cal-iso)
15249 (setq futurep nil)
15250 (setq year (or iso-year year)
15251 day (or iso-weekday wday 1)
15252 wday nil ; to make sure that the trigger below does not match
15253 iso-date (calendar-gregorian-from-absolute
15254 (calendar-absolute-from-iso
15255 (list iso-week day year))))
15256 ; FIXME: Should we also push ISO weeks into the future?
15257 ; (when (and org-read-date-prefer-future
15258 ; (not iso-year)
15259 ; (< (calendar-absolute-from-gregorian iso-date)
15260 ; (time-to-days (current-time))))
15261 ; (setq year (1+ year)
15262 ; iso-date (calendar-gregorian-from-absolute
15263 ; (calendar-absolute-from-iso
15264 ; (list iso-week day year)))))
15265 (setq month (car iso-date)
15266 year (nth 2 iso-date)
15267 day (nth 1 iso-date)))
15268 (deltan
15269 (setq futurep nil)
15270 (unless deltadef
15271 (let ((now (decode-time (current-time))))
15272 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15273 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15274 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15275 ((equal deltaw "m") (setq month (+ month deltan)))
15276 ((equal deltaw "y") (setq year (+ year deltan)))))
15277 ((and wday (not (nth 3 tl)))
15278 (setq futurep nil)
15279 ;; Weekday was given, but no day, so pick that day in the week
15280 ;; on or after the derived date.
15281 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15282 (unless (equal wday wday1)
15283 (setq day (+ day (% (- wday wday1 -7) 7))))))
15284 (if (and (boundp 'org-time-was-given)
15285 (nth 2 tl))
15286 (setq org-time-was-given t))
15287 (if (< year 100) (setq year (+ 2000 year)))
15288 ;; Check of the date is representable
15289 (if org-read-date-force-compatible-dates
15290 (progn
15291 (if (< year 1970)
15292 (setq year 1970 org-read-date-analyze-forced-year t))
15293 (if (> year 2037)
15294 (setq year 2037 org-read-date-analyze-forced-year t)))
15295 (condition-case nil
15296 (ignore (encode-time second minute hour day month year))
15297 (error
15298 (setq year (nth 5 defdecode))
15299 (setq org-read-date-analyze-forced-year t))))
15300 (setq org-read-date-analyze-futurep futurep)
15301 (list second minute hour day month year)))
15303 (defvar parse-time-weekdays)
15305 (defun org-read-date-get-relative (s today default)
15306 "Check string S for special relative date string.
15307 TODAY and DEFAULT are internal times, for today and for a default.
15308 Return shift list (N what def-flag)
15310 N is the number of WHATs to shift.
15311 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15312 the DEFAULT date rather than TODAY."
15313 (require 'parse-time)
15314 (when (and
15315 (string-match
15316 (concat
15321 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15322 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15323 (string-to-char (substring (match-string 1 s) -1))
15324 ?+))
15325 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15326 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15327 (what (if (match-end 3) (match-string 3 s) "d"))
15328 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15329 (date (if rel default today))
15330 (wday (nth 6 (decode-time date)))
15331 delta)
15332 (if wday1
15333 (progn
15334 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15335 (if (= dir ?-) (setq delta (- delta 7)))
15336 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15337 (list delta "d" rel))
15338 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15340 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15341 "Turn a user-specified date into the internal representation.
15342 The internal representation needed by the calendar is (month day year).
15343 This is a wrapper to handle the brain-dead convention in calendar that
15344 user function argument order change dependent on argument order."
15345 (if (boundp 'calendar-date-style)
15346 (cond
15347 ((eq calendar-date-style 'american)
15348 (list arg1 arg2 arg3))
15349 ((eq calendar-date-style 'european)
15350 (list arg2 arg1 arg3))
15351 ((eq calendar-date-style 'iso)
15352 (list arg2 arg3 arg1)))
15353 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15354 (if (org-bound-and-true-p european-calendar-style)
15355 (list arg2 arg1 arg3)
15356 (list arg1 arg2 arg3)))))
15358 (defun org-eval-in-calendar (form &optional keepdate)
15359 "Eval FORM in the calendar window and return to current window.
15360 Also, store the cursor date in variable org-ans2."
15361 (let ((sf (selected-frame))
15362 (sw (selected-window)))
15363 (select-window (get-buffer-window "*Calendar*" t))
15364 (eval form)
15365 (when (and (not keepdate) (calendar-cursor-to-date))
15366 (let* ((date (calendar-cursor-to-date))
15367 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15368 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15369 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15370 (select-window sw)
15371 (org-select-frame-set-input-focus sf)))
15373 (defun org-calendar-select ()
15374 "Return to `org-read-date' with the date currently selected.
15375 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15376 (interactive)
15377 (when (calendar-cursor-to-date)
15378 (let* ((date (calendar-cursor-to-date))
15379 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15380 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15381 (if (active-minibuffer-window) (exit-minibuffer))))
15383 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15384 "Insert a date stamp for the date given by the internal TIME.
15385 WITH-HM means use the stamp format that includes the time of the day.
15386 INACTIVE means use square brackets instead of angular ones, so that the
15387 stamp will not contribute to the agenda.
15388 PRE and POST are optional strings to be inserted before and after the
15389 stamp.
15390 The command returns the inserted time stamp."
15391 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15392 stamp)
15393 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15394 (insert-before-markers (or pre ""))
15395 (when (listp extra)
15396 (setq extra (car extra))
15397 (if (and (stringp extra)
15399 (setq extra (format "-%02d:%02d"
15400 (string-to-number (match-string 1 extra))
15401 (string-to-number (match-string 2 extra))))
15402 (setq extra nil)))
15403 (when extra
15404 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15405 (insert-before-markers (setq stamp (format-time-string fmt time)))
15406 (insert-before-markers (or post ""))
15407 (setq org-last-inserted-timestamp stamp)))
15409 (defun org-toggle-time-stamp-overlays ()
15410 "Toggle the use of custom time stamp formats."
15411 (interactive)
15412 (setq org-display-custom-times (not org-display-custom-times))
15413 (unless org-display-custom-times
15414 (let ((p (point-min)) (bmp (buffer-modified-p)))
15415 (while (setq p (next-single-property-change p 'display))
15416 (if (and (get-text-property p 'display)
15417 (eq (get-text-property p 'face) 'org-date))
15418 (remove-text-properties
15419 p (setq p (next-single-property-change p 'display))
15420 '(display t))))
15421 (set-buffer-modified-p bmp)))
15422 (if (featurep 'xemacs)
15423 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15424 (org-restart-font-lock)
15425 (setq org-table-may-need-update t)
15426 (if org-display-custom-times
15427 (message "Time stamps are overlaid with custom format")
15428 (message "Time stamp overlays removed")))
15430 (defun org-display-custom-time (beg end)
15431 "Overlay modified time stamp format over timestamp between BEG and END."
15432 (let* ((ts (buffer-substring beg end))
15433 t1 w1 with-hm tf time str w2 (off 0))
15434 (save-match-data
15435 (setq t1 (org-parse-time-string ts t))
15436 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15437 (setq off (- (match-end 0) (match-beginning 0)))))
15438 (setq end (- end off))
15439 (setq w1 (- end beg)
15440 with-hm (and (nth 1 t1) (nth 2 t1))
15441 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15442 time (org-fix-decoded-time t1)
15443 str (org-add-props
15444 (format-time-string
15445 (substring tf 1 -1) (apply 'encode-time time))
15446 nil 'mouse-face 'highlight)
15447 w2 (length str))
15448 (if (not (= w2 w1))
15449 (add-text-properties (1+ beg) (+ 2 beg)
15450 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15451 (if (featurep 'xemacs)
15452 (progn
15453 (put-text-property beg end 'invisible t)
15454 (put-text-property beg end 'end-glyph (make-glyph str)))
15455 (put-text-property beg end 'display str))))
15457 (defun org-translate-time (string)
15458 "Translate all timestamps in STRING to custom format.
15459 But do this only if the variable `org-display-custom-times' is set."
15460 (when org-display-custom-times
15461 (save-match-data
15462 (let* ((start 0)
15463 (re org-ts-regexp-both)
15464 t1 with-hm inactive tf time str beg end)
15465 (while (setq start (string-match re string start))
15466 (setq beg (match-beginning 0)
15467 end (match-end 0)
15468 t1 (save-match-data
15469 (org-parse-time-string (substring string beg end) t))
15470 with-hm (and (nth 1 t1) (nth 2 t1))
15471 inactive (equal (substring string beg (1+ beg)) "[")
15472 tf (funcall (if with-hm 'cdr 'car)
15473 org-time-stamp-custom-formats)
15474 time (org-fix-decoded-time t1)
15475 str (format-time-string
15476 (concat
15477 (if inactive "[" "<") (substring tf 1 -1)
15478 (if inactive "]" ">"))
15479 (apply 'encode-time time))
15480 string (replace-match str t t string)
15481 start (+ start (length str)))))))
15482 string)
15484 (defun org-fix-decoded-time (time)
15485 "Set 0 instead of nil for the first 6 elements of time.
15486 Don't touch the rest."
15487 (let ((n 0))
15488 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15490 (defun org-days-to-time (timestamp-string)
15491 "Difference between TIMESTAMP-STRING and now in days."
15492 (- (time-to-days (org-time-string-to-time timestamp-string))
15493 (time-to-days (current-time))))
15495 (defun org-deadline-close (timestamp-string &optional ndays)
15496 "Is the time in TIMESTAMP-STRING close to the current date?"
15497 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15498 (and (< (org-days-to-time timestamp-string) ndays)
15499 (not (org-entry-is-done-p))))
15501 (defun org-get-wdays (ts)
15502 "Get the deadline lead time appropriate for timestring TS."
15503 (cond
15504 ((<= org-deadline-warning-days 0)
15505 ;; 0 or negative, enforce this value no matter what
15506 (- org-deadline-warning-days))
15508 ;; lead time is specified.
15509 (floor (* (string-to-number (match-string 1 ts))
15510 (cdr (assoc (match-string 2 ts)
15511 '(("d" . 1) ("w" . 7)
15512 ("m" . 30.4) ("y" . 365.25)))))))
15513 ;; go for the default.
15514 (t org-deadline-warning-days)))
15516 (defun org-calendar-select-mouse (ev)
15517 "Return to `org-read-date' with the date currently selected.
15518 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15519 (interactive "e")
15520 (mouse-set-point ev)
15521 (when (calendar-cursor-to-date)
15522 (let* ((date (calendar-cursor-to-date))
15523 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15524 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15525 (if (active-minibuffer-window) (exit-minibuffer))))
15527 (defun org-check-deadlines (ndays)
15528 "Check if there are any deadlines due or past due.
15529 A deadline is considered due if it happens within `org-deadline-warning-days'
15530 days from today's date. If the deadline appears in an entry marked DONE,
15531 it is not shown. The prefix arg NDAYS can be used to test that many
15533 (interactive "P")
15534 (let* ((org-warn-days
15535 (cond
15536 ((equal ndays '(4)) 100000)
15537 (ndays (prefix-numeric-value ndays))
15538 (t (abs org-deadline-warning-days))))
15539 (case-fold-search nil)
15541 (callback
15542 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15544 (message "%d deadlines past-due or due within %d days"
15545 (org-occur regexp nil callback)
15546 org-warn-days)))
15548 (defun org-check-before-date (date)
15549 "Check if there are deadlines or scheduled entries before DATE."
15550 (interactive (list (org-read-date)))
15551 (let ((case-fold-search nil)
15555 (callback
15556 (lambda () (time-less-p
15557 (org-time-string-to-time (match-string 2))
15558 (org-time-string-to-time date)))))
15559 (message "%d entries before %s"
15560 (org-occur regexp nil callback) date)))
15562 (defun org-check-after-date (date)
15563 "Check if there are deadlines or scheduled entries after DATE."
15564 (interactive (list (org-read-date)))
15565 (let ((case-fold-search nil)
15569 (callback
15570 (lambda () (not
15571 (time-less-p
15572 (org-time-string-to-time (match-string 2))
15573 (org-time-string-to-time date))))))
15574 (message "%d entries after %s"
15575 (org-occur regexp nil callback) date)))
15577 (defun org-check-dates-range (start-date end-date)
15578 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15579 (interactive (list (org-read-date nil nil nil "Range starts")
15580 (org-read-date nil nil nil "Range end")))
15581 (let ((case-fold-search nil)
15585 (callback
15586 (lambda ()
15587 (let ((match (match-string 2)))
15588 (and
15589 (not (time-less-p
15590 (org-time-string-to-time match)
15591 (org-time-string-to-time start-date)))
15592 (time-less-p
15593 (org-time-string-to-time match)
15594 (org-time-string-to-time end-date)))))))
15595 (message "%d entries between %s and %s"
15596 (org-occur regexp nil callback) start-date end-date)))
15598 (defun org-evaluate-time-range (&optional to-buffer)
15599 "Evaluate a time range by computing the difference between start and end.
15600 Normally the result is just printed in the echo area, but with prefix arg
15601 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15602 If the time range is actually in a table, the result is inserted into the
15603 next column.
15604 For time difference computation, a year is assumed to be exactly 365
15605 days in order to avoid rounding problems."
15606 (interactive "P")
15607 (or
15608 (org-clock-update-time-maybe)
15609 (save-excursion
15610 (unless (org-at-date-range-p t)
15611 (goto-char (point-at-bol))
15612 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15613 (if (not (org-at-date-range-p t))
15614 (error "Not at a time-stamp range, and none found in current line")))
15615 (let* ((ts1 (match-string 1))
15616 (ts2 (match-string 2))
15617 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15618 (match-end (match-end 0))
15619 (time1 (org-time-string-to-time ts1))
15620 (time2 (org-time-string-to-time ts2))
15621 (t1 (org-float-time time1))
15622 (t2 (org-float-time time2))
15623 (diff (abs (- t2 t1)))
15624 (negative (< (- t2 t1) 0))
15625 ;; (ys (floor (* 365 24 60 60)))
15626 (ds (* 24 60 60))
15627 (hs (* 60 60))
15628 (fy "%dy %dd %02d:%02d")
15629 (fy1 "%dy %dd")
15630 (fd "%dd %02d:%02d")
15631 (fd1 "%dd")
15632 (fh "%02d:%02d")
15633 y d h m align)
15634 (if havetime
15635 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15636 y 0
15637 d (floor (/ diff ds)) diff (mod diff ds)
15638 h (floor (/ diff hs)) diff (mod diff hs)
15639 m (floor (/ diff 60)))
15640 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15641 y 0
15642 d (floor (+ (/ diff ds) 0.5))
15643 h 0 m 0))
15644 (if (not to-buffer)
15645 (message "%s" (org-make-tdiff-string y d h m))
15646 (if (org-at-table-p)
15647 (progn
15648 (goto-char match-end)
15649 (setq align t)
15650 (and (looking-at " *|") (goto-char (match-end 0))))
15651 (goto-char match-end))
15652 (if (looking-at
15654 (replace-match ""))
15655 (if negative (insert " -"))
15656 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15657 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15658 (insert " " (format fh h m))))
15659 (if align (org-table-align))
15660 (message "Time difference inserted")))))
15662 (defun org-make-tdiff-string (y d h m)
15663 (let ((fmt "")
15664 (l nil))
15665 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15666 l (push y l)))
15667 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15668 l (push d l)))
15669 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15670 l (push h l)))
15671 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15672 l (push m l)))
15673 (apply 'format fmt (nreverse l))))
15675 (defun org-time-string-to-time (s &optional buffer pos)
15676 (condition-case errdata
15677 (apply 'encode-time (org-parse-time-string s))
15679 s (if (not (and buffer pos))
15680 ""
15681 (format " at %d in buffer `%s'" pos buffer))
15682 (cdr errdata)))))
15684 (defun org-time-string-to-seconds (s)
15685 (org-float-time (org-time-string-to-time s)))
15687 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15688 "Convert a time stamp to an absolute day number.
15689 If there is a specifier for a cyclic time stamp, get the closest date to
15690 DAYNR.
15691 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15692 The variable date is bound by the calendar when this is called."
15693 (cond
15695 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15696 daynr
15697 (+ daynr 1000)))
15699 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15700 (time-to-days (current-time))) (match-string 0 s)
15701 prefer show-all))
15702 (t (time-to-days
15703 (condition-case errdata
15704 (apply 'encode-time (org-parse-time-string s))
15706 s (if (not (and buffer pos))
15707 ""
15708 (format " at %d in buffer `%s'" pos buffer))
15709 (cdr errdata))))))))
15711 (defun org-days-to-iso-week (days)
15712 "Return the iso week number."
15713 (require 'cal-iso)
15714 (car (calendar-iso-from-absolute days)))
15716 (defun org-small-year-to-year (year)
15717 "Convert 2-digit years into 4-digit years.
15718 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15719 The year 2000 cannot be abbreviated. Any year larger than 99
15720 is returned unchanged."
15721 (if (< year 38)
15722 (setq year (+ 2000 year))
15723 (if (< year 100)
15724 (setq year (+ 1900 year))))
15725 year)
15727 (defun org-time-from-absolute (d)
15728 "Return the time corresponding to date D.
15729 D may be an absolute day number, or a calendar-type list (month day year)."
15730 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15731 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15733 (defun org-calendar-holiday ()
15734 "List of holidays, for Diary display in Org-mode."
15735 (require 'holidays)
15736 (let ((hl (funcall
15737 (if (fboundp 'calendar-check-holidays)
15738 'calendar-check-holidays 'check-calendar-holidays) date)))
15739 (if hl (mapconcat 'identity hl "; "))))
15741 (defun org-diary-sexp-entry (sexp entry date)
15742 "Process a SEXP diary ENTRY for DATE."
15743 (require 'diary-lib)
15744 (let ((result (if calendar-debug-sexp
15745 (let ((stack-trace-on-error t))
15746 (eval (car (read-from-string sexp))))
15747 (condition-case nil
15748 (eval (car (read-from-string sexp)))
15749 (error
15750 (beep)
15751 (message "Bad sexp at line %d in %s: %s"
15752 (org-current-line)
15753 (buffer-file-name) sexp)
15754 (sleep-for 2))))))
15755 (cond ((stringp result) (split-string result "; "))
15756 ((and (consp result)
15757 (not (consp (cdr result)))
15758 (stringp (cdr result))) (cdr result))
15759 ((and (consp result)
15760 (stringp (car result))) result)
15761 (result entry)
15762 (t nil))))
15764 (defun org-diary-to-ical-string (frombuf)
15765 "Get iCalendar entries from diary entries in buffer FROMBUF.
15766 This uses the icalendar.el library."
15767 (let* ((tmpdir (if (featurep 'xemacs)
15768 (temp-directory)
15769 temporary-file-directory))
15770 (tmpfile (make-temp-name
15771 (expand-file-name "orgics" tmpdir)))
15772 buf rtn b e)
15773 (with-current-buffer frombuf
15774 (icalendar-export-region (point-min) (point-max) tmpfile)
15775 (setq buf (find-buffer-visiting tmpfile))
15776 (set-buffer buf)
15777 (goto-char (point-min))
15778 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15779 (setq b (match-beginning 0)))
15780 (goto-char (point-max))
15781 (if (re-search-backward "^END:VEVENT" nil t)
15782 (setq e (match-end 0)))
15784 (kill-buffer buf)
15785 (delete-file tmpfile)
15786 rtn))
15788 (defun org-closest-date (start current change prefer show-all)
15789 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15790 When PREFER is `past', return a date that is either CURRENT or past.
15791 When PREFER is `future', return a date that is either CURRENT or future.
15792 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15793 ;; Make the proper lists from the dates
15794 (catch 'exit
15795 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15796 dn dw sday cday n1 n2 n0
15797 d m y y1 y2 date1 date2 nmonths nm ny m2)
15799 (setq start (org-date-to-gregorian start)
15800 current (org-date-to-gregorian
15801 (if show-all
15802 current
15803 (time-to-days (current-time))))
15804 sday (calendar-absolute-from-gregorian start)
15805 cday (calendar-absolute-from-gregorian current))
15807 (if (<= cday sday) (throw 'exit sday))
15810 (setq dn (string-to-number (match-string 1 change))
15811 dw (cdr (assoc (match-string 2 change) a1)))
15812 (error "Invalid change specifier: %s" change))
15813 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15814 (cond
15815 ((eq dw 'day)
15816 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15817 n2 (+ n1 dn)))
15818 ((eq dw 'year)
15819 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15820 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15821 (setq date1 (list m d y1)
15822 n1 (calendar-absolute-from-gregorian date1)
15823 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15824 n2 (calendar-absolute-from-gregorian date2)))
15825 ((eq dw 'month)
15826 ;; approx number of month between the two dates
15827 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15828 ;; How often does dn fit in there?
15829 (setq d (nth 1 start) m (car start) y (nth 2 start)
15830 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15831 m (+ m nm)
15832 ny (floor (/ m 12))
15833 y (+ y ny)
15834 m (- m (* ny 12)))
15835 (while (> m 12) (setq m (- m 12) y (1+ y)))
15836 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15837 (setq m2 (+ m dn) y2 y)
15838 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15839 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15840 (while (<= n2 cday)
15841 (setq n1 n2 m m2 y y2)
15842 (setq m2 (+ m dn) y2 y)
15843 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15844 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15845 ;; Make sure n1 is the earlier date
15846 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15847 (if show-all
15848 (cond
15849 ((eq prefer 'past) (if (= cday n2) n2 n1))
15850 ((eq prefer 'future) (if (= cday n1) n1 n2))
15851 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15852 (cond
15853 ((eq prefer 'past) (if (= cday n2) n2 n1))
15854 ((eq prefer 'future) (if (= cday n1) n1 n2))
15855 (t (if (= cday n1) n1 n2)))))))
15857 (defun org-date-to-gregorian (date)
15858 "Turn any specification of DATE into a Gregorian date for the calendar."
15859 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15860 ((and (listp date) (= (length date) 3)) date)
15861 ((stringp date)
15862 (setq date (org-parse-time-string date))
15863 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15864 ((listp date)
15865 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15867 (defun org-parse-time-string (s &optional nodefault)
15868 "Parse the standard Org-mode time string.
15869 This should be a lot faster than the normal `parse-time-string'.
15870 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15871 hour and minute fields will be nil if not given."
15872 (if (string-match org-ts-regexp0 s)
15873 (list 0
15874 (if (or (match-beginning 8) (not nodefault))
15875 (string-to-number (or (match-string 8 s) "0")))
15876 (if (or (match-beginning 7) (not nodefault))
15877 (string-to-number (or (match-string 7 s) "0")))
15878 (string-to-number (match-string 4 s))
15879 (string-to-number (match-string 3 s))
15880 (string-to-number (match-string 2 s))
15881 nil nil nil)
15882 (error "Not a standard Org-mode time string: %s" s)))
15884 (defun org-timestamp-up (&optional arg)
15885 "Increase the date item at the cursor by one.
15886 If the cursor is on the year, change the year. If it is on the month,
15887 the day or the time, change that.
15888 With prefix ARG, change by that many units."
15889 (interactive "p")
15890 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15892 (defun org-timestamp-down (&optional arg)
15893 "Decrease the date item at the cursor by one.
15894 If the cursor is on the year, change the year. If it is on the month,
15895 the day or the time, change that.
15896 With prefix ARG, change by that many units."
15897 (interactive "p")
15898 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15900 (defun org-timestamp-up-day (&optional arg)
15901 "Increase the date in the time stamp by one day.
15902 With prefix ARG, change that many days."
15903 (interactive "p")
15904 (if (and (not (org-at-timestamp-p t))
15905 (org-at-heading-p))
15906 (org-todo 'up)
15907 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15909 (defun org-timestamp-down-day (&optional arg)
15910 "Decrease the date in the time stamp by one day.
15911 With prefix ARG, change that many days."
15912 (interactive "p")
15913 (if (and (not (org-at-timestamp-p t))
15914 (org-at-heading-p))
15915 (org-todo 'down)
15916 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15918 (defun org-at-timestamp-p (&optional inactive-ok)
15919 "Determine if the cursor is in or at a timestamp."
15920 (interactive)
15921 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15922 (pos (point))
15923 (ans (or (looking-at tsr)
15924 (save-excursion
15926 (if (> (point) (point-min)) (backward-char 1))
15927 (and (looking-at tsr)
15928 (> (- (match-end 0) pos) -1))))))
15929 (and ans
15930 (boundp 'org-ts-what)
15931 (setq org-ts-what
15932 (cond
15933 ((= pos (match-beginning 0)) 'bracket)
15934 ;; Point is considered to be "on the bracket" whether
15935 ;; it's really on it or right after it.
15936 ((or (= pos (1- (match-end 0)))
15937 (= pos (match-end 0))) 'bracket)
15938 ((org-pos-in-match-range pos 2) 'year)
15939 ((org-pos-in-match-range pos 3) 'month)
15940 ((org-pos-in-match-range pos 7) 'hour)
15941 ((org-pos-in-match-range pos 8) 'minute)
15942 ((or (org-pos-in-match-range pos 4)
15943 (org-pos-in-match-range pos 5)) 'day)
15944 ((and (> pos (or (match-end 8) (match-end 5)))
15945 (< pos (match-end 0)))
15946 (- pos (or (match-end 8) (match-end 5))))
15947 (t 'day))))
15948 ans))
15950 (defun org-toggle-timestamp-type ()
15951 "Toggle the type (<active> or [inactive]) of a time stamp."
15952 (interactive)
15953 (when (org-at-timestamp-p t)
15954 (let ((beg (match-beginning 0)) (end (match-end 0))
15955 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15956 (save-excursion
15957 (goto-char beg)
15958 (while (re-search-forward "[][<>]" end t)
15959 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15960 t t)))
15961 (message "Timestamp is now %sactive"
15962 (if (equal (char-after beg) ?<) "" "in")))))
15964 (defun org-timestamp-change (n &optional what updown)
15965 "Change the date in the time stamp at point.
15966 The date will be changed by N times WHAT. WHAT can be `day', `month',
15967 `year', `minute', `second'. If WHAT is not given, the cursor position
15968 in the timestamp determines what will be changed."
15969 (let ((origin (point)) origin-cat
15970 with-hm inactive
15971 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15972 org-ts-what
15973 extra rem
15974 ts time time0)
15975 (if (not (org-at-timestamp-p t))
15976 (error "Not at a timestamp"))
15977 (if (and (not what) (eq org-ts-what 'bracket))
15978 (org-toggle-timestamp-type)
15979 ;; Point isn't on brackets. Remember the part of the time-stamp
15980 ;; the point was in. Indeed, size of time-stamps may change,
15981 ;; but point must be kept in the same category nonetheless.
15982 (setq origin-cat org-ts-what)
15983 (if (and (not what) (not (eq org-ts-what 'day))
15984 org-display-custom-times
15985 (get-text-property (point) 'display)
15986 (not (get-text-property (1- (point)) 'display)))
15987 (setq org-ts-what 'day))
15988 (setq org-ts-what (or what org-ts-what)
15989 inactive (= (char-after (match-beginning 0)) ?\[)
15990 ts (match-string 0))
15991 (replace-match "")
15992 (if (string-match
15994 ts)
15995 (setq extra (match-string 1 ts)))
15997 (setq with-hm t))
15998 (setq time0 (org-parse-time-string ts))
15999 (when (and updown
16000 (eq org-ts-what 'minute)
16001 (not current-prefix-arg))
16002 ;; This looks like s-up and s-down. Change by one rounding step.
16003 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16004 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16005 (setcar (cdr time0) (+ (nth 1 time0)
16006 (if (> n 0) (- rem) (- dm rem))))))
16007 (setq time
16008 (encode-time (or (car time0) 0)
16009 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16010 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16011 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16012 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16013 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16014 (nthcdr 6 time0)))
16015 (when (and (member org-ts-what '(hour minute))
16016 extra
16018 (setq extra (org-modify-ts-extra
16019 extra
16020 (if (eq org-ts-what 'hour) 2 5)
16021 n dm)))
16022 (when (integerp org-ts-what)
16023 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16024 (if (eq what 'calendar)
16025 (let ((cal-date (org-get-date-from-calendar)))
16026 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16027 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16028 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16029 (setcar time0 (or (car time0) 0))
16030 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16031 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16032 (setq time (apply 'encode-time time0))))
16033 ;; Insert the new time-stamp, and ensure point stays in the same
16034 ;; category as before (i.e. not after the last position in that
16035 ;; category).
16036 (let ((pos (point)))
16037 ;; Stay before inserted string. `save-excursion' is of no use.
16038 (setq org-last-changed-timestamp
16039 (org-insert-time-stamp time with-hm inactive nil nil extra))
16040 (goto-char pos))
16041 (save-match-data
16042 (looking-at org-ts-regexp3)
16043 (goto-char (cond
16044 ;; `day' category ends before `hour' if any, or at
16045 ;; the end of the day name.
16046 ((eq origin-cat 'day)
16047 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16048 ((eq origin-cat 'hour) (min (match-end 7) origin))
16049 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16050 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16051 ;; `year' and `month' have both fixed size: point
16052 ;; couldn't have moved into another part.
16053 (t origin))))
16054 ;; Update clock if on a CLOCK line.
16055 (org-clock-update-time-maybe)
16056 ;; Try to recenter the calendar window, if any.
16057 (if (and org-calendar-follow-timestamp-change
16058 (get-buffer-window "*Calendar*" t)
16059 (memq org-ts-what '(day month year)))
16060 (org-recenter-calendar (time-to-days time))))))
16062 (defun org-modify-ts-extra (s pos n dm)
16063 "Change the different parts of the lead-time and repeat fields in timestamp."
16064 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16065 ng h m new rem)
16066 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16067 (cond
16068 ((or (org-pos-in-match-range pos 2)
16069 (org-pos-in-match-range pos 3))
16070 (setq m (string-to-number (match-string 3 s))
16071 h (string-to-number (match-string 2 s)))
16072 (if (org-pos-in-match-range pos 2)
16073 (setq h (+ h n))
16074 (setq n (* dm (org-no-warnings (signum n))))
16075 (when (not (= 0 (setq rem (% m dm))))
16076 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16077 (setq m (+ m n)))
16078 (if (< m 0) (setq m (+ m 60) h (1- h)))
16079 (if (> m 59) (setq m (- m 60) h (1+ h)))
16080 (setq h (min 24 (max 0 h)))
16081 (setq ng 1 new (format "-%02d:%02d" h m)))
16082 ((org-pos-in-match-range pos 6)
16083 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16084 ((org-pos-in-match-range pos 5)
16085 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16087 ((org-pos-in-match-range pos 9)
16088 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16089 ((org-pos-in-match-range pos 8)
16090 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16092 (when ng
16093 (setq s (concat
16094 (substring s 0 (match-beginning ng))
16095 new
16096 (substring s (match-end ng))))))
16097 s))
16099 (defun org-recenter-calendar (date)
16100 "If the calendar is visible, recenter it to DATE."
16101 (let* ((win (selected-window))
16102 (cwin (get-buffer-window "*Calendar*" t))
16103 (calendar-move-hook nil))
16104 (when cwin
16105 (select-window cwin)
16106 (calendar-goto-date (if (listp date) date
16107 (calendar-gregorian-from-absolute date)))
16108 (select-window win))))
16110 (defun org-goto-calendar (&optional arg)
16111 "Go to the Emacs calendar at the current date.
16112 If there is a time stamp in the current line, go to that date.
16113 A prefix ARG can be used to force the current date."
16114 (interactive "P")
16115 (let ((tsr org-ts-regexp) diff
16116 (calendar-move-hook nil)
16117 (calendar-view-holidays-initially-flag nil)
16118 (calendar-view-diary-initially-flag nil))
16119 (if (or (org-at-timestamp-p)
16120 (save-excursion
16121 (beginning-of-line 1)
16122 (looking-at (concat ".*" tsr))))
16123 (let ((d1 (time-to-days (current-time)))
16124 (d2 (time-to-days
16125 (org-time-string-to-time (match-string 1)))))
16126 (setq diff (- d2 d1))))
16127 (calendar)
16128 (calendar-goto-today)
16129 (if (and diff (not arg)) (calendar-forward-day diff))))
16131 (defun org-get-date-from-calendar ()
16132 "Return a list (month day year) of date at point in calendar."
16133 (with-current-buffer "*Calendar*"
16134 (save-match-data
16135 (calendar-cursor-to-date))))
16137 (defun org-date-from-calendar ()
16138 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16139 If there is already a time stamp at the cursor position, update it."
16140 (interactive)
16141 (if (org-at-timestamp-p t)
16142 (org-timestamp-change 0 'calendar)
16143 (let ((cal-date (org-get-date-from-calendar)))
16144 (org-insert-time-stamp
16145 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16147 (defun org-minutes-to-hh:mm-string (m)
16148 "Compute H:MM from a number of minutes."
16149 (let ((h (/ m 60)))
16150 (setq m (- m (* 60 h)))
16151 (format org-time-clocksum-format h m)))
16153 (defun org-hh:mm-string-to-minutes (s)
16154 "Convert a string H:MM to a number of minutes.
16155 If the string is just a number, interpret it as minutes.
16156 In fact, the first hh:mm or number in the string will be taken,
16157 there can be extra stuff in the string.
16158 If no number is found, the return value is 0."
16159 (cond
16160 ((integerp s) s)
16162 (+ (* (string-to-number (match-string 1 s)) 60)
16163 (string-to-number (match-string 2 s))))
16165 (string-to-number (match-string 1 s)))
16166 (t 0)))
16168 (defcustom org-effort-durations
16169 `(("h" . 60)
16170 ("d" . ,(* 60 8))
16171 ("w" . ,(* 60 8 5))
16172 ("m" . ,(* 60 8 5 4))
16173 ("y" . ,(* 60 8 5 40)))
16174 "Conversion factor to minutes for an effort modifier.
16176 Each entry has the form (MODIFIER . MINUTES).
16178 In an effort string, a number followed by MODIFIER is multiplied
16179 by the specified number of MINUTES to obtain an effort in
16180 minutes.
16184 :group 'org-agenda
16185 :type '(alist :key-type (string :tag "Modifier")
16186 :value-type (number :tag "Minutes")))
16188 (defun org-duration-string-to-minutes (s)
16189 "Convert a duration string S to minutes.
16191 A bare number is interpreted as minutes, modifiers can be set by
16192 customizing `org-effort-durations' (which see).
16194 Entries containing a colon are interpreted as H:MM by
16195 `org-hh:mm-string-to-minutes'."
16196 (let ((result 0)
16198 (regexp-opt (mapcar 'car org-effort-durations))
16200 (while (string-match re s)
16201 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16202 (string-to-number (match-string 1 s))))
16203 (setq s (replace-match "" nil t s)))
16204 (incf result (org-hh:mm-string-to-minutes s))
16205 result))
16207 ;;;; Files
16209 (defun org-save-all-org-buffers ()
16210 "Save all Org-mode buffers without user confirmation."
16211 (interactive)
16212 (message "Saving all Org-mode buffers...")
16213 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16214 (when (featurep 'org-id) (org-id-locations-save))
16215 (message "Saving all Org-mode buffers... done"))
16217 (defun org-revert-all-org-buffers ()
16218 "Revert all Org-mode buffers.
16219 Prompt for confirmation when there are unsaved changes.
16220 Be sure you know what you are doing before letting this function
16221 overwrite your changes.
16223 This function is useful in a setup where one tracks org files
16224 with a version control system, to revert on one machine after pulling
16225 changes from another. I believe the procedure must be like this:
16227 1. M-x org-save-all-org-buffers
16228 2. Pull changes from the other machine, resolve conflicts
16229 3. M-x org-revert-all-org-buffers"
16230 (interactive)
16231 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16232 (error "Abort"))
16233 (save-excursion
16234 (save-window-excursion
16235 (mapc
16236 (lambda (b)
16237 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16238 (with-current-buffer b buffer-file-name))
16239 (org-pop-to-buffer-same-window b)
16240 (revert-buffer t 'no-confirm)))
16241 (buffer-list))
16242 (when (and (featurep 'org-id) org-id-track-globally)
16243 (org-id-locations-load)))))
16245 ;;;; Agenda files
16247 ;;;###autoload
16248 (defun org-switchb (&optional arg)
16249 "Switch between Org buffers.
16250 With one prefix argument, restrict available buffers to files.
16251 With two prefix arguments, restrict available buffers to agenda files.
16253 Defaults to `iswitchb' for buffer name completion.
16254 Set `org-completion-use-ido' to make it use ido instead."
16255 (interactive "P")
16256 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16257 ((equal arg '(16)) (org-buffer-list 'agenda))
16258 (t (org-buffer-list))))
16259 (org-completion-use-iswitchb org-completion-use-iswitchb)
16260 (org-completion-use-ido org-completion-use-ido))
16261 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16262 (setq org-completion-use-iswitchb t))
16263 (org-pop-to-buffer-same-window
16264 (org-icompleting-read "Org buffer: "
16265 (mapcar 'list (mapcar 'buffer-name blist))
16266 nil t))))
16268 ;;; Define some older names previously used for this functionality
16269 ;;;###autoload
16270 (defalias 'org-ido-switchb 'org-switchb)
16271 ;;;###autoload
16272 (defalias 'org-iswitchb 'org-switchb)
16274 (defun org-buffer-list (&optional predicate exclude-tmp)
16275 "Return a list of Org buffers.
16276 PREDICATE can be `export', `files' or `agenda'.
16278 export restrict the list to Export buffers.
16279 files restrict the list to buffers visiting Org files.
16280 agenda restrict the list to buffers visiting agenda files.
16282 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16283 (let* ((bfn nil)
16284 (agenda-files (and (eq predicate 'agenda)
16285 (mapcar 'file-truename (org-agenda-files t))))
16286 (filter
16287 (cond
16288 ((eq predicate 'files)
16289 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16290 ((eq predicate 'export)
16291 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16292 ((eq predicate 'agenda)
16293 (lambda (b)
16294 (with-current-buffer b
16295 (and (eq major-mode 'org-mode)
16296 (setq bfn (buffer-file-name b))
16297 (member (file-truename bfn) agenda-files)))))
16298 (t (lambda (b) (with-current-buffer b
16299 (or (eq major-mode 'org-mode)
16300 (string-match "\*Org .*Export"
16301 (buffer-name b)))))))))
16302 (delq nil
16303 (mapcar
16304 (lambda(b)
16305 (if (and (funcall filter b)
16306 (or (not exclude-tmp)
16307 (not (string-match "tmp" (buffer-name b)))))
16308 b
16309 nil))
16310 (buffer-list)))))
16312 (defun org-agenda-files (&optional unrestricted archives)
16313 "Get the list of agenda files.
16314 Optional UNRESTRICTED means return the full list even if a restriction
16315 is currently in place.
16316 When ARCHIVES is t, include all archive files that are really being
16317 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16318 `org-agenda-archives-mode' is t."
16319 (let ((files
16320 (cond
16321 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16322 ((stringp org-agenda-files) (org-read-agenda-file-list))
16323 ((listp org-agenda-files) org-agenda-files)
16324 (t (error "Invalid value of `org-agenda-files'")))))
16325 (setq files (apply 'append
16326 (mapcar (lambda (f)
16327 (if (file-directory-p f)
16328 (directory-files
16329 f t org-agenda-file-regexp)
16330 (list f)))
16331 files)))
16332 (when org-agenda-skip-unavailable-files
16333 (setq files (delq nil
16334 (mapcar (function
16335 (lambda (file)
16336 (and (file-readable-p file) file)))
16337 files))))
16338 (when (or (eq archives t)
16339 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16340 (setq files (org-add-archive-files files)))
16341 files))
16343 (defun org-agenda-file-p (&optional file)
16344 "Return non-nil, if FILE is an agenda file.
16345 If FILE is omitted, use the file associated with the current
16346 buffer."
16347 (member (or file (buffer-file-name))
16348 (org-agenda-files t)))
16350 (defun org-edit-agenda-file-list ()
16351 "Edit the list of agenda files.
16352 Depending on setup, this either uses customize to edit the variable
16353 `org-agenda-files', or it visits the file that is holding the list. In the
16354 latter case, the buffer is set up in a way that saving it automatically kills
16355 the buffer and restores the previous window configuration."
16356 (interactive)
16357 (if (stringp org-agenda-files)
16358 (let ((cw (current-window-configuration)))
16359 (find-file org-agenda-files)
16360 (org-set-local 'org-window-configuration cw)
16361 (org-add-hook 'after-save-hook
16362 (lambda ()
16363 (set-window-configuration
16364 (prog1 org-window-configuration
16365 (kill-buffer (current-buffer))))
16366 (org-install-agenda-files-menu)
16367 (message "New agenda file list installed"))
16368 nil 'local)
16369 (message "%s" (substitute-command-keys
16371 (customize-variable 'org-agenda-files)))
16373 (defun org-store-new-agenda-file-list (list)
16374 "Set new value for the agenda file list and save it correctly."
16375 (if (stringp org-agenda-files)
16376 (let ((fe (org-read-agenda-file-list t)) b u)
16377 (while (setq b (find-buffer-visiting org-agenda-files))
16378 (kill-buffer b))
16379 (with-temp-file org-agenda-files
16380 (insert
16381 (mapconcat
16382 (lambda (f) ;; Keep un-expanded entries.
16383 (if (setq u (assoc f fe))
16384 (cdr u)
16385 f))
16388 (let ((org-mode-hook nil) (org-inhibit-startup t)
16389 (org-insert-mode-line-in-empty-file nil))
16390 (setq org-agenda-files list)
16391 (customize-save-variable 'org-agenda-files org-agenda-files))))
16393 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16394 "Read the list of agenda files from a file.
16395 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16396 filenames, used by `org-store-new-agenda-file-list' to write back
16397 un-expanded file names."
16398 (when (file-directory-p org-agenda-files)
16399 (error "`org-agenda-files' cannot be a single directory"))
16400 (when (stringp org-agenda-files)
16401 (with-temp-buffer
16402 (insert-file-contents org-agenda-files)
16403 (mapcar
16404 (lambda (f)
16405 (let ((e (expand-file-name (substitute-in-file-name f)
16406 org-directory)))
16407 (if pair-with-expansion
16408 (cons e f)
16409 e)))
16412 ;;;###autoload
16413 (defun org-cycle-agenda-files ()
16414 "Cycle through the files in `org-agenda-files'.
16415 If the current buffer visits an agenda file, find the next one in the list.
16416 If the current buffer does not, find the first agenda file."
16417 (interactive)
16418 (let* ((fs (org-agenda-files t))
16419 (files (append fs (list (car fs))))
16420 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16421 file)
16422 (unless files (error "No agenda files"))
16423 (catch 'exit
16424 (while (setq file (pop files))
16425 (if (equal (file-truename file) tcf)
16426 (when (car files)
16427 (find-file (car files))
16428 (throw 'exit t))))
16429 (find-file (car fs)))
16430 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16432 (defun org-agenda-file-to-front (&optional to-end)
16433 "Move/add the current file to the top of the agenda file list.
16434 If the file is not present in the list, it is added to the front. If it is
16435 present, it is moved there. With optional argument TO-END, add/move to the
16436 end of the list."
16437 (interactive "P")
16438 (let ((org-agenda-skip-unavailable-files nil)
16439 (file-alist (mapcar (lambda (x)
16440 (cons (file-truename x) x))
16441 (org-agenda-files t)))
16442 (ctf (file-truename buffer-file-name))
16443 x had)
16444 (setq x (assoc ctf file-alist) had x)
16446 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16447 (if to-end
16448 (setq file-alist (append (delq x file-alist) (list x)))
16449 (setq file-alist (cons x (delq x file-alist))))
16450 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16451 (org-install-agenda-files-menu)
16452 (message "File %s to %s of agenda file list"
16453 (if had "moved" "added") (if to-end "end" "front"))))
16455 (defun org-remove-file (&optional file)
16456 "Remove current file from the list of files in variable `org-agenda-files'.
16457 These are the files which are being checked for agenda entries.
16458 Optional argument FILE means use this file instead of the current."
16459 (interactive)
16460 (let* ((org-agenda-skip-unavailable-files nil)
16461 (file (or file buffer-file-name))
16462 (true-file (file-truename file))
16463 (afile (abbreviate-file-name file))
16464 (files (delq nil (mapcar
16465 (lambda (x)
16466 (if (equal true-file
16467 (file-truename x))
16468 nil x))
16469 (org-agenda-files t)))))
16470 (if (not (= (length files) (length (org-agenda-files t))))
16471 (progn
16472 (org-store-new-agenda-file-list files)
16473 (org-install-agenda-files-menu)
16474 (message "Removed file: %s" afile))
16475 (message "File was not in list: %s (not removed)" afile))))
16477 (defun org-file-menu-entry (file)
16478 (vector file (list 'find-file file) t))
16480 (defun org-check-agenda-file (file)
16481 "Make sure FILE exists. If not, ask user what to do."
16482 (when (not (file-exists-p file))
16483 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16484 (abbreviate-file-name file))
16485 (let ((r (downcase (read-char-exclusive))))
16486 (cond
16487 ((equal r ?r)
16488 (org-remove-file file)
16489 (throw 'nextfile t))
16490 (t (error "Abort"))))))
16492 (defun org-get-agenda-file-buffer (file)
16493 "Get a buffer visiting FILE. If the buffer needs to be created, add
16494 it to the list of buffers which might be released later."
16495 (let ((buf (org-find-base-buffer-visiting file)))
16496 (if buf
16497 buf ; just return it
16498 ;; Make a new buffer and remember it
16499 (setq buf (find-file-noselect file))
16500 (if buf (push buf org-agenda-new-buffers))
16501 buf)))
16503 (defun org-release-buffers (blist)
16504 "Release all buffers in list, asking the user for confirmation when needed.
16505 When a buffer is unmodified, it is just killed. When modified, it is saved
16506 \(if the user agrees) and then killed."
16507 (let (buf file)
16508 (while (setq buf (pop blist))
16509 (setq file (buffer-file-name buf))
16510 (when (and (buffer-modified-p buf)
16511 file
16512 (y-or-n-p (format "Save file %s? " file)))
16513 (with-current-buffer buf (save-buffer)))
16514 (kill-buffer buf))))
16516 (defun org-prepare-agenda-buffers (files)
16517 "Create buffers for all agenda files, protect archived trees and comments."
16518 (interactive)
16519 (let ((pa '(:org-archived t))
16520 (pc '(:org-comment t))
16521 (pall '(:org-archived t :org-comment t))
16522 (inhibit-read-only t)
16523 (rea (concat ":" org-archive-tag ":"))
16524 bmp file re)
16525 (save-excursion
16526 (save-restriction
16527 (while (setq file (pop files))
16528 (catch 'nextfile
16529 (if (bufferp file)
16530 (set-buffer file)
16531 (org-check-agenda-file file)
16532 (set-buffer (org-get-agenda-file-buffer file)))
16533 (widen)
16534 (setq bmp (buffer-modified-p))
16535 (org-refresh-category-properties)
16536 (setq org-todo-keywords-for-agenda
16537 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16538 (setq org-done-keywords-for-agenda
16539 (append org-done-keywords-for-agenda org-done-keywords))
16540 (setq org-todo-keyword-alist-for-agenda
16541 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16542 (setq org-drawers-for-agenda
16543 (append org-drawers-for-agenda org-drawers))
16544 (setq org-tag-alist-for-agenda
16545 (append org-tag-alist-for-agenda org-tag-alist))
16547 (save-excursion
16548 (remove-text-properties (point-min) (point-max) pall)
16549 (when org-agenda-skip-archived-trees
16550 (goto-char (point-min))
16551 (while (re-search-forward rea nil t)
16552 (if (org-at-heading-p t)
16553 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16554 (goto-char (point-min))
16555 (setq re (format org-heading-keyword-regexp-format
16556 org-comment-string))
16557 (while (re-search-forward re nil t)
16558 (add-text-properties
16559 (match-beginning 0) (org-end-of-subtree t) pc)))
16560 (set-buffer-modified-p bmp)))))
16561 (setq org-todo-keywords-for-agenda
16562 (org-uniquify org-todo-keywords-for-agenda))
16563 (setq org-todo-keyword-alist-for-agenda
16564 (org-uniquify org-todo-keyword-alist-for-agenda)
16565 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16567 ;;;; Embedded LaTeX
16569 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16570 "Keymap for the minor `org-cdlatex-mode'.")
16572 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16573 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16574 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16575 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16576 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16578 (defvar org-cdlatex-texmathp-advice-is-done nil
16579 "Flag remembering if we have applied the advice to texmathp already.")
16581 (define-minor-mode org-cdlatex-mode
16582 "Toggle the minor `org-cdlatex-mode'.
16583 This mode supports entering LaTeX environment and math in LaTeX fragments
16584 in Org-mode.
16586 nil " OCDL" nil
16587 (when org-cdlatex-mode
16588 (require 'cdlatex)
16589 (run-hooks 'cdlatex-mode-hook)
16590 (cdlatex-compute-tables))
16591 (unless org-cdlatex-texmathp-advice-is-done
16592 (setq org-cdlatex-texmathp-advice-is-done t)
16593 (defadvice texmathp (around org-math-always-on activate)
16594 "Always return t in org-mode buffers.
16595 This is because we want to insert math symbols without dollars even outside
16596 the LaTeX math segments. If Orgmode thinks that point is actually inside
16597 an embedded LaTeX fragment, let texmathp do its job.
16599 (interactive)
16600 (let (p)
16601 (cond
16602 ((not (eq major-mode 'org-mode)) ad-do-it)
16603 ((eq this-command 'cdlatex-math-symbol)
16604 (setq ad-return-value t
16605 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16606 (t
16607 (let ((p (org-inside-LaTeX-fragment-p)))
16608 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16609 (setq ad-return-value t
16610 texmathp-why '("Org-mode embedded math" . 0))
16611 (if p ad-do-it)))))))))
16613 (defun turn-on-org-cdlatex ()
16614 "Unconditionally turn on `org-cdlatex-mode'."
16615 (org-cdlatex-mode 1))
16617 (defun org-inside-LaTeX-fragment-p ()
16618 "Test if point is inside a LaTeX fragment.
16620 sequence appearing also before point.
16621 Even though the matchers for math are configurable, this function assumes
16623 delimiters are skipped when they have been removed by customization.
16624 The return value is nil, or a cons cell with the delimiter and the
16625 position of this delimiter.
16627 This function does a reasonably good job, but can locally be fooled by
16628 for example currency specifications. For example it will assume being in
16630 fragments that are properly closed, but during editing, we have to live
16631 with the uncertainty caused by missing closing delimiters. This function
16632 looks only before point, not after."
16633 (catch 'exit
16634 (let ((pos (point))
16635 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16636 (lim (progn
16638 (point)))
16639 dd-on str (start 0) m re)
16640 (goto-char pos)
16641 (when dodollar
16643 re (nth 1 (assoc "$" org-latex-regexps)))
16644 (while (string-match re str start)
16645 (cond
16646 ((= (match-end 0) (length str))
16647 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16648 ((= (match-end 0) (- (length str) 5))
16649 (throw 'exit nil))
16650 (t (setq start (match-end 0))))))
16651 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16652 (goto-char pos)
16653 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16654 (and (match-beginning 2) (throw 'exit nil))
16655 ;; count $$
16657 (setq dd-on (not dd-on)))
16658 (goto-char pos)
16659 (if dd-on (cons "$$" m))))))
16661 (defun org-inside-latex-macro-p ()
16662 "Is point inside a LaTeX macro or its arguments?"
16663 (save-match-data
16664 (org-in-regexp
16667 (defun org-try-cdlatex-tab ()
16668 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16669 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16670 - inside a LaTeX fragment, or
16671 - after the first word in a line, where an abbreviation expansion could
16672 insert a LaTeX environment."
16673 (when org-cdlatex-mode
16674 (cond
16675 ;; Before any word on the line: No expansion possible.
16677 ;; Just after first word on the line: Expand it. Make sure it
16678 ;; cannot happen on headlines, though.
16679 ((save-excursion
16680 (skip-chars-backward "a-zA-Z0-9*")
16682 (and (bolp) (not (org-at-heading-p))))
16683 (cdlatex-tab) t)
16684 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16686 (defun org-cdlatex-underscore-caret (&optional arg)
16687 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16688 Revert to the normal definition outside of these fragments."
16689 (interactive "P")
16690 (if (org-inside-LaTeX-fragment-p)
16691 (call-interactively 'cdlatex-sub-superscript)
16692 (let (org-cdlatex-mode)
16693 (call-interactively (key-binding (vector last-input-event))))))
16695 (defun org-cdlatex-math-modify (&optional arg)
16696 "Execute `cdlatex-math-modify' in LaTeX fragments.
16697 Revert to the normal definition outside of these fragments."
16698 (interactive "P")
16699 (if (org-inside-LaTeX-fragment-p)
16700 (call-interactively 'cdlatex-math-modify)
16701 (let (org-cdlatex-mode)
16702 (call-interactively (key-binding (vector last-input-event))))))
16704 (defvar org-latex-fragment-image-overlays nil
16705 "List of overlays carrying the images of latex fragments.")
16706 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16708 (defun org-remove-latex-fragment-image-overlays ()
16709 "Remove all overlays with LaTeX fragment images in current buffer."
16710 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16711 (setq org-latex-fragment-image-overlays nil))
16713 (defun org-preview-latex-fragment (&optional subtree)
16714 "Preview the LaTeX fragment at point, or all locally or globally.
16715 If the cursor is in a LaTeX fragment, create the image and overlay
16716 it over the source code. If there is no fragment at point, display
16717 all fragments in the current text, from one headline to the next. With
16718 prefix SUBTREE, display all fragments in the current subtree. With a
16720 the cursor is before the first headline,
16721 display all fragments in the buffer.
16723 (interactive "P")
16724 (org-remove-latex-fragment-image-overlays)
16725 (save-excursion
16726 (save-restriction
16727 (let (beg end at msg)
16728 (cond
16729 ((or (equal subtree '(16))
16730 (not (save-excursion
16731 (re-search-backward org-outline-regexp-bol nil t))))
16732 (setq beg (point-min) end (point-max)
16733 msg "Creating images for buffer...%s"))
16734 ((equal subtree '(4))
16735 (org-back-to-heading)
16736 (setq beg (point) end (org-end-of-subtree t)
16737 msg "Creating images for subtree...%s"))
16738 (t
16739 (if (setq at (org-inside-LaTeX-fragment-p))
16740 (goto-char (max (point-min) (- (cdr at) 2)))
16741 (org-back-to-heading))
16742 (setq beg (point) end (progn (outline-next-heading) (point))
16743 msg (if at "Creating image...%s"
16744 "Creating images for entry...%s"))))
16745 (message msg "")
16746 (narrow-to-region beg end)
16747 (goto-char beg)
16748 (org-format-latex
16749 (concat "ltxpng/" (file-name-sans-extension
16750 (file-name-nondirectory
16751 buffer-file-name)))
16752 default-directory 'overlays msg at 'forbuffer 'dvipng)
16753 (message msg "done. Use `C-c C-c' to remove images.")))))
16755 (defvar org-latex-regexps
16757 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16760 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16764 "Regular expressions for matching embedded LaTeX.")
16766 (defvar org-export-have-math nil) ;; dynamic scoping
16767 (defun org-format-latex (prefix &optional dir overlays msg at
16768 forbuffer processing-type)
16769 "Replace LaTeX fragments with links to an image, and produce images.
16770 Some of the options can be changed using the variable
16771 `org-format-latex-options'."
16772 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16773 (let* ((prefixnodir (file-name-nondirectory prefix))
16774 (absprefix (expand-file-name prefix dir))
16775 (todir (file-name-directory absprefix))
16776 (opt org-format-latex-options)
16777 (matchers (plist-get opt :matchers))
16778 (re-list org-latex-regexps)
16779 (org-format-latex-header-extra
16780 (plist-get (org-infile-export-plist) :latex-header-extra))
16781 (cnt 0) txt hash link beg end re e checkdir
16782 executables-checked string
16783 m n block-type block linkfile movefile ov)
16784 ;; Check the different regular expressions
16785 (while (setq e (pop re-list))
16786 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16788 (when (member m matchers)
16789 (goto-char (point-min))
16790 (while (re-search-forward re nil t)
16791 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16792 (not (get-text-property (match-beginning n)
16793 'org-protected))
16794 (or (not overlays)
16795 (not (eq (get-char-property (match-beginning n)
16796 'org-overlay-type)
16797 'org-latex-overlay))))
16798 (setq org-export-have-math t)
16799 (cond
16800 ((eq processing-type 'verbatim)
16801 ;; Leave the text verbatim, just protect it
16802 (add-text-properties (match-beginning n) (match-end n)
16803 '(org-protected t)))
16804 ((eq processing-type 'mathjax)
16805 ;; Prepare for MathJax processing
16806 (setq string (match-string n))
16807 (if (member m '("$" "$1"))
16808 (save-excursion
16809 (delete-region (match-beginning n) (match-end n))
16810 (goto-char (match-beginning n))
16813 '(org-protected t))))
16814 (add-text-properties (match-beginning n) (match-end n)
16815 '(org-protected t))))
16816 ((eq processing-type 'dvipng)
16817 ;; Process to an image
16818 (setq txt (match-string n)
16819 beg (match-beginning n) end (match-end n)
16820 cnt (1+ cnt))
16821 (let (print-length print-level) ; make sure full list is printed
16822 (setq hash (sha1 (prin1-to-string
16823 (list org-format-latex-header
16824 org-format-latex-header-extra
16825 org-export-latex-default-packages-alist
16826 org-export-latex-packages-alist
16827 org-format-latex-options
16828 forbuffer txt)))
16829 linkfile (format "%s_%s.png" prefix hash)
16830 movefile (format "%s_%s.png" absprefix hash)))
16831 (setq link (concat block "[[file:" linkfile "]]" block))
16832 (if msg (message msg cnt))
16833 (goto-char beg)
16834 (unless checkdir ; make sure the directory exists
16835 (setq checkdir t)
16836 (or (file-directory-p todir) (make-directory todir t)))
16838 (unless executables-checked
16839 (org-check-external-command
16840 "latex" "needed to convert LaTeX fragments to images")
16841 (org-check-external-command
16842 "dvipng" "needed to convert LaTeX fragments to images")
16843 (setq executables-checked t))
16845 (unless (file-exists-p movefile)
16846 (org-create-formula-image
16847 txt movefile opt forbuffer))
16848 (if overlays
16849 (progn
16850 (mapc (lambda (o)
16851 (if (eq (overlay-get o 'org-overlay-type)
16852 'org-latex-overlay)
16853 (delete-overlay o)))
16854 (overlays-in beg end))
16855 (setq ov (make-overlay beg end))
16856 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16857 (if (featurep 'xemacs)
16858 (progn
16859 (overlay-put ov 'invisible t)
16860 (overlay-put
16861 ov 'end-glyph
16862 (make-glyph (vector 'png :file movefile))))
16863 (overlay-put
16864 ov 'display
16865 (list 'image :type 'png :file movefile :ascent 'center)))
16866 (push ov org-latex-fragment-image-overlays)
16867 (goto-char end))
16868 (delete-region beg end)
16869 (insert (org-add-props link
16870 (list 'org-latex-src
16871 (replace-regexp-in-string
16873 'org-latex-src-embed-type
16874 (if block-type 'paragraph 'character))))))
16875 ((eq processing-type 'mathml)
16876 ;; Process to MathML
16877 (unless executables-checked
16878 (unless (save-match-data (org-format-latex-mathml-available-p))
16879 (error "LaTeX to MathML converter not configured"))
16880 (setq executables-checked t))
16881 (setq txt (match-string n)
16882 beg (match-beginning n) end (match-end n)
16883 cnt (1+ cnt))
16884 (if msg (message msg cnt))
16885 (goto-char beg)
16886 (delete-region beg end)
16887 (insert (org-format-latex-as-mathml
16888 txt block-type prefix dir)))
16889 (t
16890 (error "Unknown conversion type %s for latex fragments"
16891 processing-type)))))))))
16893 (defun org-create-math-formula (latex-frag &optional mathml-file)
16894 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16895 Use `org-latex-to-mathml-convert-command'. If the conversion is
16897 elements otherwise return nil. When MATHML-FILE is specified,
16898 write the results in to that file. When invoked as an
16899 interactive command, prompt for LATEX-FRAG, with initial value
16900 set to the current active region and echo the results for user
16901 inspection."
16902 (interactive (list (let ((frag (when (region-active-p)
16903 (buffer-substring-no-properties
16904 (region-beginning) (region-end)))))
16905 (read-string "LaTeX Fragment: " frag nil frag))))
16906 (unless latex-frag (error "Invalid latex-frag"))
16907 (let* ((tmp-in-file (file-relative-name
16908 (make-temp-name (expand-file-name "ltxmathml-in"))))
16909 (ignore (write-region latex-frag nil tmp-in-file))
16910 (tmp-out-file (file-relative-name
16911 (make-temp-name (expand-file-name "ltxmathml-out"))))
16912 (cmd (format-spec
16913 org-latex-to-mathml-convert-command
16914 `((?j . ,(shell-quote-argument
16915 (expand-file-name org-latex-to-mathml-jar-file)))
16916 (?I . ,(shell-quote-argument tmp-in-file))
16917 (?o . ,(shell-quote-argument tmp-out-file)))))
16918 mathml shell-command-output)
16919 (when (org-called-interactively-p 'any)
16920 (unless (org-format-latex-mathml-available-p)
16921 (error "LaTeX to MathML converter not configured")))
16922 (message "Running %s" cmd)
16923 (setq shell-command-output (shell-command-to-string cmd))
16924 (setq mathml
16925 (when (file-readable-p tmp-out-file)
16926 (with-current-buffer (find-file-noselect tmp-out-file t)
16927 (goto-char (point-min))
16928 (when (re-search-forward
16929 (concat
16930 (regexp-quote
16933 (regexp-quote "</math>")) nil t)
16934 (prog1 (match-string 0) (kill-buffer))))))
16935 (cond
16936 (mathml
16937 (setq mathml
16939 (when mathml-file
16940 (write-region mathml nil mathml-file))
16941 (when (org-called-interactively-p 'any)
16942 (message mathml)))
16943 ((message "LaTeX to MathML conversion failed")
16944 (message shell-command-output)))
16945 (delete-file tmp-in-file)
16946 (when (file-exists-p tmp-out-file)
16947 (delete-file tmp-out-file))
16948 mathml))
16950 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16951 prefix &optional dir)
16952 "Use `org-create-math-formula' but check local cache first."
16953 (let* ((absprefix (expand-file-name prefix dir))
16954 (print-length nil) (print-level nil)
16955 (formula-id (concat
16956 "formula-"
16957 (sha1
16958 (prin1-to-string
16959 (list latex-frag
16960 org-latex-to-mathml-convert-command)))))
16961 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16962 (formula-cache-dir (file-name-directory formula-cache)))
16964 (unless (file-directory-p formula-cache-dir)
16965 (make-directory formula-cache-dir t))
16967 (unless (file-exists-p formula-cache)
16968 (org-create-math-formula latex-frag formula-cache))
16970 (if (file-exists-p formula-cache)
16971 ;; Successful conversion. Return the link to MathML file.
16972 (org-add-props
16973 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16975 'org-latex-src-embed-type (if latex-frag-type
16976 'paragraph 'character)))
16977 ;; Failed conversion. Return the LaTeX fragment verbatim
16978 (add-text-properties
16979 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16980 latex-frag)))
16982 ;; This function borrows from Ganesh Swami's latex2png.el
16983 (defun org-create-formula-image (string tofile options buffer)
16984 "This calls dvipng."
16985 (require 'org-latex)
16986 (let* ((tmpdir (if (featurep 'xemacs)
16987 (temp-directory)
16988 temporary-file-directory))
16989 (texfilebase (make-temp-name
16990 (expand-file-name "orgtex" tmpdir)))
16991 (texfile (concat texfilebase ".tex"))
16992 (dvifile (concat texfilebase ".dvi"))
16993 (pngfile (concat texfilebase ".png"))
16994 (fnh (if (featurep 'xemacs)
16995 (font-height (get-face-font 'default))
16996 (face-attribute 'default :height nil)))
16997 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16998 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16999 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17000 "Black"))
17001 (bg (or (plist-get options (if buffer :background :html-background))
17002 "Transparent")))
17003 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17004 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17005 (with-temp-file texfile
17006 (insert (org-splice-latex-header
17007 org-format-latex-header
17008 org-export-latex-default-packages-alist
17009 org-export-latex-packages-alist t
17010 org-format-latex-header-extra))
17012 (require 'org-latex)
17013 (org-export-latex-fix-inputenc))
17014 (let ((dir default-directory))
17015 (condition-case nil
17016 (progn
17017 (cd tmpdir)
17018 (call-process "latex" nil nil nil texfile))
17019 (error nil))
17020 (cd dir))
17021 (if (not (file-exists-p dvifile))
17022 (progn (message "Failed to create dvi file from %s" texfile) nil)
17023 (condition-case nil
17024 (call-process "dvipng" nil nil nil
17025 "-fg" fg "-bg" bg
17026 "-D" dpi
17027 ;;"-x" scale "-y" scale
17028 "-T" "tight"
17029 "-o" pngfile
17030 dvifile)
17031 (error nil))
17032 (if (not (file-exists-p pngfile))
17033 (if org-format-latex-signal-error
17034 (error "Failed to create png file from %s" texfile)
17035 (message "Failed to create png file from %s" texfile)
17036 nil)
17037 ;; Use the requested file name and clean up
17038 (copy-file pngfile tofile 'replace)
17039 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17040 (delete-file (concat texfilebase e)))
17041 pngfile))))
17043 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17044 "Fill a LaTeX header template TPL.
17045 In the template, the following place holders will be recognized:
17048 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17050 [NO-PACKAGES] do not include PKG
17051 [EXTRA] the string EXTRA
17052 [NO-EXTRA] do not include EXTRA
17054 For backward compatibility, if both the positive and the negative place
17056 assumed to be present at the end of the template.
17057 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17058 EXTRA is a string.
17059 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17060 (let (rpl (end ""))
17062 (setq rpl (if (or (match-end 1) (not def-pkg))
17063 "" (org-latex-packages-to-string def-pkg snippets-p t))
17064 tpl (replace-match rpl t t tpl))
17065 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17068 (setq rpl (if (or (match-end 1) (not pkg))
17069 "" (org-latex-packages-to-string pkg snippets-p t))
17070 tpl (replace-match rpl t t tpl))
17071 (if pkg (setq end
17073 (org-latex-packages-to-string pkg snippets-p)))))
17076 (setq rpl (if (or (match-end 1) (not extra))
17078 tpl (replace-match rpl t t tpl))
17084 tpl)))
17086 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17088 (setq pkg (mapconcat (lambda(p)
17089 (cond
17090 ((stringp p) p)
17091 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17092 (format "%% Package %s omitted" (cadr p)))
17093 ((equal "" (car p))
17095 (t
17097 (car p) (cadr p)))))
17098 pkg
17102 (defun org-dvipng-color (attr)
17103 "Return an rgb color specification for dvipng."
17104 (apply 'format "rgb %s %s %s"
17105 (mapcar 'org-normalize-color
17106 (color-values (face-attribute 'default attr nil)))))
17108 (defun org-normalize-color (value)
17109 "Return string to be used as color value for an RGB component."
17110 (format "%g" (/ value 65535.0)))
17112 ;; Image display
17115 (defvar org-inline-image-overlays nil)
17116 (make-variable-buffer-local 'org-inline-image-overlays)
17118 (defun org-toggle-inline-images (&optional include-linked)
17119 "Toggle the display of inline images.
17120 INCLUDE-LINKED is passed to `org-display-inline-images'."
17121 (interactive "P")
17122 (if org-inline-image-overlays
17123 (progn
17124 (org-remove-inline-images)
17125 (message "Inline image display turned off"))
17126 (org-display-inline-images include-linked)
17127 (if org-inline-image-overlays
17128 (message "%d images displayed inline"
17129 (length org-inline-image-overlays))
17130 (message "No images to display inline"))))
17132 (defun org-display-inline-images (&optional include-linked refresh beg end)
17133 "Display inline images.
17134 Normally only links without a description part are inlined, because this
17135 is how it will work for export. When INCLUDE-LINKED is set, also links
17136 with a description part will be inlined. This can be nice for a quick
17137 look at those images, but it does not reflect what exported files will look
17138 like.
17139 When REFRESH is set, refresh existing images between BEG and END.
17140 This will create new image displays only if necessary.
17141 BEG and END default to the buffer boundaries."
17142 (interactive "P")
17143 (unless refresh
17144 (org-remove-inline-images)
17145 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17146 (save-excursion
17147 (save-restriction
17148 (widen)
17149 (setq beg (or beg (point-min)) end (or end (point-max)))
17150 (goto-char (point-min))
17152 (substring (org-image-file-name-regexp) 0 -2)
17154 old file ov img)
17155 (while (re-search-forward re end t)
17156 (setq old (get-char-property-and-overlay (match-beginning 1)
17157 'org-image-overlay))
17158 (setq file (expand-file-name
17159 (concat (or (match-string 3) "") (match-string 4))))
17160 (when (file-exists-p file)
17161 (if (and (car-safe old) refresh)
17162 (image-refresh (overlay-get (cdr old) 'display))
17163 (setq img (save-match-data (create-image file)))
17164 (when img
17165 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17166 (overlay-put ov 'display img)
17167 (overlay-put ov 'face 'default)
17168 (overlay-put ov 'org-image-overlay t)
17169 (overlay-put ov 'modification-hooks
17170 (list 'org-display-inline-modification-hook))
17171 (push ov org-inline-image-overlays)))))))))
17173 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17174 "Remove inline-display overlay if a corresponding region is modified."
17175 (let ((inhibit-modification-hooks t))
17176 (when (and ov after)
17177 (delete ov org-inline-image-overlays)
17178 (delete-overlay ov))))
17180 (defun org-remove-inline-images ()
17181 "Remove inline display of images."
17182 (interactive)
17183 (mapc 'delete-overlay org-inline-image-overlays)
17184 (setq org-inline-image-overlays nil))
17186 ;;;; Key bindings
17188 ;; Outline functions from `outline-mode-prefix-map'
17189 ;; that can be remapped in Org:
17190 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17191 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17192 (define-key org-mode-map [remap outline-forward-same-level]
17193 'org-forward-same-level)
17194 (define-key org-mode-map [remap outline-backward-same-level]
17195 'org-backward-same-level)
17196 (define-key org-mode-map [remap show-branches]
17197 'org-kill-note-or-show-branches)
17198 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17199 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17200 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17202 ;; Outline functions from `outline-mode-prefix-map'
17203 ;; that can not be remapped in Org:
17204 ;; - the column "key binding" shows whether the Outline function is still
17205 ;; available in Org mode on the same key that it has been bound to in
17206 ;; Outline mode:
17207 ;; - "overridden": key used for a different functionality in Org mode
17208 ;; - else: key still bound to the same Outline function in Org mode
17209 ;; | Outline function | key binding | Org replacement |
17210 ;; |------------------------------------+-------------+-----------------------|
17211 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17212 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17213 ;; | `show-children' | `C-c C-i' | visibility cycling |
17214 ;; | `hide-subtree' | overridden | visibility cycling |
17215 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17216 ;; | `hide-body' | overridden | no replacement |
17217 ;; | `show-all' | overridden | no replacement |
17218 ;; | `hide-entry' | overridden | visibility cycling |
17219 ;; | `show-entry' | overridden | no replacement |
17220 ;; | `hide-leaves' | overridden | no replacement |
17221 ;; | `hide-sublevels' | overridden | no replacement |
17222 ;; | `hide-other' | overridden | no replacement |
17223 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17224 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17226 ;; Make `C-c C-x' a prefix key
17227 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17229 ;; TAB key with modifiers
17230 (org-defkey org-mode-map "\C-i" 'org-cycle)
17231 (org-defkey org-mode-map [(tab)] 'org-cycle)
17232 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17233 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17235 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17236 ;; The following line is necessary under Suse GNU/Linux
17237 (unless (featurep 'xemacs)
17238 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17239 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17240 (define-key org-mode-map [backtab] 'org-shifttab)
17242 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17243 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17244 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17246 ;; Cursor keys with modifiers
17247 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17248 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17249 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17250 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17252 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17253 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17254 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17255 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17257 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17258 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17259 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17260 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17262 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17263 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17264 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17265 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17267 ;; Babel keys
17268 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17269 (mapc (lambda (pair)
17270 (define-key org-babel-map (car pair) (cdr pair)))
17271 org-babel-key-bindings)
17273 ;;; Extra keys for tty access.
17274 ;; We only set them when really needed because otherwise the
17275 ;; menus don't show the simple keys
17277 (when (or org-use-extra-keys
17278 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17279 (not window-system))
17280 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17281 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17282 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17283 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17284 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17285 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17286 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17287 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17288 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17289 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17290 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17291 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17292 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17293 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17294 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17295 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17296 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17297 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17298 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17299 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17300 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17301 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17302 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17303 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17304 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17305 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17306 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17307 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17309 ;; All the other keys
17311 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17312 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17313 (if (boundp 'narrow-map)
17314 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17315 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17316 (if (boundp 'narrow-map)
17317 (org-defkey narrow-map "b" 'org-narrow-to-block)
17318 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17319 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17320 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17321 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17322 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17323 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17324 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17325 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17326 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17327 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17328 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17329 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17330 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17331 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17332 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17333 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17334 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17336 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17337 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17338 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17339 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17340 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17341 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17342 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17343 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17344 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17345 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17346 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17347 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17348 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17349 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17350 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17351 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17352 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17353 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17354 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17355 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17357 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17358 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17359 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17360 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17361 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17362 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17363 (org-defkey org-mode-map "\C-c^" 'org-sort)
17364 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17365 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17366 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17367 (org-defkey org-mode-map "\C-m" 'org-return)
17368 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17369 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17370 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17371 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17372 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17373 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17374 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17375 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17376 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17377 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17378 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17379 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17380 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17381 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17382 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17383 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17384 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17385 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17386 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17387 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17388 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17389 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17390 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17392 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17393 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17394 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17395 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17397 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17398 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17399 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17400 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17401 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17402 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17403 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17404 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17405 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17406 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17408 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17409 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17410 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17411 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17412 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17413 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17414 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17416 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17417 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17418 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17419 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17420 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17422 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17424 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17426 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17427 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17429 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17432 (when (featurep 'xemacs)
17433 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17436 (defconst org-speed-commands-default
17437 '(
17438 ("Outline Navigation")
17439 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17440 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17441 ("f" . (org-speed-move-safe 'org-forward-same-level))
17442 ("b" . (org-speed-move-safe 'org-backward-same-level))
17443 ("u" . (org-speed-move-safe 'outline-up-heading))
17444 ("j" . org-goto)
17445 ("g" . (org-refile t))
17446 ("Outline Visibility")
17447 ("c" . org-cycle)
17448 ("C" . org-shifttab)
17449 (" " . org-display-outline-path)
17450 ("Outline Structure Editing")
17451 ("U" . org-shiftmetaup)
17452 ("D" . org-shiftmetadown)
17453 ("r" . org-metaright)
17454 ("l" . org-metaleft)
17455 ("R" . org-shiftmetaright)
17456 ("L" . org-shiftmetaleft)
17457 ("i" . (progn (forward-char 1) (call-interactively
17458 'org-insert-heading-respect-content)))
17459 ("^" . org-sort)
17460 ("w" . org-refile)
17461 ("a" . org-archive-subtree-default-with-confirmation)
17462 ("." . org-mark-subtree)
17463 ("Clock Commands")
17464 ("I" . org-clock-in)
17465 ("O" . org-clock-out)
17466 ("Meta Data Editing")
17467 ("t" . org-todo)
17468 ("0" . (org-priority ?\ ))
17469 ("1" . (org-priority ?A))
17470 ("2" . (org-priority ?B))
17471 ("3" . (org-priority ?C))
17472 (";" . org-set-tags-command)
17473 ("e" . org-set-effort)
17474 ("Agenda Views etc")
17475 ("v" . org-agenda)
17476 ("/" . org-sparse-tree)
17477 ("Misc")
17478 ("o" . org-open-at-point)
17479 ("?" . org-speed-command-help)
17480 ("<" . (org-agenda-set-restriction-lock 'subtree))
17481 (">" . (org-agenda-remove-restriction-lock))
17482 )
17483 "The default speed commands.")
17485 (defun org-print-speed-command (e)
17486 (if (> (length (car e)) 1)
17487 (progn
17489 (princ (car e))
17491 (princ (make-string (length (car e)) ?-))
17493 (princ (car e))
17494 (princ " ")
17495 (if (symbolp (cdr e))
17496 (princ (symbol-name (cdr e)))
17497 (prin1 (cdr e)))
17500 (defun org-speed-command-help ()
17501 "Show the available speed commands."
17502 (interactive)
17503 (if (not org-use-speed-commands)
17504 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17505 (with-output-to-temp-buffer "*Help*"
17507 (mapc 'org-print-speed-command org-speed-commands-user)
17510 (mapc 'org-print-speed-command org-speed-commands-default))
17511 (with-current-buffer "*Help*"
17512 (setq truncate-lines t))))
17514 (defun org-speed-move-safe (cmd)
17515 "Execute CMD, but make sure that the cursor always ends up in a headline.
17516 If not, return to the original position and throw an error."
17517 (interactive)
17518 (let ((pos (point)))
17519 (call-interactively cmd)
17520 (unless (and (bolp) (org-at-heading-p))
17521 (goto-char pos)
17522 (error "Boundary reached while executing %s" cmd))))
17524 (defvar org-self-insert-command-undo-counter 0)
17526 (defvar org-table-auto-blank-field) ; defined in org-table.el
17527 (defvar org-speed-command nil)
17529 (defun org-speed-command-default-hook (keys)
17530 "Hook for activating single-letter speed commands.
17531 `org-speed-commands-default' specifies a minimal command set.
17532 Use `org-speed-commands-user' for further customization."
17533 (when (or (and (bolp) (looking-at org-outline-regexp))
17534 (and (functionp org-use-speed-commands)
17535 (funcall org-use-speed-commands)))
17536 (cdr (assoc keys (append org-speed-commands-user
17537 org-speed-commands-default)))))
17539 (defun org-babel-speed-command-hook (keys)
17540 "Hook for activating single-letter code block commands."
17541 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17542 (cdr (assoc keys org-babel-key-bindings))))
17544 (defcustom org-speed-command-hook
17545 '(org-speed-command-default-hook org-babel-speed-command-hook)
17546 "Hook for activating speed commands at strategic locations.
17547 Hook functions are called in sequence until a valid handler is
17548 found.
17550 Each hook takes a single argument, a user-pressed command key
17551 which is also a `self-insert-command' from the global map.
17553 Within the hook, examine the cursor position and the command key
17554 and return nil or a valid handler as appropriate. Handler could
17555 be one of an interactive command, a function, or a form.
17557 Set `org-use-speed-commands' to non-nil value to enable this
17558 hook. The default setting is `org-speed-command-default-hook'."
17559 :group 'org-structure
17560 :type 'hook)
17562 (defun org-self-insert-command (N)
17563 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17564 If the cursor is in a table looking at whitespace, the whitespace is
17565 overwritten, and the table is not marked as requiring realignment."
17566 (interactive "p")
17567 (org-check-before-invisible-edit 'insert)
17568 (cond
17569 ((and org-use-speed-commands
17570 (setq org-speed-command
17571 (run-hook-with-args-until-success
17572 'org-speed-command-hook (this-command-keys))))
17573 (cond
17574 ((commandp org-speed-command)
17575 (setq this-command org-speed-command)
17576 (call-interactively org-speed-command))
17577 ((functionp org-speed-command)
17578 (funcall org-speed-command))
17579 ((and org-speed-command (listp org-speed-command))
17580 (eval org-speed-command))
17581 (t (let (org-use-speed-commands)
17582 (call-interactively 'org-self-insert-command)))))
17583 ((and
17584 (org-table-p)
17585 (progn
17586 ;; check if we blank the field, and if that triggers align
17587 (and (featurep 'org-table) org-table-auto-blank-field
17588 (member last-command
17589 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17591 ;; got extra space, this field does not determine column width
17592 (let (org-table-may-need-update) (org-table-blank-field))
17593 ;; no extra space, this field may determine column width
17594 (org-table-blank-field)))
17595 t)
17596 (eq N 1)
17598 (let (org-table-may-need-update)
17599 (goto-char (1- (match-end 0)))
17600 (delete-char -1)
17601 (goto-char (match-beginning 0))
17602 (self-insert-command N)))
17603 (t
17604 (setq org-table-may-need-update t)
17605 (self-insert-command N)
17606 (org-fix-tags-on-the-fly)
17607 (if org-self-insert-cluster-for-undo
17608 (if (not (eq last-command 'org-self-insert-command))
17609 (setq org-self-insert-command-undo-counter 1)
17610 (if (>= org-self-insert-command-undo-counter 20)
17611 (setq org-self-insert-command-undo-counter 1)
17612 (and (> org-self-insert-command-undo-counter 0)
17613 buffer-undo-list (listp buffer-undo-list)
17614 (not (cadr buffer-undo-list)) ; remove nil entry
17615 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17616 (setq org-self-insert-command-undo-counter
17617 (1+ org-self-insert-command-undo-counter))))))))
17619 (defun org-check-before-invisible-edit (kind)
17620 "Check is editing if kind KIND would be dangerous with invisible text around.
17621 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17622 ;; First, try to get out of here as quickly as possible, to reduce overhead
17623 (if (and org-catch-invisible-edits
17624 (or (not (boundp 'visible-mode)) (not visible-mode))
17625 (or (get-char-property (point) 'invisible)
17626 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17627 ;; OK, we need to take a closer look
17628 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17629 (invisible-before-point (if (bobp) nil (get-char-property
17630 (1- (point)) 'invisible)))
17631 (border-and-ok-direction
17632 (or
17633 ;; Check if we are acting predictably before invisible text
17634 (and invisible-at-point (not invisible-before-point)
17635 (memq kind '(insert delete-backward)))
17636 ;; Check if we are acting predictably after invisible text
17637 ;; This works not well, and I have turned it off. It seems
17638 ;; better to always show and stop after invisible text.
17639 ;; (and (not invisible-at-point) invisible-before-point
17640 ;; (memq kind '(insert delete)))
17641 )))
17643 (when (or (memq invisible-at-point '(outline org-hide-block))
17644 (memq invisible-before-point '(outline org-hide-block)))
17645 (if (eq org-catch-invisible-edits 'error)
17646 (error "Editing in invisible areas is prohibited - make visible first"))
17647 ;; Make the area visible
17648 (save-excursion
17649 (if invisible-before-point
17650 (goto-char (previous-single-char-property-change
17651 (point) 'invisible)))
17652 (org-cycle))
17653 (cond
17654 ((eq org-catch-invisible-edits 'show)
17655 ;; That's it, we do the edit after showing
17656 (message
17657 "Unfolding invisible region around point before editing")
17658 (sit-for 1))
17659 ((and (eq org-catch-invisible-edits 'smart)
17660 border-and-ok-direction)
17661 (message "Unfolding invisible region around point before editing"))
17662 (t
17663 ;; Don't do the edit, make the user repeat it in full visibility
17664 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17666 (defun org-fix-tags-on-the-fly ()
17667 (when (and (equal (char-after (point-at-bol)) ?*)
17668 (org-at-heading-p))
17669 (org-align-tags-here org-tags-column)))
17671 (defun org-delete-backward-char (N)
17672 "Like `delete-backward-char', insert whitespace at field end in tables.
17673 When deleting backwards, in tables this function will insert whitespace in
17675 still be marked for re-alignment if the field did fill the entire column,
17676 because, in this case the deletion might narrow the column."
17677 (interactive "p")
17678 (org-check-before-invisible-edit 'delete-backward)
17679 (if (and (org-table-p)
17680 (eq N 1)
17681 (string-match "|" (buffer-substring (point-at-bol) (point)))
17682 (looking-at ".*?|"))
17683 (let ((pos (point))
17685 (c org-table-may-need-update))
17686 (backward-delete-char N)
17687 (if (not overwrite-mode)
17688 (progn
17689 (skip-chars-forward "^|")
17690 (insert " ")
17691 (goto-char (1- 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 (backward-delete-char N)
17696 (org-fix-tags-on-the-fly)))
17698 (defun org-delete-char (N)
17699 "Like `delete-char', but insert whitespace at field end in tables.
17700 When deleting characters, in tables this function will insert whitespace in
17702 still be marked for re-alignment if the field did fill the entire column,
17703 because, in this case the deletion might narrow the column."
17704 (interactive "p")
17705 (org-check-before-invisible-edit 'delete)
17706 (if (and (org-table-p)
17707 (not (bolp))
17708 (not (= (char-after) ?|))
17709 (eq N 1))
17710 (if (looking-at ".*?|")
17711 (let ((pos (point))
17713 (c org-table-may-need-update))
17714 (replace-match (concat
17715 (substring (match-string 0) 1 -1)
17716 " |"))
17717 (goto-char pos)
17718 ;; noalign: if there were two spaces at the end, this field
17719 ;; does not determine the width of the column.
17720 (if noalign (setq org-table-may-need-update c)))
17721 (delete-char N))
17722 (delete-char N)
17723 (org-fix-tags-on-the-fly)))
17725 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17726 (put 'org-self-insert-command 'delete-selection t)
17727 (put 'orgtbl-self-insert-command 'delete-selection t)
17728 (put 'org-delete-char 'delete-selection 'supersede)
17729 (put 'org-delete-backward-char 'delete-selection 'supersede)
17730 (put 'org-yank 'delete-selection 'yank)
17732 ;; Make `flyspell-mode' delay after some commands
17733 (put 'org-self-insert-command 'flyspell-delayed t)
17734 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17735 (put 'org-delete-char 'flyspell-delayed t)
17736 (put 'org-delete-backward-char 'flyspell-delayed t)
17738 ;; Make pabbrev-mode expand after org-mode commands
17739 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17740 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17742 ;; How to do this: Measure non-white length of current string
17743 ;; If equal to column width, we should realign.
17745 (defun org-remap (map &rest commands)
17746 "In MAP, remap the functions given in COMMANDS.
17747 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17748 (let (new old)
17749 (while commands
17750 (setq old (pop commands) new (pop commands))
17751 (if (fboundp 'command-remapping)
17752 (org-defkey map (vector 'remap old) new)
17753 (substitute-key-definition old new map global-map)))))
17755 (when (eq org-enable-table-editor 'optimized)
17756 ;; If the user wants maximum table support, we need to hijack
17757 ;; some standard editing functions
17758 (org-remap org-mode-map
17759 'self-insert-command 'org-self-insert-command
17760 'delete-char 'org-delete-char
17761 'delete-backward-char 'org-delete-backward-char)
17762 (org-defkey org-mode-map "|" 'org-force-self-insert))
17764 (defvar org-ctrl-c-ctrl-c-hook nil
17765 "Hook for functions attaching themselves to `C-c C-c'.
17767 This can be used to add additional functionality to the C-c C-c
17768 key which executes context-dependent commands. This hook is run
17769 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17770 run after the last test.
17772 Each function will be called with no arguments. The function
17773 must check if the context is appropriate for it to act. If yes,
17774 it should do its thing and then return a non-nil value. If the
17775 context is wrong, just do nothing and return nil.")
17777 (defvar org-ctrl-c-ctrl-c-final-hook nil
17778 "Hook for functions attaching themselves to `C-c C-c'.
17780 This can be used to add additional functionality to the C-c C-c
17781 key which executes context-dependent commands. This hook is run
17782 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17783 before the first test.
17785 Each function will be called with no arguments. The function
17786 must check if the context is appropriate for it to act. If yes,
17787 it should do its thing and then return a non-nil value. If the
17788 context is wrong, just do nothing and return nil.")
17790 (defvar org-tab-first-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 as the first action when TAB is pressed, even before
17794 `org-cycle' messes around with the `outline-regexp' to cater for
17795 inline tasks and plain list item folding.
17796 If any function in this hook returns t, any other actions that
17797 would have been caused by TAB (such as table field motion or visibility
17798 cycling) will not occur.")
17800 (defvar org-tab-after-check-for-table-hook nil
17801 "Hook for functions to attach themselves to TAB.
17802 See `org-ctrl-c-ctrl-c-hook' for more information.
17803 This hook runs after it has been established that the cursor is not in a
17804 table, but before checking if the cursor is in a headline or if global cycling
17805 should be done.
17806 If any function in this hook returns t, not other actions like visibility
17807 cycling will be done.")
17809 (defvar org-tab-after-check-for-cycling-hook nil
17810 "Hook for functions to attach themselves to TAB.
17811 See `org-ctrl-c-ctrl-c-hook' for more information.
17812 This hook runs after it has been established that not table field motion and
17813 not visibility should be done because of current context. This is probably
17814 the place where a package like yasnippets can hook in.")
17816 (defvar org-tab-before-tab-emulation-hook nil
17817 "Hook for functions to attach themselves to TAB.
17818 See `org-ctrl-c-ctrl-c-hook' for more information.
17819 This hook runs after every other options for TAB have been exhausted, but
17822 (defvar org-metaleft-hook nil
17823 "Hook for functions attaching themselves to `M-left'.
17824 See `org-ctrl-c-ctrl-c-hook' for more information.")
17825 (defvar org-metaright-hook nil
17826 "Hook for functions attaching themselves to `M-right'.
17827 See `org-ctrl-c-ctrl-c-hook' for more information.")
17828 (defvar org-metaup-hook nil
17829 "Hook for functions attaching themselves to `M-up'.
17830 See `org-ctrl-c-ctrl-c-hook' for more information.")
17831 (defvar org-metadown-hook nil
17832 "Hook for functions attaching themselves to `M-down'.
17833 See `org-ctrl-c-ctrl-c-hook' for more information.")
17834 (defvar org-shiftmetaleft-hook nil
17835 "Hook for functions attaching themselves to `M-S-left'.
17836 See `org-ctrl-c-ctrl-c-hook' for more information.")
17837 (defvar org-shiftmetaright-hook nil
17838 "Hook for functions attaching themselves to `M-S-right'.
17839 See `org-ctrl-c-ctrl-c-hook' for more information.")
17840 (defvar org-shiftmetaup-hook nil
17841 "Hook for functions attaching themselves to `M-S-up'.
17842 See `org-ctrl-c-ctrl-c-hook' for more information.")
17843 (defvar org-shiftmetadown-hook nil
17844 "Hook for functions attaching themselves to `M-S-down'.
17845 See `org-ctrl-c-ctrl-c-hook' for more information.")
17846 (defvar org-metareturn-hook nil
17847 "Hook for functions attaching themselves to `M-RET'.
17848 See `org-ctrl-c-ctrl-c-hook' for more information.")
17849 (defvar org-shiftup-hook nil
17850 "Hook for functions attaching themselves to `S-up'.
17851 See `org-ctrl-c-ctrl-c-hook' for more information.")
17852 (defvar org-shiftup-final-hook nil
17853 "Hook for functions attaching themselves to `S-up'.
17854 This one runs after all other options except shift-select have been excluded.
17855 See `org-ctrl-c-ctrl-c-hook' for more information.")
17856 (defvar org-shiftdown-hook nil
17857 "Hook for functions attaching themselves to `S-down'.
17858 See `org-ctrl-c-ctrl-c-hook' for more information.")
17859 (defvar org-shiftdown-final-hook nil
17860 "Hook for functions attaching themselves to `S-down'.
17861 This one runs after all other options except shift-select have been excluded.
17862 See `org-ctrl-c-ctrl-c-hook' for more information.")
17863 (defvar org-shiftleft-hook nil
17864 "Hook for functions attaching themselves to `S-left'.
17865 See `org-ctrl-c-ctrl-c-hook' for more information.")
17866 (defvar org-shiftleft-final-hook nil
17867 "Hook for functions attaching themselves to `S-left'.
17868 This one runs after all other options except shift-select have been excluded.
17869 See `org-ctrl-c-ctrl-c-hook' for more information.")
17870 (defvar org-shiftright-hook nil
17871 "Hook for functions attaching themselves to `S-right'.
17872 See `org-ctrl-c-ctrl-c-hook' for more information.")
17873 (defvar org-shiftright-final-hook nil
17874 "Hook for functions attaching themselves to `S-right'.
17875 This one runs after all other options except shift-select have been excluded.
17876 See `org-ctrl-c-ctrl-c-hook' for more information.")
17878 (defun org-modifier-cursor-error ()
17879 "Throw an error, a modified cursor command was applied in wrong context."
17880 (error "This command is active in special context like tables, headlines or items"))
17882 (defun org-shiftselect-error ()
17883 "Throw an error because Shift-Cursor command was applied in wrong context."
17884 (if (and (boundp 'shift-select-mode) shift-select-mode)
17885 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17886 (error "This command works only in special context like headlines or timestamps")))
17888 (defun org-call-for-shift-select (cmd)
17889 (let ((this-command-keys-shift-translated t))
17890 (call-interactively cmd)))
17892 (defun org-shifttab (&optional arg)
17893 "Global visibility cycling or move to previous table field.
17894 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17895 on context.
17896 See the individual commands for more information."
17897 (interactive "P")
17898 (cond
17899 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17900 ((integerp arg)
17901 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17902 (message "Content view to level: %d" arg)
17903 (org-content (prefix-numeric-value arg2))
17904 (setq org-cycle-global-status 'overview)))
17905 (t (call-interactively 'org-global-cycle))))
17907 (defun org-shiftmetaleft ()
17908 "Promote subtree or delete table column.
17909 Calls `org-promote-subtree', `org-outdent-item',
17910 or `org-table-delete-column', depending on context.
17911 See the individual commands for more information."
17912 (interactive)
17913 (cond
17914 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17915 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17916 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17917 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17918 (t (org-modifier-cursor-error))))
17920 (defun org-shiftmetaright ()
17921 "Demote subtree or insert table column.
17922 Calls `org-demote-subtree', `org-indent-item',
17923 or `org-table-insert-column', depending on context.
17924 See the individual commands for more information."
17925 (interactive)
17926 (cond
17927 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17928 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17929 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17930 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17931 (t (org-modifier-cursor-error))))
17933 (defun org-shiftmetaup (&optional arg)
17934 "Move subtree up or kill table row.
17935 Calls `org-move-subtree-up' or `org-table-kill-row' or
17936 `org-move-item-up' depending on context. See the individual commands
17937 for more information."
17938 (interactive "P")
17939 (cond
17940 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17941 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17942 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17943 ((org-at-item-p) (call-interactively 'org-move-item-up))
17944 (t (org-modifier-cursor-error))))
17946 (defun org-shiftmetadown (&optional arg)
17947 "Move subtree down or insert table row.
17948 Calls `org-move-subtree-down' or `org-table-insert-row' or
17949 `org-move-item-down', depending on context. See the individual
17950 commands for more information."
17951 (interactive "P")
17952 (cond
17953 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17954 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17955 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17956 ((org-at-item-p) (call-interactively 'org-move-item-down))
17957 (t (org-modifier-cursor-error))))
17959 (defsubst org-hidden-tree-error ()
17960 (error
17961 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17963 (defun org-metaleft (&optional arg)
17964 "Promote heading or move table column to left.
17965 Calls `org-do-promote' or `org-table-move-column', depending on context.
17966 With no specific context, calls the Emacs default `backward-word'.
17967 See the individual commands for more information."
17968 (interactive "P")
17969 (cond
17970 ((run-hook-with-args-until-success 'org-metaleft-hook))
17971 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17972 ((org-with-limited-levels
17973 (or (org-at-heading-p)
17974 (and (org-region-active-p)
17975 (save-excursion
17976 (goto-char (region-beginning))
17977 (org-at-heading-p)))))
17978 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17979 (call-interactively 'org-do-promote))
17980 ;; At an inline task.
17981 ((org-at-heading-p)
17982 (call-interactively 'org-inlinetask-promote))
17983 ((or (org-at-item-p)
17984 (and (org-region-active-p)
17985 (save-excursion
17986 (goto-char (region-beginning))
17987 (org-at-item-p))))
17988 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17989 (call-interactively 'org-outdent-item))
17990 (t (call-interactively 'backward-word))))
17992 (defun org-metaright (&optional arg)
17993 "Demote subtree or move table column to right.
17994 Calls `org-do-demote' or `org-table-move-column', depending on context.
17995 With no specific context, calls the Emacs default `forward-word'.
17996 See the individual commands for more information."
17997 (interactive "P")
17998 (cond
17999 ((run-hook-with-args-until-success 'org-metaright-hook))
18000 ((org-at-table-p) (call-interactively 'org-table-move-column))
18001 ((org-with-limited-levels
18002 (or (org-at-heading-p)
18003 (and (org-region-active-p)
18004 (save-excursion
18005 (goto-char (region-beginning))
18006 (org-at-heading-p)))))
18007 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18008 (call-interactively 'org-do-demote))
18009 ;; At an inline task.
18010 ((org-at-heading-p)
18011 (call-interactively 'org-inlinetask-demote))
18012 ((or (org-at-item-p)
18013 (and (org-region-active-p)
18014 (save-excursion
18015 (goto-char (region-beginning))
18016 (org-at-item-p))))
18017 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18018 (call-interactively 'org-indent-item))
18019 (t (call-interactively 'forward-word))))
18021 (defun org-check-for-hidden (what)
18022 "Check if there are hidden headlines/items in the current visual line.
18023 WHAT can be either `headlines' or `items'. If the current line is
18024 an outline or item heading and it has a folded subtree below it,
18025 this function returns t, nil otherwise."
18026 (let ((re (cond
18027 ((eq what 'headlines) org-outline-regexp-bol)
18028 ((eq what 'items) (org-item-beginning-re))
18029 (t (error "This should not happen"))))
18030 beg end)
18031 (save-excursion
18032 (catch 'exit
18033 (unless (org-region-active-p)
18034 (setq beg (point-at-bol))
18035 (beginning-of-line 2)
18036 (while (and (not (eobp)) ;; this is like `next-line'
18037 (get-char-property (1- (point)) 'invisible))
18038 (beginning-of-line 2))
18039 (setq end (point))
18040 (goto-char beg)
18041 (goto-char (point-at-eol))
18042 (setq end (max end (point)))
18043 (while (re-search-forward re end t)
18044 (if (get-char-property (match-beginning 0) 'invisible)
18045 (throw 'exit t))))
18046 nil))))
18048 (defun org-metaup (&optional arg)
18049 "Move subtree up or move table row up.
18050 Calls `org-move-subtree-up' or `org-table-move-row' or
18051 `org-move-item-up', depending on context. See the individual commands
18052 for more information."
18053 (interactive "P")
18054 (cond
18055 ((run-hook-with-args-until-success 'org-metaup-hook))
18056 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18057 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18058 ((org-at-item-p) (call-interactively 'org-move-item-up))
18059 (t (transpose-lines 1) (beginning-of-line -1))))
18061 (defun org-metadown (&optional arg)
18062 "Move subtree down or move table row down.
18063 Calls `org-move-subtree-down' or `org-table-move-row' or
18064 `org-move-item-down', depending on context. See the individual
18065 commands for more information."
18066 (interactive "P")
18067 (cond
18068 ((run-hook-with-args-until-success 'org-metadown-hook))
18069 ((org-at-table-p) (call-interactively 'org-table-move-row))
18070 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18071 ((org-at-item-p) (call-interactively 'org-move-item-down))
18072 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18074 (defun org-shiftup (&optional arg)
18075 "Increase item in timestamp or increase priority of current headline.
18076 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18077 depending on context. See the individual commands for more information."
18078 (interactive "P")
18079 (cond
18080 ((run-hook-with-args-until-success 'org-shiftup-hook))
18081 ((and org-support-shift-select (org-region-active-p))
18082 (org-call-for-shift-select 'previous-line))
18083 ((org-at-timestamp-p t)
18084 (call-interactively (if org-edit-timestamp-down-means-later
18085 'org-timestamp-down 'org-timestamp-up)))
18086 ((and (not (eq org-support-shift-select 'always))
18087 org-enable-priority-commands
18088 (org-at-heading-p))
18089 (call-interactively 'org-priority-up))
18090 ((and (not org-support-shift-select) (org-at-item-p))
18091 (call-interactively 'org-previous-item))
18092 ((org-clocktable-try-shift 'up arg))
18093 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18094 (org-support-shift-select
18095 (org-call-for-shift-select 'previous-line))
18096 (t (org-shiftselect-error))))
18098 (defun org-shiftdown (&optional arg)
18099 "Decrease item in timestamp or decrease priority of current headline.
18100 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18101 depending on context. See the individual commands for more information."
18102 (interactive "P")
18103 (cond
18104 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18105 ((and org-support-shift-select (org-region-active-p))
18106 (org-call-for-shift-select 'next-line))
18107 ((org-at-timestamp-p t)
18108 (call-interactively (if org-edit-timestamp-down-means-later
18109 'org-timestamp-up 'org-timestamp-down)))
18110 ((and (not (eq org-support-shift-select 'always))
18111 org-enable-priority-commands
18112 (org-at-heading-p))
18113 (call-interactively 'org-priority-down))
18114 ((and (not org-support-shift-select) (org-at-item-p))
18115 (call-interactively 'org-next-item))
18116 ((org-clocktable-try-shift 'down arg))
18117 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18118 (org-support-shift-select
18119 (org-call-for-shift-select 'next-line))
18120 (t (org-shiftselect-error))))
18122 (defun org-shiftright (&optional arg)
18123 "Cycle the thing at point or in the current line, depending on context.
18124 Depending on context, this does one of the following:
18126 - switch a timestamp at point one day into the future
18127 - on a headline, switch to the next TODO keyword.
18128 - on an item, switch entire list to the next bullet type
18129 - on a property line, switch to the next allowed value
18130 - on a clocktable definition line, move time block into the future"
18131 (interactive "P")
18132 (cond
18133 ((run-hook-with-args-until-success 'org-shiftright-hook))
18134 ((and org-support-shift-select (org-region-active-p))
18135 (org-call-for-shift-select 'forward-char))
18136 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18137 ((and (not (eq org-support-shift-select 'always))
18138 (org-at-heading-p))
18139 (let ((org-inhibit-logging
18140 (not org-treat-S-cursor-todo-selection-as-state-change))
18141 (org-inhibit-blocking
18142 (not org-treat-S-cursor-todo-selection-as-state-change)))
18143 (org-call-with-arg 'org-todo 'right)))
18144 ((or (and org-support-shift-select
18145 (not (eq org-support-shift-select 'always))
18146 (org-at-item-bullet-p))
18147 (and (not org-support-shift-select) (org-at-item-p)))
18148 (org-call-with-arg 'org-cycle-list-bullet nil))
18149 ((and (not (eq org-support-shift-select 'always))
18150 (org-at-property-p))
18151 (call-interactively 'org-property-next-allowed-value))
18152 ((org-clocktable-try-shift 'right arg))
18153 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18154 (org-support-shift-select
18155 (org-call-for-shift-select 'forward-char))
18156 (t (org-shiftselect-error))))
18158 (defun org-shiftleft (&optional arg)
18159 "Cycle the thing at point or in the current line, depending on context.
18160 Depending on context, this does one of the following:
18162 - switch a timestamp at point one day into the past
18163 - on a headline, switch to the previous TODO keyword.
18164 - on an item, switch entire list to the previous bullet type
18165 - on a property line, switch to the previous allowed value
18166 - on a clocktable definition line, move time block into the past"
18167 (interactive "P")
18168 (cond
18169 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18170 ((and org-support-shift-select (org-region-active-p))
18171 (org-call-for-shift-select 'backward-char))
18172 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18173 ((and (not (eq org-support-shift-select 'always))
18174 (org-at-heading-p))
18175 (let ((org-inhibit-logging
18176 (not org-treat-S-cursor-todo-selection-as-state-change))
18177 (org-inhibit-blocking
18178 (not org-treat-S-cursor-todo-selection-as-state-change)))
18179 (org-call-with-arg 'org-todo 'left)))
18180 ((or (and org-support-shift-select
18181 (not (eq org-support-shift-select 'always))
18182 (org-at-item-bullet-p))
18183 (and (not org-support-shift-select) (org-at-item-p)))
18184 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18185 ((and (not (eq org-support-shift-select 'always))
18186 (org-at-property-p))
18187 (call-interactively 'org-property-previous-allowed-value))
18188 ((org-clocktable-try-shift 'left arg))
18189 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18190 (org-support-shift-select
18191 (org-call-for-shift-select 'backward-char))
18192 (t (org-shiftselect-error))))
18194 (defun org-shiftcontrolright ()
18195 "Switch to next TODO set."
18196 (interactive)
18197 (cond
18198 ((and org-support-shift-select (org-region-active-p))
18199 (org-call-for-shift-select 'forward-word))
18200 ((and (not (eq org-support-shift-select 'always))
18201 (org-at-heading-p))
18202 (org-call-with-arg 'org-todo 'nextset))
18203 (org-support-shift-select
18204 (org-call-for-shift-select 'forward-word))
18205 (t (org-shiftselect-error))))
18207 (defun org-shiftcontrolleft ()
18208 "Switch to previous TODO set."
18209 (interactive)
18210 (cond
18211 ((and org-support-shift-select (org-region-active-p))
18212 (org-call-for-shift-select 'backward-word))
18213 ((and (not (eq org-support-shift-select 'always))
18214 (org-at-heading-p))
18215 (org-call-with-arg 'org-todo 'previousset))
18216 (org-support-shift-select
18217 (org-call-for-shift-select 'backward-word))
18218 (t (org-shiftselect-error))))
18220 (defun org-shiftcontrolup ()
18221 "Change timestamps synchronously up in CLOCK log lines."
18222 (interactive)
18223 (cond ((and (not org-support-shift-select)
18224 (org-at-clock-log-p)
18225 (org-at-timestamp-p t))
18226 (org-clock-timestamps-up))
18227 (t (org-shiftselect-error))))
18229 (defun org-shiftcontroldown ()
18230 "Change timestamps synchronously down in CLOCK log lines."
18231 (interactive)
18232 (cond ((and (not org-support-shift-select)
18233 (org-at-clock-log-p)
18234 (org-at-timestamp-p t))
18235 (org-clock-timestamps-down))
18236 (t (org-shiftselect-error))))
18238 (defun org-ctrl-c-ret ()
18239 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18240 (interactive)
18241 (cond
18242 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18243 (t (call-interactively 'org-insert-heading))))
18245 (defun org-find-visible ()
18246 (let ((s (point)))
18247 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18248 (get-char-property s 'invisible)))
18249 s))
18250 (defun org-find-invisible ()
18251 (let ((s (point)))
18252 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18253 (not (get-char-property s 'invisible))))
18254 s))
18256 (defun org-copy-visible (beg end)
18257 "Copy the visible parts of the region."
18258 (interactive "r")
18259 (let (snippets s)
18260 (save-excursion
18261 (save-restriction
18262 (narrow-to-region beg end)
18263 (setq s (goto-char (point-min)))
18264 (while (not (= (point) (point-max)))
18265 (goto-char (org-find-invisible))
18266 (push (buffer-substring s (point)) snippets)
18267 (setq s (goto-char (org-find-visible))))))
18268 (kill-new (apply 'concat (nreverse snippets)))))
18270 (defun org-copy-special ()
18271 "Copy region in table or copy current subtree.
18272 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18273 See the individual commands for more information."
18274 (interactive)
18275 (call-interactively
18276 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18278 (defun org-cut-special ()
18279 "Cut region in table or cut current subtree.
18280 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18281 See the individual commands for more information."
18282 (interactive)
18283 (call-interactively
18284 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18286 (defun org-paste-special (arg)
18287 "Paste rectangular region into table, or past subtree relative to level.
18288 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18289 See the individual commands for more information."
18290 (interactive "P")
18291 (if (org-at-table-p)
18292 (org-table-paste-rectangle)
18293 (org-paste-subtree arg)))
18295 (defun org-edit-special (&optional arg)
18296 "Call a special editor for the stuff at point.
18297 When at a table, call the formula editor with `org-table-edit-formulas'.
18298 When at the first line of an src example, call `org-edit-src-code'.
18299 When in an #+include line, visit the include file. Otherwise call
18300 `ffap' to visit the file at point."
18301 (interactive)
18302 ;; possibly prep session before editing source
18303 (when arg
18304 (let* ((info (org-babel-get-src-block-info))
18305 (lang (nth 0 info))
18306 (params (nth 2 info))
18307 (session (cdr (assoc :session params))))
18308 (when (and info session) ;; we are in a source-code block with a session
18309 (funcall
18310 (intern (concat "org-babel-prep-session:" lang)) session params))))
18311 (cond ;; proceed with `org-edit-special'
18312 ((save-excursion
18313 (beginning-of-line 1)
18314 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18315 (find-file (org-trim (match-string 1))))
18316 ((org-edit-src-code))
18317 ((org-edit-fixed-width-region))
18318 ((org-at-table.el-p)
18319 (org-edit-src-code))
18320 ((or (org-at-table-p)
18321 (save-excursion
18322 (beginning-of-line 1)
18324 (call-interactively 'org-table-edit-formulas))
18325 (t (call-interactively 'ffap))))
18327 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18328 (defun org-ctrl-c-ctrl-c (&optional arg)
18329 "Set tags in headline, or update according to changed information at point.
18331 This command does many different things, depending on context:
18333 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18334 this is what we do.
18336 - If the cursor is on a statistics cookie, update it.
18338 - If the cursor is in a headline, prompt for tags and insert them
18339 into the current line, aligned to `org-tags-column'. When called
18340 with prefix arg, realign all tags in the current buffer.
18342 - If the cursor is in one of the special #+KEYWORD lines, this
18343 triggers scanning the buffer for these lines and updating the
18344 information.
18346 - If the cursor is inside a table, realign the table. This command
18347 works even if the automatic table editor has been turned off.
18349 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18350 the entire table.
18352 - If the cursor is at a footnote reference or definition, jump to
18353 the corresponding definition or references, respectively.
18355 - If the cursor is a the beginning of a dynamic block, update it.
18357 - If the current buffer is a capture buffer, close note and file it.
18359 - If the cursor is on a <<<target>>>, update radio targets and
18360 corresponding links in this buffer.
18362 - If the cursor is on a numbered item in a plain list, renumber the
18363 ordered list.
18365 - If the cursor is on a checkbox, toggle it.
18367 - If the cursor is on a code block, evaluate it. The variable
18368 `org-confirm-babel-evaluate' can be used to control prompting
18369 before code block evaluation, by default every code block
18370 evaluation requires confirmation. Code block evaluation can be
18371 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18372 (interactive "P")
18373 (let ((org-enable-table-editor t))
18374 (cond
18375 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18376 org-occur-highlights
18377 org-latex-fragment-image-overlays)
18378 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18379 (org-remove-occur-highlights)
18380 (org-remove-latex-fragment-image-overlays)
18381 (message "Temporary highlights/overlays removed from current buffer"))
18382 ((and (local-variable-p 'org-finish-function (current-buffer))
18383 (fboundp org-finish-function))
18384 (funcall org-finish-function))
18385 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18386 ((org-in-regexp org-ts-regexp-both)
18387 (org-timestamp-change 0 'day))
18388 ((or (looking-at org-property-start-re)
18389 (org-at-property-p))
18390 (call-interactively 'org-property-action))
18391 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18393 (or (org-at-heading-p) (org-at-item-p)))
18394 (call-interactively 'org-update-statistics-cookies))
18395 ((org-at-heading-p) (call-interactively 'org-set-tags))
18396 ((org-at-table.el-p)
18397 (message "Use C-c ' to edit table.el tables"))
18398 ((org-at-table-p)
18399 (org-table-maybe-eval-formula)
18400 (if arg
18401 (call-interactively 'org-table-recalculate)
18402 (org-table-maybe-recalculate-line))
18403 (call-interactively 'org-table-align)
18404 (orgtbl-send-table 'maybe))
18405 ((or (org-footnote-at-reference-p)
18406 (org-footnote-at-definition-p))
18407 (call-interactively 'org-footnote-action))
18408 ((org-at-item-checkbox-p)
18409 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18410 ;; list only if at top item.
18411 (let* ((cbox (match-string 1))
18412 (struct (org-list-struct))
18413 (old-struct (copy-tree struct))
18414 (parents (org-list-parents-alist struct))
18415 (orderedp (org-entry-get nil "ORDERED"))
18416 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18417 block-item)
18418 ;; Use a light version of `org-toggle-checkbox' to avoid
18419 ;; computing list structure twice.
18420 (let ((new-box (cond
18421 ((equal arg '(16)) "[-]")
18422 ((equal arg '(4)) nil)
18423 ((equal "[X]" cbox) "[ ]")
18424 (t "[X]"))))
18425 (if (and firstp arg)
18426 ;; If at first item of sub-list, remove check-box from
18427 ;; every item at the same level.
18428 (mapc
18429 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18430 (org-list-get-all-items
18431 (point-at-bol) struct (org-list-prevs-alist struct)))
18432 (org-list-set-checkbox (point-at-bol) struct new-box)))
18433 ;; Replicate `org-list-write-struct', while grabbing a return
18434 ;; value from `org-list-struct-fix-box'.
18435 (org-list-struct-fix-ind struct parents 2)
18436 (org-list-struct-fix-item-end struct)
18437 (let ((prevs (org-list-prevs-alist struct)))
18438 (org-list-struct-fix-bul struct prevs)
18439 (org-list-struct-fix-ind struct parents)
18440 (setq block-item
18441 (org-list-struct-fix-box struct parents prevs orderedp)))
18442 (org-list-struct-apply-struct struct old-struct)
18443 (org-update-checkbox-count-maybe)
18444 (when block-item
18445 (message
18446 "Checkboxes were removed due to unchecked box at line %d"
18447 (org-current-line block-item)))
18448 (when firstp (org-list-send-list 'maybe))))
18449 ((org-at-item-p)
18450 ;; Cursor at an item: repair list. Do checkbox related actions
18451 ;; only if function was called with an argument. Send list only
18452 ;; if at top item.
18453 (let* ((struct (org-list-struct))
18454 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18455 old-struct)
18456 (when arg
18457 (setq old-struct (copy-tree struct))
18458 (if firstp
18459 ;; If at first item of sub-list, add check-box to every
18460 ;; item at the same level.
18461 (mapc
18462 (lambda (pos)
18463 (unless (org-list-get-checkbox pos struct)
18464 (org-list-set-checkbox pos struct "[ ]")))
18465 (org-list-get-all-items
18466 (point-at-bol) struct (org-list-prevs-alist struct)))
18467 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18468 (org-list-write-struct
18469 struct (org-list-parents-alist struct) old-struct)
18470 (when arg (org-update-checkbox-count-maybe))
18471 (when firstp (org-list-send-list 'maybe))))
18472 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18473 ;; Dynamic block
18474 (beginning-of-line 1)
18475 (save-excursion (org-update-dblock)))
18476 ((save-excursion
18477 (beginning-of-line 1)
18479 (cond
18480 ((equal (match-string 1) "TBLFM")
18481 ;; Recalculate the table before this line
18482 (save-excursion
18483 (beginning-of-line 1)
18485 (if (org-at-table-p)
18486 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18487 (t
18488 (let ((org-inhibit-startup-visibility-stuff t)
18489 (org-startup-align-all-tables nil))
18490 (when (boundp 'org-table-coordinate-overlays)
18491 (mapc 'delete-overlay org-table-coordinate-overlays)
18492 (setq org-table-coordinate-overlays nil))
18493 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18494 (message "Local setup has been refreshed"))))
18495 ((org-clock-update-time-maybe))
18496 (t
18497 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18498 (error "C-c C-c can do nothing useful at this location"))))))
18500 (defun org-mode-restart ()
18501 "Restart Org-mode, to scan again for special lines.
18502 Also updates the keyword regular expressions."
18503 (interactive)
18504 (org-mode)
18505 (message "Org-mode restarted"))
18507 (defun org-kill-note-or-show-branches ()
18508 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18509 (interactive)
18510 (if (not org-finish-function)
18511 (progn
18512 (hide-subtree)
18513 (call-interactively 'show-branches))
18514 (let ((org-note-abort t))
18515 (funcall org-finish-function))))
18517 (defun org-return (&optional indent)
18518 "Goto next table row or insert a newline.
18519 Calls `org-table-next-row' or `newline', depending on context.
18520 See the individual commands for more information."
18521 (interactive)
18522 (cond
18523 ((or (bobp) (org-in-src-block-p))
18524 (if indent (newline-and-indent) (newline)))
18525 ((org-at-table-p)
18526 (org-table-justify-field-maybe)
18527 (call-interactively 'org-table-next-row))
18528 ;; when `newline-and-indent' is called within a list, make sure
18529 ;; text moved stays inside the item.
18530 ((and (org-in-item-p) indent)
18531 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18532 (progn
18533 (save-match-data (newline))
18534 (org-indent-line-to (length (match-string 0))))
18535 (let ((ind (org-get-indentation)))
18536 (newline)
18537 (if (org-looking-back org-list-end-re)
18538 (org-indent-line-function)
18539 (org-indent-line-to ind)))))
18540 ((and org-return-follows-link
18541 (let ((tprop (get-text-property (point) 'face)))
18542 (or (eq tprop 'org-link)
18543 (and (listp tprop) (memq 'org-link tprop)))))
18544 (call-interactively 'org-open-at-point))
18545 ((and (org-at-heading-p)
18546 (looking-at
18548 (org-show-entry)
18549 (end-of-line 1)
18550 (newline))
18551 (t (if indent (newline-and-indent) (newline)))))
18553 (defun org-return-indent ()
18554 "Goto next table row or insert a newline and indent.
18555 Calls `org-table-next-row' or `newline-and-indent', depending on
18556 context. See the individual commands for more information."
18557 (interactive)
18558 (org-return t))
18560 (defun org-ctrl-c-star ()
18561 "Compute table, or change heading status of lines.
18562 Calls `org-table-recalculate' or `org-toggle-heading',
18563 depending on context."
18564 (interactive)
18565 (cond
18566 ((org-at-table-p)
18567 (call-interactively 'org-table-recalculate))
18568 (t
18569 ;; Convert all lines in region to list items
18570 (call-interactively 'org-toggle-heading))))
18572 (defun org-ctrl-c-minus ()
18573 "Insert separator line in table or modify bullet status of line.
18574 Also turns a plain line or a region of lines into list items.
18575 Calls `org-table-insert-hline', `org-toggle-item', or
18576 `org-cycle-list-bullet', depending on context."
18577 (interactive)
18578 (cond
18579 ((org-at-table-p)
18580 (call-interactively 'org-table-insert-hline))
18581 ((org-region-active-p)
18582 (call-interactively 'org-toggle-item))
18583 ((org-in-item-p)
18584 (call-interactively 'org-cycle-list-bullet))
18585 (t
18586 (call-interactively 'org-toggle-item))))
18588 (defun org-toggle-item (arg)
18589 "Convert headings or normal lines to items, items to normal lines.
18590 If there is no active region, only the current line is considered.
18592 If the first non blank line in the region is an headline, convert
18593 all headlines to items, shifting text accordingly.
18595 If it is an item, convert all items to normal lines.
18597 If it is normal text, change region into an item. With a prefix
18598 argument ARG, change each line in region into an item."
18599 (interactive "P")
18600 (let ((shift-text
18601 (function
18602 ;; Shift text in current section to IND, from point to END.
18603 ;; The function leaves point to END line.
18604 (lambda (ind end)
18605 (let ((min-i 1000) (end (copy-marker end)))
18606 ;; First determine the minimum indentation (MIN-I) of
18607 ;; the text.
18608 (save-excursion
18609 (catch 'exit
18610 (while (< (point) end)
18611 (let ((i (org-get-indentation)))
18612 (cond
18613 ;; Skip blank lines and inline tasks.
18615 ((looking-at org-outline-regexp-bol))
18616 ;; We can't find less than 0 indentation.
18617 ((zerop i) (throw 'exit (setq min-i 0)))
18618 ((< i min-i) (setq min-i i))))
18619 (forward-line))))
18620 ;; Then indent each line so that a line indented to
18621 ;; MIN-I becomes indented to IND. Ignore blank lines
18622 ;; and inline tasks in the process.
18623 (let ((delta (- ind min-i)))
18624 (while (< (point) end)
18626 (looking-at org-outline-regexp-bol))
18627 (org-indent-line-to (+ (org-get-indentation) delta)))
18628 (forward-line)))))))
18629 (skip-blanks
18630 (function
18631 ;; Return beginning of first non-blank line, starting from
18632 ;; line at POS.
18633 (lambda (pos)
18634 (save-excursion
18635 (goto-char pos)
18637 (point-at-bol)))))
18638 beg end)
18639 ;; Determine boundaries of changes.
18640 (if (org-region-active-p)
18641 (setq beg (funcall skip-blanks (region-beginning))
18642 end (copy-marker (region-end)))
18643 (setq beg (funcall skip-blanks (point-at-bol))
18644 end (copy-marker (point-at-eol))))
18645 ;; Depending on the starting line, choose an action on the text
18646 ;; between BEG and END.
18647 (org-with-limited-levels
18648 (save-excursion
18649 (goto-char beg)
18650 (cond
18651 ;; Case 1. Start at an item: de-itemize. Note that it only
18652 ;; happens when a region is active: `org-ctrl-c-minus'
18653 ;; would call `org-cycle-list-bullet' otherwise.
18654 ((org-at-item-p)
18655 (while (< (point) end)
18656 (when (org-at-item-p)
18658 (delete-region (point) (match-end 0)))
18659 (forward-line)))
18660 ;; Case 2. Start at an heading: convert to items.
18661 ((org-at-heading-p)
18662 (let* ((bul (org-list-bullet-string "-"))
18663 (bul-len (length bul))
18664 ;; Indentation of the first heading. It should be
18665 ;; relative to the indentation of its parent, if any.
18666 (start-ind (save-excursion
18667 (cond
18668 ((not org-adapt-indentation) 0)
18669 ((not (outline-previous-heading)) 0)
18670 (t (length (match-string 0))))))
18671 ;; Level of first heading. Further headings will be
18672 ;; compared to it to determine hierarchy in the list.
18673 (ref-level (org-reduced-level (org-outline-level))))
18674 (while (< (point) end)
18675 (let* ((level (org-reduced-level (org-outline-level)))
18676 (delta (max 0 (- level ref-level))))
18677 ;; If current headline is less indented than the first
18678 ;; one, set it as reference, in order to preserve
18679 ;; subtrees.
18680 (when (< level ref-level) (setq ref-level level))
18681 (replace-match bul t t)
18682 (org-indent-line-to (+ start-ind (* delta bul-len)))
18683 ;; Ensure all text down to END (or SECTION-END) belongs
18684 ;; to the newly created item.
18685 (let ((section-end (save-excursion
18686 (or (outline-next-heading) (point)))))
18687 (forward-line)
18688 (funcall shift-text
18689 (+ start-ind (* (1+ delta) bul-len))
18690 (min end section-end)))))))
18691 ;; Case 3. Normal line with ARG: turn each non-item line into
18692 ;; an item.
18693 (arg
18694 (while (< (point) end)
18695 (unless (or (org-at-heading-p) (org-at-item-p))
18697 (replace-match
18699 (forward-line)))
18700 ;; Case 4. Normal line without ARG: make the first line of
18701 ;; region an item, and shift indentation of others
18702 ;; lines to set them as item's body.
18703 (t (let* ((bul (org-list-bullet-string "-"))
18704 (bul-len (length bul))
18705 (ref-ind (org-get-indentation)))
18707 (insert bul)
18708 (forward-line)
18709 (while (< (point) end)
18710 ;; Ensure that lines less indented than first one
18711 ;; still get included in item body.
18712 (funcall shift-text
18713 (+ ref-ind bul-len)
18714 (min end (save-excursion (or (outline-next-heading)
18715 (point)))))
18716 (forward-line)))))))))
18718 (defun org-toggle-heading (&optional nstars)
18719 "Convert headings to normal text, or items or text to headings.
18720 If there is no active region, only the current line is considered.
18722 If the first non blank line is an headline, remove the stars from
18723 all headlines in the region.
18725 If it is a plain list item, turn all plain list items into headings.
18727 If it is a normal line, turn each and every normal line (i.e. not
18728 an heading or an item) in the region into a heading.
18730 When converting a line into a heading, the number of stars is chosen
18731 such that the lines become children of the current entry. However,
18732 when a prefix argument is given, its value determines the number of
18733 stars to add."
18734 (interactive "P")
18735 (let ((skip-blanks
18736 (function
18737 ;; Return beginning of first non-blank line, starting from
18738 ;; line at POS.
18739 (lambda (pos)
18740 (save-excursion
18741 (goto-char pos)
18743 (point-at-bol)))))
18744 beg end)
18745 ;; Determine boundaries of changes. If region ends at a bol, do
18746 ;; not consider the last line to be in the region.
18747 (if (org-region-active-p)
18748 (setq beg (funcall skip-blanks (region-beginning))
18749 end (copy-marker (save-excursion
18750 (goto-char (region-end))
18751 (if (bolp) (point) (point-at-eol)))))
18752 (setq beg (funcall skip-blanks (point-at-bol))
18753 end (copy-marker (point-at-eol))))
18754 ;; Ensure inline tasks don't count as headings.
18755 (org-with-limited-levels
18756 (save-excursion
18757 (goto-char beg)
18758 (cond
18759 ;; Case 1. Started at an heading: de-star headings.
18760 ((org-at-heading-p)
18761 (while (< (point) end)
18762 (when (org-at-heading-p t)
18763 (looking-at org-outline-regexp) (replace-match ""))
18764 (forward-line)))
18765 ;; Case 2. Started at an item: change items into headlines.
18766 ;; One star will be added by `org-list-to-subtree'.
18767 ((org-at-item-p)
18768 (let* ((stars (make-string
18769 (if nstars
18770 ;; subtract the star that will be added again by
18771 ;; `org-list-to-subtree'
18772 (1- (prefix-numeric-value current-prefix-arg))
18773 (or (org-current-level) 0))
18774 ?*))
18775 (add-stars
18776 (cond (nstars "") ; stars from prefix only
18777 ((equal stars "") "") ; before first heading
18778 (org-odd-levels-only "*") ; inside heading, odd
18779 (t "")))) ; inside heading, oddeven
18780 (while (< (point) end)
18781 (when (org-at-item-p)
18782 ;; Pay attention to cases when region ends before list.
18783 (let* ((struct (org-list-struct))
18784 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18785 (save-restriction
18786 (narrow-to-region (point) list-end)
18787 (insert
18788 (org-list-to-subtree
18789 (org-list-parse-list t)
18790 '(:istart (concat stars add-stars (funcall get-stars depth))
18791 :icount (concat stars add-stars (funcall get-stars depth))))))))
18792 (forward-line))))
18793 ;; Case 3. Started at normal text: make every line an heading,
18794 ;; skipping headlines and items.
18795 (t (let* ((stars (make-string
18796 (if nstars
18797 (prefix-numeric-value current-prefix-arg)
18798 (or (org-current-level) 0))
18799 ?*))
18800 (add-stars
18801 (cond (nstars "") ; stars from prefix only
18802 ((equal stars "") "*") ; before first heading
18803 (org-odd-levels-only "**") ; inside heading, odd
18804 (t "*"))) ; inside heading, oddeven
18805 (rpl (concat stars add-stars " ")))
18806 (while (< (point) end)
18807 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18809 (replace-match (concat rpl (match-string 2))))
18810 (forward-line)))))))))
18812 (defun org-meta-return (&optional arg)
18813 "Insert a new heading or wrap a region in a table.
18814 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18815 See the individual commands for more information."
18816 (interactive "P")
18817 (cond
18818 ((run-hook-with-args-until-success 'org-metareturn-hook))
18819 ((or (org-at-drawer-p) (org-at-property-p))
18820 (newline-and-indent))
18821 ((org-at-table-p)
18822 (call-interactively 'org-table-wrap-region))
18823 (t (call-interactively 'org-insert-heading))))
18825 ;;; Menu entries
18827 ;; Define the Org-mode menus
18828 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18829 '("Tbl"
18830 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18831 ["Next Field" org-cycle (org-at-table-p)]
18832 ["Previous Field" org-shifttab (org-at-table-p)]
18833 ["Next Row" org-return (org-at-table-p)]
18834 "--"
18835 ["Blank Field" org-table-blank-field (org-at-table-p)]
18836 ["Edit Field" org-table-edit-field (org-at-table-p)]
18837 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18838 "--"
18839 ("Column"
18840 ["Move Column Left" org-metaleft (org-at-table-p)]
18841 ["Move Column Right" org-metaright (org-at-table-p)]
18842 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18843 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18844 ("Row"
18845 ["Move Row Up" org-metaup (org-at-table-p)]
18846 ["Move Row Down" org-metadown (org-at-table-p)]
18847 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18848 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18849 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18850 "--"
18851 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18852 ("Rectangle"
18853 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18854 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18855 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18856 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18857 "--"
18858 ("Calculate"
18859 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18860 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18861 ["Edit Formulas" org-edit-special (org-at-table-p)]
18862 "--"
18863 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18864 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18865 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18866 "--"
18867 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18868 "--"
18869 ["Sum Column/Rectangle" org-table-sum
18870 (or (org-at-table-p) (org-region-active-p))]
18871 ["Which Column?" org-table-current-column (org-at-table-p)])
18872 ["Debug Formulas"
18873 org-table-toggle-formula-debugger
18874 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18875 ["Show Col/Row Numbers"
18876 org-table-toggle-coordinate-overlays
18877 :style toggle
18878 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18879 "--"
18880 ["Create" org-table-create (and (not (org-at-table-p))
18881 org-enable-table-editor)]
18882 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18883 ["Import from File" org-table-import (not (org-at-table-p))]
18884 ["Export to File" org-table-export (org-at-table-p)]
18885 "--"
18886 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18888 (easy-menu-define org-org-menu org-mode-map "Org menu"
18889 '("Org"
18890 ("Show/Hide"
18891 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18892 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18893 ["Sparse Tree..." org-sparse-tree t]
18894 ["Reveal Context" org-reveal t]
18895 ["Show All" show-all t]
18896 "--"
18897 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18898 "--"
18899 ["New Heading" org-insert-heading t]
18900 ("Navigate Headings"
18901 ["Up" outline-up-heading t]
18902 ["Next" outline-next-visible-heading t]
18903 ["Previous" outline-previous-visible-heading t]
18904 ["Next Same Level" outline-forward-same-level t]
18905 ["Previous Same Level" outline-backward-same-level t]
18906 "--"
18907 ["Jump" org-goto t])
18908 ("Edit Structure"
18909 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18910 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18911 "--"
18912 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18913 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18914 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18915 "--"
18916 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18917 "--"
18918 ["Copy visible text" org-copy-visible t]
18919 "--"
18920 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18921 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18922 ["Demote Heading" org-metaright (not (org-at-table-p))]
18923 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18924 "--"
18925 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18926 "--"
18927 ["Convert to odd levels" org-convert-to-odd-levels t]
18928 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18929 ("Editing"
18930 ["Emphasis..." org-emphasize t]
18931 ["Edit Source Example" org-edit-special t]
18932 "--"
18933 ["Footnote new/jump" org-footnote-action t]
18934 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18935 ("Archive"
18936 ["Archive (default method)" org-archive-subtree-default t]
18937 "--"
18938 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18939 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18940 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18941 )
18942 "--"
18943 ("Hyperlinks"
18944 ["Store Link (Global)" org-store-link t]
18945 ["Find existing link to here" org-occur-link-in-agenda-files t]
18946 ["Insert Link" org-insert-link t]
18947 ["Follow Link" org-open-at-point t]
18948 "--"
18949 ["Next link" org-next-link t]
18950 ["Previous link" org-previous-link t]
18951 "--"
18952 ["Descriptive Links"
18953 org-toggle-link-display
18954 :style radio
18955 :selected org-descriptive-links
18956 ]
18957 ["Literal Links"
18958 org-toggle-link-display
18959 :style radio
18960 :selected (not org-descriptive-links)])
18961 "--"
18962 ("TODO Lists"
18963 ["TODO/DONE/-" org-todo t]
18964 ("Select keyword"
18965 ["Next keyword" org-shiftright (org-at-heading-p)]
18966 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18967 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18968 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18969 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18970 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18971 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18972 "--"
18973 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18974 :selected org-enforce-todo-dependencies :style toggle :active t]
18975 "Settings for tree at point"
18976 ["Do Children sequentially" org-toggle-ordered-property :style radio
18977 :selected (org-entry-get nil "ORDERED")
18978 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18979 ["Do Children parallel" org-toggle-ordered-property :style radio
18980 :selected (not (org-entry-get nil "ORDERED"))
18981 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18982 "--"
18983 ["Set Priority" org-priority t]
18984 ["Priority Up" org-shiftup t]
18985 ["Priority Down" org-shiftdown t]
18986 "--"
18987 ["Get news from all feeds" org-feed-update-all t]
18988 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18989 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18990 ("TAGS and Properties"
18991 ["Set Tags" org-set-tags-command t]
18992 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18993 "--"
18994 ["Set property" org-set-property t]
18995 ["Column view of properties" org-columns t]
18996 ["Insert Column View DBlock" org-insert-columns-dblock t])
18997 ("Dates and Scheduling"
18998 ["Timestamp" org-time-stamp t]
18999 ["Timestamp (inactive)" org-time-stamp-inactive t]
19000 ("Change Date"
19001 ["1 Day Later" org-shiftright t]
19002 ["1 Day Earlier" org-shiftleft t]
19003 ["1 ... Later" org-shiftup t]
19004 ["1 ... Earlier" org-shiftdown t])
19005 ["Compute Time Range" org-evaluate-time-range t]
19006 ["Schedule Item" org-schedule t]
19007 ["Deadline" org-deadline t]
19008 "--"
19009 ["Custom time format" org-toggle-time-stamp-overlays
19010 :style radio :selected org-display-custom-times]
19011 "--"
19012 ["Goto Calendar" org-goto-calendar t]
19013 ["Date from Calendar" org-date-from-calendar t]
19014 "--"
19015 ["Start/Restart Timer" org-timer-start t]
19016 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19017 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19018 ["Insert Timer String" org-timer t]
19019 ["Insert Timer Item" org-timer-item t])
19020 ("Logging work"
19021 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19022 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19023 ["Clock out" org-clock-out t]
19024 ["Clock cancel" org-clock-cancel t]
19025 "--"
19026 ["Mark as default task" org-clock-mark-default-task t]
19027 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19028 ["Goto running clock" org-clock-goto t]
19029 "--"
19030 ["Display times" org-clock-display t]
19031 ["Create clock table" org-clock-report t]
19032 "--"
19033 ["Record DONE time"
19034 (progn (setq org-log-done (not org-log-done))
19035 (message "Switching to %s will %s record a timestamp"
19036 (car org-done-keywords)
19037 (if org-log-done "automatically" "not")))
19038 :style toggle :selected org-log-done])
19039 "--"
19040 ["Agenda Command..." org-agenda t]
19041 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19042 ("File List for Agenda")
19043 ("Special views current file"
19044 ["TODO Tree" org-show-todo-tree t]
19045 ["Check Deadlines" org-check-deadlines t]
19046 ["Timeline" org-timeline t]
19047 ["Tags/Property tree" org-match-sparse-tree t])
19048 "--"
19049 ["Export/Publish..." org-export t]
19050 ("LaTeX"
19051 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19052 :selected org-cdlatex-mode]
19053 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19054 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19055 ["Modify math symbol" org-cdlatex-math-modify
19056 (org-inside-LaTeX-fragment-p)]
19057 ["Insert citation" org-reftex-citation t]
19058 "--"
19059 ["Template for BEAMER" org-insert-beamer-options-template t])
19060 "--"
19061 ("MobileOrg"
19062 ["Push Files and Views" org-mobile-push t]
19063 ["Get Captured and Flagged" org-mobile-pull t]
19064 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19065 "--"
19066 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19067 "--"
19068 ("Documentation"
19069 ["Show Version" org-version t]
19070 ["Info Documentation" org-info t])
19071 ("Customize"
19072 ["Browse Org Group" org-customize t]
19073 "--"
19074 ["Expand This Menu" org-create-customize-menu
19075 (fboundp 'customize-menu-create)])
19076 ["Send bug report" org-submit-bug-report t]
19077 "--"
19078 ("Refresh/Reload"
19079 ["Refresh setup current buffer" org-mode-restart t]
19080 ["Reload Org (after update)" org-reload t]
19081 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19082 ))
19084 (defun org-info (&optional node)
19085 "Read documentation for Org-mode in the info system.
19086 With optional NODE, go directly to that node."
19087 (interactive)
19088 (info (format "(org)%s" (or node ""))))
19090 ;;;###autoload
19091 (defun org-submit-bug-report ()
19092 "Submit a bug report on Org-mode via mail.
19094 Don't hesitate to report any problems or inaccurate documentation.
19096 If you don't have setup sending mail from (X)Emacs, please copy the
19097 output buffer into your mail program, as it gives us important
19098 information about your Org-mode version and configuration."
19099 (interactive)
19100 (require 'reporter)
19101 (org-load-modules-maybe)
19102 (org-require-autoloaded-modules)
19103 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19104 (reporter-submit-bug-report
19105 "emacs-orgmode@gnu.org"
19106 (org-version)
19107 (let (list)
19108 (save-window-excursion
19109 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19110 (delete-other-windows)
19111 (erase-buffer)
19112 (insert "You are about to submit a bug report to the Org-mode mailing list.
19114 We would like to add your full Org-mode and Outline configuration to the
19115 bug report. This greatly simplifies the work of the maintainer and
19116 other experts on the mailing list.
19118 HOWEVER, some variables you have customized may contain private
19119 information. The names of customers, colleagues, or friends, might
19120 appear in the form of file names, tags, todo states, or search strings.
19121 If you answer yes to the prompt, you might want to check and remove
19122 such private information before sending the email.")
19123 (add-text-properties (point-min) (point-max) '(face org-warning))
19124 (when (yes-or-no-p "Include your Org-mode configuration ")
19125 (mapatoms
19126 (lambda (v)
19127 (and (boundp v)
19129 (or (and (symbol-value v)
19131 (and
19132 (get v 'custom-type) (get v 'standard-value)
19133 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19134 (push v list)))))
19135 (kill-buffer (get-buffer "*Warn about privacy*"))
19136 list))
19137 nil nil
19138 "Remember to cover the basics, that is, what you expected to happen and
19139 what in fact did happen. You don't know how to make a good report? See
19141 http://orgmode.org/manual/Feedback.html#Feedback
19143 Your bug report will be posted to the Org-mode mailing list.
19144 ------------------------------------------------------------------------")
19145 (save-excursion
19150 (defun org-install-agenda-files-menu ()
19151 (let ((bl (buffer-list)))
19152 (save-excursion
19153 (while bl
19154 (set-buffer (pop bl))
19155 (if (eq major-mode 'org-mode) (setq bl nil)))
19156 (when (eq major-mode 'org-mode)
19157 (easy-menu-change
19158 '("Org") "File List for Agenda"
19159 (append
19160 (list
19161 ["Edit File List" (org-edit-agenda-file-list) t]
19162 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19163 ["Remove Current File from List" org-remove-file t]
19164 ["Cycle through agenda files" org-cycle-agenda-files t]
19165 ["Occur in all agenda files" org-occur-in-agenda-files t]
19166 "--")
19167 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19169 ;;;; Documentation
19171 ;;;###autoload
19172 (defun org-require-autoloaded-modules ()
19173 (interactive)
19174 (mapc 'require
19175 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19176 org-docbook org-exp org-html org-icalendar
19177 org-id org-latex
19178 org-publish org-remember org-table
19179 org-timer org-xoxo)))
19181 ;;;###autoload
19182 (defun org-reload (&optional uncompiled)
19183 "Reload all org lisp files.
19184 With prefix arg UNCOMPILED, load the uncompiled versions."
19185 (interactive "P")
19186 (require 'find-func)
19188 (dir-org (file-name-directory (org-find-library-name "org")))
19189 (dir-org-contrib (ignore-errors
19190 (file-name-directory
19191 (org-find-library-name "org-contribdir"))))
19192 (babel-files
19193 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19194 (append (list nil "comint" "eval" "exp" "keys"
19195 "lob" "ref" "table" "tangle")
19196 (delq nil
19197 (mapcar
19198 (lambda (lang)
19199 (when (cdr lang) (symbol-name (car lang))))
19200 org-babel-load-languages)))))
19201 (files
19202 (append (directory-files dir-org t file-re)
19203 babel-files
19204 (and dir-org-contrib
19205 (directory-files dir-org-contrib t file-re))))
19206 (remove-re (concat (if (featurep 'xemacs)
19207 "org-colview" "org-colview-xemacs")
19209 (setq files (mapcar 'file-name-sans-extension files))
19210 (setq files (mapcar
19211 (lambda (x) (if (string-match remove-re x) nil x))
19212 files))
19213 (setq files (delq nil files))
19214 (mapc
19215 (lambda (f)
19216 (when (featurep (intern (file-name-nondirectory f)))
19217 (if (and (not uncompiled)
19218 (file-exists-p (concat f ".elc")))
19219 (load (concat f ".elc") nil nil t)
19220 (load (concat f ".el") nil nil t))))
19221 files))
19222 (org-version))
19224 ;;;###autoload
19225 (defun org-customize ()
19226 "Call the customize function with org as argument."
19227 (interactive)
19228 (org-load-modules-maybe)
19229 (org-require-autoloaded-modules)
19230 (customize-browse 'org))
19232 (defun org-create-customize-menu ()
19233 "Create a full customization menu for Org-mode, insert it into the menu."
19234 (interactive)
19235 (org-load-modules-maybe)
19236 (org-require-autoloaded-modules)
19237 (if (fboundp 'customize-menu-create)
19238 (progn
19239 (easy-menu-change
19240 '("Org") "Customize"
19241 `(["Browse Org group" org-customize t]
19242 "--"
19243 ,(customize-menu-create 'org)
19244 ["Set" Custom-set t]
19245 ["Save" Custom-save t]
19246 ["Reset to Current" Custom-reset-current t]
19247 ["Reset to Saved" Custom-reset-saved t]
19248 ["Reset to Standard Settings" Custom-reset-standard t]))
19250 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19252 ;;;; Miscellaneous stuff
19254 ;;; Generally useful functions
19256 (defun org-get-at-bol (property)
19257 "Get text property PROPERTY at beginning of line."
19258 (get-text-property (point-at-bol) property))
19260 (defun org-find-text-property-in-string (prop s)
19261 "Return the first non-nil value of property PROP in string S."
19262 (or (get-text-property 0 prop s)
19263 (get-text-property (or (next-single-property-change 0 prop s) 0)
19264 prop s)))
19266 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19267 "Display the given MESSAGE as a warning."
19268 (if (fboundp 'display-warning)
19269 (display-warning 'org message
19270 (if (featurep 'xemacs) 'warning :warning))
19271 (let ((buf (get-buffer-create "*Org warnings*")))
19272 (with-current-buffer buf
19273 (goto-char (point-max))
19274 (insert "Warning (Org): " message)
19275 (unless (bolp)
19276 (newline)))
19277 (display-buffer buf)
19278 (sit-for 0))))
19280 (defun org-eval (form)
19281 "Eval FORM and return result."
19282 (condition-case error
19283 (eval form)
19284 (error (format "%%![Error: %s]" error))))
19286 (defun org-in-commented-line ()
19287 "Is point in a line starting with `#'?"
19288 (equal (char-after (point-at-bol)) ?#))
19290 (defun org-in-indented-comment-line ()
19291 "Is point in a line starting with `#' after some white space?"
19292 (save-excursion
19293 (save-match-data
19294 (goto-char (point-at-bol))
19297 (defun org-in-verbatim-emphasis ()
19298 (save-match-data
19299 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19301 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19302 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19303 (if (and marker (marker-buffer marker)
19304 (buffer-live-p (marker-buffer marker)))
19305 (progn
19306 (org-pop-to-buffer-same-window (marker-buffer marker))
19307 (if (or (> marker (point-max)) (< marker (point-min)))
19308 (widen))
19309 (goto-char marker)
19310 (org-show-context 'org-goto))
19311 (if bookmark
19312 (bookmark-jump bookmark)
19313 (error "Cannot find location"))))
19315 (defun org-quote-csv-field (s)
19316 "Quote field for inclusion in CSV material."
19319 s))
19321 (defun org-force-self-insert (N)
19322 "Needed to enforce self-insert under remapping."
19323 (interactive "p")
19324 (self-insert-command N))
19326 (defun org-string-width (s)
19327 "Compute width of string, ignoring invisible characters.
19328 This ignores character with invisibility property `org-link', and also
19329 characters with property `org-cwidth', because these will become invisible
19330 upon the next fontification round."
19331 (let (b l)
19332 (when (or (eq t buffer-invisibility-spec)
19333 (assq 'org-link buffer-invisibility-spec))
19334 (while (setq b (text-property-any 0 (length s)
19335 'invisible 'org-link s))
19336 (setq s (concat (substring s 0 b)
19337 (substring s (or (next-single-property-change
19338 b 'invisible s) (length s)))))))
19339 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19340 (setq s (concat (substring s 0 b)
19341 (substring s (or (next-single-property-change
19342 b 'org-cwidth s) (length s))))))
19343 (setq l (string-width s) b -1)
19344 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19345 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19346 l))
19348 (defun org-shorten-string (s maxlength)
19349 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19350 If the string is shorter or has length MAXLENGTH, just return the
19351 original string. If it is longer, the functions finds a space in the
19352 string, breaks this string off at that locations and adds three dots
19353 as ellipsis. Including the ellipsis, the string will not be longer
19354 than MAXLENGTH. If finding a good breaking point in the string does
19355 not work, the string is just chopped off in the middle of a word
19356 if necessary."
19357 (if (<= (length s) maxlength)
19358 s
19359 (let* ((n (max (- maxlength 4) 1))
19361 (if (string-match re s)
19362 (concat (match-string 1 s) "...")
19363 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19365 (defun org-get-indentation (&optional line)
19366 "Get the indentation of the current line, interpreting tabs.
19367 When LINE is given, assume it represents a line and compute its indentation."
19368 (if line
19369 (if (string-match "^ *" (org-remove-tabs line))
19370 (match-end 0))
19371 (save-excursion
19372 (beginning-of-line 1)
19374 (current-column))))
19376 (defun org-get-string-indentation (s)
19377 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19378 (let ((n -1) (i 0) (w tab-width) c)
19379 (catch 'exit
19380 (while (< (setq n (1+ n)) (length s))
19381 (setq c (aref s n))
19382 (cond ((= c ?\ ) (setq i (1+ i)))
19384 (t (throw 'exit t)))))
19385 i))
19387 (defun org-remove-tabs (s &optional width)
19388 "Replace tabulators in S with spaces.
19389 Assumes that s is a single line, starting in column 0."
19390 (setq width (or width tab-width))
19392 (setq s (replace-match
19393 (make-string
19394 (- (* width (/ (+ (match-beginning 0) width) width))
19395 (match-beginning 0)) ?\ )
19396 t t s)))
19397 s)
19399 (defun org-fix-indentation (line ind)
19400 "Fix indentation in LINE.
19401 IND is a cons cell with target and minimum indentation.
19402 If the current indentation in LINE is smaller than the minimum,
19403 leave it alone. If it is larger than ind, set it to the target."
19404 (let* ((l (org-remove-tabs line))
19405 (i (org-get-indentation l))
19406 (i1 (car ind)) (i2 (cdr ind)))
19407 (if (>= i i2) (setq l (substring line i2)))
19408 (if (> i1 0)
19409 (concat (make-string i1 ?\ ) l)
19410 l)))
19412 (defun org-remove-indentation (code &optional n)
19413 "Remove the maximum common indentation from the lines in CODE.
19414 N may optionally be the number of spaces to remove."
19415 (with-temp-buffer
19416 (insert code)
19417 (org-do-remove-indentation n)
19418 (buffer-string)))
19420 (defun org-do-remove-indentation (&optional n)
19421 "Remove the maximum common indentation from the buffer."
19422 (untabify (point-min) (point-max))
19423 (let ((min 10000) re)
19424 (if n
19425 (setq min n)
19426 (goto-char (point-min))
19428 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19429 (unless (or (= min 0) (= min 10000))
19431 (goto-char (point-min))
19432 (while (re-search-forward re nil t)
19433 (replace-match "")
19434 (end-of-line 1))
19435 min)))
19437 (defun org-fill-template (template alist)
19438 "Find each %key of ALIST in TEMPLATE and replace it."
19439 (let ((case-fold-search nil)
19440 entry key value)
19441 (setq alist (sort (copy-sequence alist)
19442 (lambda (a b) (< (length (car a)) (length (car b))))))
19443 (while (setq entry (pop alist))
19444 (setq template
19445 (replace-regexp-in-string
19446 (concat "%" (regexp-quote (car entry)))
19447 (cdr entry) template t t)))
19448 template))
19450 (defun org-base-buffer (buffer)
19451 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19452 (if (not buffer)
19453 buffer
19454 (or (buffer-base-buffer buffer)
19455 buffer)))
19457 (defun org-trim (s)
19458 "Remove whitespace at beginning and end of string."
19461 s)
19463 (defun org-wrap (string &optional width lines)
19464 "Wrap string to either a number of lines, or a width in characters.
19465 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19466 that costs. If there is a word longer than WIDTH, the text is actually
19467 wrapped to the length of that word.
19468 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19469 many lines, whatever width that takes.
19470 The return value is a list of lines, without newlines at the end."
19472 (maxword (apply 'max (mapcar 'org-string-width words)))
19473 w ll)
19474 (cond (width
19475 (org-do-wrap words (max maxword width)))
19476 (lines
19477 (setq w maxword)
19478 (setq ll (org-do-wrap words maxword))
19479 (if (<= (length ll) lines)
19480 ll
19481 (setq ll words)
19482 (while (> (length ll) lines)
19483 (setq w (1+ w))
19484 (setq ll (org-do-wrap words w)))
19485 ll))
19486 (t (error "Cannot wrap this")))))
19488 (defun org-do-wrap (words width)
19489 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19490 (let (lines line)
19491 (while words
19492 (setq line (pop words))
19493 (while (and words (< (+ (length line) (length (car words))) width))
19494 (setq line (concat line " " (pop words))))
19495 (setq lines (push line lines)))
19496 (nreverse lines)))
19498 (defun org-split-string (string &optional separators)
19499 "Splits STRING into substrings at SEPARATORS.
19500 No empty strings are returned if there are matches at the beginning
19501 and end of string."
19503 (start 0)
19504 notfirst
19505 (list nil))
19506 (while (and (string-match rexp string
19507 (if (and notfirst
19508 (= start (match-beginning 0))
19509 (< start (length string)))
19510 (1+ start) start))
19511 (< (match-beginning 0) (length string)))
19512 (setq notfirst t)
19513 (or (eq (match-beginning 0) 0)
19514 (and (eq (match-beginning 0) (match-end 0))
19515 (eq (match-beginning 0) start))
19516 (setq list
19517 (cons (substring string start (match-beginning 0))
19518 list)))
19519 (setq start (match-end 0)))
19520 (or (eq start (length string))
19521 (setq list
19522 (cons (substring string start)
19523 list)))
19524 (nreverse list)))
19526 (defun org-quote-vert (s)
19528 (while (string-match "|" s)
19530 s)
19532 (defun org-uuidgen-p (s)
19533 "Is S an ID created by UUIDGEN?"
19534 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19536 (defun org-in-src-block-p nil
19537 "Whether point is in a code source block."
19538 (let (ov)
19539 (when (setq ov (overlays-at (point)))
19540 (memq 'org-block-background
19541 (overlay-properties
19542 (car ov))))))
19544 (defun org-context ()
19545 "Return a list of contexts of the current cursor position.
19546 If several contexts apply, all are returned.
19547 Each context entry is a list with a symbol naming the context, and
19548 two positions indicating start and end of the context. Possible
19549 contexts are:
19551 :headline anywhere in a headline
19552 :headline-stars on the leading stars in a headline
19553 :todo-keyword on a TODO keyword (including DONE) in a headline
19554 :tags on the TAGS in a headline
19555 :priority on the priority cookie in a headline
19556 :item on the first line of a plain list item
19557 :item-bullet on the bullet/number of a plain list item
19558 :checkbox on the checkbox in a plain list item
19559 :table in an org-mode table
19560 :table-special on a special filed in a table
19561 :table-table in a table.el table
19562 :clocktable in a clocktable
19563 :src-block in a source block
19564 :link on a hyperlink
19565 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19566 :target on a <<target>>
19567 :radio-target on a <<<radio-target>>>
19568 :latex-fragment on a LaTeX fragment
19569 :latex-preview on a LaTeX fragment with overlaid preview image
19571 This function expects the position to be visible because it uses font-lock
19572 faces as a help to recognize the following contexts: :table-special, :link,
19573 and :keyword."
19574 (let* ((f (get-text-property (point) 'face))
19575 (faces (if (listp f) f (list f)))
19576 (case-fold-search t)
19577 (p (point)) clist o)
19578 ;; First the large context
19579 (cond
19580 ((org-at-heading-p t)
19581 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19582 (when (progn
19583 (beginning-of-line 1)
19584 (looking-at org-todo-line-tags-regexp))
19585 (push (org-point-in-group p 1 :headline-stars) clist)
19586 (push (org-point-in-group p 2 :todo-keyword) clist)
19587 (push (org-point-in-group p 4 :tags) clist))
19588 (goto-char p)
19591 (push (org-point-in-group p 0 :priority) clist)))
19593 ((org-at-item-p)
19594 (push (org-point-in-group p 2 :item-bullet) clist)
19595 (push (list :item (point-at-bol)
19596 (save-excursion (org-end-of-item) (point)))
19597 clist)
19598 (and (org-at-item-checkbox-p)
19599 (push (org-point-in-group p 0 :checkbox) clist)))
19601 ((org-at-table-p)
19602 (push (list :table (org-table-begin) (org-table-end)) clist)
19603 (if (memq 'org-formula faces)
19604 (push (list :table-special
19605 (previous-single-property-change p 'face)
19606 (next-single-property-change p 'face)) clist)))
19607 ((org-at-table-p 'any)
19608 (push (list :table-table) clist)))
19609 (goto-char p)
19611 ;; New the "medium" contexts: clocktables, source blocks
19612 (cond ((org-in-clocktable-p)
19613 (push (list :clocktable
19615 (search-backward "#+BEGIN: clocktable" nil t))
19616 (match-beginning 0))
19618 (match-end 0))) clist))
19619 ((org-in-src-block-p)
19620 (push (list :src-block
19622 (search-backward "#+BEGIN_SRC" nil t))
19623 (match-beginning 0))
19624 (and (search-forward "#+END_SRC" nil t)
19625 (match-beginning 0))) clist)))
19626 (goto-char p)
19628 ;; Now the small context
19629 (cond
19630 ((org-at-timestamp-p)
19631 (push (org-point-in-group p 0 :timestamp) clist))
19632 ((memq 'org-link faces)
19633 (push (list :link
19634 (previous-single-property-change p 'face)
19635 (next-single-property-change p 'face)) clist))
19636 ((memq 'org-special-keyword faces)
19637 (push (list :keyword
19638 (previous-single-property-change p 'face)
19639 (next-single-property-change p 'face)) clist))
19640 ((org-at-target-p)
19641 (push (org-point-in-group p 0 :target) clist)
19642 (goto-char (1- (match-beginning 0)))
19643 (if (looking-at org-radio-target-regexp)
19644 (push (org-point-in-group p 0 :radio-target) clist))
19645 (goto-char p))
19646 ((setq o (car (delq nil
19647 (mapcar
19648 (lambda (x)
19649 (if (memq x org-latex-fragment-image-overlays) x))
19650 (overlays-at (point))))))
19651 (push (list :latex-fragment
19652 (overlay-start o) (overlay-end o)) clist)
19653 (push (list :latex-preview
19654 (overlay-start o) (overlay-end o)) clist))
19655 ((org-inside-LaTeX-fragment-p)
19656 ;; FIXME: positions wrong.
19657 (push (list :latex-fragment (point) (point)) clist)))
19659 (setq clist (nreverse (delq nil clist)))
19660 clist))
19662 ;; FIXME: Compare with at-regexp-p Do we need both?
19663 (defun org-in-regexp (re &optional nlines visually)
19664 "Check if point is inside a match of regexp.
19665 Normally only the current line is checked, but you can include NLINES extra
19666 lines both before and after point into the search.
19667 If VISUALLY is set, require that the cursor is not after the match but
19668 really on, so that the block visually is on the match."
19669 (catch 'exit
19670 (let ((pos (point))
19671 (eol (point-at-eol (+ 1 (or nlines 0))))
19672 (inc (if visually 1 0)))
19673 (save-excursion
19674 (beginning-of-line (- 1 (or nlines 0)))
19675 (while (re-search-forward re eol t)
19676 (if (and (<= (match-beginning 0) pos)
19677 (>= (+ inc (match-end 0)) pos))
19678 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19680 (defun org-at-regexp-p (regexp)
19681 "Is point inside a match of REGEXP in the current line?"
19682 (catch 'exit
19683 (save-excursion
19684 (let ((pos (point)) (end (point-at-eol)))
19685 (beginning-of-line 1)
19686 (while (re-search-forward regexp end t)
19687 (if (and (<= (match-beginning 0) pos)
19688 (>= (match-end 0) pos))
19689 (throw 'exit t)))
19690 nil))))
19692 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19693 "Non-nil when point is between matches of START-RE and END-RE.
19695 Also return a non-nil value when point is on one of the matches.
19697 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19698 buffer positions. Default values are the positions of headlines
19699 surrounding the point.
19701 The functions returns a cons cell whose car (resp. cdr) is the
19702 position before START-RE (resp. after END-RE)."
19703 (save-match-data
19704 (let ((pos (point))
19705 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19706 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19707 beg end)
19708 (save-excursion
19709 ;; Point is on a block when on START-RE or if START-RE can be
19710 ;; found before it...
19711 (and (or (org-at-regexp-p start-re)
19712 (re-search-backward start-re limit-up t))
19713 (setq beg (match-beginning 0))
19714 ;; ... and END-RE after it...
19715 (goto-char (match-end 0))
19716 (re-search-forward end-re limit-down t)
19717 (> (setq end (match-end 0)) pos)
19718 ;; ... without another START-RE in-between.
19719 (goto-char (match-beginning 0))
19720 (not (re-search-backward start-re (1+ beg) t))
19721 ;; Return value.
19722 (cons beg end))))))
19724 (defun org-in-block-p (names)
19725 "Non-nil when point belongs to a block whose name belongs to NAMES.
19727 NAMES is a list of strings containing names of blocks.
19729 Return first block name matched, or nil. Beware that in case of
19730 nested blocks, the returned name may not belong to the closest
19731 block from point."
19732 (save-match-data
19733 (catch 'exit
19734 (let ((case-fold-search t)
19735 (lim-up (save-excursion (outline-previous-heading)))
19736 (lim-down (save-excursion (outline-next-heading))))
19737 (mapc (lambda (name)
19738 (let ((n (regexp-quote name)))
19739 (when (org-between-regexps-p
19742 lim-up lim-down)
19743 (throw 'exit n))))
19744 names))
19745 nil)))
19747 (defun org-occur-in-agenda-files (regexp &optional nlines)
19748 "Call `multi-occur' with buffers for all agenda files."
19750 (let* ((files (org-agenda-files))
19751 (tnames (mapcar 'file-truename files))
19752 (extra org-agenda-text-search-extra-files)
19753 f)
19754 (when (eq (car extra) 'agenda-archives)
19755 (setq extra (cdr extra))
19756 (setq files (org-add-archive-files files)))
19757 (while (setq f (pop extra))
19758 (unless (member (file-truename f) tnames)
19759 (add-to-list 'files f 'append)
19760 (add-to-list 'tnames (file-truename f) 'append)))
19761 (multi-occur
19762 (mapcar (lambda (x)
19763 (with-current-buffer
19764 (or (get-file-buffer x) (find-file-noselect x))
19765 (widen)
19766 (current-buffer)))
19767 files)
19768 regexp)))
19770 (if (boundp 'occur-mode-find-occurrence-hook)
19771 ;; Emacs 23
19772 (add-hook 'occur-mode-find-occurrence-hook
19773 (lambda ()
19774 (when (eq major-mode 'org-mode)
19775 (org-reveal))))
19776 ;; Emacs 22
19777 (defadvice occur-mode-goto-occurrence
19778 (after org-occur-reveal activate)
19779 (and (eq major-mode 'org-mode) (org-reveal)))
19780 (defadvice occur-mode-goto-occurrence-other-window
19781 (after org-occur-reveal activate)
19782 (and (eq major-mode 'org-mode) (org-reveal)))
19783 (defadvice occur-mode-display-occurrence
19784 (after org-occur-reveal activate)
19785 (when (eq major-mode 'org-mode)
19786 (let ((pos (occur-mode-find-occurrence)))
19787 (with-current-buffer (marker-buffer pos)
19788 (save-excursion
19789 (goto-char pos)
19790 (org-reveal)))))))
19792 (defun org-occur-link-in-agenda-files ()
19793 "Create a link and search for it in the agendas.
19794 The link is not stored in `org-stored-links', it is just created
19795 for the search purpose."
19796 (interactive)
19797 (let ((link (condition-case nil
19798 (org-store-link nil)
19799 (error "Unable to create a link to here"))))
19800 (org-occur-in-agenda-files (regexp-quote link))))
19802 (defun org-uniquify (list)
19803 "Remove duplicate elements from LIST."
19804 (let (res)
19805 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19806 res))
19808 (defun org-delete-all (elts list)
19809 "Remove all elements in ELTS from LIST."
19810 (while elts
19811 (setq list (delete (pop elts) list)))
19812 list)
19814 (defun org-count (cl-item cl-seq)
19815 "Count the number of occurrences of ITEM in SEQ.
19816 Taken from `count' in cl-seq.el with all keyword arguments removed."
19817 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19818 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19819 (while (< cl-start cl-end)
19820 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19821 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19822 (setq cl-start (1+ cl-start)))
19823 cl-count))
19825 (defun org-remove-if (predicate seq)
19826 "Remove everything from SEQ that fulfills PREDICATE."
19827 (let (res e)
19828 (while seq
19829 (setq e (pop seq))
19830 (if (not (funcall predicate e)) (push e res)))
19831 (nreverse res)))
19833 (defun org-remove-if-not (predicate seq)
19834 "Remove everything from SEQ that does not fulfill PREDICATE."
19835 (let (res e)
19836 (while seq
19837 (setq e (pop seq))
19838 (if (funcall predicate e) (push e res)))
19839 (nreverse res)))
19841 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19842 "Reduce two-argument FUNCTION across SEQ.
19843 Taken from `reduce' in cl-seq.el with all keyword arguments but
19845 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19846 (cadr (memq :initial-value cl-keys)))
19847 (cl-seq (pop cl-seq))
19848 (t (funcall cl-func)))))
19849 (while cl-seq
19850 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19851 cl-accum))
19853 (defun org-back-over-empty-lines ()
19854 "Move backwards over whitespace, to the beginning of the first empty line.
19855 Returns the number of empty lines passed."
19856 (let ((pos (point)))
19857 (if (cdr (assoc 'heading org-blank-before-new-entry))
19859 (unless (eobp)
19860 (forward-line -1)))
19861 (beginning-of-line 2)
19862 (goto-char (min (point) pos))
19863 (count-lines (point) pos)))
19865 (defun org-skip-whitespace ()
19868 (defun org-point-in-group (point group &optional context)
19869 "Check if POINT is in match-group GROUP.
19870 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19871 match. If the match group does not exist or point is not inside it,
19872 return nil."
19873 (and (match-beginning group)
19874 (>= point (match-beginning group))
19875 (<= point (match-end group))
19876 (if context
19877 (list context (match-beginning group) (match-end group))
19878 t)))
19880 (defun org-switch-to-buffer-other-window (&rest args)
19881 "Switch to buffer in a second window on the current frame.
19882 In particular, do not allow pop-up frames.
19883 Returns the newly created buffer."
19884 (let (pop-up-frames special-display-buffer-names special-display-regexps
19885 special-display-function)
19886 (apply 'switch-to-buffer-other-window args)))
19888 (defun org-combine-plists (&rest plists)
19889 "Create a single property list from all plists in PLISTS.
19890 The process starts by copying the first list, and then setting properties
19891 from the other lists. Settings in the last list are the most significant
19892 ones and overrule settings in the other lists."
19893 (let ((rtn (copy-sequence (pop plists)))
19894 p v ls)
19895 (while plists
19896 (setq ls (pop plists))
19897 (while ls
19898 (setq p (pop ls) v (pop ls))
19899 (setq rtn (plist-put rtn p v))))
19900 rtn))
19902 (defun org-move-line-down (arg)
19903 "Move the current line down. With prefix argument, move it past ARG lines."
19904 (interactive "p")
19905 (let ((col (current-column))
19906 beg end pos)
19907 (beginning-of-line 1) (setq beg (point))
19908 (beginning-of-line 2) (setq end (point))
19909 (beginning-of-line (+ 1 arg))
19910 (setq pos (move-marker (make-marker) (point)))
19911 (insert (delete-and-extract-region beg end))
19912 (goto-char pos)
19913 (org-move-to-column col)))
19915 (defun org-move-line-up (arg)
19916 "Move the current line up. With prefix argument, move it past ARG lines."
19917 (interactive "p")
19918 (let ((col (current-column))
19919 beg end pos)
19920 (beginning-of-line 1) (setq beg (point))
19921 (beginning-of-line 2) (setq end (point))
19922 (beginning-of-line (- arg))
19923 (setq pos (move-marker (make-marker) (point)))
19924 (insert (delete-and-extract-region beg end))
19925 (goto-char pos)
19926 (org-move-to-column col)))
19928 (defun org-replace-escapes (string table)
19929 "Replace %-escapes in STRING with values in TABLE.
19931 The sequences in STRING may contain normal field width and padding information,
19933 so values can contain further %-escapes if they are define later in TABLE."
19934 (let ((tbl (copy-alist table))
19935 (case-fold-search nil)
19936 (pchg 0)
19937 e re rpl)
19938 (while (setq e (pop tbl))
19939 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19940 (when (and (cdr e) (string-match re (cdr e)))
19941 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19942 (safe "SREF"))
19943 (add-text-properties 0 3 (list 'sref sref) safe)
19944 (setcdr e (replace-match safe t t (cdr e)))))
19945 (while (string-match re string)
19946 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19947 (cdr e)))
19948 (setq string (replace-match rpl t t string))))
19949 (while (setq pchg (next-property-change pchg string))
19950 (let ((sref (get-text-property pchg 'sref string)))
19951 (when (and sref (string-match "SREF" string pchg))
19952 (setq string (replace-match sref t t string)))))
19953 string))
19955 (defun org-sublist (list start end)
19956 "Return a section of LIST, from START to END.
19957 Counting starts at 1."
19958 (let (rtn (c start))
19959 (setq list (nthcdr (1- start) list))
19960 (while (and list (<= c end))
19961 (push (pop list) rtn)
19962 (setq c (1+ c)))
19963 (nreverse rtn)))
19965 (defun org-find-base-buffer-visiting (file)
19966 "Like `find-buffer-visiting' but always return the base buffer and
19967 not an indirect buffer."
19968 (let ((buf (or (get-file-buffer file)
19969 (find-buffer-visiting file))))
19970 (if buf
19971 (or (buffer-base-buffer buf) buf)
19972 nil)))
19974 (defun org-image-file-name-regexp (&optional extensions)
19975 "Return regexp matching the file names of images.
19976 If EXTENSIONS is given, only match these."
19977 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19978 (image-file-name-regexp)
19979 (let ((image-file-name-extensions
19980 (or extensions
19981 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19982 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19984 (regexp-opt (nconc (mapcar 'upcase
19985 image-file-name-extensions)
19986 image-file-name-extensions)
19987 t)
19990 (defun org-file-image-p (file &optional extensions)
19991 "Return non-nil if FILE is an image."
19992 (save-match-data
19993 (string-match (org-image-file-name-regexp extensions) file)))
19995 (defun org-get-cursor-date ()
19996 "Return the date at cursor in as a time.
19997 This works in the calendar and in the agenda, anywhere else it just
19998 returns the current time."
19999 (let (date day defd)
20000 (cond
20001 ((eq major-mode 'calendar-mode)
20002 (setq date (calendar-cursor-to-date)
20003 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20004 ((eq major-mode 'org-agenda-mode)
20005 (setq day (get-text-property (point) 'day))
20006 (if day
20007 (setq date (calendar-gregorian-from-absolute day)
20008 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20009 (nth 2 date))))))
20010 (or defd (current-time))))
20012 (defvar org-agenda-action-marker (make-marker)
20013 "Marker pointing to the entry for the next agenda action.")
20015 (defun org-mark-entry-for-agenda-action ()
20016 "Mark the current entry as target of an agenda action.
20017 Agenda actions are actions executed from the agenda with the key `k',
20018 which make use of the date at the cursor."
20019 (interactive)
20020 (move-marker org-agenda-action-marker
20021 (save-excursion (org-back-to-heading t) (point))
20022 (current-buffer))
20023 (message
20024 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20026 (defun org-mark-subtree ()
20027 "Mark the current subtree.
20028 This puts point at the start of the current subtree, and mark at the end.
20030 If point is in an inline task, mark that task instead."
20031 (interactive)
20032 (let ((inline-task-p
20033 (and (featurep 'org-inlinetask)
20034 (org-inlinetask-in-task-p)))
20035 (beg))
20036 ;; Get beginning of subtree
20037 (cond
20038 (inline-task-p (org-inlinetask-goto-beginning))
20039 ((org-at-heading-p) (beginning-of-line))
20040 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20041 (setq beg (point))
20042 ;; Get end of it
20043 (if inline-task-p
20044 (org-inlinetask-goto-end)
20045 (org-end-of-subtree))
20046 ;; Mark zone
20047 (push-mark (point) nil t)
20048 (goto-char beg)))
20050 ;;; Paragraph filling stuff.
20051 ;; We want this to be just right, so use the full arsenal.
20053 (defun org-indent-line-function ()
20054 "Indent line depending on context."
20055 (interactive)
20056 (let* ((pos (point))
20057 (itemp (org-at-item-p))
20058 (case-fold-search t)
20060 (inline-task-p (and (featurep 'org-inlinetask)
20061 (org-inlinetask-in-task-p)))
20062 (inline-re (and inline-task-p
20063 (org-inlinetask-outline-regexp)))
20064 column)
20065 (beginning-of-line 1)
20066 (cond
20067 ;; Comments
20068 ((looking-at "# ") (setq column 0))
20069 ;; Headings
20070 ((looking-at org-outline-regexp) (setq column 0))
20071 ;; Included files
20073 ;; Footnote definition
20074 ((looking-at org-footnote-definition-re) (setq column 0))
20075 ;; Literal examples
20077 (setq column (org-get-indentation))) ; do nothing
20078 ;; Lists
20079 ((ignore-errors (goto-char (org-in-item-p)))
20080 (setq column (if itemp
20081 (org-get-indentation)
20082 (org-list-item-body-column (point))))
20083 (goto-char pos))
20084 ;; Drawers
20086 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20087 (save-excursion
20088 (goto-char (1- (match-beginning 1)))
20089 (setq column (current-column))))
20090 ;; Special blocks
20092 (save-excursion
20093 (re-search-backward
20095 (setq column (org-get-indentation (match-string 0))))
20098 (save-excursion
20100 (setq column
20101 (cond ((equal (downcase (match-string 1)) "src")
20102 ;; src blocks: let `org-edit-src-exit' handle them
20103 (org-get-indentation))
20104 ((equal (downcase (match-string 1)) "example")
20105 (max (org-get-indentation)
20106 (org-get-indentation (match-string 0))))
20107 (t
20108 (org-get-indentation (match-string 0))))))
20109 ;; This line has nothing special, look at the previous relevant
20110 ;; line to compute indentation
20111 (t
20112 (beginning-of-line 0)
20113 (while (and (not (bobp))
20114 (not (looking-at org-drawer-regexp))
20115 ;; When point started in an inline task, do not move
20116 ;; above task starting line.
20117 (not (and inline-task-p (looking-at inline-re)))
20118 ;; Skip drawers, blocks, empty lines, verbatim,
20119 ;; comments, tables, footnotes definitions, lists,
20120 ;; inline tasks.
20122 (re-search-backward org-drawer-regexp nil t))
20126 (looking-at org-footnote-definition-re)
20127 (and (ignore-errors (goto-char (org-in-item-p)))
20128 (goto-char
20129 (org-list-get-top-point (org-list-struct))))
20130 (and (not inline-task-p)
20131 (featurep 'org-inlinetask)
20132 (org-inlinetask-in-task-p)
20133 (or (org-inlinetask-goto-beginning) t))))
20134 (beginning-of-line 0))
20135 (cond
20136 ;; There was an heading above.
20138 (if (not org-adapt-indentation)
20139 (setq column 0)
20140 (goto-char (match-end 0))
20141 (setq column (current-column))))
20142 ;; A drawer had started and is unfinished
20143 ((looking-at org-drawer-regexp)
20144 (goto-char (1- (match-beginning 1)))
20145 (setq column (current-column)))
20146 ;; Else, nothing noticeable found: get indentation and go on.
20147 (t (setq column (org-get-indentation))))))
20148 ;; Now apply indentation and move cursor accordingly
20149 (goto-char pos)
20150 (if (<= (current-column) (current-indentation))
20151 (org-indent-line-to column)
20152 (save-excursion (org-indent-line-to column)))
20153 ;; Special polishing for properties, see `org-property-format'
20154 (setq column (current-column))
20155 (beginning-of-line 1)
20156 (if (looking-at
20158 (replace-match (concat (match-string 1)
20159 (format org-property-format
20160 (match-string 2) (match-string 3)))
20161 t t))
20162 (org-move-to-column column)))
20164 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20165 "Variable to store copy of `adaptive-fill-regexp'.
20166 Since `adaptive-fill-regexp' is set to never match, we need to
20167 store a backup of its value before entering `org-mode' so that
20168 the functionality can be provided as a fall-back.")
20170 (defun org-set-autofill-regexps ()
20171 (interactive)
20172 ;; In the paragraph separator we include headlines, because filling
20173 ;; text in a line directly attached to a headline would otherwise
20174 ;; fill the headline as well.
20177 ;; The paragraph starter includes hand-formatted lists.
20178 (org-set-local
20179 'paragraph-start
20180 (concat
20189 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20190 ;; But only if the user has not turned off tables or fixed-width regions
20191 (org-set-local
20192 'auto-fill-inhibit-regexp
20193 (concat org-outline-regexp
20196 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20197 (concat
20199 (if org-enable-table-editor "|" "")
20200 (if org-enable-fixed-width-editor ":" "")
20201 "]"))))
20202 ;; We use our own fill-paragraph function, to make sure that tables
20203 ;; and fixed-width regions are not wrapped. That function will pass
20204 ;; through to `fill-paragraph' when appropriate.
20205 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20206 ;; Prevent auto-fill from inserting unwanted new items.
20207 (if (boundp 'fill-nobreak-predicate)
20208 (org-set-local 'fill-nobreak-predicate
20209 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20210 fill-nobreak-predicate
20211 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20212 ;; Adaptive filling: To get full control, first make sure that
20213 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20214 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20215 (org-set-local 'org-adaptive-fill-regexp-backup
20216 adaptive-fill-regexp))
20218 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20219 (org-set-local 'adaptive-fill-function
20220 'org-adaptive-fill-function)
20221 (org-set-local
20222 'align-mode-rules-list
20223 '((org-in-buffer-settings
20225 (modes . '(org-mode))))))
20227 (defun org-fill-item-nobreak-p ()
20228 "Non-nil when a line break at point would insert a new item."
20229 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20231 (defun org-fill-paragraph (&optional justify)
20232 "Re-align a table, pass through to fill-paragraph if no table."
20233 (let ((table-p (org-at-table-p))
20234 (table.el-p (org-at-table.el-p))
20235 (itemp (org-in-item-p)))
20236 (cond ((and (equal (char-after (point-at-bol)) ?*)
20237 (save-excursion (goto-char (point-at-bol))
20238 (looking-at org-outline-regexp)))
20239 t) ; skip headlines
20240 (table.el-p t) ; skip table.el tables
20241 (table-p (org-table-align) t) ; align Org tables
20242 (itemp ; align text in items
20243 (let* ((struct (save-excursion (goto-char itemp)
20244 (org-list-struct)))
20245 (parents (org-list-parents-alist struct))
20246 (children (org-list-get-children itemp struct parents))
20247 beg end prev next prefix)
20248 ;; Determine in which part of item point is: before
20249 ;; first child, after last child, between two
20250 ;; sub-lists, or simply in item if there's no child.
20251 (cond
20252 ((not children)
20253 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20254 beg itemp
20255 end (org-list-get-item-end itemp struct)))
20256 ((< (point) (setq next (car children)))
20257 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20258 beg itemp
20259 end next))
20260 ((> (point) (setq prev (car (last children))))
20261 (setq beg (org-list-get-item-end prev struct)
20262 end (org-list-get-item-end itemp struct)
20263 prefix (save-excursion
20264 (goto-char beg)
20266 (make-string (current-column) ?\ ))))
20267 (t (catch 'exit
20268 (while (setq next (pop children))
20269 (if (> (point) next)
20270 (setq prev next)
20271 (setq beg (org-list-get-item-end prev struct)
20272 end next
20273 prefix (save-excursion
20274 (goto-char beg)
20276 (make-string (current-column) ?\ )))
20277 (throw 'exit nil))))))
20278 ;; Use `fill-paragraph' with buffer narrowed to item
20279 ;; without any child, and with our computed PREFIX.
20280 (flet ((fill-context-prefix (from to &optional flr) prefix))
20281 (save-restriction
20282 (narrow-to-region beg end)
20283 (save-excursion (fill-paragraph justify)))) t))
20284 ;; Special case where point is not in a list but is on
20285 ;; a paragraph adjacent to a list: make sure this paragraph
20286 ;; doesn't get merged with the end of the list by narrowing
20287 ;; buffer first.
20288 ((save-excursion (forward-paragraph -1)
20289 (setq itemp (org-in-item-p)))
20290 (let ((struct (save-excursion (goto-char itemp)
20291 (org-list-struct))))
20292 (save-restriction
20293 (narrow-to-region (org-list-get-bottom-point struct)
20294 (save-excursion (forward-paragraph 1)
20295 (point)))
20296 (fill-paragraph justify) t)))
20297 ;; Else simply call `fill-paragraph'.
20298 (t nil))))
20300 ;; For reference, this is the default value of adaptive-fill-regexp
20303 (defun org-adaptive-fill-function ()
20304 "Return a fill prefix for org-mode files."
20305 (let (itemp)
20306 (save-excursion
20307 (cond
20308 ;; Comment line
20310 (match-string-no-properties 0))
20311 ;; Plain list item
20312 ((org-at-item-p)
20313 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20314 ;; Point is in a list after `backward-paragraph': original
20315 ;; point wasn't in the list, or filling would have been taken
20316 ;; care of by `org-auto-fill-function', but the list and the
20317 ;; real paragraph are not separated by a blank line. Thus, move
20318 ;; point after the list to go back to real paragraph and
20319 ;; determine fill-prefix.
20320 ((setq itemp (org-in-item-p))
20321 (goto-char itemp)
20322 (let* ((struct (org-list-struct))
20323 (bottom (org-list-get-bottom-point struct)))
20324 (goto-char bottom)
20325 (make-string (org-get-indentation) ?\ )))
20326 ;; Other text
20327 ((looking-at org-adaptive-fill-regexp-backup)
20328 (match-string-no-properties 0))))))
20330 (defun org-auto-fill-function ()
20331 "Auto-fill function."
20332 (let (itemp prefix)
20333 ;; When in a list, compute an appropriate fill-prefix and make
20334 ;; sure it will be used by `do-auto-fill'.
20335 (if (setq itemp (org-in-item-p))
20336 (progn
20337 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20338 (flet ((fill-context-prefix (from to &optional flr) prefix))
20339 (do-auto-fill)))
20340 ;; Else just use `do-auto-fill'.
20341 (do-auto-fill))))
20343 ;;; Other stuff.
20345 (defun org-toggle-fixed-width-section (arg)
20346 "Toggle the fixed-width export.
20347 If there is no active region, the QUOTE keyword at the current headline is
20348 inserted or removed. When present, it causes the text between this headline
20349 and the next to be exported as fixed-width text, and unmodified.
20350 If there is an active region, this command adds or removes a colon as the
20351 first character of this line. If the first character of a line is a colon,
20352 this line is also exported in fixed-width font."
20353 (interactive "P")
20354 (let* ((cc 0)
20355 (regionp (org-region-active-p))
20356 (beg (if regionp (region-beginning) (point)))
20357 (end (if regionp (region-end)))
20358 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20359 (case-fold-search nil)
20361 off)
20362 (if regionp
20363 (save-excursion
20364 (goto-char beg)
20365 (setq cc (current-column))
20366 (beginning-of-line 1)
20367 (setq off (looking-at re))
20368 (while (> nlines 0)
20369 (setq nlines (1- nlines))
20370 (beginning-of-line 1)
20371 (cond
20372 (arg
20373 (org-move-to-column cc t)
20375 (forward-line -1))
20376 ((and off (looking-at re))
20377 (replace-match "" t t nil 1))
20378 ((not off) (org-move-to-column cc t) (insert ": ")))
20379 (forward-line 1)))
20380 (save-excursion
20381 (org-back-to-heading)
20382 (cond
20383 ((looking-at (format org-heading-keyword-regexp-format
20384 org-quote-string))
20385 (goto-char (match-end 1))
20386 (looking-at (concat " +" org-quote-string))
20387 (replace-match "" t t)
20388 (when (eolp) (insert " ")))
20389 ((looking-at org-outline-regexp)
20390 (goto-char (match-end 0))
20391 (insert org-quote-string " ")))))))
20393 (defun org-reftex-citation ()
20394 "Use reftex-citation to insert a citation into the buffer.
20395 This looks for a line like
20397 #+BIBLIOGRAPHY: foo plain option:-d
20399 and derives from it that foo.bib is the bibliography file relevant
20400 for this document. It then installs the necessary environment for RefTeX
20401 to work in this buffer and calls `reftex-citation' to insert a citation
20402 into the buffer.
20404 Export of such citations to both LaTeX and HTML is handled by the contributed
20405 package org-exp-bibtex by Taru Karttunen."
20406 (interactive)
20407 (let ((reftex-docstruct-symbol 'rds)
20409 rds bib)
20410 (save-excursion
20411 (save-restriction
20412 (widen)
20413 (let ((case-fold-search t)
20415 (if (not (save-excursion
20416 (or (re-search-forward re nil t)
20417 (re-search-backward re nil t))))
20418 (error "No bibliography defined in file")
20419 (setq bib (concat (match-string 1) ".bib")
20420 rds (list (list 'bib bib)))))))
20421 (call-interactively 'reftex-citation)))
20423 ;;;; Functions extending outline functionality
20425 (defun org-beginning-of-line (&optional arg)
20426 "Go to the beginning of the current line. If that is invisible, continue
20427 to a visible line beginning. This makes the function of C-a more intuitive.
20428 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20429 first attempt, and only move to after the tags when the cursor is already
20430 beyond the end of the headline."
20431 (interactive "P")
20432 (let ((pos (point))
20433 (special (if (consp org-special-ctrl-a/e)
20434 (car org-special-ctrl-a/e)
20435 org-special-ctrl-a/e))
20436 refpos)
20437 (if (org-bound-and-true-p line-move-visual)
20438 (beginning-of-visual-line 1)
20439 (beginning-of-line 1))
20440 (if (and arg (fboundp 'move-beginning-of-line))
20441 (call-interactively 'move-beginning-of-line)
20442 (if (bobp)
20443 nil
20444 (backward-char 1)
20445 (if (org-truely-invisible-p)
20446 (while (and (not (bobp)) (org-truely-invisible-p))
20447 (backward-char 1)
20448 (beginning-of-line 1))
20449 (forward-char 1))))
20450 (when special
20451 (cond
20452 ((and (looking-at org-complex-heading-regexp)
20453 (= (char-after (match-end 1)) ?\ ))
20454 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20455 (point-at-eol)))
20456 (goto-char
20457 (if (eq special t)
20458 (cond ((> pos refpos) refpos)
20459 ((= pos (point)) refpos)
20460 (t (point)))
20461 (cond ((> pos (point)) (point))
20462 ((not (eq last-command this-command)) (point))
20463 (t refpos)))))
20464 ((org-at-item-p)
20465 ;; Set special position at first white space character after
20466 ;; bullet, and check-box, if any.
20467 (let ((after-bullet
20468 (progn (looking-at org-list-full-item-re)
20469 (let ((bul (or (match-end 3) (match-end 1))))
20470 (if (= (char-after bul) ? ) (1+ bul) bul)))))
20471 ;; Special case: Move point to special position when
20472 ;; currently after it or at beginning of line.
20473 (if (eq special t)
20474 (when (or (> pos after-bullet) (= (point) pos))
20475 (goto-char after-bullet))
20476 ;; Reversed case: Move point to special position when
20477 ;; point was already at beginning of line and command is
20478 ;; repeated.
20479 (when (and (= (point) pos) (eq last-command this-command))
20480 (goto-char after-bullet)))))))
20481 (org-no-warnings
20482 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20484 (defun org-end-of-line (&optional arg)
20485 "Go to the end of the line.
20486 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20487 first attempt, and only move to after the tags when the cursor is already
20488 beyond the end of the headline."
20489 (interactive "P")
20490 (let ((special (if (consp org-special-ctrl-a/e)
20491 (cdr org-special-ctrl-a/e)
20492 org-special-ctrl-a/e)))
20493 (cond
20494 ((or (not special) arg
20495 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20496 (call-interactively
20497 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20498 ((fboundp 'move-end-of-line) 'move-end-of-line)
20499 (t 'end-of-line))))
20500 ((org-at-heading-p)
20501 (let ((pos (point)))
20502 (beginning-of-line 1)
20504 (if (eq special t)
20505 (if (or (< pos (match-beginning 1))
20506 (= pos (match-end 0)))
20507 (goto-char (match-beginning 1))
20508 (goto-char (match-end 0)))
20509 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20510 (goto-char (match-end 0))
20511 (goto-char (match-beginning 1))))
20512 (call-interactively (if (fboundp 'move-end-of-line)
20513 'move-end-of-line
20514 'end-of-line)))))
20515 ((org-at-drawer-p)
20516 (move-end-of-line 1)
20517 (when (overlays-at (1- (point))) (backward-char 1)))
20518 ;; At an item: Move before any hidden text.
20519 (t (call-interactively 'end-of-line)))
20520 (org-no-warnings
20521 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20523 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20524 (define-key org-mode-map "\C-e" 'org-end-of-line)
20526 (defun org-backward-sentence (&optional arg)
20527 "Go to beginning of sentence, or beginning of table field.
20528 This will call `backward-sentence' or `org-table-beginning-of-field',
20529 depending on context."
20530 (interactive "P")
20531 (cond
20532 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20533 (t (call-interactively 'backward-sentence))))
20535 (defun org-forward-sentence (&optional arg)
20536 "Go to end of sentence, or end of table field.
20537 This will call `forward-sentence' or `org-table-end-of-field',
20538 depending on context."
20539 (interactive "P")
20540 (cond
20541 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20542 (t (call-interactively 'forward-sentence))))
20544 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20545 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20547 (defun org-kill-line (&optional arg)
20548 "Kill line, to tags or end of line."
20549 (interactive "P")
20550 (cond
20551 ((or (not org-special-ctrl-k)
20552 (bolp)
20553 (not (org-at-heading-p)))
20554 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20555 org-ctrl-k-protect-subtree)
20556 (if (or (eq org-ctrl-k-protect-subtree 'error)
20557 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20558 (error "C-k aborted - would kill hidden subtree")))
20559 (call-interactively
20560 (if visual-line-mode 'kill-visual-line 'kill-line)))
20562 (kill-region (point) (match-beginning 1))
20563 (org-set-tags nil t))
20564 (t (kill-region (point) (point-at-eol)))))
20566 (define-key org-mode-map "\C-k" 'org-kill-line)
20568 (defun org-yank (&optional arg)
20569 "Yank. If the kill is a subtree, treat it specially.
20570 This command will look at the current kill and check if is a single
20571 subtree, or a series of subtrees[1]. If it passes the test, and if the
20572 cursor is at the beginning of a line or after the stars of a currently
20573 empty headline, then the yank is handled specially. How exactly depends
20574 on the value of the following variables, both set by default.
20576 org-yank-folded-subtrees
20577 When set, the subtree(s) will be folded after insertion, but only
20578 if doing so would now swallow text after the yanked text.
20580 org-yank-adjusted-subtrees
20581 When set, the subtree will be promoted or demoted in order to
20582 fit into the local outline tree structure, which means that the level
20583 will be adjusted so that it becomes the smaller one of the two
20584 *visible* surrounding headings.
20586 Any prefix to this command will cause `yank' to be called directly with
20588 will just
20589 plainly yank the text as it is.
20591 \[1] The test checks if the first non-white line is a heading
20592 and if there are no other headings with fewer stars."
20593 (interactive "P")
20594 (org-yank-generic 'yank arg))
20596 (defun org-yank-generic (command arg)
20597 "Perform some yank-like command.
20599 This function implements the behavior described in the `org-yank'
20600 documentation. However, it has been generalized to work for any
20601 interactive command with similar behavior."
20603 ;; pretend to be command COMMAND
20604 (setq this-command command)
20606 (if arg
20607 (call-interactively command)
20609 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20610 (and (org-kill-is-subtree-p)
20611 (or (bolp)
20613 (string-match
20615 (buffer-substring (point-at-bol) (point)))))))
20616 swallowp)
20617 (cond
20618 ((and subtreep org-yank-folded-subtrees)
20619 (let ((beg (point))
20620 end)
20621 (if (and subtreep org-yank-adjusted-subtrees)
20622 (org-paste-subtree nil nil 'for-yank)
20623 (call-interactively command))
20625 (setq end (point))
20626 (goto-char beg)
20627 (when (and (bolp) subtreep
20628 (not (setq swallowp
20629 (org-yank-folding-would-swallow-text beg end))))
20630 (org-with-limited-levels
20631 (or (looking-at org-outline-regexp)
20632 (re-search-forward org-outline-regexp-bol end t))
20633 (while (and (< (point) end) (looking-at org-outline-regexp))
20634 (hide-subtree)
20635 (org-cycle-show-empty-lines 'folded)
20636 (condition-case nil
20637 (outline-forward-same-level 1)
20638 (error (goto-char end))))))
20639 (when swallowp
20640 (message
20641 "Inserted text not folded because that would swallow text"))
20643 (goto-char end)
20645 (beginning-of-line 1)
20646 (push-mark beg 'nomsg)))
20647 ((and subtreep org-yank-adjusted-subtrees)
20648 (let ((beg (point-at-bol)))
20649 (org-paste-subtree nil nil 'for-yank)
20650 (push-mark beg 'nomsg)))
20651 (t
20652 (call-interactively command))))))
20654 (defun org-yank-folding-would-swallow-text (beg end)
20655 "Would hide-subtree at BEG swallow any text after END?"
20656 (let (level)
20657 (org-with-limited-levels
20658 (save-excursion
20659 (goto-char beg)
20660 (when (or (looking-at org-outline-regexp)
20661 (re-search-forward org-outline-regexp-bol end t))
20662 (setq level (org-outline-level)))
20663 (goto-char end)
20665 (if (or (eobp)
20666 (and (bolp) (looking-at org-outline-regexp)
20667 (<= (org-outline-level) level)))
20668 nil ; Nothing would be swallowed
20669 t))))) ; something would swallow
20671 (define-key org-mode-map "\C-y" 'org-yank)
20673 (defun org-truely-invisible-p ()
20674 "Check if point is at a character currently not visible.
20675 This version does not only check the character property, but also
20676 `visible-mode'."
20677 ;; Early versions of noutline don't have `outline-invisible-p'.
20678 (if (org-bound-and-true-p visible-mode)
20679 nil
20680 (outline-invisible-p)))
20682 (defun org-invisible-p2 ()
20683 "Check if point is at a character currently not visible."
20684 (save-excursion
20685 (if (and (eolp) (not (bobp))) (backward-char 1))
20686 ;; Early versions of noutline don't have `outline-invisible-p'.
20687 (outline-invisible-p)))
20689 (defun org-back-to-heading (&optional invisible-ok)
20690 "Call `outline-back-to-heading', but provide a better error message."
20691 (condition-case nil
20692 (outline-back-to-heading invisible-ok)
20693 (error (error "Before first headline at position %d in buffer %s"
20694 (point) (current-buffer)))))
20696 (defun org-beginning-of-defun ()
20697 "Go to the beginning of the subtree, i.e. back to the heading."
20698 (org-back-to-heading))
20699 (defun org-end-of-defun ()
20700 "Go to the end of the subtree."
20701 (org-end-of-subtree nil t))
20703 (defun org-before-first-heading-p ()
20704 "Before first heading?"
20705 (save-excursion
20706 (end-of-line)
20707 (null (re-search-backward org-outline-regexp-bol nil t))))
20709 (defun org-at-heading-p (&optional ignored)
20710 (outline-on-heading-p t))
20711 ;; Compatibility alias with Org versions < 7.8.03
20712 (defalias 'org-on-heading-p 'org-at-heading-p)
20714 (defun org-at-drawer-p nil
20715 "Whether point is at a drawer."
20716 (save-excursion
20717 (move-beginning-of-line 1)
20718 (looking-at org-drawer-regexp)))
20720 (defun org-point-at-end-of-empty-headline ()
20721 "If point is at the end of an empty headline, return t, else nil.
20722 If the heading only contains a TODO keyword, it is still still considered
20723 empty."
20725 (save-excursion
20726 (beginning-of-line 1)
20727 (let ((case-fold-search nil))
20728 (looking-at org-todo-line-regexp)))
20729 (string= (match-string 3) "")))
20731 (defun org-at-heading-or-item-p ()
20732 (or (org-at-heading-p) (org-at-item-p)))
20734 (defun org-at-target-p ()
20735 (or (org-in-regexp org-radio-target-regexp)
20736 (org-in-regexp org-target-regexp)))
20737 ;; Compatibility alias with Org versions < 7.8.03
20738 (defalias 'org-on-target-p 'org-at-target-p)
20740 (defun org-up-heading-all (arg)
20741 "Move to the heading line of which the present line is a subheading.
20742 This function considers both visible and invisible heading lines.
20743 With argument, move up ARG levels."
20744 (if (fboundp 'outline-up-heading-all)
20745 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20746 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20748 (defun org-up-heading-safe ()
20749 "Move to the heading line of which the present line is a subheading.
20750 This version will not throw an error. It will return the level of the
20751 headline found, or nil if no higher level is found.
20753 Also, this function will be a lot faster than `outline-up-heading',
20754 because it relies on stars being the outline starters. This can really
20755 make a significant difference in outlines with very many siblings."
20756 (let (start-level re)
20757 (org-back-to-heading t)
20758 (setq start-level (funcall outline-level))
20759 (if (equal start-level 1)
20760 nil
20762 (if (re-search-backward re nil t)
20763 (funcall outline-level)))))
20765 (defun org-first-sibling-p ()
20766 "Is this heading the first child of its parents?"
20767 (interactive)
20768 (let ((re org-outline-regexp-bol)
20769 level l)
20770 (unless (org-at-heading-p t)
20771 (error "Not at a heading"))
20772 (setq level (funcall outline-level))
20773 (save-excursion
20774 (if (not (re-search-backward re nil t))
20775 t
20776 (setq l (funcall outline-level))
20777 (< l level)))))
20779 (defun org-goto-sibling (&optional previous)
20780 "Goto the next sibling, even if it is invisible.
20781 When PREVIOUS is set, go to the previous sibling instead. Returns t
20782 when a sibling was found. When none is found, return nil and don't
20783 move point."
20784 (let ((fun (if previous 're-search-backward 're-search-forward))
20785 (pos (point))
20786 (re org-outline-regexp-bol)
20787 level l)
20788 (when (condition-case nil (org-back-to-heading t) (error nil))
20789 (setq level (funcall outline-level))
20790 (catch 'exit
20791 (or previous (forward-char 1))
20792 (while (funcall fun re nil t)
20793 (setq l (funcall outline-level))
20794 (when (< l level) (goto-char pos) (throw 'exit nil))
20795 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20796 (goto-char pos)
20797 nil))))
20799 (defun org-show-siblings ()
20800 "Show all siblings of the current headline."
20801 (save-excursion
20802 (while (org-goto-sibling) (org-flag-heading nil)))
20803 (save-excursion
20804 (while (org-goto-sibling 'previous)
20805 (org-flag-heading nil))))
20807 (defun org-goto-first-child ()
20808 "Goto the first child, even if it is invisible.
20809 Return t when a child was found. Otherwise don't move point and
20810 return nil."
20811 (let (level (pos (point)) (re org-outline-regexp-bol))
20812 (when (condition-case nil (org-back-to-heading t) (error nil))
20813 (setq level (outline-level))
20814 (forward-char 1)
20815 (if (and (re-search-forward re nil t) (> (outline-level) level))
20816 (progn (goto-char (match-beginning 0)) t)
20817 (goto-char pos) nil))))
20819 (defun org-show-hidden-entry ()
20820 "Show an entry where even the heading is hidden."
20821 (save-excursion
20822 (org-show-entry)))
20824 (defun org-flag-heading (flag &optional entry)
20825 "Flag the current heading. FLAG non-nil means make invisible.
20826 When ENTRY is non-nil, show the entire entry."
20827 (save-excursion
20828 (org-back-to-heading t)
20829 ;; Check if we should show the entire entry
20830 (if entry
20831 (progn
20832 (org-show-entry)
20833 (save-excursion
20834 (and (outline-next-heading)
20835 (org-flag-heading nil))))
20836 (outline-flag-region (max (point-min) (1- (point)))
20837 (save-excursion (outline-end-of-heading) (point))
20838 flag))))
20840 (defun org-get-next-sibling ()
20841 "Move to next heading of the same level, and return point.
20842 If there is no such heading, return nil.
20843 This is like outline-next-sibling, but invisible headings are ok."
20844 (let ((level (funcall outline-level)))
20845 (outline-next-heading)
20846 (while (and (not (eobp)) (> (funcall outline-level) level))
20847 (outline-next-heading))
20848 (if (or (eobp) (< (funcall outline-level) level))
20849 nil
20850 (point))))
20852 (defun org-get-last-sibling ()
20853 "Move to previous heading of the same level, and return point.
20854 If there is no such heading, return nil."
20855 (let ((opoint (point))
20856 (level (funcall outline-level)))
20857 (outline-previous-heading)
20858 (when (and (/= (point) opoint) (outline-on-heading-p t))
20859 (while (and (> (funcall outline-level) level)
20860 (not (bobp)))
20861 (outline-previous-heading))
20862 (if (< (funcall outline-level) level)
20863 nil
20864 (point)))))
20866 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20867 ;; This contains an exact copy of the original function, but it uses
20868 ;; `org-back-to-heading', to make it work also in invisible
20869 ;; trees. And is uses an invisible-OK argument.
20870 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20871 ;; Furthermore, when used inside Org, finding the end of a large subtree
20872 ;; with many children and grandchildren etc, this can be much faster
20873 ;; than the outline version.
20874 (org-back-to-heading invisible-OK)
20875 (let ((first t)
20876 (level (funcall outline-level)))
20877 (if (and (eq major-mode 'org-mode) (< level 1000))
20878 ;; A true heading (not a plain list item), in Org-mode
20879 ;; This means we can easily find the end by looking
20880 ;; only for the right number of stars. Using a regexp to do
20881 ;; this is so much faster than using a Lisp loop.
20883 (forward-char 1)
20884 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20885 ;; something else, do it the slow way
20886 (while (and (not (eobp))
20887 (or first (> (funcall outline-level) level)))
20888 (setq first nil)
20889 (outline-next-heading)))
20890 (unless to-heading
20892 (progn
20893 ;; Go to end of line before heading
20894 (forward-char -1)
20896 ;; leave blank line before heading
20897 (forward-char -1))))))
20898 (point))
20900 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20901 "Use Org version in org-mode, for dramatic speed-up."
20902 (if (eq major-mode 'org-mode)
20903 (progn
20904 (org-end-of-subtree nil t)
20905 (unless (eobp) (backward-char 1)))
20906 ad-do-it))
20908 (defun org-end-of-meta-data-and-drawers ()
20909 "Jump to the first text after meta data and drawers in the current entry.
20910 This will move over empty lines, lines with planning time stamps,
20911 clocking lines, and drawers."
20912 (org-back-to-heading t)
20913 (let ((end (save-excursion (outline-next-heading) (point)))
20916 (forward-line 1)
20917 (while (re-search-forward re end t)
20918 (if (not (match-end 1))
20919 ;; empty or planning line
20920 (forward-line 1)
20921 ;; a drawer, find the end
20923 (forward-line 1)))
20925 (point)))
20927 (defun org-forward-same-level (arg &optional invisible-ok)
20928 "Move forward to the arg'th subheading at same level as this one.
20929 Stop at the first and last subheadings of a superior heading.
20930 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20931 it wil also look at invisible ones."
20932 (interactive "p")
20933 (org-back-to-heading invisible-ok)
20934 (org-at-heading-p)
20935 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20937 l)
20938 (forward-char 1)
20939 (while (> arg 0)
20940 (while (and (re-search-forward re nil 'move)
20941 (setq l (- (match-end 0) (match-beginning 0) 1))
20942 (= l level)
20943 (not invisible-ok)
20944 (progn (backward-char 1) (outline-invisible-p)))
20945 (if (< l level) (setq arg 1)))
20946 (setq arg (1- arg)))
20947 (beginning-of-line 1)))
20949 (defun org-backward-same-level (arg &optional invisible-ok)
20950 "Move backward to the arg'th subheading at same level as this one.
20951 Stop at the first and last subheadings of a superior heading."
20952 (interactive "p")
20953 (org-back-to-heading)
20954 (org-at-heading-p)
20955 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20957 l)
20958 (while (> arg 0)
20959 (while (and (re-search-backward re nil 'move)
20960 (setq l (- (match-end 0) (match-beginning 0) 1))
20961 (= l level)
20962 (not invisible-ok)
20963 (outline-invisible-p))
20964 (if (< l level) (setq arg 1)))
20965 (setq arg (1- arg)))))
20967 (defun org-show-subtree ()
20968 "Show everything after this heading at deeper levels."
20969 (outline-flag-region
20970 (point)
20971 (save-excursion
20972 (org-end-of-subtree t t))
20973 nil))
20975 (defun org-show-entry ()
20976 "Show the body directly following this heading.
20977 Show the heading too, if it is currently invisible."
20978 (interactive)
20979 (save-excursion
20980 (condition-case nil
20981 (progn
20982 (org-back-to-heading t)
20983 (outline-flag-region
20984 (max (point-min) (1- (point)))
20985 (save-excursion
20986 (if (re-search-forward
20988 (match-beginning 1)
20989 (point-max)))
20990 nil)
20991 (org-cycle-hide-drawers 'children))
20992 (error nil))))
20994 (defun org-make-options-regexp (kwds &optional extra)
20995 "Make a regular expression for keyword lines."
20996 (concat
20997 "^"
21004 ;; Make isearch reveal the necessary context
21005 (defun org-isearch-end ()
21006 "Reveal context after isearch exits."
21007 (when isearch-success ; only if search was successful
21008 (if (featurep 'xemacs)
21009 ;; Under XEmacs, the hook is run in the correct place,
21010 ;; we directly show the context.
21011 (org-show-context 'isearch)
21012 ;; In Emacs the hook runs *before* restoring the overlays.
21013 ;; So we have to use a one-time post-command-hook to do this.
21014 ;; (Emacs 22 has a special variable, see function `org-mode')
21015 (unless (and (boundp 'isearch-mode-end-hook-quit)
21016 isearch-mode-end-hook-quit)
21017 ;; Only when the isearch was not quitted.
21018 (org-add-hook 'post-command-hook 'org-isearch-post-command
21019 'append 'local)))))
21021 (defun org-isearch-post-command ()
21022 "Remove self from hook, and show context."
21023 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21024 (org-show-context 'isearch))
21027 ;;;; Integration with and fixes for other packages
21029 ;;; Imenu support
21031 (defvar org-imenu-markers nil
21032 "All markers currently used by Imenu.")
21033 (make-variable-buffer-local 'org-imenu-markers)
21035 (defun org-imenu-new-marker (&optional pos)
21036 "Return a new marker for use by Imenu, and remember the marker."
21037 (let ((m (make-marker)))
21038 (move-marker m (or pos (point)))
21039 (push m org-imenu-markers)
21040 m))
21042 (defun org-imenu-get-tree ()
21043 "Produce the index for Imenu."
21044 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21045 (setq org-imenu-markers nil)
21046 (let* ((n org-imenu-depth)
21047 (re (concat "^" (org-get-limited-outline-regexp)))
21048 (subs (make-vector (1+ n) nil))
21049 (last-level 0)
21050 m level head)
21051 (save-excursion
21052 (save-restriction
21053 (widen)
21054 (goto-char (point-max))
21055 (while (re-search-backward re nil t)
21056 (setq level (org-reduced-level (funcall outline-level)))
21057 (when (<= level n)
21058 (looking-at org-complex-heading-regexp)
21059 (setq head (org-link-display-format
21060 (org-match-string-no-properties 4))
21061 m (org-imenu-new-marker))
21062 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21063 (if (>= level last-level)
21064 (push (cons head m) (aref subs level))
21065 (push (cons head (aref subs (1+ level))) (aref subs level))
21066 (loop for i from (1+ level) to n do (aset subs i nil)))
21067 (setq last-level level)))))
21068 (aref subs 1)))
21070 (eval-after-load "imenu"
21071 '(progn
21072 (add-hook 'imenu-after-jump-hook
21073 (lambda ()
21074 (if (eq major-mode 'org-mode)
21075 (org-show-context 'org-goto))))))
21077 (defun org-link-display-format (link)
21078 "Replace a link with either the description, or the link target
21079 if no description is present"
21080 (save-match-data
21081 (if (string-match org-bracket-link-analytic-regexp link)
21082 (replace-match (if (match-end 5)
21083 (match-string 5 link)
21084 (concat (match-string 1 link)
21085 (match-string 3 link)))
21086 nil t link)
21087 link)))
21089 (defun org-toggle-link-display ()
21090 "Toggle the literal or descriptive display of links."
21091 (interactive)
21092 (if org-descriptive-links
21093 (progn (org-remove-from-invisibility-spec '(org-link))
21094 (org-restart-font-lock)
21095 (setq org-descriptive-links nil))
21096 (progn (add-to-invisibility-spec '(org-link))
21097 (org-restart-font-lock)
21098 (setq org-descriptive-links t))))
21100 ;; Speedbar support
21102 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21103 "Overlay marking the agenda restriction line in speedbar.")
21104 (overlay-put org-speedbar-restriction-lock-overlay
21105 'face 'org-agenda-restriction-lock)
21106 (overlay-put org-speedbar-restriction-lock-overlay
21107 'help-echo "Agendas are currently limited to this item.")
21108 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21110 (defun org-speedbar-set-agenda-restriction ()
21111 "Restrict future agenda commands to the location at point in speedbar.
21113 (interactive)
21114 (require 'org-agenda)
21115 (let (p m tp np dir txt)
21116 (cond
21117 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21118 'org-imenu t))
21119 (setq m (get-text-property p 'org-imenu-marker))
21120 (with-current-buffer (marker-buffer m)
21121 (goto-char m)
21122 (org-agenda-set-restriction-lock 'subtree)))
21123 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21124 'speedbar-function 'speedbar-find-file))
21125 (setq tp (previous-single-property-change
21126 (1+ p) 'speedbar-function)
21127 np (next-single-property-change
21128 tp 'speedbar-function)
21129 dir (speedbar-line-directory)
21130 txt (buffer-substring-no-properties (or tp (point-min))
21131 (or np (point-max))))
21132 (with-current-buffer (find-file-noselect
21133 (let ((default-directory dir))
21134 (expand-file-name txt)))
21135 (unless (eq major-mode 'org-mode)
21136 (error "Cannot restrict to non-Org-mode file"))
21137 (org-agenda-set-restriction-lock 'file)))
21138 (t (error "Don't know how to restrict Org-mode's agenda")))
21139 (move-overlay org-speedbar-restriction-lock-overlay
21140 (point-at-bol) (point-at-eol))
21141 (setq current-prefix-arg nil)
21142 (org-agenda-maybe-redo)))
21144 (eval-after-load "speedbar"
21145 '(progn
21146 (speedbar-add-supported-extension ".org")
21147 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21148 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21149 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21150 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21151 (add-hook 'speedbar-visiting-tag-hook
21152 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21154 ;;; Fixes and Hacks for problems with other packages
21156 ;; Make flyspell not check words in links, to not mess up our keymap
21157 (defun org-mode-flyspell-verify ()
21158 "Don't let flyspell put overlays at active buttons, or on
21159 {todo,all-time,additional-option-like}-keywords."
21160 (let ((pos (max (1- (point)) (point-min)))
21161 (word (thing-at-point 'word)))
21162 (and (not (get-text-property pos 'keymap))
21163 (not (get-text-property pos 'org-no-flyspell))
21164 (not (member word org-todo-keywords-1))
21165 (not (member word org-all-time-keywords))
21166 (not (member word org-additional-option-like-keywords)))))
21168 (defun org-remove-flyspell-overlays-in (beg end)
21169 "Remove flyspell overlays in region."
21170 (and (org-bound-and-true-p flyspell-mode)
21171 (fboundp 'flyspell-delete-region-overlays)
21172 (flyspell-delete-region-overlays beg end))
21173 (add-text-properties beg end '(org-no-flyspell t)))
21175 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21176 (eval-after-load "bookmark"
21177 '(if (boundp 'bookmark-after-jump-hook)
21178 ;; We can use the hook
21179 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21180 ;; Hook not available, use advice
21181 (defadvice bookmark-jump (after org-make-visible activate)
21182 "Make the position visible."
21183 (org-bookmark-jump-unhide))))
21185 ;; Make sure saveplace shows the location if it was hidden
21186 (eval-after-load "saveplace"
21187 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21188 "Make the position visible."
21189 (org-bookmark-jump-unhide)))
21191 ;; Make sure ecb shows the location if it was hidden
21192 (eval-after-load "ecb"
21193 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21194 "Make hierarchy visible when jumping into location from ECB tree buffer."
21195 (if (eq major-mode 'org-mode)
21196 (org-show-context))))
21198 (defun org-bookmark-jump-unhide ()
21199 "Unhide the current position, to show the bookmark location."
21200 (and (eq major-mode 'org-mode)
21201 (or (outline-invisible-p)
21202 (save-excursion (goto-char (max (point-min) (1- (point))))
21203 (outline-invisible-p)))
21204 (org-show-context 'bookmark-jump)))
21206 ;; Make session.el ignore our circular variable
21207 (eval-after-load "session"
21208 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21210 ;;;; Experimental code
21212 (defun org-closed-in-range ()
21213 "Sparse tree of items closed in a certain time range.
21214 Still experimental, may disappear in the future."
21215 (interactive)
21216 ;; Get the time interval from the user.
21217 (let* ((time1 (org-float-time
21218 (org-read-date nil 'to-time nil "Starting date: ")))
21219 (time2 (org-float-time
21220 (org-read-date nil 'to-time nil "End date:")))
21221 ;; callback function
21222 (callback (lambda ()
21223 (let ((time
21224 (org-float-time
21225 (apply 'encode-time
21226 (org-parse-time-string
21227 (match-string 1))))))
21228 ;; check if time in interval
21229 (and (>= time time1) (<= time time2))))))
21230 ;; make tree, check each match with the callback
21233 ;;;; Finish up
21235 (provide 'org)
21237 (run-hooks 'org-load-hook)
21239 ;;; org.el ends here