| blob | 801a5e29274e3e324cf3807096cf65863c3855a6 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.8.06
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
80 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
92 ;; Other stuff we need.
110 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
115 ;; babel
124 ;; load languages based on value of `org-babel-load-languages'
126 ;;;###autoload
128 "Load the languages defined in `org-babel-load-languages'."
140 org-babel-load-languages))
143 "Languages which can be evaluated in Org-mode buffers.
144 This list can be used to load support for any of the languages
145 below, note that each language will depend on a different set of
146 system executables and/or Emacs modes. When a language is
148 with `org-babel-execute-src-block' bound by default to C-c
149 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
150 be set to remove code block evaluation from the C-c C-c
151 keybinding. By default only Emacs Lisp (which has no
152 requirements) is loaded."
156 :key-type
196 ;;;; Customization variables
198 "Remove ID property of clones of a subtree.
199 When non-nil, clones of a subtree don't inherit the ID property.
200 Otherwise they inherit the ID property with a new unique
201 identifier."
205 ;;; Version
210 ;;;###autoload
212 "Show the org-mode version in the echo area.
213 With prefix arg HERE, insert it at point."
239 ;;; Compatibility constants
241 ;;; The custom variables
244 "Outline-based notes management and organizer."
250 "Mode hook for Org-mode, run after the mode was turned on."
255 "Hook that is run after org.el has been loaded."
260 "Hook that is run after an Org log buffer is created."
269 "Load all extensions listed in `org-modules'."
274 org-modules)
278 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
287 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
288 "Modules that should always be loaded together with org.el.
289 If a description starts with <C>, the file is not part of Emacs
290 and loading it will require that you have downloaded and properly installed
291 the org-mode distribution.
293 You can also use this system to load external packages (i.e. neither Org
294 core modules, nor modules from the CONTRIB directory). Just add symbols
295 to the end of the list. If the package is called org-xyz.el, then you need
296 to add the symbol `xyz', and the package must have a call to
298 (provide 'org-xyz)"
301 :type
332 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
341 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
350 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
366 "Non-nil means make shift-cursor commands select text when possible.
368 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
369 start selecting a region, or enlarge regions started in this way.
370 In Org-mode, in special contexts, these same keys are used for
371 other purposes, important enough to compete with shift selection.
372 Org tries to balance these needs by supporting `shift-select-mode'
373 outside these special contexts, under control of this variable.
375 The default of this variable is nil, to avoid confusing behavior. Shifted
376 cursor keys will then execute Org commands in the following contexts:
377 - on a headline, changing TODO state (left/right) and priority (up/down)
378 - on a time stamp, changing the time
379 - in a plain list item, changing the bullet type
380 - in a property definition line, switching between allowed values
381 - in the BEGIN line of a clock table (changing the time block).
382 Outside these contexts, the commands will throw an error.
384 When this variable is t and the cursor is not in a special
385 context, Org-mode will support shift-selection for making and
386 enlarging regions. To make this more effective, the bullet
387 cycling will no longer happen anywhere in an item line, but only
388 if the cursor is exactly on the bullet.
390 If you set this variable to the symbol `always', then the keys
391 will not be special in headlines, property lines, and item lines,
392 to make shift selection work there as well. If this is what you
393 want, you can use the following alternative commands: `C-c C-t'
394 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
395 can be used to switch TODO sets, `C-c -' to cycle item bullet
396 types, and properties can be edited by hand or in column view.
398 However, when the cursor is on a timestamp, shift-cursor commands
399 will still edit the time stamp - this is just too good to give up.
401 XEmacs user should have this variable set to nil, because
402 `shift-select-mode' is in Emacs 23 or later only."
410 "Shall some commands act upon headlines in the active region?
412 When set to `t', some commands will be performed in all headlines
413 within the active region.
415 When set to `start-level', some commands will be performed in all
416 headlines within the active region, provided that these headlines
417 are of the same level than the first one.
419 When set to a string, those commands will be performed on the
420 matching headlines within the active region. Such string must be
421 a tags/property/todo match as it is used in the agenda tags view.
423 The list of commands is: `org-schedule', `org-deadline',
424 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
425 `org-archive-to-archive-sibling'. The archiving commands skip
426 already archived entries."
435 "Options concerning startup of Org-mode."
440 "Non-nil means entering Org-mode will switch to OVERVIEW.
441 This can also be configured on a per-file basis by adding one of
442 the following lines anywhere in the buffer:
444 #+STARTUP: fold (or `overview', this is equivalent)
445 #+STARTUP: nofold (or `showall', this is equivalent)
446 #+STARTUP: content
447 #+STARTUP: showeverything"
456 "Non-nil means entering Org-mode will set `truncate-lines'.
457 This is useful since some lines containing links can be very long and
458 uninteresting. Also tables look terrible when wrapped."
463 "Non-nil means turn on `org-indent-mode' on startup.
464 This can also be configured on a per-file basis by adding one of
465 the following lines anywhere in the buffer:
467 #+STARTUP: indent
468 #+STARTUP: noindent"
476 When this option is turned on, you can use TeX-like syntax for sub- and
478 considered as a single item - so grouping with {} is normally not
479 needed. For example, the following things will be parsed as single
480 sub- or superscripts.
482 10^24 or 10^tau several digits will be considered 1 item.
483 10^-12 or 10^-tau a leading sign with digits or a word
484 x^2-y^3 will be read as x^2 - y^3, because items are
485 terminated by almost any nonword/nondigit char.
486 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
488 Still, ambiguity is possible - so when in doubt use {} to enclose the
489 sub/superscript. If you set this variable to the symbol `{}',
490 the braces are *required* in order to trigger interpretations as
492 frequently in plain text.
494 Not all export backends support this, but HTML does.
509 "Non-nil means turn on `org-beamer-mode' on startup.
510 This can also be configured on a per-file basis by adding one of
511 the following lines anywhere in the buffer:
513 #+STARTUP: beamer"
518 "Non-nil means align all tables when visiting a file.
519 This is useful when the column width in tables is forced with <N> cookies
520 in table fields. Such tables will look correct only after the first re-align.
521 This can also be configured on a per-file basis by adding one of
522 the following lines anywhere in the buffer:
523 #+STARTUP: align
524 #+STARTUP: noalign"
529 "Non-nil means show inline images when loading a new Org file.
530 This can also be configured on a per-file basis by adding one of
531 the following lines anywhere in the buffer:
532 #+STARTUP: inlineimages
533 #+STARTUP: noinlineimages"
538 "Non-nil means insert the first line setting Org-mode in empty files.
539 When the function `org-mode' is called interactively in an empty file, this
540 normally means that the file name does not automatically trigger Org-mode.
541 To ensure that the file will always be in Org-mode in the future, a
542 line enforcing Org-mode will be inserted into the buffer, if this option
543 has been set."
548 "Non-nil means use alternative key bindings for some keys.
549 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
550 These keys are also used by other packages like shift-selection-mode'
551 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
552 If you want to use Org-mode together with one of these other modes,
553 or more generally if you would like to move some Org-mode commands to
554 other keys, set this variable and configure the keys with the variable
555 `org-disputed-keys'.
557 This option is only relevant at load-time of Org-mode, and must be set
558 *before* org.el is loaded. Changing it requires a restart of Emacs to
559 become effective."
564 "Non-nil means use extra key sequence definitions for certain commands.
565 This happens automatically if you run XEmacs or if `window-system'
566 is nil. This variable lets you do the same manually. You must
567 set it before loading org.
569 Example: on Carbon Emacs 22 running graphically, with an external
570 keyboard on a Powerbook, the default way of setting M-left might
571 not work for either Alt or ESC. Setting this variable will make
572 it work for ESC."
586 "Keys for which Org-mode and other modes compete.
587 This is an alist, cars are the default keys, second element specifies
588 the alternative to use when `org-replace-disputed-keys' is t.
590 Keys can be specified in any syntax supported by `define-key'.
591 The value of this option takes effect only at Org-mode's startup,
592 therefore you'll have to restart Emacs to apply it after changing."
597 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
598 Or return the original if not disputed.
599 Also apply the translations defined in `org-xemacs-key-equivalents'."
604 org-disputed-keys)))
608 key)
618 "Define a key, possibly translated, as returned by `org-key'."
622 "The ellipsis to use in the Org-mode outline.
623 When nil, just use the standard three dots. When a string, use that instead,
624 When a face, use the standard 3 dots, but with the specified face.
625 The change affects only Org-mode (which will then use its own display table).
626 Changing this requires executing `M-x org-mode' in a buffer to become
627 effective."
637 "Keywords in Org-mode."
642 "String to mark deadline entries.
643 A deadline is this string, followed by a time stamp. Should be a word,
644 terminated by a colon. You can insert a schedule keyword and
646 Changes become only effective after restarting Emacs."
651 "String to mark scheduled TODO entries.
652 A schedule is this string, followed by a time stamp. Should be a word,
653 terminated by a colon. You can insert a schedule keyword and
655 Changes become only effective after restarting Emacs."
660 "String used as the prefix for timestamps logging closing a TODO entry."
665 "String used as prefix for timestamps clocking work hours on an item."
670 "Entries starting with this keyword will never be exported.
671 An entry can be toggled between COMMENT and normal with
673 Changes become only effective after restarting Emacs."
678 "Entries starting with this keyword will be exported in fixed-width font.
679 Quoting applies only to the text in the entry following the headline, and does
680 not extend beyond the next headline, even if that is lower level.
681 An entry can be toggled between QUOTE and normal with
688 "Regular expression for specifying repeated events.
692 "Options concerning the general structure of Org-mode files."
697 "Options about how to make context of a location visible."
721 "Non-nil means show full hierarchy when revealing a location.
722 Org-mode often shows locations in an org-mode file which might have
723 been invisible before. When this is set, the hierarchy of headings
724 above the exposed location is shown.
725 Turning this off for example for sparse trees makes them very compact.
726 Instead of t, this can also be an alist specifying this option for different
727 contexts. Valid contexts are
728 agenda when exposing an entry from the agenda
729 org-goto when using the command `org-goto' on key C-c C-j
730 occur-tree when using the command `org-occur' on key C-c /
731 tags-tree when constructing a sparse tree based on tags matches
732 link-search when exposing search matches associated with a link
733 mark-goto when exposing the jump goal of a mark
734 bookmark-jump when exposing a bookmark location
735 isearch when exiting from an incremental search
736 default default for all contexts not set explicitly"
741 "Non-nil means show following heading when revealing a location.
742 Org-mode often shows locations in an org-mode file which might have
743 been invisible before. When this is set, the heading following the
744 match is shown.
745 Turning this off for example for sparse trees makes them very compact,
746 but makes it harder to edit the location of the match. In such a case,
748 Instead of t, this can also be an alist specifying this option for different
749 contexts. See `org-show-hierarchy-above' for valid contexts."
754 "Non-nil means show all sibling heading when revealing a location.
755 Org-mode often shows locations in an org-mode file which might have
756 been invisible before. When this is set, the sibling of the current entry
757 heading are all made visible. If `org-show-hierarchy-above' is t,
758 the same happens on each level of the hierarchy above the current entry.
760 By default this is on for the isearch context, off for all other contexts.
761 Turning this off for example for sparse trees makes them very compact,
762 but makes it harder to edit the location of the match. In such a case,
764 Instead of t, this can also be an alist specifying this option for different
765 contexts. See `org-show-hierarchy-above' for valid contexts."
770 "Non-nil means show the entry below a headline when revealing a location.
771 Org-mode often shows locations in an org-mode file which might have
772 been invisible before. When this is set, the text below the headline that is
773 exposed is also shown.
775 By default this is off for all contexts.
776 Instead of t, this can also be an alist specifying this option for different
777 contexts. See `org-show-hierarchy-above' for valid contexts."
782 "How should indirect tree buffers be displayed?
783 This applies to indirect buffers created with the commands
785 Valid values are:
786 current-window Display in the current window
787 other-window Just display in another window.
788 dedicated-frame Create one new frame, and re-use it each time.
789 new-frame Make a new frame each time. Note that in this case
790 previously-made indirect buffers are kept, and you need to
791 kill these buffers yourself."
801 "Non-nil means activate single letter commands at beginning of a headline.
802 This may also be a function to test for appropriate locations where speed
803 commands should be active."
811 "Alist of additional speed commands.
812 This list will be checked before `org-speed-commands-default'
813 when the variable `org-use-speed-commands' is non-nil
814 and when the cursor is at the beginning of a headline.
815 The car if each entry is a string with a single letter, which must
816 be assigned to `self-insert-command' in the global map.
817 The cdr is either a command to be called interactively, a function
818 to be called, or a form to be evaluated.
819 An entry that is just a list with a single string will be interpreted
820 as a descriptive headline that will be added when listing the speed
821 commands in the Help buffer using the `?' speed command."
833 "Options concerning visibility cycling in Org-mode."
838 "Non-nil means skip CHILDREN state in entries that don't have any."
843 "Maximum level which should still be subject to visibility cycling.
844 Levels higher than this will, for cycling, be treated as text, not a headline.
845 When `org-odd-levels-only' is set, a value of N in this variable actually
846 means 2N-1 stars as the limiting headline.
847 When nil, cycle all levels.
848 Note that the limiting level of cycling is also influenced by
849 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
850 `org-inlinetask-min-level' is, cycling will be limited to levels one less
851 than its value."
858 "Names of drawers. Drawers are not opened by cycling on the headline above.
859 Drawers only open with a TAB on the drawer line itself. A drawer looks like
860 this:
861 :DRAWERNAME:
862 .....
863 :END:
865 the property API.
867 Drawers can be defined on the per-file basis with a line like:
869 #+DRAWERS: HIDDEN STATE PROPERTIES"
875 "Non-nil means entering Org-mode will fold all blocks.
876 This can also be set in on a per-file basis with
878 #+STARTUP: hideblocks
879 #+STARTUP: showblocks"
885 "Cycle globally if cursor is at beginning of buffer and not at a headline.
886 This makes it possible to do global cycling without having to use S-TAB or
888 of the buffer
889 must not be a headline - it may be empty or some other text. When used in
890 this way, `org-cycle-hook' is disables temporarily, to make sure the
891 cursor stays at the beginning of the buffer.
892 When this option is nil, don't do anything special at the beginning
893 of the buffer."
898 "Non-nil means cycle entry level or item indentation in new empty entries.
900 When the cursor is at the end of an empty headline, i.e with only stars
901 and maybe a TODO keyword, TAB will then switch the entry to become a child,
902 and then all possible ancestor states, before returning to the original state.
903 This makes data entry extremely fast: M-RET to create a new headline,
904 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
906 When the cursor is at the end of an empty plain list item, one TAB will
907 make it a subitem, two or more tabs will back up to make this an item
908 higher up in the item hierarchy."
913 "Where should `org-cycle' emulate TAB.
914 nil Never
915 white Only in completely white lines
916 whitestart Only at the beginning of lines, before the first non-white char
917 t Everywhere except in headlines
918 exc-hl-bol Everywhere except at the start of a headline
919 If TAB is used in a place where it does not emulate TAB, the current subtree
920 visibility is cycled."
927 ))
930 "Number of empty lines needed to keep an empty line between collapsed trees.
931 If you leave an empty line between the end of a subtree and the following
932 headline, this empty line is hidden when the subtree is folded.
933 Org-mode will leave (exactly) one empty line visible if the number of
934 empty lines is equal or larger to the number given in this variable.
935 So the default 2 means at least 2 empty lines after the end of a subtree
936 are needed to produce free space between a collapsed subtree and the
937 following headline.
939 If the number is negative, and the number of empty lines is at least -N,
940 all empty lines are shown.
942 Special case: when 0, never leave empty lines in collapsed view."
948 "Hook that is run before visibility cycling is happening.
949 The function(s) in this hook must accept a single argument which indicates
950 the new state that will be set right after running this hook. The
951 argument is a symbol. Before a global state change, it can have the values
952 `overview', `content', or `all'. Before a local state change, it can have
953 the values `folded', `children', or `subtree'."
958 org-cycle-hide-drawers
959 org-cycle-show-empty-lines
960 org-optimize-window-after-visibility-change)
961 "Hook that is run after `org-cycle' has changed the buffer visibility.
962 The function(s) in this hook must accept a single argument which indicates
963 the new state that was set by the most recent `org-cycle' command. The
964 argument is a symbol. After a global state change, it can have the values
965 `overview', `content', or `all'. After a local state change, it can have
966 the values `folded', `children', or `subtree'."
971 "Options concerning structure editing in Org-mode."
976 "Non-nil means skip even levels and only use odd levels for the outline.
977 This has the effect that two stars are being added/taken away in
978 promotion/demotion commands. It also influences how levels are
979 handled by the exporters.
980 Changing it requires restart of `font-lock-mode' to become effective
981 for fontification also in regions already fontified.
982 You may also set this on a per-file basis by adding one of the following
983 lines to the buffer:
985 #+STARTUP: odd
986 #+STARTUP: oddeven"
992 "Non-nil means adapt indentation to outline node level.
994 When this variable is set, Org assumes that you write outlines by
995 indenting text in each node to align with the headline (after the stars).
996 The following issues are influenced by this variable:
998 - When this is set and the *entire* text in an entry is indented, the
999 indentation is increased by one space in a demotion command, and
1000 decreased by one in a promotion command. If any line in the entry
1001 body starts with text at column 0, indentation is not changed at all.
1003 - Property drawers and planning information is inserted indented when
1004 this variable s set. When nil, they will not be indented.
1006 - TAB indents a line relative to context. The lines below a headline
1007 will be indented when this variable is set.
1009 Note that this is all about true indentation, by adding and removing
1010 space characters. See also `org-indent.el' which does level-dependent
1011 indentation in a virtual way, i.e. at display time in Emacs."
1016 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1018 When t, `C-a' will bring back the cursor to the beginning of the
1019 headline text, i.e. after the stars and after a possible TODO keyword.
1020 In an item, this will be the position after the bullet.
1021 When the cursor is already at that position, another `C-a' will bring
1022 it to the beginning of the line.
1024 `C-e' will jump to the end of the headline, ignoring the presence of tags
1025 in the headline. A second `C-e' will then jump to the true end of the
1026 line, after any tags. This also means that, when this variable is
1027 non-nil, `C-e' also will never jump beyond the end of the heading of a
1028 folded section, i.e. not after the ellipses.
1030 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1031 going to the true line boundary first. Only a directly following, identical
1032 keypress will bring the cursor to the special positions.
1034 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1035 set separately."
1054 "Non-nil means `C-k' will behave specially in headlines.
1055 When nil, `C-k' will call the default `kill-line' command.
1056 When t, the following will happen while the cursor is in the headline:
1058 - When the cursor is at the beginning of a headline, kill the entire
1059 line and possible the folded subtree below the line.
1060 - When in the middle of the headline text, kill the headline up to the tags.
1061 - When after the headline text, kill the tags."
1066 "Non-nil means, do not delete a hidden subtree with C-k.
1067 When set to the symbol `error', simply throw an error when C-k is
1068 used to kill (part-of) a headline that has hidden text behind it.
1069 Any other non-nil value will result in a query to the user, if it is
1070 OK to kill that hidden subtree. When nil, kill without remorse."
1078 "Check if in invisible region before inserting or deleting a character.
1079 Valid values are:
1081 nil Do not check, so just do invisible edits.
1082 error Throw an error and do nothing.
1083 show Make point visible, and do the requested edit.
1084 show-and-error Make point visible, then throw an error and abort the edit.
1085 smart Make point visible, and do insertion/deletion if it is
1086 adjacent to visible text and the change feels predictable.
1087 Never delete a previously invisible character or add in the
1088 middle or right after an invisible region. Basically, this
1089 allows insertion and backward-delete right before ellipses.
1090 FIXME: maybe in this case we should not even show?"
1100 "Non-nil means when yanking subtrees, fold them.
1101 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1102 it starts with a heading and all other headings in it are either children
1103 or siblings, then fold all the subtrees. However, do this only if no
1104 text after the yank would be swallowed into a folded tree by this action."
1109 "Non-nil means when yanking subtrees, adjust the level.
1110 With this setting, `org-paste-subtree' is used to insert the subtree, see
1111 this function for details."
1116 "Non-nil means M-RET will split the line at the cursor position.
1117 When nil, it will go to the end of the line before making a
1118 new line.
1119 You may also set this option in a different way for different
1120 contexts. Valid contexts are:
1122 headline when creating a new headline
1123 item when creating a new item
1124 table in a table field
1125 default the value to be used for all contexts not explicitly
1126 customized"
1143 "Non-nil means insert new headings after the current subtree.
1144 When nil, the new heading is created directly after the current line.
1147 for the duration of the command."
1153 "Should `org-insert-heading' leave a blank line before new heading/item?
1154 The value is an alist, with `heading' and `plain-list-item' as CAR,
1155 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1156 which case Org will look at the surrounding headings/items and try to
1157 make an intelligent decision whether to insert a blank line or not.
1159 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1160 set, the setting here is ignored and no empty line is inserted, to avoid
1161 breaking the list structure."
1174 "Hook being run after inserting a new heading."
1180 This currently only means they are never auto-wrapped.
1181 When nil, such lines will be treated like ordinary lines.
1182 See also the QUOTE keyword."
1187 "Non-nil means typing characters in `org-goto' starts incremental search."
1192 "Options concerning sparse trees in Org-mode."
1197 "Non-nil means highlight all matches that define a sparse tree.
1198 The highlights will automatically disappear the next time the buffer is
1199 changed by an edit command."
1204 "Non-nil means any change to the buffer will remove temporary highlights.
1205 Such highlights are created by `org-occur' and `org-clock-display'.
1206 When nil, `C-c C-c needs to be used to get rid of the highlights.
1207 The highlights created by `org-preview-latex-fragment' always need
1208 `C-c C-c' to be removed."
1215 "Hook that is run after `org-occur' has constructed a sparse tree.
1216 This can be used to recenter the window to show as much of the structure
1217 as possible."
1222 "Options concerning imenu and speedbar in Org-mode."
1227 "The maximum level for Imenu access to Org-mode headlines.
1228 This also applied for speedbar access."
1233 "Options concerning tables in Org-mode."
1239 When nil, such lines will be treated like ordinary lines.
1241 When equal to the symbol `optimized', the table editor will be optimized to
1242 do the following:
1243 - Automatic overwrite mode in front of whitespace in table fields.
1244 This makes the structure of the table stay in tact as long as the edited
1245 field does not exceed the column width.
1246 - Minimize the number of realigns. Normally, the table is aligned each time
1247 TAB or RET are pressed to move to another field. With optimization this
1248 happens only if changes to a field might have changed the column width.
1249 Optimization requires replacing the functions `self-insert-command',
1250 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1251 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1252 very good at guessing when a re-align will be necessary, but you can always
1255 If you would like to use the optimized version in Org-mode, but the
1256 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1258 This variable can be used to turn on and off the table editor during a session,
1259 but in order to toggle optimization, a restart is required.
1261 See also the variable `org-table-auto-blank-field'."
1269 "Non-nil means cluster self-insert commands for undo when possible.
1270 If this is set, then, like in the Emacs command loop, 20 consecutive
1271 characters will be undone together.
1272 This is configurable, because there is some impact on typing performance."
1277 "Non-nil means TAB will automatically notice a table.el table.
1278 When it sees such a table, it moves point into it and - if necessary -
1279 calls `table-recognize-table'."
1284 "Options concerning links in Org-mode."
1289 "Buffer-local version of `org-link-abbrev-alist', which see.
1294 "Alist of link abbreviations.
1295 The car of each element is a string, to be replaced at the start of a link.
1297 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1299 [[linkkey:tag][description]]
1301 The 'linkkey' must be a word word, starting with a letter, followed
1302 by letters, numbers, '-' or '_'.
1304 If REPLACE is a string, the tag will simply be appended to create the link.
1307 be inserted at that point (see the function `url-hexify-string').
1309 REPLACE may also be a function that will be called with the tag as the
1310 only argument to create the link, which should be returned as a string.
1312 See the manual for examples."
1322 "Non-nil means Org will display descriptive links.
1323 E.g. [[http://orgmode.org][Org website]] will be displayed as
1325 description. When set to `nil', Org will display the full links
1326 literally.
1328 You can interactively set the value of this variable by calling
1329 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1334 "How the path name in file links should be stored.
1335 Valid values are:
1337 relative Relative to the current directory, i.e. the directory of the file
1338 into which the link is being inserted.
1339 absolute Absolute path, if possible with ~ for home directory.
1340 noabbrev Absolute path, no abbreviation of home directory.
1341 adaptive Use relative path for files in the current directory and sub-
1342 directories of it. For other files, use an absolute path."
1351 "Types of links that should be activated in Org-mode files.
1352 This is a list of symbols, each leading to the activation of a certain link
1353 type. In principle, it does not hurt to turn on most link types - there may
1354 be a small gain when turning off unused link types. The types are:
1356 bracket The recommended [[link][description]] or [[link]] links with hiding.
1357 angle Links in angular brackets that may contain whitespace like
1358 <bbdb:Carsten Dominik>.
1359 plain Plain links in normal text, no whitespace, like http://google.com.
1360 radio Text that is matched by a radio target, see manual for details.
1361 tag Tag settings in a headline (link to tag search).
1362 date Time stamps (link to calendar).
1363 footnote Footnote labels.
1365 Changing this variable requires a restart of Emacs to become effective."
1377 "Function to use to generate link descriptions from links.
1378 If nil the link location will be used. This function must take
1379 two parameters; the first is the link and the second the
1380 description `org-insert-link' has generated, and should return the
1381 description to use."
1386 "Options concerning storing links in Org-mode."
1391 "Format of the description part of a link to an email or usenet message.
1392 The following %-escapes will be replaced by corresponding information:
1400 %s subject
1401 %d date
1402 %m message-id.
1404 You may use normal field width specification between the % and the letter.
1405 This is for example useful to limit the length of the subject.
1419 It should match if the message is from the user him/herself."
1424 "Non-nil means storing a link to an Org file will use entry IDs.
1426 Note that before this variable is even considered, org-id must be loaded,
1427 so please customize `org-modules' and turn it on.
1429 The variable can have the following values:
1431 t Create an ID if needed to make a link to the current entry.
1433 create-if-interactive
1434 If `org-store-link' is called directly (interactively, as a user
1435 command), do create an ID to support the link. But when doing the
1436 job for remember, only use the ID if it already exists. The
1437 purpose of this setting is to avoid proliferation of unwanted
1438 IDs, just because you happen to be in an Org file when you
1439 call `org-remember' that automatically and preemptively
1440 creates a link. If you do want to get an ID link in a remember
1441 template to an entry not having an ID, create it first by
1442 explicitly creating a link to it, using `C-c C-l' first.
1444 create-if-interactive-and-no-custom-id
1445 Like create-if-interactive, but do not create an ID if there is
1446 a CUSTOM_ID property defined in the entry. This is the default.
1448 use-existing
1449 Use existing ID, do not create one.
1451 nil Never use an ID to make a link, instead link using a text search for
1452 the headline text."
1457 create-if-interactive)
1459 create-if-interactive-and-no-custom-id)
1464 "Non-nil means file links from `org-store-link' contain context.
1465 A search string will be added to the file name with :: as separator and
1466 used to find the context when the link is activated by the command
1467 `org-open-at-point'. When this option is t, the entire active region
1468 will be placed in the search string of the file link. If set to a
1469 positive integer, only the first n lines of context will be stored.
1472 negates this setting for the duration of the command."
1477 "Non-nil means keep link in list for entire session.
1479 The command `org-store-link' adds a link pointing to the current
1480 location to an internal list. These links accumulate during a session.
1481 The command `org-insert-link' can be used to insert links into any
1482 Org-mode file (offering completion for all stored links). When this
1484 will be removed from the list, to make completing the unused links
1485 more efficient."
1490 "Options concerning following links in Org-mode."
1495 "Function to translate links with different syntax to Org syntax.
1496 This can be used to translate links created for example by the Planner
1497 or emacs-wiki packages to Org syntax.
1498 The function must accept two parameters, a TYPE containing the link
1500 which is everything after the link protocol. It should return a cons
1501 with possibly modified values of type and path.
1502 Org contains a function for this, so if you set this variable to
1503 `org-translate-link-from-planner', you should be able follow many
1504 links created by planner."
1509 "Hook that is run after a link has been followed."
1514 "Non-nil means on links TAB will follow the link.
1515 Needs to be set before org.el is loaded.
1516 This really should not be used, it does not make sense, and the
1517 implementation is bad."
1522 "Non-nil means on links RET will follow the link."
1528 "Non-nil means mouse-1 on a link will follow the link.
1529 A longer mouse click will still set point. Does not work on XEmacs.
1530 Needs to be set before org.el is loaded."
1535 "Number of different positions to be recorded in the ring.
1536 Changing this requires a restart of Emacs to work correctly."
1541 "Non-nil means internal links in Org files must exactly match a headline.
1542 When nil, the link search tries to match a phrase with all words
1543 in the search text."
1549 query-to-create)))
1556 "Setup the frame configuration for following links.
1557 When following a link with Emacs, it may often be useful to display
1558 this link in another window or frame. This variable can be used to
1559 set this up for the different types of links.
1560 For VM, use any of
1561 `vm-visit-folder'
1562 `vm-visit-folder-other-window'
1563 `vm-visit-folder-other-frame'
1564 For Gnus, use any of
1565 `gnus'
1566 `gnus-other-frame'
1567 `org-gnus-no-new-news'
1568 For FILE, use any of
1569 `find-file'
1570 `find-file-other-window'
1571 `find-file-other-frame'
1572 For Wanderlust use any of
1573 `wl'
1574 `wl-other-frame'
1575 For the calendar, use the variable `calendar-setup'.
1576 For BBDB, it is currently only possible to display the matches in
1577 another window."
1601 "Non-nil means use indirect buffer to display infile links.
1602 Activating internal links (from one location in a file to another location
1603 in the same file) normally just jumps to the location. When the link is
1605 is displayed in
1606 another window. When this option is set, the other window actually displays
1607 an indirect buffer clone of the current buffer, to avoid any visibility
1608 changes to the current buffer."
1613 "Non-nil means `org-open-file' will open non-existing files.
1614 When nil, an error will be generated.
1615 This variable applies only to external applications because they
1616 might choke on non-existing files. If the link is to a file that
1617 will be opened in Emacs, the variable is ignored."
1622 "Non-nil means a link to a directory really means to index.org.
1623 When nil, following a directory link will run dired or open a finder/explorer
1624 window on that directory."
1629 "Function and arguments to call for following mailto links.
1630 This is a list with the first element being a Lisp function, and the
1631 remaining elements being arguments to the function. In string arguments,
1632 %a will be replaced by the address, and %s will be replaced by the subject
1633 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1642 "Non-nil means ask for confirmation before executing shell links.
1643 Shell links can be dangerous: just think about a link
1645 [[shell:rm -rf ~/*][Google Search]]
1648 but really it would remove your entire home directory.
1649 Therefore we advise against setting this variable to nil.
1650 Just change it to `y-or-n-p' if you want to confirm with a
1658 'safe-local-variable
1662 "A regexp to skip confirmation for shell links."
1667 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1668 Elisp links can be dangerous: just think about a link
1673 but really it would remove your entire home directory.
1674 Therefore we advise against setting this variable to nil.
1675 Just change it to `y-or-n-p' if you want to confirm with a
1683 'safe-local-variable
1687 "A regexp to skip confirmation for Elisp links."
1695 "Default file applications on a UNIX or GNU/Linux system.
1706 "Default file applications on a MacOS X system.
1708 for some files for which the OS does not have a good default.
1716 'mswindows-shell-execute
1721 'mswindows-shell-execute
1724 "Default file applications on a Windows NT system.
1729 '(
1734 )
1735 "External applications for opening `file:path' items in a document.
1736 Org-mode uses system defaults for different file types, but
1737 you can use this variable to set the application for a given file
1738 extension. The entries in this list are cons cells where the car identifies
1739 files and the cdr the corresponding command. Possible values for the
1740 file identifier are
1742 ways, depending on its contents:
1744 - Alphanumeric characters only:
1745 Match links with this file extension.
1747 to open PDFs with evince.
1749 - Regular expression: Match links where the
1750 filename matches the regexp. If you want to
1751 use groups here, use shy groups.
1755 to open *.html and *.xhtml with firefox.
1757 - Regular expression which contains (non-shy) groups:
1759 anything after that, matches the regexp.
1760 In a custom command string, %1, %2, etc. are replaced with
1761 the parts of the link that were matched by the groups.
1762 For backwards compatibility, if a command string is given
1763 that does not use any of the group matches, this case is
1764 handled identically to the second one (i.e. match against
1765 file name only).
1766 In a custom lisp form, you can access the group matches with
1767 (match-string n link).
1770 to open [[file:document.pdf::5]] with evince at page 5.
1772 `directory' Matches a directory
1773 `remote' Matches a remote file, accessible through tramp or efs.
1774 Remote files most likely should be visited through Emacs
1775 because external applications cannot handle such paths.
1776 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1777 so all files Emacs knows how to handle. Using this with
1778 command `emacs' will open most files in Emacs. Beware that this
1779 will also open html files inside Emacs, unless you add
1781 t Default for files not matched by any of the other options.
1782 `system' The system command to open files, like `open' on Windows
1783 and Mac OS X, and mailcap under GNU/Linux. This is the command
1784 that will be selected if you call `C-c C-o' with a double
1787 Possible values for the command are:
1788 `emacs' The file will be visited by the current Emacs process.
1789 `default' Use the default application for this file type, which is the
1790 association for t in the list, most likely in the system-specific
1791 part.
1792 This can be used to overrule an unwanted setting in the
1793 system-specific variable.
1795 This command is specified by the entry whose car is `system'.
1796 Most likely, the system-specific version of this variable
1797 does define this command, but you can overrule/replace it
1798 here.
1799 string A command to be executed by a shell; %s will be replaced
1800 by the path to the file.
1801 sexp A Lisp form which will be evaluated. The file path will
1802 be available in the Lisp variable `file'.
1803 For more examples, see the system specific constants
1804 `org-file-apps-defaults-macosx'
1805 `org-file-apps-defaults-windowsnt'
1806 `org-file-apps-defaults-gnu'."
1816 auto-mode))
1827 "Options concerning refiling entries in Org-mode."
1832 "Directory with org files.
1833 This is just a default location to look for Org files. There is no need
1834 at all to put your files into this directory. It is only used in the
1835 following situations:
1837 1. When a remember template specifies a target file that is not an
1838 absolute path. The path will then be interpreted relative to
1839 `org-directory'
1840 2. When a remember note is filed away in an interactive way (when exiting the
1841 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1842 with `org-directory' as the default path."
1848 "Default target for storing notes.
1849 Used as a fall back file for org-remember.el and org-capture.el, for
1850 templates that do not specify a target file."
1855 file))
1858 "The default interface to be used for `org-goto'.
1859 Allowed values are:
1860 outline The interface shows an outline of the relevant file
1861 and the correct heading is found by moving through
1862 the outline or by searching with incremental search.
1863 outline-path-completion Headlines in the current buffer are offered via
1864 completion. This is the interface also used by
1865 the refile command."
1872 "Maximum target level when running `org-goto' with refile interface."
1877 "Non-nil means store new notes at the beginning of a file or entry.
1878 When nil, new notes will be filed to the end of a file or entry.
1879 This can also be a list with cons cells of regular expressions that
1880 are matched against file names, and values."
1890 "Information to record when a task is refiled.
1892 Possible values are:
1894 nil Don't add anything
1895 time Add a time stamp to the task
1896 note Prompt for a note and add it with template `org-log-note-headings'
1898 This option can also be set with on a per-file-basis with
1900 #+STARTUP: nologrefile
1901 #+STARTUP: logrefile
1902 #+STARTUP: lognoterefile
1904 You can have local logging settings for a subtree by setting the LOGGING
1905 property to one or more of these keywords.
1907 When bulk-refiling from the agenda, the value `note' is forbidden and
1908 will temporarily be changed to `time'."
1918 This is a list of cons cells. Each cell contains:
1919 - a specification of the files to be considered, either a list of files,
1920 or a symbol whose function or variable value will be used to retrieve
1921 a file name or a list of file names. If you use `org-agenda-files' for
1922 that, all agenda files will be scanned for targets. Nil means consider
1923 headings in the current buffer.
1924 - A specification of how to find candidate refile targets. This may be
1925 any of:
1927 This tag has to be present in all target headlines, inheritance will
1928 not be considered.
1930 todo keyword.
1932 headlines that are refiling targets.
1933 - a cons cell (:level . N). Any headline of level N is considered a target.
1934 Note that, when `org-odd-levels-only' is set, level corresponds to
1935 order in hierarchy, not to the number of stars.
1936 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1937 Note that, when `org-odd-levels-only' is set, level corresponds to
1938 order in hierarchy, not to the number of stars.
1940 Each element of this list generates a set of possible targets.
1941 The union of these sets is presented (with completion) to
1942 the user by `org-refile'.
1944 You can set the variable `org-refile-target-verify-function' to a function
1945 to verify each headline found by the simple criteria above.
1947 When this variable is nil, all top-level headlines in the current buffer
1948 are used, equivalent to the value `((nil . (:level . 1))'."
1964 "Function to verify if the headline at point should be a refile target.
1965 The function will be called without arguments, with point at the
1966 beginning of the headline. It should return t and leave point
1967 where it is if the headline is a valid target for refiling.
1969 If the target should not be selected, the function must return nil.
1970 In addition to this, it may move point to a place from where the search
1971 should be continued. For example, the function may decide that the entire
1972 subtree of the current entry should be excluded and move point to the end
1973 of the subtree."
1978 "Non-nil means cache refile targets to speed up the process.
1979 The cache for a particular file will be updated automatically when
1980 the buffer has been killed, or when any of the marker used for flagging
1981 refile targets no longer points at a live buffer.
1982 If you have added new entries to a buffer that might themselves be targets,
1983 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1984 find that easier, `C-u C-u C-u C-c C-w'."
1989 "Non-nil means provide refile targets as paths.
1990 So a level 3 headline will be available as level1/level2/level3.
1992 When the value is `file', also include the file name (without directory)
1993 into the path. In this case, you can also stop the completion after
1994 the file name, to get entries inserted as top level in the file.
1996 When `full-file-path', include the full file path."
2005 "Non-nil means complete the outline path in hierarchical steps.
2006 When Org-mode uses the refile interface to select an outline path
2007 \(see variable `org-refile-use-outline-path'), the completion of
2008 the path can be done is a single go, or if can be done in steps down
2009 the headline hierarchy. Going in steps is probably the best if you
2010 do not use a special completion package like `ido' or `icicles'.
2011 However, when using these packages, going in one step can be very
2012 fast, while still showing the whole path to the entry."
2017 "Non-nil means allow to create new nodes as refile targets.
2019 of an existing node. When the value of this variable is `confirm',
2020 new node creation must be confirmed by the user (recommended)
2021 When nil, the completion must match an existing entry.
2023 Note that, if the new heading is not seen by the criteria
2024 listed in `org-refile-targets', multiple instances of the same
2025 heading would be created by trying again to file under the new
2026 heading."
2034 "Non-nil means also refile active region within a subtree.
2036 By default `org-refile' doesn't allow refiling regions if they
2037 don't contain a set of subtrees, but it might be convenient to
2038 do so sometimes: in that case, the first line of the region is
2039 converted to a headline before refiling."
2044 "Options concerning TODO items in Org-mode."
2049 "Options concerning Progress logging in Org-mode."
2056 "The available interpretation symbols for customizing `org-todo-keywords'.
2060 "List of TODO entry keyword sequences and their interpretation.
2063 Each sequence starts with a symbol, either `sequence' or `type',
2064 indicating if the keywords should be interpreted as a sequence of
2065 action steps, or as different types of TODO items. The first
2066 keywords are states requiring action - these states will select a headline
2067 for inclusion into the global TODO list Org-mode produces. If one of
2070 the last keyword is treated as the only DONE state of the sequence.
2073 additional state where no keyword is present. For details about this
2074 cycling, see the manual.
2076 TODO keywords and interpretation can also be set on a per-file basis with
2077 the special #+SEQ_TODO and #+TYP_TODO lines.
2079 Each keyword can optionally specify a character for fast state selection
2080 \(in combination with the variable `org-use-fast-todo-selection')
2081 and specifiers for state change logging, using the same syntax
2084 indicates to record a time stamp each time this state is selected.
2086 Each keyword may also specify if a timestamp or a note should be
2087 recorded when entering or leaving the state, by adding additional
2088 characters in the parenthesis after the keyword. This looks like this:
2090 record only the time of the state change. With X and Y being either
2092 Y when leaving the state if and only if the *target* state does not
2093 define X. You may omit any of the fast-selection key or X or /Y,
2094 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2096 For backward compatibility, this variable may also be just a list
2097 of keywords - in this case the interpretation (sequence or type) will be
2098 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2108 ;;Quick and dirty way to see
2109 ;;`org-todo-interpretations'. This takes the
2110 ;;place of item arguments
2111 :convert-widget
2118 org-todo-interpretation-widgets))
2119 widget))
2150 "Controls how TODO keywords are interpreted.
2151 This variable is in principle obsolete and is only used for
2152 backward compatibility, if the interpretation of todo keywords is
2153 not given already in `org-todo-keywords'. See that variable for
2154 more information."
2161 "Non-nil means use the fast todo selection scheme with C-c C-t.
2162 This variable describes if and under what circumstances the cycling
2163 mechanism for TODO keywords will be replaced by a single-key, direct
2164 selection scheme.
2166 When nil, fast selection is never used.
2168 When the symbol `prefix', it will be used when `org-todo' is called with
2169 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2170 in an agenda buffer.
2172 When t, fast selection is used by default. In this case, the prefix
2173 argument forces cycling instead.
2175 In all cases, the special interface is only used if access keys have actually
2176 been assigned by the user, i.e. if keywords in the configuration are followed
2177 by a letter in parenthesis, like TODO(t)."
2185 "Non-nil means update todo statistics after insert and toggle.
2186 ALL-HEADLINES means update todo statistics by including headlines
2187 with no TODO keyword as well, counting them as not done.
2188 A list of TODO keywords means the same, but skip keywords that are
2189 not in this list.
2191 When this is set, todo statistics is updated in the parent of the
2192 current entry each time a todo state is changed."
2202 "Non-nil means TODO statistics covers just direct children.
2203 When nil, all entries in the subtree are considered.
2204 This has only an effect if `org-provide-todo-statistics' is set.
2205 To set this to nil for only a single subtree, use a COOKIE_DATA
2211 "Hook which is run after the state of a TODO item was changed.
2212 The new state (a string with a TODO keyword, or nil) is available in the
2213 Lisp variable `state'."
2218 "Hook for functions that are allowed to block a state change.
2220 Each function gets as its single argument a property list, see
2221 `org-trigger-hook' for more information about this list.
2223 If any of the functions in this hook returns nil, the state change
2227 "Hook for functions that are triggered by a state change.
2229 Each function gets as its single argument a property list with at least
2230 the following elements:
2232 (:type type-of-change :position pos-at-entry-start
2233 :from old-state :to new-state)
2235 Depending on the type, more properties may be present.
2237 This mechanism is currently implemented for:
2239 TODO state changes
2240 ------------------
2241 :type todo-state-change
2242 :from previous state (keyword as a string), or nil, or a symbol
2243 'todo' or 'done', to indicate the general type of state.
2247 "Non-nil means undone TODO entries will block switching the parent to DONE.
2248 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2249 be blocked if any prior sibling is not yet done.
2250 Finally, if the parent is blocked because of ordered siblings of its own,
2251 the child will also be blocked."
2263 "Non-nil means unchecked boxes will block switching the parent to DONE.
2264 When this is nil, checkboxes have no influence on switching TODO states.
2265 When non-nil, you first need to check off all check boxes before the TODO
2266 entry can be switched to DONE.
2267 This variable needs to be set before org.el is loaded, and you need to
2268 restart Emacs after a change to make the change effective. The only way
2269 to change is while Emacs is running is through the customize interface."
2281 "Non-nil means inserting a TODO heading is treated as state change.
2283 logging will apply if appropriate. When nil, the new TODO item will
2284 be inserted directly, and no logging will take place."
2289 "Non-nil means switching TODO states with S-cursor counts as state change.
2290 This is the default behavior. However, setting this to nil allows a
2291 convenient way to select a TODO state and bypass any logging associated
2292 with that."
2297 "Tag changes that should be triggered by TODO state changes.
2298 This is a list. Each entry is
2300 (state-change (tag . flag) .......)
2302 State-change can be a string with a state, and empty string to indicate the
2303 state that has no TODO keyword, or it can be one of the symbols `todo'
2304 or `done', meaning any not-done or done state, respectively."
2318 "Information to record when a task moves to the DONE state.
2320 Possible values are:
2322 nil Don't add anything, just change the keyword
2323 time Add a time stamp to the task
2324 note Prompt for a note and add it with template `org-log-note-headings'
2326 This option can also be set with on a per-file-basis with
2328 #+STARTUP: nologdone
2329 #+STARTUP: logdone
2330 #+STARTUP: lognotedone
2332 You can have local logging settings for a subtree by setting the LOGGING
2333 property to one or more of these keywords."
2341 ;; Normalize old uses of org-log-done.
2348 "Information to record when the scheduling date of a tasks is modified.
2350 Possible values are:
2352 nil Don't add anything, just change the date
2353 time Add a time stamp to the task
2354 note Prompt for a note and add it with template `org-log-note-headings'
2356 This option can also be set with on a per-file-basis with
2358 #+STARTUP: nologreschedule
2359 #+STARTUP: logreschedule
2360 #+STARTUP: lognotereschedule"
2369 "Information to record when the deadline date of a tasks is modified.
2371 Possible values are:
2373 nil Don't add anything, just change the date
2374 time Add a time stamp to the task
2375 note Prompt for a note and add it with template `org-log-note-headings'
2377 This option can also be set with on a per-file-basis with
2379 #+STARTUP: nologredeadline
2380 #+STARTUP: logredeadline
2381 #+STARTUP: lognoteredeadline
2383 You can have local logging settings for a subtree by setting the LOGGING
2384 property to one or more of these keywords."
2393 "Non-nil means record a note when clocking out of an item.
2394 This can also be configured on a per-file basis by adding one of
2395 the following lines anywhere in the buffer:
2397 #+STARTUP: lognoteclock-out
2398 #+STARTUP: nolognoteclock-out"
2404 "Non-nil means the CLOSED time stamp will contain date and time.
2405 When nil, only the date will be recorded."
2419 "Headings for notes added to entries.
2420 The value is an alist, with the car being a symbol indicating the note
2421 context, and the cdr is the heading to be used. The heading may also be the
2422 empty string.
2423 %t in the heading will be replaced by a time stamp.
2424 %T will be an active time stamp instead the default inactive one
2425 %d will be replaced by a short-format time stamp.
2426 %D will be replaced by an active short-format time stamp.
2427 %s will be replaced by the new TODO state, in double quotes.
2428 %S will be replaced by the old TODO state, in double quotes.
2429 %u will be replaced by the user name.
2430 %U will be replaced by the full user name.
2432 In fact, it is not a good idea to change the `state' entry, because
2433 agenda log mode depends on the format of these entries."
2439 "Heading when changing todo state (todo sequence only)"
2453 "Non-nil means insert state change notes and time stamps into a drawer.
2454 When nil, state changes notes will be inserted after the headline and
2455 any scheduling and clock lines, but not inside a drawer.
2457 The value of this variable should be the name of the drawer to use.
2458 LOGBOOK is proposed as the default drawer for this purpose, you can
2459 also set this to a string to define the drawer of your choice.
2463 If this variable is set, `org-log-state-notes-insert-after-drawers'
2464 will be ignored.
2466 You can set the property LOG_INTO_DRAWER to overrule this setting for
2467 a subtree."
2479 "Return the value of `org-log-into-drawer', but let properties overrule.
2480 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2481 used instead of the default value."
2489 "Non-nil means insert state change notes after any drawers in entry.
2490 Only the drawers that *immediately* follow the headline and the
2491 deadline/scheduled line are skipped.
2492 When nil, insert notes right after the heading and perhaps the line
2493 with deadline/scheduling if present.
2495 This variable will have no effect if `org-log-into-drawer' is
2496 set."
2502 "Non-nil means the latest state note will be directly after heading.
2503 When nil, the state change notes will be ordered according to time."
2509 "The TODO state to which a repeater should return the repeating task.
2510 By default this is the first task in a TODO sequence, or the previous state
2511 in a TODO_TYP set. But you can specify another task here.
2512 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2518 "Non-nil means record moving through the DONE state when triggering repeat.
2519 An auto-repeating task is immediately switched back to TODO when
2522 record a closing note, there will be no record of the task moving
2523 through DONE. This variable forces taking a note anyway.
2525 nil Don't force a record
2526 time Record a time stamp
2527 note Record a note
2529 This option can also be set with on a per-file-basis with
2531 #+STARTUP: logrepeat
2532 #+STARTUP: lognoterepeat
2533 #+STARTUP: nologrepeat
2535 You can have local logging settings for a subtree by setting the LOGGING
2536 property to one or more of these keywords."
2546 "Priorities in Org-mode."
2551 "Non-nil means priority commands are active.
2552 When nil, these commands will be disabled, so that you never accidentally
2553 set a priority."
2558 "The highest priority of TODO items. A character like ?A, ?B etc.
2559 Must have a smaller ASCII number than `org-lowest-priority'."
2564 "The lowest priority of TODO items. A character like ?A, ?B etc.
2565 Must have a larger ASCII number than `org-highest-priority'."
2570 "The default priority of TODO items.
2571 This is the priority an item gets if no explicit priority is given.
2572 When starting to cycle on an empty priority the first step in the cycle
2573 depends on `org-priority-start-cycle-with-default'. The resulting first
2574 step priority must not exceed the range from `org-highest-priority' to
2575 `org-lowest-priority' which means that `org-default-priority' has to be
2576 in this range exclusive or inclusive the range boundaries. Else the
2577 first step refuses to set the default and the second will fall back
2578 to (depending on the command used) the highest or lowest priority."
2583 "Non-nil means start with default priority when starting to cycle.
2584 When this is nil, the first step in the cycle will be (depending on the
2585 command used) one higher or lower than the default priority.
2586 See also `org-default-priority'."
2591 "Function to extract the priority from a string.
2592 The string is normally the headline. If this is nil Org computes the
2593 priority from the priority cookie like [#A] in the headline. It returns
2594 an integer, increasing by 1000 for each priority level.
2595 The user can set a different function here, which should take a string
2596 as an argument and return the numeric priority."
2601 "Options concerning time stamps and deadlines in Org-mode."
2606 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2607 When nil, these labeled time stamps are forces into the second line of an
2608 entry, just after the headline. When scheduling from the global TODO list,
2609 the time stamp will always be forced into the second line."
2614 "Formats for `format-time-string' which are used for time stamps.
2618 "Number of minutes to round time stamps to.
2619 These are two values, the first applies when first creating a time stamp.
2620 The second applies when changing it with the commands `S-up' and `S-down'.
2621 When changing the time stamp, this means that it will change in steps
2622 of N minutes, as given by the second value.
2624 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2625 numbers should be factors of 60, so for example 5, 10, 15.
2627 When this is larger than 1, you can still force an exact time stamp by using
2628 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2629 and by using a prefix arg to `S-up/down' to specify the exact number
2630 of minutes to shift."
2640 ;; Normalize old customizations of this variable.
2644 org-time-stamp-rounding-minutes)))
2647 "Non-nil means overlay custom formats over all time stamps.
2648 The formats are defined through the variable `org-time-stamp-custom-formats'.
2649 To turn this on on a per-file basis, insert anywhere in the file:
2650 #+STARTUP: customtime"
2658 "Custom formats for time stamps. See `format-time-string' for the syntax.
2659 These are overlaid over the default ISO format if the variable
2660 `org-display-custom-times' is set. Time like %H:%M should be at the
2661 end of the second format. The custom formats are also honored by export
2662 commands, if custom time display is turned on at the time of export."
2667 "Get the right format for a time string."
2672 f)))
2675 "The format string used when creating CLOCKSUM lines.
2676 This is also used when org-mode generates a time duration."
2682 org-mode generates a time duration."
2687 "The format string used when creating CLOCKSUM lines, or when
2688 org-mode generates a time duration."
2693 "No. of days before expiration during which a deadline becomes active.
2694 This variable governs the display in sparse trees and in the agenda.
2695 When 0 or negative, it means use this number (the absolute value of it)
2696 even if a deadline has a different individual lead time specified.
2698 Custom commands can set this variable in the options section."
2704 "Non-nil means assume future for incomplete date input from user.
2705 This affects the following situations:
2706 1. The user gives a month but not a year.
2709 2. The user gives a day, but no month.
2712 it will be considered as *this* month.
2714 If you set this variable to the symbol `time', then also the following
2715 will work:
2717 3. If the user gives a time, but no day. If the time is before now,
2718 to will be interpreted as tomorrow.
2720 Currently none of this works for ISO week specifications.
2722 When this option is nil, the current day, month and year will always be
2723 used as defaults.
2725 See also `org-agenda-jump-prefer-future'."
2733 "Should the agenda jump command prefer the future for incomplete dates?
2734 The default is to do the same as configured in `org-read-date-prefer-future'.
2735 But you can also set a deviating value here.
2736 This may t or nil, or the symbol `org-read-date-prefer-future'."
2741 org-read-date-prefer-future)
2746 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2748 Depending on the system Emacs is running on, certain dates cannot
2749 be represented with the type used internally to represent time.
2750 Dates between 1970-1-1 and 2038-1-1 can always be represented
2751 correctly. Some systems allow for earlier dates, some for later,
2752 some for both. One way to find out it to insert any date into an
2753 Org buffer, putting the cursor on the year and hitting S-up and
2754 S-down to test the range.
2756 When this variable is set to t, the date/time prompt will not let
2757 you specify dates outside the 1970-2037 range, so it is certain that
2758 these dates will work in whatever version of Emacs you are
2759 running, and also that you can move a file from one Emacs implementation
2760 to another. WHenever Org is forcing the year for you, it will display
2761 a message and beep.
2763 When this variable is nil, Org will check if the date is
2764 representable in the specific Emacs implementation you are using.
2765 If not, it will force a year, usually the current year, and beep
2766 to remind you. Currently this setting is not recommended because
2767 the likelihood that you will open your Org files in an Emacs that
2768 has limited date range is not negligible.
2770 A workaround for this problem is to use diary sexp dates for time
2771 stamps outside of this range."
2776 "Non-nil means display current interpretation of date prompt live.
2777 This display will be in an overlay, in the minibuffer."
2782 "Non-nil means pop up a calendar when prompting for a date.
2783 In the calendar, the date can be selected with mouse-1. However, the
2784 minibuffer will also be active, and you can simply enter the date as well.
2785 When nil, only the minibuffer will be available."
2793 "Hook to be used to set up keys for the date/time interface.
2794 Add key definitions to `minibuffer-local-map', which will be a temporary
2795 copy."
2800 "The hour when your day really ends. Must be an integer.
2801 This has influence for the following applications:
2803 the time given here, the day recognized as TODAY is actually yesterday.
2804 - When a date is read from the user and it is still before the time given
2805 here, the current date and time will be assumed to be yesterday, 23:59.
2806 Also, timestamps inserted in remember templates follow this rule.
2808 IMPORTANT: This is a feature whose implementation is and likely will
2809 remain incomplete. Really, it is only here because past midnight seems to
2810 be the favorite working time of John Wiegley :-)"
2815 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2816 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2818 23:59 of the previous day."
2823 "Non-nil means S-down will increase the time in a time stamp.
2824 When nil, S-up will increase."
2829 "Non-nil means make the calendar window follow timestamp changes.
2830 When a timestamp is modified and the calendar window is visible, it will be
2831 moved to the new date."
2836 "Options concerning tags in Org-mode."
2841 "List of tags allowed in Org-mode files.
2842 When this list is nil, Org-mode will base TAG input on what is already in the
2843 buffer.
2844 The value of this variable is an alist, the car of each entry must be a
2845 keyword as a string, the cdr may be a character that is used to select
2846 that tag through the fast-tag-selection interface.
2847 See the manual for details."
2862 "List of tags that will always appear in all Org-mode files.
2863 This is in addition to any in buffer settings or customizations
2864 of `org-tag-alist'.
2865 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2866 The value of this variable is an alist, the car of each entry must be a
2867 keyword as a string, the cdr may be a character that is used to select
2868 that tag through the fast-tag-selection interface.
2869 See the manual for details.
2870 To disable these tags on a per-file basis, insert anywhere in the file:
2871 #+STARTUP: noptag"
2882 "If non-nil, always offer completion for all tags of all agenda files.
2883 Instead of customizing this variable directly, you might want to
2884 set it locally for capture buffers, because there no list of
2885 tags in that file can be created dynamically (there are none).
2887 (add-hook 'org-capture-mode-hook
2888 (lambda ()
2889 (set (make-local-variable
2890 'org-complete-tags-always-offer-all-agenda-tags)
2891 t)))"
2896 "List of tags that can be inherited by all entries in the file.
2897 The tags will be inherited if the variable `org-use-tag-inheritance'
2898 says they should be.
2902 "Non-nil means use fast tag selection scheme.
2903 This is a special interface to select and deselect tags with single keys.
2904 When nil, fast selection is never used.
2905 When the symbol `auto', fast selection is used if and only if selection
2906 characters for tags have been configured, either through the variable
2907 `org-tag-alist' or through a #+TAGS line in the buffer.
2908 When t, fast selection is always used and selection keys are assigned
2909 automatically if necessary."
2917 "Non-nil means fast tag selection exits after first change.
2918 When nil, you have to press RET to exit it.
2919 During fast tag selection, you can toggle this flag with `C-c'.
2920 This variable can also have the value `expert'. In this case, the window
2921 displaying the tags menu is not even shown, until you press C-c again."
2929 "Non-nil means fast tags selection interface will also offer TODO states.
2933 "The column to which tags should be indented in a headline.
2934 If this number is positive, it specifies the column. If it is negative,
2935 it means that the tags should be flushright to that column. For example,
2936 -80 works well for a normal 80 character screen.
2937 When 0, place tags directly after headline text, with only one space in
2938 between."
2943 "Non-nil keeps tags aligned when modifying headlines.
2944 Some operations (i.e. demoting) change the length of a headline and
2945 therefore shift the tags around. With this option turned on, after
2946 each such operation the tags are again aligned to `org-tags-column'."
2951 "Non-nil means tags in levels apply also for sublevels.
2952 When nil, only the tags directly given in a specific line apply there.
2953 This may also be a list of tags that should be inherited, or a regexp that
2954 matches tags that should be inherited. Additional control is possible
2955 with the variable `org-tags-exclude-from-inheritance' which gives an
2956 explicit list of tags to be excluded from inheritance., even if the value of
2957 `org-use-tag-inheritance' would select it for inheritance.
2959 If this option is t, a match early-on in a tree can lead to a large
2960 number of matches in the subtree when constructing the agenda or creating
2961 a sparse tree. If you only want to see the first match in a tree during
2962 a search, check out the variable `org-tags-match-list-sublevels'."
2971 "List of tags that should never be inherited.
2972 This is a way to exclude a few tags from inheritance. For way to do
2973 the opposite, to actively allow inheritance for selected tags,
2974 see the variable `org-use-tag-inheritance'."
2979 "Check if TAG is one that should be inherited."
2991 "Non-nil means list also sublevels of headlines matching a search.
2992 This variable applies to tags/property searches, and also to stuck
2993 projects because this search is based on a tags match as well.
2995 When set to the symbol `indented', sublevels are indented with
2996 leading dots.
2998 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2999 the sublevels of a headline matching a tag search often also match
3000 the same search. Listing all of them can create very long lists.
3001 Setting this variable to nil causes subtrees of a match to be skipped.
3003 This variable is semi-obsolete and probably should always be true. It
3004 is better to limit inheritance to certain tags using the variables
3005 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3013 "When set, tags are sorted using this function as a comparator."
3029 "Options concerning properties in Org-mode."
3034 "How property key/value pairs should be formatted by `indent-line'.
3035 When `indent-line' hits a property definition, it will format the line
3036 according to this format, mainly to make sure that the values are
3037 lined-up with respect to each other."
3042 "Alist of properties and functions to adjust inserted values.
3043 Elements of this alist must be of the form
3045 ([string] [function])
3047 where [string] must be a property name and [function] must be a
3048 lambda expression: this lambda expression must take one argument,
3049 the value to adjust, and return the new value as a string.
3053 and the clock summary:
3056 (let ((clocksum (org-clock-sum-current-item))
3057 (effort (org-duration-string-to-minutes
3059 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3064 "Non-nil means properties apply also for sublevels.
3066 This setting is chiefly used during property searches. Turning it on can
3067 cause significant overhead when doing a search, which is why it is not
3068 on by default.
3070 When nil, only the properties directly given in the current entry count.
3071 When t, every property is inherited. The value may also be a list of
3072 properties that should have inheritance, or a regular expression matching
3073 properties that should be inherited.
3075 However, note that some special properties use inheritance under special
3076 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3078 for valid values of a property.
3080 Note for programmers:
3081 When querying an entry with `org-entry-get', you can control if inheritance
3082 should be used. By default, `org-entry-get' looks only at the local
3083 properties. You can request inheritance by setting the inherit argument
3084 to t (to force inheritance) or to `selective' (to respect the setting
3085 in this variable)."
3094 "Check if PROPERTY is one that should be inherited."
3105 "The default column format, if no other format has been defined.
3106 This variable can be set on the per-file basis by inserting a line
3108 #+COLUMNS: %25ITEM ....."
3113 "The ellipses to be used when a field in column view is truncated.
3114 When this is the empty string, as many characters as possible are shown,
3115 but then there will be no visual indication that the field has been truncated.
3116 When this is a string of length N, the last N characters of a truncated
3117 field are replaced by this string. If the column is narrower than the
3118 ellipses string, only part of the ellipses string will be shown."
3123 "Function that modifies values for display in column view.
3124 For example, it can be used to cut out a certain part from a time stamp.
3125 The function must take 2 arguments:
3127 column-title The title of the column (*not* the property name)
3128 value The value that should be modified.
3130 The function should return the value that should be displayed,
3131 or nil if the normal value should be used."
3136 "The property that is being used to keep track of effort estimates.
3137 Effort estimates given in this property need to have the format H:MM."
3145 "List of property/value pairs that can be inherited by any entry.
3147 These are fixed values, for the preset properties. The user variable
3148 that can be used to add to this list is `org-global-properties'.
3150 The entries in this list are cons cells where the car is a property
3151 name and cdr is a string with the value. If the value represents
3156 "List of property/value pairs that can be inherited by any entry.
3158 This list will be combined with the constant `org-global-properties-fixed'.
3160 The entries in this list are cons cells where the car is a property
3161 name and cdr is a string with the value.
3163 You can set buffer-local values for the same purpose in the variable
3164 `org-file-properties' this by adding lines like
3166 #+PROPERTY: NAME VALUE"
3173 "List of property/value pairs that can be inherited by any entry.
3174 Valid for the current buffer.
3179 "Options concerning agenda views in Org-mode."
3184 "Variable used by org files to set a category for agenda display.
3185 Such files should use a file variable to set it, for example
3189 or contain a special line
3191 #+CATEGORY: ELisp
3193 If the file does not specify a category, then file's base name
3199 "The files to be used for agenda display.
3203 If an entry is a directory, all files in that directory that are matched by
3204 `org-agenda-file-regexp' will be part of the file list.
3206 If the value of the variable is not a list but a single file name, then
3207 the list of agenda files is actually stored and maintained in that file, one
3208 agenda file per line. In this file paths can be given relative to
3209 `org-directory'. Tilde expansion and environment variable substitution
3210 are also made."
3217 "Regular expression to match files for `org-agenda-files'.
3218 If any element in the list in that variable contains a directory instead
3219 of a normal file, all files in that directory that are matched by this
3220 regular expression will be included."
3225 "List of extra files to be searched by text search commands.
3226 These files will be search in addition to the agenda files by the
3227 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3228 Note that these files will only be searched for text search commands,
3229 not for the other agenda views like todo lists, tag searches or the weekly
3230 agenda. This variable is intended to list notes and possibly archive files
3231 that should also be searched by these two commands.
3232 In fact, if the first element in the list is the symbol `agenda-archives',
3233 than all archive files of all agenda files will be added to the search
3234 scope."
3245 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3246 A nil value means to remove them, after a query, from the list."
3251 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3252 The command `org-calendar-goto-agenda' will be bound to this key. The
3253 default is the character `c' because then `c' can be used to switch back and
3254 forth between agenda and calendar."
3259 "The key to be installed in `calendar-mode-map' for agenda-action.
3260 The command `org-agenda-action' will be bound to this key. The
3261 default is the character `k' because we use the same key in the agenda."
3266 "The key to be installed in `calendar-mode-map' for adding diary entries.
3267 This option is irrelevant until `org-agenda-diary-file' has been configured
3268 to point to an Org-mode file. When that is the case, the command
3269 `org-agenda-diary-entry' will be bound to the key given here, by default
3270 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3271 if you want to continue doing this, you need to change this to a different
3272 key."
3277 "File to which to add new entries with the `i' key in agenda and calendar.
3278 When this is the symbol `diary-file', the functionality in the Emacs
3279 calendar will be used to add entries to the `diary-file'. But when this
3280 points to a file, `org-agenda-diary-entry' will be used instead."
3296 org-calendar-insert-diary-entry-key
3300 "Options for embedding LaTeX code into Org-mode."
3308 "Options for creating images from LaTeX fragments.
3309 This is a property list with the following properties:
3311 `default' means use the foreground of the default face.
3313 `default' means use the background of the default face.
3314 :scale a scaling factor for the size of the images, to get more pixels
3315 :html-foreground, :html-background, :html-scale
3316 the same numbers for HTML export.
3317 :matchers a list indicating which matchers should be used to
3318 find LaTeX fragments. Valid members of this list are:
3329 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3330 When nil, just push out a message."
3335 Use this to specify additional executable file say a jar file.
3337 When using MathToWeb as the converter, specify the full-path to
3338 your mathtoweb.jar file."
3345 "Command to convert LaTeX fragments to MathML.
3346 Replace format-specifiers in the command as noted below and use
3347 `shell-command' to convert LaTeX to MathML.
3348 %j: Executable file in fully expanded form as specified by
3349 `org-latex-to-mathml-jar-file'.
3350 %I: Input LaTeX file in fully expanded form
3351 %o: Output MathML file
3352 This command is used by `org-create-math-formula'.
3354 When using MathToWeb as the converter, set this to
3362 "Return t if `org-latex-to-mathml-convert-command' is usable."
3365 org-latex-to-mathml-convert-command)
3367 org-latex-to-mathml-convert-command))))
3372 t))))))
3379 \[PACKAGES]
3380 \[DEFAULT-PACKAGES]
3381 % The settings below are copied from fullpage.sty
3394 "The document header used for processing LaTeX fragments.
3395 It is imperative that this header make sure that no page number
3396 appears on the page. The package defined in the variables
3397 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3399 will be appended."
3406 "Set the packages alist and make sure it has 3 elements per entry."
3410 x))
3411 val)))
3415 "Get the packages alist and make sure it has 3 elements per entry."
3419 x))
3422 ;; The following variables are defined here because is it also used
3423 ;; when formatting latex fragments. Originally it was part of the
3424 ;; LaTeX exporter, which is why the name includes "export".
3441 )
3442 "Alist of default packages to be inserted in the header.
3443 Change this only if one of the packages here causes an incompatibility
3444 with another package you are using.
3445 The packages in this list are needed by one part or another of Org-mode
3446 to function properly.
3448 - inputenc, fontenc: for basic font and character selection
3449 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3450 for interpreting the entities in `org-entities'. You can skip some of these
3451 packages if you don't use any of the symbols in it.
3452 - graphicx: for including images
3453 - float, wrapfig: for figure placement
3454 - longtable: for long tables
3455 - hyperref: for cross references
3457 Therefore you should not modify this variable unless you know what you
3458 are doing. The one reason to change it anyway is that you might be loading
3459 some other package that conflicts with one of the default packages.
3461 If SNIPPET-FLAG is t, the package also needs to be included when
3462 compiling LaTeX snippets into images for inclusion into HTML."
3475 "Alist of packages to be inserted in every LaTeX header.
3476 These will be inserted after `org-export-latex-default-packages-alist'.
3478 SNIPPET-FLAG, when t, indicates that this package is also needed when
3479 turning LaTeX snippets into images for inclusion into HTML.
3480 Make sure that you only list packages here which:
3481 - you want in every file
3482 - do not conflict with the default packages in
3483 `org-export-latex-default-packages-alist'
3484 - do not conflict with the setup in `org-format-latex-header'."
3498 "Settings for Org-mode appearance."
3503 "Non-nil means fontify only the stars in each headline.
3504 When nil, the entire headline is fontified.
3505 Changing it requires restart of `font-lock-mode' to become effective
3506 also in regions already fontified."
3511 "Non-nil means hide the first N-1 stars in a headline.
3512 This works by using the face `org-hide' for these stars. This
3513 face is white for a light background, and black for a dark
3514 background. You may have to customize the face `org-hide' to
3515 make this work.
3516 Changing it requires restart of `font-lock-mode' to become effective
3517 also in regions already fontified.
3518 You may also set this on a per-file basis by adding one of the following
3519 lines to the buffer:
3521 #+STARTUP: hidestars
3522 #+STARTUP: showstars"
3527 "List of symbols corresponding to keywords to be hidden the org buffer.
3528 For example, a value '(title) for this list will make the document's title
3529 appear in the buffer without the initial #+TITLE: keyword."
3537 "Non-nil means change the face of a headline if it is marked DONE.
3538 Normally, only the TODO/DONE keyword indicates the state of a headline.
3539 When this is non-nil, the headline after the keyword is set to the
3540 `org-headline-done' as an additional indication."
3545 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3546 Changing this variable requires a restart of Emacs to take effect."
3551 "Non-nil means fontify the whole line for headings.
3552 This is useful when setting a background color for the
3553 org-level-* faces."
3558 "Non-nil means fontify what is treated specially by the exporters."
3563 "Non-nil mean font-lock should hide the emphasis marker characters."
3568 "Non-nil means show entities as UTF8 characters.
3574 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3579 "Regular expression for matching emphasis.
3580 After a match, the match groups contain these elements:
3581 0 The match of the full regular expression, including the characters
3582 before and after the proper match
3583 1 The character before the proper match, or empty at beginning of line
3584 2 The proper match, including the leading and trailing markers
3585 3 The leading marker like * or /, indicating the type of highlighting
3586 4 The text between the emphasis markers, not including the markers
3593 "Set variable and compute the emphasis regular expression."
3597 org-emphasis-alist org-emphasis-regexp-components)
3609 ;; make sure special characters appear at the right position in the class
3621 ;; Make the regexp
3629 body1
3641 body1
3649 "Components used to build the regular expression for emphasis.
3650 This is a list with five entries. Terminology: In an emphasis string
3654 specify what is allowed/forbidden in each part:
3656 pre Chars allowed as prematch. Beginning of line will be allowed too.
3657 post Chars allowed as postmatch. End of line will be allowed too.
3658 border The chars *forbidden* as border characters.
3660 non-shy groups here, and don't allow newline here.
3661 newline The maximum number of newlines allowed in an emphasis exp.
3663 Use customize to modify this, or restart Emacs after changing it."
3682 )
3683 "Special syntax for emphasized text.
3684 Text starting and ending with a special character will be emphasized, for
3685 example *bold*, _underlined_ and /italic/. This variable sets the marker
3686 characters, the face to be used by font-lock for highlighting in Org-mode
3687 Emacs buffers, and the HTML tags to be used for this.
3688 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3689 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3690 Use customize to modify this, or restart Emacs after changing it."
3705 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3708 ;;; Miscellaneous options
3711 "Completion in Org-mode."
3716 "Non-nil means use ido completion wherever possible.
3717 Note that `ido-mode' must be active for this variable to be relevant.
3718 If you decide to turn this variable on, you might well want to turn off
3719 `org-outline-path-complete-in-steps'.
3720 See also `org-completion-use-iswitchb'."
3725 "Non-nil means use iswitchb completion wherever possible.
3726 Note that `iswitchb-mode' must be active for this variable to be relevant.
3727 If you decide to turn this variable on, you might well want to turn off
3728 `org-outline-path-complete-in-steps'.
3729 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3735 Normal means, no org-mode-specific context."
3739 ;;; Functions and variables from their packages
3740 ;; Declared here to avoid compiler warnings
3742 ;; XEmacs only
3748 ;; Emacs only
3751 ;; Various packages
3770 org-agenda-format-item "org-agenda"
3801 ;;; Autoload and prepare some org modules
3803 ;; Some table stuff that needs to be defined here, because it is used
3804 ;; by the functions setting up org-mode or checking for table context.
3817 "Detect the first line outside a table when searching from within it.
3820 ;; Autoload the functions in org-table.el that are needed by functions here.
3825 org-table-convert org-table-convert-region org-table-copy-down
3826 org-table-copy-region org-table-create
3827 org-table-create-or-convert-from-region
3828 org-table-create-with-table.el org-table-current-dline
3829 org-table-cut-region org-table-delete-column org-table-edit-field
3830 org-table-edit-formulas org-table-end org-table-eval-formula
3831 org-table-export org-table-field-info
3832 org-table-get-stored-formulas org-table-goto-column
3833 org-table-hline-and-move org-table-import org-table-insert-column
3834 org-table-insert-hline org-table-insert-row org-table-iterate
3835 org-table-justify-field-maybe org-table-kill-row
3836 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3837 org-table-move-column org-table-move-column-left
3838 org-table-move-column-right org-table-move-row
3839 org-table-move-row-down org-table-move-row-up
3840 org-table-next-field org-table-next-row org-table-paste-rectangle
3841 org-table-previous-field org-table-recalculate
3842 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3843 org-table-toggle-coordinate-overlays
3844 org-table-toggle-formula-debugger org-table-wrap-region
3845 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3846 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3847 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3850 "Return t if the cursor is inside an org-type table.
3851 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3856 org-table-line-regexp)))
3857 nil))
3861 "Return t if and only if we are at a table.el table."
3867 "If there is a table.el table nearby, recognize it and move into it."
3873 nil
3883 t
3888 t)
3889 nil)
3890 nil))
3893 "Return t if the cursor is inside a hline in a table."
3898 nil))
3903 "Apply FUNCTION to the start of all tables in the buffer."
3919 ;; Declare and autoload functions from org-exp.el & Co
3927 org-insert-export-options-template
3928 org-table-clean-before-export))
3931 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3932 org-export-region-as-ascii))
3935 org-replace-region-by-latex org-export-region-as-latex
3936 org-export-as-latex org-export-as-pdf
3937 org-export-as-pdf-and-open))
3940 org-export-as-html-batch org-export-as-html-to-buffer
3941 org-replace-region-by-html org-export-region-as-html
3942 org-export-as-html))
3945 org-replace-region-by-docbook org-export-region-as-docbook
3946 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3947 org-export-as-docbook))
3950 org-export-icalendar-all-agenda-files
3951 org-export-icalendar-combine-agenda-files))
3955 ;; Declare and autoload functions from org-agenda.el
3960 org-todo-list org-tags-view org-agenda-list-stuck-projects
3961 org-diary org-agenda-to-appt
3962 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3964 ;; Autoload org-remember
3969 org-remember-apply-template org-remember org-remember-handler)))
3974 org-capture-import-remember-templates)))
3976 ;; Autoload org-clock.el
3991 "Return non-nil if clock is currently running.
3992 The return value is actually the clock marker."
3997 "org-clock"
3999 org-clock-goto org-clock-sum org-clock-display
4000 org-clock-remove-overlays org-clock-report
4001 org-clocktable-shift org-dblock-write:clocktable
4002 org-get-clocktable org-resolve-clocks)))
4005 "If this is a CLOCK line, update it and return t.
4006 Otherwise, return nil."
4015 ts te h m s neg)
4018 nil)
4023 ;; The clock is running here
4044 t))))))
4047 "Check if the current buffer contains the running clock.
4048 If yes, offer to stop it and to save the buffer with the changes."
4057 "Check if this line starts a clock table, if yes, shift the time block."
4061 ;; Autoload org-timer.el
4065 "org-timer"
4067 org-timer-change-times-in-region
4068 org-timer-set-timer
4069 org-timer-reset-timers
4070 org-timer-show-remaining-time)))
4072 ;; Autoload org-feed.el
4076 "org-feed"
4080 ;; Autoload org-indent.el
4082 ;; Define the variable already here, to make sure we have it.
4084 "Non-nil if Org-Indent mode is enabled.
4089 "org-indent"
4092 ;; Autoload org-mobile.el
4096 "org-mobile"
4099 ;; Autoload archiving code
4100 ;; The stuff that is needed for cycling and tags has to be defined here.
4103 "Options concerning archiving in Org-mode."
4108 "The location where subtrees should be archived.
4110 The value of this variable is a string, consisting of two parts,
4111 separated by a double-colon. The first part is a filename and
4112 the second part is a headline.
4114 When the filename is omitted, archiving happens in the same file.
4115 %s in the filename will be replaced by the current file
4116 name (without the directory part). Archiving to a different file
4117 is useful to keep archived entries from contributing to the
4118 Org-mode Agenda.
4120 The archived entries will be filed as subtrees of the specified
4121 headline. When the headline is omitted, the subtrees are simply
4122 filed away at the end of the file, as top-level entries. Also in
4123 the heading you can use %s to represent the file name, this can be
4124 useful when using the same archive for a number of different files.
4126 Here are a few examples:
4128 If the current file is Projects.org, archive in file
4129 Projects.org_archive, as top-level trees. This is the default.
4132 Archive in the current file, under the top-level headline
4136 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4139 Archive in file ~/org/archive.org (absolute path), under headlines
4143 Archive in file ./basement (relative path), as level 3 trees
4146 You may set this option on a per-file basis by adding to the buffer a
4147 line like
4149 #+ARCHIVE: basement::** Finished Tasks
4151 You may also define it locally for a subtree by setting an ARCHIVE property
4152 in the entry. If such a property is found in an entry, or anywhere up
4153 the hierarchy, it will be used."
4158 "The tag that marks a subtree as archived.
4159 An archived subtree does not open during visibility cycling, and does
4160 not contribute to the agenda listings.
4161 After changing this, font-lock must be restarted in the relevant buffers to
4162 get the proper fontification."
4168 "Non-nil means the agenda will skip any items located in archived trees.
4169 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4170 variable is no longer recommended, you should leave it at the value t.
4171 Instead, use the key `v' to cycle the archives-mode in the agenda."
4177 "Non-nil means ignore archived trees when creating column view."
4183 "Non-nil means `org-cycle' will open archived trees.
4184 An archived tree is a tree marked with the tag ARCHIVE.
4185 When nil, archived trees will stay folded. You can still open them with
4186 normal outline commands like `show-all', but not with the cycling commands."
4192 "Non-nil means sparse tree construction shows matches in archived trees.
4193 When nil, matches in these trees are highlighted, but the trees are kept in
4194 collapsed state."
4200 "Re-hide all archived subtrees after a visibility state change."
4211 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4214 "Cycle subtree even if it is archived."
4221 "Re-hide all archived subtrees after a visibility state change."
4236 flag)))
4243 org-archive-to-archive-sibling org-toggle-archive-tag
4244 org-archive-subtree-default
4245 org-archive-subtree-default-with-confirmation)))
4247 ;; Autoload Column View Code
4255 org-columns-compute org-agenda-columns org-columns-remove-overlays
4258 ;; Autoload ID code
4266 org-id-get-with-outline-path-completion
4267 org-id-get-with-outline-drilling org-id-store-link
4268 org-id-goto org-id-find org-id-store-link))
4270 ;; Autoload Plotting Code
4275 ;;; Variables for pre-computed regular expressions, all buffer local
4293 "Matches a headline and puts everything into groups:
4294 group 1: the stars
4295 group 2: The todo keyword, maybe
4296 group 3: Priority cookie
4297 group 4: True headline
4301 "Printf format to make regexp to match an exact headline.
4302 This regexp will match the headline of any node which has the
4303 exact headline text that is put into the format, but may have any
4307 "Matches a headline and puts TODO state into group 2 if present.
4356 "Regular expression to match a plain time or time range.
4357 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4358 groups carry important information:
4359 0 the full match
4360 1 the first time, range or not
4368 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4369 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4370 groups carry important information:
4371 0 the full match
4372 7 hours of duration
4381 "Regular expression to match a timestamp time or time range.
4382 After a match, the following groups carry important information:
4383 0 the full match
4384 1 date plus weekday, for back referencing to make sure both times are on the same day
4385 2 the first time, range or not
4440 "Variable associated with STARTUP options for org-mode.
4441 Each element is a list of three items: The startup options as written
4442 in the #+STARTUP line, the corresponding variable, and the value to
4443 set this variable to if the option is found. An optional forth element PUSH
4447 "Update PROPS with KEY and VAL."
4461 "Printf format for a regexp matching an headline with some keyword.
4462 This regexp will match the headline of any node which has the
4463 exact keyword that is put into the format. The keyword isn't in
4467 "Printf format for a regexp matching an headline, possibly with some keyword.
4468 This regexp can match any headline with the specified keyword, or
4469 without a keyword. The keyword isn't in any group by default,
4473 "Precompute regular expressions for current buffer."
4493 kwds kws0 kwsa key log value cat arch tags const links hw dws
4494 tail sep kws1 prio props ftags drawers beamer-p
4516 ;; general TODO-like setup
4528 links)))
4535 props))))
4540 ftags
4550 l var val)
4580 ;; search for property blocks
4589 props)))))))
4606 ;; Process the TODO keywords
4608 ;; Use the global values as if they had been given locally.
4620 kws)))
4623 kwsa nil
4626 ;; 1 2
4634 kw)
4636 kws0)
4653 ;; Process the constants
4661 ;; Process the tags.
4672 tgs))
4680 ;; Compute the regular expressions and other local variables.
4681 ;; Using `org-outline-regexp-bol' would complicate them much,
4682 ;; because of the fixed white space at the end of that string.
4690 org-drawer-regexp
4694 org-not-done-keywords
4696 org-todo-regexp
4700 org-not-done-regexp
4704 org-not-done-heading-regexp
4706 org-todo-line-regexp
4708 org-complex-heading-regexp
4715 org-complex-heading-regexp-format
4720 ;; Stats cookies can be stuck to body.
4727 org-todo-line-tags-regexp
4734 org-deadline-time-regexp
4736 org-deadline-line-regexp
4738 org-scheduled-regexp
4740 org-scheduled-time-regexp
4742 org-closed-time-regexp
4744 org-keyword-time-regexp
4750 org-keyword-time-not-clock-regexp
4756 org-maybe-keyword-time-regexp
4762 org-planning-or-clock-line-re
4767 org-all-time-keywords
4770 org-clock-string org-closed-string))
4771 )
4776 "Return the contents of FILE, as a string."
4790 "Extract the log state setting from a TODO keyword string.
4804 "Remove a pair of parenthesis at the end of each string in LIST."
4808 x))
4809 list))
4812 "Assign fast keys to a keyword-key alist.
4813 Respect keys that are already there."
4831 ;;; Some variables used in various places
4838 "Function to be called when `C-c C-c' is used.
4842 ;; FIXME: Occasionally check by commenting these, to make sure
4843 ;; no other functions uses these, forgetting to let-bind them.
4848 ;; Defined somewhere in this file, but used before definition.
4854 ;;;; Define the Org-mode
4857 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
4860 ;; We use a before-change function to check if a table might need
4861 ;; an update.
4863 "Indicates that a table might need an update.
4864 This variable is set by `org-before-change-function'.
4867 "Every change indicates that a table might need an update."
4877 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4878 ;; some places -- e.g. see the macro org-with-limited-levels.
4879 ;;
4880 ;; In Org buffers, the value of `outline-regexp' is that of
4881 ;; `org-outline-regexp'. The only function still directly relying on
4882 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4883 ;; job when `orgstruct-mode' is active.
4887 "Regexp to match Org headlines.
4888 This is similar to `org-outline-regexp' but additionally makes
4892 "Matches an headline, putting stars and text into groups.
4895 ;;;###autoload
4897 "Outline-based notes management and organizer, alias
4900 Org-mode develops organizational tasks around a NOTES file which
4901 contains information about projects as plain text. Org-mode is
4902 implemented on top of outline-mode, which is ideal to keep the content
4903 of large files well structured. It supports ToDo items, deadlines and
4904 time stamps, which magically appear in the diary listing of the Emacs
4905 calendar. Tables are easily created with a built-in table editor.
4906 Plain text URL-like links connect to websites, emails (VM), Usenet
4907 messages (Gnus), BBDB entries, and any files related to the project.
4908 For printing and sharing of notes, an Org-mode file (or a part of it)
4909 can be exported as a structured ASCII or HTML file.
4911 The following commands are available:
4915 ;; Get rid of Outline menus, they are not needed
4916 ;; Need to do this here because define-derived-mode sets up
4917 ;; the keymap so late. Still, it is a waste to call this each time
4918 ;; we switch another buffer into org-mode.
4921 ;; Assume this is Greg's port, it uses easymenu
4947 org-display-table 4
4950 org-ellipsis)))
4955 ;; tag faces set outside customize.... force initialization.
4957 ;; Calc embedded
4963 ;; Activate before-change-function
4967 ;; Check for running clock before killing a buffer
4969 ;; Paragraphs and auto-filling
4973 ;; Beginning/end of defun
4976 ;; Next error for sparse trees
4978 ;; Make sure dependence stuff works reliably, even for users who set it
4979 ;; too late :-(
4991 ;; Comment characters
4995 ;; Align options lines
4997 'align-mode-rules-list
5002 ;; Imenu
5006 ;; Make isearch reveal context
5009 ;; Emacs 21 and XEmacs make use of the hook
5011 ;; Emacs 22 deals with this through a special variable
5015 ;; Turn on org-beamer-mode?
5018 ;; Setup the pcomplete hooks
5031 ;; If empty file that did not turn on org-mode automatically, make it to.
5056 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5066 "Return today date, considering `org-extend-today-until'."
5071 ;;;; Font-Lock stuff, including the activators
5102 "Regular expression used to analyze links.
5103 Here is what the match groups contain after a match:
5104 1: http:
5105 2: http
5106 3: path
5107 4: [desc]
5115 "Number of stacked braces for sub/superscript matching.
5116 This has to be set before loading org.el to be effective."
5121 "Create a regular expression which will match a balanced sexp.
5122 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5123 as single character strings.
5124 The regexp returned will match the entire expression including the
5125 delimiters. It will also define a single group which contains the
5126 match except for the outermost delimiters. The maximum depth of
5127 stacked delimiters is N. Escaping delimiters is not possible."
5156 "Update the link regular expressions.
5157 This should be called after the variable `org-link-types' has changed."
5161 org-link-re-with-space
5167 org-link-re-with-space2
5173 org-link-re-with-space3
5178 org-angle-link-re
5184 org-plain-link-re
5188 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5189 org-bracket-link-regexp
5191 org-bracket-link-analytic-regexp
5199 org-bracket-link-analytic-regexp++
5207 org-any-link-re
5216 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5218 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5219 "Regular expression matching time strings for analysis.
5220 This one does not require the space after the date, so it can be used
5222 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5238 "Regular expression matching a time stamp or time stamp range.
5244 "Run through the buffer and add overlays to emphasized strings."
5253 'face
5266 rtn))
5269 "Insert or change an emphasis, i.e. a font like bold or italic.
5270 If there is an active region, change that region to a new emphasis.
5271 If there is no region, just insert the marker characters and position
5272 the cursor between them.
5273 CHAR should be either the marker character, or the first character of the
5274 HTML tag associated with that emphasis. If CHAR is a space, the means
5275 to remove the emphasis of the selected region.
5276 If char is not given (for example in an interactive call) it
5277 will be prompted for."
5328 "Run through the buffer and add overlays to links."
5337 nil
5343 t)))))
5351 t)))
5354 "When non-nil, fontify code in code blocks."
5365 "Fontify #+ lines and blocks, in the correct ways."
5368 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5369 limit t)
5377 end end1 quoting block-type ovl)
5380 ;; a single line of backend-specific content
5388 ; for backend-specific code
5389 t)
5391 ;; Truly a block
5403 beg end
5411 ;; remove old background overlays
5416 ;; add a background overlay
5430 t))
5443 ;; just any other in-buffer setting, but not indented
5447 t)
5455 t)
5463 "Strip protective commas between BEG and END in the current buffer."
5479 "Run through the buffer and add overlays to links."
5487 t)))
5490 "Run through the buffer and add overlays to footnotes."
5497 'keymap org-mouse-map
5498 'help-echo
5500 "Footnote definition"
5502 'font-lock-fontified t
5503 'font-lock-multiline t
5507 "Run through the buffer and add overlays to bracketed links."
5511 ;; FIXME: above we should remove the escapes.
5512 ;; but that requires another match, protecting match data,
5513 ;; a lot of overhead for font-lock.
5520 ;; We need to remove the invisible property here. Table narrowing
5521 ;; may have made some of this invisible.
5539 t)))
5542 "Run through the buffer and add overlays to dates."
5554 t)))
5563 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5567 "Run through the buffer and add overlays to target matches."
5575 'keymap org-mouse-map
5579 t)))))
5582 "Find all radio targets in this file and update the regular expression."
5597 t)))
5604 ;; This should be with the exporter code, but we also use if for font-locking
5614 "Compute regular expression for stuff treated specially by exporters."
5621 org-latex-regexps)))
5649 org-entities)))
5653 org-latex-entities)
5654 nil))
5656 ))
5657 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5660 org-export-html-special-string-regexps)))
5665 ))))
5667 'org-latex-and-specials-regexp
5672 "Run through the buffer and add overlays to links."
5676 limit t))
5690 rtn)))
5693 "Restart `font-lock-mode', to force refontification."
5699 "Return a list of all targets in this file.
5700 With optional argument RADIO, only find radio targets."
5702 rtn)
5707 rtn)))
5710 "Make regular expression matching all strings in TARGETS.
5711 The regular expression finds the targets also if there is a line break
5712 between words."
5721 x)
5722 targets
5734 t)))
5737 "Compute the outline level of the heading at point.
5738 This function assumes that the cursor is at the beginning of a line matched
5739 by `outline-regexp'. Otherwise it returns garbage.
5740 If this is called at a normal headline, the level is the number of stars.
5741 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5748 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5755 "Functions that can manipulate `org-font-lock-extra-keywords'.
5756 This is called after `org-font-lock-extra-keywords' is defined, but before
5757 it is installed to be used by font lock. This can be useful if something
5768 ;; Call the hook
5770 ;; Headlines
5777 ;; Table lines
5780 ;; Table internals
5785 ;; Drawers
5788 ;; Properties
5792 ;; Links
5802 ;; TODO keyword
5804 org-todo-regexp)
5806 ;; DONE
5814 nil)
5815 ;; Priorities
5817 ;; Tags
5819 ;; Special keywords
5824 ;; Emphasis
5829 ;; Checkboxes
5830 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5835 ;; Description list items
5838 ;; ARCHIVEd headings
5840 org-outline-regexp-bol
5843 ;; Specials
5847 ;; Code
5849 ;; COMMENT
5856 ;; Blocks and meta lines
5858 )))
5861 ;; Now set the full font-lock-keywords
5868 "Toggle the composition display of entities as UTF8 characters."
5880 "Find an entity to fontify."
5886 limit t)
5898 nil))))
5901 "Fontify string S like in Org-mode."
5913 "Get the right face for match N in font-lock matching of headlines."
5926 "Get the right face for a TODO keyword KWD.
5927 If KWD is a number, get the corresponding match group."
5935 "Create a face list that inherits INHERIT, but sets the foreground color.
5936 When FACE-OR-COLOR is not a string, just return it."
5940 face-or-color)
5941 face-or-color))
5944 "Add the special tag faces."
5953 "Add the special priority faces."
5960 org-priority-faces)))
5965 "Get the right face for a TODO keyword KWD.
5966 If KWD is a number, get the corresponding match group."
5973 "Remove fontification and activation overlays from links."
5978 deactivate-mark buffer-file-name buffer-file-truename)
5982 invisible t intangible t
5983 org-no-flyspell t org-emphasis t))
5993 "Remove specific display properties that have been added by font lock.
5994 The will remove the raise properties that are used to show superscripts
5995 and subscripts."
6005 "Add raise properties to sub/superscripts."
6009 org-match-substring-regexp
6010 org-match-substring-with-braces-regexp)
6011 limit t)
6021 ;; FIXME: Should we go back one character here, for a_b^c
6022 ;; (goto-char (1- pos)) ;????????????????????
6024 t
6026 'display
6042 t)))))
6044 ;;;; Visibility cycling, including org-goto and indirect buffer
6046 ;;; Cycling
6053 ;;;###autoload
6058 "TAB-action and visibility cycling for Org-mode.
6060 This is the command invoked in Org-mode by the TAB key. Its main purpose
6061 is outline visibility cycling, but it also invokes other actions
6062 in special contexts.
6064 - When this function is called with a prefix argument, rotate the entire
6065 buffer through 3 states (global cycling)
6066 1. OVERVIEW: Show only top-level headlines.
6067 2. CONTENTS: Show all headlines of all levels, but no body text.
6068 3. SHOW ALL: Show everything.
6069 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6070 determined by the variable `org-startup-folded', and by any VISIBILITY
6071 properties in the buffer.
6072 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6073 including any drawers.
6075 - When inside a table, re-align the table and move to the next field.
6077 - When point is at the beginning of a headline, rotate the subtree started
6078 by this line through 3 different states (local cycling)
6079 1. FOLDED: Only the main headline is shown.
6080 2. CHILDREN: The main headline and the direct children are shown.
6081 From this state, you can move to one of the children
6082 and zoom in further.
6083 3. SUBTREE: Show the entire subtree, including body text.
6084 If there is no subtree, switch directly from CHILDREN to FOLDED.
6086 - When point is at the beginning of an empty headline and the variable
6087 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6088 of the headline by demoting and promoting it to likely levels. This
6089 speeds up creation document structure by pressing TAB once or several
6090 times right after creating a new headline.
6092 - When there is a numeric prefix, go up to a heading with level ARG, do
6093 a `show-subtree' and return to the previous cursor position. If ARG
6094 is negative, go up that many levels.
6096 - When point is not at the beginning of a headline, execute the global
6097 binding for TAB, which is re-indenting the line. See the option
6098 `org-cycle-emulate-tab' for details.
6100 - Special case: if point is at the beginning of the buffer and there is
6101 no headline in line 1, this function will act as if called with prefix arg
6102 (C-u TAB, same as S-TAB) also when called without prefix arg.
6103 But only if also the variable `org-cycle-global-at-bob' is t."
6113 org-inlinetask-min-level
6118 limit-level)))
6121 outline-regexp
6129 org-cycle-hook))
6133 ;; special case: use global cycling
6147 ;; Table: enter it or move to the next field.
6158 ;; Global cycling: delegate to `org-cycle-internal-global'.
6161 ;; Drawers: delegate to `org-flag-drawer'.
6169 ;; Show-subtree, ARG levels up from here.
6177 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6185 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6192 ;; From there: TAB emulation and template completion.
6214 t
6223 "Do the global cycling action."
6227 ;; We just created the overview - now do table of contents
6228 ;; This can be slow in very large buffers, so indicate action
6238 ;; We just showed the table of contents - now show everything
6246 ;; Default action: go to overview
6254 "Do the local cycling action."
6256 ;; First, determine end of headline (EOH), end of subtree or item
6257 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6281 ;; Determine end invisible part of buffer (EOL)
6283 ;; XEmacs doesn't have `next-single-char-property-change'
6293 ;; Find out what to do next and set `this-command'
6296 ;; Nothing is hidden behind this heading
6308 org-cycle-skip-children-state-if-no-children))))
6309 ;; Entire subtree is hidden in one line: children view
6315 ;; FIXME: This slows down the func way too much.
6316 ;; How keep drawers hidden in subtree anyway?
6317 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6318 ;; (org-cycle-hide-drawers 'subtree))
6320 ;; Fold every list in subtree to top-level items.
6342 ;; We just showed the children, or no children are there,
6343 ;; now show everything.
6350 ;; Default action: hide the subtree.
6357 ;;;###autoload
6359 "Cycle the global visibility. For details see `org-cycle'.
6361 With a numeric prefix, show all headlines up to that level."
6377 "Set the visibility required by startup options and properties."
6392 "Switch subtree visibilities according to :VISIBILITY: property."
6399 nil t)
6423 ;; This function uses outline-regexp instead of the more fundamental
6424 ;; org-outline-regexp so that org-cycle-global works outside of Org
6425 ;; buffers, where outline-regexp is needed.
6427 "Switch to overview mode, showing only top-level headlines.
6428 Really, this shows all headlines with level equal or greater than the level
6429 of the first headline in the buffer. This is important, because if the
6430 first headline is not level one, then (hide-sublevels 1) gives confusing
6431 results."
6442 "Show all headlines in the buffer, like a table of contents.
6443 With numerical argument N, show content up to level N."
6446 ;; Visit all headings and show their offspring
6453 t)
6462 "Adjust the window after a change in outline visibility.
6463 This function is the default value of the hook `org-cycle-hook'."
6473 "Remove outline overlays that do not contain non-white stuff."
6483 "Fix visibility issues after moving a subtree."
6484 ;; First, find a reasonable region to look at:
6485 ;; Start two siblings above, end three below
6503 ;; Properly fold already folded siblings
6514 "Show empty lines above all visible headlines.
6515 The region to be covered depends on STATE when called through
6516 `org-cycle-hook'. Lisp program can use t for STATE to get the
6517 entire buffer covered. Note that an empty line is only shown if there
6518 are at least `org-cycle-separator-lines' empty lines before the headline."
6528 beg end b e)
6552 ;; Never hide empty lines at the end of the file.
6562 "Move to the parent and re-show empty lines before visible headlines."
6568 "Return `org-agenda-files' list, plus all open org-mode files.
6569 This is useful for operations that need to scan all of a user's
6570 open and agenda-wise Org files."
6578 files))
6581 "Return the beginning position of the current entry."
6585 "Return the end position of the current entry."
6589 "Re-hide all drawers after a visibility state change."
6615 "Is the end of the current subtree visible?"
6620 "Move cursor to the first headline and recenter the headline.
6621 Optional argument N means put the headline into the Nth line of the window."
6627 ;;; Saving and restoring visibility
6630 "Return a list of the locations of all outline overlays.
6631 These are overlays with the `invisible' property value `outline'.
6632 The return value is a list of cons cells, with start and stop
6633 positions for each overlay.
6634 If USE-MARKERS is set, return the positions as markers."
6652 "Create visibility overlays for all positions in DATA.
6653 DATA should have been made by `org-outline-overlay-data'."
6661 data)))))
6663 ;;; Folding of blocks
6670 "Call FUNCTION at the head of all source blocks in the current buffer.
6671 Optional arguments START and END can be used to limit the range."
6683 "Toggle the visibility of all blocks in the current buffer."
6687 "Fold all blocks in the current buffer."
6693 "Unfold all blocks in the current buffer."
6699 "Toggle visibility of block at point."
6710 "Toggle the visibility of the current block."
6717 ov)
6733 ;; make the block accessible to isearch
6735 ov 'isearch-open-invisible
6746 ;; org-tab-after-check-for-cycling-hook
6748 ;; Remove overlays when changing major mode
6753 ;;; Org-goto
6759 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6775 nil)
6776 (org-defkey map "q" 'org-goto-quit)
6777 (org-defkey map "n" 'outline-next-visible-heading)
6778 (org-defkey map "p" 'outline-previous-visible-heading)
6779 (org-defkey map "f" 'outline-forward-same-level)
6780 (org-defkey map "b" 'outline-backward-same-level)
6781 (org-defkey map "u" 'outline-up-heading))
6782 (org-defkey map "/" 'org-occur)
6783 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6784 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6785 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6786 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6787 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6788 map))
6790 (defconst org-goto-help
6791 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6792 RET=jump to location [Q]uit and return to previous location
6793 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6795 (defvar org-goto-start-pos) ; dynamically scoped parameter
6797 ;; FIXME: Docstring does not mention both interfaces
6798 (defun org-goto (&optional alternative-interface)
6799 "Look up a different location in the current file, keeping current visibility.
6801 When you want look-up or go to a different location in a document, the
6802 fastest way is often to fold the entire buffer and then dive into the tree.
6803 This method has the disadvantage, that the previous location will be folded,
6804 which may not be what you want.
6806 This command works around this by showing a copy of the current buffer
6807 in an indirect buffer, in overview mode. You can dive into the tree in
6808 that copy, use org-occur and incremental search to find a location.
6809 When pressing RET or `Q', the command returns to the original buffer in
6810 which the visibility is still unchanged. After RET it will also jump to
6811 the location selected in the indirect buffer and expose the headline
6812 hierarchy above."
6813 (interactive "P")
6814 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6815 (org-refile-use-outline-path t)
6816 (org-refile-target-verify-function nil)
6817 (interface
6818 (if (not alternative-interface)
6819 org-goto-interface
6820 (if (eq org-goto-interface 'outline)
6821 'outline-path-completion
6822 'outline)))
6823 (org-goto-start-pos (point))
6824 (selected-point
6825 (if (eq interface 'outline)
6826 (car (org-get-location (current-buffer) org-goto-help))
6827 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6828 (org-refile-check-position pa)
6829 (nth 3 pa)))))
6830 (if selected-point
6831 (progn
6832 (org-mark-ring-push org-goto-start-pos)
6833 (goto-char selected-point)
6834 (if (or (outline-invisible-p) (org-invisible-p2))
6835 (org-show-context 'org-goto)))
6836 (message "Quit"))))
6838 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6839 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6840 (defvar org-goto-local-auto-isearch-map) ; defined below
6842 (defun org-get-location (buf help)
6843 "Let the user select a location in the Org-mode buffer BUF.
6844 This function uses a recursive edit. It returns the selected position
6845 or nil."
6846 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6847 (isearch-hide-immediately nil)
6848 (isearch-search-fun-function
6849 (lambda () 'org-goto-local-search-headings))
6850 (org-goto-selected-point org-goto-exit-command)
6851 (pop-up-frames nil)
6852 (special-display-buffer-names nil)
6853 (special-display-regexps nil)
6854 (special-display-function nil))
6855 (save-excursion
6856 (save-window-excursion
6857 (delete-other-windows)
6858 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6859 (org-pop-to-buffer-same-window
6860 (condition-case nil
6861 (make-indirect-buffer (current-buffer) "*org-goto*")
6862 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6863 (with-output-to-temp-buffer "*Help*"
6864 (princ help))
6865 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6866 (setq buffer-read-only nil)
6867 (let ((org-startup-truncated t)
6868 (org-startup-folded nil)
6869 (org-startup-align-all-tables nil))
6870 (org-mode)
6871 (org-overview))
6872 (setq buffer-read-only t)
6873 (if (and (boundp 'org-goto-start-pos)
6874 (integer-or-marker-p org-goto-start-pos))
6875 (let ((org-show-hierarchy-above t)
6876 (org-show-siblings t)
6877 (org-show-following-heading t))
6878 (goto-char org-goto-start-pos)
6879 (and (outline-invisible-p) (org-show-context)))
6880 (goto-char (point-min)))
6881 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6882 (message "Select location and press RET")
6883 (use-local-map org-goto-map)
6884 (recursive-edit)
6885 ))
6886 (kill-buffer "*org-goto*")
6887 (cons org-goto-selected-point org-goto-exit-command)))
6889 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6890 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6891 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6892 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6894 (defun org-goto-local-search-headings (string bound noerror)
6895 "Search and make sure that any matches are in headlines."
6896 (catch 'return
6897 (while (if isearch-forward
6898 (search-forward string bound noerror)
6899 (search-backward string bound noerror))
6900 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6901 (and (member :headline context)
6902 (not (member :tags context))))
6903 (throw 'return (point))))))
6905 (defun org-goto-local-auto-isearch ()
6906 "Start isearch."
6907 (interactive)
6908 (goto-char (point-min))
6909 (let ((keys (this-command-keys)))
6910 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6911 (isearch-mode t)
6912 (isearch-process-search-char (string-to-char keys)))))
6914 (defun org-goto-ret (&optional arg)
6915 "Finish `org-goto' by going to the new location."
6916 (interactive "P")
6917 (setq org-goto-selected-point (point)
6918 org-goto-exit-command 'return)
6919 (throw 'exit nil))
6921 (defun org-goto-left ()
6922 "Finish `org-goto' by going to the new location."
6923 (interactive)
6924 (if (org-at-heading-p)
6925 (progn
6926 (beginning-of-line 1)
6927 (setq org-goto-selected-point (point)
6928 org-goto-exit-command 'left)
6929 (throw 'exit nil))
6930 (error "Not on a heading")))
6932 (defun org-goto-right ()
6933 "Finish `org-goto' by going to the new location."
6934 (interactive)
6935 (if (org-at-heading-p)
6936 (progn
6937 (setq org-goto-selected-point (point)
6938 org-goto-exit-command 'right)
6939 (throw 'exit nil))
6940 (error "Not on a heading")))
6942 (defun org-goto-quit ()
6943 "Finish `org-goto' without cursor motion."
6944 (interactive)
6945 (setq org-goto-selected-point nil)
6946 (setq org-goto-exit-command 'quit)
6947 (throw 'exit nil))
6949 ;;; Indirect buffer display of subtrees
6951 (defvar org-indirect-dedicated-frame nil
6952 "This is the frame being used for indirect tree display.")
6953 (defvar org-last-indirect-buffer nil)
6955 (defun org-tree-to-indirect-buffer (&optional arg)
6956 "Create indirect buffer and narrow it to current subtree.
6957 With numerical prefix ARG, go up to this level and then take that tree.
6958 If ARG is negative, go up that many levels.
6959 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6960 indirect buffer previously made with this command, to avoid proliferation of
6961 indirect buffers. However, when you call the command with a \
6963 when `org-indirect-buffer-display' is `new-frame', the last buffer
6964 is kept so that you can work with several indirect buffers at the same time.
6965 If `org-indirect-buffer-display' is `dedicated-frame', the \
6967 requests that a new frame be made for the new buffer, so that the dedicated
6968 frame is not changed."
6969 (interactive "P")
6970 (let ((cbuf (current-buffer))
6971 (cwin (selected-window))
6972 (pos (point))
6973 beg end level heading ibuf)
6974 (save-excursion
6975 (org-back-to-heading t)
6976 (when (numberp arg)
6977 (setq level (org-outline-level))
6978 (if (< arg 0) (setq arg (+ level arg)))
6979 (while (> (setq level (org-outline-level)) arg)
6980 (outline-up-heading 1 t)))
6981 (setq beg (point)
6982 heading (org-get-heading))
6983 (org-end-of-subtree t t)
6984 (if (org-at-heading-p) (backward-char 1))
6985 (setq end (point)))
6986 (if (and (buffer-live-p org-last-indirect-buffer)
6987 (not (eq org-indirect-buffer-display 'new-frame))
6988 (not arg))
6989 (kill-buffer org-last-indirect-buffer))
6990 (setq ibuf (org-get-indirect-buffer cbuf)
6991 org-last-indirect-buffer ibuf)
6992 (cond
6993 ((or (eq org-indirect-buffer-display 'new-frame)
6994 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6995 (select-frame (make-frame))
6996 (delete-other-windows)
6997 (org-pop-to-buffer-same-window ibuf)
6998 (org-set-frame-title heading))
6999 ((eq org-indirect-buffer-display 'dedicated-frame)
7000 (raise-frame
7001 (select-frame (or (and org-indirect-dedicated-frame
7002 (frame-live-p org-indirect-dedicated-frame)
7003 org-indirect-dedicated-frame)
7004 (setq org-indirect-dedicated-frame (make-frame)))))
7005 (delete-other-windows)
7006 (org-pop-to-buffer-same-window ibuf)
7007 (org-set-frame-title (concat "Indirect: " heading)))
7008 ((eq org-indirect-buffer-display 'current-window)
7009 (org-pop-to-buffer-same-window ibuf))
7010 ((eq org-indirect-buffer-display 'other-window)
7011 (pop-to-buffer ibuf))
7012 (t (error "Invalid value")))
7013 (if (featurep 'xemacs)
7014 (save-excursion (org-mode) (turn-on-font-lock)))
7015 (narrow-to-region beg end)
7016 (show-all)
7017 (goto-char pos)
7018 (run-hook-with-args 'org-cycle-hook 'all)
7019 (and (window-live-p cwin) (select-window cwin))))
7021 (defun org-get-indirect-buffer (&optional buffer)
7022 (setq buffer (or buffer (current-buffer)))
7023 (let ((n 1) (base (buffer-name buffer)) bname)
7024 (while (buffer-live-p
7025 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7026 (setq n (1+ n)))
7027 (condition-case nil
7028 (make-indirect-buffer buffer bname 'clone)
7029 (error (make-indirect-buffer buffer bname)))))
7031 (defun org-set-frame-title (title)
7032 "Set the title of the current frame to the string TITLE."
7033 ;; FIXME: how to name a single frame in XEmacs???
7034 (unless (featurep 'xemacs)
7035 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7037 ;;;; Structure editing
7039 ;;; Inserting headlines
7041 (defun org-previous-line-empty-p ()
7042 (save-excursion
7043 (and (not (bobp))
7044 (or (beginning-of-line 0) t)
7045 (save-match-data
7048 (defun org-insert-heading (&optional force-heading invisible-ok)
7049 "Insert a new heading or item with same depth at point.
7050 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7051 If point is at the beginning of a headline, insert a sibling before the
7052 current headline. If point is not at the beginning, split the line,
7053 create the new headline with the text in the current line after point
7054 \(but see also the variable `org-M-RET-may-split-line').
7056 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7057 This is important for non-interactive uses of the command."
7058 (interactive "P")
7059 (if (or (= (buffer-size) 0)
7060 (and (not (save-excursion
7061 (and (ignore-errors (org-back-to-heading invisible-ok))
7062 (org-at-heading-p))))
7063 (or force-heading (not (org-in-item-p)))))
7064 (progn
7066 (run-hooks 'org-insert-heading-hook))
7067 (when (or force-heading (not (org-insert-item)))
7068 (let* ((empty-line-p nil)
7069 (level nil)
7070 (on-heading (org-at-heading-p))
7071 (head (save-excursion
7072 (condition-case nil
7073 (progn
7074 (org-back-to-heading invisible-ok)
7075 (when (and (not on-heading)
7076 (featurep 'org-inlinetask)
7077 (integerp org-inlinetask-min-level)
7078 (>= (length (match-string 0))
7079 org-inlinetask-min-level))
7080 ;; Find a heading level before the inline task
7081 (while (and (setq level (org-up-heading-safe))
7082 (>= level org-inlinetask-min-level)))
7083 (if (org-at-heading-p)
7084 (org-back-to-heading invisible-ok)
7085 (error "This should not happen")))
7086 (setq empty-line-p (org-previous-line-empty-p))
7087 (match-string 0))
7088 (error "*"))))
7089 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7090 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7091 pos hide-previous previous-pos)
7092 (cond
7093 ((and (org-at-heading-p) (bolp)
7094 (or (bobp)
7095 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7096 ;; insert before the current line
7097 (open-line (if blank 2 1)))
7098 ((and (bolp)
7099 (not org-insert-heading-respect-content)
7100 (or (bobp)
7101 (save-excursion
7102 (backward-char 1) (not (outline-invisible-p)))))
7103 ;; insert right here
7104 nil)
7105 (t
7106 ;; somewhere in the line
7107 (save-excursion
7108 (setq previous-pos (point-at-bol))
7109 (end-of-line)
7110 (setq hide-previous (outline-invisible-p)))
7111 (and org-insert-heading-respect-content (org-show-subtree))
7112 (let ((split
7113 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7114 (save-excursion
7115 (let ((p (point)))
7116 (goto-char (point-at-bol))
7117 (and (looking-at org-complex-heading-regexp)
7118 (match-beginning 4)
7119 (> p (match-beginning 4)))))))
7120 tags pos)
7121 (cond
7122 (org-insert-heading-respect-content
7123 (org-end-of-subtree nil t)
7124 (when (featurep 'org-inlinetask)
7125 (while (and (not (eobp))
7127 (>= (length (match-string 1))
7128 org-inlinetask-min-level))
7129 (org-end-of-subtree nil t)))
7130 (or (bolp) (newline))
7131 (or (org-previous-line-empty-p)
7132 (and blank (newline)))
7133 (open-line 1))
7134 ((org-at-heading-p)
7135 (when hide-previous
7136 (show-children)
7137 (org-show-entry))
7139 (setq tags (and (match-end 2) (match-string 2)))
7140 (and (match-end 1)
7141 (delete-region (match-beginning 1) (match-end 1)))
7142 (setq pos (point-at-bol))
7143 (or split (end-of-line 1))
7144 (delete-horizontal-space)
7146 (buffer-substring (point-at-bol) (point)))
7147 (insert " "))
7148 (newline (if blank 2 1))
7149 (when tags
7150 (save-excursion
7151 (goto-char pos)
7152 (end-of-line 1)
7153 (insert " " tags)
7154 (org-set-tags nil 'align))))
7155 (t
7156 (or split (end-of-line 1))
7157 (newline (if blank 2 1)))))))
7158 (insert head) (just-one-space)
7159 (setq pos (point))
7160 (end-of-line 1)
7161 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7162 (when (and org-insert-heading-respect-content hide-previous)
7163 (save-excursion
7164 (goto-char previous-pos)
7165 (hide-subtree)))
7166 (run-hooks 'org-insert-heading-hook)))))
7168 (defun org-get-heading (&optional no-tags no-todo)
7169 "Return the heading of the current entry, without the stars.
7170 When NO-TAGS is non-nil, don't include tags.
7171 When NO-TODO is non-nil, don't include TODO keywords."
7172 (save-excursion
7173 (org-back-to-heading t)
7174 (cond
7175 ((and no-tags no-todo)
7176 (looking-at org-complex-heading-regexp)
7177 (match-string 4))
7178 (no-tags
7179 (looking-at (concat org-outline-regexp
7182 (match-string 1))
7183 (no-todo
7184 (looking-at org-todo-line-regexp)
7185 (match-string 3))
7186 (t (looking-at org-heading-regexp)
7187 (match-string 2)))))
7189 (defun org-heading-components ()
7190 "Return the components of the current heading.
7191 This is a list with the following elements:
7192 - the level as an integer
7193 - the reduced level, different if `org-odd-levels-only' is set.
7194 - the TODO keyword, or nil
7195 - the priority character, like ?A, or nil if no priority is given
7196 - the headline text itself, or the tags string if no headline text
7197 - the tags string, or nil."
7198 (save-excursion
7199 (org-back-to-heading t)
7200 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7201 (list (length (match-string 1))
7202 (org-reduced-level (length (match-string 1)))
7203 (org-match-string-no-properties 2)
7204 (and (match-end 3) (aref (match-string 3) 2))
7205 (org-match-string-no-properties 4)
7206 (org-match-string-no-properties 5)))))
7208 (defun org-get-entry ()
7209 "Get the entry text, after heading, entire subtree."
7210 (save-excursion
7211 (org-back-to-heading t)
7212 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7214 (defun org-insert-heading-after-current ()
7215 "Insert a new heading with same level as current, after current subtree."
7216 (interactive)
7217 (org-back-to-heading)
7218 (org-insert-heading)
7219 (org-move-subtree-down)
7220 (end-of-line 1))
7222 (defun org-insert-heading-respect-content ()
7223 (interactive)
7224 (let ((org-insert-heading-respect-content t))
7225 (org-insert-heading t)))
7227 (defun org-insert-todo-heading-respect-content (&optional force-state)
7228 (interactive "P")
7229 (let ((org-insert-heading-respect-content t))
7230 (org-insert-todo-heading force-state t)))
7232 (defun org-insert-todo-heading (arg &optional force-heading)
7233 "Insert a new heading with the same level and TODO state as current heading.
7234 If the heading has no TODO state, or if the state is DONE, use the first
7235 state (TODO by default). Also with prefix arg, force first state."
7236 (interactive "P")
7237 (when (or force-heading (not (org-insert-item 'checkbox)))
7238 (org-insert-heading force-heading)
7239 (save-excursion
7240 (org-back-to-heading)
7241 (outline-previous-heading)
7242 (looking-at org-todo-line-regexp))
7243 (let*
7244 ((new-mark-x
7245 (if (or arg
7246 (not (match-beginning 2))
7247 (member (match-string 2) org-done-keywords))
7248 (car org-todo-keywords-1)
7249 (match-string 2)))
7250 (new-mark
7251 (or
7252 (run-hook-with-args-until-success
7253 'org-todo-get-default-hook new-mark-x nil)
7254 new-mark-x)))
7255 (beginning-of-line 1)
7256 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7257 (if org-treat-insert-todo-heading-as-state-change
7258 (org-todo new-mark)
7259 (insert new-mark " "))))
7260 (when org-provide-todo-statistics
7261 (org-update-parent-todo-statistics))))
7263 (defun org-insert-subheading (arg)
7264 "Insert a new subheading and demote it.
7265 Works for outline headings and for plain lists alike."
7266 (interactive "P")
7267 (org-insert-heading arg)
7268 (cond
7269 ((org-at-heading-p) (org-do-demote))
7270 ((org-at-item-p) (org-indent-item))))
7272 (defun org-insert-todo-subheading (arg)
7273 "Insert a new subheading with TODO keyword or checkbox and demote it.
7274 Works for outline headings and for plain lists alike."
7275 (interactive "P")
7276 (org-insert-todo-heading arg)
7277 (cond
7278 ((org-at-heading-p) (org-do-demote))
7279 ((org-at-item-p) (org-indent-item))))
7281 ;;; Promotion and Demotion
7283 (defvar org-after-demote-entry-hook nil
7284 "Hook run after an entry has been demoted.
7285 The cursor will be at the beginning of the entry.
7286 When a subtree is being demoted, the hook will be called for each node.")
7288 (defvar org-after-promote-entry-hook nil
7289 "Hook run after an entry has been promoted.
7290 The cursor will be at the beginning of the entry.
7291 When a subtree is being promoted, the hook will be called for each node.")
7293 (defun org-promote-subtree ()
7294 "Promote the entire subtree.
7295 See also `org-promote'."
7296 (interactive)
7297 (save-excursion
7298 (org-with-limited-levels (org-map-tree 'org-promote)))
7299 (org-fix-position-after-promote))
7301 (defun org-demote-subtree ()
7302 "Demote the entire subtree. See `org-demote'.
7303 See also `org-promote'."
7304 (interactive)
7305 (save-excursion
7306 (org-with-limited-levels (org-map-tree 'org-demote)))
7307 (org-fix-position-after-promote))
7310 (defun org-do-promote ()
7311 "Promote the current heading higher up the tree.
7312 If the region is active in `transient-mark-mode', promote all headings
7313 in the region."
7314 (interactive)
7315 (save-excursion
7316 (if (org-region-active-p)
7317 (org-map-region 'org-promote (region-beginning) (region-end))
7318 (org-promote)))
7319 (org-fix-position-after-promote))
7321 (defun org-do-demote ()
7322 "Demote the current heading lower down the tree.
7323 If the region is active in `transient-mark-mode', demote all headings
7324 in the region."
7325 (interactive)
7326 (save-excursion
7327 (if (org-region-active-p)
7328 (org-map-region 'org-demote (region-beginning) (region-end))
7329 (org-demote)))
7330 (org-fix-position-after-promote))
7332 (defun org-fix-position-after-promote ()
7333 "Make sure that after pro/demotion cursor position is right."
7334 (let ((pos (point)))
7335 (when (save-excursion
7336 (beginning-of-line 1)
7337 (looking-at org-todo-line-regexp)
7338 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7339 (cond ((eobp) (insert " "))
7340 ((eolp) (insert " "))
7341 ((equal (char-after) ?\ ) (forward-char 1))))))
7343 (defun org-current-level ()
7344 "Return the level of the current entry, or nil if before the first headline.
7345 The level is the number of stars at the beginning of the headline."
7346 (save-excursion
7347 (org-with-limited-levels
7348 (if (ignore-errors (org-back-to-heading t))
7349 (funcall outline-level)))))
7351 (defun org-get-previous-line-level ()
7352 "Return the outline depth of the last headline before the current line.
7353 Returns 0 for the first headline in the buffer, and nil if before the
7354 first headline."
7355 (let ((current-level (org-current-level))
7356 (prev-level (when (> (line-number-at-pos) 1)
7357 (save-excursion
7358 (beginning-of-line 0)
7359 (org-current-level)))))
7360 (cond ((null current-level) nil) ; Before first headline
7361 ((null prev-level) 0) ; At first headline
7362 (prev-level))))
7364 (defun org-reduced-level (l)
7365 "Compute the effective level of a heading.
7366 This takes into account the setting of `org-odd-levels-only'."
7367 (cond
7368 ((zerop l) 0)
7369 (org-odd-levels-only (1+ (floor (/ l 2))))
7370 (t l)))
7372 (defun org-level-increment ()
7373 "Return the number of stars that will be added or removed at a
7374 time to headlines when structure editing, based on the value of
7375 `org-odd-levels-only'."
7376 (if org-odd-levels-only 2 1))
7378 (defun org-get-valid-level (level &optional change)
7379 "Rectify a level change under the influence of `org-odd-levels-only'
7380 LEVEL is a current level, CHANGE is by how much the level should be
7381 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7382 even level numbers will become the next higher odd number."
7383 (if org-odd-levels-only
7384 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7385 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7386 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7387 (max 1 (+ level (or change 0)))))
7389 (if (boundp 'define-obsolete-function-alias)
7390 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7391 (define-obsolete-function-alias 'org-get-legal-level
7392 'org-get-valid-level)
7393 (define-obsolete-function-alias 'org-get-legal-level
7394 'org-get-valid-level "23.1")))
7396 (defun org-promote ()
7397 "Promote the current heading higher up the tree.
7398 If the region is active in `transient-mark-mode', promote all headings
7399 in the region."
7400 (org-back-to-heading t)
7401 (let* ((level (save-match-data (funcall outline-level)))
7402 (after-change-functions (remove 'flyspell-after-change-function
7403 after-change-functions))
7404 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7405 (diff (abs (- level (length up-head) -1))))
7406 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7407 (replace-match up-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-promote-entry-hook)))
7413 (defun org-demote ()
7414 "Demote the current heading lower down the tree.
7415 If the region is active in `transient-mark-mode', demote all headings
7416 in the region."
7417 (org-back-to-heading t)
7418 (let* ((level (save-match-data (funcall outline-level)))
7419 (after-change-functions (remove 'flyspell-after-change-function
7420 after-change-functions))
7421 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7422 (diff (abs (- level (length down-head) -1))))
7423 (replace-match down-head nil t)
7424 ;; Fixup tag positioning
7425 (and org-auto-align-tags (org-set-tags nil t))
7426 (if org-adapt-indentation (org-fixup-indentation diff))
7427 (run-hooks 'org-after-demote-entry-hook)))
7429 (defun org-cycle-level ()
7430 "Cycle the level of an empty headline through possible states.
7431 This goes first to child, then to parent, level, then up the hierarchy.
7432 After top level, it switches back to sibling level."
7433 (interactive)
7434 (let ((org-adapt-indentation nil))
7435 (when (org-point-at-end-of-empty-headline)
7436 (setq this-command 'org-cycle-level) ; Only needed for caching
7437 (let ((cur-level (org-current-level))
7438 (prev-level (org-get-previous-line-level)))
7439 (cond
7440 ;; If first headline in file, promote to top-level.
7441 ((= prev-level 0)
7442 (loop repeat (/ (- cur-level 1) (org-level-increment))
7443 do (org-do-promote)))
7444 ;; If same level as prev, demote one.
7445 ((= prev-level cur-level)
7446 (org-do-demote))
7447 ;; If parent is top-level, promote to top level if not already.
7448 ((= prev-level 1)
7449 (loop repeat (/ (- cur-level 1) (org-level-increment))
7450 do (org-do-promote)))
7451 ;; If top-level, return to prev-level.
7452 ((= cur-level 1)
7453 (loop repeat (/ (- prev-level 1) (org-level-increment))
7454 do (org-do-demote)))
7455 ;; If less than prev-level, promote one.
7456 ((< cur-level prev-level)
7457 (org-do-promote))
7458 ;; If deeper than prev-level, promote until higher than
7459 ;; prev-level.
7460 ((> cur-level prev-level)
7461 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7462 do (org-do-promote))))
7463 t))))
7465 (defun org-map-tree (fun)
7466 "Call FUN for every heading underneath the current one."
7467 (org-back-to-heading)
7468 (let ((level (funcall outline-level)))
7469 (save-excursion
7470 (funcall fun)
7471 (while (and (progn
7472 (outline-next-heading)
7473 (> (funcall outline-level) level))
7474 (not (eobp)))
7475 (funcall fun)))))
7477 (defun org-map-region (fun beg end)
7478 "Call FUN for every heading between BEG and END."
7479 (let ((org-ignore-region t))
7480 (save-excursion
7481 (setq end (copy-marker end))
7482 (goto-char beg)
7483 (if (and (re-search-forward org-outline-regexp-bol nil t)
7484 (< (point) end))
7485 (funcall fun))
7486 (while (and (progn
7487 (outline-next-heading)
7488 (< (point) end))
7489 (not (eobp)))
7490 (funcall fun)))))
7492 (defvar org-property-end-re) ; silence byte-compiler
7493 (defun org-fixup-indentation (diff)
7494 "Change the indentation in the current entry by DIFF.
7495 However, if any line in the current entry has no indentation, or if it
7496 would end up with no indentation after the change, nothing at all is done."
7497 (save-excursion
7498 (let ((end (save-excursion (outline-next-heading)
7499 (point-marker)))
7500 (prohibit (if (> diff 0)
7503 col)
7504 (unless (save-excursion (end-of-line 1)
7505 (re-search-forward prohibit end t))
7506 (while (and (< (point) end)
7508 (goto-char (match-end 0))
7509 (setq col (current-column))
7510 (if (< diff 0) (replace-match ""))
7511 (org-indent-to-column (+ diff col))))
7512 (move-marker end nil))))
7514 (defun org-convert-to-odd-levels ()
7515 "Convert an org-mode file with all levels allowed to one with odd levels.
7516 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7517 level 5 etc."
7518 (interactive)
7519 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7520 (let ((outline-level 'org-outline-level)
7521 (org-odd-levels-only nil) n)
7522 (save-excursion
7523 (goto-char (point-min))
7525 (setq n (- (length (match-string 0)) 2))
7526 (while (>= (setq n (1- n)) 0)
7527 (org-demote))
7528 (end-of-line 1))))))
7530 (defun org-convert-to-oddeven-levels ()
7531 "Convert an org-mode file with only odd levels to one with odd/even levels.
7532 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7533 file contains a section with an even level, conversion would
7534 destroy the structure of the file. An error is signaled in this
7535 case."
7536 (interactive)
7537 (goto-char (point-min))
7538 ;; First check if there are no even levels
7540 (org-show-context t)
7541 (error "Not all levels are odd in this file. Conversion not possible"))
7542 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7543 (let ((outline-regexp org-outline-regexp)
7544 (outline-level 'org-outline-level)
7545 (org-odd-levels-only nil) n)
7546 (save-excursion
7547 (goto-char (point-min))
7549 (setq n (/ (1- (length (match-string 0))) 2))
7550 (while (>= (setq n (1- n)) 0)
7551 (org-promote))
7552 (end-of-line 1))))))
7554 (defun org-tr-level (n)
7555 "Make N odd if required."
7556 (if org-odd-levels-only (1+ (/ n 2)) n))
7558 ;;; Vertical tree motion, cutting and pasting of subtrees
7560 (defun org-move-subtree-up (&optional arg)
7561 "Move the current subtree up past ARG headlines of the same level."
7562 (interactive "p")
7563 (org-move-subtree-down (- (prefix-numeric-value arg))))
7565 (defun org-move-subtree-down (&optional arg)
7566 "Move the current subtree down past ARG headlines of the same level."
7567 (interactive "p")
7568 (setq arg (prefix-numeric-value arg))
7569 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7570 'org-get-last-sibling))
7571 (ins-point (make-marker))
7572 (cnt (abs arg))
7573 (col (current-column))
7574 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7575 ;; Select the tree
7576 (org-back-to-heading)
7577 (setq beg0 (point))
7578 (save-excursion
7579 (setq ne-beg (org-back-over-empty-lines))
7580 (setq beg (point)))
7581 (save-match-data
7582 (save-excursion (outline-end-of-heading)
7583 (setq folded (outline-invisible-p)))
7584 (outline-end-of-subtree))
7585 (outline-next-heading)
7586 (setq ne-end (org-back-over-empty-lines))
7587 (setq end (point))
7588 (goto-char beg0)
7589 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7590 ;; include less whitespace
7591 (save-excursion
7592 (goto-char beg)
7593 (forward-line (- ne-beg ne-end))
7594 (setq beg (point))))
7595 ;; Find insertion point, with error handling
7596 (while (> cnt 0)
7597 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7598 (progn (goto-char beg0)
7599 (error "Cannot move past superior level or buffer limit")))
7600 (setq cnt (1- cnt)))
7601 (if (> arg 0)
7602 ;; Moving forward - still need to move over subtree
7603 (progn (org-end-of-subtree t t)
7604 (save-excursion
7605 (org-back-over-empty-lines)
7606 (or (bolp) (newline)))))
7607 (setq ne-ins (org-back-over-empty-lines))
7608 (move-marker ins-point (point))
7609 (setq txt (buffer-substring beg end))
7610 (org-save-markers-in-region beg end)
7611 (delete-region beg end)
7612 (org-remove-empty-overlays-at beg)
7613 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7614 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7616 (let ((bbb (point)))
7617 (insert-before-markers txt)
7618 (org-reinstall-markers-in-region bbb)
7619 (move-marker ins-point bbb))
7621 (setq ins-end (point))
7622 (goto-char ins-point)
7623 (org-skip-whitespace)
7624 (when (and (< arg 0)
7625 (org-first-sibling-p)
7626 (> ne-ins ne-beg))
7627 ;; Move whitespace back to beginning
7628 (save-excursion
7629 (goto-char ins-end)
7630 (let ((kill-whole-line t))
7631 (kill-line (- ne-ins ne-beg)) (point)))
7633 (move-marker ins-point nil)
7634 (if folded
7635 (hide-subtree)
7636 (org-show-entry)
7637 (show-children)
7638 (org-cycle-hide-drawers 'children))
7639 (org-clean-visibility-after-subtree-move)
7640 ;; move back to the initial column we were at
7641 (move-to-column col)))
7643 (defvar org-subtree-clip ""
7644 "Clipboard for cut and paste of subtrees.
7645 This is actually only a copy of the kill, because we use the normal kill
7646 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7648 (defvar org-subtree-clip-folded nil
7649 "Was the last copied subtree folded?
7650 This is used to fold the tree back after pasting.")
7652 (defun org-cut-subtree (&optional n)
7653 "Cut the current subtree into the clipboard.
7654 With prefix arg N, cut this many sequential subtrees.
7655 This is a short-hand for marking the subtree and then cutting it."
7656 (interactive "p")
7657 (org-copy-subtree n 'cut))
7659 (defun org-copy-subtree (&optional n cut force-store-markers)
7660 "Cut the current subtree into the clipboard.
7661 With prefix arg N, cut this many sequential subtrees.
7662 This is a short-hand for marking the subtree and then copying it.
7663 If CUT is non-nil, actually cut the subtree.
7664 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7665 of some markers in the region, even if CUT is non-nil. This is
7666 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7667 (interactive "p")
7668 (let (beg end folded (beg0 (point)))
7669 (if (org-called-interactively-p 'any)
7670 (org-back-to-heading nil) ; take what looks like a subtree
7671 (org-back-to-heading t)) ; take what is really there
7672 (org-back-over-empty-lines)
7673 (setq beg (point))
7675 (save-match-data
7676 (save-excursion (outline-end-of-heading)
7677 (setq folded (outline-invisible-p)))
7678 (condition-case nil
7679 (org-forward-same-level (1- n) t)
7680 (error nil))
7681 (org-end-of-subtree t t))
7682 (org-back-over-empty-lines)
7683 (setq end (point))
7684 (goto-char beg0)
7685 (when (> end beg)
7686 (setq org-subtree-clip-folded folded)
7687 (when (or cut force-store-markers)
7688 (org-save-markers-in-region beg end))
7689 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7690 (setq org-subtree-clip (current-kill 0))
7691 (message "%s: Subtree(s) with %d characters"
7692 (if cut "Cut" "Copied")
7693 (length org-subtree-clip)))))
7695 (defun org-paste-subtree (&optional level tree for-yank)
7696 "Paste the clipboard as a subtree, with modification of headline level.
7697 The entire subtree is promoted or demoted in order to match a new headline
7698 level.
7700 If the cursor is at the beginning of a headline, the same level as
7701 that headline is used to paste the tree
7703 If not, the new level is derived from the *visible* headings
7704 before and after the insertion point, and taken to be the inferior headline
7705 level of the two. So if the previous visible heading is level 3 and the
7706 next is level 4 (or vice versa), level 4 will be used for insertion.
7707 This makes sure that the subtree remains an independent subtree and does
7708 not swallow low level entries.
7710 You can also force a different level, either by using a numeric prefix
7711 argument, or by inserting the heading marker by hand. For example, if the
7714 If optional TREE is given, use this text instead of the kill ring.
7716 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7717 move back over whitespace before inserting, and move point to the end of
7718 the inserted text when done."
7719 (interactive "P")
7720 (setq tree (or tree (and kill-ring (current-kill 0))))
7721 (unless (org-kill-is-subtree-p tree)
7722 (error "%s"
7723 (substitute-command-keys
7725 (org-with-limited-levels
7726 (let* ((visp (not (outline-invisible-p)))
7727 (txt tree)
7729 (old-level (if (string-match org-outline-regexp-bol txt)
7730 (- (match-end 0) (match-beginning 0) 1)
7731 -1))
7732 (force-level (cond (level (prefix-numeric-value level))
7734 (string-match
7736 (point-at-bol) (point))))
7737 (- (match-end 1) (match-beginning 1)))
7738 ((and (bolp)
7739 (looking-at org-outline-regexp))
7740 (- (match-end 0) (point) 1))
7741 (t nil)))
7742 (previous-level (save-excursion
7743 (condition-case nil
7744 (progn
7745 (outline-previous-visible-heading 1)
7746 (if (looking-at ^re_)
7747 (- (match-end 0) (match-beginning 0) 1)
7748 1))
7749 (error 1))))
7750 (next-level (save-excursion
7751 (condition-case nil
7752 (progn
7753 (or (looking-at org-outline-regexp)
7754 (outline-next-visible-heading 1))
7755 (if (looking-at ^re_)
7756 (- (match-end 0) (match-beginning 0) 1)
7757 1))
7758 (error 1))))
7759 (new-level (or force-level (max previous-level next-level)))
7760 (shift (if (or (= old-level -1)
7761 (= new-level -1)
7762 (= old-level new-level))
7763 0
7764 (- new-level old-level)))
7765 (delta (if (> shift 0) -1 1))
7766 (func (if (> shift 0) 'org-demote 'org-promote))
7767 (org-odd-levels-only nil)
7768 beg end newend)
7769 ;; Remove the forced level indicator
7770 (if force-level
7771 (delete-region (point-at-bol) (point)))
7772 ;; Paste
7773 (beginning-of-line (if (bolp) 1 2))
7774 (unless for-yank (org-back-over-empty-lines))
7775 (setq beg (point))
7776 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7777 (insert-before-markers txt)
7779 (setq newend (point))
7780 (org-reinstall-markers-in-region beg)
7781 (setq end (point))
7782 (goto-char beg)
7784 (setq beg (point))
7785 (if (and (outline-invisible-p) visp)
7786 (save-excursion (outline-show-heading)))
7787 ;; Shift if necessary
7788 (unless (= shift 0)
7789 (save-restriction
7790 (narrow-to-region beg end)
7791 (while (not (= shift 0))
7792 (org-map-region func (point-min) (point-max))
7793 (setq shift (+ delta shift)))
7794 (goto-char (point-min))
7795 (setq newend (point-max))))
7796 (when (or (org-called-interactively-p 'interactive) for-yank)
7797 (message "Clipboard pasted as level %d subtree" new-level))
7798 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7799 kill-ring
7800 (eq org-subtree-clip (current-kill 0))
7801 org-subtree-clip-folded)
7802 ;; The tree was folded before it was killed/copied
7803 (hide-subtree))
7804 (and for-yank (goto-char newend)))))
7806 (defun org-kill-is-subtree-p (&optional txt)
7807 "Check if the current kill is an outline subtree, or a set of trees.
7808 Returns nil if kill does not start with a headline, or if the first
7809 headline level is not the largest headline level in the tree.
7810 So this will actually accept several entries of equal levels as well,
7811 which is OK for `org-paste-subtree'.
7812 If optional TXT is given, check this string instead of the current kill."
7813 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7814 (re (org-get-limited-outline-regexp))
7815 (^re (concat "^" re))
7816 (start-level (and kill
7817 (string-match
7819 kill)
7820 (- (match-end 2) (match-beginning 2) 1)))
7821 (start (1+ (or (match-beginning 2) -1))))
7822 (if (not start-level)
7823 (progn
7824 nil) ;; does not even start with a heading
7825 (catch 'exit
7826 (while (setq start (string-match ^re kill (1+ start)))
7827 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7828 (throw 'exit nil)))
7829 t))))
7831 (defvar org-markers-to-move nil
7832 "Markers that should be moved with a cut-and-paste operation.
7833 Those markers are stored together with their positions relative to
7834 the start of the region.")
7836 (defun org-save-markers-in-region (beg end)
7837 "Check markers in region.
7838 If these markers are between BEG and END, record their position relative
7839 to BEG, so that after moving the block of text, we can put the markers back
7840 into place.
7841 This function gets called just before an entry or tree gets cut from the
7842 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7843 called immediately, to move the markers with the entries."
7844 (setq org-markers-to-move nil)
7845 (when (featurep 'org-clock)
7846 (org-clock-save-markers-for-cut-and-paste beg end))
7847 (when (featurep 'org-agenda)
7848 (org-agenda-save-markers-for-cut-and-paste beg end)))
7850 (defun org-check-and-save-marker (marker beg end)
7851 "Check if MARKER is between BEG and END.
7852 If yes, remember the marker and the distance to BEG."
7853 (when (and (marker-buffer marker)
7854 (equal (marker-buffer marker) (current-buffer)))
7855 (if (and (>= marker beg) (< marker end))
7856 (push (cons marker (- marker beg)) org-markers-to-move))))
7858 (defun org-reinstall-markers-in-region (beg)
7859 "Move all remembered markers to their position relative to BEG."
7860 (mapc (lambda (x)
7861 (move-marker (car x) (+ beg (cdr x))))
7862 org-markers-to-move)
7863 (setq org-markers-to-move nil))
7865 (defun org-narrow-to-subtree ()
7866 "Narrow buffer to the current subtree."
7867 (interactive)
7868 (save-excursion
7869 (save-match-data
7870 (org-with-limited-levels
7871 (narrow-to-region
7872 (progn (org-back-to-heading t) (point))
7873 (progn (org-end-of-subtree t t)
7874 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7875 (point)))))))
7877 (defun org-narrow-to-block ()
7878 "Narrow buffer to the current block."
7879 (interactive)
7880 (let* ((case-fold-search t)
7883 (if blockp
7884 (narrow-to-region (car blockp) (cdr blockp))
7885 (error "Not in a block"))))
7887 (eval-when-compile
7888 (defvar org-property-drawer-re))
7890 (defvar org-property-start-re) ;; defined below
7891 (defun org-clone-subtree-with-time-shift (n &optional shift)
7892 "Clone the task (subtree) at point N times.
7893 The clones will be inserted as siblings.
7895 In interactive use, the user will be prompted for the number of
7896 clones to be produced, and for a time SHIFT, which may be a
7897 repeater as used in time stamps, for example `+3d'.
7899 When a valid repeater is given and the entry contains any time
7900 stamps, the clones will become a sequence in time, with time
7901 stamps in the subtree shifted for each clone produced. If SHIFT
7902 is nil or the empty string, time stamps will be left alone. The
7903 ID property of the original subtree is removed.
7905 If the original subtree did contain time stamps with a repeater,
7906 the following will happen:
7907 - the repeater will be removed in each clone
7908 - an additional clone will be produced, with the current, unshifted
7909 date(s) in the entry.
7910 - the original entry will be placed *after* all the clones, with
7911 repeater intact.
7912 - the start days in the repeater in the original entry will be shifted
7913 to past the last clone.
7914 In this way you can spell out a number of instances of a repeating task,
7915 and still retain the repeater to cover future instances of the task."
7916 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7917 (let (beg end template task idprop
7918 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7919 (drawer-re org-drawer-regexp))
7920 (if (not (and (integerp n) (> n 0)))
7921 (error "Invalid number of replications %s" n))
7924 shift)))
7925 (error "Invalid shift specification %s" shift))
7926 (when doshift
7927 (setq shift-n (string-to-number (match-string 1 shift))
7928 shift-what (cdr (assoc (match-string 2 shift)
7929 '(("d" . day) ("w" . week)
7930 ("m" . month) ("y" . year))))))
7931 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7932 (setq nmin 1 nmax n)
7933 (org-back-to-heading t)
7934 (setq beg (point))
7935 (setq idprop (org-entry-get nil "ID"))
7936 (org-end-of-subtree t t)
7938 (setq end (point))
7939 (setq template (buffer-substring beg end))
7940 (when (and doshift
7942 (delete-region beg end)
7943 (setq end beg)
7944 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7945 (goto-char end)
7946 (loop for n from nmin to nmax do
7947 ;; prepare clone
7948 (with-temp-buffer
7949 (insert template)
7950 (org-mode)
7951 (goto-char (point-min))
7952 (org-show-subtree)
7953 (and idprop (if org-clone-delete-id
7954 (org-entry-delete nil "ID")
7955 (org-id-get-create t)))
7956 (unless (= n 0)
7958 (kill-whole-line))
7959 (goto-char (point-min))
7960 (while (re-search-forward drawer-re nil t)
7961 (mapc (lambda (d)
7962 (org-remove-empty-drawer-at d (point))) org-drawers)))
7963 (goto-char (point-min))
7964 (when doshift
7965 (while (re-search-forward org-ts-regexp-both nil t)
7966 (org-timestamp-change (* n shift-n) shift-what))
7967 (unless (= n n-no-remove)
7968 (goto-char (point-min))
7969 (while (re-search-forward org-ts-regexp nil t)
7970 (save-excursion
7971 (goto-char (match-beginning 0))
7973 (delete-region (match-beginning 1) (match-end 1)))))))
7974 (setq task (buffer-string)))
7975 (insert task))
7976 (goto-char beg)))
7978 ;;; Outline Sorting
7980 (defun org-sort (with-case)
7981 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7982 Optional argument WITH-CASE means sort case-sensitively."
7983 (interactive "P")
7984 (cond
7985 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7986 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7987 (t
7988 (org-call-with-arg 'org-sort-entries with-case))))
7990 (defun org-sort-remove-invisible (s)
7991 (remove-text-properties 0 (length s) org-rm-props s)
7992 (while (string-match org-bracket-link-regexp s)
7993 (setq s (replace-match (if (match-end 2)
7994 (match-string 3 s)
7995 (match-string 1 s)) t t s)))
7996 s)
7998 (defvar org-priority-regexp) ; defined later in the file
8000 (defvar org-after-sorting-entries-or-items-hook nil
8001 "Hook that is run after a bunch of entries or items have been sorted.
8002 When children are sorted, the cursor is in the parent line when this
8003 hook gets called. When a region or a plain list is sorted, the cursor
8004 will be in the first entry of the sorted region/list.")
8006 (defun org-sort-entries
8007 (&optional with-case sorting-type getkey-func compare-func property)
8008 "Sort entries on a certain level of an outline tree.
8009 If there is an active region, the entries in the region are sorted.
8010 Else, if the cursor is before the first entry, sort the top-level items.
8011 Else, the children of the entry at point are sorted.
8013 Sorting can be alphabetically, numerically, by date/time as given by
8014 a time stamp, by a property or by priority.
8016 The command prompts for the sorting type unless it has been given to the
8017 function through the SORTING-TYPE argument, which needs to be a character,
8018 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8019 precise meaning of each character:
8021 n Numerically, by converting the beginning of the entry/item to a number.
8022 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8023 t By date/time, either the first active time stamp in the entry, or, if
8024 none exist, by the first inactive one.
8025 s By the scheduled date/time.
8026 d By deadline date/time.
8027 c By creation time, which is assumed to be the first inactive time stamp
8028 at the beginning of a line.
8029 p By priority according to the cookie.
8030 r By the value of a property.
8032 Capital letters will reverse the sort order.
8034 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8035 called with point at the beginning of the record. It must return either
8036 a string or a number that should serve as the sorting key for that record.
8038 Comparing entries ignores case by default. However, with an optional argument
8039 WITH-CASE, the sorting considers case as well."
8040 (interactive "P")
8041 (let ((case-func (if with-case 'identity 'downcase))
8042 start beg end stars re re2
8043 txt what tmp)
8044 ;; Find beginning and end of region to sort
8045 (cond
8046 ((org-region-active-p)
8047 ;; we will sort the region
8048 (setq end (region-end)
8049 what "region")
8050 (goto-char (region-beginning))
8051 (if (not (org-at-heading-p)) (outline-next-heading))
8052 (setq start (point)))
8053 ((or (org-at-heading-p)
8054 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8055 ;; we will sort the children of the current headline
8056 (org-back-to-heading)
8057 (setq start (point)
8058 end (progn (org-end-of-subtree t t)
8060 (org-back-over-empty-lines)
8061 (point))
8062 what "children")
8063 (goto-char start)
8064 (show-subtree)
8065 (outline-next-heading))
8066 (t
8067 ;; we will sort the top-level entries in this file
8068 (goto-char (point-min))
8069 (or (org-at-heading-p) (outline-next-heading))
8070 (setq start (point))
8071 (goto-char (point-max))
8072 (beginning-of-line 1)
8074 ;; File ends in a non-white line
8075 (end-of-line 1)
8077 (setq end (point-max))
8078 (setq what "top-level")
8079 (goto-char start)
8080 (show-all)))
8082 (setq beg (point))
8083 (if (>= beg end) (error "Nothing to sort"))
8086 (setq stars (match-string 1)
8087 re (concat "^" (regexp-quote stars) " +")
8089 txt (buffer-substring beg end))
8091 (if (and (not (equal stars "*")) (string-match re2 txt))
8092 (error "Region to sort contains a level above the first entry"))
8094 (unless sorting-type
8095 (message
8096 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8098 A/N/T/S/D/C/P/O/F means reversed:"
8099 what)
8100 (setq sorting-type (read-char-exclusive))
8102 (and (= (downcase sorting-type) ?f)
8103 (setq getkey-func
8104 (org-icompleting-read "Sort using function: "
8105 obarray 'fboundp t nil nil))
8106 (setq getkey-func (intern getkey-func)))
8108 (and (= (downcase sorting-type) ?r)
8109 (setq property
8110 (org-icompleting-read "Property: "
8111 (mapcar 'list (org-buffer-property-keys t))
8112 nil t))))
8114 (message "Sorting entries...")
8116 (save-restriction
8117 (narrow-to-region start end)
8118 (let ((dcst (downcase sorting-type))
8119 (case-fold-search nil)
8120 (now (current-time)))
8121 (sort-subr
8122 (/= dcst sorting-type)
8123 ;; This function moves to the beginning character of the "record" to
8124 ;; be sorted.
8125 (lambda nil
8126 (if (re-search-forward re nil t)
8127 (goto-char (match-beginning 0))
8128 (goto-char (point-max))))
8129 ;; This function moves to the last character of the "record" being
8130 ;; sorted.
8131 (lambda nil
8132 (save-match-data
8133 (condition-case nil
8134 (outline-forward-same-level 1)
8135 (error
8136 (goto-char (point-max))))))
8137 ;; This function returns the value that gets sorted against.
8138 (lambda nil
8139 (cond
8140 ((= dcst ?n)
8141 (if (looking-at org-complex-heading-regexp)
8142 (string-to-number (match-string 4))
8143 nil))
8144 ((= dcst ?a)
8145 (if (looking-at org-complex-heading-regexp)
8146 (funcall case-func (match-string 4))
8147 nil))
8148 ((= dcst ?t)
8149 (let ((end (save-excursion (outline-next-heading) (point))))
8150 (if (or (re-search-forward org-ts-regexp end t)
8151 (re-search-forward org-ts-regexp-both end t))
8152 (org-time-string-to-seconds (match-string 0))
8153 (org-float-time now))))
8154 ((= dcst ?c)
8155 (let ((end (save-excursion (outline-next-heading) (point))))
8156 (if (re-search-forward
8158 end t)
8159 (org-time-string-to-seconds (match-string 0))
8160 (org-float-time now))))
8161 ((= dcst ?s)
8162 (let ((end (save-excursion (outline-next-heading) (point))))
8163 (if (re-search-forward org-scheduled-time-regexp end t)
8164 (org-time-string-to-seconds (match-string 1))
8165 (org-float-time now))))
8166 ((= dcst ?d)
8167 (let ((end (save-excursion (outline-next-heading) (point))))
8168 (if (re-search-forward org-deadline-time-regexp end t)
8169 (org-time-string-to-seconds (match-string 1))
8170 (org-float-time now))))
8171 ((= dcst ?p)
8172 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8173 (string-to-char (match-string 2))
8174 org-default-priority))
8175 ((= dcst ?r)
8176 (or (org-entry-get nil property) ""))
8177 ((= dcst ?o)
8178 (if (looking-at org-complex-heading-regexp)
8179 (- 9999 (length (member (match-string 2)
8180 org-todo-keywords-1)))))
8181 ((= dcst ?f)
8182 (if getkey-func
8183 (progn
8184 (setq tmp (funcall getkey-func))
8185 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8186 tmp)
8187 (error "Invalid key function `%s'" getkey-func)))
8188 (t (error "Invalid sorting type `%c'" sorting-type))))
8189 nil
8190 (cond
8191 ((= dcst ?a) 'string<)
8192 ((= dcst ?f) compare-func)
8193 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8194 (t nil)))))
8195 (run-hooks 'org-after-sorting-entries-or-items-hook)
8196 (message "Sorting entries...done")))
8198 (defun org-do-sort (table what &optional with-case sorting-type)
8199 "Sort TABLE of WHAT according to SORTING-TYPE.
8200 The user will be prompted for the SORTING-TYPE if the call to this
8201 function does not specify it. WHAT is only for the prompt, to indicate
8202 what is being sorted. The sorting key will be extracted from
8203 the car of the elements of the table.
8204 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8205 (unless sorting-type
8206 (message
8207 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8208 what)
8209 (setq sorting-type (read-char-exclusive)))
8210 (let ((dcst (downcase sorting-type))
8211 extractfun comparefun)
8212 ;; Define the appropriate functions
8213 (cond
8214 ((= dcst ?n)
8215 (setq extractfun 'string-to-number
8216 comparefun (if (= dcst sorting-type) '< '>)))
8217 ((= dcst ?a)
8218 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8219 (lambda(x) (downcase (org-sort-remove-invisible x))))
8220 comparefun (if (= dcst sorting-type)
8221 'string<
8222 (lambda (a b) (and (not (string< a b))
8223 (not (string= a b)))))))
8224 ((= dcst ?t)
8225 (setq extractfun
8226 (lambda (x)
8227 (if (or (string-match org-ts-regexp x)
8228 (string-match org-ts-regexp-both x))
8229 (org-float-time
8230 (org-time-string-to-time (match-string 0 x)))
8231 0))
8232 comparefun (if (= dcst sorting-type) '< '>)))
8233 (t (error "Invalid sorting type `%c'" sorting-type)))
8235 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8236 table)
8237 (lambda (a b) (funcall comparefun (car a) (car b))))))
8240 ;;; The orgstruct minor mode
8242 ;; Define a minor mode which can be used in other modes in order to
8243 ;; integrate the org-mode structure editing commands.
8245 ;; This is really a hack, because the org-mode structure commands use
8246 ;; keys which normally belong to the major mode. Here is how it
8247 ;; works: The minor mode defines all the keys necessary to operate the
8248 ;; structure commands, but wraps the commands into a function which
8249 ;; tests if the cursor is currently at a headline or a plain list
8250 ;; item. If that is the case, the structure command is used,
8251 ;; temporarily setting many Org-mode variables like regular
8252 ;; expressions for filling etc. However, when any of those keys is
8253 ;; used at a different location, function uses `key-binding' to look
8254 ;; up if the key has an associated command in another currently active
8255 ;; keymap (minor modes, major mode, global), and executes that
8256 ;; command. There might be problems if any of the keys is otherwise
8257 ;; used as a prefix key.
8259 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8260 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8261 ;; addresses this by checking explicitly for both bindings.
8263 (defvar orgstruct-mode-map (make-sparse-keymap)
8264 "Keymap for the minor `orgstruct-mode'.")
8266 (defvar org-local-vars nil
8267 "List of local variables, for use by `orgstruct-mode'.")
8269 ;;;###autoload
8270 (define-minor-mode orgstruct-mode
8271 "Toggle the minor mode `orgstruct-mode'.
8272 This mode is for using Org-mode structure commands in other
8273 modes. The following keys behave as if Org-mode were active, if
8274 the cursor is on a headline, or on a plain list item (both as
8275 defined by Org-mode).
8277 M-up Move entry/item up
8278 M-down Move entry/item down
8279 M-left Promote
8280 M-right Demote
8281 M-S-up Move entry/item up
8282 M-S-down Move entry/item down
8283 M-S-left Promote subtree
8284 M-S-right Demote subtree
8285 M-q Fill paragraph and items like in Org-mode
8286 C-c ^ Sort entries
8287 C-c - Cycle list bullet
8288 TAB Cycle item visibility
8289 M-RET Insert new heading/item
8290 S-M-RET Insert new TODO heading / Checkbox item
8291 C-c C-c Set tags / toggle checkbox"
8292 nil " OrgStruct" nil
8293 (org-load-modules-maybe)
8294 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8296 ;;;###autoload
8297 (defun turn-on-orgstruct ()
8298 "Unconditionally turn on `orgstruct-mode'."
8299 (orgstruct-mode 1))
8301 (defun orgstruct++-mode (&optional arg)
8302 "Toggle `orgstruct-mode', the enhanced version of it.
8303 In addition to setting orgstruct-mode, this also exports all indentation
8304 and autofilling variables from org-mode into the buffer. It will also
8305 recognize item context in multiline items.
8306 Note that turning off orgstruct-mode will *not* remove the
8307 indentation/paragraph settings. This can only be done by refreshing the
8309 (interactive "P")
8310 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8311 (if (< arg 1)
8312 (orgstruct-mode -1)
8313 (orgstruct-mode 1)
8314 (let (var val)
8315 (mapc
8316 (lambda (x)
8317 (when (string-match
8319 (symbol-name (car x)))
8320 (setq var (car x) val (nth 1 x))
8321 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8322 org-local-vars)
8323 (org-set-local 'orgstruct-is-++ t))))
8325 (defvar orgstruct-is-++ nil
8326 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8327 (make-variable-buffer-local 'orgstruct-is-++)
8329 ;;;###autoload
8330 (defun turn-on-orgstruct++ ()
8331 "Unconditionally turn on `orgstruct++-mode'."
8332 (orgstruct++-mode 1))
8334 (defun orgstruct-error ()
8335 "Error when there is no default binding for a structure key."
8336 (interactive)
8337 (error "This key has no function outside structure elements"))
8339 (defun orgstruct-setup ()
8340 "Setup orgstruct keymaps."
8341 (let ((nfunc 0)
8342 (bindings
8343 (list
8344 '([(meta up)] org-metaup)
8345 '([(meta down)] org-metadown)
8346 '([(meta left)] org-metaleft)
8347 '([(meta right)] org-metaright)
8348 '([(meta shift up)] org-shiftmetaup)
8349 '([(meta shift down)] org-shiftmetadown)
8350 '([(meta shift left)] org-shiftmetaleft)
8351 '([(meta shift right)] org-shiftmetaright)
8352 '([?\e (up)] org-metaup)
8353 '([?\e (down)] org-metadown)
8354 '([?\e (left)] org-metaleft)
8355 '([?\e (right)] org-metaright)
8356 '([?\e (shift up)] org-shiftmetaup)
8357 '([?\e (shift down)] org-shiftmetadown)
8358 '([?\e (shift left)] org-shiftmetaleft)
8359 '([?\e (shift right)] org-shiftmetaright)
8360 '([(shift up)] org-shiftup)
8361 '([(shift down)] org-shiftdown)
8362 '([(shift left)] org-shiftleft)
8363 '([(shift right)] org-shiftright)
8364 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8365 '("\M-q" fill-paragraph)
8366 '("\C-c^" org-sort)
8367 '("\C-c-" org-cycle-list-bullet)))
8368 elt key fun cmd)
8369 (while (setq elt (pop bindings))
8370 (setq nfunc (1+ nfunc))
8371 (setq key (org-key (car elt))
8372 fun (nth 1 elt)
8373 cmd (orgstruct-make-binding fun nfunc key))
8374 (org-defkey orgstruct-mode-map key cmd))
8376 ;; Special treatment needed for TAB and RET
8377 (org-defkey orgstruct-mode-map [(tab)]
8378 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8379 (org-defkey orgstruct-mode-map "\C-i"
8380 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8382 (org-defkey orgstruct-mode-map "\M-\C-m"
8383 (orgstruct-make-binding 'org-insert-heading 105
8384 "\M-\C-m" [(meta return)]))
8385 (org-defkey orgstruct-mode-map [(meta return)]
8386 (orgstruct-make-binding 'org-insert-heading 106
8387 [(meta return)] "\M-\C-m"))
8389 (org-defkey orgstruct-mode-map [(shift meta return)]
8390 (orgstruct-make-binding 'org-insert-todo-heading 107
8391 [(meta return)] "\M-\C-m"))
8393 (org-defkey orgstruct-mode-map "\e\C-m"
8394 (orgstruct-make-binding 'org-insert-heading 108
8395 "\e\C-m" [?\e (return)]))
8396 (org-defkey orgstruct-mode-map [?\e (return)]
8397 (orgstruct-make-binding 'org-insert-heading 109
8398 [?\e (return)] "\e\C-m"))
8399 (org-defkey orgstruct-mode-map [?\e (shift return)]
8400 (orgstruct-make-binding 'org-insert-todo-heading 110
8401 [?\e (return)] "\e\C-m"))
8403 (unless org-local-vars
8404 (setq org-local-vars (org-get-local-variables)))
8406 t))
8408 (defun orgstruct-make-binding (fun n &rest keys)
8409 "Create a function for binding in the structure minor mode.
8410 FUN is the command to call inside a table. N is used to create a unique
8411 command name. KEYS are keys that should be checked in for a command
8412 to execute outside of tables."
8413 (eval
8414 (list 'defun
8415 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8416 '(arg)
8418 "Outside of structure, run the binding of `"
8419 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8420 "'.")
8421 '(interactive "p")
8422 (list 'if
8423 `(org-context-p 'headline 'item
8424 (and orgstruct-is-++
8425 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8426 'item-body))
8427 (list 'org-run-like-in-org-mode (list 'quote fun))
8428 (list 'let '(orgstruct-mode)
8429 (list 'call-interactively
8430 (append '(or)
8431 (mapcar (lambda (k)
8432 (list 'key-binding k))
8433 keys)
8434 '('orgstruct-error))))))))
8436 (defun org-context-p (&rest contexts)
8437 "Check if local context is any of CONTEXTS.
8438 Possible values in the list of contexts are `table', `headline', and `item'."
8439 (let ((pos (point)))
8440 (goto-char (point-at-bol))
8441 (prog1 (or (and (memq 'table contexts)
8443 (and (memq 'headline contexts)
8444 (looking-at org-outline-regexp))
8445 (and (memq 'item contexts)
8447 (and (memq 'item-body contexts)
8448 (org-in-item-p)))
8449 (goto-char pos))))
8451 (defun org-get-local-variables ()
8452 "Return a list of all local variables in an org-mode buffer."
8453 (let (varlist)
8454 (with-current-buffer (get-buffer-create "*Org tmp*")
8455 (erase-buffer)
8456 (org-mode)
8457 (setq varlist (buffer-local-variables)))
8458 (kill-buffer "*Org tmp*")
8459 (delq nil
8460 (mapcar
8461 (lambda (x)
8462 (setq x
8463 (if (symbolp x)
8464 (list x)
8465 (list (car x) (list 'quote (cdr x)))))
8466 (if (string-match
8467 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8468 (symbol-name (car x)))
8469 x nil))
8470 varlist))))
8472 (defun org-clone-local-variables (from-buffer &optional regexp)
8473 "Clone local variables from FROM-BUFFER.
8474 Optional argument REGEXP selects variables to clone."
8475 (mapc
8476 (lambda (pair)
8477 (and (symbolp (car pair))
8478 (or (null regexp)
8479 (string-match regexp (symbol-name (car pair))))
8480 (set (make-local-variable (car pair))
8481 (cdr pair))))
8482 (buffer-local-variables from-buffer)))
8484 ;;;###autoload
8485 (defun org-run-like-in-org-mode (cmd)
8486 "Run a command, pretending that the current buffer is in Org-mode.
8487 This will temporarily bind local variables that are typically bound in
8488 Org-mode to the values they have in Org-mode, and then interactively
8489 call CMD."
8490 (org-load-modules-maybe)
8491 (unless org-local-vars
8492 (setq org-local-vars (org-get-local-variables)))
8493 (eval (list 'let org-local-vars
8494 (list 'call-interactively (list 'quote cmd)))))
8496 ;;;; Archiving
8498 (defun org-get-category (&optional pos force-refresh)
8499 "Get the category applying to position POS."
8500 (save-match-data
8501 (if force-refresh (org-refresh-category-properties))
8502 (let ((pos (or pos (point))))
8503 (or (get-text-property pos 'org-category)
8504 (progn (org-refresh-category-properties)
8505 (get-text-property pos 'org-category))))))
8507 (defun org-refresh-category-properties ()
8508 "Refresh category text properties in the buffer."
8509 (let ((def-cat (cond
8510 ((null org-category)
8511 (if buffer-file-name
8512 (file-name-sans-extension
8513 (file-name-nondirectory buffer-file-name))
8514 "???"))
8515 ((symbolp org-category) (symbol-name org-category))
8516 (t org-category)))
8517 beg end cat pos optionp)
8518 (org-unmodified
8519 (save-excursion
8520 (save-restriction
8521 (widen)
8522 (goto-char (point-min))
8523 (put-text-property (point) (point-max) 'org-category def-cat)
8524 (while (re-search-forward
8526 (setq pos (match-end 0)
8527 optionp (equal (char-after (match-beginning 0)) ?#)
8528 cat (org-trim (match-string 2)))
8529 (if optionp
8530 (setq beg (point-at-bol) end (point-max))
8531 (org-back-to-heading t)
8532 (setq beg (point) end (org-end-of-subtree t t)))
8533 (put-text-property beg end 'org-category cat)
8534 (put-text-property beg end 'org-category-position beg)
8535 (goto-char pos)))))))
8538 ;;;; Link Stuff
8540 ;;; Link abbreviations
8542 (defun org-link-expand-abbrev (link)
8543 "Apply replacements as defined in `org-link-abbrev-alist."
8545 (let* ((key (match-string 1 link))
8546 (as (or (assoc key org-link-abbrev-alist-local)
8547 (assoc key org-link-abbrev-alist)))
8548 (tag (and (match-end 2) (match-string 3 link)))
8549 rpl)
8550 (if (not as)
8551 link
8552 (setq rpl (cdr as))
8553 (cond
8554 ((symbolp rpl) (funcall rpl tag))
8555 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8556 ((string-match "%h" rpl)
8557 (replace-match (url-hexify-string (or tag "")) t t rpl))
8558 (t (concat rpl tag)))))
8559 link))
8561 ;;; Storing and inserting links
8563 (defvar org-insert-link-history nil
8564 "Minibuffer history for links inserted with `org-insert-link'.")
8566 (defvar org-stored-links nil
8567 "Contains the links stored with `org-store-link'.")
8569 (defvar org-store-link-plist nil
8570 "Plist with info about the most recently link created with `org-store-link'.")
8572 (defvar org-link-protocols nil
8573 "Link protocols added to Org-mode using `org-add-link-type'.")
8575 (defvar org-store-link-functions nil
8576 "List of functions that are called to create and store a link.
8577 Each function will be called in turn until one returns a non-nil
8578 value. Each function should check if it is responsible for creating
8579 this link (for example by looking at the major mode).
8580 If not, it must exit and return nil.
8581 If yes, it should return a non-nil value after a calling
8582 `org-store-link-props' with a list of properties and values.
8583 Special properties are:
8587 This is obligatory as well.
8588 :description Optional default description for the second pair
8589 of brackets in an Org-mode link. The user can still change
8590 this when inserting this link into an Org-mode buffer.
8592 In addition to these, any additional properties can be specified
8593 and then used in remember templates.")
8595 (defun org-add-link-type (type &optional follow export)
8596 "Add TYPE to the list of `org-link-types'.
8597 Re-compute all regular expressions depending on `org-link-types'
8599 FOLLOW and EXPORT are two functions.
8601 FOLLOW should take the link path as the single argument and do whatever
8602 is necessary to follow the link, for example find a file or display
8603 a mail message.
8605 EXPORT should format the link path for export to one of the export formats.
8606 It should be a function accepting three arguments:
8609 desc the description of the link, if any, or a description added by
8610 org-export-normalize-links if there is none
8611 format the export format, a symbol like `html' or `latex' or `ascii'..
8613 The function may use the FORMAT information to return different values
8614 depending on the format. The return value will be put literally into
8615 the exported file. If the return value is nil, this means Org should
8616 do what it normally does with links which do not have EXPORT defined.
8618 Org-mode has a built-in default for exporting links. If you are happy with
8619 this default, there is no need to define an export function for the link
8620 type. For a simple example of an export function, see `org-bbdb.el'."
8621 (add-to-list 'org-link-types type t)
8622 (org-make-link-regexps)
8623 (if (assoc type org-link-protocols)
8624 (setcdr (assoc type org-link-protocols) (list follow export))
8625 (push (list type follow export) org-link-protocols)))
8627 (defvar org-agenda-buffer-name)
8629 ;;;###autoload
8630 (defun org-store-link (arg)
8632 This link is added to `org-stored-links' and can later be inserted
8635 For some link types, a prefix arg is interpreted:
8636 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8637 For file links, arg negates `org-context-in-file-links'."
8638 (interactive "P")
8639 (org-load-modules-maybe)
8640 (setq org-store-link-plist nil) ; reset
8641 (org-with-limited-levels
8642 (let (link cpltxt desc description search txt custom-id agenda-link)
8643 (cond
8645 ((run-hook-with-args-until-success 'org-store-link-functions)
8646 (setq link (plist-get org-store-link-plist :link)
8647 desc (or (plist-get org-store-link-plist :description) link)))
8649 ((org-src-edit-buffer-p)
8650 (let (label gc)
8651 (while (or (not label)
8652 (save-excursion
8653 (save-restriction
8654 (widen)
8655 (goto-char (point-min))
8656 (re-search-forward
8657 (regexp-quote (format org-coderef-label-format label))
8658 nil t))))
8659 (when label (message "Label exists already") (sit-for 2))
8660 (setq label (read-string "Code line label: " label)))
8661 (end-of-line 1)
8662 (setq link (format org-coderef-label-format label))
8663 (setq gc (- 79 (length link)))
8664 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8665 (insert link)
8666 (setq link (concat "(" label ")") desc nil)))
8668 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8669 ;; We are in the agenda, link to referenced location
8670 (let ((m (or (get-text-property (point) 'org-hd-marker)
8671 (get-text-property (point) 'org-marker))))
8672 (when m
8673 (org-with-point-at m
8674 (setq agenda-link
8675 (if (org-called-interactively-p 'any)
8676 (call-interactively 'org-store-link)
8677 (org-store-link nil)))))))
8679 ((eq major-mode 'calendar-mode)
8680 (let ((cd (calendar-cursor-to-date)))
8681 (setq link
8682 (format-time-string
8683 (car org-time-stamp-formats)
8684 (apply 'encode-time
8685 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8686 nil nil nil))))
8687 (org-store-link-props :type "calendar" :date cd)))
8689 ((eq major-mode 'w3-mode)
8690 (setq cpltxt (if (and (buffer-name)
8691 (not (string-match "Untitled" (buffer-name))))
8692 (buffer-name)
8693 (url-view-url t))
8694 link (org-make-link (url-view-url t)))
8695 (org-store-link-props :type "w3" :url (url-view-url t)))
8697 ((eq major-mode 'w3m-mode)
8698 (setq cpltxt (or w3m-current-title w3m-current-url)
8699 link (org-make-link w3m-current-url))
8700 (org-store-link-props :type "w3m" :url (url-view-url t)))
8702 ((setq search (run-hook-with-args-until-success
8703 'org-create-file-search-functions))
8704 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8705 "::" search))
8706 (setq cpltxt (or description link)))
8708 ((eq major-mode 'image-mode)
8709 (setq cpltxt (concat "file:"
8710 (abbreviate-file-name buffer-file-name))
8711 link (org-make-link cpltxt))
8712 (org-store-link-props :type "image" :file buffer-file-name))
8714 ((eq major-mode 'dired-mode)
8715 ;; link to the file in the current line
8716 (let ((file (dired-get-filename nil t)))
8717 (setq file (if file
8718 (abbreviate-file-name
8719 (expand-file-name (dired-get-filename nil t)))
8720 ;; otherwise, no file so use current directory.
8721 default-directory))
8722 (setq cpltxt (concat "file:" file)
8723 link (org-make-link cpltxt))))
8725 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8726 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8727 (cond
8729 (setq cpltxt
8730 (concat "file:"
8731 (abbreviate-file-name
8732 (buffer-file-name (buffer-base-buffer)))
8733 "::" (match-string 1))
8734 link (org-make-link cpltxt)))
8735 ((and (featurep 'org-id)
8736 (or (eq org-link-to-org-use-id t)
8737 (and (eq org-link-to-org-use-id 'create-if-interactive)
8738 (org-called-interactively-p 'any))
8739 (and (eq org-link-to-org-use-id
8740 'create-if-interactive-and-no-custom-id)
8741 (org-called-interactively-p 'any)
8742 (not custom-id))
8743 (and org-link-to-org-use-id
8744 (org-entry-get nil "ID"))))
8745 ;; We can make a link using the ID.
8746 (setq link (condition-case nil
8747 (prog1 (org-id-store-link)
8748 (setq desc (plist-get org-store-link-plist
8749 :description)))
8750 (error
8751 ;; probably before first headline, link to file only
8752 (concat "file:"
8753 (abbreviate-file-name
8754 (buffer-file-name (buffer-base-buffer))))))))
8755 (t
8756 ;; Just link to current headline
8757 (setq cpltxt (concat "file:"
8758 (abbreviate-file-name
8759 (buffer-file-name (buffer-base-buffer)))))
8760 ;; Add a context search string
8761 (when (org-xor org-context-in-file-links arg)
8762 (setq txt (cond
8763 ((org-at-heading-p) nil)
8764 ((org-region-active-p)
8765 (buffer-substring (region-beginning) (region-end)))
8766 (t nil)))
8768 (setq cpltxt
8769 (concat cpltxt "::"
8770 (condition-case nil
8771 (org-make-org-heading-search-string txt)
8772 (error "")))
8773 desc (or (nth 4 (ignore-errors
8774 (org-heading-components))) "NONE"))))
8776 (setq cpltxt (substring cpltxt 0 -2)))
8777 (setq link (org-make-link cpltxt)))))
8779 ((buffer-file-name (buffer-base-buffer))
8780 ;; Just link to this file here.
8781 (setq cpltxt (concat "file:"
8782 (abbreviate-file-name
8783 (buffer-file-name (buffer-base-buffer)))))
8784 ;; Add a context string
8785 (when (org-xor org-context-in-file-links arg)
8786 (setq txt (if (org-region-active-p)
8787 (buffer-substring (region-beginning) (region-end))
8788 (buffer-substring (point-at-bol) (point-at-eol))))
8789 ;; Only use search option if there is some text.
8791 (setq cpltxt
8792 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8793 desc "NONE")))
8794 (setq link (org-make-link cpltxt)))
8796 ((org-called-interactively-p 'interactive)
8797 (error "Cannot link to a buffer which is not visiting a file"))
8799 (t (setq link nil)))
8801 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8802 (setq link (or link cpltxt)
8803 desc (or desc cpltxt))
8804 (if (equal desc "NONE") (setq desc nil))
8806 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8807 (progn
8808 (setq org-stored-links
8809 (cons (list link desc) org-stored-links))
8810 (message "Stored: %s" (or desc link))
8811 (when custom-id
8812 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8813 "::#" custom-id))
8814 (setq org-stored-links
8815 (cons (list link desc) org-stored-links))))
8816 (or agenda-link (and link (org-make-link-string link desc)))))))
8818 (defun org-store-link-props (&rest plist)
8819 "Store link properties, extract names and addresses."
8820 (let (x adr)
8821 (when (setq x (plist-get plist :from))
8822 (setq adr (mail-extract-address-components x))
8823 (setq plist (plist-put plist :fromname (car adr)))
8824 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8825 (when (setq x (plist-get plist :to))
8826 (setq adr (mail-extract-address-components x))
8827 (setq plist (plist-put plist :toname (car adr)))
8828 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8829 (let ((from (plist-get plist :from))
8830 (to (plist-get plist :to)))
8831 (when (and from to org-from-is-user-regexp)
8832 (setq plist
8833 (plist-put plist :fromto
8834 (if (string-match org-from-is-user-regexp from)
8835 (concat "to %t")
8836 (concat "from %f"))))))
8837 (setq org-store-link-plist plist))
8839 (defun org-add-link-props (&rest plist)
8840 "Add these properties to the link property list."
8841 (let (key value)
8842 (while plist
8843 (setq key (pop plist) value (pop plist))
8844 (setq org-store-link-plist
8845 (plist-put org-store-link-plist key value)))))
8847 (defun org-email-link-description (&optional fmt)
8848 "Return the description part of an email link.
8849 This takes information from `org-store-link-plist' and formats it
8850 according to FMT (default from `org-email-link-description-format')."
8851 (setq fmt (or fmt org-email-link-description-format))
8852 (let* ((p org-store-link-plist)
8853 (to (plist-get p :toaddress))
8854 (from (plist-get p :fromaddress))
8855 (table
8856 (list
8857 (cons "%c" (plist-get p :fromto))
8858 (cons "%F" (plist-get p :from))
8859 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8860 (cons "%T" (plist-get p :to))
8861 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8862 (cons "%s" (plist-get p :subject))
8863 (cons "%d" (plist-get p :date))
8864 (cons "%m" (plist-get p :message-id)))))
8865 (when (string-match "%c" fmt)
8866 ;; Check if the user wrote this message
8867 (if (and org-from-is-user-regexp from to
8868 (save-match-data (string-match org-from-is-user-regexp from)))
8869 (setq fmt (replace-match "to %t" t t fmt))
8870 (setq fmt (replace-match "from %f" t t fmt))))
8871 (org-replace-escapes fmt table)))
8873 (defun org-make-org-heading-search-string (&optional string heading)
8874 "Make search string for STRING or current headline."
8875 (interactive)
8876 (let ((s (or string (org-get-heading)))
8877 (lines org-context-in-file-links))
8878 (unless (and string (not heading))
8879 ;; We are using a headline, clean up garbage in there.
8880 (if (string-match org-todo-regexp s)
8881 (setq s (replace-match "" t t s)))
8883 (setq s (replace-match "" t t s)))
8884 (setq s (org-trim s))
8887 (setq s (replace-match "" t t s)))
8888 (while (string-match org-ts-regexp s)
8889 (setq s (replace-match "" t t s))))
8890 (or string (setq s (concat "*" s))) ; Add * for headlines
8891 (when (and string (integerp lines) (> lines 0))
8893 (when (< lines (length slines))
8894 (setq s (mapconcat
8895 'identity
8896 (reverse (nthcdr (- (length slines) lines)
8900 (defun org-make-link (&rest strings)
8901 "Concatenate STRINGS."
8902 (apply 'concat strings))
8904 (defun org-make-link-string (link &optional description)
8905 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8907 (error "Empty link"))
8908 (when (and description
8909 (stringp description)
8911 (setq description nil))
8912 (when (stringp description)
8913 ;; Remove brackets from the description, they are fatal.
8915 (setq description (replace-match "{" t t description)))
8917 (setq description (replace-match "}" t t description))))
8918 (when (equal link description)
8919 ;; No description needed, it is identical
8920 (setq description nil))
8921 (when (and (not description)
8922 (not (string-match (org-image-file-name-regexp) link))
8923 (not (equal link (org-link-escape link))))
8924 (setq description (org-extract-attributes link)))
8925 (setq link
8926 (cond ((string-match (org-image-file-name-regexp) link) link)
8927 ((string-match org-link-types-re link)
8928 (concat (match-string 1 link)
8929 (org-link-escape (substring link (match-end 1)))))
8930 (t (org-link-escape link))))
8931 (concat "[[" link "]"
8932 (if description (concat "[" description "]") "")
8933 "]"))
8935 (defconst org-link-escape-chars
8936 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8937 "List of characters that should be escaped in link.
8938 This is the list that is used for internal purposes.")
8940 (defvar org-url-encoding-use-url-hexify nil)
8942 (defconst org-link-escape-chars-browser
8943 '(?\ )
8944 "List of escapes for characters that are problematic in links.
8945 This is the list that is used before handing over to the browser.")
8947 (defun org-link-escape (text &optional table merge)
8948 "Return percent escaped representation of TEXT.
8949 TEXT is a string with the text to escape.
8950 Optional argument TABLE is a list with characters that should be
8951 escaped. When nil, `org-link-escape-chars' is used.
8952 If optional argument MERGE is set, merge TABLE into
8953 `org-link-escape-chars'."
8954 (if (and org-url-encoding-use-url-hexify (not table))
8955 (url-hexify-string text)
8956 (cond
8957 ((and table merge)
8958 (mapc (lambda (defchr)
8959 (unless (member defchr table)
8960 (setq table (cons defchr table)))) org-link-escape-chars))
8961 ((null table)
8962 (setq table org-link-escape-chars)))
8963 (mapconcat
8964 (lambda (char)
8965 (if (or (member char table)
8966 (< char 32) (= char 37) (> char 126))
8967 (mapconcat (lambda (sequence-element)
8968 (format "%%%.2X" sequence-element))
8969 (or (encode-coding-char char 'utf-8)
8970 (error "Unable to percent escape character: %s"
8971 (char-to-string char))) "")
8972 (char-to-string char))) text "")))
8974 (defun org-link-unescape (str)
8975 "Unhex hexified Unicode strings as returned from the JavaScript function
8976 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8977 (unless (and (null str) (string= "" str))
8978 (let ((pos 0) (case-fold-search t) unhexed)
8980 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8981 (setq str (replace-match unhexed t t str))
8982 (setq pos (+ pos (length unhexed))))))
8983 str)
8985 (defun org-link-unescape-compound (hex)
8986 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8987 Note: this function also decodes single byte encodings like
8989 (save-match-data
8990 (let* ((bytes (cdr (split-string hex "%")))
8991 (ret "")
8992 (eat 0)
8993 (sum 0))
8994 (while bytes
8995 (let* ((val (string-to-number (pop bytes) 16))
8996 (shift-xor
8997 (if (= 0 eat)
8998 (cond
8999 ((>= val 252) (cons 6 252))
9000 ((>= val 248) (cons 5 248))
9001 ((>= val 240) (cons 4 240))
9002 ((>= val 224) (cons 3 224))
9003 ((>= val 192) (cons 2 192))
9004 (t (cons 0 0)))
9005 (cons 6 128))))
9006 (if (>= val 192) (setq eat (car shift-xor)))
9007 (setq val (logxor val (cdr shift-xor)))
9008 (setq sum (+ (lsh sum (car shift-xor)) val))
9009 (if (> eat 0) (setq eat (- eat 1)))
9010 (cond
9011 ((= 0 eat) ;multi byte
9012 (setq ret (concat ret (org-char-to-string sum)))
9013 (setq sum 0))
9014 ((not bytes) ; single byte(s)
9015 (setq ret (org-link-unescape-single-byte-sequence hex))))
9016 )) ;; end (while bytes
9017 ret )))
9019 (defun org-link-unescape-single-byte-sequence (hex)
9020 "Unhexify hex-encoded single byte character sequences."
9021 (mapconcat (lambda (byte)
9022 (char-to-string (string-to-number byte 16)))
9023 (cdr (split-string hex "%")) ""))
9025 (defun org-xor (a b)
9026 "Exclusive or."
9027 (if a (not b) b))
9029 (defun org-fixup-message-id-for-http (s)
9030 "Replace special characters in a message id, so it can be used in an http query."
9031 (when (string-match "%" s)
9032 (setq s (mapconcat (lambda (c)
9033 (if (eq c ?%)
9034 "%25"
9035 (char-to-string c)))
9036 s "")))
9037 (while (string-match "<" s)
9038 (setq s (replace-match "%3C" t t s)))
9039 (while (string-match ">" s)
9040 (setq s (replace-match "%3E" t t s)))
9041 (while (string-match "@" s)
9042 (setq s (replace-match "%40" t t s)))
9043 s)
9045 ;;;###autoload
9046 (defun org-insert-link-global ()
9047 "Insert a link like Org-mode does.
9048 This command can be called in any mode to insert a link in Org-mode syntax."
9049 (interactive)
9050 (org-load-modules-maybe)
9051 (org-run-like-in-org-mode 'org-insert-link))
9053 (defun org-insert-link (&optional complete-file link-location default-description)
9054 "Insert a link. At the prompt, enter the link.
9056 Completion can be used to insert any of the link protocol prefixes like
9057 http or ftp in use.
9059 The history can be used to select a link previously stored with
9060 `org-store-link'. When the empty string is entered (i.e. if you just
9061 press RET at the prompt), the link defaults to the most recently
9062 stored link. As SPC triggers completion in the minibuffer, you need to
9063 use M-SPC or C-q SPC to force the insertion of a space character.
9065 You will also be prompted for a description, and if one is given, it will
9066 be displayed in the buffer instead of the link.
9068 If there is already a link at point, this command will allow you to edit link
9069 and description parts.
9072 be selected using completion. The path to the file will be relative to the
9073 current directory if the file is in the current directory or a subdirectory.
9074 Otherwise, the link will be the absolute path as completed in the minibuffer
9075 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9076 option `org-link-file-path-type'.
9079 the current directory or below.
9082 `org-keep-stored-link-after-insertion'.
9084 If `org-make-link-description-function' is non-nil, this function will be
9085 called with the link target, and the result will be the default
9086 link description.
9088 If the LINK-LOCATION parameter is non-nil, this value will be
9089 used as the link location instead of reading one interactively.
9091 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9092 be used as the default description."
9093 (interactive "P")
9094 (let* ((wcf (current-window-configuration))
9095 (region (if (org-region-active-p)
9096 (buffer-substring (region-beginning) (region-end))))
9097 (remove (and region (list (region-beginning) (region-end))))
9098 (desc region)
9099 tmphist ; byte-compile incorrectly complains about this
9100 (link link-location)
9101 entry file all-prefixes)
9102 (cond
9103 (link-location) ; specified by arg, just use it.
9104 ((org-in-regexp org-bracket-link-regexp 1)
9105 ;; We do have a link at point, and we are going to edit it.
9106 (setq remove (list (match-beginning 0) (match-end 0)))
9107 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9108 (setq link (read-string "Link: "
9109 (org-link-unescape
9110 (org-match-string-no-properties 1)))))
9111 ((or (org-in-regexp org-angle-link-re)
9112 (org-in-regexp org-plain-link-re))
9113 ;; Convert to bracket link
9114 (setq remove (list (match-beginning 0) (match-end 0))
9115 link (read-string "Link: "
9116 (org-remove-angle-brackets (match-string 0)))))
9117 ((member complete-file '((4) (16)))
9118 ;; Completing read for file names.
9119 (setq link (org-file-complete-link complete-file)))
9120 (t
9121 ;; Read link, with completion for stored links.
9122 (with-output-to-temp-buffer "*Org Links*"
9123 (princ "Insert a link.
9125 (when org-stored-links
9127 (princ (mapconcat
9128 (lambda (x)
9129 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9131 (let ((cw (selected-window)))
9132 (select-window (get-buffer-window "*Org Links*" 'visible))
9133 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9134 (unless (pos-visible-in-window-p (point-max))
9135 (org-fit-window-to-buffer))
9136 (and (window-live-p cw) (select-window cw)))
9137 ;; Fake a link history, containing the stored links.
9138 (setq tmphist (append (mapcar 'car org-stored-links)
9139 org-insert-link-history))
9140 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9141 (mapcar 'car org-link-abbrev-alist)
9142 org-link-types))
9143 (unwind-protect
9144 (progn
9145 (setq link
9146 (let ((org-completion-use-ido nil)
9147 (org-completion-use-iswitchb nil))
9148 (org-completing-read
9149 "Link: "
9150 (append
9151 (mapcar (lambda (x) (list (concat x ":")))
9152 all-prefixes)
9153 (mapcar 'car org-stored-links))
9154 nil nil nil
9155 'tmphist
9156 (car (car org-stored-links)))))
9158 (error "No link selected"))
9159 (if (or (member link all-prefixes)
9160 (and (equal ":" (substring link -1))
9161 (member (substring link 0 -1) all-prefixes)
9162 (setq link (substring link 0 -1))))
9163 (setq link (org-link-try-special-completion link))))
9164 (set-window-configuration wcf)
9165 (kill-buffer "*Org Links*"))
9166 (setq entry (assoc link org-stored-links))
9167 (or entry (push link org-insert-link-history))
9168 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9169 (not org-keep-stored-link-after-insertion))
9170 (setq org-stored-links (delq (assoc link org-stored-links)
9171 org-stored-links)))
9172 (setq desc (or desc (nth 1 entry)))))
9174 (if (string-match org-plain-link-re link)
9175 ;; URL-like link, normalize the use of angular brackets.
9176 (setq link (org-make-link (org-remove-angle-brackets link))))
9178 ;; Check if we are linking to the current file with a search option
9179 ;; If yes, simplify the link by using only the search option.
9180 (when (and buffer-file-name
9182 (let* ((path (match-string 1 link))
9183 (case-fold-search nil)
9184 (search (match-string 2 link)))
9185 (save-match-data
9186 (if (equal (file-truename buffer-file-name) (file-truename path))
9187 ;; We are linking to this same file, with a search option
9188 (setq link search)))))
9190 ;; Check if we can/should use a relative path. If yes, simplify the link
9192 (let* ((type (match-string 1 link))
9193 (path (match-string 2 link))
9194 (origpath path)
9195 (case-fold-search nil))
9196 (cond
9197 ((or (eq org-link-file-path-type 'absolute)
9198 (equal complete-file '(16)))
9199 (setq path (abbreviate-file-name (expand-file-name path))))
9200 ((eq org-link-file-path-type 'noabbrev)
9201 (setq path (expand-file-name path)))
9202 ((eq org-link-file-path-type 'relative)
9203 (setq path (file-relative-name path)))
9204 (t
9205 (save-match-data
9206 (if (string-match (concat "^" (regexp-quote
9207 (expand-file-name
9208 (file-name-as-directory
9209 default-directory))))
9210 (expand-file-name path))
9211 ;; We are linking a file with relative path name.
9212 (setq path (substring (expand-file-name path)
9213 (match-end 0)))
9214 (setq path (abbreviate-file-name (expand-file-name path)))))))
9215 (setq link (concat type path))
9216 (if (equal desc origpath)
9217 (setq desc path))))
9219 (if org-make-link-description-function
9220 (setq desc (funcall org-make-link-description-function link desc))
9221 (if default-description (setq desc default-description)))
9223 (setq desc (read-string "Description: " desc))
9225 (if remove (apply 'delete-region remove))
9226 (insert (org-make-link-string link desc))))
9228 (defun org-link-try-special-completion (type)
9229 "If there is completion support for link type TYPE, offer it."
9230 (let ((fun (intern (concat "org-" type "-complete-link"))))
9231 (if (functionp fun)
9232 (funcall fun)
9233 (read-string "Link (no completion support): " (concat type ":")))))
9235 (defun org-file-complete-link (&optional arg)
9236 "Create a file link using completion."
9237 (let (file link)
9238 (setq file (read-file-name "File: "))
9239 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9240 (pwd1 (file-name-as-directory (abbreviate-file-name
9241 (expand-file-name ".")))))
9242 (cond
9243 ((equal arg '(16))
9244 (setq link (org-make-link
9245 "file:"
9246 (abbreviate-file-name (expand-file-name file)))))
9248 (setq link (org-make-link "file:" (match-string 1 file))))
9250 (expand-file-name file))
9251 (setq link (org-make-link
9252 "file:" (match-string 1 (expand-file-name file)))))
9253 (t (setq link (org-make-link "file:" file)))))
9254 link))
9256 (defun org-completing-read (&rest args)
9257 "Completing-read with SPACE being a normal character."
9258 (let ((enable-recursive-minibuffers t)
9259 (minibuffer-local-completion-map
9260 (copy-keymap minibuffer-local-completion-map)))
9261 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9262 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9263 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9264 (apply 'org-icompleting-read args)))
9266 (defun org-completing-read-no-i (&rest args)
9267 (let (org-completion-use-ido org-completion-use-iswitchb)
9268 (apply 'org-completing-read args)))
9270 (defun org-iswitchb-completing-read (prompt choices &rest args)
9271 "Use iswitch as a completing-read replacement to choose from choices.
9272 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9273 from."
9274 (let* ((iswitchb-use-virtual-buffers nil)
9275 (iswitchb-make-buflist-hook
9276 (lambda ()
9277 (setq iswitchb-temp-buflist choices))))
9278 (iswitchb-read-buffer prompt)))
9280 (defun org-icompleting-read (&rest args)
9281 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9282 (org-without-partial-completion
9283 (if (and org-completion-use-ido
9284 (fboundp 'ido-completing-read)
9285 (boundp 'ido-mode) ido-mode
9286 (listp (second args)))
9287 (let ((ido-enter-matching-directory nil))
9288 (apply 'ido-completing-read (concat (car args))
9289 (if (consp (car (nth 1 args)))
9290 (mapcar 'car (nth 1 args))
9291 (nth 1 args))
9292 (cddr args)))
9293 (if (and org-completion-use-iswitchb
9294 (boundp 'iswitchb-mode) iswitchb-mode
9295 (listp (second args)))
9296 (apply 'org-iswitchb-completing-read (concat (car args))
9297 (if (consp (car (nth 1 args)))
9298 (mapcar 'car (nth 1 args))
9299 (nth 1 args))
9300 (cddr args))
9301 (apply 'completing-read args)))))
9303 (defun org-extract-attributes (s)
9304 "Extract the attributes cookie from a string and set as text property."
9305 (let (a attr (start 0) key value)
9306 (save-match-data
9308 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9310 (setq key (match-string 1 a) value (match-string 2 a)
9311 start (match-end 0)
9312 attr (plist-put attr (intern key) value))))
9313 (org-add-props s nil 'org-attr attr))
9314 s))
9316 (defun org-extract-attributes-from-string (tag)
9317 (let (key value attr)
9319 (setq key (match-string 1 tag) value (match-string 2 tag)
9320 tag (replace-match "" t t tag)
9321 attr (plist-put attr (intern key) value)))
9322 (cons tag attr)))
9324 (defun org-attributes-to-string (plist)
9325 "Format a property list into an HTML attribute list."
9326 (let ((s "") key value)
9327 (while plist
9328 (setq key (pop plist) value (pop plist))
9329 (and value
9331 s))
9333 ;;; Opening/following a link
9335 (defvar org-link-search-failed nil)
9337 (defvar org-open-link-functions nil
9338 "Hook for functions finding a plain text link.
9339 These functions must take a single argument, the link content.
9340 They will be called for links that look like [[link text][description]]
9344 These functions will be called *before* Org attempts to resolve the
9345 link by doing text searches in the current buffer - so if you want a
9347 handle this as a special case.
9349 When the function does handle the link, it must return a non-nil value.
9350 If it decides that it is not responsible for this link, it must return
9351 nil to indicate that that Org-mode can continue with other options
9352 like exact and fuzzy text search.")
9354 (defun org-next-link ()
9355 "Move forward to the next link.
9356 If the link is in hidden text, expose it."
9357 (interactive)
9358 (when (and org-link-search-failed (eq this-command last-command))
9359 (goto-char (point-min))
9360 (message "Link search wrapped back to beginning of buffer"))
9361 (setq org-link-search-failed nil)
9362 (let* ((pos (point))
9363 (ct (org-context))
9364 (a (assoc :link ct)))
9365 (if a (goto-char (nth 2 a)))
9366 (if (re-search-forward org-any-link-re nil t)
9367 (progn
9368 (goto-char (match-beginning 0))
9369 (if (outline-invisible-p) (org-show-context)))
9370 (goto-char pos)
9371 (setq org-link-search-failed t)
9372 (error "No further link found"))))
9374 (defun org-previous-link ()
9375 "Move backward to the previous link.
9376 If the link is in hidden text, expose it."
9377 (interactive)
9378 (when (and org-link-search-failed (eq this-command last-command))
9379 (goto-char (point-max))
9380 (message "Link search wrapped back to end of buffer"))
9381 (setq org-link-search-failed nil)
9382 (let* ((pos (point))
9383 (ct (org-context))
9384 (a (assoc :link ct)))
9385 (if a (goto-char (nth 1 a)))
9386 (if (re-search-backward org-any-link-re nil t)
9387 (progn
9388 (goto-char (match-beginning 0))
9389 (if (outline-invisible-p) (org-show-context)))
9390 (goto-char pos)
9391 (setq org-link-search-failed t)
9392 (error "No further link found"))))
9394 (defun org-translate-link (s)
9395 "Translate a link string if a translation function has been defined."
9396 (if (and org-link-translation-function
9397 (fboundp org-link-translation-function)
9399 (progn
9400 (setq s (funcall org-link-translation-function
9401 (match-string 1) (match-string 2)))
9402 (concat (car s) ":" (cdr s)))
9403 s))
9405 (defun org-translate-link-from-planner (type path)
9406 "Translate a link from Emacs Planner syntax so that Org can follow it.
9407 This is still an experimental function, your mileage may vary."
9408 (cond
9409 ((member type '("http" "https" "news" "ftp"))
9410 ;; standard Internet links are the same.
9411 nil)
9412 ((and (equal type "irc") (string-match "^//" path))
9413 ;; Planner has two / at the beginning of an irc link, we have 1.
9414 ;; We should have zero, actually....
9415 (setq path (substring path 1)))
9416 ((and (equal type "lisp") (string-match "^/" path))
9417 ;; Planner has a slash, we do not.
9418 (setq type "elisp" path (substring path 1)))
9420 ;; A typical message link. Planner has the id after the final slash,
9421 ;; we separate it with a hash mark
9422 (setq path (concat (match-string 1 path) "#"
9423 (org-remove-angle-brackets (match-string 2 path)))))
9424 )
9425 (cons type path))
9427 (defun org-find-file-at-mouse (ev)
9428 "Open file link or URL at mouse."
9429 (interactive "e")
9430 (mouse-set-point ev)
9431 (org-open-at-point 'in-emacs))
9433 (defun org-open-at-mouse (ev)
9434 "Open file link or URL at mouse.
9435 See the docstring of `org-open-file' for details."
9436 (interactive "e")
9437 (mouse-set-point ev)
9438 (if (eq major-mode 'org-agenda-mode)
9439 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9440 (org-open-at-point))
9442 (defvar org-window-config-before-follow-link nil
9443 "The window configuration before following a link.
9444 This is saved in case the need arises to restore it.")
9446 (defvar org-open-link-marker (make-marker)
9447 "Marker pointing to the location where `org-open-at-point; was called.")
9449 ;;;###autoload
9450 (defun org-open-at-point-global ()
9451 "Follow a link like Org-mode does.
9452 This command can be called in any mode to follow a link that has
9453 Org-mode syntax."
9454 (interactive)
9455 (org-run-like-in-org-mode 'org-open-at-point))
9457 ;;;###autoload
9458 (defun org-open-link-from-string (s &optional arg reference-buffer)
9459 "Open a link in the string S, as if it was in Org-mode."
9461 (let ((reference-buffer (or reference-buffer (current-buffer))))
9462 (with-temp-buffer
9463 (let ((org-inhibit-startup (not reference-buffer)))
9464 (org-mode)
9465 (insert s)
9466 (goto-char (point-min))
9467 (when reference-buffer
9468 (setq org-link-abbrev-alist-local
9469 (with-current-buffer reference-buffer
9470 org-link-abbrev-alist-local)))
9471 (org-open-at-point arg reference-buffer)))))
9473 (defvar org-open-at-point-functions nil
9474 "Hook that is run when following a link at point.
9476 Functions in this hook must return t if they identify and follow
9477 a link at point. If they don't find anything interesting at point,
9478 they must return nil.")
9480 (defun org-open-at-point (&optional arg reference-buffer)
9481 "Open link at or after point.
9482 If there is no link at point, this function will search forward up to
9483 the end of the current line.
9484 Normally, files will be opened by an appropriate application. If the
9485 optional prefix argument ARG is non-nil, Emacs will visit the file.
9486 With a double prefix argument, try to open outside of Emacs, in the
9487 application the system uses for this file type."
9488 (interactive "P")
9489 ;; if in a code block, then open the block's results
9490 (unless (call-interactively #'org-babel-open-src-block-result)
9491 (org-load-modules-maybe)
9492 (move-marker org-open-link-marker (point))
9493 (setq org-window-config-before-follow-link (current-window-configuration))
9494 (org-remove-occur-highlights nil nil t)
9495 (cond
9496 ((and (org-at-heading-p)
9497 (not (org-in-regexp
9502 (not (get-text-property (point) 'org-linked-text)))
9503 (or (org-offer-links-in-entry arg)
9504 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9505 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9506 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9507 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9508 (not (org-in-regexp org-bracket-link-regexp)))
9509 (org-footnote-action))
9510 (t
9511 (let (type path link line search (pos (point)))
9512 (catch 'match
9513 (save-excursion
9515 (when (org-in-regexp org-bracket-link-regexp 1)
9516 (setq link (org-extract-attributes
9517 (org-link-unescape (org-match-string-no-properties 1))))
9519 (setq link (replace-match " " t t link)))
9520 (setq link (org-link-expand-abbrev link))
9521 (cond
9522 ((or (file-name-absolute-p link)
9524 (setq type "file" path link))
9525 ((string-match org-link-re-with-space3 link)
9526 (setq type (match-string 1 link) path (match-string 2 link)))
9527 (t (setq type "thisfile" path link)))
9528 (throw 'match t)))
9530 (when (get-text-property (point) 'org-linked-text)
9531 (setq type "thisfile"
9532 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9533 (1+ (point)) (point))
9534 path (buffer-substring
9535 (or (previous-single-property-change pos 'org-linked-text)
9536 (point-min))
9537 (or (next-single-property-change pos 'org-linked-text)
9538 (point-max))))
9539 (throw 'match t))
9541 (save-excursion
9542 (when (or (org-in-regexp org-angle-link-re)
9543 (org-in-regexp org-plain-link-re))
9544 (setq type (match-string 1)
9545 path (org-link-unescape (match-string 2)))
9546 (throw 'match t)))
9547 (save-excursion
9549 (setq type "tags"
9550 path (match-string 1))
9551 (while (string-match ":" path)
9552 (setq path (replace-match "+" t t path)))
9553 (throw 'match t)))
9555 (setq type "tree-match"
9556 path (match-string 1))
9557 (throw 'match t)))
9558 (unless path
9559 (error "No link found"))
9561 ;; switch back to reference buffer
9562 ;; needed when if called in a temporary buffer through
9563 ;; org-open-link-from-string
9564 (with-current-buffer (or reference-buffer (current-buffer))
9566 ;; Remove any trailing spaces in path
9568 (setq path (replace-match "" t t path)))
9569 (if (and org-link-translation-function
9570 (fboundp org-link-translation-function))
9571 ;; Check if we need to translate the link
9572 (let ((tmp (funcall org-link-translation-function type path)))
9573 (setq type (car tmp) path (cdr tmp))))
9575 (cond
9577 ((assoc type org-link-protocols)
9578 (funcall (nth 1 (assoc type org-link-protocols)) path))
9580 ((equal type "mailto")
9581 (let ((cmd (car org-link-mailto-program))
9582 (args (cdr org-link-mailto-program)) args1
9583 (address path) (subject "") a)
9585 (setq address (match-string 1 path)
9586 subject (org-link-escape (match-string 2 path))))
9587 (while args
9588 (cond
9589 ((not (stringp (car args))) (push (pop args) args1))
9590 (t (setq a (pop args))
9591 (if (string-match "%a" a)
9592 (setq a (replace-match address t t a)))
9593 (if (string-match "%s" a)
9594 (setq a (replace-match subject t t a)))
9595 (push a args1))))
9596 (apply cmd (nreverse args1))))
9598 ((member type '("http" "https" "ftp" "news"))
9599 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9600 (org-link-escape
9601 path org-link-escape-chars-browser)
9602 path))))
9604 ((string= type "doi")
9605 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9606 (org-link-escape
9607 path org-link-escape-chars-browser)
9608 path))))
9610 ((member type '("message"))
9611 (browse-url (concat type ":" path)))
9613 ((string= type "tags")
9614 (org-tags-view arg path))
9616 ((string= type "tree-match")
9619 ((string= type "file")
9621 (setq line (string-to-number (match-string 1 path))
9622 path (substring path 0 (match-beginning 0)))
9624 (setq search (match-string 1 path)
9625 path (substring path 0 (match-beginning 0)))))
9626 (if (string-match "[*?{]" (file-name-nondirectory path))
9627 (dired path)
9628 (org-open-file path arg line search)))
9630 ((string= type "shell")
9631 (let ((cmd path))
9632 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9633 (string-match org-confirm-shell-link-not-regexp cmd))
9634 (not org-confirm-shell-link-function)
9635 (funcall org-confirm-shell-link-function
9637 (org-add-props cmd nil
9638 'face 'org-warning))))
9639 (progn
9640 (message "Executing %s" cmd)
9641 (shell-command cmd))
9642 (error "Abort"))))
9644 ((string= type "elisp")
9645 (let ((cmd path))
9646 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9647 (string-match org-confirm-elisp-link-not-regexp cmd))
9648 (not org-confirm-elisp-link-function)
9649 (funcall org-confirm-elisp-link-function
9651 (org-add-props cmd nil
9652 'face 'org-warning))))
9653 (message "%s => %s" cmd
9654 (if (equal (string-to-char cmd) ?\()
9655 (eval (read cmd))
9656 (call-interactively (read cmd))))
9657 (error "Abort"))))
9659 ((and (string= type "thisfile")
9660 (run-hook-with-args-until-success
9661 'org-open-link-functions path)))
9663 ((string= type "thisfile")
9664 (if arg
9665 (switch-to-buffer-other-window
9666 (org-get-buffer-for-internal-link (current-buffer)))
9667 (org-mark-ring-push))
9668 (let ((cmd `(org-link-search
9669 ,path
9670 ,(cond ((equal arg '(4)) ''occur)
9671 ((equal arg '(16)) ''org-occur)
9672 (t nil))
9673 ,pos)))
9674 (condition-case nil (let ((org-link-search-inhibit-query t))
9675 (eval cmd))
9676 (error (progn (widen) (eval cmd))))))
9678 (t
9679 (browse-url-at-point)))))))
9680 (move-marker org-open-link-marker nil)
9681 (run-hook-with-args 'org-follow-link-hook)))
9683 (defun org-offer-links-in-entry (&optional nth zero)
9684 "Offer links in the current entry and follow the selected link.
9685 If there is only one link, follow it immediately as well.
9686 If NTH is an integer, immediately pick the NTH link found.
9687 If ZERO is a string, check also this string for a link, and if
9688 there is one, offer it as link number zero."
9692 (cnt ?0)
9693 (in-emacs (if (integerp nth) nil nth))
9694 have-zero end links link c)
9695 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9696 (push (match-string 0 zero) links)
9697 (setq cnt (1- cnt) have-zero t))
9698 (save-excursion
9699 (org-back-to-heading t)
9700 (setq end (save-excursion (outline-next-heading) (point)))
9701 (while (re-search-forward re end t)
9702 (push (match-string 0) links))
9703 (setq links (org-uniquify (reverse links))))
9705 (cond
9706 ((null links)
9707 (message "No links"))
9708 ((equal (length links) 1)
9709 (setq link (list (car links))))
9710 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9711 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9712 (t ; we have to select a link
9713 (save-excursion
9714 (save-window-excursion
9715 (delete-other-windows)
9716 (with-output-to-temp-buffer "*Select Link*"
9717 (mapc (lambda (l)
9718 (if (not (string-match org-bracket-link-regexp l))
9720 (org-remove-angle-brackets l)))
9721 (if (match-end 3)
9723 (match-string 3 l) (match-string 1 l)))
9725 (match-string 1 l))))))
9726 links))
9727 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9728 (message "Select link to open, RET to open all:")
9729 (setq c (read-char-exclusive))
9730 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9731 (when (equal c ?q) (error "Abort"))
9732 (if (equal c ?\C-m)
9733 (setq link links)
9734 (setq nth (- c ?0))
9735 (if have-zero (setq nth (1+ nth)))
9736 (unless (and (integerp nth) (>= (length links) nth))
9737 (error "Invalid link selection"))
9738 (setq link (list (nth (1- nth) links))))))
9739 (if link
9740 (let ((buf (current-buffer)))
9741 (dolist (l link)
9742 (org-open-link-from-string l in-emacs buf))
9743 t)
9744 nil)))
9746 ;; Add special file links that specify the way of opening
9748 (org-add-link-type "file+sys" 'org-open-file-with-system)
9749 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9750 (defun org-open-file-with-system (path)
9751 "Open file at PATH using the system way of opening it."
9752 (org-open-file path 'system))
9753 (defun org-open-file-with-emacs (path)
9754 "Open file at PATH in Emacs."
9755 (org-open-file path 'emacs))
9756 (defun org-remove-file-link-modifiers ()
9757 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9758 (goto-char (point-min))
9760 (org-if-unprotected
9761 (replace-match "file:" t t))))
9762 (eval-after-load "org-exp"
9763 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9764 'org-remove-file-link-modifiers))
9766 ;;;; Time estimates
9768 (defun org-get-effort (&optional pom)
9769 "Get the effort estimate for the current entry."
9770 (org-entry-get pom org-effort-property))
9772 ;;; File search
9774 (defvar org-create-file-search-functions nil
9775 "List of functions to construct the right search string for a file link.
9776 These functions are called in turn with point at the location to
9777 which the link should point.
9779 A function in the hook should first test if it would like to
9780 handle this file type, for example by checking the `major-mode'
9781 or the file extension. If it decides not to handle this file, it
9782 should just return nil to give other functions a chance. If it
9783 does handle the file, it must return the search string to be used
9784 when following the link. The search string will be part of the
9785 file link, given after a double colon, and `org-open-at-point'
9786 will automatically search for it. If special measures must be
9787 taken to make the search successful, another function should be
9788 added to the companion hook `org-execute-file-search-functions',
9789 which see.
9791 A function in this hook may also use `setq' to set the variable
9792 `description' to provide a suggestion for the descriptive text to
9793 be used for this link when it gets inserted into an Org-mode
9796 (defvar org-execute-file-search-functions nil
9797 "List of functions to execute a file search triggered by a link.
9799 Functions added to this hook must accept a single argument, the
9800 search string that was part of the file link, the part after the
9801 double colon. The function must first check if it would like to
9802 handle this search, for example by checking the `major-mode' or
9803 the file extension. If it decides not to handle this search, it
9804 should just return nil to give other functions a chance. If it
9805 does handle the search, it must return a non-nil value to keep
9806 other functions from trying.
9808 Each function can access the current prefix argument through the
9809 variable `current-prefix-argument'. Note that a single prefix is
9810 used to force opening a link in Emacs, so it may be good to only
9811 use a numeric or double prefix to guide the search function.
9813 In case this is needed, a function in this hook can also restore
9814 the window configuration before `org-open-at-point' was called using:
9816 (set-window-configuration org-window-config-before-follow-link)")
9818 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9819 (defun org-link-search (s &optional type avoid-pos stealth)
9820 "Search for a link search option.
9821 If S is surrounded by forward slashes, it is interpreted as a
9822 regular expression. In org-mode files, this will create an `org-occur'
9823 sparse tree. In ordinary files, `occur' will be used to list matches.
9824 If the current buffer is in `dired-mode', grep will be used to search
9825 in all files. If AVOID-POS is given, ignore matches near that position.
9827 When optional argument STEALTH is non-nil, do not modify
9828 visibility around point, thus ignoring
9829 `org-show-hierarchy-above', `org-show-following-heading' and
9830 `org-show-siblings' variables."
9831 (let ((case-fold-search t)
9835 org-emphasis-alist)
9837 (pos (point))
9838 (pre nil) (post nil)
9839 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9840 (cond
9841 ;; First check if there are any special search functions
9842 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9843 ;; Now try the builtin stuff
9844 ((and (equal (string-to-char s0) ?#)
9845 (> (length s0) 1)
9846 (save-excursion
9847 (goto-char (point-min))
9848 (and
9849 (re-search-forward
9851 (setq type 'dedicated
9852 pos (match-beginning 0))))
9853 ;; There is an exact target for this
9854 (goto-char pos)
9855 (org-back-to-heading t)))
9856 ((save-excursion
9857 (goto-char (point-min))
9858 (and
9859 (re-search-forward
9860 (concat "<<" (regexp-quote s0) ">>") nil t)
9861 (setq type 'dedicated
9862 pos (match-beginning 0))))
9863 ;; There is an exact target for this
9864 (goto-char pos))
9866 (save-excursion
9867 (goto-char (point-min))
9868 (and
9869 (re-search-forward
9870 (concat "[^[]" (regexp-quote
9871 (format org-coderef-label-format
9872 (match-string 1 s0))))
9873 nil t)
9874 (setq type 'dedicated
9875 pos (1+ (match-beginning 0))))))
9876 ;; There is a coderef target for this
9877 (goto-char pos))
9879 ;; A regular expression
9880 (cond
9881 ((eq major-mode 'org-mode)
9882 (org-occur (match-string 1 s)))
9883 ;;((eq major-mode 'dired-mode)
9884 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9885 (t (org-do-occur (match-string 1 s)))))
9886 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9887 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9888 (goto-char (point-min))
9889 (cond
9890 ((let (case-fold-search)
9891 (re-search-forward (format org-complex-heading-regexp-format
9892 (regexp-quote s))
9893 nil t))
9894 ;; OK, found a match
9895 (setq type 'dedicated)
9896 (goto-char (match-beginning 0)))
9897 ((and (not org-link-search-inhibit-query)
9898 (eq org-link-search-must-match-exact-headline 'query-to-create)
9899 (y-or-n-p "No match - create this as a new heading? "))
9900 (goto-char (point-max))
9901 (or (bolp) (newline))
9903 (beginning-of-line 0))
9904 (t
9905 (goto-char pos)
9906 (error "No match"))))
9907 (t
9908 ;; A normal search string
9909 (when (equal (string-to-char s) ?*)
9910 ;; Anchor on headlines, post may include tags.
9913 s (substring s 1)))
9914 (remove-text-properties
9915 0 (length s)
9916 '(face nil mouse-face nil keymap nil fontified nil) s)
9917 ;; Make a series of regular expressions to find a match
9926 re4 (concat "[^a-zA-Z_]" re4_)
9928 re1 (concat pre re2 post)
9929 re3 (concat pre (if pre re4_ re4) post)
9930 re5 (concat pre ".*" re4)
9931 re2 (concat pre re2)
9932 re2a (concat pre (if pre re2a_ re2a))
9933 re4 (concat pre (if pre re4_ re4))
9937 ))
9938 (cond
9939 ((eq type 'org-occur) (org-occur reall))
9940 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9941 (t (goto-char (point-min))
9942 (setq type 'fuzzy)
9943 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9944 (org-search-not-self 1 re1 nil t)
9945 (org-search-not-self 1 re2 nil t)
9946 (org-search-not-self 1 re2a nil t)
9947 (org-search-not-self 1 re3 nil t)
9948 (org-search-not-self 1 re4 nil t)
9949 (org-search-not-self 1 re5 nil t)
9950 )
9951 (goto-char (match-beginning 1))
9952 (goto-char pos)
9953 (error "No match"))))))
9954 (and (eq major-mode 'org-mode)
9955 (not stealth)
9956 (org-show-context 'link-search))
9957 type))
9959 (defun org-search-not-self (group &rest args)
9960 "Execute `re-search-forward', but only accept matches that do not
9961 enclose the position of `org-open-link-marker'."
9962 (let ((m org-open-link-marker))
9963 (catch 'exit
9964 (while (apply 're-search-forward args)
9965 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9966 (goto-char (match-end group))
9967 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9968 (> (match-beginning 0) (marker-position m))
9969 (< (match-end 0) (marker-position m)))
9970 (save-match-data
9971 (or (not (org-in-regexp
9972 org-bracket-link-analytic-regexp 1))
9973 (not (match-end 4)) ; no description
9974 (and (<= (match-beginning 4) (point))
9975 (>= (match-end 4) (point))))))
9976 (throw 'exit (point))))))))
9978 (defun org-get-buffer-for-internal-link (buffer)
9979 "Return a buffer to be used for displaying the link target of internal links."
9980 (cond
9981 ((not org-display-internal-link-with-indirect-buffer)
9982 buffer)
9983 ((string-match "(Clone)$" (buffer-name buffer))
9984 (message "Buffer is already a clone, not making another one")
9985 ;; we also do not modify visibility in this case
9986 buffer)
9987 (t ; make a new indirect buffer for displaying the link
9988 (let* ((bn (buffer-name buffer))
9989 (ibn (concat bn "(Clone)"))
9990 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9991 (with-current-buffer ib (org-overview))
9992 ib))))
9994 (defun org-do-occur (regexp &optional cleanup)
9995 "Call the Emacs command `occur'.
9996 If CLEANUP is non-nil, remove the printout of the regular expression
9997 in the *Occur* buffer. This is useful if the regex is long and not useful
9998 to read."
9999 (occur regexp)
10000 (when cleanup
10001 (let ((cwin (selected-window)) win beg end)
10002 (when (setq win (get-buffer-window "*Occur*"))
10003 (select-window win))
10004 (goto-char (point-min))
10005 (when (re-search-forward "match[a-z]+" nil t)
10006 (setq beg (match-end 0))
10008 (setq end (1- (match-beginning 0)))))
10009 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10010 (goto-char (point-min))
10011 (select-window cwin))))
10013 ;;; The mark ring for links jumps
10015 (defvar org-mark-ring nil
10016 "Mark ring for positions before jumps in Org-mode.")
10017 (defvar org-mark-ring-last-goto nil
10018 "Last position in the mark ring used to go back.")
10019 ;; Fill and close the ring
10020 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10021 (loop for i from 1 to org-mark-ring-length do
10022 (push (make-marker) org-mark-ring))
10023 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10024 org-mark-ring)
10026 (defun org-mark-ring-push (&optional pos buffer)
10027 "Put the current position or POS into the mark ring and rotate it."
10028 (interactive)
10029 (setq pos (or pos (point)))
10030 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10031 (move-marker (car org-mark-ring)
10032 (or pos (point))
10033 (or buffer (current-buffer)))
10034 (message "%s"
10035 (substitute-command-keys
10038 (defun org-mark-ring-goto (&optional n)
10039 "Jump to the previous position in the mark ring.
10040 With prefix arg N, jump back that many stored positions. When
10041 called several times in succession, walk through the entire ring.
10042 Org-mode commands jumping to a different position in the current file,
10043 or to another Org-mode file, automatically push the old position
10044 onto the ring."
10045 (interactive "p")
10046 (let (p m)
10047 (if (eq last-command this-command)
10048 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10049 (setq p org-mark-ring))
10050 (setq org-mark-ring-last-goto p)
10051 (setq m (car p))
10052 (org-pop-to-buffer-same-window (marker-buffer m))
10053 (goto-char m)
10054 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10056 (defun org-remove-angle-brackets (s)
10057 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10058 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10059 s)
10060 (defun org-add-angle-brackets (s)
10061 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10062 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10063 s)
10064 (defun org-remove-double-quotes (s)
10067 s)
10069 ;;; Following specific links
10071 (defun org-follow-timestamp-link ()
10072 (cond
10073 ((org-at-date-range-p t)
10074 (let ((org-agenda-start-on-weekday)
10075 (t1 (match-string 1))
10076 (t2 (match-string 2)))
10077 (setq t1 (time-to-days (org-time-string-to-time t1))
10078 t2 (time-to-days (org-time-string-to-time t2)))
10079 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10080 ((org-at-timestamp-p t)
10081 (org-agenda-list nil (time-to-days (org-time-string-to-time
10082 (substring (match-string 1) 0 10)))
10083 1))
10084 (t (error "This should not happen"))))
10087 ;;; Following file links
10088 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10089 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10090 (declare-function mailcap-mime-info
10091 "mailcap" (string &optional request no-decode))
10092 (defvar org-wait nil)
10093 (defun org-open-file (path &optional in-emacs line search)
10094 "Open the file at PATH.
10095 First, this expands any special file name abbreviations. Then the
10096 configuration variable `org-file-apps' is checked if it contains an
10097 entry for this file type, and if yes, the corresponding command is launched.
10099 If no application is found, Emacs simply visits the file.
10101 With optional prefix argument IN-EMACS, Emacs will visit the file.
10103 prefix arg, Org tries to avoid opening in Emacs
10104 and to use an external application to visit the file.
10106 Optional LINE specifies a line to go to, optional SEARCH a string
10107 to search for. If LINE or SEARCH is given, the file will be
10108 opened in Emacs, unless an entry from org-file-apps that makes
10109 use of groups in a regexp matches.
10111 If you want to change the way frames are used when following a
10112 link, please customize `org-link-frame-setup'.
10114 If the file does not exist, an error is thrown."
10115 (let* ((file (if (equal path "")
10116 buffer-file-name
10117 (substitute-in-file-name (expand-file-name path))))
10118 (file-apps (append org-file-apps (org-default-apps)))
10119 (apps (org-remove-if
10120 'org-file-apps-entry-match-against-dlink-p file-apps))
10121 (apps-dlink (org-remove-if-not
10122 'org-file-apps-entry-match-against-dlink-p file-apps))
10123 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10124 (dirp (if remp nil (file-directory-p file)))
10125 (file (if (and dirp org-open-directory-means-index-dot-org)
10126 (concat (file-name-as-directory file) "index.org")
10127 file))
10128 (a-m-a-p (assq 'auto-mode apps))
10129 (dfile (downcase file))
10130 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10131 (link (cond ((and (eq line nil)
10132 (eq search nil))
10133 file)
10134 (line
10135 (concat file "::" (number-to-string line)))
10136 (search
10137 (concat file "::" search))))
10138 (dlink (downcase link))
10139 (old-buffer (current-buffer))
10140 (old-pos (point))
10141 (old-mode major-mode)
10142 ext cmd link-match-data)
10144 (setq ext (match-string 1 dfile))
10146 (setq ext (match-string 1 dfile))))
10147 (cond
10148 ((member in-emacs '((16) system))
10149 (setq cmd (cdr (assoc 'system apps))))
10150 (in-emacs (setq cmd 'emacs))
10151 (t
10152 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10153 (and dirp (cdr (assoc 'directory apps)))
10154 ; first, try matching against apps-dlink
10155 ; if we get a match here, store the match data for later
10156 (let ((match (assoc-default dlink apps-dlink
10157 'string-match)))
10158 (if match
10159 (progn (setq link-match-data (match-data))
10160 match)
10161 (progn (setq in-emacs (or in-emacs line search))
10162 nil))) ; if we have no match in apps-dlink,
10163 ; always open the file in emacs if line or search
10164 ; is given (for backwards compatibility)
10165 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10166 'string-match)
10167 (cdr (assoc ext apps))
10168 (cdr (assoc t apps))))))
10169 (when (eq cmd 'system)
10170 (setq cmd (cdr (assoc 'system apps))))
10171 (when (eq cmd 'default)
10172 (setq cmd (cdr (assoc t apps))))
10173 (when (eq cmd 'mailcap)
10174 (require 'mailcap)
10175 (mailcap-parse-mailcaps)
10176 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10177 (command (mailcap-mime-info mime-type)))
10178 (if (stringp command)
10179 (setq cmd command)
10180 (setq cmd 'emacs))))
10181 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10182 (not (file-exists-p file))
10183 (not org-open-non-existing-files))
10184 (error "No such file: %s" file))
10185 (cond
10187 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10189 (setq cmd (replace-match "%s" t t cmd)))
10190 (while (string-match "%s" cmd)
10191 (setq cmd (replace-match
10192 (save-match-data
10193 (shell-quote-argument
10194 (convert-standard-filename file)))
10195 t t cmd)))
10197 ;; Replace "%1", "%2" etc. in command with group matches from regex
10198 (save-match-data
10199 (let ((match-index 1)
10200 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10201 (set-match-data link-match-data)
10202 (while (<= match-index number-of-groups)
10203 (let ((regex (concat "%" (number-to-string match-index)))
10204 (replace-with (match-string match-index dlink)))
10205 (while (string-match regex cmd)
10206 (setq cmd (replace-match replace-with t t cmd))))
10207 (setq match-index (+ match-index 1)))))
10209 (save-window-excursion
10210 (start-process-shell-command cmd nil cmd)
10211 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10212 ))
10213 ((or (stringp cmd)
10214 (eq cmd 'emacs))
10215 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10216 (widen)
10217 (if line (org-goto-line line)
10218 (if search (org-link-search search))))
10219 ((consp cmd)
10220 (let ((file (convert-standard-filename file)))
10221 (save-match-data
10222 (set-match-data link-match-data)
10223 (eval cmd))))
10224 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10225 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10226 (or (not (equal old-buffer (current-buffer)))
10227 (not (equal old-pos (point))))
10228 (org-mark-ring-push old-pos old-buffer))))
10230 (defun org-file-apps-entry-match-against-dlink-p (entry)
10231 "This function returns non-nil if `entry' uses a regular
10232 expression which should be matched against the whole link by
10233 org-open-file.
10235 It assumes that is the case when the entry uses a regular
10236 expression which has at least one grouping construct and the
10237 action is either a lisp form or a command string containing
10238 '%1', i.e. using at least one subexpression match as a
10239 parameter."
10240 (let ((selector (car entry))
10241 (action (cdr entry)))
10242 (if (stringp selector)
10243 (and (> (regexp-opt-depth selector) 0)
10244 (or (and (stringp action)
10245 (string-match "%[0-9]" action))
10246 (consp action)))
10247 nil)))
10249 (defun org-default-apps ()
10250 "Return the default applications for this operating system."
10251 (cond
10252 ((eq system-type 'darwin)
10253 org-file-apps-defaults-macosx)
10254 ((eq system-type 'windows-nt)
10255 org-file-apps-defaults-windowsnt)
10256 (t org-file-apps-defaults-gnu)))
10258 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10259 "Convert extensions to regular expressions in the cars of LIST.
10260 Also, weed out any non-string entries, because the return value is used
10261 only for regexp matching.
10262 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10263 point to the symbol `emacs', indicating that the file should
10264 be opened in Emacs."
10265 (append
10266 (delq nil
10267 (mapcar (lambda (x)
10268 (if (not (stringp (car x)))
10269 nil
10271 x
10273 list))
10274 (if add-auto-mode
10275 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10277 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10278 (defun org-file-remote-p (file)
10279 "Test whether FILE specifies a location on a remote system.
10280 Return non-nil if the location is indeed remote.
10284 (cond ((fboundp 'file-remote-p)
10285 (file-remote-p file))
10286 ((fboundp 'tramp-handle-file-remote-p)
10287 (tramp-handle-file-remote-p file))
10288 ((and (boundp 'ange-ftp-name-format)
10289 (string-match (car ange-ftp-name-format) file))
10290 t)
10291 (t nil)))
10294 ;;;; Refiling
10296 (defun org-get-org-file ()
10297 "Read a filename, with default directory `org-directory'."
10298 (let ((default (or org-default-notes-file remember-data-file)))
10299 (read-file-name (format "File name [%s]: " default)
10300 (file-name-as-directory org-directory)
10301 default)))
10303 (defun org-notes-order-reversed-p ()
10304 "Check if the current file should receive notes in reversed order."
10305 (cond
10306 ((not org-reverse-note-order) nil)
10307 ((eq t org-reverse-note-order) t)
10308 ((not (listp org-reverse-note-order)) nil)
10309 (t (catch 'exit
10310 (let ((all org-reverse-note-order)
10311 entry)
10312 (while (setq entry (pop all))
10313 (if (string-match (car entry) buffer-file-name)
10314 (throw 'exit (cdr entry))))
10315 nil)))))
10317 (defvar org-refile-target-table nil
10318 "The list of refile targets, created by `org-refile'.")
10320 (defvar org-agenda-new-buffers nil
10321 "Buffers created to visit agenda files.")
10323 (defvar org-refile-cache nil
10324 "Cache for refile targets.")
10326 (defvar org-refile-markers nil
10327 "All the markers used for caching refile locations.")
10329 (defun org-refile-marker (pos)
10330 "Get a new refile marker, but only if caching is in use."
10331 (if (not org-refile-use-cache)
10332 pos
10333 (let ((m (make-marker)))
10334 (move-marker m pos)
10335 (push m org-refile-markers)
10336 m)))
10338 (defun org-refile-cache-clear ()
10339 "Clear the refile cache and disable all the markers."
10340 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10341 (setq org-refile-markers nil)
10342 (setq org-refile-cache nil)
10343 (message "Refile cache has been cleared"))
10345 (defun org-refile-cache-check-set (set)
10346 "Check if all the markers in the cache still have live buffers."
10347 (let (marker)
10348 (catch 'exit
10349 (while (and set (setq marker (nth 3 (pop set))))
10350 ;; if org-refile-use-outline-path is 'file, marker may be nil
10351 (when (and marker (null (marker-buffer marker)))
10352 (message "not found") (sit-for 3)
10353 (throw 'exit nil)))
10354 t)))
10356 (defun org-refile-cache-put (set &rest identifiers)
10357 "Push the refile targets SET into the cache, under IDENTIFIERS."
10358 (let* ((key (sha1 (prin1-to-string identifiers)))
10359 (entry (assoc key org-refile-cache)))
10360 (if entry
10361 (setcdr entry set)
10362 (push (cons key set) org-refile-cache))))
10364 (defun org-refile-cache-get (&rest identifiers)
10365 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10366 (cond
10367 ((not org-refile-cache) nil)
10368 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10369 (t
10370 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10371 org-refile-cache))))
10372 (and set (org-refile-cache-check-set set) set)))))
10374 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10375 "Produce a table with refile targets."
10376 (let ((case-fold-search nil)
10377 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10378 (entries (or org-refile-targets '((nil . (:level . 1)))))
10379 targets tgs txt re files f desc descre fast-path-p level pos0)
10380 (message "Getting targets...")
10381 (with-current-buffer (or default-buffer (current-buffer))
10382 (while (setq entry (pop entries))
10383 (setq files (car entry) desc (cdr entry))
10384 (setq fast-path-p nil)
10385 (cond
10386 ((null files) (setq files (list (current-buffer))))
10387 ((eq files 'org-agenda-files)
10388 (setq files (org-agenda-files 'unrestricted)))
10389 ((and (symbolp files) (fboundp files))
10390 (setq files (funcall files)))
10391 ((and (symbolp files) (boundp files))
10392 (setq files (symbol-value files))))
10393 (if (stringp files) (setq files (list files)))
10394 (cond
10395 ((eq (car desc) :tag)
10397 ((eq (car desc) :todo)
10399 ((eq (car desc) :regexp)
10400 (setq descre (cdr desc)))
10401 ((eq (car desc) :level)
10403 (if org-odd-levels-only
10404 (1- (* 2 (cdr desc)))
10405 (cdr desc)))
10407 ((eq (car desc) :maxlevel)
10408 (setq fast-path-p t)
10410 (if org-odd-levels-only
10411 (1- (* 2 (cdr desc)))
10412 (cdr desc)))
10414 (t (error "Bad refiling target description %s" desc)))
10415 (while (setq f (pop files))
10416 (with-current-buffer
10417 (if (bufferp f) f (org-get-agenda-file-buffer f))
10418 (or
10419 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10420 (progn
10421 (if (bufferp f) (setq f (buffer-file-name
10422 (buffer-base-buffer f))))
10423 (setq f (and f (expand-file-name f)))
10424 (if (eq org-refile-use-outline-path 'file)
10425 (push (list (file-name-nondirectory f) f nil nil) tgs))
10426 (save-excursion
10427 (save-restriction
10428 (widen)
10429 (goto-char (point-min))
10430 (while (re-search-forward descre nil t)
10431 (goto-char (setq pos0 (point-at-bol)))
10432 (catch 'next
10433 (when org-refile-target-verify-function
10434 (save-match-data
10435 (or (funcall org-refile-target-verify-function)
10436 (throw 'next t))))
10437 (when (and (looking-at org-complex-heading-regexp)
10438 (not (member (match-string 4) excluded-entries))
10439 (match-string 4))
10440 (setq level (org-reduced-level
10441 (- (match-end 1) (match-beginning 1)))
10442 txt (org-link-display-format (match-string 4))
10444 re (format org-complex-heading-regexp-format
10445 (regexp-quote (match-string 4))))
10446 (when org-refile-use-outline-path
10447 (setq txt (mapconcat
10448 'org-protect-slash
10449 (append
10450 (if (eq org-refile-use-outline-path
10451 'file)
10452 (list (file-name-nondirectory
10453 (buffer-file-name
10454 (buffer-base-buffer))))
10455 (if (eq org-refile-use-outline-path
10456 'full-file-path)
10457 (list (buffer-file-name
10458 (buffer-base-buffer)))))
10459 (org-get-outline-path fast-path-p
10460 level txt)
10461 (list txt))
10462 "/")))
10463 (push (list txt f re (org-refile-marker (point)))
10464 tgs)))
10465 (when (= (point) pos0)
10466 ;; verification function has not moved point
10467 (goto-char (point-at-eol))))))))
10468 (when org-refile-use-cache
10469 (org-refile-cache-put tgs (buffer-file-name) descre))
10470 (setq targets (append tgs targets))
10471 ))))
10472 (message "Getting targets...done")
10473 (nreverse targets)))
10475 (defun org-protect-slash (s)
10476 (while (string-match "/" s)
10478 s)
10480 (defvar org-olpa (make-vector 20 nil))
10482 (defun org-get-outline-path (&optional fastp level heading)
10483 "Return the outline path to the current entry, as a list.
10485 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10486 routine which makes outline path derivations for an entire file,
10487 avoiding backtracing. Refile target collection makes use of that."
10488 (if fastp
10489 (progn
10490 (if (> level 19)
10491 (error "Outline path failure, more than 19 levels"))
10492 (loop for i from level upto 19 do
10493 (aset org-olpa i nil))
10494 (prog1
10495 (delq nil (append org-olpa nil))
10496 (aset org-olpa level heading)))
10497 (let (rtn case-fold-search)
10498 (save-excursion
10499 (save-restriction
10500 (widen)
10501 (while (org-up-heading-safe)
10502 (when (looking-at org-complex-heading-regexp)
10503 (push (org-match-string-no-properties 4) rtn)))
10504 rtn)))))
10506 (defun org-format-outline-path (path &optional width prefix)
10507 "Format the outline path PATH for display.
10508 Width is the maximum number of characters that is available.
10509 Prefix is a prefix to be included in the returned string,
10510 such as the file name."
10511 (setq width (or width 79))
10512 (if prefix (setq width (- width (length prefix))))
10513 (if (not path)
10514 (or prefix "")
10515 (let* ((nsteps (length path))
10516 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10517 (maxwidth (if (<= total-width width)
10518 10000 ;; everything fits
10519 ;; we need to shorten the level headings
10520 (/ (- width nsteps) nsteps)))
10521 (org-odd-levels-only nil)
10522 (n 0)
10523 (total (1+ (length prefix))))
10524 (setq maxwidth (max maxwidth 10))
10525 (concat prefix
10526 (mapconcat
10527 (lambda (h)
10528 (setq n (1+ n))
10529 (if (and (= n nsteps) (< maxwidth 10000))
10530 (setq maxwidth (- total-width total)))
10531 (if (< (length h) maxwidth)
10532 (progn (setq total (+ total (length h) 1)) h)
10533 (setq h (substring h 0 (- maxwidth 2))
10534 total (+ total maxwidth 1))
10536 (setq h (substring h 0 (match-beginning 0))))
10537 (setq h (concat h "..")))
10538 (org-add-props h nil 'face
10539 (nth (% (1- n) org-n-level-faces)
10540 org-level-faces))
10541 h)
10542 path "/")))))
10544 (defun org-display-outline-path (&optional file current)
10545 "Display the current outline path in the echo area."
10546 (interactive "P")
10547 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10548 (case-fold-search nil)
10549 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10550 (if current (setq path (append path
10551 (save-excursion
10552 (org-back-to-heading t)
10553 (if (looking-at org-complex-heading-regexp)
10554 (list (match-string 4)))))))
10555 (message "%s"
10556 (org-format-outline-path
10557 path
10558 (1- (frame-width))
10559 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10561 (defvar org-refile-history nil
10562 "History for refiling operations.")
10564 (defvar org-after-refile-insert-hook nil
10565 "Hook run after `org-refile' has inserted its stuff at the new location.
10566 Note that this is still *before* the stuff will be removed from
10567 the *old* location.")
10569 (defvar org-capture-last-stored-marker)
10570 (defun org-refile (&optional goto default-buffer rfloc)
10571 "Move the entry or entries at point to another heading.
10572 The list of target headings is compiled using the information in
10573 `org-refile-targets', which see.
10575 At the target location, the entry is filed as a subitem of the target
10576 heading. Depending on `org-reverse-note-order', the new subitem will
10577 either be the first or the last subitem.
10579 If there is an active region, all entries in that region will be moved.
10580 However, the region must fulfill the requirement that the first heading
10581 is the first one sets the top-level of the moved text - at most siblings
10582 below it are allowed.
10584 With prefix arg GOTO, the command will only visit the target location
10585 and not actually move anything.
10588 go to the location where the last refiling operation has put the subtree.
10589 With a prefix argument of `2', refile to the running clock.
10591 RFLOC can be a refile location obtained in a different way.
10593 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10595 If you are using target caching (see `org-refile-use-cache'),
10596 You have to clear the target cache in order to find new targets.
10597 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10598 prefix argument (`C-u C-u C-u C-c C-w')."
10600 (interactive "P")
10601 (if (member goto '(0 (64)))
10602 (org-refile-cache-clear)
10603 (let* ((cbuf (current-buffer))
10604 (regionp (org-region-active-p))
10605 (region-start (and regionp (region-beginning)))
10606 (region-end (and regionp (region-end)))
10607 (region-length (and regionp (- region-end region-start)))
10608 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10609 pos it nbuf file re level reversed)
10610 (setq last-command nil)
10611 (when regionp
10612 (goto-char region-start)
10613 (or (bolp) (goto-char (point-at-bol)))
10614 (setq region-start (point))
10615 (unless (or (org-kill-is-subtree-p
10616 (buffer-substring region-start region-end))
10617 (prog1 org-refile-active-region-within-subtree
10618 (org-toggle-heading)))
10619 (error "The region is not a (sequence of) subtree(s)")))
10620 (if (equal goto '(16))
10621 (org-refile-goto-last-stored)
10622 (when (or
10623 (and (equal goto 2)
10624 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10625 (prog1
10626 (setq it (list (or org-clock-heading "running clock")
10627 (buffer-file-name
10628 (marker-buffer org-clock-hd-marker))
10629 ""
10630 (marker-position org-clock-hd-marker)))
10631 (setq goto nil)))
10632 (setq it (or rfloc
10633 (let (heading-text)
10634 (save-excursion
10635 (unless goto
10636 (org-back-to-heading t)
10637 (setq heading-text
10638 (nth 4 (org-heading-components))))
10639 (org-refile-get-location
10640 (cond (goto "Goto")
10641 (regionp "Refile region to")
10644 default-buffer
10645 (and (not (equal '(4) goto))
10646 org-refile-allow-creating-parent-nodes)
10647 goto))))))
10648 (setq file (nth 1 it)
10649 re (nth 2 it)
10650 pos (nth 3 it))
10651 (if (and (not goto)
10652 pos
10653 (equal (buffer-file-name) file)
10654 (if regionp
10655 (and (>= pos region-start)
10656 (<= pos region-end))
10657 (and (>= pos (point))
10658 (< pos (save-excursion
10659 (org-end-of-subtree t t))))))
10660 (error "Cannot refile to position inside the tree or region"))
10662 (setq nbuf (or (find-buffer-visiting file)
10663 (find-file-noselect file)))
10664 (if goto
10665 (progn
10666 (org-pop-to-buffer-same-window nbuf)
10667 (goto-char pos)
10668 (org-show-context 'org-goto))
10669 (if regionp
10670 (progn
10671 (org-kill-new (buffer-substring region-start region-end))
10672 (org-save-markers-in-region region-start region-end))
10673 (org-copy-subtree 1 nil t))
10674 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10675 (find-file-noselect file)))
10676 (setq reversed (org-notes-order-reversed-p))
10677 (save-excursion
10678 (save-restriction
10679 (widen)
10680 (if pos
10681 (progn
10682 (goto-char pos)
10683 (looking-at org-outline-regexp)
10684 (setq level (org-get-valid-level (funcall outline-level) 1))
10685 (goto-char
10686 (if reversed
10687 (or (outline-next-heading) (point-max))
10688 (or (save-excursion (org-get-next-sibling))
10689 (org-end-of-subtree t t)
10690 (point-max)))))
10691 (setq level 1)
10692 (if (not reversed)
10693 (goto-char (point-max))
10694 (goto-char (point-min))
10695 (or (outline-next-heading) (goto-char (point-max)))))
10696 (if (not (bolp)) (newline))
10697 (org-paste-subtree level)
10698 (when org-log-refile
10699 (org-add-log-setup 'refile nil nil 'findpos
10700 org-log-refile)
10701 (unless (eq org-log-refile 'note)
10702 (save-excursion (org-add-log-note))))
10703 (and org-auto-align-tags (org-set-tags nil t))
10704 (bookmark-set "org-refile-last-stored")
10705 ;; If we are refiling for capture, make sure that the
10706 ;; last-capture pointers point here
10707 (when (org-bound-and-true-p org-refile-for-capture)
10708 (bookmark-set "org-capture-last-stored-marker")
10709 (move-marker org-capture-last-stored-marker (point)))
10710 (if (fboundp 'deactivate-mark) (deactivate-mark))
10711 (run-hooks 'org-after-refile-insert-hook))))
10712 (if regionp
10713 (delete-region (point) (+ (point) region-length))
10714 (org-cut-subtree))
10715 (when (featurep 'org-inlinetask)
10716 (org-inlinetask-remove-END-maybe))
10717 (setq org-markers-to-move nil)
10720 (defun org-refile-goto-last-stored ()
10721 "Go to the location where the last refile was stored."
10722 (interactive)
10723 (bookmark-jump "org-refile-last-stored")
10724 (message "This is the location of the last refile"))
10726 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10727 no-exclude)
10728 "Prompt the user for a refile location, using PROMPT.
10729 PROMPT should not be suffixed with a colon and a space, because
10730 this function appends the default value from
10731 `org-refile-history' automatically, if that is not empty.
10732 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10733 this is used for the GOTO interface."
10734 (let ((org-refile-targets org-refile-targets)
10735 (org-refile-use-outline-path org-refile-use-outline-path)
10736 excluded-entries)
10737 (when (and (eq major-mode 'org-mode)
10738 (not org-refile-use-cache)
10739 (not no-exclude))
10740 (org-map-tree
10741 (lambda()
10742 (setq excluded-entries
10743 (append excluded-entries (list (org-get-heading t t)))))))
10744 (setq org-refile-target-table
10745 (org-refile-get-targets default-buffer excluded-entries)))
10746 (unless org-refile-target-table
10747 (error "No refile targets"))
10748 (let* ((prompt (concat prompt
10749 (and (car org-refile-history)
10750 (concat " (default " (car org-refile-history) ")"))
10751 ": "))
10752 (cbuf (current-buffer))
10753 (partial-completion-mode nil)
10754 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10755 (cfunc (if (and org-refile-use-outline-path
10756 org-outline-path-complete-in-steps)
10757 'org-olpath-completing-read
10758 'org-icompleting-read))
10759 (extra (if org-refile-use-outline-path "/" ""))
10760 (filename (and cfn (expand-file-name cfn)))
10761 (tbl (mapcar
10762 (lambda (x)
10763 (if (and (not (member org-refile-use-outline-path
10764 '(file full-file-path)))
10765 (not (equal filename (nth 1 x))))
10766 (cons (concat (car x) extra " ("
10767 (file-name-nondirectory (nth 1 x)) ")")
10768 (cdr x))
10769 (cons (concat (car x) extra) (cdr x))))
10770 org-refile-target-table))
10771 (completion-ignore-case t)
10772 pa answ parent-target child parent old-hist)
10773 (setq old-hist org-refile-history)
10774 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10775 nil 'org-refile-history (car org-refile-history)))
10776 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10777 (org-refile-check-position pa)
10778 (if pa
10779 (progn
10780 (when (or (not org-refile-history)
10781 (not (eq old-hist org-refile-history))
10782 (not (equal (car pa) (car org-refile-history))))
10783 (setq org-refile-history
10784 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10785 org-refile-history
10786 (cdr org-refile-history))))
10787 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10788 (pop org-refile-history)))
10789 pa)
10791 (progn
10792 (setq parent (match-string 1 answ)
10793 child (match-string 2 answ))
10794 (setq parent-target (or (assoc parent tbl)
10795 (assoc (concat parent "/") tbl)))
10796 (when (and parent-target
10797 (or (eq new-nodes t)
10798 (and (eq new-nodes 'confirm)
10800 child)))))
10801 (org-refile-new-child parent-target child)))
10802 (error "Invalid target location")))))
10804 (defun org-refile-check-position (refile-pointer)
10805 "Check if the refile pointer matches the readline to which it points."
10806 (let* ((file (nth 1 refile-pointer))
10807 (re (nth 2 refile-pointer))
10808 (pos (nth 3 refile-pointer))
10809 buffer)
10810 (when (org-string-nw-p re)
10811 (setq buffer (if (markerp pos)
10812 (marker-buffer pos)
10813 (or (find-buffer-visiting file)
10814 (find-file-noselect file))))
10815 (with-current-buffer buffer
10816 (save-excursion
10817 (save-restriction
10818 (widen)
10819 (goto-char pos)
10820 (beginning-of-line 1)
10821 (unless (org-looking-at-p re)
10822 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10824 (defun org-refile-new-child (parent-target child)
10825 "Use refile target PARENT-TARGET to add new CHILD below it."
10826 (unless parent-target
10827 (error "Cannot find parent for new node"))
10828 (let ((file (nth 1 parent-target))
10829 (pos (nth 3 parent-target))
10830 level)
10831 (with-current-buffer (or (find-buffer-visiting file)
10832 (find-file-noselect file))
10833 (save-excursion
10834 (save-restriction
10835 (widen)
10836 (if pos
10837 (goto-char pos)
10838 (goto-char (point-max))
10839 (if (not (bolp)) (newline)))
10840 (when (looking-at org-outline-regexp)
10841 (setq level (funcall outline-level))
10842 (org-end-of-subtree t t))
10843 (org-back-over-empty-lines)
10845 (if pos (org-get-valid-level level 1) 1) ?*)
10847 (beginning-of-line 0)
10848 (list (concat (car parent-target) "/" child) file "" (point)))))))
10850 (defun org-olpath-completing-read (prompt collection &rest args)
10851 "Read an outline path like a file name."
10852 (let ((thetable collection)
10853 (org-completion-use-ido nil) ; does not work with ido.
10854 (org-completion-use-iswitchb nil)) ; or iswitchb
10855 (apply
10856 'org-icompleting-read prompt
10857 (lambda (string predicate &optional flag)
10858 (let (rtn r f (l (length string)))
10859 (cond
10860 ((eq flag nil)
10861 ;; try completion
10862 (try-completion string thetable))
10863 ((eq flag t)
10864 ;; all-completions
10865 (setq rtn (all-completions string thetable predicate))
10866 (mapcar
10867 (lambda (x)
10868 (setq r (substring x l))
10869 (if (string-match " ([^)]*)$" x)
10870 (setq f (match-string 0 x))
10871 (setq f ""))
10872 (if (string-match "/" r)
10873 (concat string (substring r 0 (match-end 0)) f)
10874 x))
10875 rtn))
10876 ((eq flag 'lambda)
10877 ;; exact match?
10878 (assoc string thetable)))
10879 ))
10880 args)))
10882 ;;;; Dynamic blocks
10884 (defun org-find-dblock (name)
10885 "Find the first dynamic block with name NAME in the buffer.
10886 If not found, stay at current position and return nil."
10887 (let (pos)
10888 (save-excursion
10889 (goto-char (point-min))
10891 nil t)
10892 (match-beginning 0))))
10893 (if pos (goto-char pos))
10894 pos))
10896 (defconst org-dblock-start-re
10898 "Matches the start line of a dynamic block, with parameters.")
10901 "Matches the end of a dynamic block.")
10903 (defun org-create-dblock (plist)
10904 "Create a dynamic block section, with parameters taken from PLIST.
10905 PLIST must contain a :name entry which is used as name of the block."
10907 (end-of-line 1)
10908 (newline))
10909 (let ((col (current-column))
10910 (name (plist-get plist :name)))
10911 (insert "#+BEGIN: " name)
10912 (while plist
10913 (if (eq (car plist) :name)
10914 (setq plist (cddr plist))
10915 (insert " " (prin1-to-string (pop plist)))))
10917 (beginning-of-line -2)))
10919 (defun org-prepare-dblock ()
10920 "Prepare dynamic block for refresh.
10921 This empties the block, puts the cursor at the insert position and returns
10922 the property list including an extra property :name with the block name."
10923 (unless (looking-at org-dblock-start-re)
10924 (error "Not at a dynamic block"))
10925 (let* ((begdel (1+ (match-end 0)))
10926 (name (org-no-properties (match-string 1)))
10927 (params (append (list :name name)
10928 (read (concat "(" (match-string 3) ")")))))
10929 (save-excursion
10930 (beginning-of-line 1)
10932 (setq params (plist-put params :indentation-column (current-column))))
10933 (unless (re-search-forward org-dblock-end-re nil t)
10934 (error "Dynamic block not terminated"))
10935 (setq params
10936 (append params
10937 (list :content (buffer-substring
10938 begdel (match-beginning 0)))))
10939 (delete-region begdel (match-beginning 0))
10940 (goto-char begdel)
10941 (open-line 1)
10942 params))
10944 (defun org-map-dblocks (&optional command)
10945 "Apply COMMAND to all dynamic blocks in the current buffer.
10946 If COMMAND is not given, use `org-update-dblock'."
10947 (let ((cmd (or command 'org-update-dblock)))
10948 (save-excursion
10949 (goto-char (point-min))
10950 (while (re-search-forward org-dblock-start-re nil t)
10951 (goto-char (match-beginning 0))
10952 (save-excursion
10953 (condition-case nil
10954 (funcall cmd)
10955 (error (message "Error during update of dynamic block"))))
10956 (unless (re-search-forward org-dblock-end-re nil t)
10957 (error "Dynamic block not terminated"))))))
10959 (defun org-dblock-update (&optional arg)
10960 "User command for updating dynamic blocks.
10961 Update the dynamic block at point. With prefix ARG, update all dynamic
10962 blocks in the buffer."
10963 (interactive "P")
10964 (if arg
10965 (org-update-all-dblocks)
10966 (or (looking-at org-dblock-start-re)
10967 (org-beginning-of-dblock))
10968 (org-update-dblock)))
10970 (defun org-update-dblock ()
10971 "Update the dynamic block at point.
10972 This means to empty the block, parse for parameters and then call
10973 the correct writing function."
10974 (interactive)
10975 (save-window-excursion
10976 (let* ((pos (point))
10977 (line (org-current-line))
10978 (params (org-prepare-dblock))
10979 (name (plist-get params :name))
10980 (indent (plist-get params :indentation-column))
10981 (cmd (intern (concat "org-dblock-write:" name))))
10982 (message "Updating dynamic block `%s' at line %d..." name line)
10983 (funcall cmd params)
10984 (message "Updating dynamic block `%s' at line %d...done" name line)
10985 (goto-char pos)
10986 (when (and indent (> indent 0))
10987 (setq indent (make-string indent ?\ ))
10988 (save-excursion
10989 (org-beginning-of-dblock)
10990 (forward-line 1)
10991 (while (not (looking-at org-dblock-end-re))
10992 (insert indent)
10993 (beginning-of-line 2))
10994 (when (looking-at org-dblock-end-re)
10996 (replace-match ""))
10997 (insert indent)))))))
10999 (defun org-beginning-of-dblock ()
11000 "Find the beginning of the dynamic block at point.
11001 Error if there is no such block at point."
11002 (let ((pos (point))
11003 beg)
11004 (end-of-line 1)
11005 (if (and (re-search-backward org-dblock-start-re nil t)
11006 (setq beg (match-beginning 0))
11007 (re-search-forward org-dblock-end-re nil t)
11008 (> (match-end 0) pos))
11009 (goto-char beg)
11010 (goto-char pos)
11011 (error "Not in a dynamic block"))))
11013 (defun org-update-all-dblocks ()
11014 "Update all dynamic blocks in the buffer.
11015 This function can be used in a hook."
11016 (interactive)
11017 (when (eq major-mode 'org-mode)
11018 (org-map-dblocks 'org-update-dblock)))
11021 ;;;; Completion
11023 (defconst org-additional-option-like-keywords
11024 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11025 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11026 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11027 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11028 "BEGIN:" "END:"
11029 "ORGTBL" "TBLFM:" "TBLNAME:"
11030 "BEGIN_EXAMPLE" "END_EXAMPLE"
11031 "BEGIN_QUOTE" "END_QUOTE"
11032 "BEGIN_VERSE" "END_VERSE"
11033 "BEGIN_CENTER" "END_CENTER"
11034 "BEGIN_SRC" "END_SRC"
11035 "BEGIN_RESULT" "END_RESULT"
11036 "NAME:" "RESULTS:"
11037 "HEADER:" "HEADERS:"
11038 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11039 "CAPTION:" "LABEL:"
11040 "SETUPFILE:"
11041 "INCLUDE:"
11042 "BIND:"
11043 "MACRO:"))
11045 (defcustom org-structure-template-alist
11046 '(
11059 ("L" "#+latex: "
11063 ("H" "#+html: "
11066 ("A" "#+ascii: ")
11067 ("i" "#+index: ?"
11068 "#+index: ?")
11069 ("I" "#+include %file ?"
11071 )
11072 "Structure completion elements.
11073 This is a list of abbreviation keys and values. The value gets inserted
11074 if you type `<' followed by the key and then press the completion key,
11075 usually `M-TAB'. %file will be replaced by a file name after prompting
11076 for the file using completion. The cursor will be placed at the position
11077 of the `?` in the template.
11078 There are two templates for each key, the first uses the original Org syntax,
11079 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11080 the default when the /org-mtags.el/ module has been loaded. See also the
11081 variable `org-mtags-prefer-muse-templates'.
11082 This is an experimental feature, it is undecided if it is going to stay in."
11083 :group 'org-completion
11084 :type '(repeat
11085 (string :tag "Key")
11086 (string :tag "Template")
11087 (string :tag "Muse Template")))
11089 (defun org-try-structure-completion ()
11090 "Try to complete a structure template before point.
11092 expands them."
11093 (let ((l (buffer-substring (point-at-bol) (point)))
11094 a)
11097 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11098 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11099 (match-beginning 1)) a)
11100 t)))
11102 (defun org-complete-expand-structure-template (start cell)
11103 "Expand a structure template."
11104 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11105 (rpl (nth (if musep 2 1) cell))
11106 (ind ""))
11107 (delete-region start (point))
11109 (cond
11110 ((bolp))
11112 (setq ind (buffer-substring (point-at-bol) (point))))
11113 (t (newline))))
11114 (setq start (point))
11115 (if (string-match "%file" rpl)
11116 (setq rpl (replace-match
11117 (concat
11119 (save-match-data
11120 (abbreviate-file-name (read-file-name "Include file: ")))
11122 t t rpl)))
11125 (insert rpl)
11128 ;;;; TODO, DEADLINE, Comments
11130 (defun org-toggle-comment ()
11131 "Change the COMMENT state of an entry."
11132 (interactive)
11133 (save-excursion
11134 (org-back-to-heading)
11135 (let (case-fold-search)
11136 (cond
11137 ((looking-at (format org-heading-keyword-regexp-format
11138 org-comment-string))
11139 (goto-char (match-end 1))
11140 (looking-at (concat " +" org-comment-string))
11141 (replace-match "" t t)
11142 (when (eolp) (insert " ")))
11143 ((looking-at org-outline-regexp)
11144 (goto-char (match-end 0))
11145 (insert org-comment-string " "))))))
11147 (defvar org-last-todo-state-is-todo nil
11148 "This is non-nil when the last TODO state change led to a TODO state.
11149 If the last change removed the TODO tag or switched to DONE, then
11150 this is nil.")
11152 (defvar org-setting-tags nil) ; dynamically skipped
11154 (defvar org-todo-setup-filter-hook nil
11155 "Hook for functions that pre-filter todo specs.
11156 Each function takes a todo spec and returns either nil or the spec
11157 transformed into canonical form." )
11159 (defvar org-todo-get-default-hook nil
11160 "Hook for functions that get a default item for todo.
11161 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11162 nil or a string to be used for the todo mark." )
11164 (defvar org-agenda-headline-snapshot-before-repeat)
11166 (defun org-current-effective-time ()
11167 "Return current time adjusted for `org-extend-today-until' variable"
11168 (let* ((ct (org-current-time))
11169 (dct (decode-time ct))
11170 (ct1
11171 (if (and org-use-effective-time
11172 (< (nth 2 dct) org-extend-today-until))
11173 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11174 ct)))
11175 ct1))
11177 (defun org-todo-yesterday (&optional arg)
11178 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11179 (interactive "P")
11180 (if (eq major-mode 'org-agenda-mode)
11181 (apply 'org-agenda-todo-yesterday arg)
11182 (let* ((hour (third (decode-time
11183 (org-current-time))))
11184 (org-extend-today-until (1+ hour)))
11185 (org-todo arg))))
11187 (defun org-todo (&optional arg)
11188 "Change the TODO state of an item.
11189 The state of an item is given by a keyword at the start of the heading,
11190 like
11191 *** TODO Write paper
11192 *** DONE Call mom
11194 The different keywords are specified in the variable `org-todo-keywords'.
11196 So for this example: when the item starts with TODO, it is changed to DONE.
11197 When it starts with DONE, the DONE is removed. And when neither TODO nor
11198 DONE are present, add TODO at the beginning of the heading.
11201 state.
11202 With numeric prefix arg, switch to that state.
11204 keywords (nextset).
11206 With a numeric prefix arg of 0, inhibit note taking for the change.
11208 For calling through lisp, arg is also interpreted in the following way:
11209 'none -> empty state
11211 'done -> switch to DONE
11212 'nextset -> switch to the next set of keywords
11213 'previousset -> switch to the previous set of keywords
11215 really is a member of `org-todo-keywords'."
11216 (interactive "P")
11217 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11218 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11219 'region-start-level 'region))
11220 org-loop-over-headlines-in-active-region)
11221 (org-map-entries
11222 `(org-todo ,arg)
11223 org-loop-over-headlines-in-active-region
11224 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11225 (if (equal arg '(16)) (setq arg 'nextset))
11226 (let ((org-blocker-hook org-blocker-hook)
11227 (case-fold-search nil))
11228 (when (equal arg '(64))
11229 (setq arg nil org-blocker-hook nil))
11230 (when (and org-blocker-hook
11231 (or org-inhibit-blocking
11232 (org-entry-get nil "NOBLOCKING")))
11233 (setq org-blocker-hook nil))
11234 (save-excursion
11235 (catch 'exit
11236 (org-back-to-heading t)
11237 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11240 (let* ((match-data (match-data))
11241 (startpos (point-at-bol))
11242 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11243 (org-log-done org-log-done)
11244 (org-log-repeat org-log-repeat)
11245 (org-todo-log-states org-todo-log-states)
11246 (org-inhibit-logging
11247 (if (equal arg 0)
11248 (progn (setq arg nil) 'note) org-inhibit-logging))
11249 (this (match-string 1))
11250 (hl-pos (match-beginning 0))
11251 (head (org-get-todo-sequence-head this))
11252 (ass (assoc head org-todo-kwd-alist))
11253 (interpret (nth 1 ass))
11254 (done-word (nth 3 ass))
11255 (final-done-word (nth 4 ass))
11256 (last-state (or this ""))
11257 (completion-ignore-case t)
11258 (member (member this org-todo-keywords-1))
11259 (tail (cdr member))
11260 (state (cond
11261 ((and org-todo-key-trigger
11262 (or (and (equal arg '(4))
11263 (eq org-use-fast-todo-selection 'prefix))
11264 (and (not arg) org-use-fast-todo-selection
11265 (not (eq org-use-fast-todo-selection
11266 'prefix)))))
11267 ;; Use fast selection
11268 (org-fast-todo-selection))
11269 ((and (equal arg '(4))
11270 (or (not org-use-fast-todo-selection)
11271 (not org-todo-key-trigger)))
11272 ;; Read a state with completion
11273 (org-icompleting-read
11274 "State: " (mapcar (lambda(x) (list x))
11275 org-todo-keywords-1)
11276 nil t))
11277 ((eq arg 'right)
11278 (if this
11279 (if tail (car tail) nil)
11280 (car org-todo-keywords-1)))
11281 ((eq arg 'left)
11282 (if (equal member org-todo-keywords-1)
11283 nil
11284 (if this
11285 (nth (- (length org-todo-keywords-1)
11286 (length tail) 2)
11287 org-todo-keywords-1)
11288 (org-last org-todo-keywords-1))))
11289 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11290 (setq arg nil))) ; hack to fall back to cycling
11291 (arg
11292 ;; user or caller requests a specific state
11293 (cond
11294 ((equal arg "") nil)
11295 ((eq arg 'none) nil)
11296 ((eq arg 'done) (or done-word (car org-done-keywords)))
11297 ((eq arg 'nextset)
11298 (or (car (cdr (member head org-todo-heads)))
11299 (car org-todo-heads)))
11300 ((eq arg 'previousset)
11301 (let ((org-todo-heads (reverse org-todo-heads)))
11302 (or (car (cdr (member head org-todo-heads)))
11303 (car org-todo-heads))))
11304 ((car (member arg org-todo-keywords-1)))
11305 ((stringp arg)
11306 (error "State `%s' not valid in this file" arg))
11307 ((nth (1- (prefix-numeric-value arg))
11308 org-todo-keywords-1))))
11309 ((null member) (or head (car org-todo-keywords-1)))
11310 ((equal this final-done-word) nil) ;; -> make empty
11311 ((null tail) nil) ;; -> first entry
11312 ((memq interpret '(type priority))
11313 (if (eq this-command last-command)
11314 (car tail)
11315 (if (> (length tail) 0)
11316 (or done-word (car org-done-keywords))
11317 nil)))
11318 (t
11319 (car tail))))
11320 (state (or
11321 (run-hook-with-args-until-success
11322 'org-todo-get-default-hook state last-state)
11323 state))
11324 (next (if state (concat " " state " ") " "))
11325 (change-plist (list :type 'todo-state-change :from this :to state
11326 :position startpos))
11327 dolog now-done-p)
11328 (when org-blocker-hook
11329 (setq org-last-todo-state-is-todo
11330 (not (member this org-done-keywords)))
11331 (unless (save-excursion
11332 (save-match-data
11333 (org-with-wide-buffer
11334 (run-hook-with-args-until-failure
11335 'org-blocker-hook change-plist))))
11336 (if (org-called-interactively-p 'interactive)
11337 (error "TODO state change from %s to %s blocked" this state)
11338 ;; fail silently
11339 (message "TODO state change from %s to %s blocked" this state)
11340 (throw 'exit nil))))
11341 (store-match-data match-data)
11342 (replace-match next t t)
11343 (unless (pos-visible-in-window-p hl-pos)
11344 (message "TODO state changed to %s" (org-trim next)))
11345 (unless head
11346 (setq head (org-get-todo-sequence-head state)
11347 ass (assoc head org-todo-kwd-alist)
11348 interpret (nth 1 ass)
11349 done-word (nth 3 ass)
11350 final-done-word (nth 4 ass)))
11351 (when (memq arg '(nextset previousset))
11352 (message "Keyword-Set %d/%d: %s"
11353 (- (length org-todo-sets) -1
11354 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11355 (length org-todo-sets)
11356 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11357 (setq org-last-todo-state-is-todo
11358 (not (member state org-done-keywords)))
11359 (setq now-done-p (and (member state org-done-keywords)
11360 (not (member this org-done-keywords))))
11361 (and logging (org-local-logging logging))
11362 (when (and (or org-todo-log-states org-log-done)
11363 (not (eq org-inhibit-logging t))
11364 (not (memq arg '(nextset previousset))))
11365 ;; we need to look at recording a time and note
11366 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11367 (nth 2 (assoc this org-todo-log-states))))
11368 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11369 (setq dolog 'time))
11370 (when (and state
11371 (member state org-not-done-keywords)
11372 (not (member this org-not-done-keywords)))
11373 ;; This is now a todo state and was not one before
11374 ;; If there was a CLOSED time stamp, get rid of it.
11375 (org-add-planning-info nil nil 'closed))
11376 (when (and now-done-p org-log-done)
11377 ;; It is now done, and it was not done before
11378 (org-add-planning-info 'closed (org-current-effective-time))
11379 (if (and (not dolog) (eq 'note org-log-done))
11380 (org-add-log-setup 'done state this 'findpos 'note)))
11381 (when (and state dolog)
11382 ;; This is a non-nil state, and we need to log it
11383 (org-add-log-setup 'state state this 'findpos dolog)))
11384 ;; Fixup tag positioning
11385 (org-todo-trigger-tag-changes state)
11386 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11387 (when org-provide-todo-statistics
11388 (org-update-parent-todo-statistics))
11389 (run-hooks 'org-after-todo-state-change-hook)
11390 (if (and arg (not (member state org-done-keywords)))
11391 (setq head (org-get-todo-sequence-head state)))
11392 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11393 ;; Do we need to trigger a repeat?
11394 (when now-done-p
11395 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11396 ;; This is for the agenda, take a snapshot of the headline.
11397 (save-match-data
11398 (setq org-agenda-headline-snapshot-before-repeat
11399 (org-get-heading))))
11400 (org-auto-repeat-maybe state))
11401 ;; Fixup cursor location if close to the keyword
11402 (if (and (outline-on-heading-p)
11403 (not (bolp))
11404 (save-excursion (beginning-of-line 1)
11405 (looking-at org-todo-line-regexp))
11406 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11407 (progn
11408 (goto-char (or (match-end 2) (match-end 1)))
11409 (and (looking-at " ") (just-one-space))))
11410 (when org-trigger-hook
11411 (save-excursion
11412 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11414 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11415 "Block turning an entry into a TODO, using the hierarchy.
11416 This checks whether the current task should be blocked from state
11417 changes. Such blocking occurs when:
11419 1. The task has children which are not all in a completed state.
11421 2. A task has a parent with the property :ORDERED:, and there
11422 are siblings prior to the current task with incomplete
11423 status.
11425 3. The parent of the task is blocked because it has siblings that should
11426 be done first, or is child of a block grandparent TODO entry."
11428 (if (not org-enforce-todo-dependencies)
11429 t ; if locally turned off don't block
11430 (catch 'dont-block
11431 ;; If this is not a todo state change, or if this entry is already DONE,
11432 ;; do not block
11433 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11434 (member (plist-get change-plist :from)
11435 (cons 'done org-done-keywords))
11436 (member (plist-get change-plist :to)
11437 (cons 'todo org-not-done-keywords))
11438 (not (plist-get change-plist :to)))
11439 (throw 'dont-block t))
11440 ;; If this task has children, and any are undone, it's blocked
11441 (save-excursion
11442 (org-back-to-heading t)
11443 (let ((this-level (funcall outline-level)))
11444 (outline-next-heading)
11445 (let ((child-level (funcall outline-level)))
11446 (while (and (not (eobp))
11447 (> child-level this-level))
11448 ;; this todo has children, check whether they are all
11449 ;; completed
11450 (if (and (not (org-entry-is-done-p))
11451 (org-entry-is-todo-p))
11452 (throw 'dont-block nil))
11453 (outline-next-heading)
11454 (setq child-level (funcall outline-level))))))
11455 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11456 ;; any previous siblings are undone, it's blocked
11457 (save-excursion
11458 (org-back-to-heading t)
11459 (let* ((pos (point))
11460 (parent-pos (and (org-up-heading-safe) (point))))
11461 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11462 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11463 (forward-line 1)
11464 (re-search-forward org-not-done-heading-regexp pos t))
11465 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11466 ;; Search further up the hierarchy, to see if an ancestor is blocked
11467 (while t
11468 (goto-char parent-pos)
11469 (if (not (looking-at org-not-done-heading-regexp))
11470 (throw 'dont-block t)) ; do not block, parent is not a TODO
11471 (setq pos (point))
11472 (setq parent-pos (and (org-up-heading-safe) (point)))
11473 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11474 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11475 (forward-line 1)
11476 (re-search-forward org-not-done-heading-regexp pos t))
11477 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11479 (defcustom org-track-ordered-property-with-tag nil
11480 "Should the ORDERED property also be shown as a tag?
11481 The ORDERED property decides if an entry should require subtasks to be
11482 completed in sequence. Since a property is not very visible, setting
11483 this option means that toggling the ORDERED property with the command
11484 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11485 not relevant for the behavior, but it makes things more visible.
11487 Note that toggling the tag with tags commands will not change the property
11488 and therefore not influence behavior!
11490 This can be t, meaning the tag ORDERED should be used, It can also be a
11491 string to select a different tag for this task."
11492 :group 'org-todo
11493 :type '(choice
11494 (const :tag "No tracking" nil)
11495 (const :tag "Track with ORDERED tag" t)
11496 (string :tag "Use other tag")))
11498 (defun org-toggle-ordered-property ()
11499 "Toggle the ORDERED property of the current entry.
11500 For better visibility, you can track the value of this property with a tag.
11501 See variable `org-track-ordered-property-with-tag'."
11502 (interactive)
11503 (let* ((t1 org-track-ordered-property-with-tag)
11504 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11505 (save-excursion
11506 (org-back-to-heading)
11507 (if (org-entry-get nil "ORDERED")
11508 (progn
11509 (org-delete-property "ORDERED")
11510 (and tag (org-toggle-tag tag 'off))
11511 (message "Subtasks can be completed in arbitrary order"))
11512 (org-entry-put nil "ORDERED" "t")
11513 (and tag (org-toggle-tag tag 'on))
11514 (message "Subtasks must be completed in sequence")))))
11516 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11517 (defun org-block-todo-from-checkboxes (change-plist)
11518 "Block turning an entry into a TODO, using checkboxes.
11519 This checks whether the current task should be blocked from state
11520 changes because there are unchecked boxes in this entry."
11521 (if (not org-enforce-todo-checkbox-dependencies)
11522 t ; if locally turned off don't block
11523 (catch 'dont-block
11524 ;; If this is not a todo state change, or if this entry is already DONE,
11525 ;; do not block
11526 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11527 (member (plist-get change-plist :from)
11528 (cons 'done org-done-keywords))
11529 (member (plist-get change-plist :to)
11530 (cons 'todo org-not-done-keywords))
11531 (not (plist-get change-plist :to)))
11532 (throw 'dont-block t))
11533 ;; If this task has checkboxes that are not checked, it's blocked
11534 (save-excursion
11535 (org-back-to-heading t)
11536 (let ((beg (point)) end)
11537 (outline-next-heading)
11538 (setq end (point))
11539 (goto-char beg)
11540 (if (org-list-search-forward
11541 (concat (org-item-beginning-re)
11544 end t)
11545 (progn
11546 (if (boundp 'org-blocked-by-checkboxes)
11547 (setq org-blocked-by-checkboxes t))
11548 (throw 'dont-block nil)))))
11549 t))) ; do not block
11551 (defun org-entry-blocked-p ()
11552 "Is the current entry blocked?"
11553 (if (org-entry-get nil "NOBLOCKING")
11554 nil ;; Never block this entry
11555 (not
11556 (run-hook-with-args-until-failure
11557 'org-blocker-hook
11558 (list :type 'todo-state-change
11559 :position (point)
11560 :from 'todo
11561 :to 'done)))))
11563 (defun org-update-statistics-cookies (all)
11564 "Update the statistics cookie, either from TODO or from checkboxes.
11565 This should be called with the cursor in a line with a statistics cookie."
11566 (interactive "P")
11567 (if all
11568 (progn
11569 (org-update-checkbox-count 'all)
11570 (org-map-entries 'org-update-parent-todo-statistics))
11571 (if (not (org-at-heading-p))
11572 (org-update-checkbox-count)
11573 (let ((pos (move-marker (make-marker) (point)))
11574 end l1 l2)
11575 (ignore-errors (org-back-to-heading t))
11576 (if (not (org-at-heading-p))
11577 (org-update-checkbox-count)
11578 (setq l1 (org-outline-level))
11579 (setq end (save-excursion
11580 (outline-next-heading)
11581 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11582 (point)))
11583 (if (and (save-excursion
11584 (re-search-forward
11586 (not (save-excursion (re-search-forward
11588 (org-update-checkbox-count)
11589 (if (and l2 (> l2 l1))
11590 (progn
11591 (goto-char end)
11592 (org-update-parent-todo-statistics))
11593 (goto-char pos)
11594 (beginning-of-line 1)
11595 (while (re-search-forward
11597 (point-at-eol) t)
11598 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11599 (goto-char pos)
11600 (move-marker pos nil)))))
11602 (defvar org-entry-property-inherited-from) ;; defined below
11603 (defun org-update-parent-todo-statistics ()
11604 "Update any statistics cookie in the parent of the current headline.
11605 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11606 the entire subtree and this will travel up the hierarchy and update
11607 statistics everywhere."
11608 (let* ((prop (save-excursion (org-up-heading-safe)
11609 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11610 (recursive (or (not org-hierarchical-todo-statistics)
11612 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11613 0))
11614 (first t)
11616 level ltoggle l1 new ndel
11617 (cnt-all 0) (cnt-done 0) is-percent kwd
11618 checkbox-beg ov ovs ove cookie-present)
11619 (catch 'exit
11620 (save-excursion
11621 (beginning-of-line 1)
11622 (setq ltoggle (funcall outline-level))
11623 ;; Three situations are to consider:
11625 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11626 ;; to the top-level ancestor on the headline;
11628 ;; 2. If parent has "recursive" property, repeat up to the
11629 ;; headline setting that property, taking inheritance into
11630 ;; account;
11632 ;; 3. Else, move up to direct parent and proceed only once.
11633 (while (and (setq level (org-up-heading-safe))
11634 (or recursive first)
11635 (>= (point) lim))
11636 (setq first nil cookie-present nil)
11637 (unless (and level
11638 (not (string-match
11640 (downcase (or (org-entry-get nil "COOKIE_DATA")
11641 "")))))
11642 (throw 'exit nil))
11643 (while (re-search-forward box-re (point-at-eol) t)
11644 (setq cnt-all 0 cnt-done 0 cookie-present t)
11645 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11646 (save-match-data
11647 (unless (outline-next-heading) (throw 'exit nil))
11648 (while (and (looking-at org-complex-heading-regexp)
11649 (> (setq l1 (length (match-string 1))) level))
11650 (setq kwd (and (or recursive (= l1 ltoggle))
11651 (match-string 2)))
11652 (if (or (eq org-provide-todo-statistics 'all-headlines)
11653 (and (listp org-provide-todo-statistics)
11654 (or (member kwd org-provide-todo-statistics)
11655 (member kwd org-done-keywords))))
11656 (setq cnt-all (1+ cnt-all))
11657 (if (eq org-provide-todo-statistics t)
11658 (and kwd (setq cnt-all (1+ cnt-all)))))
11659 (and (member kwd org-done-keywords)
11660 (setq cnt-done (1+ cnt-done)))
11661 (outline-next-heading)))
11662 (setq new
11663 (if is-percent
11664 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11665 (format "[%d/%d]" cnt-done cnt-all))
11666 ndel (- (match-end 0) checkbox-beg))
11667 ;; handle overlays when updating cookie from column view
11668 (when (setq ov (car (overlays-at checkbox-beg)))
11669 (setq ovs (overlay-start ov) ove (overlay-end ov))
11670 (delete-overlay ov))
11671 (goto-char checkbox-beg)
11672 (insert new)
11673 (delete-region (point) (+ (point) ndel))
11674 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11675 (when ov (move-overlay ov ovs ove)))
11676 (when cookie-present
11677 (run-hook-with-args 'org-after-todo-statistics-hook
11678 cnt-done (- cnt-all cnt-done))))))
11679 (run-hooks 'org-todo-statistics-hook)))
11681 (defvar org-after-todo-statistics-hook nil
11682 "Hook that is called after a TODO statistics cookie has been updated.
11683 Each function is called with two arguments: the number of not-done entries
11684 and the number of done entries.
11686 For example, the following function, when added to this hook, will switch
11687 an entry to DONE when all children are done, and back to TODO when new
11688 entries are set to a TODO status. Note that this hook is only called
11689 when there is a statistics cookie in the headline!
11691 (defun org-summary-todo (n-done n-not-done)
11693 (let (org-log-done org-log-states) ; turn off logging
11695 ")
11697 (defvar org-todo-statistics-hook nil
11698 "Hook that is run whenever Org thinks TODO statistics should be updated.
11699 This hook runs even if there is no statistics cookie present, in which case
11700 `org-after-todo-statistics-hook' would not run.")
11702 (defun org-todo-trigger-tag-changes (state)
11703 "Apply the changes defined in `org-todo-state-tags-triggers'."
11704 (let ((l org-todo-state-tags-triggers)
11705 changes)
11706 (when (or (not state) (equal state ""))
11707 (setq changes (append changes (cdr (assoc "" l)))))
11708 (when (and (stringp state) (> (length state) 0))
11709 (setq changes (append changes (cdr (assoc state l)))))
11710 (when (member state org-not-done-keywords)
11711 (setq changes (append changes (cdr (assoc 'todo l)))))
11712 (when (member state org-done-keywords)
11713 (setq changes (append changes (cdr (assoc 'done l)))))
11714 (dolist (c changes)
11715 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11717 (defun org-local-logging (value)
11718 "Get logging settings from a property VALUE."
11719 (let* (words w a)
11720 ;; directly set the variables, they are already local.
11721 (setq org-log-done nil
11722 org-log-repeat nil
11723 org-todo-log-states nil)
11724 (setq words (org-split-string value))
11725 (while (setq w (pop words))
11726 (cond
11727 ((setq a (assoc w org-startup-options))
11728 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11729 (set (nth 1 a) (nth 2 a))))
11730 ((setq a (org-extract-log-state-settings w))
11731 (and (member (car a) org-todo-keywords-1)
11732 (push a org-todo-log-states)))))))
11734 (defun org-get-todo-sequence-head (kwd)
11735 "Return the head of the TODO sequence to which KWD belongs.
11736 If KWD is not set, check if there is a text property remembering the
11737 right sequence."
11738 (let (p)
11739 (cond
11740 ((not kwd)
11741 (or (get-text-property (point-at-bol) 'org-todo-head)
11742 (progn
11743 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11744 nil (point-at-eol)))
11745 (get-text-property p 'org-todo-head))))
11746 ((not (member kwd org-todo-keywords-1))
11747 (car org-todo-keywords-1))
11748 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11750 (defun org-fast-todo-selection ()
11751 "Fast TODO keyword selection with single keys.
11752 Returns the new TODO keyword, or nil if no state change should occur."
11753 (let* ((fulltable org-todo-key-alist)
11754 (done-keywords org-done-keywords) ;; needed for the faces.
11755 (maxlen (apply 'max (mapcar
11756 (lambda (x)
11757 (if (stringp (car x)) (string-width (car x)) 0))
11758 fulltable)))
11759 (expert nil)
11760 (fwidth (+ maxlen 3 1 3))
11761 (ncol (/ (- (window-width) 4) fwidth))
11762 tg cnt e c tbl
11763 groups ingroup)
11764 (save-excursion
11765 (save-window-excursion
11766 (if expert
11767 (set-buffer (get-buffer-create " *Org todo*"))
11768 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11769 (erase-buffer)
11770 (org-set-local 'org-done-keywords done-keywords)
11771 (setq tbl fulltable cnt 0)
11772 (while (setq e (pop tbl))
11773 (cond
11774 ((equal e '(:startgroup))
11775 (push '() groups) (setq ingroup t)
11776 (when (not (= cnt 0))
11777 (setq cnt 0)
11779 (insert "{ "))
11780 ((equal e '(:endgroup))
11781 (setq ingroup nil cnt 0)
11783 ((equal e '(:newline))
11784 (when (not (= cnt 0))
11785 (setq cnt 0)
11787 (setq e (car tbl))
11788 (while (equal (car tbl) '(:newline))
11790 (setq tbl (cdr tbl)))))
11791 (t
11792 (setq tg (car e) c (cdr e))
11793 (if ingroup (push tg (car groups)))
11794 (setq tg (org-add-props tg nil 'face
11795 (org-get-todo-face tg)))
11796 (if (and (= cnt 0) (not ingroup)) (insert " "))
11797 (insert "[" c "] " tg (make-string
11798 (- fwidth 4 (length tg)) ?\ ))
11799 (when (= (setq cnt (1+ cnt)) ncol)
11801 (if ingroup (insert " "))
11802 (setq cnt 0)))))
11804 (goto-char (point-min))
11805 (if (not expert) (org-fit-window-to-buffer))
11806 (message "[a-z..]:Set [SPC]:clear")
11807 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11808 (cond
11809 ((or (= c ?\C-g)
11810 (and (= c ?q) (not (rassoc c fulltable))))
11811 (setq quit-flag t))
11812 ((= c ?\ ) nil)
11813 ((setq e (rassoc c fulltable) tg (car e))
11814 tg)
11815 (t (setq quit-flag t)))))))
11817 (defun org-entry-is-todo-p ()
11818 (member (org-get-todo-state) org-not-done-keywords))
11820 (defun org-entry-is-done-p ()
11821 (member (org-get-todo-state) org-done-keywords))
11823 (defun org-get-todo-state ()
11824 (save-excursion
11825 (org-back-to-heading t)
11826 (and (looking-at org-todo-line-regexp)
11827 (match-end 2)
11828 (match-string 2))))
11830 (defun org-at-date-range-p (&optional inactive-ok)
11831 "Is the cursor inside a date range?"
11832 (interactive)
11833 (save-excursion
11834 (catch 'exit
11835 (let ((pos (point)))
11837 (skip-chars-backward "<[")
11838 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11839 (>= (match-end 0) pos)
11840 (throw 'exit t))
11842 (skip-chars-backward "<[")
11843 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11844 (>= (match-end 0) pos)
11845 (throw 'exit t)))
11846 nil)))
11848 (defun org-get-repeat (&optional tagline)
11849 "Check if there is a deadline/schedule with repeater in this entry."
11850 (save-match-data
11851 (save-excursion
11852 (org-back-to-heading t)
11853 (and (re-search-forward (if tagline
11855 org-repeat-re)
11856 (org-entry-end-position) t)
11857 (match-string-no-properties 1)))))
11859 (defvar org-last-changed-timestamp)
11860 (defvar org-last-inserted-timestamp)
11861 (defvar org-log-post-message)
11862 (defvar org-log-note-purpose)
11863 (defvar org-log-note-how)
11864 (defvar org-log-note-extra)
11865 (defun org-auto-repeat-maybe (done-word)
11866 "Check if the current headline contains a repeated deadline/schedule.
11867 If yes, set TODO state back to what it was and change the base date
11868 of repeating deadline/scheduled time stamps to new date.
11869 This function is run automatically after each state change to a DONE state."
11870 ;; last-state is dynamically scoped into this function
11871 (let* ((repeat (org-get-repeat))
11872 (aa (assoc last-state org-todo-kwd-alist))
11873 (interpret (nth 1 aa))
11874 (head (nth 2 aa))
11875 (whata '(("d" . day) ("m" . month) ("y" . year)))
11876 (msg "Entry repeats: ")
11877 (org-log-done nil)
11878 (org-todo-log-states nil)
11879 re type n what ts time to-state)
11880 (when repeat
11881 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11882 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11883 org-todo-repeat-to-state))
11884 (unless (and to-state (member to-state org-todo-keywords-1))
11885 (setq to-state (if (eq interpret 'type) last-state head)))
11886 (org-todo to-state)
11887 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11888 (org-entry-put nil "LAST_REPEAT" (format-time-string
11889 (org-time-stamp-format t t))))
11890 (when org-log-repeat
11891 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11892 (memq 'org-add-log-note post-command-hook))
11893 ;; OK, we are already setup for some record
11894 (if (eq org-log-repeat 'note)
11895 ;; make sure we take a note, not only a time stamp
11896 (setq org-log-note-how 'note))
11897 ;; Set up for taking a record
11898 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11899 last-state
11900 'findpos org-log-repeat)))
11901 (org-back-to-heading t)
11902 (org-add-planning-info nil nil 'closed)
11906 (while (re-search-forward
11907 re (save-excursion (outline-next-heading) (point)) t)
11908 (setq type (if (match-end 1) org-scheduled-string
11909 (if (match-end 3) org-deadline-string "Plain:"))
11910 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11912 (setq n (string-to-number (match-string 2 ts))
11913 what (match-string 3 ts))
11914 (if (equal what "w") (setq n (* n 7) what "d"))
11915 ;; Preparation, see if we need to modify the start date for the change
11916 (when (match-end 1)
11917 (setq time (save-match-data (org-time-string-to-time ts)))
11918 (cond
11919 ((equal (match-string 1 ts) ".")
11920 ;; Shift starting date to today
11921 (org-timestamp-change
11922 (- (org-today) (time-to-days time))
11923 'day))
11924 ((equal (match-string 1 ts) "+")
11925 (let ((nshiftmax 10) (nshift 0))
11926 (while (or (= nshift 0)
11927 (<= (time-to-days time)
11928 (time-to-days (current-time))))
11929 (when (= (incf nshift) nshiftmax)
11930 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11931 (error "Abort")))
11932 (org-timestamp-change n (cdr (assoc what whata)))
11933 (org-at-timestamp-p t)
11934 (setq ts (match-string 1))
11935 (setq time (save-match-data (org-time-string-to-time ts)))))
11936 (org-timestamp-change (- n) (cdr (assoc what whata)))
11937 ;; rematch, so that we have everything in place for the real shift
11938 (org-at-timestamp-p t)
11939 (setq ts (match-string 1))
11941 (org-timestamp-change n (cdr (assoc what whata)))
11942 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11943 (setq org-log-post-message msg)
11944 (message "%s" msg))))
11946 (defun org-show-todo-tree (arg)
11947 "Make a compact tree which shows all headlines marked with TODO.
11948 The tree will show the lines where the regexp matches, and all higher
11949 headlines above the match.
11951 With a numeric prefix N, construct a sparse tree for the Nth element
11952 of `org-todo-keywords-1'."
11953 (interactive "P")
11954 (let ((case-fold-search nil)
11955 (kwd-re
11956 (cond ((null arg) org-not-done-regexp)
11957 ((equal arg '(4))
11958 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11959 (mapcar 'list org-todo-keywords-1))))
11963 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11964 (regexp-quote (nth (1- (prefix-numeric-value arg))
11965 org-todo-keywords-1)))
11966 (t (error "Invalid prefix argument: %s" arg)))))
11967 (message "%d TODO entries found"
11968 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11970 (defun org-deadline (&optional remove time)
11972 With argument REMOVE, remove any deadline from the item.
11973 With argument TIME, set the deadline at the corresponding date. TIME
11975 (interactive "P")
11976 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11977 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11978 'region-start-level 'region))
11979 org-loop-over-headlines-in-active-region)
11980 (org-map-entries
11981 `(org-deadline ',remove ,time)
11982 org-loop-over-headlines-in-active-region
11983 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11984 (let* ((old-date (org-entry-get nil "DEADLINE"))
11985 (repeater (and old-date
11986 (string-match
11988 old-date)
11989 (match-string 1 old-date))))
11990 (if remove
11991 (progn
11992 (when (and old-date org-log-redeadline)
11993 (org-add-log-setup 'deldeadline nil old-date 'findpos
11994 org-log-redeadline))
11995 (org-remove-timestamp-with-keyword org-deadline-string)
11996 (message "Item no longer has a deadline."))
11997 (org-add-planning-info 'deadline time 'closed)
11998 (when (and old-date org-log-redeadline
11999 (not (equal old-date
12000 (substring org-last-inserted-timestamp 1 -1))))
12001 (org-add-log-setup 'redeadline nil old-date 'findpos
12002 org-log-redeadline))
12003 (when repeater
12004 (save-excursion
12005 (org-back-to-heading t)
12006 (when (re-search-forward (concat org-deadline-string " "
12007 org-last-inserted-timestamp)
12008 (save-excursion
12009 (outline-next-heading) (point)) t)
12010 (goto-char (1- (match-end 0)))
12011 (insert " " repeater)
12012 (setq org-last-inserted-timestamp
12013 (concat (substring org-last-inserted-timestamp 0 -1)
12014 " " repeater
12015 (substring org-last-inserted-timestamp -1))))))
12016 (message "Deadline on %s" org-last-inserted-timestamp)))))
12018 (defun org-schedule (&optional remove time)
12019 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12020 With argument REMOVE, remove any scheduling date from the item.
12021 With argument TIME, scheduled at the corresponding date. TIME can
12023 (interactive "P")
12024 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12025 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12026 'region-start-level 'region))
12027 org-loop-over-headlines-in-active-region)
12028 (org-map-entries
12029 `(org-schedule ',remove ,time)
12030 org-loop-over-headlines-in-active-region
12031 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12032 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12033 (repeater (and old-date
12034 (string-match
12036 old-date)
12037 (match-string 1 old-date))))
12038 (if remove
12039 (progn
12040 (when (and old-date org-log-reschedule)
12041 (org-add-log-setup 'delschedule nil old-date 'findpos
12042 org-log-reschedule))
12043 (org-remove-timestamp-with-keyword org-scheduled-string)
12044 (message "Item is no longer scheduled."))
12045 (org-add-planning-info 'scheduled time 'closed)
12046 (when (and old-date org-log-reschedule
12047 (not (equal old-date
12048 (substring org-last-inserted-timestamp 1 -1))))
12049 (org-add-log-setup 'reschedule nil old-date 'findpos
12050 org-log-reschedule))
12051 (when repeater
12052 (save-excursion
12053 (org-back-to-heading t)
12054 (when (re-search-forward (concat org-scheduled-string " "
12055 org-last-inserted-timestamp)
12056 (save-excursion
12057 (outline-next-heading) (point)) t)
12058 (goto-char (1- (match-end 0)))
12059 (insert " " repeater)
12060 (setq org-last-inserted-timestamp
12061 (concat (substring org-last-inserted-timestamp 0 -1)
12062 " " repeater
12063 (substring org-last-inserted-timestamp -1))))))
12064 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12066 (defun org-get-scheduled-time (pom &optional inherit)
12067 "Get the scheduled time as a time tuple, of a format suitable
12068 for calling org-schedule with, or if there is no scheduling,
12069 returns nil."
12070 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12071 (when time
12072 (apply 'encode-time (org-parse-time-string time)))))
12074 (defun org-get-deadline-time (pom &optional inherit)
12075 "Get the deadline as a time tuple, of a format suitable for
12076 calling org-deadline with, or if there is no scheduling, returns
12077 nil."
12078 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12079 (when time
12080 (apply 'encode-time (org-parse-time-string time)))))
12082 (defun org-remove-timestamp-with-keyword (keyword)
12083 "Remove all time stamps with KEYWORD in the current entry."
12085 beg)
12086 (save-excursion
12087 (org-back-to-heading t)
12088 (setq beg (point))
12089 (outline-next-heading)
12090 (while (re-search-backward re beg t)
12091 (replace-match "")
12093 (equal (char-before) ?\ ))
12094 (backward-delete-char 1)
12096 (point-at-bol) (point-at-eol)))
12097 (delete-region (point-at-bol)
12098 (min (point-max) (1+ (point-at-eol))))))))))
12100 (defun org-add-planning-info (what &optional time &rest remove)
12101 "Insert new timestamp with keyword in the line directly after the headline.
12102 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12103 If non is given, the user is prompted for a date.
12104 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12105 be removed."
12106 (interactive)
12107 (let (org-time-was-given org-end-time-was-given ts
12108 end default-time default-input)
12110 (catch 'exit
12111 (when (and (memq what '(scheduled deadline))
12112 (or (not time)
12113 (and (stringp time)
12114 (string-match "^[-+]+[0-9]" time))))
12115 ;; Try to get a default date/time from existing timestamp
12116 (save-excursion
12117 (org-back-to-heading t)
12118 (setq end (save-excursion (outline-next-heading) (point)))
12119 (when (re-search-forward (if (eq what 'scheduled)
12120 org-scheduled-time-regexp
12121 org-deadline-time-regexp)
12122 end t)
12123 (setq ts (match-string 1)
12124 default-time
12125 (apply 'encode-time (org-parse-time-string ts))
12126 default-input (and ts (org-get-compact-tod ts))))))
12127 (when what
12128 (setq time
12129 (if (stringp time)
12130 ;; This is a string (relative or absolute), set proper date
12131 (apply 'encode-time
12132 (org-read-date-analyze
12133 time default-time (decode-time default-time)))
12134 ;; If necessary, get the time from the user
12135 (or time (org-read-date nil 'to-time nil nil
12136 default-time default-input)))))
12138 (when (and org-insert-labeled-timestamps-at-point
12139 (member what '(scheduled deadline)))
12140 (insert
12141 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12142 (org-insert-time-stamp time org-time-was-given
12143 nil nil nil (list org-end-time-was-given))
12144 (setq what nil))
12145 (save-excursion
12146 (save-restriction
12147 (let (col list elt ts buffer-invisibility-spec)
12148 (org-back-to-heading t)
12150 (goto-char (match-end 1))
12151 (setq col (current-column))
12152 (goto-char (match-end 0))
12154 (when (and (not what)
12155 (not (looking-at
12157 org-keyword-time-not-clock-regexp))))
12158 ;; Nothing to add, nothing to remove...... :-)
12159 (throw 'exit nil))
12160 (if (and (not (looking-at org-outline-regexp))
12163 (not (equal (match-string 1) org-clock-string)))
12164 (narrow-to-region (match-beginning 0) (match-end 0))
12166 (backward-char 1)
12167 (narrow-to-region (point) (point))
12168 (and org-adapt-indentation (org-indent-to-column col)))
12169 ;; Check if we have to remove something.
12170 (setq list (cons what remove))
12171 (while list
12172 (setq elt (pop list))
12173 (when (or (and (eq elt 'scheduled)
12174 (re-search-forward org-scheduled-time-regexp nil t))
12175 (and (eq elt 'deadline)
12176 (re-search-forward org-deadline-time-regexp nil t))
12177 (and (eq elt 'closed)
12178 (re-search-forward org-closed-time-regexp nil t)))
12179 (replace-match "")
12180 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12182 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12183 (when what
12184 (insert
12185 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12186 (cond ((eq what 'scheduled) org-scheduled-string)
12187 ((eq what 'deadline) org-deadline-string)
12188 ((eq what 'closed) org-closed-string))
12189 " ")
12190 (setq ts (org-insert-time-stamp
12191 time
12192 (or org-time-was-given
12193 (and (eq what 'closed) org-log-done-with-time))
12194 (eq what 'closed)
12195 nil nil (list org-end-time-was-given)))
12196 (insert
12197 (if (not (or (bolp) (eq (char-before) ?\ )
12198 (memq (char-after) '(32 10))
12199 (eobp))) " " ""))
12200 (end-of-line 1))
12201 (goto-char (point-min))
12202 (widen)
12205 (delete-region (1- (point)) (point-at-eol)))
12206 ts))))))
12208 (defvar org-log-note-marker (make-marker))
12209 (defvar org-log-note-purpose nil)
12210 (defvar org-log-note-state nil)
12211 (defvar org-log-note-previous-state nil)
12212 (defvar org-log-note-how nil)
12213 (defvar org-log-note-extra nil)
12214 (defvar org-log-note-window-configuration nil)
12215 (defvar org-log-note-return-to (make-marker))
12216 (defvar org-log-note-effective-time nil
12217 "Remembered current time so that dynamically scoped
12218 `org-extend-today-until' affects tha timestamps in state change
12219 log")
12221 (defvar org-log-post-message nil
12222 "Message to be displayed after a log note has been stored.
12223 The auto-repeater uses this.")
12225 (defun org-add-note ()
12226 "Add a note to the current entry.
12227 This is done in the same way as adding a state change note."
12228 (interactive)
12229 (org-add-log-setup 'note nil nil 'findpos nil))
12231 (defvar org-property-end-re)
12232 (defun org-add-log-setup (&optional purpose state prev-state
12233 findpos how extra)
12234 "Set up the post command hook to take a note.
12235 If this is about to TODO state change, the new state is expected in STATE.
12236 When FINDPOS is non-nil, find the correct position for the note in
12237 the current entry. If not, assume that it can be inserted at point.
12238 HOW is an indicator what kind of note should be created.
12239 EXTRA is additional text that will be inserted into the notes buffer."
12240 (let* ((org-log-into-drawer (org-log-into-drawer))
12241 (drawer (cond ((stringp org-log-into-drawer)
12242 org-log-into-drawer)
12243 (org-log-into-drawer "LOGBOOK")
12244 (t nil))))
12245 (save-restriction
12246 (save-excursion
12247 (when findpos
12248 (org-back-to-heading t)
12249 (narrow-to-region (point) (save-excursion
12250 (outline-next-heading) (point)))
12254 (goto-char (match-end 0))
12255 (cond
12256 (drawer
12258 nil t)
12259 (progn
12260 (goto-char (match-end 0))
12261 (or org-log-states-order-reversed
12262 (and (re-search-forward org-property-end-re nil t)
12263 (goto-char (1- (match-beginning 0))))))
12265 (beginning-of-line 0)
12266 (org-indent-line-function)
12267 (beginning-of-line 2)
12268 (org-indent-line-function)
12269 (end-of-line 0)))
12270 ((and org-log-state-notes-insert-after-drawers
12271 (save-excursion
12272 (forward-line) (looking-at org-drawer-regexp)))
12273 (forward-line)
12274 (while (looking-at org-drawer-regexp)
12275 (goto-char (match-end 0))
12276 (re-search-forward org-property-end-re (point-max) t)
12277 (forward-line))
12278 (forward-line -1)))
12279 (unless org-log-states-order-reversed
12281 (org-skip-over-state-notes)
12283 (move-marker org-log-note-marker (point))
12284 (setq org-log-note-purpose purpose
12285 org-log-note-state state
12286 org-log-note-previous-state prev-state
12287 org-log-note-how how
12288 org-log-note-extra extra
12289 org-log-note-effective-time (org-current-effective-time))
12290 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12292 (defun org-skip-over-state-notes ()
12293 "Skip past the list of State notes in an entry."
12295 (when (ignore-errors (goto-char (org-in-item-p)))
12296 (let* ((struct (org-list-struct))
12297 (prevs (org-list-prevs-alist struct)))
12299 (goto-char (or (org-list-get-next-item (point) struct prevs)
12300 (org-list-get-item-end (point) struct)))))))
12302 (defun org-add-log-note (&optional purpose)
12303 "Pop up a window for taking a note, and add this note later at point."
12304 (remove-hook 'post-command-hook 'org-add-log-note)
12305 (setq org-log-note-window-configuration (current-window-configuration))
12306 (delete-other-windows)
12307 (move-marker org-log-note-return-to (point))
12308 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12309 (goto-char org-log-note-marker)
12310 (org-switch-to-buffer-other-window "*Org Note*")
12311 (erase-buffer)
12312 (if (memq org-log-note-how '(time state))
12313 (let (current-prefix-arg) (org-store-log-note))
12314 (let ((org-inhibit-startup t)) (org-mode))
12315 (insert (format "# Insert note for %s.
12317 (cond
12318 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12319 ((eq org-log-note-purpose 'done) "closed todo item")
12320 ((eq org-log-note-purpose 'state)
12322 (or org-log-note-previous-state "")
12323 (or org-log-note-state "")))
12324 ((eq org-log-note-purpose 'reschedule)
12325 "rescheduling")
12326 ((eq org-log-note-purpose 'delschedule)
12327 "no longer scheduled")
12328 ((eq org-log-note-purpose 'redeadline)
12329 "changing deadline")
12330 ((eq org-log-note-purpose 'deldeadline)
12331 "removing deadline")
12332 ((eq org-log-note-purpose 'refile)
12333 "refiling")
12334 ((eq org-log-note-purpose 'note)
12335 "this entry")
12336 (t (error "This should not happen")))))
12337 (if org-log-note-extra (insert org-log-note-extra))
12338 (org-set-local 'org-finish-function 'org-store-log-note)
12339 (run-hooks 'org-log-buffer-setup-hook)))
12341 (defvar org-note-abort nil) ; dynamically scoped
12342 (defun org-store-log-note ()
12343 "Finish taking a log note, and insert it to where it belongs."
12344 (let ((txt (buffer-string))
12345 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12346 lines ind bul)
12347 (kill-buffer (current-buffer))
12349 (setq txt (replace-match "" t t txt)))
12351 (setq txt (replace-match "" t t txt)))
12354 (setq note
12355 (org-replace-escapes
12356 note
12357 (list (cons "%u" (user-login-name))
12358 (cons "%U" user-full-name)
12359 (cons "%t" (format-time-string
12360 (org-time-stamp-format 'long 'inactive)
12361 org-log-note-effective-time))
12362 (cons "%T" (format-time-string
12363 (org-time-stamp-format 'long nil)
12364 org-log-note-effective-time))
12365 (cons "%d" (format-time-string
12366 (org-time-stamp-format nil 'inactive)
12367 org-log-note-effective-time))
12368 (cons "%D" (format-time-string
12369 (org-time-stamp-format nil nil)
12370 org-log-note-effective-time))
12371 (cons "%s" (if org-log-note-state
12373 ""))
12374 (cons "%S" (if org-log-note-previous-state
12378 (push note lines))
12379 (when (or current-prefix-arg org-note-abort)
12380 (when org-log-into-drawer
12381 (org-remove-empty-drawer-at
12382 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12383 org-log-note-marker))
12384 (setq lines nil))
12385 (when lines
12386 (with-current-buffer (marker-buffer org-log-note-marker)
12387 (save-excursion
12388 (goto-char org-log-note-marker)
12389 (move-marker org-log-note-marker nil)
12390 (end-of-line 1)
12392 (setq ind (save-excursion
12393 (if (ignore-errors (goto-char (org-in-item-p)))
12394 (let ((struct (org-list-struct)))
12395 (org-list-get-ind
12396 (org-list-get-top-point struct) struct))
12398 (cond
12399 ((and (org-at-heading-p)
12400 org-adapt-indentation)
12401 (1+ (org-current-level)))
12402 ((org-at-heading-p) 0)
12403 (t (org-get-indentation))))))
12404 (setq bul (org-list-bullet-string "-"))
12405 (org-indent-line-to ind)
12406 (insert bul (pop lines))
12407 (let ((ind-body (+ (length bul) ind)))
12408 (while lines
12410 (org-indent-line-to ind-body)
12411 (insert (pop lines))))
12412 (message "Note stored")
12413 (org-back-to-heading t)
12414 (org-cycle-hide-drawers 'children)))))
12415 (set-window-configuration org-log-note-window-configuration)
12416 (with-current-buffer (marker-buffer org-log-note-return-to)
12417 (goto-char org-log-note-return-to))
12418 (move-marker org-log-note-return-to nil)
12419 (and org-log-post-message (message "%s" org-log-post-message)))
12421 (defun org-remove-empty-drawer-at (drawer pos)
12422 "Remove an empty drawer DRAWER at position POS.
12423 POS may also be a marker."
12424 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12425 (save-excursion
12426 (save-restriction
12427 (widen)
12428 (goto-char pos)
12429 (if (org-in-regexp
12431 (replace-match ""))))))
12433 (defun org-sparse-tree (&optional arg)
12434 "Create a sparse tree, prompt for the details.
12435 This command can create sparse trees. You first need to select the type
12436 of match used to create the tree:
12438 t Show all TODO entries.
12439 T Show entries with a specific TODO keyword.
12440 m Show entries selected by a tags/property match.
12441 p Enter a property name and its value (both with completion on existing
12442 names/values) and show entries with that property.
12443 r Show entries matching a regular expression (`/' can be used as well)
12444 d Show deadlines due within `org-deadline-warning-days'.
12445 b Show deadlines and scheduled items before a date.
12446 a Show deadlines and scheduled items after a date."
12447 (interactive "P")
12448 (let (ans kwd value)
12449 (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")
12450 (setq ans (read-char-exclusive))
12451 (cond
12452 ((equal ans ?d)
12453 (call-interactively 'org-check-deadlines))
12454 ((equal ans ?b)
12455 (call-interactively 'org-check-before-date))
12456 ((equal ans ?a)
12457 (call-interactively 'org-check-after-date))
12458 ((equal ans ?D)
12459 (call-interactively 'org-check-dates-range))
12460 ((equal ans ?t)
12461 (org-show-todo-tree nil))
12462 ((equal ans ?T)
12463 (org-show-todo-tree '(4)))
12464 ((member ans '(?T ?m))
12465 (call-interactively 'org-match-sparse-tree))
12466 ((member ans '(?p ?P))
12467 (setq kwd (org-icompleting-read "Property: "
12468 (mapcar 'list (org-buffer-property-keys))))
12469 (setq value (org-icompleting-read "Value: "
12470 (mapcar 'list (org-property-values kwd))))
12473 (org-match-sparse-tree arg (concat kwd "=" value)))
12474 ((member ans '(?r ?R ?/))
12475 (call-interactively 'org-occur))
12478 (defvar org-occur-highlights nil
12479 "List of overlays used for occur matches.")
12480 (make-variable-buffer-local 'org-occur-highlights)
12481 (defvar org-occur-parameters nil
12482 "Parameters of the active org-occur calls.
12483 This is a list, each call to org-occur pushes as cons cell,
12484 containing the regular expression and the callback, onto the list.
12485 The list can contain several entries if `org-occur' has been called
12486 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12487 will only contain one set of parameters. When the highlights are
12488 removed (for example with `C-c C-c', or with the next edit (depending
12489 on `org-remove-highlights-with-change'), this variable is emptied
12490 as well.")
12491 (make-variable-buffer-local 'org-occur-parameters)
12493 (defun org-occur (regexp &optional keep-previous callback)
12494 "Make a compact tree which shows all matches of REGEXP.
12495 The tree will show the lines where the regexp matches, and all higher
12496 headlines above the match. It will also show the heading after the match,
12497 to make sure editing the matching entry is easy.
12498 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12499 call to `org-occur' will be kept, to allow stacking of calls to this
12500 command.
12501 If CALLBACK is non-nil, it is a function which is called to confirm
12502 that the match should indeed be shown."
12504 (when (equal regexp "")
12505 (error "Regexp cannot be empty"))
12506 (unless keep-previous
12507 (org-remove-occur-highlights nil nil t))
12508 (push (cons regexp callback) org-occur-parameters)
12509 (let ((cnt 0))
12510 (save-excursion
12511 (goto-char (point-min))
12512 (if (or (not keep-previous) ; do not want to keep
12513 (not org-occur-highlights)) ; no previous matches
12514 ;; hide everything
12515 (org-overview))
12516 (while (re-search-forward regexp nil t)
12517 (when (or (not callback)
12518 (save-match-data (funcall callback)))
12519 (setq cnt (1+ cnt))
12520 (when org-highlight-sparse-tree-matches
12521 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12522 (org-show-context 'occur-tree))))
12523 (when org-remove-highlights-with-change
12524 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12525 nil 'local))
12526 (unless org-sparse-tree-open-archived-trees
12527 (org-hide-archived-subtrees (point-min) (point-max)))
12528 (run-hooks 'org-occur-hook)
12529 (if (org-called-interactively-p 'interactive)
12530 (message "%d match(es) for regexp %s" cnt regexp))
12531 cnt))
12533 (defun org-occur-next-match (&optional n reset)
12534 "Function for `next-error-function' to find sparse tree matches.
12535 N is the number of matches to move, when negative move backwards.
12536 RESET is entirely ignored - this function always goes back to the
12537 starting point when no match is found."
12538 (let* ((limit (if (< n 0) (point-min) (point-max)))
12539 (search-func (if (< n 0)
12540 'previous-single-char-property-change
12541 'next-single-char-property-change))
12542 (n (abs n))
12543 (pos (point))
12544 p1)
12545 (catch 'exit
12546 (while (setq p1 (funcall search-func (point) 'org-type))
12547 (when (equal p1 limit)
12548 (goto-char pos)
12549 (error "No more matches"))
12550 (when (equal (get-char-property p1 'org-type) 'org-occur)
12551 (setq n (1- n))
12552 (when (= n 0)
12553 (goto-char p1)
12554 (throw 'exit (point))))
12555 (goto-char p1))
12556 (goto-char p1)
12557 (error "No more matches"))))
12559 (defun org-show-context (&optional key)
12560 "Make sure point and context are visible.
12561 How much context is shown depends upon the variables
12562 `org-show-hierarchy-above', `org-show-following-heading',
12563 `org-show-entry-below' and `org-show-siblings'."
12564 (let ((heading-p (org-at-heading-p t))
12565 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12566 (following-p (org-get-alist-option org-show-following-heading key))
12567 (entry-p (org-get-alist-option org-show-entry-below key))
12568 (siblings-p (org-get-alist-option org-show-siblings key)))
12569 (catch 'exit
12570 ;; Show heading or entry text
12571 (if (and heading-p (not entry-p))
12572 (org-flag-heading nil) ; only show the heading
12573 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12574 (org-show-hidden-entry))) ; show entire entry
12575 (when following-p
12576 ;; Show next sibling, or heading below text
12577 (save-excursion
12578 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12579 (org-flag-heading nil))))
12580 (when siblings-p (org-show-siblings))
12581 (when hierarchy-p
12582 ;; show all higher headings, possibly with siblings
12583 (save-excursion
12584 (while (and (condition-case nil
12585 (progn (org-up-heading-all 1) t)
12586 (error nil))
12587 (not (bobp)))
12588 (org-flag-heading nil)
12589 (when siblings-p (org-show-siblings))))))))
12591 (defvar org-reveal-start-hook nil
12592 "Hook run before revealing a location.")
12594 (defun org-reveal (&optional siblings)
12595 "Show current entry, hierarchy above it, and the following headline.
12596 This can be used to show a consistent set of context around locations
12597 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12598 not t for the search context.
12600 With optional argument SIBLINGS, on each level of the hierarchy all
12601 siblings are shown. This repairs the tree structure to what it would
12602 look like when opened with hierarchical calls to `org-cycle'.
12604 go to the parent and show the
12605 entire tree."
12606 (interactive "P")
12607 (run-hooks 'org-reveal-start-hook)
12608 (let ((org-show-hierarchy-above t)
12609 (org-show-following-heading t)
12610 (org-show-siblings (if siblings t org-show-siblings)))
12611 (org-show-context nil))
12612 (when (equal siblings '(16))
12613 (save-excursion
12614 (when (org-up-heading-safe)
12615 (org-show-subtree)
12616 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12618 (defun org-highlight-new-match (beg end)
12619 "Highlight from BEG to END and mark the highlight is an occur headline."
12620 (let ((ov (make-overlay beg end)))
12621 (overlay-put ov 'face 'secondary-selection)
12622 (overlay-put ov 'org-type 'org-occur)
12623 (push ov org-occur-highlights)))
12625 (defun org-remove-occur-highlights (&optional beg end noremove)
12626 "Remove the occur highlights from the buffer.
12627 BEG and END are ignored. If NOREMOVE is nil, remove this function
12628 from the `before-change-functions' in the current buffer."
12629 (interactive)
12630 (unless org-inhibit-highlight-removal
12631 (mapc 'delete-overlay org-occur-highlights)
12632 (setq org-occur-highlights nil)
12633 (setq org-occur-parameters nil)
12634 (unless noremove
12635 (remove-hook 'before-change-functions
12636 'org-remove-occur-highlights 'local))))
12638 ;;;; Priorities
12641 "Regular expression matching the priority indicator.")
12643 (defvar org-remove-priority-next-time nil)
12645 (defun org-priority-up ()
12646 "Increase the priority of the current item."
12647 (interactive)
12648 (org-priority 'up))
12650 (defun org-priority-down ()
12651 "Decrease the priority of the current item."
12652 (interactive)
12653 (org-priority 'down))
12655 (defun org-priority (&optional action)
12656 "Change the priority of an item by ARG.
12657 ACTION can be `set', `up', `down', or a character."
12658 (interactive)
12659 (unless org-enable-priority-commands
12660 (error "Priority commands are disabled"))
12661 (setq action (or action 'set))
12662 (let (current new news have remove)
12663 (save-excursion
12664 (org-back-to-heading t)
12665 (if (looking-at org-priority-regexp)
12666 (setq current (string-to-char (match-string 2))
12667 have t))
12668 (cond
12669 ((eq action 'remove)
12670 (setq remove t new ?\ ))
12671 ((or (eq action 'set)
12672 (if (featurep 'xemacs) (characterp action) (integerp action)))
12673 (if (not (eq action 'set))
12674 (setq new action)
12675 (message "Priority %c-%c, SPC to remove: "
12676 org-highest-priority org-lowest-priority)
12677 (save-match-data
12678 (setq new (read-char-exclusive))))
12679 (if (and (= (upcase org-highest-priority) org-highest-priority)
12680 (= (upcase org-lowest-priority) org-lowest-priority))
12681 (setq new (upcase new)))
12682 (cond ((equal new ?\ ) (setq remove t))
12683 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12684 (error "Priority must be between `%c' and `%c'"
12685 org-highest-priority org-lowest-priority))))
12686 ((eq action 'up)
12687 (setq new (if have
12688 (1- current) ; normal cycling
12689 ;; last priority was empty
12690 (if (eq last-command this-command)
12691 org-lowest-priority ; wrap around empty to lowest
12692 ;; default
12693 (if org-priority-start-cycle-with-default
12694 org-default-priority
12695 (1- org-default-priority))))))
12696 ((eq action 'down)
12697 (setq new (if have
12698 (1+ current) ; normal cycling
12699 ;; last priority was empty
12700 (if (eq last-command this-command)
12701 org-highest-priority ; wrap around empty to highest
12702 ;; default
12703 (if org-priority-start-cycle-with-default
12704 org-default-priority
12705 (1+ org-default-priority))))))
12706 (t (error "Invalid action")))
12707 (if (or (< (upcase new) org-highest-priority)
12708 (> (upcase new) org-lowest-priority))
12709 (if (and (memq action '(up down))
12710 (not have) (not (eq last-command this-command)))
12711 ;; `new' is from default priority
12712 (error
12713 "The default can not be set, see `org-default-priority' why")
12714 ;; normal cycling: `new' is beyond highest/lowest priority
12715 ;; and is wrapped around to the empty priority
12716 (setq remove t)))
12717 (setq news (format "%c" new))
12718 (if have
12719 (if remove
12720 (replace-match "" t t nil 1)
12721 (replace-match news t t nil 2))
12722 (if remove
12723 (error "No priority cookie found in line")
12724 (let ((case-fold-search nil))
12725 (looking-at org-todo-line-regexp))
12726 (if (match-end 2)
12727 (progn
12728 (goto-char (match-end 2))
12729 (insert " [#" news "]"))
12730 (goto-char (match-beginning 3))
12731 (insert "[#" news "] "))))
12732 (org-preserve-lc (org-set-tags nil 'align)))
12733 (if remove
12734 (message "Priority removed")
12735 (message "Priority of current item set to %s" news))))
12737 (defun org-get-priority (s)
12738 "Find priority cookie and return priority."
12739 (if (functionp org-get-priority-function)
12740 (funcall org-get-priority-function)
12741 (save-match-data
12742 (if (not (string-match org-priority-regexp s))
12743 (* 1000 (- org-lowest-priority org-default-priority))
12744 (* 1000 (- org-lowest-priority
12745 (string-to-char (match-string 2 s))))))))
12747 ;;;; Tags
12749 (defvar org-agenda-archives-mode)
12750 (defvar org-map-continue-from nil
12751 "Position from where mapping should continue.
12752 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12754 (defvar org-scanner-tags nil
12755 "The current tag list while the tags scanner is running.")
12756 (defvar org-trust-scanner-tags nil
12757 "Should `org-get-tags-at' use the tags for the scanner.
12758 This is for internal dynamical scoping only.
12759 When this is non-nil, the function `org-get-tags-at' will return the value
12760 of `org-scanner-tags' instead of building the list by itself. This
12761 can lead to large speed-ups when the tags scanner is used in a file with
12762 many entries, and when the list of tags is retrieved, for example to
12763 obtain a list of properties. Building the tags list for each entry in such
12764 a file becomes an N^2 operation - but with this variable set, it scales
12765 as N.")
12767 (defun org-scan-tags (action matcher &optional todo-only start-level)
12768 "Scan headline tags with inheritance and produce output ACTION.
12770 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12771 or `agenda' to produce an entry list for an agenda view. It can also be
12772 a Lisp form or a function that should be called at each matched headline, in
12773 this case the return value is a list of all return values from these calls.
12775 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12776 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12777 only lines with a TODO keyword are included in the output.
12779 START-LEVEL can be a string with asterisks, reducing the scope to
12780 headlines matching this string."
12781 (require 'org-agenda)
12782 (let* ((re (concat "^"
12783 (if start-level
12784 ;; Get the correct level to match
12786 org-outline-regexp)
12789 (org-re
12791 (props (list 'face 'default
12792 'done-face 'org-agenda-done
12793 'undone-face 'default
12794 'mouse-face 'highlight
12795 'org-not-done-regexp org-not-done-regexp
12796 'org-todo-regexp org-todo-regexp
12797 'org-complex-heading-regexp org-complex-heading-regexp
12798 'help-echo
12799 (format "mouse-2 or RET jump to org file %s"
12800 (abbreviate-file-name
12801 (or (buffer-file-name (buffer-base-buffer))
12802 (buffer-name (buffer-base-buffer)))))))
12803 (case-fold-search nil)
12804 (org-map-continue-from nil)
12805 lspos tags tags-list
12806 (tags-alist (list (cons 0 org-file-tags)))
12807 (llast 0) rtn rtn1 level category i txt
12808 todo marker entry priority)
12809 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12810 (setq action (list 'lambda nil action)))
12811 (save-excursion
12812 (goto-char (point-min))
12813 (when (eq action 'sparse-tree)
12814 (org-overview)
12815 (org-remove-occur-highlights))
12816 (while (re-search-forward re nil t)
12817 (setq org-map-continue-from nil)
12818 (catch :skip
12819 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12820 tags (if (match-end 4) (org-match-string-no-properties 4)))
12821 (goto-char (setq lspos (match-beginning 0)))
12822 (setq level (org-reduced-level (funcall outline-level))
12823 category (org-get-category))
12824 (setq i llast llast level)
12825 ;; remove tag lists from same and sublevels
12826 (while (>= i level)
12827 (when (setq entry (assoc i tags-alist))
12828 (setq tags-alist (delete entry tags-alist)))
12829 (setq i (1- i)))
12830 ;; add the next tags
12831 (when tags
12832 (setq tags (org-split-string tags ":")
12833 tags-alist
12834 (cons (cons level tags) tags-alist)))
12835 ;; compile tags for current headline
12836 (setq tags-list
12837 (if org-use-tag-inheritance
12838 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12839 tags)
12840 org-scanner-tags tags-list)
12841 (when org-use-tag-inheritance
12842 (setcdr (car tags-alist)
12843 (mapcar (lambda (x)
12844 (setq x (copy-sequence x))
12845 (org-add-prop-inherited x))
12846 (cdar tags-alist))))
12847 (when (and tags org-use-tag-inheritance
12848 (or (not (eq t org-use-tag-inheritance))
12849 org-tags-exclude-from-inheritance))
12850 ;; selective inheritance, remove uninherited ones
12851 (setcdr (car tags-alist)
12852 (org-remove-uninherited-tags (cdar tags-alist))))
12853 (when (and
12855 ;; eval matcher only when the todo condition is OK
12856 (and (or (not todo-only) (member todo org-not-done-keywords))
12857 (let ((case-fold-search t)) (eval matcher)))
12859 ;; Call the skipper, but return t if it does not skip,
12860 ;; so that the `and' form continues evaluating
12861 (progn
12862 (unless (eq action 'sparse-tree) (org-agenda-skip))
12863 t)
12865 ;; Check if timestamps are deselecting this entry
12866 (or (not todo-only)
12867 (and (member todo org-not-done-keywords)
12868 (or (not org-agenda-tags-todo-honor-ignore-options)
12869 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12871 ;; Extra check for the archive tag
12872 ;; FIXME: Does the skipper already do this????
12873 (or
12874 (not (member org-archive-tag tags-list))
12875 ;; we have an archive tag, should we use this anyway?
12876 (or (not org-agenda-skip-archived-trees)
12877 (and (eq action 'agenda) org-agenda-archives-mode))))
12879 ;; select this headline
12881 (cond
12882 ((eq action 'sparse-tree)
12883 (and org-highlight-sparse-tree-matches
12884 (org-get-heading) (match-end 0)
12885 (org-highlight-new-match
12886 (match-beginning 1) (match-end 1)))
12887 (org-show-context 'tags-tree))
12888 ((eq action 'agenda)
12889 (setq txt (org-agenda-format-item
12890 ""
12891 (concat
12892 (if (eq org-tags-match-list-sublevels 'indented)
12893 (make-string (1- level) ?.) "")
12894 (org-get-heading))
12895 category
12896 tags-list
12897 )
12898 priority (org-get-priority txt))
12899 (goto-char lspos)
12900 (setq marker (org-agenda-new-marker))
12901 (org-add-props txt props
12902 'org-marker marker 'org-hd-marker marker 'org-category category
12903 'todo-state todo
12904 'priority priority 'type "tagsmatch")
12905 (push txt rtn))
12906 ((functionp action)
12907 (setq org-map-continue-from nil)
12908 (save-excursion
12909 (setq rtn1 (funcall action))
12910 (push rtn1 rtn)))
12911 (t (error "Invalid action")))
12913 ;; if we are to skip sublevels, jump to end of subtree
12914 (unless org-tags-match-list-sublevels
12915 (org-end-of-subtree t)
12916 (backward-char 1))))
12917 ;; Get the correct position from where to continue
12918 (if org-map-continue-from
12919 (goto-char org-map-continue-from)
12920 (and (= (point) lspos) (end-of-line 1)))))
12921 (when (and (eq action 'sparse-tree)
12922 (not org-sparse-tree-open-archived-trees))
12923 (org-hide-archived-subtrees (point-min) (point-max)))
12924 (nreverse rtn)))
12926 (defun org-remove-uninherited-tags (tags)
12927 "Remove all tags that are not inherited from the list TAGS."
12928 (cond
12929 ((eq org-use-tag-inheritance t)
12930 (if org-tags-exclude-from-inheritance
12931 (org-delete-all org-tags-exclude-from-inheritance tags)
12932 tags))
12933 ((not org-use-tag-inheritance) nil)
12934 ((stringp org-use-tag-inheritance)
12935 (delq nil (mapcar
12936 (lambda (x)
12937 (if (and (string-match org-use-tag-inheritance x)
12938 (not (member x org-tags-exclude-from-inheritance)))
12939 x nil))
12940 tags)))
12941 ((listp org-use-tag-inheritance)
12942 (delq nil (mapcar
12943 (lambda (x)
12944 (if (member x org-use-tag-inheritance) x nil))
12945 tags)))))
12947 (defvar todo-only) ;; dynamically scoped
12949 (defun org-match-sparse-tree (&optional todo-only match)
12950 "Create a sparse tree according to tags string MATCH.
12951 MATCH can contain positive and negative selection of tags, like
12953 If optional argument TODO-ONLY is non-nil, only select lines that are
12954 also TODO lines."
12955 (interactive "P")
12956 (org-prepare-agenda-buffers (list (current-buffer)))
12957 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12959 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12961 (defvar org-cached-props nil)
12962 (defun org-cached-entry-get (pom property)
12963 (if (or (eq t org-use-property-inheritance)
12964 (and (stringp org-use-property-inheritance)
12965 (string-match org-use-property-inheritance property))
12966 (and (listp org-use-property-inheritance)
12967 (member property org-use-property-inheritance)))
12968 ;; Caching is not possible, check it directly
12969 (org-entry-get pom property 'inherit)
12970 ;; Get all properties, so that we can do complicated checks easily
12971 (cdr (assoc property (or org-cached-props
12972 (setq org-cached-props
12973 (org-entry-properties pom)))))))
12975 (defun org-global-tags-completion-table (&optional files)
12976 "Return the list of all tags in all agenda buffer/files.
12977 Optional FILES argument is a list of files to which can be used
12978 instead of the agenda files."
12979 (save-excursion
12980 (org-uniquify
12981 (delq nil
12982 (apply 'append
12983 (mapcar
12984 (lambda (file)
12985 (set-buffer (find-file-noselect file))
12986 (append (org-get-buffer-tags)
12987 (mapcar (lambda (x) (if (stringp (car-safe x))
12988 (list (car-safe x)) nil))
12989 org-tag-alist)))
12990 (if (and files (car files))
12991 files
12992 (org-agenda-files))))))))
12994 (defun org-make-tags-matcher (match)
12995 "Create the TAGS/TODO matcher form for the selection string MATCH."
12996 ;; todo-only is scoped dynamically into this function, and the function
12997 ;; may change it if the matcher asks for it.
12998 (unless match
12999 ;; Get a new match request, with completion
13000 (let ((org-last-tags-completion-table
13001 (org-global-tags-completion-table)))
13002 (setq match (org-completing-read-no-i
13003 "Match: " 'org-tags-completion-function nil nil nil
13004 'org-tags-history))))
13006 ;; Parse the string and create a lisp form
13007 (let ((match0 match)
13008 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13009 minus tag mm
13010 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13011 orterms term orlist re-p str-p level-p level-op time-p
13012 prop-p pn pv po gv rest)
13013 (if (string-match "/+" match)
13014 ;; match contains also a todo-matching request
13015 (progn
13016 (setq tagsmatch (substring match 0 (match-beginning 0))
13017 todomatch (substring match (match-end 0)))
13018 (if (string-match "^!" todomatch)
13019 (setq todo-only t todomatch (substring todomatch 1)))
13021 (setq todomatch nil)))
13022 ;; only matching tags
13023 (setq tagsmatch match todomatch nil))
13025 ;; Make the tags matcher
13027 (setq tagsmatcher t)
13028 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13029 (while (setq term (pop orterms))
13031 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13032 (while (string-match re term)
13033 (setq rest (substring term (match-end 0))
13034 minus (and (match-end 1)
13035 (equal (match-string 1 term) "-"))
13036 tag (save-match-data (replace-regexp-in-string
13038 (match-string 2 term)))
13039 re-p (equal (string-to-char tag) ?{)
13040 level-p (match-end 4)
13041 prop-p (match-end 5)
13042 mm (cond
13043 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13044 (level-p
13045 (setq level-op (org-op-to-function (match-string 3 term)))
13046 `(,level-op level ,(string-to-number
13047 (match-string 4 term))))
13048 (prop-p
13049 (setq pn (match-string 5 term)
13050 po (match-string 6 term)
13051 pv (match-string 7 term)
13052 re-p (equal (string-to-char pv) ?{)
13054 time-p (save-match-data
13056 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13057 (if time-p (setq pv (org-matcher-time pv)))
13058 (setq po (org-op-to-function po (if time-p 'time str-p)))
13059 (cond
13060 ((equal pn "CATEGORY")
13061 (setq gv '(get-text-property (point) 'org-category)))
13062 ((equal pn "TODO")
13063 (setq gv 'todo))
13064 (t
13065 (setq gv `(org-cached-entry-get nil ,pn))))
13066 (if re-p
13067 (if (eq po 'org<>)
13068 `(not (string-match ,pv (or ,gv "")))
13069 `(string-match ,pv (or ,gv "")))
13070 (if str-p
13071 `(,po (or ,gv "") ,pv)
13072 `(,po (string-to-number (or ,gv ""))
13073 ,(string-to-number pv) ))))
13074 (t `(member ,tag tags-list)))
13075 mm (if minus (list 'not mm) mm)
13076 term rest)
13077 (push mm tagsmatcher))
13078 (push (if (> (length tagsmatcher) 1)
13079 (cons 'and tagsmatcher)
13080 (car tagsmatcher))
13081 orlist)
13082 (setq tagsmatcher nil))
13083 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13084 (setq tagsmatcher
13085 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13086 ;; Make the todo matcher
13088 (setq todomatcher t)
13089 (setq orterms (org-split-string todomatch "|") orlist nil)
13090 (while (setq term (pop orterms))
13091 (while (string-match re term)
13092 (setq minus (and (match-end 1)
13093 (equal (match-string 1 term) "-"))
13094 kwd (match-string 2 term)
13095 re-p (equal (string-to-char kwd) ?{)
13096 term (substring term (match-end 0))
13097 mm (if re-p
13098 `(string-match ,(substring kwd 1 -1) todo)
13099 (list 'equal 'todo kwd))
13100 mm (if minus (list 'not mm) mm))
13101 (push mm todomatcher))
13102 (push (if (> (length todomatcher) 1)
13103 (cons 'and todomatcher)
13104 (car todomatcher))
13105 orlist)
13106 (setq todomatcher nil))
13107 (setq todomatcher (if (> (length orlist) 1)
13108 (cons 'or orlist) (car orlist))))
13110 ;; Return the string and lisp forms of the matcher
13111 (setq matcher (if todomatcher
13112 (list 'and tagsmatcher todomatcher)
13113 tagsmatcher))
13114 (cons match0 matcher)))
13116 (defun org-op-to-function (op &optional stringp)
13117 "Turn an operator into the appropriate function."
13118 (setq op
13119 (cond
13120 ((equal op "<" ) '(< string< org-time<))
13121 ((equal op ">" ) '(> org-string> org-time>))
13122 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13123 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13124 ((member op '("=" "==")) '(= string= org-time=))
13125 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13126 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13128 (defun org<> (a b) (not (= a b)))
13129 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13130 (defun org-string>= (a b) (not (string< a b)))
13131 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13132 (defun org-string<> (a b) (not (string= a b)))
13133 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13134 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13135 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13136 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13137 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13138 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13139 (defun org-2ft (s)
13140 "Convert S to a floating point time.
13141 If S is already a number, just return it. If it is a string, parse
13142 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13143 (cond
13144 ((numberp s) s)
13145 ((stringp s)
13146 (condition-case nil
13147 (float-time (apply 'encode-time (org-parse-time-string s)))
13148 (error 0.)))
13149 (t 0.)))
13151 (defun org-time-today ()
13152 "Time in seconds today at 0:00.
13153 Returns the float number of seconds since the beginning of the
13154 epoch to the beginning of today (00:00)."
13155 (float-time (apply 'encode-time
13156 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13158 (defun org-matcher-time (s)
13159 "Interpret a time comparison value."
13160 (save-match-data
13161 (cond
13162 ((string= s "<now>") (float-time))
13163 ((string= s "<today>") (org-time-today))
13164 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13165 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13167 (+ (org-time-today)
13168 (* (string-to-number (match-string 1 s))
13169 (cdr (assoc (match-string 2 s)
13170 '(("d" . 86400.0) ("w" . 604800.0)
13171 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13172 (t (org-2ft s)))))
13174 (defun org-match-any-p (re list)
13175 "Does re match any element of list?"
13176 (setq list (mapcar (lambda (x) (string-match re x)) list))
13177 (delq nil list))
13179 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13180 (defvar org-tags-overlay (make-overlay 1 1))
13181 (org-detach-overlay org-tags-overlay)
13183 (defun org-get-local-tags-at (&optional pos)
13184 "Get a list of tags defined in the current headline."
13185 (org-get-tags-at pos 'local))
13187 (defun org-get-local-tags ()
13188 "Get a list of tags defined in the current headline."
13189 (org-get-tags-at nil 'local))
13191 (defun org-get-tags-at (&optional pos local)
13192 "Get a list of all headline tags applicable at POS.
13193 POS defaults to point. If tags are inherited, the list contains
13194 the targets in the same sequence as the headlines appear, i.e.
13195 the tags of the current headline come last.
13196 When LOCAL is non-nil, only return tags from the current headline,
13197 ignore inherited ones."
13198 (interactive)
13199 (if (and org-trust-scanner-tags
13200 (or (not pos) (equal pos (point)))
13201 (not local))
13202 org-scanner-tags
13203 (let (tags ltags lastpos parent)
13204 (save-excursion
13205 (save-restriction
13206 (widen)
13207 (goto-char (or pos (point)))
13208 (save-match-data
13209 (catch 'done
13210 (condition-case nil
13211 (progn
13212 (org-back-to-heading t)
13213 (while (not (equal lastpos (point)))
13214 (setq lastpos (point))
13215 (when (looking-at
13217 (setq ltags (org-split-string
13218 (org-match-string-no-properties 1) ":"))
13219 (when parent
13220 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13221 (setq tags (append
13222 (if parent
13223 (org-remove-uninherited-tags ltags)
13224 ltags)
13225 tags)))
13226 (or org-use-tag-inheritance (throw 'done t))
13227 (if local (throw 'done t))
13228 (or (org-up-heading-safe) (error nil))
13229 (setq parent t)))
13230 (error nil)))))
13231 (if local
13232 tags
13233 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13235 (defun org-add-prop-inherited (s)
13236 (add-text-properties 0 (length s) '(inherited t) s)
13237 s)
13239 (defun org-toggle-tag (tag &optional onoff)
13240 "Toggle the tag TAG for the current line.
13241 If ONOFF is `on' or `off', don't toggle but set to this state."
13242 (let (res current)
13243 (save-excursion
13244 (org-back-to-heading t)
13246 (point-at-eol) t)
13247 (progn
13248 (setq current (match-string 1))
13249 (replace-match ""))
13250 (setq current ""))
13251 (setq current (nreverse (org-split-string current ":")))
13252 (cond
13253 ((eq onoff 'on)
13254 (setq res t)
13255 (or (member tag current) (push tag current)))
13256 ((eq onoff 'off)
13257 (or (not (member tag current)) (setq current (delete tag current))))
13258 (t (if (member tag current)
13259 (setq current (delete tag current))
13260 (setq res t)
13261 (push tag current))))
13262 (end-of-line 1)
13263 (if current
13264 (progn
13265 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13266 (org-set-tags nil t))
13267 (delete-horizontal-space))
13268 (run-hooks 'org-after-tags-change-hook))
13269 res))
13271 (defun org-align-tags-here (to-col)
13272 ;; Assumes that this is a headline
13273 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13274 (beginning-of-line 1)
13276 (< pos (match-beginning 2)))
13277 (progn
13278 (setq tags-l (- (match-end 2) (match-beginning 2)))
13279 (goto-char (match-beginning 1))
13280 (insert " ")
13281 (delete-region (point) (1+ (match-beginning 2)))
13282 (setq ncol (max (current-column)
13283 (1+ col)
13284 (if (> to-col 0)
13285 to-col
13286 (- (abs to-col) tags-l))))
13287 (setq p (point))
13288 (insert (make-string (- ncol (current-column)) ?\ ))
13289 (setq ncol (current-column))
13290 (when indent-tabs-mode (tabify p (point-at-eol)))
13291 (org-move-to-column (min ncol col) t))
13292 (goto-char pos))))
13294 (defun org-set-tags-command (&optional arg just-align)
13295 "Call the set-tags command for the current entry."
13296 (interactive "P")
13297 (if (org-at-heading-p)
13298 (org-set-tags arg just-align)
13299 (save-excursion
13300 (org-back-to-heading t)
13301 (org-set-tags arg just-align))))
13303 (defun org-set-tags-to (data)
13304 "Set the tags of the current entry to DATA, replacing the current tags.
13305 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13306 If DATA is nil or the empty string, any tags will be removed."
13307 (interactive "sTags: ")
13308 (setq data
13309 (cond
13310 ((eq data nil) "")
13311 ((equal data "") "")
13312 ((stringp data)
13313 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13314 ":"))
13315 ((listp data)
13316 (concat ":" (mapconcat 'identity data ":") ":"))
13317 (t nil)))
13318 (when data
13319 (save-excursion
13320 (org-back-to-heading t)
13321 (when (looking-at org-complex-heading-regexp)
13322 (if (match-end 5)
13323 (progn
13324 (goto-char (match-beginning 5))
13325 (insert data)
13326 (delete-region (point) (point-at-eol))
13327 (org-set-tags nil 'align))
13328 (goto-char (point-at-eol))
13329 (insert " " data)
13330 (org-set-tags nil 'align)))
13331 (beginning-of-line 1)
13333 (delete-region (match-beginning 1) (match-end 1))))))
13335 (defun org-align-all-tags ()
13336 "Align the tags i all headings."
13337 (interactive)
13338 (save-excursion
13339 (or (ignore-errors (org-back-to-heading t))
13340 (outline-next-heading))
13341 (if (org-at-heading-p)
13342 (org-set-tags t)
13343 (message "No headings"))))
13345 (defvar org-indent-indentation-per-level)
13346 (defun org-set-tags (&optional arg just-align)
13347 "Set the tags for the current headline.
13348 With prefix ARG, realign all tags in headings in the current buffer."
13349 (interactive "P")
13350 (let* ((re org-outline-regexp-bol)
13351 (current (org-get-tags-string))
13352 (col (current-column))
13353 (org-setting-tags t)
13354 table current-tags inherited-tags ; computed below when needed
13355 tags p0 c0 c1 rpl di tc level)
13356 (if arg
13357 (save-excursion
13358 (goto-char (point-min))
13359 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13360 (while (re-search-forward re nil t)
13361 (org-set-tags nil t)
13362 (end-of-line 1)))
13363 (message "All tags realigned to column %d" org-tags-column))
13364 (if just-align
13365 (setq tags current)
13366 ;; Get a new set of tags from the user
13367 (save-excursion
13368 (setq table (append org-tag-persistent-alist
13369 (or org-tag-alist (org-get-buffer-tags))
13370 (and
13371 org-complete-tags-always-offer-all-agenda-tags
13372 (org-global-tags-completion-table
13373 (org-agenda-files))))
13374 org-last-tags-completion-table table
13375 current-tags (org-split-string current ":")
13376 inherited-tags (nreverse
13377 (nthcdr (length current-tags)
13378 (nreverse (org-get-tags-at))))
13379 tags
13380 (if (or (eq t org-use-fast-tag-selection)
13381 (and org-use-fast-tag-selection
13382 (delq nil (mapcar 'cdr table))))
13383 (org-fast-tag-selection
13384 current-tags inherited-tags table
13385 (if org-fast-tag-selection-include-todo
13386 org-todo-key-alist))
13387 (let ((org-add-colon-after-tag-completion t))
13388 (org-trim
13389 (org-icompleting-read "Tags: "
13390 'org-tags-completion-function
13391 nil nil current 'org-tags-history))))))
13392 (while (string-match "[-+&]+" tags)
13393 ;; No boolean logic, just a list
13394 (setq tags (replace-match ":" t t tags))))
13396 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13398 (if org-tags-sort-function
13399 (setq tags (mapconcat 'identity
13400 (sort (org-split-string
13401 tags (org-re "[^[:alnum:]_@#%]+"))
13402 org-tags-sort-function) ":")))
13405 (setq tags "")
13406 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13407 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13409 ;; Insert new tags at the correct column
13410 (beginning-of-line 1)
13411 (setq level (or (and (looking-at org-outline-regexp)
13412 (- (match-end 0) (point) 1))
13413 1))
13414 (cond
13415 ((and (equal current "") (equal tags "")))
13416 ((re-search-forward
13418 (point-at-eol) t)
13419 (if (equal tags "")
13420 (setq rpl "")
13421 (goto-char (match-beginning 0))
13422 (setq c0 (current-column)
13423 ;; compute offset for the case of org-indent-mode active
13424 di (if org-indent-mode
13425 (* (1- org-indent-indentation-per-level) (1- level))
13426 0)
13427 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13428 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13429 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13430 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13431 (replace-match rpl t t)
13432 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13433 tags)
13434 (t (error "Tags alignment failed")))
13435 (org-move-to-column col)
13436 (unless just-align
13437 (run-hooks 'org-after-tags-change-hook)))))
13439 (defun org-change-tag-in-region (beg end tag off)
13440 "Add or remove TAG for each entry in the region.
13441 This works in the agenda, and also in an org-mode buffer."
13442 (interactive
13443 (list (region-beginning) (region-end)
13444 (let ((org-last-tags-completion-table
13445 (if (eq major-mode 'org-mode)
13446 (org-get-buffer-tags)
13447 (org-global-tags-completion-table))))
13448 (org-icompleting-read
13449 "Tag: " 'org-tags-completion-function nil nil nil
13450 'org-tags-history))
13451 (progn
13453 (equal (read-char-exclusive) ?r))))
13454 (if (fboundp 'deactivate-mark) (deactivate-mark))
13455 (let ((agendap (equal major-mode 'org-agenda-mode))
13456 l1 l2 m buf pos newhead (cnt 0))
13457 (goto-char end)
13458 (setq l2 (1- (org-current-line)))
13459 (goto-char beg)
13460 (setq l1 (org-current-line))
13461 (loop for l from l1 to l2 do
13462 (org-goto-line l)
13463 (setq m (get-text-property (point) 'org-hd-marker))
13464 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13465 (and agendap m))
13466 (setq buf (if agendap (marker-buffer m) (current-buffer))
13467 pos (if agendap m (point)))
13468 (with-current-buffer buf
13469 (save-excursion
13470 (save-restriction
13471 (goto-char pos)
13472 (setq cnt (1+ cnt))
13473 (org-toggle-tag tag (if off 'off 'on))
13474 (setq newhead (org-get-heading)))))
13475 (and agendap (org-agenda-change-all-lines newhead m))))
13476 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13478 (defun org-tags-completion-function (string predicate &optional flag)
13479 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13480 (confirm (lambda (x) (stringp (car x)))))
13482 (setq s1 (match-string 1 string)
13483 s2 (match-string 2 string))
13484 (setq s1 "" s2 string))
13485 (cond
13486 ((eq flag nil)
13487 ;; try completion
13488 (setq rtn (try-completion s2 ctable confirm))
13489 (if (stringp rtn)
13490 (setq rtn
13491 (concat s1 s2 (substring rtn (length s2))
13492 (if (and org-add-colon-after-tag-completion
13493 (assoc rtn ctable))
13494 ":" ""))))
13495 rtn)
13496 ((eq flag t)
13497 ;; all-completions
13498 (all-completions s2 ctable confirm)
13499 )
13500 ((eq flag 'lambda)
13501 ;; exact match?
13502 (assoc s2 ctable)))
13503 ))
13505 (defun org-fast-tag-insert (kwd tags face &optional end)
13506 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13507 (insert (format "%-12s" (concat kwd ":"))
13508 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13509 (or end "")))
13511 (defun org-fast-tag-show-exit (flag)
13512 (save-excursion
13513 (org-goto-line 3)
13515 (replace-match ""))
13516 (when flag
13517 (end-of-line 1)
13518 (org-move-to-column (- (window-width) 19) t)
13519 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13521 (defun org-set-current-tags-overlay (current prefix)
13522 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13523 (if (featurep 'xemacs)
13524 (org-overlay-display org-tags-overlay (concat prefix s)
13525 'secondary-selection)
13526 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13527 (org-overlay-display org-tags-overlay (concat prefix s)))))
13529 (defvar org-last-tag-selection-key nil)
13530 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13531 "Fast tag selection with single keys.
13532 CURRENT is the current list of tags in the headline, INHERITED is the
13533 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13534 possibly with grouping information. TODO-TABLE is a similar table with
13535 TODO keywords, should these have keys assigned to them.
13536 If the keys are nil, a-z are automatically assigned.
13537 Returns the new tags string, or nil to not change the current settings."
13538 (let* ((fulltable (append table todo-table))
13539 (maxlen (apply 'max (mapcar
13540 (lambda (x)
13541 (if (stringp (car x)) (string-width (car x)) 0))
13542 fulltable)))
13543 (buf (current-buffer))
13544 (expert (eq org-fast-tag-selection-single-key 'expert))
13545 (buffer-tags nil)
13546 (fwidth (+ maxlen 3 1 3))
13547 (ncol (/ (- (window-width) 4) fwidth))
13548 (i-face 'org-done)
13549 (c-face 'org-todo)
13550 tg cnt e c char c1 c2 ntable tbl rtn
13551 ov-start ov-end ov-prefix
13552 (exit-after-next org-fast-tag-selection-single-key)
13553 (done-keywords org-done-keywords)
13554 groups ingroup)
13555 (save-excursion
13556 (beginning-of-line 1)
13557 (if (looking-at
13559 (setq ov-start (match-beginning 1)
13560 ov-end (match-end 1)
13561 ov-prefix "")
13562 (setq ov-start (1- (point-at-eol))
13563 ov-end (1+ ov-start))
13565 (setq ov-prefix
13566 (concat
13567 (buffer-substring (1- (point)) (point))
13568 (if (> (current-column) org-tags-column)
13569 " "
13570 (make-string (- org-tags-column (current-column)) ?\ ))))))
13571 (move-overlay org-tags-overlay ov-start ov-end)
13572 (save-window-excursion
13573 (if expert
13574 (set-buffer (get-buffer-create " *Org tags*"))
13575 (delete-other-windows)
13576 (split-window-vertically)
13577 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13578 (erase-buffer)
13579 (org-set-local 'org-done-keywords done-keywords)
13582 (org-fast-tag-show-exit exit-after-next)
13583 (org-set-current-tags-overlay current ov-prefix)
13584 (setq tbl fulltable char ?a cnt 0)
13585 (while (setq e (pop tbl))
13586 (cond
13587 ((equal (car e) :startgroup)
13588 (push '() groups) (setq ingroup t)
13589 (when (not (= cnt 0))
13590 (setq cnt 0)
13592 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13593 ((equal (car e) :endgroup)
13594 (setq ingroup nil cnt 0)
13596 ((equal e '(:newline))
13597 (when (not (= cnt 0))
13598 (setq cnt 0)
13600 (setq e (car tbl))
13601 (while (equal (car tbl) '(:newline))
13603 (setq tbl (cdr tbl)))))
13604 (t
13605 (setq tg (copy-sequence (car e)) c2 nil)
13606 (if (cdr e)
13607 (setq c (cdr e))
13608 ;; automatically assign a character.
13609 (setq c1 (string-to-char
13610 (downcase (substring
13611 tg (if (= (string-to-char tg) ?@) 1 0)))))
13612 (if (or (rassoc c1 ntable) (rassoc c1 table))
13613 (while (or (rassoc char ntable) (rassoc char table))
13614 (setq char (1+ char)))
13615 (setq c2 c1))
13616 (setq c (or c2 char)))
13617 (if ingroup (push tg (car groups)))
13618 (setq tg (org-add-props tg nil 'face
13619 (cond
13620 ((not (assoc tg table))
13621 (org-get-todo-face tg))
13622 ((member tg current) c-face)
13623 ((member tg inherited) i-face)
13624 (t nil))))
13625 (if (and (= cnt 0) (not ingroup)) (insert " "))
13626 (insert "[" c "] " tg (make-string
13627 (- fwidth 4 (length tg)) ?\ ))
13628 (push (cons tg c) ntable)
13629 (when (= (setq cnt (1+ cnt)) ncol)
13631 (if ingroup (insert " "))
13632 (setq cnt 0)))))
13633 (setq ntable (nreverse ntable))
13635 (goto-char (point-min))
13636 (if (not expert) (org-fit-window-to-buffer))
13637 (setq rtn
13638 (catch 'exit
13639 (while t
13640 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13641 (if (not groups) "no " "")
13642 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13643 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13644 (setq org-last-tag-selection-key c)
13645 (cond
13647 ((= c ?!)
13648 (setq groups (not groups))
13649 (goto-char (point-min))
13650 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13651 ((= c ?\C-c)
13652 (if (not expert)
13653 (org-fast-tag-show-exit
13654 (setq exit-after-next (not exit-after-next)))
13655 (setq expert nil)
13656 (delete-other-windows)
13657 (set-window-buffer (split-window-vertically) " *Org tags*")
13658 (org-switch-to-buffer-other-window " *Org tags*")
13659 (org-fit-window-to-buffer)))
13660 ((or (= c ?\C-g)
13661 (and (= c ?q) (not (rassoc c ntable))))
13662 (org-detach-overlay org-tags-overlay)
13663 (setq quit-flag t))
13664 ((= c ?\ )
13665 (setq current nil)
13666 (if exit-after-next (setq exit-after-next 'now)))
13668 (condition-case nil
13669 (setq tg (org-icompleting-read
13670 "Tag: "
13671 (or buffer-tags
13672 (with-current-buffer buf
13673 (org-get-buffer-tags)))))
13674 (quit (setq tg "")))
13676 (add-to-list 'buffer-tags (list tg))
13677 (if (member tg current)
13678 (setq current (delete tg current))
13679 (push tg current)))
13680 (if exit-after-next (setq exit-after-next 'now)))
13681 ((setq e (rassoc c todo-table) tg (car e))
13682 (with-current-buffer buf
13683 (save-excursion (org-todo tg)))
13684 (if exit-after-next (setq exit-after-next 'now)))
13685 ((setq e (rassoc c ntable) tg (car e))
13686 (if (member tg current)
13687 (setq current (delete tg current))
13688 (loop for g in groups do
13689 (if (member tg g)
13690 (mapc (lambda (x)
13691 (setq current (delete x current)))
13692 g)))
13693 (push tg current))
13694 (if exit-after-next (setq exit-after-next 'now))))
13696 ;; Create a sorted list
13697 (setq current
13698 (sort current
13699 (lambda (a b)
13700 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13701 (if (eq exit-after-next 'now) (throw 'exit t))
13702 (goto-char (point-min))
13703 (beginning-of-line 2)
13704 (delete-region (point) (point-at-eol))
13705 (org-fast-tag-insert "Current" current c-face)
13706 (org-set-current-tags-overlay current ov-prefix)
13707 (while (re-search-forward
13709 (setq tg (match-string 1))
13710 (add-text-properties
13711 (match-beginning 1) (match-end 1)
13712 (list 'face
13713 (cond
13714 ((member tg current) c-face)
13715 ((member tg inherited) i-face)
13716 (t (get-text-property (match-beginning 1) 'face))))))
13717 (goto-char (point-min)))))
13718 (org-detach-overlay org-tags-overlay)
13719 (if rtn
13720 (mapconcat 'identity current ":")
13721 nil))))
13723 (defun org-get-tags-string ()
13724 "Get the TAGS string in the current headline."
13725 (unless (org-at-heading-p t)
13726 (error "Not on a heading"))
13727 (save-excursion
13728 (beginning-of-line 1)
13730 (org-match-string-no-properties 1)
13731 "")))
13733 (defun org-get-tags ()
13734 "Get the list of tags specified in the current headline."
13735 (org-split-string (org-get-tags-string) ":"))
13737 (defun org-get-buffer-tags ()
13738 "Get a table of all tags used in the buffer, for completion."
13739 (let (tags)
13740 (save-excursion
13741 (goto-char (point-min))
13742 (while (re-search-forward
13744 (when (equal (char-after (point-at-bol 0)) ?*)
13745 (mapc (lambda (x) (add-to-list 'tags x))
13746 (org-split-string (org-match-string-no-properties 1) ":")))))
13747 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13748 (mapcar 'list tags)))
13750 ;;;; The mapping API
13752 ;;;###autoload
13753 (defun org-map-entries (func &optional match scope &rest skip)
13754 "Call FUNC at each headline selected by MATCH in SCOPE.
13756 FUNC is a function or a lisp form. The function will be called without
13757 arguments, with the cursor positioned at the beginning of the headline.
13758 The return values of all calls to the function will be collected and
13759 returned as a list.
13761 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13762 does not need to preserve point. After evaluation, the cursor will be
13763 moved to the end of the line (presumably of the headline of the
13764 processed entry) and search continues from there. Under some
13765 circumstances, this may not produce the wanted results. For example,
13766 if you have removed (e.g. archived) the current (sub)tree it could
13767 mean that the next entry will be skipped entirely. In such cases, you
13768 can specify the position from where search should continue by making
13769 FUNC set the variable `org-map-continue-from' to the desired buffer
13770 position.
13772 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13773 Only headlines that are matched by this query will be considered during
13774 the iteration. When MATCH is nil or t, all headlines will be
13775 visited by the iteration.
13777 SCOPE determines the scope of this command. It can be any of:
13779 nil The current buffer, respecting the restriction if any
13780 tree The subtree started with the entry at point
13781 region The entries within the active region, if any
13782 region-start-level
13783 The entries within the active region, but only those at
13784 the same level than the first one.
13785 file The current buffer, without restriction
13786 file-with-archives
13787 The current buffer, and any archives associated with it
13788 agenda All agenda files
13789 agenda-with-archives
13790 All agenda files with any archive files associated with them
13791 \(file1 file2 ...)
13792 If this is a list, all files in the list will be scanned
13794 The remaining args are treated as settings for the skipping facilities of
13795 the scanner. The following items can be given here:
13797 archive skip trees with the archive tag.
13798 comment skip trees with the COMMENT keyword
13799 function or Emacs Lisp form:
13800 will be used as value for `org-agenda-skip-function', so whenever
13801 the function returns t, FUNC will not be called for that
13802 entry and search will continue from the point where the
13803 function leaves it.
13805 If your function needs to retrieve the tags including inherited tags
13806 at the *current* entry, you can use the value of the variable
13807 `org-scanner-tags' which will be much faster than getting the value
13808 with `org-get-tags-at'. If your function gets properties with
13809 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13810 to t around the call to `org-entry-properties' to get the same speedup.
13811 Note that if your function moves around to retrieve tags and properties at
13812 a *different* entry, you cannot use these techniques."
13813 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13814 (not (org-region-active-p)))
13815 (let* ((org-agenda-archives-mode nil) ; just to make sure
13816 (org-agenda-skip-archived-trees (memq 'archive skip))
13817 (org-agenda-skip-comment-trees (memq 'comment skip))
13818 (org-agenda-skip-function
13819 (car (org-delete-all '(comment archive) skip)))
13820 (org-tags-match-list-sublevels t)
13821 (start-level (eq scope 'region-start-level))
13822 matcher file res
13823 org-todo-keywords-for-agenda
13824 org-done-keywords-for-agenda
13825 org-todo-keyword-alist-for-agenda
13826 org-drawers-for-agenda
13827 org-tag-alist-for-agenda)
13829 (cond
13830 ((eq match t) (setq matcher t))
13831 ((eq match nil) (setq matcher t))
13832 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13834 (save-excursion
13835 (save-restriction
13836 (cond ((eq scope 'tree)
13837 (org-back-to-heading t)
13838 (org-narrow-to-subtree)
13839 (setq scope nil))
13840 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13841 (org-region-active-p))
13842 ;; If needed, set start-level to a string like "2"
13843 (when start-level
13844 (save-excursion
13845 (goto-char (region-beginning))
13846 (unless (org-at-heading-p) (outline-next-heading))
13847 (setq start-level (org-current-level))))
13848 (narrow-to-region (region-beginning)
13849 (save-excursion
13850 (goto-char (region-end))
13851 (unless (and (bolp) (org-at-heading-p))
13852 (outline-next-heading))
13853 (point)))
13854 (setq scope nil)))
13856 (if (not scope)
13857 (progn
13858 (org-prepare-agenda-buffers
13859 (list (buffer-file-name (current-buffer))))
13860 (setq res (org-scan-tags func matcher nil start-level)))
13861 ;; Get the right scope
13862 (cond
13863 ((and scope (listp scope) (symbolp (car scope)))
13864 (setq scope (eval scope)))
13865 ((eq scope 'agenda)
13866 (setq scope (org-agenda-files t)))
13867 ((eq scope 'agenda-with-archives)
13868 (setq scope (org-agenda-files t))
13869 (setq scope (org-add-archive-files scope)))
13870 ((eq scope 'file)
13871 (setq scope (list (buffer-file-name))))
13872 ((eq scope 'file-with-archives)
13873 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13874 (org-prepare-agenda-buffers scope)
13875 (while (setq file (pop scope))
13876 (with-current-buffer (org-find-base-buffer-visiting file)
13877 (save-excursion
13878 (save-restriction
13879 (widen)
13880 (goto-char (point-min))
13881 (setq res (append res (org-scan-tags func matcher))))))))))
13882 res)))
13884 ;;;; Properties
13886 ;;; Setting and retrieving properties
13888 (defconst org-special-properties
13889 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13890 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13891 "The special properties valid in Org-mode.
13893 These are properties that are not defined in the property drawer,
13894 but in some other way.")
13896 (defconst org-default-properties
13897 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13898 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13899 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13900 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13901 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13902 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13903 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13904 "Some properties that are used by Org-mode for various purposes.
13905 Being in this list makes sure that they are offered for completion.")
13908 "Regular expression matching the first line of a property drawer.")
13911 "Regular expression matching the last line of a property drawer.")
13914 "Regular expression matching the first line of a property drawer.")
13917 "Regular expression matching the first line of a property drawer.")
13919 (defconst org-property-drawer-re
13922 "Matches an entire property drawer.")
13924 (defconst org-clock-drawer-re
13927 "Matches an entire clock drawer.")
13929 (defsubst org-re-property (property)
13930 "Return a regexp matching PROPERTY.
13931 Match group 1 will be set to the value "
13934 (defun org-property-action ()
13935 "Do an action on properties."
13936 (interactive)
13937 (let (c)
13938 (org-at-property-p)
13939 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13940 (setq c (read-char-exclusive))
13941 (cond
13942 ((equal c ?s)
13943 (call-interactively 'org-set-property))
13944 ((equal c ?d)
13945 (call-interactively 'org-delete-property))
13946 ((equal c ?D)
13947 (call-interactively 'org-delete-property-globally))
13948 ((equal c ?c)
13949 (call-interactively 'org-compute-property-at-point))
13950 (t (error "No such property action %c" c)))))
13952 (defun org-set-effort (&optional value)
13953 "Set the effort property of the current entry.
13954 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13955 allowed value."
13956 (interactive "P")
13957 (if (equal value 0) (setq value 10))
13958 (let* ((completion-ignore-case t)
13959 (prop org-effort-property)
13960 (cur (org-entry-get nil prop))
13961 (allowed (org-property-get-allowed-values nil prop 'table))
13962 (existing (mapcar 'list (org-property-values prop)))
13963 rpl
13964 (val (cond
13965 ((stringp value) value)
13966 ((and allowed (integerp value))
13967 (or (car (nth (1- value) allowed))
13968 (car (org-last allowed))))
13969 (allowed
13970 (message "Select 1-9,0, [RET%s]: %s"
13971 (if cur (concat "=" cur) "")
13972 (mapconcat 'car allowed " "))
13973 (setq rpl (read-char-exclusive))
13975 cur
13976 (setq rpl (- rpl ?0))
13977 (if (equal rpl 0) (setq rpl 10))
13978 (if (and (> rpl 0) (<= rpl (length allowed)))
13979 (car (nth (1- rpl) allowed))
13980 (org-completing-read "Effort: " allowed nil))))
13981 (t
13982 (let (org-completion-use-ido org-completion-use-iswitchb)
13983 (org-completing-read
13985 (concat "[" cur "]") "")
13986 ": ")
13987 existing nil nil "" nil cur))))))
13988 (unless (equal (org-entry-get nil prop) val)
13989 (org-entry-put nil prop val))
13990 (message "%s is now %s" prop val)))
13992 (defun org-at-property-p ()
13993 "Is cursor inside a property drawer?"
13994 (save-excursion
13995 (beginning-of-line 1)
13997 (save-match-data ;; Used by calling procedures
13998 (let ((p (point))
13999 (range (unless (org-before-first-heading-p)
14000 (org-get-property-block))))
14001 (and range (<= (car range) p) (< p (cdr range))))))))
14003 (defun org-get-property-block (&optional beg end force)
14004 "Return the (beg . end) range of the body of the property drawer.
14005 BEG and END can be beginning and end of subtree, if not given
14006 they will be found.
14007 If the drawer does not exist and FORCE is non-nil, create the drawer."
14008 (catch 'exit
14009 (save-excursion
14010 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14011 (end (or end (progn (outline-next-heading) (point)))))
14012 (goto-char beg)
14013 (if (re-search-forward org-property-start-re end t)
14014 (setq beg (1+ (match-end 0)))
14015 (if force
14016 (save-excursion
14017 (org-insert-property-drawer)
14018 (setq end (progn (outline-next-heading) (point))))
14019 (throw 'exit nil))
14020 (goto-char beg)
14021 (if (re-search-forward org-property-start-re end t)
14022 (setq beg (1+ (match-end 0)))))
14023 (if (re-search-forward org-property-end-re end t)
14024 (setq end (match-beginning 0))
14025 (or force (throw 'exit nil))
14026 (goto-char beg)
14027 (setq end beg)
14028 (org-indent-line-function)
14030 (cons beg end)))))
14032 (defun org-entry-properties (&optional pom which specific)
14033 "Get all properties of the entry at point-or-marker POM.
14034 This includes the TODO keyword, the tags, time strings for deadline,
14035 scheduled, and clocking, and any additional properties defined in the
14036 entry. The return value is an alist, keys may occur multiple times
14037 if the property key was used several times.
14038 POM may also be nil, in which case the current entry is used.
14039 If WHICH is nil or `all', get all properties. If WHICH is
14040 `special' or `standard', only get that subclass. If WHICH
14041 is a string only get exactly this property. SPECIFIC can be a string, the
14042 specific property we are interested in. Specifying it can speed
14043 things up because then unnecessary parsing is avoided."
14044 (setq which (or which 'all))
14045 (org-with-point-at pom
14046 (let ((clockstr (substring org-clock-string 0 -1))
14047 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14048 (case-fold-search nil)
14049 beg end range props sum-props key key1 value string clocksum)
14050 (save-excursion
14051 (when (condition-case nil
14052 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14053 (error nil))
14054 (setq beg (point))
14055 (setq sum-props (get-text-property (point) 'org-summaries))
14056 (setq clocksum (get-text-property (point) :org-clock-minutes))
14057 (outline-next-heading)
14058 (setq end (point))
14059 (when (memq which '(all special))
14060 ;; Get the special properties, like TODO and tags
14061 (goto-char beg)
14062 (when (and (or (not specific) (string= specific "TODO"))
14063 (looking-at org-todo-line-regexp) (match-end 2))
14064 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14065 (when (and (or (not specific) (string= specific "PRIORITY"))
14066 (looking-at org-priority-regexp))
14067 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14068 (when (or (not specific) (string= specific "FILE"))
14069 (push (cons "FILE" buffer-file-name) props))
14070 (when (and (or (not specific) (string= specific "TAGS"))
14071 (setq value (org-get-tags-string))
14073 (push (cons "TAGS" value) props))
14074 (when (and (or (not specific) (string= specific "ALLTAGS"))
14075 (setq value (org-get-tags-at)))
14076 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14077 ":"))
14078 props))
14079 (when (or (not specific) (string= specific "BLOCKED"))
14080 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14081 (when (or (not specific)
14082 (member specific
14083 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14084 "TIMESTAMP" "TIMESTAMP_IA")))
14085 (catch 'match
14086 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14087 (setq key (if (match-end 1)
14088 (substring (org-match-string-no-properties 1)
14089 0 -1))
14090 string (if (equal key clockstr)
14091 (org-no-properties
14092 (org-trim
14093 (buffer-substring
14094 (match-beginning 3) (goto-char
14095 (point-at-eol)))))
14096 (substring (org-match-string-no-properties 3)
14097 1 -1)))
14098 ;; Get the correct property name from the key. This is
14099 ;; necessary if the user has configured time keywords.
14100 (setq key1 (concat key ":"))
14101 (cond
14102 ((not key)
14103 (setq key
14104 (if (= (char-after (match-beginning 3)) ?\[)
14105 "TIMESTAMP_IA" "TIMESTAMP")))
14106 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14107 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14108 ((equal key1 org-closed-string) (setq key "CLOSED"))
14109 ((equal key1 org-clock-string) (setq key "CLOCK")))
14110 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14111 (progn
14112 (push (cons key string) props)
14113 ;; no need to search further if match is found
14114 (throw 'match t))
14115 (when (or (equal key "CLOCK") (not (assoc key props)))
14116 (push (cons key string) props))))))
14117 )
14119 (when (memq which '(all standard))
14120 ;; Get the standard properties, like :PROP: ...
14121 (setq range (org-get-property-block beg end))
14122 (when range
14123 (goto-char (car range))
14124 (while (re-search-forward
14126 (cdr range) t)
14127 (setq key (org-match-string-no-properties 1)
14128 value (org-trim (or (org-match-string-no-properties 2) "")))
14129 (unless (member key excluded)
14130 (push (cons key (or value "")) props)))))
14131 (if clocksum
14132 (push (cons "CLOCKSUM"
14133 (org-columns-number-to-string (/ (float clocksum) 60.)
14134 'add_times))
14135 props))
14136 (unless (assoc "CATEGORY" props)
14137 (push (cons "CATEGORY" (org-get-category)) props))
14138 (append sum-props (nreverse props)))))))
14140 (defun org-entry-get (pom property &optional inherit literal-nil)
14141 "Get value of PROPERTY for entry at point-or-marker POM.
14142 If INHERIT is non-nil and the entry does not have the property,
14143 then also check higher levels of the hierarchy.
14144 If INHERIT is the symbol `selective', use inheritance only if the setting
14145 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14146 If the property is present but empty, the return value is the empty string.
14147 If the property is not present at all, nil is returned.
14150 do not interpret it as the list atom nil. This is used for inheritance
14152 (org-with-point-at pom
14153 (if (and inherit (if (eq inherit 'selective)
14154 (org-property-inherit-p property)
14155 t))
14156 (org-entry-get-with-inheritance property literal-nil)
14157 (if (member property org-special-properties)
14158 ;; We need a special property. Use `org-entry-properties' to
14159 ;; retrieve it, but specify the wanted property
14160 (cdr (assoc property (org-entry-properties nil 'special property)))
14161 (let ((range (unless (org-before-first-heading-p)
14162 (org-get-property-block)))
14163 (props (list (or (assoc property org-file-properties)
14164 (assoc property org-global-properties)
14165 (assoc property org-global-properties-fixed))))
14166 val)
14167 (flet ((ap (key)
14168 (when (re-search-forward
14169 (org-re-property key) (cdr range) t)
14170 (setq props
14171 (org-update-property-plist
14172 key
14173 (if (match-end 1)
14174 (org-match-string-no-properties 1) "")
14175 props)))))
14176 (when (and range (goto-char (car range)))
14177 (ap property)
14178 (goto-char (car range))
14179 (while (ap (concat property "+")))
14180 (setq val (cdr (assoc property props)))
14181 (when val (if literal-nil val (org-not-nil val))))))))))
14183 (defun org-property-or-variable-value (var &optional inherit)
14184 "Check if there is a property fixing the value of VAR.
14185 If yes, return this value. If not, return the current value of the variable."
14186 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14188 (read prop)
14189 (symbol-value var))))
14191 (defun org-entry-delete (pom property)
14192 "Delete the property PROPERTY from entry at point-or-marker POM."
14193 (org-with-point-at pom
14194 (if (member property org-special-properties)
14195 nil ; cannot delete these properties.
14196 (let ((range (org-get-property-block)))
14197 (if (and range
14198 (goto-char (car range))
14199 (re-search-forward
14200 (org-re-property property)
14201 (cdr range) t))
14202 (progn
14203 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14204 t)
14205 nil)))))
14207 ;; Multi-values properties are properties that contain multiple values
14208 ;; These values are assumed to be single words, separated by whitespace.
14209 (defun org-entry-add-to-multivalued-property (pom property value)
14210 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14211 (let* ((old (org-entry-get pom property))
14213 (setq value (org-entry-protect-space value))
14214 (unless (member value values)
14215 (setq values (cons value values))
14216 (org-entry-put pom property
14217 (mapconcat 'identity values " ")))))
14219 (defun org-entry-remove-from-multivalued-property (pom property value)
14220 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14221 (let* ((old (org-entry-get pom property))
14223 (setq value (org-entry-protect-space value))
14224 (when (member value values)
14225 (setq values (delete value values))
14226 (org-entry-put pom property
14227 (mapconcat 'identity values " ")))))
14229 (defun org-entry-member-in-multivalued-property (pom property value)
14230 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14231 (let* ((old (org-entry-get pom property))
14233 (setq value (org-entry-protect-space value))
14234 (member value values)))
14236 (defun org-entry-get-multivalued-property (pom property)
14237 "Return a list of values in a multivalued property."
14238 (let* ((value (org-entry-get pom property))
14240 (mapcar 'org-entry-restore-space values)))
14242 (defun org-entry-put-multivalued-property (pom property &rest values)
14243 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14244 VALUES should be a list of strings. Spaces will be protected."
14245 (org-entry-put pom property
14246 (mapconcat 'org-entry-protect-space values " "))
14247 (let* ((value (org-entry-get pom property))
14249 (mapcar 'org-entry-restore-space values)))
14251 (defun org-entry-protect-space (s)
14252 "Protect spaces and newline in string S."
14253 (while (string-match " " s)
14254 (setq s (replace-match "%20" t t s)))
14256 (setq s (replace-match "%0A" t t s)))
14257 s)
14259 (defun org-entry-restore-space (s)
14260 "Restore spaces and newline in string S."
14261 (while (string-match "%20" s)
14262 (setq s (replace-match " " t t s)))
14263 (while (string-match "%0A" s)
14265 s)
14267 (defvar org-entry-property-inherited-from (make-marker)
14268 "Marker pointing to the entry from where a property was inherited.
14269 Each call to `org-entry-get-with-inheritance' will set this marker to the
14270 location of the entry where the inheritance search matched. If there was
14271 no match, the marker will point nowhere.
14272 Note that also `org-entry-get' calls this function, if the INHERIT flag
14273 is set.")
14275 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14276 "Get entry property, and search higher levels if not present.
14277 The search will stop at the first ancestor which has the property defined.
14279 should be considered as undefined (this is the meaning of nil here).
14281 (move-marker org-entry-property-inherited-from nil)
14282 (let (tmp)
14283 (unless (org-before-first-heading-p)
14284 (save-excursion
14285 (save-restriction
14286 (widen)
14287 (catch 'ex
14288 (while t
14289 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14290 (org-back-to-heading t)
14291 (move-marker org-entry-property-inherited-from (point))
14292 (throw 'ex tmp))
14293 (or (org-up-heading-safe) (throw 'ex nil)))))))
14294 (setq tmp (or tmp
14295 (cdr (assoc property org-file-properties))
14296 (cdr (assoc property org-global-properties))
14297 (cdr (assoc property org-global-properties-fixed))))
14298 (if literal-nil tmp (org-not-nil tmp))))
14300 (defvar org-property-changed-functions nil
14301 "Hook called when the value of a property has changed.
14302 Each hook function should accept two arguments, the name of the property
14303 and the new value.")
14305 (defun org-entry-put (pom property value)
14306 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14307 (org-with-point-at pom
14308 (org-back-to-heading t)
14309 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14310 range)
14311 (cond
14312 ((equal property "TODO")
14314 (not (member value org-todo-keywords-1)))
14316 (if (or (not value)
14318 (setq value 'none))
14319 (org-todo value)
14320 (org-set-tags nil 'align))
14321 ((equal property "PRIORITY")
14323 (string-to-char value) ?\ ))
14324 (org-set-tags nil 'align))
14325 ((equal property "SCHEDULED")
14326 (if (re-search-forward org-scheduled-time-regexp end t)
14327 (cond
14328 ((eq value 'earlier) (org-timestamp-change -1 'day))
14329 ((eq value 'later) (org-timestamp-change 1 'day))
14330 (t (call-interactively 'org-schedule)))
14331 (call-interactively 'org-schedule)))
14332 ((equal property "DEADLINE")
14333 (if (re-search-forward org-deadline-time-regexp end t)
14334 (cond
14335 ((eq value 'earlier) (org-timestamp-change -1 'day))
14336 ((eq value 'later) (org-timestamp-change 1 'day))
14337 (t (call-interactively 'org-deadline)))
14338 (call-interactively 'org-deadline)))
14339 ((member property org-special-properties)
14340 (error "The %s property can not yet be set with `org-entry-put'"
14341 property))
14342 (t ; a non-special property
14343 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14344 (setq range (org-get-property-block beg end 'force))
14345 (goto-char (car range))
14346 (if (re-search-forward
14347 (org-re-property property) (cdr range) t)
14348 (progn
14349 (delete-region (match-beginning 0) (match-end 0))
14350 (goto-char (match-beginning 0)))
14351 (goto-char (cdr range))
14353 (backward-char 1)
14354 (org-indent-line-function))
14355 (insert ":" property ":")
14356 (and value (insert " " value))
14357 (org-indent-line-function)))))
14358 (run-hook-with-args 'org-property-changed-functions property value)))
14360 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14361 "Get all property keys in the current buffer.
14362 With INCLUDE-SPECIALS, also list the special properties that reflect things
14363 like tags and TODO state.
14364 With INCLUDE-DEFAULTS, also include properties that has special meaning
14365 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14366 and others.
14367 With INCLUDE-COLUMNS, also include property names given in COLUMN
14368 formats in the current buffer."
14369 (let (rtn range cfmt s p)
14370 (save-excursion
14371 (save-restriction
14372 (widen)
14373 (goto-char (point-min))
14374 (while (re-search-forward org-property-start-re nil t)
14375 (setq range (org-get-property-block))
14376 (goto-char (car range))
14377 (while (re-search-forward
14379 (cdr range) t)
14380 (add-to-list 'rtn (org-match-string-no-properties 1)))
14381 (outline-next-heading))))
14383 (when include-specials
14384 (setq rtn (append org-special-properties rtn)))
14386 (when include-defaults
14387 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14388 (add-to-list 'rtn org-effort-property))
14390 (when include-columns
14391 (save-excursion
14392 (save-restriction
14393 (widen)
14394 (goto-char (point-min))
14395 (while (re-search-forward
14397 nil t)
14398 (setq cfmt (match-string 2) s 0)
14400 cfmt s)
14401 (setq s (match-end 0)
14402 p (match-string 1 cfmt))
14403 (unless (or (equal p "ITEM")
14404 (member p org-special-properties))
14405 (add-to-list 'rtn (match-string 1 cfmt))))))))
14407 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14409 (defun org-property-values (key)
14410 "Return a list of all values of property KEY in the current buffer."
14411 (save-excursion
14412 (save-restriction
14413 (widen)
14414 (goto-char (point-min))
14415 (let ((re (org-re-property key))
14416 values)
14417 (while (re-search-forward re nil t)
14418 (add-to-list 'values (org-trim (match-string 1))))
14419 (delete "" values)))))
14421 (defun org-insert-property-drawer ()
14422 "Insert a property drawer into the current entry."
14423 (interactive)
14424 (org-back-to-heading t)
14425 (looking-at org-outline-regexp)
14426 (let ((indent (if org-adapt-indentation
14427 (- (match-end 0)(match-beginning 0))
14428 0))
14429 (beg (point))
14431 end hiddenp)
14432 (outline-next-heading)
14433 (setq end (point))
14434 (goto-char beg)
14435 (while (re-search-forward re end t))
14436 (setq hiddenp (outline-invisible-p))
14437 (end-of-line 1)
14440 (if (member (match-string 1) '("CLOCK:" ":END:"))
14441 ;; just skip this line
14442 (beginning-of-line 2)
14443 ;; Drawer start, find the end
14445 (beginning-of-line 1)))
14446 (org-skip-over-state-notes)
14448 (if (eq (char-before) ?*) (forward-char 1))
14450 (beginning-of-line 0)
14451 (org-indent-to-column indent)
14452 (beginning-of-line 2)
14453 (org-indent-to-column indent)
14454 (beginning-of-line 0)
14455 (if hiddenp
14456 (save-excursion
14457 (org-back-to-heading t)
14458 (hide-entry))
14459 (org-flag-drawer t))))
14461 (defvar org-property-set-functions-alist nil
14462 "Property set function alist.
14463 Each entry should have the following format:
14465 (PROPERTY . READ-FUNCTION)
14467 The read function will be called with the same argument as
14468 `org-completing-read'.")
14470 (defun org-set-property-function (property)
14471 "Get the function that should be used to set PROPERTY.
14472 This is computed according to `org-property-set-functions-alist'."
14473 (or (cdr (assoc property org-property-set-functions-alist))
14474 'org-completing-read))
14476 (defun org-read-property-value (property)
14477 "Read PROPERTY value from user."
14478 (let* ((completion-ignore-case t)
14479 (allowed (org-property-get-allowed-values nil property 'table))
14480 (cur (org-entry-get nil property))
14481 (prompt (concat property " value"
14483 (concat " [" cur "]") "") ": "))
14484 (set-function (org-set-property-function property))
14485 (val (if allowed
14486 (funcall set-function prompt allowed nil
14487 (not (get-text-property 0 'org-unrestricted
14488 (caar allowed))))
14489 (let (org-completion-use-ido org-completion-use-iswitchb)
14490 (funcall set-function prompt
14491 (mapcar 'list (org-property-values property))
14492 nil nil "" nil cur)))))
14493 (if (equal val "")
14494 cur
14495 val)))
14497 (defvar org-last-set-property nil)
14498 (defun org-read-property-name ()
14499 "Read a property name."
14500 (let* ((completion-ignore-case t)
14501 (keys (org-buffer-property-keys nil t t))
14502 (default-prop (or (save-excursion
14503 (save-match-data
14504 (beginning-of-line)
14506 (null (string= (match-string 1) "END"))
14507 (match-string 1))))
14508 org-last-set-property))
14509 (property (org-icompleting-read
14510 (concat "Property"
14511 (if default-prop (concat " [" default-prop "]") "")
14512 ": ")
14513 (mapcar 'list keys)
14514 nil nil nil nil
14515 default-prop
14516 )))
14517 (if (member property keys)
14518 property
14519 (or (cdr (assoc (downcase property)
14520 (mapcar (lambda (x) (cons (downcase x) x))
14521 keys)))
14522 property))))
14524 (defun org-set-property (property value)
14525 "In the current entry, set PROPERTY to VALUE.
14526 When called interactively, this will prompt for a property name, offering
14527 completion on existing and default properties. And then it will prompt
14528 for a value, offering completion either on allowed values (via an inherited
14529 xxx_ALL property) or on existing values in other instances of this property
14530 in the current file."
14531 (interactive (list nil nil))
14532 (let* ((property (or property (org-read-property-name)))
14533 (value (or value (org-read-property-value property)))
14534 (fn (assoc property org-properties-postprocess-alist)))
14535 (setq org-last-set-property property)
14536 ;; Possibly postprocess the inserted value:
14537 (when fn (setq value (funcall (cadr fn) value)))
14538 (unless (equal (org-entry-get nil property) value)
14539 (org-entry-put nil property value))))
14541 (defun org-delete-property (property)
14542 "In the current entry, delete PROPERTY."
14543 (interactive
14544 (let* ((completion-ignore-case t)
14545 (prop (org-icompleting-read "Property: "
14546 (org-entry-properties nil 'standard))))
14547 (list prop)))
14548 (message "Property %s %s" property
14549 (if (org-entry-delete nil property)
14550 "deleted"
14551 "was not present in the entry")))
14553 (defun org-delete-property-globally (property)
14554 "Remove PROPERTY globally, from all entries."
14555 (interactive
14556 (let* ((completion-ignore-case t)
14557 (prop (org-icompleting-read
14558 "Globally remove property: "
14559 (mapcar 'list (org-buffer-property-keys)))))
14560 (list prop)))
14561 (save-excursion
14562 (save-restriction
14563 (widen)
14564 (goto-char (point-min))
14565 (let ((cnt 0))
14566 (while (re-search-forward
14567 (org-re-property property)
14568 nil t)
14569 (setq cnt (1+ cnt))
14570 (replace-match ""))
14573 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14575 (defun org-compute-property-at-point ()
14576 "Compute the property at point.
14577 This looks for an enclosing column format, extracts the operator and
14578 then applies it to the property in the column format's scope."
14579 (interactive)
14580 (unless (org-at-property-p)
14581 (error "Not at a property"))
14582 (let ((prop (org-match-string-no-properties 2)))
14583 (org-columns-get-format-and-top-level)
14584 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14585 (error "No operator defined for property %s" prop))
14586 (org-columns-compute prop)))
14588 (defvar org-property-allowed-value-functions nil
14589 "Hook for functions supplying allowed values for a specific property.
14590 The functions must take a single argument, the name of the property, and
14592 the values, this means that these values are intended as defaults for
14593 completion, but that other values should be allowed too.
14594 The functions must return nil if they are not responsible for this
14595 property.")
14597 (defun org-property-get-allowed-values (pom property &optional table)
14598 "Get allowed values for the property PROPERTY.
14599 When TABLE is non-nil, return an alist that can directly be used for
14600 completion."
14601 (let (vals)
14602 (cond
14603 ((equal property "TODO")
14604 (setq vals (org-with-point-at pom
14605 (append org-todo-keywords-1 '("")))))
14606 ((equal property "PRIORITY")
14607 (let ((n org-lowest-priority))
14608 (while (>= n org-highest-priority)
14609 (push (char-to-string n) vals)
14610 (setq n (1- n)))))
14611 ((member property org-special-properties))
14612 ((setq vals (run-hook-with-args-until-success
14613 'org-property-allowed-value-functions property)))
14614 (t
14615 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14617 (setq vals (car (read-from-string (concat "(" vals ")"))))
14618 (setq vals (mapcar (lambda (x)
14619 (cond ((stringp x) x)
14620 ((numberp x) (number-to-string x))
14621 ((symbolp x) (symbol-name x))
14622 (t "???")))
14623 vals)))))
14624 (when (member ":ETC" vals)
14625 (setq vals (remove ":ETC" vals))
14626 (org-add-props (car vals) '(org-unrestricted t)))
14627 (if table (mapcar 'list vals) vals)))
14629 (defun org-property-previous-allowed-value (&optional previous)
14630 "Switch to the next allowed value for this property."
14631 (interactive)
14632 (org-property-next-allowed-value t))
14634 (defun org-property-next-allowed-value (&optional previous)
14635 "Switch to the next allowed value for this property."
14636 (interactive)
14637 (unless (org-at-property-p)
14638 (error "Not at a property"))
14639 (let* ((key (match-string 2))
14640 (value (match-string 3))
14641 (allowed (or (org-property-get-allowed-values (point) key)
14642 (and (member value '("[ ]" "[-]" "[X]"))
14643 '("[ ]" "[X]"))))
14644 nval)
14645 (unless allowed
14646 (error "Allowed values for this property have not been defined"))
14647 (if previous (setq allowed (reverse allowed)))
14648 (if (member value allowed)
14649 (setq nval (car (cdr (member value allowed)))))
14650 (setq nval (or nval (car allowed)))
14651 (if (equal nval value)
14652 (error "Only one allowed value for this property"))
14653 (org-at-property-p)
14654 (replace-match (concat " :" key ": " nval) t t)
14655 (org-indent-line-function)
14656 (beginning-of-line 1)
14658 (run-hook-with-args 'org-property-changed-functions key nval)))
14660 (defun org-find-olp (path &optional this-buffer)
14661 "Return a marker pointing to the entry at outline path OLP.
14662 If anything goes wrong, throw an error.
14663 You can wrap this call to catch the error like this:
14665 (condition-case msg
14666 (org-mobile-locate-entry (match-string 4))
14667 (error (nth 1 msg)))
14669 The return value will then be either a string with the error message,
14670 or a marker if everything is OK.
14672 If THIS-BUFFER is set, the outline path does not contain a file,
14673 only headings."
14674 (let* ((file (if this-buffer buffer-file-name (pop path)))
14675 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14676 (level 1)
14677 (lmin 1)
14678 (lmax 1)
14679 limit re end found pos heading cnt flevel)
14680 (unless buffer (error "File not found :%s" file))
14681 (with-current-buffer buffer
14682 (save-excursion
14683 (save-restriction
14684 (widen)
14685 (setq limit (point-max))
14686 (goto-char (point-min))
14687 (while (setq heading (pop path))
14688 (setq re (format org-complex-heading-regexp-format
14689 (regexp-quote heading)))
14690 (setq cnt 0 pos (point))
14691 (while (re-search-forward re end t)
14692 (setq level (- (match-end 1) (match-beginning 1)))
14693 (if (and (>= level lmin) (<= level lmax))
14694 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14695 (when (= cnt 0) (error "Heading not found on level %d: %s"
14696 lmax heading))
14697 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14698 lmax heading))
14699 (goto-char found)
14700 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14701 (setq end (save-excursion (org-end-of-subtree t t))))
14702 (when (org-at-heading-p)
14703 (move-marker (make-marker) (point))))))))
14705 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14706 "Find node HEADING in BUFFER.
14707 Return a marker to the heading if it was found, or nil if not.
14708 If POS-ONLY is set, return just the position instead of a marker.
14710 The heading text must match exact, but it may have a TODO keyword,
14711 a priority cookie and tags in the standard locations."
14712 (with-current-buffer (or buffer (current-buffer))
14713 (save-excursion
14714 (save-restriction
14715 (widen)
14716 (goto-char (point-min))
14717 (let (case-fold-search)
14718 (if (re-search-forward
14719 (format org-complex-heading-regexp-format
14720 (regexp-quote heading)) nil t)
14721 (if pos-only
14722 (match-beginning 0)
14723 (move-marker (make-marker) (match-beginning 0)))))))))
14725 (defun org-find-exact-heading-in-directory (heading &optional dir)
14726 "Find Org node headline HEADING in all .org files in directory DIR.
14727 When the target headline is found, return a marker to this location."
14728 (let ((files (directory-files (or dir default-directory)
14730 file visiting m buffer)
14731 (catch 'found
14732 (while (setq file (pop files))
14733 (message "trying %s" file)
14734 (setq visiting (org-find-base-buffer-visiting file))
14735 (setq buffer (or visiting (find-file-noselect file)))
14736 (setq m (org-find-exact-headline-in-buffer
14737 heading buffer))
14738 (when (and (not m) (not visiting)) (kill-buffer buffer))
14739 (and m (throw 'found m))))))
14741 (defun org-find-entry-with-id (ident)
14742 "Locate the entry that contains the ID property with exact value IDENT.
14743 IDENT can be a string, a symbol or a number, this function will search for
14744 the string representation of it.
14745 Return the position where this entry starts, or nil if there is no such entry."
14746 (interactive "sID: ")
14747 (let ((id (cond
14748 ((stringp ident) ident)
14749 ((symbol-name ident) (symbol-name ident))
14750 ((numberp ident) (number-to-string ident))
14751 (t (error "IDENT %s must be a string, symbol or number" ident))))
14752 (case-fold-search nil))
14753 (save-excursion
14754 (save-restriction
14755 (widen)
14756 (goto-char (point-min))
14757 (when (re-search-forward
14759 nil t)
14760 (org-back-to-heading t)
14761 (point))))))
14763 ;;;; Timestamps
14765 (defvar org-last-changed-timestamp nil)
14766 (defvar org-last-inserted-timestamp nil
14767 "The last time stamp inserted with `org-insert-time-stamp'.")
14768 (defvar org-time-was-given) ; dynamically scoped parameter
14769 (defvar org-end-time-was-given) ; dynamically scoped parameter
14770 (defvar org-ts-what) ; dynamically scoped parameter
14772 (defun org-time-stamp (arg &optional inactive)
14773 "Prompt for a date/time and insert a time stamp.
14774 If the user specifies a time like HH:MM, or if this command is called
14775 with a prefix argument, the time stamp will contain date and time.
14776 Otherwise, only the date will be included. All parts of a date not
14777 specified by the user will be filled in from the current date/time.
14778 So if you press just return without typing anything, the time stamp
14779 will represent the current date/time. If there is already a timestamp
14780 at the cursor, it will be modified."
14781 (interactive "P")
14782 (let* ((ts nil)
14783 (default-time
14784 ;; Default time is either today, or, when entering a range,
14785 ;; the range start.
14786 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14787 (save-excursion
14788 (re-search-backward
14790 (- (point) 20) t)))
14791 (apply 'encode-time (org-parse-time-string (match-string 1)))
14792 (current-time)))
14793 (default-input (and ts (org-get-compact-tod ts)))
14794 (repeater (save-excursion
14795 (save-match-data
14796 (beginning-of-line)
14797 (when (re-search-forward
14799 (save-excursion (progn (end-of-line) (point))) t)
14800 (match-string 0)))))
14801 org-time-was-given org-end-time-was-given time)
14802 (cond
14803 ((and (org-at-timestamp-p t)
14804 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14805 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14806 (insert "--")
14807 (setq time (let ((this-command this-command))
14808 (org-read-date arg 'totime nil nil
14809 default-time default-input)))
14810 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14811 ((org-at-timestamp-p t)
14812 (setq time (let ((this-command this-command))
14813 (org-read-date arg 'totime nil nil default-time default-input)))
14814 (when (org-at-timestamp-p t) ; just to get the match data
14815 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14816 (replace-match "")
14817 (setq org-last-changed-timestamp
14818 (org-insert-time-stamp
14819 time (or org-time-was-given arg)
14820 inactive nil nil (list org-end-time-was-given)))
14821 (when repeater (goto-char (1- (point))) (insert " " repeater)
14822 (setq org-last-changed-timestamp
14823 (concat (substring org-last-inserted-timestamp 0 -1)
14824 " " repeater ">"))))
14825 (message "Timestamp updated"))
14826 (t
14827 (setq time (let ((this-command this-command))
14828 (org-read-date arg 'totime nil nil default-time default-input)))
14829 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14830 nil nil (list org-end-time-was-given))))))
14832 ;; FIXME: can we use this for something else, like computing time differences?
14833 (defun org-get-compact-tod (s)
14834 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14835 (let* ((t1 (match-string 1 s))
14836 (h1 (string-to-number (match-string 2 s)))
14837 (m1 (string-to-number (match-string 3 s)))
14838 (t2 (and (match-end 4) (match-string 5 s)))
14839 (h2 (and t2 (string-to-number (match-string 6 s))))
14840 (m2 (and t2 (string-to-number (match-string 7 s))))
14841 dh dm)
14842 (if (not t2)
14843 t1
14844 (setq dh (- h2 h1) dm (- m2 m1))
14845 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14846 (concat t1 "+" (number-to-string dh)
14847 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14849 (defun org-time-stamp-inactive (&optional arg)
14850 "Insert an inactive time stamp.
14851 An inactive time stamp is enclosed in square brackets instead of angle
14852 brackets. It is inactive in the sense that it does not trigger agenda entries,
14853 does not link to the calendar and cannot be changed with the S-cursor keys.
14854 So these are more for recording a certain time/date."
14855 (interactive "P")
14856 (org-time-stamp arg 'inactive))
14858 (defvar org-date-ovl (make-overlay 1 1))
14859 (overlay-put org-date-ovl 'face 'org-warning)
14860 (org-detach-overlay org-date-ovl)
14862 (defvar org-ans1) ; dynamically scoped parameter
14863 (defvar org-ans2) ; dynamically scoped parameter
14865 (defvar org-plain-time-of-day-regexp) ; defined below
14867 (defvar org-overriding-default-time nil) ; dynamically scoped
14868 (defvar org-read-date-overlay nil)
14869 (defvar org-dcst nil) ; dynamically scoped
14870 (defvar org-read-date-history nil)
14871 (defvar org-read-date-final-answer nil)
14872 (defvar org-read-date-analyze-futurep nil)
14873 (defvar org-read-date-analyze-forced-year nil)
14875 (defun org-read-date (&optional with-time to-time from-string prompt
14876 default-time default-input)
14877 "Read a date, possibly a time, and make things smooth for the user.
14878 The prompt will suggest to enter an ISO date, but you can also enter anything
14879 which will at least partially be understood by `parse-time-string'.
14880 Unrecognized parts of the date will default to the current day, month, year,
14881 hour and minute. If this command is called to replace a timestamp at point,
14882 or to enter the second timestamp of a range, the default time is taken
14883 from the existing stamp. Furthermore, the command prefers the future,
14884 so if you are giving a date where the year is not given, and the day-month
14885 combination is already past in the current year, it will assume you
14886 mean next year. For details, see the manual. A few examples:
14888 3-2-5 --> 2003-02-05
14889 feb 15 --> currentyear-02-15
14890 2/15 --> currentyear-02-15
14891 sep 12 9 --> 2009-09-12
14892 12:45 --> today 12:45
14893 22 sept 0:34 --> currentyear-09-22 0:34
14894 12 --> currentyear-currentmonth-12
14895 Fri --> nearest Friday (today or later)
14896 etc.
14898 Furthermore you can specify a relative date by giving, as the *first* thing
14899 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14900 change in days weeks, months, years.
14901 With a single plus or minus, the date is relative to today. With a double
14902 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14903 +4d --> four days from today
14904 +4 --> same as above
14905 +2w --> two weeks from today
14906 ++5 --> five days from default date
14908 The function understands only English month and weekday abbreviations,
14909 but this can be configured with the variables `parse-time-months' and
14910 `parse-time-weekdays'.
14912 While prompting, a calendar is popped up - you can also select the
14913 date with the mouse (button 1). The calendar shows a period of three
14914 months. To scroll it to other months, use the keys `>' and `<'.
14915 If you don't like the calendar, turn it off with
14916 \(setq org-read-date-popup-calendar nil)
14918 With optional argument TO-TIME, the date will immediately be converted
14919 to an internal time.
14920 With an optional argument WITH-TIME, the prompt will suggest to also
14921 insert a time. Note that when WITH-TIME is not set, you can still
14922 enter a time, and this function will inform the calling routine about
14923 this change. The calling routine may then choose to change the format
14924 used to insert the time stamp into the buffer to include the time.
14925 With optional argument FROM-STRING, read from this string instead from
14926 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14927 the time/date that is used for everything that is not specified by the
14928 user."
14929 (require 'parse-time)
14930 (let* ((org-time-stamp-rounding-minutes
14931 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14932 (org-dcst org-display-custom-times)
14933 (ct (org-current-time))
14934 (def (or org-overriding-default-time default-time ct))
14935 (defdecode (decode-time def))
14936 (dummy (progn
14937 (when (< (nth 2 defdecode) org-extend-today-until)
14938 (setcar (nthcdr 2 defdecode) -1)
14939 (setcar (nthcdr 1 defdecode) 59)
14940 (setq def (apply 'encode-time defdecode)
14941 defdecode (decode-time def)))))
14942 (calendar-frame-setup nil)
14943 (calendar-setup nil)
14944 (calendar-move-hook nil)
14945 (calendar-view-diary-initially-flag nil)
14946 (calendar-view-holidays-initially-flag nil)
14947 (timestr (format-time-string
14948 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14949 (prompt (concat (if prompt (concat prompt " ") "")
14950 (format "Date+time [%s]: " timestr)))
14951 ans (org-ans0 "") org-ans1 org-ans2 final)
14953 (cond
14954 (from-string (setq ans from-string))
14955 (org-read-date-popup-calendar
14956 (save-excursion
14957 (save-window-excursion
14958 (calendar)
14959 (unwind-protect
14960 (progn
14961 (calendar-forward-day (- (time-to-days def)
14962 (calendar-absolute-from-gregorian
14963 (calendar-current-date))))
14964 (org-eval-in-calendar nil t)
14965 (let* ((old-map (current-local-map))
14966 (map (copy-keymap calendar-mode-map))
14967 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14968 (org-defkey map (kbd "RET") 'org-calendar-select)
14969 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14970 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14971 (org-defkey minibuffer-local-map [(meta shift left)]
14972 (lambda () (interactive)
14973 (org-eval-in-calendar '(calendar-backward-month 1))))
14974 (org-defkey minibuffer-local-map [(meta shift right)]
14975 (lambda () (interactive)
14976 (org-eval-in-calendar '(calendar-forward-month 1))))
14977 (org-defkey minibuffer-local-map [(meta shift up)]
14978 (lambda () (interactive)
14979 (org-eval-in-calendar '(calendar-backward-year 1))))
14980 (org-defkey minibuffer-local-map [(meta shift down)]
14981 (lambda () (interactive)
14982 (org-eval-in-calendar '(calendar-forward-year 1))))
14983 (org-defkey minibuffer-local-map [?\e (shift left)]
14984 (lambda () (interactive)
14985 (org-eval-in-calendar '(calendar-backward-month 1))))
14986 (org-defkey minibuffer-local-map [?\e (shift right)]
14987 (lambda () (interactive)
14988 (org-eval-in-calendar '(calendar-forward-month 1))))
14989 (org-defkey minibuffer-local-map [?\e (shift up)]
14990 (lambda () (interactive)
14991 (org-eval-in-calendar '(calendar-backward-year 1))))
14992 (org-defkey minibuffer-local-map [?\e (shift down)]
14993 (lambda () (interactive)
14994 (org-eval-in-calendar '(calendar-forward-year 1))))
14995 (org-defkey minibuffer-local-map [(shift up)]
14996 (lambda () (interactive)
14997 (org-eval-in-calendar '(calendar-backward-week 1))))
14998 (org-defkey minibuffer-local-map [(shift down)]
14999 (lambda () (interactive)
15000 (org-eval-in-calendar '(calendar-forward-week 1))))
15001 (org-defkey minibuffer-local-map [(shift left)]
15002 (lambda () (interactive)
15003 (org-eval-in-calendar '(calendar-backward-day 1))))
15004 (org-defkey minibuffer-local-map [(shift right)]
15005 (lambda () (interactive)
15006 (org-eval-in-calendar '(calendar-forward-day 1))))
15007 (org-defkey minibuffer-local-map ">"
15008 (lambda () (interactive)
15009 (org-eval-in-calendar '(scroll-calendar-left 1))))
15010 (org-defkey minibuffer-local-map "<"
15011 (lambda () (interactive)
15012 (org-eval-in-calendar '(scroll-calendar-right 1))))
15013 (org-defkey minibuffer-local-map "\C-v"
15014 (lambda () (interactive)
15015 (org-eval-in-calendar
15016 '(calendar-scroll-left-three-months 1))))
15017 (org-defkey minibuffer-local-map "\M-v"
15018 (lambda () (interactive)
15019 (org-eval-in-calendar
15020 '(calendar-scroll-right-three-months 1))))
15021 (run-hooks 'org-read-date-minibuffer-setup-hook)
15022 (unwind-protect
15023 (progn
15024 (use-local-map map)
15025 (add-hook 'post-command-hook 'org-read-date-display)
15026 (setq org-ans0 (read-string prompt default-input
15027 'org-read-date-history nil))
15028 ;; org-ans0: from prompt
15029 ;; org-ans1: from mouse click
15030 ;; org-ans2: from calendar motion
15031 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15032 (remove-hook 'post-command-hook 'org-read-date-display)
15033 (use-local-map old-map)
15034 (when org-read-date-overlay
15035 (delete-overlay org-read-date-overlay)
15036 (setq org-read-date-overlay nil)))))
15037 (bury-buffer "*Calendar*")))))
15039 (t ; Naked prompt only
15040 (unwind-protect
15041 (setq ans (read-string prompt default-input
15042 'org-read-date-history timestr))
15043 (when org-read-date-overlay
15044 (delete-overlay org-read-date-overlay)
15045 (setq org-read-date-overlay nil)))))
15047 (setq final (org-read-date-analyze ans def defdecode))
15049 (when org-read-date-analyze-forced-year
15050 (message "Year was forced into %s"
15051 (if org-read-date-force-compatible-dates
15052 "compatible range (1970-2037)"
15053 "range representable on this machine"))
15054 (ding))
15056 ;; One round trip to get rid of 34th of August and stuff like that....
15057 (setq final (decode-time (apply 'encode-time final)))
15059 (setq org-read-date-final-answer ans)
15061 (if to-time
15062 (apply 'encode-time final)
15063 (if (and (boundp 'org-time-was-given) org-time-was-given)
15064 (format "%04d-%02d-%02d %02d:%02d"
15065 (nth 5 final) (nth 4 final) (nth 3 final)
15066 (nth 2 final) (nth 1 final))
15067 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15069 (defvar def)
15070 (defvar defdecode)
15071 (defvar with-time)
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 (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15096 (when (and org-end-time-was-given
15097 (string-match org-plain-time-of-day-regexp txt))
15098 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15099 org-end-time-was-given
15100 (substring txt (match-end 0)))))
15101 (when org-read-date-analyze-futurep
15102 (setq txt (concat txt " (=>F)")))
15103 (setq org-read-date-overlay
15104 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15105 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15107 (defun org-read-date-analyze (ans def defdecode)
15108 "Analyze the combined answer of the date prompt."
15109 ;; FIXME: cleanup and comment
15110 (let ((nowdecode (decode-time (current-time)))
15111 delta deltan deltaw deltadef year month day
15112 hour minute second wday pm h2 m2 tl wday1
15113 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15114 (setq org-read-date-analyze-futurep nil
15115 org-read-date-analyze-forced-year nil)
15117 (setq ans "+0"))
15119 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15120 (setq ans (replace-match "" t t ans)
15121 deltan (car delta)
15122 deltaw (nth 1 delta)
15123 deltadef (nth 2 delta)))
15125 ;; Check if there is an iso week date in there
15126 ;; If yes, store the info and postpone interpreting it until the rest
15127 ;; of the parsing is done
15128 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15129 (setq iso-year (if (match-end 1)
15130 (org-small-year-to-year
15131 (string-to-number (match-string 1 ans))))
15132 iso-weekday (if (match-end 3)
15133 (string-to-number (match-string 3 ans)))
15134 iso-week (string-to-number (match-string 2 ans)))
15135 (setq ans (replace-match "" t t ans)))
15137 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15138 (when (string-match
15140 (setq year (if (match-end 2)
15141 (string-to-number (match-string 2 ans))
15142 (progn (setq kill-year t)
15143 (string-to-number (format-time-string "%Y"))))
15144 month (string-to-number (match-string 3 ans))
15145 day (string-to-number (match-string 4 ans)))
15146 (if (< year 100) (setq year (+ 2000 year)))
15148 t nil ans)))
15150 ;; Help matching dotted european dates
15151 (when (string-match
15152 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15153 (setq year (if (match-end 3)
15154 (string-to-number (match-string 3 ans))
15155 (progn (setq kill-year t)
15156 (string-to-number (format-time-string "%Y"))))
15157 day (string-to-number (match-string 1 ans))
15158 month (string-to-number (match-string 2 ans))
15160 t nil ans)))
15162 ;; Help matching american dates, like 5/30 or 5/30/7
15163 (when (string-match
15164 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15165 (setq year (if (match-end 4)
15166 (string-to-number (match-string 4 ans))
15167 (progn (setq kill-year t)
15168 (string-to-number (format-time-string "%Y"))))
15169 month (string-to-number (match-string 1 ans))
15170 day (string-to-number (match-string 2 ans)))
15171 (if (< year 100) (setq year (+ 2000 year)))
15173 t nil ans)))
15174 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15175 ;; If there is a time with am/pm, and *no* time without it, we convert
15176 ;; so that matching will be successful.
15177 (loop for i from 1 to 2 do ; twice, for end time as well
15180 (setq hour (string-to-number (match-string 1 ans))
15181 minute (if (match-end 3)
15182 (string-to-number (match-string 3 ans))
15183 0)
15184 pm (equal ?p
15185 (string-to-char (downcase (match-string 4 ans)))))
15186 (if (and (= hour 12) (not pm))
15187 (setq hour 0)
15188 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15189 (setq ans (replace-match (format "%02d:%02d" hour minute)
15190 t t ans))))
15192 ;; Check if a time range is given as a duration
15193 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15194 (setq hour (string-to-number (match-string 1 ans))
15195 h2 (+ hour (string-to-number (match-string 3 ans)))
15196 minute (string-to-number (match-string 2 ans))
15197 m2 (+ minute (if (match-end 5) (string-to-number
15198 (match-string 5 ans))0)))
15199 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15200 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15201 t t ans)))
15203 ;; Check if there is a time range
15204 (when (boundp 'org-end-time-was-given)
15205 (setq org-time-was-given nil)
15206 (when (and (string-match org-plain-time-of-day-regexp ans)
15207 (match-end 8))
15208 (setq org-end-time-was-given (match-string 8 ans))
15209 (setq ans (concat (substring ans 0 (match-beginning 7))
15210 (substring ans (match-end 7))))))
15212 (setq tl (parse-time-string ans)
15213 day (or (nth 3 tl) (nth 3 defdecode))
15214 month (or (nth 4 tl)
15215 (if (and org-read-date-prefer-future
15216 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15217 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15218 (nth 4 defdecode)))
15219 year (or (and (not kill-year) (nth 5 tl))
15220 (if (and org-read-date-prefer-future
15221 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15222 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15223 (nth 5 defdecode)))
15224 hour (or (nth 2 tl) (nth 2 defdecode))
15225 minute (or (nth 1 tl) (nth 1 defdecode))
15226 second (or (nth 0 tl) 0)
15227 wday (nth 6 tl))
15229 (when (and (eq org-read-date-prefer-future 'time)
15230 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15231 (equal day (nth 3 nowdecode))
15232 (equal month (nth 4 nowdecode))
15233 (equal year (nth 5 nowdecode))
15234 (nth 2 tl)
15235 (or (< (nth 2 tl) (nth 2 nowdecode))
15236 (and (= (nth 2 tl) (nth 2 nowdecode))
15237 (nth 1 tl)
15238 (< (nth 1 tl) (nth 1 nowdecode)))))
15239 (setq day (1+ day)
15240 futurep t))
15242 ;; Special date definitions below
15243 (cond
15244 (iso-week
15245 ;; There was an iso week
15246 (require 'cal-iso)
15247 (setq futurep nil)
15248 (setq year (or iso-year year)
15249 day (or iso-weekday wday 1)
15250 wday nil ; to make sure that the trigger below does not match
15251 iso-date (calendar-gregorian-from-absolute
15252 (calendar-absolute-from-iso
15253 (list iso-week day year))))
15254 ; FIXME: Should we also push ISO weeks into the future?
15255 ; (when (and org-read-date-prefer-future
15256 ; (not iso-year)
15257 ; (< (calendar-absolute-from-gregorian iso-date)
15258 ; (time-to-days (current-time))))
15259 ; (setq year (1+ year)
15260 ; iso-date (calendar-gregorian-from-absolute
15261 ; (calendar-absolute-from-iso
15262 ; (list iso-week day year)))))
15263 (setq month (car iso-date)
15264 year (nth 2 iso-date)
15265 day (nth 1 iso-date)))
15266 (deltan
15267 (setq futurep nil)
15268 (unless deltadef
15269 (let ((now (decode-time (current-time))))
15270 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15271 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15272 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15273 ((equal deltaw "m") (setq month (+ month deltan)))
15274 ((equal deltaw "y") (setq year (+ year deltan)))))
15275 ((and wday (not (nth 3 tl)))
15276 (setq futurep nil)
15277 ;; Weekday was given, but no day, so pick that day in the week
15278 ;; on or after the derived date.
15279 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15280 (unless (equal wday wday1)
15281 (setq day (+ day (% (- wday wday1 -7) 7))))))
15282 (if (and (boundp 'org-time-was-given)
15283 (nth 2 tl))
15284 (setq org-time-was-given t))
15285 (if (< year 100) (setq year (+ 2000 year)))
15286 ;; Check of the date is representable
15287 (if org-read-date-force-compatible-dates
15288 (progn
15289 (if (< year 1970)
15290 (setq year 1970 org-read-date-analyze-forced-year t))
15291 (if (> year 2037)
15292 (setq year 2037 org-read-date-analyze-forced-year t)))
15293 (condition-case nil
15294 (ignore (encode-time second minute hour day month year))
15295 (error
15296 (setq year (nth 5 defdecode))
15297 (setq org-read-date-analyze-forced-year t))))
15298 (setq org-read-date-analyze-futurep futurep)
15299 (list second minute hour day month year)))
15301 (defvar parse-time-weekdays)
15303 (defun org-read-date-get-relative (s today default)
15304 "Check string S for special relative date string.
15305 TODAY and DEFAULT are internal times, for today and for a default.
15306 Return shift list (N what def-flag)
15308 N is the number of WHATs to shift.
15309 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15310 the DEFAULT date rather than TODAY."
15311 (require 'parse-time)
15312 (when (and
15313 (string-match
15314 (concat
15319 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15320 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15321 (string-to-char (substring (match-string 1 s) -1))
15322 ?+))
15323 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15324 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15325 (what (if (match-end 3) (match-string 3 s) "d"))
15326 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15327 (date (if rel default today))
15328 (wday (nth 6 (decode-time date)))
15329 delta)
15330 (if wday1
15331 (progn
15332 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15333 (if (= dir ?-) (setq delta (- delta 7)))
15334 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15335 (list delta "d" rel))
15336 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15338 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15339 "Turn a user-specified date into the internal representation.
15340 The internal representation needed by the calendar is (month day year).
15341 This is a wrapper to handle the brain-dead convention in calendar that
15342 user function argument order change dependent on argument order."
15343 (if (boundp 'calendar-date-style)
15344 (cond
15345 ((eq calendar-date-style 'american)
15346 (list arg1 arg2 arg3))
15347 ((eq calendar-date-style 'european)
15348 (list arg2 arg1 arg3))
15349 ((eq calendar-date-style 'iso)
15350 (list arg2 arg3 arg1)))
15351 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15352 (if (org-bound-and-true-p european-calendar-style)
15353 (list arg2 arg1 arg3)
15354 (list arg1 arg2 arg3)))))
15356 (defun org-eval-in-calendar (form &optional keepdate)
15357 "Eval FORM in the calendar window and return to current window.
15358 Also, store the cursor date in variable org-ans2."
15359 (let ((sf (selected-frame))
15360 (sw (selected-window)))
15361 (select-window (get-buffer-window "*Calendar*" t))
15362 (eval form)
15363 (when (and (not keepdate) (calendar-cursor-to-date))
15364 (let* ((date (calendar-cursor-to-date))
15365 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15366 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15367 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15368 (select-window sw)
15369 (org-select-frame-set-input-focus sf)))
15371 (defun org-calendar-select ()
15372 "Return to `org-read-date' with the date currently selected.
15373 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15374 (interactive)
15375 (when (calendar-cursor-to-date)
15376 (let* ((date (calendar-cursor-to-date))
15377 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15378 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15379 (if (active-minibuffer-window) (exit-minibuffer))))
15381 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15382 "Insert a date stamp for the date given by the internal TIME.
15383 WITH-HM means use the stamp format that includes the time of the day.
15384 INACTIVE means use square brackets instead of angular ones, so that the
15385 stamp will not contribute to the agenda.
15386 PRE and POST are optional strings to be inserted before and after the
15387 stamp.
15388 The command returns the inserted time stamp."
15389 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15390 stamp)
15391 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15392 (insert-before-markers (or pre ""))
15393 (when (listp extra)
15394 (setq extra (car extra))
15395 (if (and (stringp extra)
15397 (setq extra (format "-%02d:%02d"
15398 (string-to-number (match-string 1 extra))
15399 (string-to-number (match-string 2 extra))))
15400 (setq extra nil)))
15401 (when extra
15402 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15403 (insert-before-markers (setq stamp (format-time-string fmt time)))
15404 (insert-before-markers (or post ""))
15405 (setq org-last-inserted-timestamp stamp)))
15407 (defun org-toggle-time-stamp-overlays ()
15408 "Toggle the use of custom time stamp formats."
15409 (interactive)
15410 (setq org-display-custom-times (not org-display-custom-times))
15411 (unless org-display-custom-times
15412 (let ((p (point-min)) (bmp (buffer-modified-p)))
15413 (while (setq p (next-single-property-change p 'display))
15414 (if (and (get-text-property p 'display)
15415 (eq (get-text-property p 'face) 'org-date))
15416 (remove-text-properties
15417 p (setq p (next-single-property-change p 'display))
15418 '(display t))))
15419 (set-buffer-modified-p bmp)))
15420 (if (featurep 'xemacs)
15421 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15422 (org-restart-font-lock)
15423 (setq org-table-may-need-update t)
15424 (if org-display-custom-times
15425 (message "Time stamps are overlaid with custom format")
15426 (message "Time stamp overlays removed")))
15428 (defun org-display-custom-time (beg end)
15429 "Overlay modified time stamp format over timestamp between BEG and END."
15430 (let* ((ts (buffer-substring beg end))
15431 t1 w1 with-hm tf time str w2 (off 0))
15432 (save-match-data
15433 (setq t1 (org-parse-time-string ts t))
15434 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15435 (setq off (- (match-end 0) (match-beginning 0)))))
15436 (setq end (- end off))
15437 (setq w1 (- end beg)
15438 with-hm (and (nth 1 t1) (nth 2 t1))
15439 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15440 time (org-fix-decoded-time t1)
15441 str (org-add-props
15442 (format-time-string
15443 (substring tf 1 -1) (apply 'encode-time time))
15444 nil 'mouse-face 'highlight)
15445 w2 (length str))
15446 (if (not (= w2 w1))
15447 (add-text-properties (1+ beg) (+ 2 beg)
15448 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15449 (if (featurep 'xemacs)
15450 (progn
15451 (put-text-property beg end 'invisible t)
15452 (put-text-property beg end 'end-glyph (make-glyph str)))
15453 (put-text-property beg end 'display str))))
15455 (defun org-translate-time (string)
15456 "Translate all timestamps in STRING to custom format.
15457 But do this only if the variable `org-display-custom-times' is set."
15458 (when org-display-custom-times
15459 (save-match-data
15460 (let* ((start 0)
15461 (re org-ts-regexp-both)
15462 t1 with-hm inactive tf time str beg end)
15463 (while (setq start (string-match re string start))
15464 (setq beg (match-beginning 0)
15465 end (match-end 0)
15466 t1 (save-match-data
15467 (org-parse-time-string (substring string beg end) t))
15468 with-hm (and (nth 1 t1) (nth 2 t1))
15469 inactive (equal (substring string beg (1+ beg)) "[")
15470 tf (funcall (if with-hm 'cdr 'car)
15471 org-time-stamp-custom-formats)
15472 time (org-fix-decoded-time t1)
15473 str (format-time-string
15474 (concat
15475 (if inactive "[" "<") (substring tf 1 -1)
15476 (if inactive "]" ">"))
15477 (apply 'encode-time time))
15478 string (replace-match str t t string)
15479 start (+ start (length str)))))))
15480 string)
15482 (defun org-fix-decoded-time (time)
15483 "Set 0 instead of nil for the first 6 elements of time.
15484 Don't touch the rest."
15485 (let ((n 0))
15486 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15488 (defun org-days-to-time (timestamp-string)
15489 "Difference between TIMESTAMP-STRING and now in days."
15490 (- (time-to-days (org-time-string-to-time timestamp-string))
15491 (time-to-days (current-time))))
15493 (defun org-deadline-close (timestamp-string &optional ndays)
15494 "Is the time in TIMESTAMP-STRING close to the current date?"
15495 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15496 (and (< (org-days-to-time timestamp-string) ndays)
15497 (not (org-entry-is-done-p))))
15499 (defun org-get-wdays (ts)
15500 "Get the deadline lead time appropriate for timestring TS."
15501 (cond
15502 ((<= org-deadline-warning-days 0)
15503 ;; 0 or negative, enforce this value no matter what
15504 (- org-deadline-warning-days))
15506 ;; lead time is specified.
15507 (floor (* (string-to-number (match-string 1 ts))
15508 (cdr (assoc (match-string 2 ts)
15509 '(("d" . 1) ("w" . 7)
15510 ("m" . 30.4) ("y" . 365.25)))))))
15511 ;; go for the default.
15512 (t org-deadline-warning-days)))
15514 (defun org-calendar-select-mouse (ev)
15515 "Return to `org-read-date' with the date currently selected.
15516 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15517 (interactive "e")
15518 (mouse-set-point ev)
15519 (when (calendar-cursor-to-date)
15520 (let* ((date (calendar-cursor-to-date))
15521 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15522 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15523 (if (active-minibuffer-window) (exit-minibuffer))))
15525 (defun org-check-deadlines (ndays)
15526 "Check if there are any deadlines due or past due.
15527 A deadline is considered due if it happens within `org-deadline-warning-days'
15528 days from today's date. If the deadline appears in an entry marked DONE,
15529 it is not shown. The prefix arg NDAYS can be used to test that many
15531 (interactive "P")
15532 (let* ((org-warn-days
15533 (cond
15534 ((equal ndays '(4)) 100000)
15535 (ndays (prefix-numeric-value ndays))
15536 (t (abs org-deadline-warning-days))))
15537 (case-fold-search nil)
15539 (callback
15540 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15542 (message "%d deadlines past-due or due within %d days"
15543 (org-occur regexp nil callback)
15544 org-warn-days)))
15546 (defun org-check-before-date (date)
15547 "Check if there are deadlines or scheduled entries before DATE."
15548 (interactive (list (org-read-date)))
15549 (let ((case-fold-search nil)
15553 (callback
15554 (lambda () (time-less-p
15555 (org-time-string-to-time (match-string 2))
15556 (org-time-string-to-time date)))))
15557 (message "%d entries before %s"
15558 (org-occur regexp nil callback) date)))
15560 (defun org-check-after-date (date)
15561 "Check if there are deadlines or scheduled entries after DATE."
15562 (interactive (list (org-read-date)))
15563 (let ((case-fold-search nil)
15567 (callback
15568 (lambda () (not
15569 (time-less-p
15570 (org-time-string-to-time (match-string 2))
15571 (org-time-string-to-time date))))))
15572 (message "%d entries after %s"
15573 (org-occur regexp nil callback) date)))
15575 (defun org-check-dates-range (start-date end-date)
15576 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15577 (interactive (list (org-read-date nil nil nil "Range starts")
15578 (org-read-date nil nil nil "Range end")))
15579 (let ((case-fold-search nil)
15583 (callback
15584 (lambda ()
15585 (let ((match (match-string 2)))
15586 (and
15587 (not (time-less-p
15588 (org-time-string-to-time match)
15589 (org-time-string-to-time start-date)))
15590 (time-less-p
15591 (org-time-string-to-time match)
15592 (org-time-string-to-time end-date)))))))
15593 (message "%d entries between %s and %s"
15594 (org-occur regexp nil callback) start-date end-date)))
15596 (defun org-evaluate-time-range (&optional to-buffer)
15597 "Evaluate a time range by computing the difference between start and end.
15598 Normally the result is just printed in the echo area, but with prefix arg
15599 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15600 If the time range is actually in a table, the result is inserted into the
15601 next column.
15602 For time difference computation, a year is assumed to be exactly 365
15603 days in order to avoid rounding problems."
15604 (interactive "P")
15605 (or
15606 (org-clock-update-time-maybe)
15607 (save-excursion
15608 (unless (org-at-date-range-p t)
15609 (goto-char (point-at-bol))
15610 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15611 (if (not (org-at-date-range-p t))
15612 (error "Not at a time-stamp range, and none found in current line")))
15613 (let* ((ts1 (match-string 1))
15614 (ts2 (match-string 2))
15615 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15616 (match-end (match-end 0))
15617 (time1 (org-time-string-to-time ts1))
15618 (time2 (org-time-string-to-time ts2))
15619 (t1 (org-float-time time1))
15620 (t2 (org-float-time time2))
15621 (diff (abs (- t2 t1)))
15622 (negative (< (- t2 t1) 0))
15623 ;; (ys (floor (* 365 24 60 60)))
15624 (ds (* 24 60 60))
15625 (hs (* 60 60))
15626 (fy "%dy %dd %02d:%02d")
15627 (fy1 "%dy %dd")
15628 (fd "%dd %02d:%02d")
15629 (fd1 "%dd")
15630 (fh "%02d:%02d")
15631 y d h m align)
15632 (if havetime
15633 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15634 y 0
15635 d (floor (/ diff ds)) diff (mod diff ds)
15636 h (floor (/ diff hs)) diff (mod diff hs)
15637 m (floor (/ diff 60)))
15638 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15639 y 0
15640 d (floor (+ (/ diff ds) 0.5))
15641 h 0 m 0))
15642 (if (not to-buffer)
15643 (message "%s" (org-make-tdiff-string y d h m))
15644 (if (org-at-table-p)
15645 (progn
15646 (goto-char match-end)
15647 (setq align t)
15648 (and (looking-at " *|") (goto-char (match-end 0))))
15649 (goto-char match-end))
15650 (if (looking-at
15652 (replace-match ""))
15653 (if negative (insert " -"))
15654 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15655 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15656 (insert " " (format fh h m))))
15657 (if align (org-table-align))
15658 (message "Time difference inserted")))))
15660 (defun org-make-tdiff-string (y d h m)
15661 (let ((fmt "")
15662 (l nil))
15663 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15664 l (push y l)))
15665 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15666 l (push d l)))
15667 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15668 l (push h l)))
15669 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15670 l (push m l)))
15671 (apply 'format fmt (nreverse l))))
15673 (defun org-time-string-to-time (s &optional buffer pos)
15674 (condition-case errdata
15675 (apply 'encode-time (org-parse-time-string s))
15677 s (if (not (and buffer pos))
15678 ""
15679 (format " at %d in buffer `%s'" pos buffer))
15680 (cdr errdata)))))
15682 (defun org-time-string-to-seconds (s)
15683 (org-float-time (org-time-string-to-time s)))
15685 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15686 "Convert a time stamp to an absolute day number.
15687 If there is a specifier for a cyclic time stamp, get the closest date to
15688 DAYNR.
15689 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15690 The variable date is bound by the calendar when this is called."
15691 (cond
15693 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15694 daynr
15695 (+ daynr 1000)))
15697 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15698 (time-to-days (current-time))) (match-string 0 s)
15699 prefer show-all))
15700 (t (time-to-days
15701 (condition-case errdata
15702 (apply 'encode-time (org-parse-time-string s))
15704 s (if (not (and buffer pos))
15705 ""
15706 (format " at %d in buffer `%s'" pos buffer))
15707 (cdr errdata))))))))
15709 (defun org-days-to-iso-week (days)
15710 "Return the iso week number."
15711 (require 'cal-iso)
15712 (car (calendar-iso-from-absolute days)))
15714 (defun org-small-year-to-year (year)
15715 "Convert 2-digit years into 4-digit years.
15716 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15717 The year 2000 cannot be abbreviated. Any year larger than 99
15718 is returned unchanged."
15719 (if (< year 38)
15720 (setq year (+ 2000 year))
15721 (if (< year 100)
15722 (setq year (+ 1900 year))))
15723 year)
15725 (defun org-time-from-absolute (d)
15726 "Return the time corresponding to date D.
15727 D may be an absolute day number, or a calendar-type list (month day year)."
15728 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15729 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15731 (defun org-calendar-holiday ()
15732 "List of holidays, for Diary display in Org-mode."
15733 (require 'holidays)
15734 (let ((hl (funcall
15735 (if (fboundp 'calendar-check-holidays)
15736 'calendar-check-holidays 'check-calendar-holidays) date)))
15737 (if hl (mapconcat 'identity hl "; "))))
15739 (defun org-diary-sexp-entry (sexp entry date)
15740 "Process a SEXP diary ENTRY for DATE."
15741 (require 'diary-lib)
15742 (let ((result (if calendar-debug-sexp
15743 (let ((stack-trace-on-error t))
15744 (eval (car (read-from-string sexp))))
15745 (condition-case nil
15746 (eval (car (read-from-string sexp)))
15747 (error
15748 (beep)
15749 (message "Bad sexp at line %d in %s: %s"
15750 (org-current-line)
15751 (buffer-file-name) sexp)
15752 (sleep-for 2))))))
15753 (cond ((stringp result) (split-string result "; "))
15754 ((and (consp result)
15755 (not (consp (cdr result)))
15756 (stringp (cdr result))) (cdr result))
15757 ((and (consp result)
15758 (stringp (car result))) result)
15759 (result entry)
15760 (t nil))))
15762 (defun org-diary-to-ical-string (frombuf)
15763 "Get iCalendar entries from diary entries in buffer FROMBUF.
15764 This uses the icalendar.el library."
15765 (let* ((tmpdir (if (featurep 'xemacs)
15766 (temp-directory)
15767 temporary-file-directory))
15768 (tmpfile (make-temp-name
15769 (expand-file-name "orgics" tmpdir)))
15770 buf rtn b e)
15771 (with-current-buffer frombuf
15772 (icalendar-export-region (point-min) (point-max) tmpfile)
15773 (setq buf (find-buffer-visiting tmpfile))
15774 (set-buffer buf)
15775 (goto-char (point-min))
15776 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15777 (setq b (match-beginning 0)))
15778 (goto-char (point-max))
15779 (if (re-search-backward "^END:VEVENT" nil t)
15780 (setq e (match-end 0)))
15782 (kill-buffer buf)
15783 (delete-file tmpfile)
15784 rtn))
15786 (defun org-closest-date (start current change prefer show-all)
15787 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15788 When PREFER is `past', return a date that is either CURRENT or past.
15789 When PREFER is `future', return a date that is either CURRENT or future.
15790 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15791 ;; Make the proper lists from the dates
15792 (catch 'exit
15793 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15794 dn dw sday cday n1 n2 n0
15795 d m y y1 y2 date1 date2 nmonths nm ny m2)
15797 (setq start (org-date-to-gregorian start)
15798 current (org-date-to-gregorian
15799 (if show-all
15800 current
15801 (time-to-days (current-time))))
15802 sday (calendar-absolute-from-gregorian start)
15803 cday (calendar-absolute-from-gregorian current))
15805 (if (<= cday sday) (throw 'exit sday))
15808 (setq dn (string-to-number (match-string 1 change))
15809 dw (cdr (assoc (match-string 2 change) a1)))
15810 (error "Invalid change specifier: %s" change))
15811 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15812 (cond
15813 ((eq dw 'day)
15814 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15815 n2 (+ n1 dn)))
15816 ((eq dw 'year)
15817 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15818 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15819 (setq date1 (list m d y1)
15820 n1 (calendar-absolute-from-gregorian date1)
15821 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15822 n2 (calendar-absolute-from-gregorian date2)))
15823 ((eq dw 'month)
15824 ;; approx number of month between the two dates
15825 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15826 ;; How often does dn fit in there?
15827 (setq d (nth 1 start) m (car start) y (nth 2 start)
15828 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15829 m (+ m nm)
15830 ny (floor (/ m 12))
15831 y (+ y ny)
15832 m (- m (* ny 12)))
15833 (while (> m 12) (setq m (- m 12) y (1+ y)))
15834 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15835 (setq m2 (+ m dn) y2 y)
15836 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15837 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15838 (while (<= n2 cday)
15839 (setq n1 n2 m m2 y y2)
15840 (setq m2 (+ m dn) y2 y)
15841 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15842 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15843 ;; Make sure n1 is the earlier date
15844 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15845 (if show-all
15846 (cond
15847 ((eq prefer 'past) (if (= cday n2) n2 n1))
15848 ((eq prefer 'future) (if (= cday n1) n1 n2))
15849 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15850 (cond
15851 ((eq prefer 'past) (if (= cday n2) n2 n1))
15852 ((eq prefer 'future) (if (= cday n1) n1 n2))
15853 (t (if (= cday n1) n1 n2)))))))
15855 (defun org-date-to-gregorian (date)
15856 "Turn any specification of DATE into a Gregorian date for the calendar."
15857 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15858 ((and (listp date) (= (length date) 3)) date)
15859 ((stringp date)
15860 (setq date (org-parse-time-string date))
15861 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15862 ((listp date)
15863 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15865 (defun org-parse-time-string (s &optional nodefault)
15866 "Parse the standard Org-mode time string.
15867 This should be a lot faster than the normal `parse-time-string'.
15868 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15869 hour and minute fields will be nil if not given."
15870 (if (string-match org-ts-regexp0 s)
15871 (list 0
15872 (if (or (match-beginning 8) (not nodefault))
15873 (string-to-number (or (match-string 8 s) "0")))
15874 (if (or (match-beginning 7) (not nodefault))
15875 (string-to-number (or (match-string 7 s) "0")))
15876 (string-to-number (match-string 4 s))
15877 (string-to-number (match-string 3 s))
15878 (string-to-number (match-string 2 s))
15879 nil nil nil)
15880 (error "Not a standard Org-mode time string: %s" s)))
15882 (defun org-timestamp-up (&optional arg)
15883 "Increase the date item at the cursor by one.
15884 If the cursor is on the year, change the year. If it is on the month,
15885 the day or the time, change that.
15886 With prefix ARG, change by that many units."
15887 (interactive "p")
15888 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15890 (defun org-timestamp-down (&optional arg)
15891 "Decrease the date item at the cursor by one.
15892 If the cursor is on the year, change the year. If it is on the month,
15893 the day or the time, change that.
15894 With prefix ARG, change by that many units."
15895 (interactive "p")
15896 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15898 (defun org-timestamp-up-day (&optional arg)
15899 "Increase the date in the time stamp by one day.
15900 With prefix ARG, change that many days."
15901 (interactive "p")
15902 (if (and (not (org-at-timestamp-p t))
15903 (org-at-heading-p))
15904 (org-todo 'up)
15905 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15907 (defun org-timestamp-down-day (&optional arg)
15908 "Decrease the date in the time stamp by one day.
15909 With prefix ARG, change that many days."
15910 (interactive "p")
15911 (if (and (not (org-at-timestamp-p t))
15912 (org-at-heading-p))
15913 (org-todo 'down)
15914 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15916 (defun org-at-timestamp-p (&optional inactive-ok)
15917 "Determine if the cursor is in or at a timestamp."
15918 (interactive)
15919 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15920 (pos (point))
15921 (ans (or (looking-at tsr)
15922 (save-excursion
15924 (if (> (point) (point-min)) (backward-char 1))
15925 (and (looking-at tsr)
15926 (> (- (match-end 0) pos) -1))))))
15927 (and ans
15928 (boundp 'org-ts-what)
15929 (setq org-ts-what
15930 (cond
15931 ((= pos (match-beginning 0)) 'bracket)
15932 ;; Point is considered to be "on the bracket" whether
15933 ;; it's really on it or right after it.
15934 ((or (= pos (1- (match-end 0)))
15935 (= pos (match-end 0))) 'bracket)
15936 ((org-pos-in-match-range pos 2) 'year)
15937 ((org-pos-in-match-range pos 3) 'month)
15938 ((org-pos-in-match-range pos 7) 'hour)
15939 ((org-pos-in-match-range pos 8) 'minute)
15940 ((or (org-pos-in-match-range pos 4)
15941 (org-pos-in-match-range pos 5)) 'day)
15942 ((and (> pos (or (match-end 8) (match-end 5)))
15943 (< pos (match-end 0)))
15944 (- pos (or (match-end 8) (match-end 5))))
15945 (t 'day))))
15946 ans))
15948 (defun org-toggle-timestamp-type ()
15949 "Toggle the type (<active> or [inactive]) of a time stamp."
15950 (interactive)
15951 (when (org-at-timestamp-p t)
15952 (let ((beg (match-beginning 0)) (end (match-end 0))
15953 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15954 (save-excursion
15955 (goto-char beg)
15956 (while (re-search-forward "[][<>]" end t)
15957 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15958 t t)))
15959 (message "Timestamp is now %sactive"
15960 (if (equal (char-after beg) ?<) "" "in")))))
15962 (defun org-timestamp-change (n &optional what updown)
15963 "Change the date in the time stamp at point.
15964 The date will be changed by N times WHAT. WHAT can be `day', `month',
15965 `year', `minute', `second'. If WHAT is not given, the cursor position
15966 in the timestamp determines what will be changed."
15967 (let ((origin (point)) origin-cat
15968 with-hm inactive
15969 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15970 org-ts-what
15971 extra rem
15972 ts time time0)
15973 (if (not (org-at-timestamp-p t))
15974 (error "Not at a timestamp"))
15975 (if (and (not what) (eq org-ts-what 'bracket))
15976 (org-toggle-timestamp-type)
15977 ;; Point isn't on brackets. Remember the part of the time-stamp
15978 ;; the point was in. Indeed, size of time-stamps may change,
15979 ;; but point must be kept in the same category nonetheless.
15980 (setq origin-cat org-ts-what)
15981 (if (and (not what) (not (eq org-ts-what 'day))
15982 org-display-custom-times
15983 (get-text-property (point) 'display)
15984 (not (get-text-property (1- (point)) 'display)))
15985 (setq org-ts-what 'day))
15986 (setq org-ts-what (or what org-ts-what)
15987 inactive (= (char-after (match-beginning 0)) ?\[)
15988 ts (match-string 0))
15989 (replace-match "")
15990 (if (string-match
15992 ts)
15993 (setq extra (match-string 1 ts)))
15995 (setq with-hm t))
15996 (setq time0 (org-parse-time-string ts))
15997 (when (and updown
15998 (eq org-ts-what 'minute)
15999 (not current-prefix-arg))
16000 ;; This looks like s-up and s-down. Change by one rounding step.
16001 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16002 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16003 (setcar (cdr time0) (+ (nth 1 time0)
16004 (if (> n 0) (- rem) (- dm rem))))))
16005 (setq time
16006 (encode-time (or (car time0) 0)
16007 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16008 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16009 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16010 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16011 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16012 (nthcdr 6 time0)))
16013 (when (and (member org-ts-what '(hour minute))
16014 extra
16016 (setq extra (org-modify-ts-extra
16017 extra
16018 (if (eq org-ts-what 'hour) 2 5)
16019 n dm)))
16020 (when (integerp org-ts-what)
16021 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16022 (if (eq what 'calendar)
16023 (let ((cal-date (org-get-date-from-calendar)))
16024 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16025 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16026 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16027 (setcar time0 (or (car time0) 0))
16028 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16029 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16030 (setq time (apply 'encode-time time0))))
16031 ;; Insert the new time-stamp, and ensure point stays in the same
16032 ;; category as before (i.e. not after the last position in that
16033 ;; category).
16034 (let ((pos (point)))
16035 ;; Stay before inserted string. `save-excursion' is of no use.
16036 (setq org-last-changed-timestamp
16037 (org-insert-time-stamp time with-hm inactive nil nil extra))
16038 (goto-char pos))
16039 (save-match-data
16040 (looking-at org-ts-regexp3)
16041 (goto-char (cond
16042 ;; `day' category ends before `hour' if any, or at
16043 ;; the end of the day name.
16044 ((eq origin-cat 'day)
16045 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16046 ((eq origin-cat 'hour) (min (match-end 7) origin))
16047 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16048 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16049 ;; `year' and `month' have both fixed size: point
16050 ;; couldn't have moved into another part.
16051 (t origin))))
16052 ;; Update clock if on a CLOCK line.
16053 (org-clock-update-time-maybe)
16054 ;; Try to recenter the calendar window, if any.
16055 (if (and org-calendar-follow-timestamp-change
16056 (get-buffer-window "*Calendar*" t)
16057 (memq org-ts-what '(day month year)))
16058 (org-recenter-calendar (time-to-days time))))))
16060 (defun org-modify-ts-extra (s pos n dm)
16061 "Change the different parts of the lead-time and repeat fields in timestamp."
16062 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16063 ng h m new rem)
16064 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16065 (cond
16066 ((or (org-pos-in-match-range pos 2)
16067 (org-pos-in-match-range pos 3))
16068 (setq m (string-to-number (match-string 3 s))
16069 h (string-to-number (match-string 2 s)))
16070 (if (org-pos-in-match-range pos 2)
16071 (setq h (+ h n))
16072 (setq n (* dm (org-no-warnings (signum n))))
16073 (when (not (= 0 (setq rem (% m dm))))
16074 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16075 (setq m (+ m n)))
16076 (if (< m 0) (setq m (+ m 60) h (1- h)))
16077 (if (> m 59) (setq m (- m 60) h (1+ h)))
16078 (setq h (min 24 (max 0 h)))
16079 (setq ng 1 new (format "-%02d:%02d" h m)))
16080 ((org-pos-in-match-range pos 6)
16081 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16082 ((org-pos-in-match-range pos 5)
16083 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16085 ((org-pos-in-match-range pos 9)
16086 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16087 ((org-pos-in-match-range pos 8)
16088 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16090 (when ng
16091 (setq s (concat
16092 (substring s 0 (match-beginning ng))
16093 new
16094 (substring s (match-end ng))))))
16095 s))
16097 (defun org-recenter-calendar (date)
16098 "If the calendar is visible, recenter it to DATE."
16099 (let ((cwin (get-buffer-window "*Calendar*" t)))
16100 (when cwin
16101 (let ((calendar-move-hook nil))
16102 (with-selected-window cwin
16103 (calendar-goto-date (if (listp date) date
16104 (calendar-gregorian-from-absolute date))))))))
16106 (defun org-goto-calendar (&optional arg)
16107 "Go to the Emacs calendar at the current date.
16108 If there is a time stamp in the current line, go to that date.
16109 A prefix ARG can be used to force the current date."
16110 (interactive "P")
16111 (let ((tsr org-ts-regexp) diff
16112 (calendar-move-hook nil)
16113 (calendar-view-holidays-initially-flag nil)
16114 (calendar-view-diary-initially-flag nil))
16115 (if (or (org-at-timestamp-p)
16116 (save-excursion
16117 (beginning-of-line 1)
16118 (looking-at (concat ".*" tsr))))
16119 (let ((d1 (time-to-days (current-time)))
16120 (d2 (time-to-days
16121 (org-time-string-to-time (match-string 1)))))
16122 (setq diff (- d2 d1))))
16123 (calendar)
16124 (calendar-goto-today)
16125 (if (and diff (not arg)) (calendar-forward-day diff))))
16127 (defun org-get-date-from-calendar ()
16128 "Return a list (month day year) of date at point in calendar."
16129 (with-current-buffer "*Calendar*"
16130 (save-match-data
16131 (calendar-cursor-to-date))))
16133 (defun org-date-from-calendar ()
16134 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16135 If there is already a time stamp at the cursor position, update it."
16136 (interactive)
16137 (if (org-at-timestamp-p t)
16138 (org-timestamp-change 0 'calendar)
16139 (let ((cal-date (org-get-date-from-calendar)))
16140 (org-insert-time-stamp
16141 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16143 (defun org-minutes-to-hh:mm-string (m)
16144 "Compute H:MM from a number of minutes."
16145 (let ((h (/ m 60)))
16146 (setq m (- m (* 60 h)))
16147 (format org-time-clocksum-format h m)))
16149 (defun org-hh:mm-string-to-minutes (s)
16150 "Convert a string H:MM to a number of minutes.
16151 If the string is just a number, interpret it as minutes.
16152 In fact, the first hh:mm or number in the string will be taken,
16153 there can be extra stuff in the string.
16154 If no number is found, the return value is 0."
16155 (cond
16156 ((integerp s) s)
16158 (+ (* (string-to-number (match-string 1 s)) 60)
16159 (string-to-number (match-string 2 s))))
16161 (string-to-number (match-string 1 s)))
16162 (t 0)))
16164 (defcustom org-effort-durations
16165 `(("h" . 60)
16166 ("d" . ,(* 60 8))
16167 ("w" . ,(* 60 8 5))
16168 ("m" . ,(* 60 8 5 4))
16169 ("y" . ,(* 60 8 5 40)))
16170 "Conversion factor to minutes for an effort modifier.
16172 Each entry has the form (MODIFIER . MINUTES).
16174 In an effort string, a number followed by MODIFIER is multiplied
16175 by the specified number of MINUTES to obtain an effort in
16176 minutes.
16180 :group 'org-agenda
16181 :type '(alist :key-type (string :tag "Modifier")
16182 :value-type (number :tag "Minutes")))
16184 (defun org-duration-string-to-minutes (s)
16185 "Convert a duration string S to minutes.
16187 A bare number is interpreted as minutes, modifiers can be set by
16188 customizing `org-effort-durations' (which see).
16190 Entries containing a colon are interpreted as H:MM by
16191 `org-hh:mm-string-to-minutes'."
16192 (let ((result 0)
16194 (regexp-opt (mapcar 'car org-effort-durations))
16196 (while (string-match re s)
16197 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16198 (string-to-number (match-string 1 s))))
16199 (setq s (replace-match "" nil t s)))
16200 (incf result (org-hh:mm-string-to-minutes s))
16201 result))
16203 ;;;; Files
16205 (defun org-save-all-org-buffers ()
16206 "Save all Org-mode buffers without user confirmation."
16207 (interactive)
16208 (message "Saving all Org-mode buffers...")
16209 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16210 (when (featurep 'org-id) (org-id-locations-save))
16211 (message "Saving all Org-mode buffers... done"))
16213 (defun org-revert-all-org-buffers ()
16214 "Revert all Org-mode buffers.
16215 Prompt for confirmation when there are unsaved changes.
16216 Be sure you know what you are doing before letting this function
16217 overwrite your changes.
16219 This function is useful in a setup where one tracks org files
16220 with a version control system, to revert on one machine after pulling
16221 changes from another. I believe the procedure must be like this:
16223 1. M-x org-save-all-org-buffers
16224 2. Pull changes from the other machine, resolve conflicts
16225 3. M-x org-revert-all-org-buffers"
16226 (interactive)
16227 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16228 (error "Abort"))
16229 (save-excursion
16230 (save-window-excursion
16231 (mapc
16232 (lambda (b)
16233 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16234 (with-current-buffer b buffer-file-name))
16235 (org-pop-to-buffer-same-window b)
16236 (revert-buffer t 'no-confirm)))
16237 (buffer-list))
16238 (when (and (featurep 'org-id) org-id-track-globally)
16239 (org-id-locations-load)))))
16241 ;;;; Agenda files
16243 ;;;###autoload
16244 (defun org-switchb (&optional arg)
16245 "Switch between Org buffers.
16246 With one prefix argument, restrict available buffers to files.
16247 With two prefix arguments, restrict available buffers to agenda files.
16249 Defaults to `iswitchb' for buffer name completion.
16250 Set `org-completion-use-ido' to make it use ido instead."
16251 (interactive "P")
16252 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16253 ((equal arg '(16)) (org-buffer-list 'agenda))
16254 (t (org-buffer-list))))
16255 (org-completion-use-iswitchb org-completion-use-iswitchb)
16256 (org-completion-use-ido org-completion-use-ido))
16257 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16258 (setq org-completion-use-iswitchb t))
16259 (org-pop-to-buffer-same-window
16260 (org-icompleting-read "Org buffer: "
16261 (mapcar 'list (mapcar 'buffer-name blist))
16262 nil t))))
16264 ;;; Define some older names previously used for this functionality
16265 ;;;###autoload
16266 (defalias 'org-ido-switchb 'org-switchb)
16267 ;;;###autoload
16268 (defalias 'org-iswitchb 'org-switchb)
16270 (defun org-buffer-list (&optional predicate exclude-tmp)
16271 "Return a list of Org buffers.
16272 PREDICATE can be `export', `files' or `agenda'.
16274 export restrict the list to Export buffers.
16275 files restrict the list to buffers visiting Org files.
16276 agenda restrict the list to buffers visiting agenda files.
16278 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16279 (let* ((bfn nil)
16280 (agenda-files (and (eq predicate 'agenda)
16281 (mapcar 'file-truename (org-agenda-files t))))
16282 (filter
16283 (cond
16284 ((eq predicate 'files)
16285 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16286 ((eq predicate 'export)
16287 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16288 ((eq predicate 'agenda)
16289 (lambda (b)
16290 (with-current-buffer b
16291 (and (eq major-mode 'org-mode)
16292 (setq bfn (buffer-file-name b))
16293 (member (file-truename bfn) agenda-files)))))
16294 (t (lambda (b) (with-current-buffer b
16295 (or (eq major-mode 'org-mode)
16296 (string-match "\*Org .*Export"
16297 (buffer-name b)))))))))
16298 (delq nil
16299 (mapcar
16300 (lambda(b)
16301 (if (and (funcall filter b)
16302 (or (not exclude-tmp)
16303 (not (string-match "tmp" (buffer-name b)))))
16304 b
16305 nil))
16306 (buffer-list)))))
16308 (defun org-agenda-files (&optional unrestricted archives)
16309 "Get the list of agenda files.
16310 Optional UNRESTRICTED means return the full list even if a restriction
16311 is currently in place.
16312 When ARCHIVES is t, include all archive files that are really being
16313 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16314 `org-agenda-archives-mode' is t."
16315 (let ((files
16316 (cond
16317 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16318 ((stringp org-agenda-files) (org-read-agenda-file-list))
16319 ((listp org-agenda-files) org-agenda-files)
16320 (t (error "Invalid value of `org-agenda-files'")))))
16321 (setq files (apply 'append
16322 (mapcar (lambda (f)
16323 (if (file-directory-p f)
16324 (directory-files
16325 f t org-agenda-file-regexp)
16326 (list f)))
16327 files)))
16328 (when org-agenda-skip-unavailable-files
16329 (setq files (delq nil
16330 (mapcar (function
16331 (lambda (file)
16332 (and (file-readable-p file) file)))
16333 files))))
16334 (when (or (eq archives t)
16335 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16336 (setq files (org-add-archive-files files)))
16337 files))
16339 (defun org-agenda-file-p (&optional file)
16340 "Return non-nil, if FILE is an agenda file.
16341 If FILE is omitted, use the file associated with the current
16342 buffer."
16343 (member (or file (buffer-file-name))
16344 (org-agenda-files t)))
16346 (defun org-edit-agenda-file-list ()
16347 "Edit the list of agenda files.
16348 Depending on setup, this either uses customize to edit the variable
16349 `org-agenda-files', or it visits the file that is holding the list. In the
16350 latter case, the buffer is set up in a way that saving it automatically kills
16351 the buffer and restores the previous window configuration."
16352 (interactive)
16353 (if (stringp org-agenda-files)
16354 (let ((cw (current-window-configuration)))
16355 (find-file org-agenda-files)
16356 (org-set-local 'org-window-configuration cw)
16357 (org-add-hook 'after-save-hook
16358 (lambda ()
16359 (set-window-configuration
16360 (prog1 org-window-configuration
16361 (kill-buffer (current-buffer))))
16362 (org-install-agenda-files-menu)
16363 (message "New agenda file list installed"))
16364 nil 'local)
16365 (message "%s" (substitute-command-keys
16367 (customize-variable 'org-agenda-files)))
16369 (defun org-store-new-agenda-file-list (list)
16370 "Set new value for the agenda file list and save it correctly."
16371 (if (stringp org-agenda-files)
16372 (let ((fe (org-read-agenda-file-list t)) b u)
16373 (while (setq b (find-buffer-visiting org-agenda-files))
16374 (kill-buffer b))
16375 (with-temp-file org-agenda-files
16376 (insert
16377 (mapconcat
16378 (lambda (f) ;; Keep un-expanded entries.
16379 (if (setq u (assoc f fe))
16380 (cdr u)
16381 f))
16384 (let ((org-mode-hook nil) (org-inhibit-startup t)
16385 (org-insert-mode-line-in-empty-file nil))
16386 (setq org-agenda-files list)
16387 (customize-save-variable 'org-agenda-files org-agenda-files))))
16389 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16390 "Read the list of agenda files from a file.
16391 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16392 filenames, used by `org-store-new-agenda-file-list' to write back
16393 un-expanded file names."
16394 (when (file-directory-p org-agenda-files)
16395 (error "`org-agenda-files' cannot be a single directory"))
16396 (when (stringp org-agenda-files)
16397 (with-temp-buffer
16398 (insert-file-contents org-agenda-files)
16399 (mapcar
16400 (lambda (f)
16401 (let ((e (expand-file-name (substitute-in-file-name f)
16402 org-directory)))
16403 (if pair-with-expansion
16404 (cons e f)
16405 e)))
16408 ;;;###autoload
16409 (defun org-cycle-agenda-files ()
16410 "Cycle through the files in `org-agenda-files'.
16411 If the current buffer visits an agenda file, find the next one in the list.
16412 If the current buffer does not, find the first agenda file."
16413 (interactive)
16414 (let* ((fs (org-agenda-files t))
16415 (files (append fs (list (car fs))))
16416 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16417 file)
16418 (unless files (error "No agenda files"))
16419 (catch 'exit
16420 (while (setq file (pop files))
16421 (if (equal (file-truename file) tcf)
16422 (when (car files)
16423 (find-file (car files))
16424 (throw 'exit t))))
16425 (find-file (car fs)))
16426 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16428 (defun org-agenda-file-to-front (&optional to-end)
16429 "Move/add the current file to the top of the agenda file list.
16430 If the file is not present in the list, it is added to the front. If it is
16431 present, it is moved there. With optional argument TO-END, add/move to the
16432 end of the list."
16433 (interactive "P")
16434 (let ((org-agenda-skip-unavailable-files nil)
16435 (file-alist (mapcar (lambda (x)
16436 (cons (file-truename x) x))
16437 (org-agenda-files t)))
16438 (ctf (file-truename buffer-file-name))
16439 x had)
16440 (setq x (assoc ctf file-alist) had x)
16442 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16443 (if to-end
16444 (setq file-alist (append (delq x file-alist) (list x)))
16445 (setq file-alist (cons x (delq x file-alist))))
16446 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16447 (org-install-agenda-files-menu)
16448 (message "File %s to %s of agenda file list"
16449 (if had "moved" "added") (if to-end "end" "front"))))
16451 (defun org-remove-file (&optional file)
16452 "Remove current file from the list of files in variable `org-agenda-files'.
16453 These are the files which are being checked for agenda entries.
16454 Optional argument FILE means use this file instead of the current."
16455 (interactive)
16456 (let* ((org-agenda-skip-unavailable-files nil)
16457 (file (or file buffer-file-name))
16458 (true-file (file-truename file))
16459 (afile (abbreviate-file-name file))
16460 (files (delq nil (mapcar
16461 (lambda (x)
16462 (if (equal true-file
16463 (file-truename x))
16464 nil x))
16465 (org-agenda-files t)))))
16466 (if (not (= (length files) (length (org-agenda-files t))))
16467 (progn
16468 (org-store-new-agenda-file-list files)
16469 (org-install-agenda-files-menu)
16470 (message "Removed file: %s" afile))
16471 (message "File was not in list: %s (not removed)" afile))))
16473 (defun org-file-menu-entry (file)
16474 (vector file (list 'find-file file) t))
16476 (defun org-check-agenda-file (file)
16477 "Make sure FILE exists. If not, ask user what to do."
16478 (when (not (file-exists-p file))
16479 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16480 (abbreviate-file-name file))
16481 (let ((r (downcase (read-char-exclusive))))
16482 (cond
16483 ((equal r ?r)
16484 (org-remove-file file)
16485 (throw 'nextfile t))
16486 (t (error "Abort"))))))
16488 (defun org-get-agenda-file-buffer (file)
16489 "Get a buffer visiting FILE. If the buffer needs to be created, add
16490 it to the list of buffers which might be released later."
16491 (let ((buf (org-find-base-buffer-visiting file)))
16492 (if buf
16493 buf ; just return it
16494 ;; Make a new buffer and remember it
16495 (setq buf (find-file-noselect file))
16496 (if buf (push buf org-agenda-new-buffers))
16497 buf)))
16499 (defun org-release-buffers (blist)
16500 "Release all buffers in list, asking the user for confirmation when needed.
16501 When a buffer is unmodified, it is just killed. When modified, it is saved
16502 \(if the user agrees) and then killed."
16503 (let (buf file)
16504 (while (setq buf (pop blist))
16505 (setq file (buffer-file-name buf))
16506 (when (and (buffer-modified-p buf)
16507 file
16508 (y-or-n-p (format "Save file %s? " file)))
16509 (with-current-buffer buf (save-buffer)))
16510 (kill-buffer buf))))
16512 (defun org-prepare-agenda-buffers (files)
16513 "Create buffers for all agenda files, protect archived trees and comments."
16514 (interactive)
16515 (let ((pa '(:org-archived t))
16516 (pc '(:org-comment t))
16517 (pall '(:org-archived t :org-comment t))
16518 (inhibit-read-only t)
16519 (rea (concat ":" org-archive-tag ":"))
16520 bmp file re)
16521 (save-excursion
16522 (save-restriction
16523 (while (setq file (pop files))
16524 (catch 'nextfile
16525 (if (bufferp file)
16526 (set-buffer file)
16527 (org-check-agenda-file file)
16528 (set-buffer (org-get-agenda-file-buffer file)))
16529 (widen)
16530 (setq bmp (buffer-modified-p))
16531 (org-refresh-category-properties)
16532 (setq org-todo-keywords-for-agenda
16533 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16534 (setq org-done-keywords-for-agenda
16535 (append org-done-keywords-for-agenda org-done-keywords))
16536 (setq org-todo-keyword-alist-for-agenda
16537 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16538 (setq org-drawers-for-agenda
16539 (append org-drawers-for-agenda org-drawers))
16540 (setq org-tag-alist-for-agenda
16541 (append org-tag-alist-for-agenda org-tag-alist))
16543 (save-excursion
16544 (remove-text-properties (point-min) (point-max) pall)
16545 (when org-agenda-skip-archived-trees
16546 (goto-char (point-min))
16547 (while (re-search-forward rea nil t)
16548 (if (org-at-heading-p t)
16549 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16550 (goto-char (point-min))
16551 (setq re (format org-heading-keyword-regexp-format
16552 org-comment-string))
16553 (while (re-search-forward re nil t)
16554 (add-text-properties
16555 (match-beginning 0) (org-end-of-subtree t) pc)))
16556 (set-buffer-modified-p bmp)))))
16557 (setq org-todo-keywords-for-agenda
16558 (org-uniquify org-todo-keywords-for-agenda))
16559 (setq org-todo-keyword-alist-for-agenda
16560 (org-uniquify org-todo-keyword-alist-for-agenda)
16561 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16563 ;;;; Embedded LaTeX
16565 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16566 "Keymap for the minor `org-cdlatex-mode'.")
16568 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16569 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16570 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16571 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16572 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16574 (defvar org-cdlatex-texmathp-advice-is-done nil
16575 "Flag remembering if we have applied the advice to texmathp already.")
16577 (define-minor-mode org-cdlatex-mode
16578 "Toggle the minor `org-cdlatex-mode'.
16579 This mode supports entering LaTeX environment and math in LaTeX fragments
16580 in Org-mode.
16582 nil " OCDL" nil
16583 (when org-cdlatex-mode
16584 (require 'cdlatex)
16585 (run-hooks 'cdlatex-mode-hook)
16586 (cdlatex-compute-tables))
16587 (unless org-cdlatex-texmathp-advice-is-done
16588 (setq org-cdlatex-texmathp-advice-is-done t)
16589 (defadvice texmathp (around org-math-always-on activate)
16590 "Always return t in org-mode buffers.
16591 This is because we want to insert math symbols without dollars even outside
16592 the LaTeX math segments. If Orgmode thinks that point is actually inside
16593 an embedded LaTeX fragment, let texmathp do its job.
16595 (interactive)
16596 (let (p)
16597 (cond
16598 ((not (eq major-mode 'org-mode)) ad-do-it)
16599 ((eq this-command 'cdlatex-math-symbol)
16600 (setq ad-return-value t
16601 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16602 (t
16603 (let ((p (org-inside-LaTeX-fragment-p)))
16604 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16605 (setq ad-return-value t
16606 texmathp-why '("Org-mode embedded math" . 0))
16607 (if p ad-do-it)))))))))
16609 (defun turn-on-org-cdlatex ()
16610 "Unconditionally turn on `org-cdlatex-mode'."
16611 (org-cdlatex-mode 1))
16613 (defun org-inside-LaTeX-fragment-p ()
16614 "Test if point is inside a LaTeX fragment.
16616 sequence appearing also before point.
16617 Even though the matchers for math are configurable, this function assumes
16619 delimiters are skipped when they have been removed by customization.
16620 The return value is nil, or a cons cell with the delimiter and the
16621 position of this delimiter.
16623 This function does a reasonably good job, but can locally be fooled by
16624 for example currency specifications. For example it will assume being in
16626 fragments that are properly closed, but during editing, we have to live
16627 with the uncertainty caused by missing closing delimiters. This function
16628 looks only before point, not after."
16629 (catch 'exit
16630 (let ((pos (point))
16631 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16632 (lim (progn
16634 (point)))
16635 dd-on str (start 0) m re)
16636 (goto-char pos)
16637 (when dodollar
16639 re (nth 1 (assoc "$" org-latex-regexps)))
16640 (while (string-match re str start)
16641 (cond
16642 ((= (match-end 0) (length str))
16643 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16644 ((= (match-end 0) (- (length str) 5))
16645 (throw 'exit nil))
16646 (t (setq start (match-end 0))))))
16647 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16648 (goto-char pos)
16649 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16650 (and (match-beginning 2) (throw 'exit nil))
16651 ;; count $$
16653 (setq dd-on (not dd-on)))
16654 (goto-char pos)
16655 (if dd-on (cons "$$" m))))))
16657 (defun org-inside-latex-macro-p ()
16658 "Is point inside a LaTeX macro or its arguments?"
16659 (save-match-data
16660 (org-in-regexp
16663 (defun org-try-cdlatex-tab ()
16664 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16665 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16666 - inside a LaTeX fragment, or
16667 - after the first word in a line, where an abbreviation expansion could
16668 insert a LaTeX environment."
16669 (when org-cdlatex-mode
16670 (cond
16671 ;; Before any word on the line: No expansion possible.
16673 ;; Just after first word on the line: Expand it. Make sure it
16674 ;; cannot happen on headlines, though.
16675 ((save-excursion
16676 (skip-chars-backward "a-zA-Z0-9*")
16678 (and (bolp) (not (org-at-heading-p))))
16679 (cdlatex-tab) t)
16680 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16682 (defun org-cdlatex-underscore-caret (&optional arg)
16683 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16684 Revert to the normal definition outside of these fragments."
16685 (interactive "P")
16686 (if (org-inside-LaTeX-fragment-p)
16687 (call-interactively 'cdlatex-sub-superscript)
16688 (let (org-cdlatex-mode)
16689 (call-interactively (key-binding (vector last-input-event))))))
16691 (defun org-cdlatex-math-modify (&optional arg)
16692 "Execute `cdlatex-math-modify' in LaTeX fragments.
16693 Revert to the normal definition outside of these fragments."
16694 (interactive "P")
16695 (if (org-inside-LaTeX-fragment-p)
16696 (call-interactively 'cdlatex-math-modify)
16697 (let (org-cdlatex-mode)
16698 (call-interactively (key-binding (vector last-input-event))))))
16700 (defvar org-latex-fragment-image-overlays nil
16701 "List of overlays carrying the images of latex fragments.")
16702 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16704 (defun org-remove-latex-fragment-image-overlays ()
16705 "Remove all overlays with LaTeX fragment images in current buffer."
16706 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16707 (setq org-latex-fragment-image-overlays nil))
16709 (defun org-preview-latex-fragment (&optional subtree)
16710 "Preview the LaTeX fragment at point, or all locally or globally.
16711 If the cursor is in a LaTeX fragment, create the image and overlay
16712 it over the source code. If there is no fragment at point, display
16713 all fragments in the current text, from one headline to the next. With
16714 prefix SUBTREE, display all fragments in the current subtree. With a
16716 the cursor is before the first headline,
16717 display all fragments in the buffer.
16719 (interactive "P")
16720 (unless buffer-file-name
16721 (error "Can't preview LaTeX fragment in a non-file buffer"))
16722 (org-remove-latex-fragment-image-overlays)
16723 (save-excursion
16724 (save-restriction
16725 (let (beg end at msg)
16726 (cond
16727 ((or (equal subtree '(16))
16728 (not (save-excursion
16729 (re-search-backward org-outline-regexp-bol nil t))))
16730 (setq beg (point-min) end (point-max)
16731 msg "Creating images for buffer...%s"))
16732 ((equal subtree '(4))
16733 (org-back-to-heading)
16734 (setq beg (point) end (org-end-of-subtree t)
16735 msg "Creating images for subtree...%s"))
16736 (t
16737 (if (setq at (org-inside-LaTeX-fragment-p))
16738 (goto-char (max (point-min) (- (cdr at) 2)))
16739 (org-back-to-heading))
16740 (setq beg (point) end (progn (outline-next-heading) (point))
16741 msg (if at "Creating image...%s"
16742 "Creating images for entry...%s"))))
16743 (message msg "")
16744 (narrow-to-region beg end)
16745 (goto-char beg)
16746 (org-format-latex
16747 (concat "ltxpng/" (file-name-sans-extension
16748 (file-name-nondirectory
16749 buffer-file-name)))
16750 default-directory 'overlays msg at 'forbuffer 'dvipng)
16751 (message msg "done. Use `C-c C-c' to remove images.")))))
16753 (defvar org-latex-regexps
16755 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16758 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16762 "Regular expressions for matching embedded LaTeX.")
16764 (defvar org-export-have-math nil) ;; dynamic scoping
16765 (defun org-format-latex (prefix &optional dir overlays msg at
16766 forbuffer processing-type)
16767 "Replace LaTeX fragments with links to an image, and produce images.
16768 Some of the options can be changed using the variable
16769 `org-format-latex-options'."
16770 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16771 (let* ((prefixnodir (file-name-nondirectory prefix))
16772 (absprefix (expand-file-name prefix dir))
16773 (todir (file-name-directory absprefix))
16774 (opt org-format-latex-options)
16775 (matchers (plist-get opt :matchers))
16776 (re-list org-latex-regexps)
16777 (org-format-latex-header-extra
16778 (plist-get (org-infile-export-plist) :latex-header-extra))
16779 (cnt 0) txt hash link beg end re e checkdir
16780 executables-checked string
16781 m n block-type block linkfile movefile ov)
16782 ;; Check the different regular expressions
16783 (while (setq e (pop re-list))
16784 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16786 (when (member m matchers)
16787 (goto-char (point-min))
16788 (while (re-search-forward re nil t)
16789 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16790 (not (get-text-property (match-beginning n)
16791 'org-protected))
16792 (or (not overlays)
16793 (not (eq (get-char-property (match-beginning n)
16794 'org-overlay-type)
16795 'org-latex-overlay))))
16796 (setq org-export-have-math t)
16797 (cond
16798 ((eq processing-type 'verbatim)
16799 ;; Leave the text verbatim, just protect it
16800 (add-text-properties (match-beginning n) (match-end n)
16801 '(org-protected t)))
16802 ((eq processing-type 'mathjax)
16803 ;; Prepare for MathJax processing
16804 (setq string (match-string n))
16805 (if (member m '("$" "$1"))
16806 (save-excursion
16807 (delete-region (match-beginning n) (match-end n))
16808 (goto-char (match-beginning n))
16811 '(org-protected t))))
16812 (add-text-properties (match-beginning n) (match-end n)
16813 '(org-protected t))))
16814 ((eq processing-type 'dvipng)
16815 ;; Process to an image
16816 (setq txt (match-string n)
16817 beg (match-beginning n) end (match-end n)
16818 cnt (1+ cnt))
16819 (let (print-length print-level) ; make sure full list is printed
16820 (setq hash (sha1 (prin1-to-string
16821 (list org-format-latex-header
16822 org-format-latex-header-extra
16823 org-export-latex-default-packages-alist
16824 org-export-latex-packages-alist
16825 org-format-latex-options
16826 forbuffer txt)))
16827 linkfile (format "%s_%s.png" prefix hash)
16828 movefile (format "%s_%s.png" absprefix hash)))
16829 (setq link (concat block "[[file:" linkfile "]]" block))
16830 (if msg (message msg cnt))
16831 (goto-char beg)
16832 (unless checkdir ; make sure the directory exists
16833 (setq checkdir t)
16834 (or (file-directory-p todir) (make-directory todir t)))
16836 (unless executables-checked
16837 (org-check-external-command
16838 "latex" "needed to convert LaTeX fragments to images")
16839 (org-check-external-command
16840 "dvipng" "needed to convert LaTeX fragments to images")
16841 (setq executables-checked t))
16843 (unless (file-exists-p movefile)
16844 (org-create-formula-image
16845 txt movefile opt forbuffer))
16846 (if overlays
16847 (progn
16848 (mapc (lambda (o)
16849 (if (eq (overlay-get o 'org-overlay-type)
16850 'org-latex-overlay)
16851 (delete-overlay o)))
16852 (overlays-in beg end))
16853 (setq ov (make-overlay beg end))
16854 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16855 (if (featurep 'xemacs)
16856 (progn
16857 (overlay-put ov 'invisible t)
16858 (overlay-put
16859 ov 'end-glyph
16860 (make-glyph (vector 'png :file movefile))))
16861 (overlay-put
16862 ov 'display
16863 (list 'image :type 'png :file movefile :ascent 'center)))
16864 (push ov org-latex-fragment-image-overlays)
16865 (goto-char end))
16866 (delete-region beg end)
16867 (insert (org-add-props link
16868 (list 'org-latex-src
16869 (replace-regexp-in-string
16871 'org-latex-src-embed-type
16872 (if block-type 'paragraph 'character))))))
16873 ((eq processing-type 'mathml)
16874 ;; Process to MathML
16875 (unless executables-checked
16876 (unless (save-match-data (org-format-latex-mathml-available-p))
16877 (error "LaTeX to MathML converter not configured"))
16878 (setq executables-checked t))
16879 (setq txt (match-string n)
16880 beg (match-beginning n) end (match-end n)
16881 cnt (1+ cnt))
16882 (if msg (message msg cnt))
16883 (goto-char beg)
16884 (delete-region beg end)
16885 (insert (org-format-latex-as-mathml
16886 txt block-type prefix dir)))
16887 (t
16888 (error "Unknown conversion type %s for latex fragments"
16889 processing-type)))))))))
16891 (defun org-create-math-formula (latex-frag &optional mathml-file)
16892 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16893 Use `org-latex-to-mathml-convert-command'. If the conversion is
16895 elements otherwise return nil. When MATHML-FILE is specified,
16896 write the results in to that file. When invoked as an
16897 interactive command, prompt for LATEX-FRAG, with initial value
16898 set to the current active region and echo the results for user
16899 inspection."
16900 (interactive (list (let ((frag (when (region-active-p)
16901 (buffer-substring-no-properties
16902 (region-beginning) (region-end)))))
16903 (read-string "LaTeX Fragment: " frag nil frag))))
16904 (unless latex-frag (error "Invalid latex-frag"))
16905 (let* ((tmp-in-file (file-relative-name
16906 (make-temp-name (expand-file-name "ltxmathml-in"))))
16907 (ignore (write-region latex-frag nil tmp-in-file))
16908 (tmp-out-file (file-relative-name
16909 (make-temp-name (expand-file-name "ltxmathml-out"))))
16910 (cmd (format-spec
16911 org-latex-to-mathml-convert-command
16912 `((?j . ,(shell-quote-argument
16913 (expand-file-name org-latex-to-mathml-jar-file)))
16914 (?I . ,(shell-quote-argument tmp-in-file))
16915 (?o . ,(shell-quote-argument tmp-out-file)))))
16916 mathml shell-command-output)
16917 (when (org-called-interactively-p 'any)
16918 (unless (org-format-latex-mathml-available-p)
16919 (error "LaTeX to MathML converter not configured")))
16920 (message "Running %s" cmd)
16921 (setq shell-command-output (shell-command-to-string cmd))
16922 (setq mathml
16923 (when (file-readable-p tmp-out-file)
16924 (with-current-buffer (find-file-noselect tmp-out-file t)
16925 (goto-char (point-min))
16926 (when (re-search-forward
16927 (concat
16928 (regexp-quote
16931 (regexp-quote "</math>")) nil t)
16932 (prog1 (match-string 0) (kill-buffer))))))
16933 (cond
16934 (mathml
16935 (setq mathml
16937 (when mathml-file
16938 (write-region mathml nil mathml-file))
16939 (when (org-called-interactively-p 'any)
16940 (message mathml)))
16941 ((message "LaTeX to MathML conversion failed")
16942 (message shell-command-output)))
16943 (delete-file tmp-in-file)
16944 (when (file-exists-p tmp-out-file)
16945 (delete-file tmp-out-file))
16946 mathml))
16948 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16949 prefix &optional dir)
16950 "Use `org-create-math-formula' but check local cache first."
16951 (let* ((absprefix (expand-file-name prefix dir))
16952 (print-length nil) (print-level nil)
16953 (formula-id (concat
16954 "formula-"
16955 (sha1
16956 (prin1-to-string
16957 (list latex-frag
16958 org-latex-to-mathml-convert-command)))))
16959 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16960 (formula-cache-dir (file-name-directory formula-cache)))
16962 (unless (file-directory-p formula-cache-dir)
16963 (make-directory formula-cache-dir t))
16965 (unless (file-exists-p formula-cache)
16966 (org-create-math-formula latex-frag formula-cache))
16968 (if (file-exists-p formula-cache)
16969 ;; Successful conversion. Return the link to MathML file.
16970 (org-add-props
16971 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16973 'org-latex-src-embed-type (if latex-frag-type
16974 'paragraph 'character)))
16975 ;; Failed conversion. Return the LaTeX fragment verbatim
16976 (add-text-properties
16977 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16978 latex-frag)))
16980 ;; This function borrows from Ganesh Swami's latex2png.el
16981 (defun org-create-formula-image (string tofile options buffer)
16982 "This calls dvipng."
16983 (require 'org-latex)
16984 (let* ((tmpdir (if (featurep 'xemacs)
16985 (temp-directory)
16986 temporary-file-directory))
16987 (texfilebase (make-temp-name
16988 (expand-file-name "orgtex" tmpdir)))
16989 (texfile (concat texfilebase ".tex"))
16990 (dvifile (concat texfilebase ".dvi"))
16991 (pngfile (concat texfilebase ".png"))
16992 (fnh (if (featurep 'xemacs)
16993 (font-height (face-font 'default))
16994 (face-attribute 'default :height nil)))
16995 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16996 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16997 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16998 "Black"))
16999 (bg (or (plist-get options (if buffer :background :html-background))
17000 "Transparent")))
17001 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17002 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17003 (with-temp-file texfile
17004 (insert (org-splice-latex-header
17005 org-format-latex-header
17006 org-export-latex-default-packages-alist
17007 org-export-latex-packages-alist t
17008 org-format-latex-header-extra))
17010 (require 'org-latex)
17011 (org-export-latex-fix-inputenc))
17012 (let ((dir default-directory))
17013 (condition-case nil
17014 (progn
17015 (cd tmpdir)
17016 (call-process "latex" nil nil nil texfile))
17017 (error nil))
17018 (cd dir))
17019 (if (not (file-exists-p dvifile))
17020 (progn (message "Failed to create dvi file from %s" texfile) nil)
17021 (condition-case nil
17022 (if (featurep 'xemacs)
17023 (call-process "dvipng" nil nil nil
17024 "-fg" fg "-bg" bg
17025 "-T" "tight"
17026 "-o" pngfile
17027 dvifile)
17028 (call-process "dvipng" nil nil nil
17029 "-fg" fg "-bg" bg
17030 "-D" dpi
17031 ;;"-x" scale "-y" scale
17032 "-T" "tight"
17033 "-o" pngfile
17034 dvifile))
17035 (error nil))
17036 (if (not (file-exists-p pngfile))
17037 (if org-format-latex-signal-error
17038 (error "Failed to create png file from %s" texfile)
17039 (message "Failed to create png file from %s" texfile)
17040 nil)
17041 ;; Use the requested file name and clean up
17042 (copy-file pngfile tofile 'replace)
17043 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17044 (delete-file (concat texfilebase e)))
17045 pngfile))))
17047 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17048 "Fill a LaTeX header template TPL.
17049 In the template, the following place holders will be recognized:
17052 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17054 [NO-PACKAGES] do not include PKG
17055 [EXTRA] the string EXTRA
17056 [NO-EXTRA] do not include EXTRA
17058 For backward compatibility, if both the positive and the negative place
17060 assumed to be present at the end of the template.
17061 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17062 EXTRA is a string.
17063 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17064 (let (rpl (end ""))
17066 (setq rpl (if (or (match-end 1) (not def-pkg))
17067 "" (org-latex-packages-to-string def-pkg snippets-p t))
17068 tpl (replace-match rpl t t tpl))
17069 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17072 (setq rpl (if (or (match-end 1) (not pkg))
17073 "" (org-latex-packages-to-string pkg snippets-p t))
17074 tpl (replace-match rpl t t tpl))
17075 (if pkg (setq end
17077 (org-latex-packages-to-string pkg snippets-p)))))
17080 (setq rpl (if (or (match-end 1) (not extra))
17082 tpl (replace-match rpl t t tpl))
17088 tpl)))
17090 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17092 (setq pkg (mapconcat (lambda(p)
17093 (cond
17094 ((stringp p) p)
17095 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17096 (format "%% Package %s omitted" (cadr p)))
17097 ((equal "" (car p))
17099 (t
17101 (car p) (cadr p)))))
17102 pkg
17106 (defun org-dvipng-color (attr)
17107 "Return an rgb color specification for dvipng."
17108 (apply 'format "rgb %s %s %s"
17109 (mapcar 'org-normalize-color
17110 (if (featurep 'xemacs)
17111 (color-rgb-components
17112 (face-property 'default
17113 (cond ((eq attr :foreground) 'foreground)
17114 ((eq attr :background) 'background))))
17115 (color-values (face-attribute 'default attr nil))))))
17117 (defun org-normalize-color (value)
17118 "Return string to be used as color value for an RGB component."
17119 (format "%g" (/ value 65535.0)))
17121 ;; Image display
17124 (defvar org-inline-image-overlays nil)
17125 (make-variable-buffer-local 'org-inline-image-overlays)
17127 (defun org-toggle-inline-images (&optional include-linked)
17128 "Toggle the display of inline images.
17129 INCLUDE-LINKED is passed to `org-display-inline-images'."
17130 (interactive "P")
17131 (if org-inline-image-overlays
17132 (progn
17133 (org-remove-inline-images)
17134 (message "Inline image display turned off"))
17135 (org-display-inline-images include-linked)
17136 (if org-inline-image-overlays
17137 (message "%d images displayed inline"
17138 (length org-inline-image-overlays))
17139 (message "No images to display inline"))))
17141 (defun org-display-inline-images (&optional include-linked refresh beg end)
17142 "Display inline images.
17143 Normally only links without a description part are inlined, because this
17144 is how it will work for export. When INCLUDE-LINKED is set, also links
17145 with a description part will be inlined. This can be nice for a quick
17146 look at those images, but it does not reflect what exported files will look
17147 like.
17148 When REFRESH is set, refresh existing images between BEG and END.
17149 This will create new image displays only if necessary.
17150 BEG and END default to the buffer boundaries."
17151 (interactive "P")
17152 (unless refresh
17153 (org-remove-inline-images)
17154 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17155 (save-excursion
17156 (save-restriction
17157 (widen)
17158 (setq beg (or beg (point-min)) end (or end (point-max)))
17159 (goto-char (point-min))
17161 (substring (org-image-file-name-regexp) 0 -2)
17163 old file ov img)
17164 (while (re-search-forward re end t)
17165 (setq old (get-char-property-and-overlay (match-beginning 1)
17166 'org-image-overlay))
17167 (setq file (expand-file-name
17168 (concat (or (match-string 3) "") (match-string 4))))
17169 (when (file-exists-p file)
17170 (if (and (car-safe old) refresh)
17171 (image-refresh (overlay-get (cdr old) 'display))
17172 (setq img (save-match-data (create-image file)))
17173 (when img
17174 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17175 (overlay-put ov 'display img)
17176 (overlay-put ov 'face 'default)
17177 (overlay-put ov 'org-image-overlay t)
17178 (overlay-put ov 'modification-hooks
17179 (list 'org-display-inline-modification-hook))
17180 (push ov org-inline-image-overlays)))))))))
17182 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17183 "Remove inline-display overlay if a corresponding region is modified."
17184 (let ((inhibit-modification-hooks t))
17185 (when (and ov after)
17186 (delete ov org-inline-image-overlays)
17187 (delete-overlay ov))))
17189 (defun org-remove-inline-images ()
17190 "Remove inline display of images."
17191 (interactive)
17192 (mapc 'delete-overlay org-inline-image-overlays)
17193 (setq org-inline-image-overlays nil))
17195 ;;;; Key bindings
17197 ;; Outline functions from `outline-mode-prefix-map'
17198 ;; that can be remapped in Org:
17199 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17200 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17201 (define-key org-mode-map [remap outline-forward-same-level]
17202 'org-forward-same-level)
17203 (define-key org-mode-map [remap outline-backward-same-level]
17204 'org-backward-same-level)
17205 (define-key org-mode-map [remap show-branches]
17206 'org-kill-note-or-show-branches)
17207 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17208 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17209 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17211 ;; Outline functions from `outline-mode-prefix-map'
17212 ;; that can not be remapped in Org:
17213 ;; - the column "key binding" shows whether the Outline function is still
17214 ;; available in Org mode on the same key that it has been bound to in
17215 ;; Outline mode:
17216 ;; - "overridden": key used for a different functionality in Org mode
17217 ;; - else: key still bound to the same Outline function in Org mode
17218 ;; | Outline function | key binding | Org replacement |
17219 ;; |------------------------------------+-------------+-----------------------|
17220 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17221 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17222 ;; | `show-children' | `C-c C-i' | visibility cycling |
17223 ;; | `hide-subtree' | overridden | visibility cycling |
17224 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17225 ;; | `hide-body' | overridden | no replacement |
17226 ;; | `show-all' | overridden | no replacement |
17227 ;; | `hide-entry' | overridden | visibility cycling |
17228 ;; | `show-entry' | overridden | no replacement |
17229 ;; | `hide-leaves' | overridden | no replacement |
17230 ;; | `hide-sublevels' | overridden | no replacement |
17231 ;; | `hide-other' | overridden | no replacement |
17232 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17233 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17235 ;; Make `C-c C-x' a prefix key
17236 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17238 ;; TAB key with modifiers
17239 (org-defkey org-mode-map "\C-i" 'org-cycle)
17240 (org-defkey org-mode-map [(tab)] 'org-cycle)
17241 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17242 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17244 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17245 ;; The following line is necessary under Suse GNU/Linux
17246 (unless (featurep 'xemacs)
17247 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17248 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17249 (define-key org-mode-map [backtab] 'org-shifttab)
17251 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17252 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17253 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17255 ;; Cursor keys with modifiers
17256 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17257 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17258 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17259 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17261 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17262 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17263 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17264 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17266 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17267 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17268 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17269 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17271 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17272 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17273 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17274 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17276 ;; Babel keys
17277 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17278 (mapc (lambda (pair)
17279 (define-key org-babel-map (car pair) (cdr pair)))
17280 org-babel-key-bindings)
17282 ;;; Extra keys for tty access.
17283 ;; We only set them when really needed because otherwise the
17284 ;; menus don't show the simple keys
17286 (when (or org-use-extra-keys
17287 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17288 (not window-system))
17289 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17290 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17291 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17292 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17293 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17294 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17295 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17296 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17297 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17298 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17299 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17300 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17301 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17302 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17303 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17304 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17305 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17306 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17307 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17308 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17309 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17310 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17311 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17312 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17313 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17314 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17315 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17316 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17318 ;; All the other keys
17320 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17321 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17322 (if (boundp 'narrow-map)
17323 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17324 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17325 (if (boundp 'narrow-map)
17326 (org-defkey narrow-map "b" 'org-narrow-to-block)
17327 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17328 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17329 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17330 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17331 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17332 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17333 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17334 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17335 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17336 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17337 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17338 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17339 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17340 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17341 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17342 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17343 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17345 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17346 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17347 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17348 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17349 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17350 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17351 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17352 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17353 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17354 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17355 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17356 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17357 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17358 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17359 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17360 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17361 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17362 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17363 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17364 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17366 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17367 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17368 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17369 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17370 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17371 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17372 (org-defkey org-mode-map "\C-c^" 'org-sort)
17373 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17374 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17375 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17376 (org-defkey org-mode-map "\C-m" 'org-return)
17377 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17378 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17379 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17380 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17381 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17382 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17383 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17384 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17385 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17386 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17387 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17388 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17389 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17390 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17391 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17392 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17393 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17394 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17395 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17396 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17397 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17398 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17400 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17401 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17402 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17403 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17405 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17406 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17407 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17408 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17409 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17410 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17411 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17412 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17413 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17414 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17416 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17417 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17418 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17419 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17420 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17421 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17422 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17424 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17425 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17426 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17427 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17428 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17430 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17432 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17434 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17435 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17437 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17440 (when (featurep 'xemacs)
17441 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17444 (defconst org-speed-commands-default
17445 '(
17446 ("Outline Navigation")
17447 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17448 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17449 ("f" . (org-speed-move-safe 'org-forward-same-level))
17450 ("b" . (org-speed-move-safe 'org-backward-same-level))
17451 ("u" . (org-speed-move-safe 'outline-up-heading))
17452 ("j" . org-goto)
17453 ("g" . (org-refile t))
17454 ("Outline Visibility")
17455 ("c" . org-cycle)
17456 ("C" . org-shifttab)
17457 (" " . org-display-outline-path)
17458 ("Outline Structure Editing")
17459 ("U" . org-shiftmetaup)
17460 ("D" . org-shiftmetadown)
17461 ("r" . org-metaright)
17462 ("l" . org-metaleft)
17463 ("R" . org-shiftmetaright)
17464 ("L" . org-shiftmetaleft)
17465 ("i" . (progn (forward-char 1) (call-interactively
17466 'org-insert-heading-respect-content)))
17467 ("^" . org-sort)
17468 ("w" . org-refile)
17469 ("a" . org-archive-subtree-default-with-confirmation)
17470 ("." . org-mark-subtree)
17471 ("Clock Commands")
17472 ("I" . org-clock-in)
17473 ("O" . org-clock-out)
17474 ("Meta Data Editing")
17475 ("t" . org-todo)
17476 ("0" . (org-priority ?\ ))
17477 ("1" . (org-priority ?A))
17478 ("2" . (org-priority ?B))
17479 ("3" . (org-priority ?C))
17480 (";" . org-set-tags-command)
17481 ("e" . org-set-effort)
17482 ("Agenda Views etc")
17483 ("v" . org-agenda)
17484 ("/" . org-sparse-tree)
17485 ("Misc")
17486 ("o" . org-open-at-point)
17487 ("?" . org-speed-command-help)
17488 ("<" . (org-agenda-set-restriction-lock 'subtree))
17489 (">" . (org-agenda-remove-restriction-lock))
17490 )
17491 "The default speed commands.")
17493 (defun org-print-speed-command (e)
17494 (if (> (length (car e)) 1)
17495 (progn
17497 (princ (car e))
17499 (princ (make-string (length (car e)) ?-))
17501 (princ (car e))
17502 (princ " ")
17503 (if (symbolp (cdr e))
17504 (princ (symbol-name (cdr e)))
17505 (prin1 (cdr e)))
17508 (defun org-speed-command-help ()
17509 "Show the available speed commands."
17510 (interactive)
17511 (if (not org-use-speed-commands)
17512 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17513 (with-output-to-temp-buffer "*Help*"
17515 (mapc 'org-print-speed-command org-speed-commands-user)
17518 (mapc 'org-print-speed-command org-speed-commands-default))
17519 (with-current-buffer "*Help*"
17520 (setq truncate-lines t))))
17522 (defun org-speed-move-safe (cmd)
17523 "Execute CMD, but make sure that the cursor always ends up in a headline.
17524 If not, return to the original position and throw an error."
17525 (interactive)
17526 (let ((pos (point)))
17527 (call-interactively cmd)
17528 (unless (and (bolp) (org-at-heading-p))
17529 (goto-char pos)
17530 (error "Boundary reached while executing %s" cmd))))
17532 (defvar org-self-insert-command-undo-counter 0)
17534 (defvar org-table-auto-blank-field) ; defined in org-table.el
17535 (defvar org-speed-command nil)
17537 (defun org-speed-command-default-hook (keys)
17538 "Hook for activating single-letter speed commands.
17539 `org-speed-commands-default' specifies a minimal command set.
17540 Use `org-speed-commands-user' for further customization."
17541 (when (or (and (bolp) (looking-at org-outline-regexp))
17542 (and (functionp org-use-speed-commands)
17543 (funcall org-use-speed-commands)))
17544 (cdr (assoc keys (append org-speed-commands-user
17545 org-speed-commands-default)))))
17547 (defun org-babel-speed-command-hook (keys)
17548 "Hook for activating single-letter code block commands."
17549 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17550 (cdr (assoc keys org-babel-key-bindings))))
17552 (defcustom org-speed-command-hook
17553 '(org-speed-command-default-hook org-babel-speed-command-hook)
17554 "Hook for activating speed commands at strategic locations.
17555 Hook functions are called in sequence until a valid handler is
17556 found.
17558 Each hook takes a single argument, a user-pressed command key
17559 which is also a `self-insert-command' from the global map.
17561 Within the hook, examine the cursor position and the command key
17562 and return nil or a valid handler as appropriate. Handler could
17563 be one of an interactive command, a function, or a form.
17565 Set `org-use-speed-commands' to non-nil value to enable this
17566 hook. The default setting is `org-speed-command-default-hook'."
17567 :group 'org-structure
17568 :type 'hook)
17570 (defun org-self-insert-command (N)
17571 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17572 If the cursor is in a table looking at whitespace, the whitespace is
17573 overwritten, and the table is not marked as requiring realignment."
17574 (interactive "p")
17575 (org-check-before-invisible-edit 'insert)
17576 (cond
17577 ((and org-use-speed-commands
17578 (setq org-speed-command
17579 (run-hook-with-args-until-success
17580 'org-speed-command-hook (this-command-keys))))
17581 (cond
17582 ((commandp org-speed-command)
17583 (setq this-command org-speed-command)
17584 (call-interactively org-speed-command))
17585 ((functionp org-speed-command)
17586 (funcall org-speed-command))
17587 ((and org-speed-command (listp org-speed-command))
17588 (eval org-speed-command))
17589 (t (let (org-use-speed-commands)
17590 (call-interactively 'org-self-insert-command)))))
17591 ((and
17592 (org-table-p)
17593 (progn
17594 ;; check if we blank the field, and if that triggers align
17595 (and (featurep 'org-table) org-table-auto-blank-field
17596 (member last-command
17597 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17599 ;; got extra space, this field does not determine column width
17600 (let (org-table-may-need-update) (org-table-blank-field))
17601 ;; no extra space, this field may determine column width
17602 (org-table-blank-field)))
17603 t)
17604 (eq N 1)
17606 (let (org-table-may-need-update)
17607 (goto-char (1- (match-end 0)))
17608 (delete-char -1)
17609 (goto-char (match-beginning 0))
17610 (self-insert-command N)))
17611 (t
17612 (setq org-table-may-need-update t)
17613 (self-insert-command N)
17614 (org-fix-tags-on-the-fly)
17615 (if org-self-insert-cluster-for-undo
17616 (if (not (eq last-command 'org-self-insert-command))
17617 (setq org-self-insert-command-undo-counter 1)
17618 (if (>= org-self-insert-command-undo-counter 20)
17619 (setq org-self-insert-command-undo-counter 1)
17620 (and (> org-self-insert-command-undo-counter 0)
17621 buffer-undo-list (listp buffer-undo-list)
17622 (not (cadr buffer-undo-list)) ; remove nil entry
17623 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17624 (setq org-self-insert-command-undo-counter
17625 (1+ org-self-insert-command-undo-counter))))))))
17627 (defun org-check-before-invisible-edit (kind)
17628 "Check is editing if kind KIND would be dangerous with invisible text around.
17629 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17630 ;; First, try to get out of here as quickly as possible, to reduce overhead
17631 (if (and org-catch-invisible-edits
17632 (or (not (boundp 'visible-mode)) (not visible-mode))
17633 (or (get-char-property (point) 'invisible)
17634 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17635 ;; OK, we need to take a closer look
17636 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17637 (invisible-before-point (if (bobp) nil (get-char-property
17638 (1- (point)) 'invisible)))
17639 (border-and-ok-direction
17640 (or
17641 ;; Check if we are acting predictably before invisible text
17642 (and invisible-at-point (not invisible-before-point)
17643 (memq kind '(insert delete-backward)))
17644 ;; Check if we are acting predictably after invisible text
17645 ;; This works not well, and I have turned it off. It seems
17646 ;; better to always show and stop after invisible text.
17647 ;; (and (not invisible-at-point) invisible-before-point
17648 ;; (memq kind '(insert delete)))
17649 )))
17651 (when (or (memq invisible-at-point '(outline org-hide-block))
17652 (memq invisible-before-point '(outline org-hide-block)))
17653 (if (eq org-catch-invisible-edits 'error)
17654 (error "Editing in invisible areas is prohibited - make visible first"))
17655 ;; Make the area visible
17656 (save-excursion
17657 (if invisible-before-point
17658 (goto-char (previous-single-char-property-change
17659 (point) 'invisible)))
17660 (org-cycle))
17661 (cond
17662 ((eq org-catch-invisible-edits 'show)
17663 ;; That's it, we do the edit after showing
17664 (message
17665 "Unfolding invisible region around point before editing")
17666 (sit-for 1))
17667 ((and (eq org-catch-invisible-edits 'smart)
17668 border-and-ok-direction)
17669 (message "Unfolding invisible region around point before editing"))
17670 (t
17671 ;; Don't do the edit, make the user repeat it in full visibility
17672 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17674 (defun org-fix-tags-on-the-fly ()
17675 (when (and (equal (char-after (point-at-bol)) ?*)
17676 (org-at-heading-p))
17677 (org-align-tags-here org-tags-column)))
17679 (defun org-delete-backward-char (N)
17680 "Like `delete-backward-char', insert whitespace at field end in tables.
17681 When deleting backwards, in tables this function will insert whitespace in
17683 still be marked for re-alignment if the field did fill the entire column,
17684 because, in this case the deletion might narrow the column."
17685 (interactive "p")
17686 (org-check-before-invisible-edit 'delete-backward)
17687 (if (and (org-table-p)
17688 (eq N 1)
17689 (string-match "|" (buffer-substring (point-at-bol) (point)))
17690 (looking-at ".*?|"))
17691 (let ((pos (point))
17693 (c org-table-may-need-update))
17694 (backward-delete-char N)
17695 (if (not overwrite-mode)
17696 (progn
17697 (skip-chars-forward "^|")
17698 (insert " ")
17699 (goto-char (1- pos))))
17700 ;; noalign: if there were two spaces at the end, this field
17701 ;; does not determine the width of the column.
17702 (if noalign (setq org-table-may-need-update c)))
17703 (backward-delete-char N)
17704 (org-fix-tags-on-the-fly)))
17706 (defun org-delete-char (N)
17707 "Like `delete-char', but insert whitespace at field end in tables.
17708 When deleting characters, in tables this function will insert whitespace in
17710 still be marked for re-alignment if the field did fill the entire column,
17711 because, in this case the deletion might narrow the column."
17712 (interactive "p")
17713 (org-check-before-invisible-edit 'delete)
17714 (if (and (org-table-p)
17715 (not (bolp))
17716 (not (= (char-after) ?|))
17717 (eq N 1))
17718 (if (looking-at ".*?|")
17719 (let ((pos (point))
17721 (c org-table-may-need-update))
17722 (replace-match (concat
17723 (substring (match-string 0) 1 -1)
17724 " |"))
17725 (goto-char pos)
17726 ;; noalign: if there were two spaces at the end, this field
17727 ;; does not determine the width of the column.
17728 (if noalign (setq org-table-may-need-update c)))
17729 (delete-char N))
17730 (delete-char N)
17731 (org-fix-tags-on-the-fly)))
17733 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17734 (put 'org-self-insert-command 'delete-selection t)
17735 (put 'orgtbl-self-insert-command 'delete-selection t)
17736 (put 'org-delete-char 'delete-selection 'supersede)
17737 (put 'org-delete-backward-char 'delete-selection 'supersede)
17738 (put 'org-yank 'delete-selection 'yank)
17740 ;; Make `flyspell-mode' delay after some commands
17741 (put 'org-self-insert-command 'flyspell-delayed t)
17742 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17743 (put 'org-delete-char 'flyspell-delayed t)
17744 (put 'org-delete-backward-char 'flyspell-delayed t)
17746 ;; Make pabbrev-mode expand after org-mode commands
17747 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17748 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17750 ;; How to do this: Measure non-white length of current string
17751 ;; If equal to column width, we should realign.
17753 (defun org-remap (map &rest commands)
17754 "In MAP, remap the functions given in COMMANDS.
17755 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17756 (let (new old)
17757 (while commands
17758 (setq old (pop commands) new (pop commands))
17759 (if (fboundp 'command-remapping)
17760 (org-defkey map (vector 'remap old) new)
17761 (substitute-key-definition old new map global-map)))))
17763 (when (eq org-enable-table-editor 'optimized)
17764 ;; If the user wants maximum table support, we need to hijack
17765 ;; some standard editing functions
17766 (org-remap org-mode-map
17767 'self-insert-command 'org-self-insert-command
17768 'delete-char 'org-delete-char
17769 'delete-backward-char 'org-delete-backward-char)
17770 (org-defkey org-mode-map "|" 'org-force-self-insert))
17772 (defvar org-ctrl-c-ctrl-c-hook nil
17773 "Hook for functions attaching themselves to `C-c C-c'.
17775 This can be used to add additional functionality to the C-c C-c
17776 key which executes context-dependent commands. This hook is run
17777 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17778 run after the last test.
17780 Each function will be called with no arguments. The function
17781 must check if the context is appropriate for it to act. If yes,
17782 it should do its thing and then return a non-nil value. If the
17783 context is wrong, just do nothing and return nil.")
17785 (defvar org-ctrl-c-ctrl-c-final-hook nil
17786 "Hook for functions attaching themselves to `C-c C-c'.
17788 This can be used to add additional functionality to the C-c C-c
17789 key which executes context-dependent commands. This hook is run
17790 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17791 before the first test.
17793 Each function will be called with no arguments. The function
17794 must check if the context is appropriate for it to act. If yes,
17795 it should do its thing and then return a non-nil value. If the
17796 context is wrong, just do nothing and return nil.")
17798 (defvar org-tab-first-hook nil
17799 "Hook for functions to attach themselves to TAB.
17800 See `org-ctrl-c-ctrl-c-hook' for more information.
17801 This hook runs as the first action when TAB is pressed, even before
17802 `org-cycle' messes around with the `outline-regexp' to cater for
17803 inline tasks and plain list item folding.
17804 If any function in this hook returns t, any other actions that
17805 would have been caused by TAB (such as table field motion or visibility
17806 cycling) will not occur.")
17808 (defvar org-tab-after-check-for-table-hook nil
17809 "Hook for functions to attach themselves to TAB.
17810 See `org-ctrl-c-ctrl-c-hook' for more information.
17811 This hook runs after it has been established that the cursor is not in a
17812 table, but before checking if the cursor is in a headline or if global cycling
17813 should be done.
17814 If any function in this hook returns t, not other actions like visibility
17815 cycling will be done.")
17817 (defvar org-tab-after-check-for-cycling-hook nil
17818 "Hook for functions to attach themselves to TAB.
17819 See `org-ctrl-c-ctrl-c-hook' for more information.
17820 This hook runs after it has been established that not table field motion and
17821 not visibility should be done because of current context. This is probably
17822 the place where a package like yasnippets can hook in.")
17824 (defvar org-tab-before-tab-emulation-hook nil
17825 "Hook for functions to attach themselves to TAB.
17826 See `org-ctrl-c-ctrl-c-hook' for more information.
17827 This hook runs after every other options for TAB have been exhausted, but
17830 (defvar org-metaleft-hook nil
17831 "Hook for functions attaching themselves to `M-left'.
17832 See `org-ctrl-c-ctrl-c-hook' for more information.")
17833 (defvar org-metaright-hook nil
17834 "Hook for functions attaching themselves to `M-right'.
17835 See `org-ctrl-c-ctrl-c-hook' for more information.")
17836 (defvar org-metaup-hook nil
17837 "Hook for functions attaching themselves to `M-up'.
17838 See `org-ctrl-c-ctrl-c-hook' for more information.")
17839 (defvar org-metadown-hook nil
17840 "Hook for functions attaching themselves to `M-down'.
17841 See `org-ctrl-c-ctrl-c-hook' for more information.")
17842 (defvar org-shiftmetaleft-hook nil
17843 "Hook for functions attaching themselves to `M-S-left'.
17844 See `org-ctrl-c-ctrl-c-hook' for more information.")
17845 (defvar org-shiftmetaright-hook nil
17846 "Hook for functions attaching themselves to `M-S-right'.
17847 See `org-ctrl-c-ctrl-c-hook' for more information.")
17848 (defvar org-shiftmetaup-hook nil
17849 "Hook for functions attaching themselves to `M-S-up'.
17850 See `org-ctrl-c-ctrl-c-hook' for more information.")
17851 (defvar org-shiftmetadown-hook nil
17852 "Hook for functions attaching themselves to `M-S-down'.
17853 See `org-ctrl-c-ctrl-c-hook' for more information.")
17854 (defvar org-metareturn-hook nil
17855 "Hook for functions attaching themselves to `M-RET'.
17856 See `org-ctrl-c-ctrl-c-hook' for more information.")
17857 (defvar org-shiftup-hook nil
17858 "Hook for functions attaching themselves to `S-up'.
17859 See `org-ctrl-c-ctrl-c-hook' for more information.")
17860 (defvar org-shiftup-final-hook nil
17861 "Hook for functions attaching themselves to `S-up'.
17862 This one runs after all other options except shift-select have been excluded.
17863 See `org-ctrl-c-ctrl-c-hook' for more information.")
17864 (defvar org-shiftdown-hook nil
17865 "Hook for functions attaching themselves to `S-down'.
17866 See `org-ctrl-c-ctrl-c-hook' for more information.")
17867 (defvar org-shiftdown-final-hook nil
17868 "Hook for functions attaching themselves to `S-down'.
17869 This one runs after all other options except shift-select have been excluded.
17870 See `org-ctrl-c-ctrl-c-hook' for more information.")
17871 (defvar org-shiftleft-hook nil
17872 "Hook for functions attaching themselves to `S-left'.
17873 See `org-ctrl-c-ctrl-c-hook' for more information.")
17874 (defvar org-shiftleft-final-hook nil
17875 "Hook for functions attaching themselves to `S-left'.
17876 This one runs after all other options except shift-select have been excluded.
17877 See `org-ctrl-c-ctrl-c-hook' for more information.")
17878 (defvar org-shiftright-hook nil
17879 "Hook for functions attaching themselves to `S-right'.
17880 See `org-ctrl-c-ctrl-c-hook' for more information.")
17881 (defvar org-shiftright-final-hook nil
17882 "Hook for functions attaching themselves to `S-right'.
17883 This one runs after all other options except shift-select have been excluded.
17884 See `org-ctrl-c-ctrl-c-hook' for more information.")
17886 (defun org-modifier-cursor-error ()
17887 "Throw an error, a modified cursor command was applied in wrong context."
17888 (error "This command is active in special context like tables, headlines or items"))
17890 (defun org-shiftselect-error ()
17891 "Throw an error because Shift-Cursor command was applied in wrong context."
17892 (if (and (boundp 'shift-select-mode) shift-select-mode)
17893 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17894 (error "This command works only in special context like headlines or timestamps")))
17896 (defun org-call-for-shift-select (cmd)
17897 (let ((this-command-keys-shift-translated t))
17898 (call-interactively cmd)))
17900 (defun org-shifttab (&optional arg)
17901 "Global visibility cycling or move to previous table field.
17902 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17903 on context.
17904 See the individual commands for more information."
17905 (interactive "P")
17906 (cond
17907 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17908 ((integerp arg)
17909 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17910 (message "Content view to level: %d" arg)
17911 (org-content (prefix-numeric-value arg2))
17912 (setq org-cycle-global-status 'overview)))
17913 (t (call-interactively 'org-global-cycle))))
17915 (defun org-shiftmetaleft ()
17916 "Promote subtree or delete table column.
17917 Calls `org-promote-subtree', `org-outdent-item',
17918 or `org-table-delete-column', depending on context.
17919 See the individual commands for more information."
17920 (interactive)
17921 (cond
17922 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17923 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17924 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17925 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17926 (t (org-modifier-cursor-error))))
17928 (defun org-shiftmetaright ()
17929 "Demote subtree or insert table column.
17930 Calls `org-demote-subtree', `org-indent-item',
17931 or `org-table-insert-column', depending on context.
17932 See the individual commands for more information."
17933 (interactive)
17934 (cond
17935 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17936 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17937 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17938 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17939 (t (org-modifier-cursor-error))))
17941 (defun org-shiftmetaup (&optional arg)
17942 "Move subtree up or kill table row.
17943 Calls `org-move-subtree-up' or `org-table-kill-row' or
17944 `org-move-item-up' depending on context. See the individual commands
17945 for more information."
17946 (interactive "P")
17947 (cond
17948 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17949 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17950 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17951 ((org-at-item-p) (call-interactively 'org-move-item-up))
17952 (t (org-modifier-cursor-error))))
17954 (defun org-shiftmetadown (&optional arg)
17955 "Move subtree down or insert table row.
17956 Calls `org-move-subtree-down' or `org-table-insert-row' or
17957 `org-move-item-down', depending on context. See the individual
17958 commands for more information."
17959 (interactive "P")
17960 (cond
17961 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17962 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17963 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17964 ((org-at-item-p) (call-interactively 'org-move-item-down))
17965 (t (org-modifier-cursor-error))))
17967 (defsubst org-hidden-tree-error ()
17968 (error
17969 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17971 (defun org-metaleft (&optional arg)
17972 "Promote heading or move table column to left.
17973 Calls `org-do-promote' or `org-table-move-column', depending on context.
17974 With no specific context, calls the Emacs default `backward-word'.
17975 See the individual commands for more information."
17976 (interactive "P")
17977 (cond
17978 ((run-hook-with-args-until-success 'org-metaleft-hook))
17979 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17980 ((org-with-limited-levels
17981 (or (org-at-heading-p)
17982 (and (org-region-active-p)
17983 (save-excursion
17984 (goto-char (region-beginning))
17985 (org-at-heading-p)))))
17986 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17987 (call-interactively 'org-do-promote))
17988 ;; At an inline task.
17989 ((org-at-heading-p)
17990 (call-interactively 'org-inlinetask-promote))
17991 ((or (org-at-item-p)
17992 (and (org-region-active-p)
17993 (save-excursion
17994 (goto-char (region-beginning))
17995 (org-at-item-p))))
17996 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17997 (call-interactively 'org-outdent-item))
17998 (t (call-interactively 'backward-word))))
18000 (defun org-metaright (&optional arg)
18001 "Demote subtree or move table column to right.
18002 Calls `org-do-demote' or `org-table-move-column', depending on context.
18003 With no specific context, calls the Emacs default `forward-word'.
18004 See the individual commands for more information."
18005 (interactive "P")
18006 (cond
18007 ((run-hook-with-args-until-success 'org-metaright-hook))
18008 ((org-at-table-p) (call-interactively 'org-table-move-column))
18009 ((org-with-limited-levels
18010 (or (org-at-heading-p)
18011 (and (org-region-active-p)
18012 (save-excursion
18013 (goto-char (region-beginning))
18014 (org-at-heading-p)))))
18015 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18016 (call-interactively 'org-do-demote))
18017 ;; At an inline task.
18018 ((org-at-heading-p)
18019 (call-interactively 'org-inlinetask-demote))
18020 ((or (org-at-item-p)
18021 (and (org-region-active-p)
18022 (save-excursion
18023 (goto-char (region-beginning))
18024 (org-at-item-p))))
18025 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18026 (call-interactively 'org-indent-item))
18027 (t (call-interactively 'forward-word))))
18029 (defun org-check-for-hidden (what)
18030 "Check if there are hidden headlines/items in the current visual line.
18031 WHAT can be either `headlines' or `items'. If the current line is
18032 an outline or item heading and it has a folded subtree below it,
18033 this function returns t, nil otherwise."
18034 (let ((re (cond
18035 ((eq what 'headlines) org-outline-regexp-bol)
18036 ((eq what 'items) (org-item-beginning-re))
18037 (t (error "This should not happen"))))
18038 beg end)
18039 (save-excursion
18040 (catch 'exit
18041 (unless (org-region-active-p)
18042 (setq beg (point-at-bol))
18043 (beginning-of-line 2)
18044 (while (and (not (eobp)) ;; this is like `next-line'
18045 (get-char-property (1- (point)) 'invisible))
18046 (beginning-of-line 2))
18047 (setq end (point))
18048 (goto-char beg)
18049 (goto-char (point-at-eol))
18050 (setq end (max end (point)))
18051 (while (re-search-forward re end t)
18052 (if (get-char-property (match-beginning 0) 'invisible)
18053 (throw 'exit t))))
18054 nil))))
18056 (defun org-metaup (&optional arg)
18057 "Move subtree up or move table row up.
18058 Calls `org-move-subtree-up' or `org-table-move-row' or
18059 `org-move-item-up', depending on context. See the individual commands
18060 for more information."
18061 (interactive "P")
18062 (cond
18063 ((run-hook-with-args-until-success 'org-metaup-hook))
18064 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18065 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18066 ((org-at-item-p) (call-interactively 'org-move-item-up))
18067 (t (transpose-lines 1) (beginning-of-line -1))))
18069 (defun org-metadown (&optional arg)
18070 "Move subtree down or move table row down.
18071 Calls `org-move-subtree-down' or `org-table-move-row' or
18072 `org-move-item-down', depending on context. See the individual
18073 commands for more information."
18074 (interactive "P")
18075 (cond
18076 ((run-hook-with-args-until-success 'org-metadown-hook))
18077 ((org-at-table-p) (call-interactively 'org-table-move-row))
18078 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18079 ((org-at-item-p) (call-interactively 'org-move-item-down))
18080 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18082 (defun org-shiftup (&optional arg)
18083 "Increase item in timestamp or increase priority of current headline.
18084 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18085 depending on context. See the individual commands for more information."
18086 (interactive "P")
18087 (cond
18088 ((run-hook-with-args-until-success 'org-shiftup-hook))
18089 ((and org-support-shift-select (org-region-active-p))
18090 (org-call-for-shift-select 'previous-line))
18091 ((org-at-timestamp-p t)
18092 (call-interactively (if org-edit-timestamp-down-means-later
18093 'org-timestamp-down 'org-timestamp-up)))
18094 ((and (not (eq org-support-shift-select 'always))
18095 org-enable-priority-commands
18096 (org-at-heading-p))
18097 (call-interactively 'org-priority-up))
18098 ((and (not org-support-shift-select) (org-at-item-p))
18099 (call-interactively 'org-previous-item))
18100 ((org-clocktable-try-shift 'up arg))
18101 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18102 (org-support-shift-select
18103 (org-call-for-shift-select 'previous-line))
18104 (t (org-shiftselect-error))))
18106 (defun org-shiftdown (&optional arg)
18107 "Decrease item in timestamp or decrease priority of current headline.
18108 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18109 depending on context. See the individual commands for more information."
18110 (interactive "P")
18111 (cond
18112 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18113 ((and org-support-shift-select (org-region-active-p))
18114 (org-call-for-shift-select 'next-line))
18115 ((org-at-timestamp-p t)
18116 (call-interactively (if org-edit-timestamp-down-means-later
18117 'org-timestamp-up 'org-timestamp-down)))
18118 ((and (not (eq org-support-shift-select 'always))
18119 org-enable-priority-commands
18120 (org-at-heading-p))
18121 (call-interactively 'org-priority-down))
18122 ((and (not org-support-shift-select) (org-at-item-p))
18123 (call-interactively 'org-next-item))
18124 ((org-clocktable-try-shift 'down arg))
18125 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18126 (org-support-shift-select
18127 (org-call-for-shift-select 'next-line))
18128 (t (org-shiftselect-error))))
18130 (defun org-shiftright (&optional arg)
18131 "Cycle the thing at point or in the current line, depending on context.
18132 Depending on context, this does one of the following:
18134 - switch a timestamp at point one day into the future
18135 - on a headline, switch to the next TODO keyword.
18136 - on an item, switch entire list to the next bullet type
18137 - on a property line, switch to the next allowed value
18138 - on a clocktable definition line, move time block into the future"
18139 (interactive "P")
18140 (cond
18141 ((run-hook-with-args-until-success 'org-shiftright-hook))
18142 ((and org-support-shift-select (org-region-active-p))
18143 (org-call-for-shift-select 'forward-char))
18144 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18145 ((and (not (eq org-support-shift-select 'always))
18146 (org-at-heading-p))
18147 (let ((org-inhibit-logging
18148 (not org-treat-S-cursor-todo-selection-as-state-change))
18149 (org-inhibit-blocking
18150 (not org-treat-S-cursor-todo-selection-as-state-change)))
18151 (org-call-with-arg 'org-todo 'right)))
18152 ((or (and org-support-shift-select
18153 (not (eq org-support-shift-select 'always))
18154 (org-at-item-bullet-p))
18155 (and (not org-support-shift-select) (org-at-item-p)))
18156 (org-call-with-arg 'org-cycle-list-bullet nil))
18157 ((and (not (eq org-support-shift-select 'always))
18158 (org-at-property-p))
18159 (call-interactively 'org-property-next-allowed-value))
18160 ((org-clocktable-try-shift 'right arg))
18161 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18162 (org-support-shift-select
18163 (org-call-for-shift-select 'forward-char))
18164 (t (org-shiftselect-error))))
18166 (defun org-shiftleft (&optional arg)
18167 "Cycle the thing at point or in the current line, depending on context.
18168 Depending on context, this does one of the following:
18170 - switch a timestamp at point one day into the past
18171 - on a headline, switch to the previous TODO keyword.
18172 - on an item, switch entire list to the previous bullet type
18173 - on a property line, switch to the previous allowed value
18174 - on a clocktable definition line, move time block into the past"
18175 (interactive "P")
18176 (cond
18177 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18178 ((and org-support-shift-select (org-region-active-p))
18179 (org-call-for-shift-select 'backward-char))
18180 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18181 ((and (not (eq org-support-shift-select 'always))
18182 (org-at-heading-p))
18183 (let ((org-inhibit-logging
18184 (not org-treat-S-cursor-todo-selection-as-state-change))
18185 (org-inhibit-blocking
18186 (not org-treat-S-cursor-todo-selection-as-state-change)))
18187 (org-call-with-arg 'org-todo 'left)))
18188 ((or (and org-support-shift-select
18189 (not (eq org-support-shift-select 'always))
18190 (org-at-item-bullet-p))
18191 (and (not org-support-shift-select) (org-at-item-p)))
18192 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18193 ((and (not (eq org-support-shift-select 'always))
18194 (org-at-property-p))
18195 (call-interactively 'org-property-previous-allowed-value))
18196 ((org-clocktable-try-shift 'left arg))
18197 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18198 (org-support-shift-select
18199 (org-call-for-shift-select 'backward-char))
18200 (t (org-shiftselect-error))))
18202 (defun org-shiftcontrolright ()
18203 "Switch to next TODO set."
18204 (interactive)
18205 (cond
18206 ((and org-support-shift-select (org-region-active-p))
18207 (org-call-for-shift-select 'forward-word))
18208 ((and (not (eq org-support-shift-select 'always))
18209 (org-at-heading-p))
18210 (org-call-with-arg 'org-todo 'nextset))
18211 (org-support-shift-select
18212 (org-call-for-shift-select 'forward-word))
18213 (t (org-shiftselect-error))))
18215 (defun org-shiftcontrolleft ()
18216 "Switch to previous TODO set."
18217 (interactive)
18218 (cond
18219 ((and org-support-shift-select (org-region-active-p))
18220 (org-call-for-shift-select 'backward-word))
18221 ((and (not (eq org-support-shift-select 'always))
18222 (org-at-heading-p))
18223 (org-call-with-arg 'org-todo 'previousset))
18224 (org-support-shift-select
18225 (org-call-for-shift-select 'backward-word))
18226 (t (org-shiftselect-error))))
18228 (defun org-shiftcontrolup ()
18229 "Change timestamps synchronously up in CLOCK log lines."
18230 (interactive)
18231 (cond ((and (not org-support-shift-select)
18232 (org-at-clock-log-p)
18233 (org-at-timestamp-p t))
18234 (org-clock-timestamps-up))
18235 (t (org-shiftselect-error))))
18237 (defun org-shiftcontroldown ()
18238 "Change timestamps synchronously down in CLOCK log lines."
18239 (interactive)
18240 (cond ((and (not org-support-shift-select)
18241 (org-at-clock-log-p)
18242 (org-at-timestamp-p t))
18243 (org-clock-timestamps-down))
18244 (t (org-shiftselect-error))))
18246 (defun org-ctrl-c-ret ()
18247 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18248 (interactive)
18249 (cond
18250 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18251 (t (call-interactively 'org-insert-heading))))
18253 (defun org-find-visible ()
18254 (let ((s (point)))
18255 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18256 (get-char-property s 'invisible)))
18257 s))
18258 (defun org-find-invisible ()
18259 (let ((s (point)))
18260 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18261 (not (get-char-property s 'invisible))))
18262 s))
18264 (defun org-copy-visible (beg end)
18265 "Copy the visible parts of the region."
18266 (interactive "r")
18267 (let (snippets s)
18268 (save-excursion
18269 (save-restriction
18270 (narrow-to-region beg end)
18271 (setq s (goto-char (point-min)))
18272 (while (not (= (point) (point-max)))
18273 (goto-char (org-find-invisible))
18274 (push (buffer-substring s (point)) snippets)
18275 (setq s (goto-char (org-find-visible))))))
18276 (kill-new (apply 'concat (nreverse snippets)))))
18278 (defun org-copy-special ()
18279 "Copy region in table or copy current subtree.
18280 Calls `org-table-copy' or `org-copy-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-copy-region 'org-copy-subtree)))
18286 (defun org-cut-special ()
18287 "Cut region in table or cut current subtree.
18288 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18289 See the individual commands for more information."
18290 (interactive)
18291 (call-interactively
18292 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18294 (defun org-paste-special (arg)
18295 "Paste rectangular region into table, or past subtree relative to level.
18296 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18297 See the individual commands for more information."
18298 (interactive "P")
18299 (if (org-at-table-p)
18300 (org-table-paste-rectangle)
18301 (org-paste-subtree arg)))
18303 (defun org-edit-special (&optional arg)
18304 "Call a special editor for the stuff at point.
18305 When at a table, call the formula editor with `org-table-edit-formulas'.
18306 When at the first line of an src example, call `org-edit-src-code'.
18307 When in an #+include line, visit the include file. Otherwise call
18308 `ffap' to visit the file at point."
18309 (interactive)
18310 ;; possibly prep session before editing source
18311 (when arg
18312 (let* ((info (org-babel-get-src-block-info))
18313 (lang (nth 0 info))
18314 (params (nth 2 info))
18315 (session (cdr (assoc :session params))))
18316 (when (and info session) ;; we are in a source-code block with a session
18317 (funcall
18318 (intern (concat "org-babel-prep-session:" lang)) session params))))
18319 (cond ;; proceed with `org-edit-special'
18320 ((save-excursion
18321 (beginning-of-line 1)
18322 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18323 (find-file (org-trim (match-string 1))))
18324 ((org-edit-src-code))
18325 ((org-edit-fixed-width-region))
18326 ((org-at-table.el-p)
18327 (org-edit-src-code))
18328 ((or (org-at-table-p)
18329 (save-excursion
18330 (beginning-of-line 1)
18332 (call-interactively 'org-table-edit-formulas))
18333 (t (call-interactively 'ffap))))
18335 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18336 (defun org-ctrl-c-ctrl-c (&optional arg)
18337 "Set tags in headline, or update according to changed information at point.
18339 This command does many different things, depending on context:
18341 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18342 this is what we do.
18344 - If the cursor is on a statistics cookie, update it.
18346 - If the cursor is in a headline, prompt for tags and insert them
18347 into the current line, aligned to `org-tags-column'. When called
18348 with prefix arg, realign all tags in the current buffer.
18350 - If the cursor is in one of the special #+KEYWORD lines, this
18351 triggers scanning the buffer for these lines and updating the
18352 information.
18354 - If the cursor is inside a table, realign the table. This command
18355 works even if the automatic table editor has been turned off.
18357 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18358 the entire table.
18360 - If the cursor is at a footnote reference or definition, jump to
18361 the corresponding definition or references, respectively.
18363 - If the cursor is a the beginning of a dynamic block, update it.
18365 - If the current buffer is a capture buffer, close note and file it.
18367 - If the cursor is on a <<<target>>>, update radio targets and
18368 corresponding links in this buffer.
18370 - If the cursor is on a numbered item in a plain list, renumber the
18371 ordered list.
18373 - If the cursor is on a checkbox, toggle it.
18375 - If the cursor is on a code block, evaluate it. The variable
18376 `org-confirm-babel-evaluate' can be used to control prompting
18377 before code block evaluation, by default every code block
18378 evaluation requires confirmation. Code block evaluation can be
18379 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18380 (interactive "P")
18381 (let ((org-enable-table-editor t))
18382 (cond
18383 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18384 org-occur-highlights
18385 org-latex-fragment-image-overlays)
18386 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18387 (org-remove-occur-highlights)
18388 (org-remove-latex-fragment-image-overlays)
18389 (message "Temporary highlights/overlays removed from current buffer"))
18390 ((and (local-variable-p 'org-finish-function (current-buffer))
18391 (fboundp org-finish-function))
18392 (funcall org-finish-function))
18393 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18394 ((org-in-regexp org-ts-regexp-both)
18395 (org-timestamp-change 0 'day))
18396 ((or (looking-at org-property-start-re)
18397 (org-at-property-p))
18398 (call-interactively 'org-property-action))
18399 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18401 (or (org-at-heading-p) (org-at-item-p)))
18402 (call-interactively 'org-update-statistics-cookies))
18403 ((org-at-heading-p) (call-interactively 'org-set-tags))
18404 ((org-at-table.el-p)
18405 (message "Use C-c ' to edit table.el tables"))
18406 ((org-at-table-p)
18407 (org-table-maybe-eval-formula)
18408 (if arg
18409 (call-interactively 'org-table-recalculate)
18410 (org-table-maybe-recalculate-line))
18411 (call-interactively 'org-table-align)
18412 (orgtbl-send-table 'maybe))
18413 ((or (org-footnote-at-reference-p)
18414 (org-footnote-at-definition-p))
18415 (call-interactively 'org-footnote-action))
18416 ((org-at-item-checkbox-p)
18417 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18418 ;; list only if at top item.
18419 (let* ((cbox (match-string 1))
18420 (struct (org-list-struct))
18421 (old-struct (copy-tree struct))
18422 (parents (org-list-parents-alist struct))
18423 (orderedp (org-entry-get nil "ORDERED"))
18424 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18425 block-item)
18426 ;; Use a light version of `org-toggle-checkbox' to avoid
18427 ;; computing list structure twice.
18428 (let ((new-box (cond
18429 ((equal arg '(16)) "[-]")
18430 ((equal arg '(4)) nil)
18431 ((equal "[X]" cbox) "[ ]")
18432 (t "[X]"))))
18433 (if (and firstp arg)
18434 ;; If at first item of sub-list, remove check-box from
18435 ;; every item at the same level.
18436 (mapc
18437 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18438 (org-list-get-all-items
18439 (point-at-bol) struct (org-list-prevs-alist struct)))
18440 (org-list-set-checkbox (point-at-bol) struct new-box)))
18441 ;; Replicate `org-list-write-struct', while grabbing a return
18442 ;; value from `org-list-struct-fix-box'.
18443 (org-list-struct-fix-ind struct parents 2)
18444 (org-list-struct-fix-item-end struct)
18445 (let ((prevs (org-list-prevs-alist struct)))
18446 (org-list-struct-fix-bul struct prevs)
18447 (org-list-struct-fix-ind struct parents)
18448 (setq block-item
18449 (org-list-struct-fix-box struct parents prevs orderedp)))
18450 (org-list-struct-apply-struct struct old-struct)
18451 (org-update-checkbox-count-maybe)
18452 (when block-item
18453 (message
18454 "Checkboxes were removed due to unchecked box at line %d"
18455 (org-current-line block-item)))
18456 (when firstp (org-list-send-list 'maybe))))
18457 ((org-at-item-p)
18458 ;; Cursor at an item: repair list. Do checkbox related actions
18459 ;; only if function was called with an argument. Send list only
18460 ;; if at top item.
18461 (let* ((struct (org-list-struct))
18462 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18463 old-struct)
18464 (when arg
18465 (setq old-struct (copy-tree struct))
18466 (if firstp
18467 ;; If at first item of sub-list, add check-box to every
18468 ;; item at the same level.
18469 (mapc
18470 (lambda (pos)
18471 (unless (org-list-get-checkbox pos struct)
18472 (org-list-set-checkbox pos struct "[ ]")))
18473 (org-list-get-all-items
18474 (point-at-bol) struct (org-list-prevs-alist struct)))
18475 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18476 (org-list-write-struct
18477 struct (org-list-parents-alist struct) old-struct)
18478 (when arg (org-update-checkbox-count-maybe))
18479 (when firstp (org-list-send-list 'maybe))))
18480 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18481 ;; Dynamic block
18482 (beginning-of-line 1)
18483 (save-excursion (org-update-dblock)))
18484 ((save-excursion
18485 (beginning-of-line 1)
18487 (cond
18488 ((equal (match-string 1) "TBLFM")
18489 ;; Recalculate the table before this line
18490 (save-excursion
18491 (beginning-of-line 1)
18493 (if (org-at-table-p)
18494 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18495 (t
18496 (let ((org-inhibit-startup-visibility-stuff t)
18497 (org-startup-align-all-tables nil))
18498 (when (boundp 'org-table-coordinate-overlays)
18499 (mapc 'delete-overlay org-table-coordinate-overlays)
18500 (setq org-table-coordinate-overlays nil))
18501 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18502 (message "Local setup has been refreshed"))))
18503 ((org-clock-update-time-maybe))
18504 (t
18505 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18506 (error "C-c C-c can do nothing useful at this location"))))))
18508 (defun org-mode-restart ()
18509 "Restart Org-mode, to scan again for special lines.
18510 Also updates the keyword regular expressions."
18511 (interactive)
18512 (org-mode)
18513 (message "Org-mode restarted"))
18515 (defun org-kill-note-or-show-branches ()
18516 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18517 (interactive)
18518 (if (not org-finish-function)
18519 (progn
18520 (hide-subtree)
18521 (call-interactively 'show-branches))
18522 (let ((org-note-abort t))
18523 (funcall org-finish-function))))
18525 (defun org-return (&optional indent)
18526 "Goto next table row or insert a newline.
18527 Calls `org-table-next-row' or `newline', depending on context.
18528 See the individual commands for more information."
18529 (interactive)
18530 (cond
18531 ((bobp) (if indent (newline-and-indent) (newline)))
18532 ((org-at-table-p)
18533 (org-table-justify-field-maybe)
18534 (call-interactively 'org-table-next-row))
18535 ;; when `newline-and-indent' is called within a list, make sure
18536 ;; text moved stays inside the item.
18537 ((and (org-in-item-p) indent)
18538 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18539 (progn
18540 (save-match-data (newline))
18541 (org-indent-line-to (length (match-string 0))))
18542 (let ((ind (org-get-indentation)))
18543 (newline)
18544 (if (org-looking-back org-list-end-re)
18545 (org-indent-line-function)
18546 (org-indent-line-to ind)))))
18547 ((and org-return-follows-link
18548 (let ((tprop (get-text-property (point) 'face)))
18549 (or (eq tprop 'org-link)
18550 (and (listp tprop) (memq 'org-link tprop)))))
18551 (call-interactively 'org-open-at-point))
18552 ((and (org-at-heading-p)
18553 (looking-at
18555 (org-show-entry)
18556 (end-of-line 1)
18557 (newline))
18558 (t (if indent (newline-and-indent) (newline)))))
18560 (defun org-return-indent ()
18561 "Goto next table row or insert a newline and indent.
18562 Calls `org-table-next-row' or `newline-and-indent', depending on
18563 context. See the individual commands for more information."
18564 (interactive)
18565 (org-return t))
18567 (defun org-ctrl-c-star ()
18568 "Compute table, or change heading status of lines.
18569 Calls `org-table-recalculate' or `org-toggle-heading',
18570 depending on context."
18571 (interactive)
18572 (cond
18573 ((org-at-table-p)
18574 (call-interactively 'org-table-recalculate))
18575 (t
18576 ;; Convert all lines in region to list items
18577 (call-interactively 'org-toggle-heading))))
18579 (defun org-ctrl-c-minus ()
18580 "Insert separator line in table or modify bullet status of line.
18581 Also turns a plain line or a region of lines into list items.
18582 Calls `org-table-insert-hline', `org-toggle-item', or
18583 `org-cycle-list-bullet', depending on context."
18584 (interactive)
18585 (cond
18586 ((org-at-table-p)
18587 (call-interactively 'org-table-insert-hline))
18588 ((org-region-active-p)
18589 (call-interactively 'org-toggle-item))
18590 ((org-in-item-p)
18591 (call-interactively 'org-cycle-list-bullet))
18592 (t
18593 (call-interactively 'org-toggle-item))))
18595 (defun org-toggle-item (arg)
18596 "Convert headings or normal lines to items, items to normal lines.
18597 If there is no active region, only the current line is considered.
18599 If the first non blank line in the region is an headline, convert
18600 all headlines to items, shifting text accordingly.
18602 If it is an item, convert all items to normal lines.
18604 If it is normal text, change region into an item. With a prefix
18605 argument ARG, change each line in region into an item."
18606 (interactive "P")
18607 (let ((shift-text
18608 (function
18609 ;; Shift text in current section to IND, from point to END.
18610 ;; The function leaves point to END line.
18611 (lambda (ind end)
18612 (let ((min-i 1000) (end (copy-marker end)))
18613 ;; First determine the minimum indentation (MIN-I) of
18614 ;; the text.
18615 (save-excursion
18616 (catch 'exit
18617 (while (< (point) end)
18618 (let ((i (org-get-indentation)))
18619 (cond
18620 ;; Skip blank lines and inline tasks.
18622 ((looking-at org-outline-regexp-bol))
18623 ;; We can't find less than 0 indentation.
18624 ((zerop i) (throw 'exit (setq min-i 0)))
18625 ((< i min-i) (setq min-i i))))
18626 (forward-line))))
18627 ;; Then indent each line so that a line indented to
18628 ;; MIN-I becomes indented to IND. Ignore blank lines
18629 ;; and inline tasks in the process.
18630 (let ((delta (- ind min-i)))
18631 (while (< (point) end)
18633 (looking-at org-outline-regexp-bol))
18634 (org-indent-line-to (+ (org-get-indentation) delta)))
18635 (forward-line)))))))
18636 (skip-blanks
18637 (function
18638 ;; Return beginning of first non-blank line, starting from
18639 ;; line at POS.
18640 (lambda (pos)
18641 (save-excursion
18642 (goto-char pos)
18644 (point-at-bol)))))
18645 beg end)
18646 ;; Determine boundaries of changes.
18647 (if (org-region-active-p)
18648 (setq beg (funcall skip-blanks (region-beginning))
18649 end (copy-marker (region-end)))
18650 (setq beg (funcall skip-blanks (point-at-bol))
18651 end (copy-marker (point-at-eol))))
18652 ;; Depending on the starting line, choose an action on the text
18653 ;; between BEG and END.
18654 (org-with-limited-levels
18655 (save-excursion
18656 (goto-char beg)
18657 (cond
18658 ;; Case 1. Start at an item: de-itemize. Note that it only
18659 ;; happens when a region is active: `org-ctrl-c-minus'
18660 ;; would call `org-cycle-list-bullet' otherwise.
18661 ((org-at-item-p)
18662 (while (< (point) end)
18663 (when (org-at-item-p)
18665 (delete-region (point) (match-end 0)))
18666 (forward-line)))
18667 ;; Case 2. Start at an heading: convert to items.
18668 ((org-at-heading-p)
18669 (let* ((bul (org-list-bullet-string "-"))
18670 (bul-len (length bul))
18671 ;; Indentation of the first heading. It should be
18672 ;; relative to the indentation of its parent, if any.
18673 (start-ind (save-excursion
18674 (cond
18675 ((not org-adapt-indentation) 0)
18676 ((not (outline-previous-heading)) 0)
18677 (t (length (match-string 0))))))
18678 ;; Level of first heading. Further headings will be
18679 ;; compared to it to determine hierarchy in the list.
18680 (ref-level (org-reduced-level (org-outline-level))))
18681 (while (< (point) end)
18682 (let* ((level (org-reduced-level (org-outline-level)))
18683 (delta (max 0 (- level ref-level))))
18684 ;; If current headline is less indented than the first
18685 ;; one, set it as reference, in order to preserve
18686 ;; subtrees.
18687 (when (< level ref-level) (setq ref-level level))
18688 (replace-match bul t t)
18689 (org-indent-line-to (+ start-ind (* delta bul-len)))
18690 ;; Ensure all text down to END (or SECTION-END) belongs
18691 ;; to the newly created item.
18692 (let ((section-end (save-excursion
18693 (or (outline-next-heading) (point)))))
18694 (forward-line)
18695 (funcall shift-text
18696 (+ start-ind (* (1+ delta) bul-len))
18697 (min end section-end)))))))
18698 ;; Case 3. Normal line with ARG: turn each non-item line into
18699 ;; an item.
18700 (arg
18701 (while (< (point) end)
18702 (unless (or (org-at-heading-p) (org-at-item-p))
18704 (replace-match
18706 (forward-line)))
18707 ;; Case 4. Normal line without ARG: make the first line of
18708 ;; region an item, and shift indentation of others
18709 ;; lines to set them as item's body.
18710 (t (let* ((bul (org-list-bullet-string "-"))
18711 (bul-len (length bul))
18712 (ref-ind (org-get-indentation)))
18714 (insert bul)
18715 (forward-line)
18716 (while (< (point) end)
18717 ;; Ensure that lines less indented than first one
18718 ;; still get included in item body.
18719 (funcall shift-text
18720 (+ ref-ind bul-len)
18721 (min end (save-excursion (or (outline-next-heading)
18722 (point)))))
18723 (forward-line)))))))))
18725 (defun org-toggle-heading (&optional nstars)
18726 "Convert headings to normal text, or items or text to headings.
18727 If there is no active region, only the current line is considered.
18729 If the first non blank line is an headline, remove the stars from
18730 all headlines in the region.
18732 If it is a plain list item, turn all plain list items into headings.
18734 If it is a normal line, turn each and every normal line (i.e. not
18735 an heading or an item) in the region into a heading.
18737 When converting a line into a heading, the number of stars is chosen
18738 such that the lines become children of the current entry. However,
18739 when a prefix argument is given, its value determines the number of
18740 stars to add."
18741 (interactive "P")
18742 (let ((skip-blanks
18743 (function
18744 ;; Return beginning of first non-blank line, starting from
18745 ;; line at POS.
18746 (lambda (pos)
18747 (save-excursion
18748 (goto-char pos)
18750 (point-at-bol)))))
18751 beg end)
18752 ;; Determine boundaries of changes. If region ends at a bol, do
18753 ;; not consider the last line to be in the region.
18754 (if (org-region-active-p)
18755 (setq beg (funcall skip-blanks (region-beginning))
18756 end (copy-marker (save-excursion
18757 (goto-char (region-end))
18758 (if (bolp) (point) (point-at-eol)))))
18759 (setq beg (funcall skip-blanks (point-at-bol))
18760 end (copy-marker (point-at-eol))))
18761 ;; Ensure inline tasks don't count as headings.
18762 (org-with-limited-levels
18763 (save-excursion
18764 (goto-char beg)
18765 (cond
18766 ;; Case 1. Started at an heading: de-star headings.
18767 ((org-at-heading-p)
18768 (while (< (point) end)
18769 (when (org-at-heading-p t)
18770 (looking-at org-outline-regexp) (replace-match ""))
18771 (forward-line)))
18772 ;; Case 2. Started at an item: change items into headlines.
18773 ;; One star will be added by `org-list-to-subtree'.
18774 ((org-at-item-p)
18775 (let* ((stars (make-string
18776 (if nstars
18777 ;; subtract the star that will be added again by
18778 ;; `org-list-to-subtree'
18779 (1- (prefix-numeric-value current-prefix-arg))
18780 (or (org-current-level) 0))
18781 ?*))
18782 (add-stars
18783 (cond (nstars "") ; stars from prefix only
18784 ((equal stars "") "") ; before first heading
18785 (org-odd-levels-only "*") ; inside heading, odd
18786 (t "")))) ; inside heading, oddeven
18787 (while (< (point) end)
18788 (when (org-at-item-p)
18789 ;; Pay attention to cases when region ends before list.
18790 (let* ((struct (org-list-struct))
18791 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18792 (save-restriction
18793 (narrow-to-region (point) list-end)
18794 (insert
18795 (org-list-to-subtree
18796 (org-list-parse-list t)
18797 '(:istart (concat stars add-stars (funcall get-stars depth))
18798 :icount (concat stars add-stars (funcall get-stars depth))))))))
18799 (forward-line))))
18800 ;; Case 3. Started at normal text: make every line an heading,
18801 ;; skipping headlines and items.
18802 (t (let* ((stars (make-string
18803 (if nstars
18804 (prefix-numeric-value current-prefix-arg)
18805 (or (org-current-level) 0))
18806 ?*))
18807 (add-stars
18808 (cond (nstars "") ; stars from prefix only
18809 ((equal stars "") "*") ; before first heading
18810 (org-odd-levels-only "**") ; inside heading, odd
18811 (t "*"))) ; inside heading, oddeven
18812 (rpl (concat stars add-stars " ")))
18813 (while (< (point) end)
18814 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18816 (replace-match (concat rpl (match-string 2))))
18817 (forward-line)))))))))
18819 (defun org-meta-return (&optional arg)
18820 "Insert a new heading or wrap a region in a table.
18821 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18822 See the individual commands for more information."
18823 (interactive "P")
18824 (cond
18825 ((run-hook-with-args-until-success 'org-metareturn-hook))
18826 ((org-at-table-p)
18827 (call-interactively 'org-table-wrap-region))
18828 (t (call-interactively 'org-insert-heading))))
18830 ;;; Menu entries
18832 ;; Define the Org-mode menus
18833 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18834 '("Tbl"
18835 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18836 ["Next Field" org-cycle (org-at-table-p)]
18837 ["Previous Field" org-shifttab (org-at-table-p)]
18838 ["Next Row" org-return (org-at-table-p)]
18839 "--"
18840 ["Blank Field" org-table-blank-field (org-at-table-p)]
18841 ["Edit Field" org-table-edit-field (org-at-table-p)]
18842 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18843 "--"
18844 ("Column"
18845 ["Move Column Left" org-metaleft (org-at-table-p)]
18846 ["Move Column Right" org-metaright (org-at-table-p)]
18847 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18848 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18849 ("Row"
18850 ["Move Row Up" org-metaup (org-at-table-p)]
18851 ["Move Row Down" org-metadown (org-at-table-p)]
18852 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18853 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18854 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18855 "--"
18856 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18857 ("Rectangle"
18858 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18859 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18860 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18861 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18862 "--"
18863 ("Calculate"
18864 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18865 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18866 ["Edit Formulas" org-edit-special (org-at-table-p)]
18867 "--"
18868 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18869 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18870 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18871 "--"
18872 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18873 "--"
18874 ["Sum Column/Rectangle" org-table-sum
18875 (or (org-at-table-p) (org-region-active-p))]
18876 ["Which Column?" org-table-current-column (org-at-table-p)])
18877 ["Debug Formulas"
18878 org-table-toggle-formula-debugger
18879 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18880 ["Show Col/Row Numbers"
18881 org-table-toggle-coordinate-overlays
18882 :style toggle
18883 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18884 "--"
18885 ["Create" org-table-create (and (not (org-at-table-p))
18886 org-enable-table-editor)]
18887 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18888 ["Import from File" org-table-import (not (org-at-table-p))]
18889 ["Export to File" org-table-export (org-at-table-p)]
18890 "--"
18891 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18893 (easy-menu-define org-org-menu org-mode-map "Org menu"
18894 '("Org"
18895 ("Show/Hide"
18896 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18897 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18898 ["Sparse Tree..." org-sparse-tree t]
18899 ["Reveal Context" org-reveal t]
18900 ["Show All" show-all t]
18901 "--"
18902 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18903 "--"
18904 ["New Heading" org-insert-heading t]
18905 ("Navigate Headings"
18906 ["Up" outline-up-heading t]
18907 ["Next" outline-next-visible-heading t]
18908 ["Previous" outline-previous-visible-heading t]
18909 ["Next Same Level" outline-forward-same-level t]
18910 ["Previous Same Level" outline-backward-same-level t]
18911 "--"
18912 ["Jump" org-goto t])
18913 ("Edit Structure"
18914 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18915 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18916 "--"
18917 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18918 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18919 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18920 "--"
18921 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18922 "--"
18923 ["Copy visible text" org-copy-visible t]
18924 "--"
18925 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18926 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18927 ["Demote Heading" org-metaright (not (org-at-table-p))]
18928 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18929 "--"
18930 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18931 "--"
18932 ["Convert to odd levels" org-convert-to-odd-levels t]
18933 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18934 ("Editing"
18935 ["Emphasis..." org-emphasize t]
18936 ["Edit Source Example" org-edit-special t]
18937 "--"
18938 ["Footnote new/jump" org-footnote-action t]
18939 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18940 ("Archive"
18941 ["Archive (default method)" org-archive-subtree-default t]
18942 "--"
18943 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18944 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18945 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18946 )
18947 "--"
18948 ("Hyperlinks"
18949 ["Store Link (Global)" org-store-link t]
18950 ["Find existing link to here" org-occur-link-in-agenda-files t]
18951 ["Insert Link" org-insert-link t]
18952 ["Follow Link" org-open-at-point t]
18953 "--"
18954 ["Next link" org-next-link t]
18955 ["Previous link" org-previous-link t]
18956 "--"
18957 ["Descriptive Links"
18958 org-toggle-link-display
18959 :style radio
18960 :selected org-descriptive-links
18961 ]
18962 ["Literal Links"
18963 org-toggle-link-display
18964 :style radio
18965 :selected (not org-descriptive-links)])
18966 "--"
18967 ("TODO Lists"
18968 ["TODO/DONE/-" org-todo t]
18969 ("Select keyword"
18970 ["Next keyword" org-shiftright (org-at-heading-p)]
18971 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18972 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18973 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18974 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18975 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18976 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18977 "--"
18978 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18979 :selected org-enforce-todo-dependencies :style toggle :active t]
18980 "Settings for tree at point"
18981 ["Do Children sequentially" org-toggle-ordered-property :style radio
18982 :selected (org-entry-get nil "ORDERED")
18983 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18984 ["Do Children parallel" org-toggle-ordered-property :style radio
18985 :selected (not (org-entry-get nil "ORDERED"))
18986 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18987 "--"
18988 ["Set Priority" org-priority t]
18989 ["Priority Up" org-shiftup t]
18990 ["Priority Down" org-shiftdown t]
18991 "--"
18992 ["Get news from all feeds" org-feed-update-all t]
18993 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18994 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18995 ("TAGS and Properties"
18996 ["Set Tags" org-set-tags-command t]
18997 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18998 "--"
18999 ["Set property" org-set-property t]
19000 ["Column view of properties" org-columns t]
19001 ["Insert Column View DBlock" org-insert-columns-dblock t])
19002 ("Dates and Scheduling"
19003 ["Timestamp" org-time-stamp t]
19004 ["Timestamp (inactive)" org-time-stamp-inactive t]
19005 ("Change Date"
19006 ["1 Day Later" org-shiftright t]
19007 ["1 Day Earlier" org-shiftleft t]
19008 ["1 ... Later" org-shiftup t]
19009 ["1 ... Earlier" org-shiftdown t])
19010 ["Compute Time Range" org-evaluate-time-range t]
19011 ["Schedule Item" org-schedule t]
19012 ["Deadline" org-deadline t]
19013 "--"
19014 ["Custom time format" org-toggle-time-stamp-overlays
19015 :style radio :selected org-display-custom-times]
19016 "--"
19017 ["Goto Calendar" org-goto-calendar t]
19018 ["Date from Calendar" org-date-from-calendar t]
19019 "--"
19020 ["Start/Restart Timer" org-timer-start t]
19021 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19022 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19023 ["Insert Timer String" org-timer t]
19024 ["Insert Timer Item" org-timer-item t])
19025 ("Logging work"
19026 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19027 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19028 ["Clock out" org-clock-out t]
19029 ["Clock cancel" org-clock-cancel t]
19030 "--"
19031 ["Mark as default task" org-clock-mark-default-task t]
19032 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19033 ["Goto running clock" org-clock-goto t]
19034 "--"
19035 ["Display times" org-clock-display t]
19036 ["Create clock table" org-clock-report t]
19037 "--"
19038 ["Record DONE time"
19039 (progn (setq org-log-done (not org-log-done))
19040 (message "Switching to %s will %s record a timestamp"
19041 (car org-done-keywords)
19042 (if org-log-done "automatically" "not")))
19043 :style toggle :selected org-log-done])
19044 "--"
19045 ["Agenda Command..." org-agenda t]
19046 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19047 ("File List for Agenda")
19048 ("Special views current file"
19049 ["TODO Tree" org-show-todo-tree t]
19050 ["Check Deadlines" org-check-deadlines t]
19051 ["Timeline" org-timeline t]
19052 ["Tags/Property tree" org-match-sparse-tree t])
19053 "--"
19054 ["Export/Publish..." org-export t]
19055 ("LaTeX"
19056 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19057 :selected org-cdlatex-mode]
19058 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19059 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19060 ["Modify math symbol" org-cdlatex-math-modify
19061 (org-inside-LaTeX-fragment-p)]
19062 ["Insert citation" org-reftex-citation t]
19063 "--"
19064 ["Template for BEAMER" org-insert-beamer-options-template t])
19065 "--"
19066 ("MobileOrg"
19067 ["Push Files and Views" org-mobile-push t]
19068 ["Get Captured and Flagged" org-mobile-pull t]
19069 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19070 "--"
19071 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19072 "--"
19073 ("Documentation"
19074 ["Show Version" org-version t]
19075 ["Info Documentation" org-info t])
19076 ("Customize"
19077 ["Browse Org Group" org-customize t]
19078 "--"
19079 ["Expand This Menu" org-create-customize-menu
19080 (fboundp 'customize-menu-create)])
19081 ["Send bug report" org-submit-bug-report t]
19082 "--"
19083 ("Refresh/Reload"
19084 ["Refresh setup current buffer" org-mode-restart t]
19085 ["Reload Org (after update)" org-reload t]
19086 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19087 ))
19089 (defun org-info (&optional node)
19090 "Read documentation for Org-mode in the info system.
19091 With optional NODE, go directly to that node."
19092 (interactive)
19093 (info (format "(org)%s" (or node ""))))
19095 ;;;###autoload
19096 (defun org-submit-bug-report ()
19097 "Submit a bug report on Org-mode via mail.
19099 Don't hesitate to report any problems or inaccurate documentation.
19101 If you don't have setup sending mail from (X)Emacs, please copy the
19102 output buffer into your mail program, as it gives us important
19103 information about your Org-mode version and configuration."
19104 (interactive)
19105 (require 'reporter)
19106 (org-load-modules-maybe)
19107 (org-require-autoloaded-modules)
19108 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19109 (reporter-submit-bug-report
19110 "emacs-orgmode@gnu.org"
19111 (org-version)
19112 (let (list)
19113 (save-window-excursion
19114 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19115 (delete-other-windows)
19116 (erase-buffer)
19117 (insert "You are about to submit a bug report to the Org-mode mailing list.
19119 We would like to add your full Org-mode and Outline configuration to the
19120 bug report. This greatly simplifies the work of the maintainer and
19121 other experts on the mailing list.
19123 HOWEVER, some variables you have customized may contain private
19124 information. The names of customers, colleagues, or friends, might
19125 appear in the form of file names, tags, todo states, or search strings.
19126 If you answer yes to the prompt, you might want to check and remove
19127 such private information before sending the email.")
19128 (add-text-properties (point-min) (point-max) '(face org-warning))
19129 (when (yes-or-no-p "Include your Org-mode configuration ")
19130 (mapatoms
19131 (lambda (v)
19132 (and (boundp v)
19134 (or (and (symbol-value v)
19136 (and
19137 (get v 'custom-type) (get v 'standard-value)
19138 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19139 (push v list)))))
19140 (kill-buffer (get-buffer "*Warn about privacy*"))
19141 list))
19142 nil nil
19143 "Remember to cover the basics, that is, what you expected to happen and
19144 what in fact did happen. You don't know how to make a good report? See
19146 http://orgmode.org/manual/Feedback.html#Feedback
19148 Your bug report will be posted to the Org-mode mailing list.
19149 ------------------------------------------------------------------------")
19150 (save-excursion
19155 (defun org-install-agenda-files-menu ()
19156 (let ((bl (buffer-list)))
19157 (save-excursion
19158 (while bl
19159 (set-buffer (pop bl))
19160 (if (eq major-mode 'org-mode) (setq bl nil)))
19161 (when (eq major-mode 'org-mode)
19162 (easy-menu-change
19163 '("Org") "File List for Agenda"
19164 (append
19165 (list
19166 ["Edit File List" (org-edit-agenda-file-list) t]
19167 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19168 ["Remove Current File from List" org-remove-file t]
19169 ["Cycle through agenda files" org-cycle-agenda-files t]
19170 ["Occur in all agenda files" org-occur-in-agenda-files t]
19171 "--")
19172 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19174 ;;;; Documentation
19176 ;;;###autoload
19177 (defun org-require-autoloaded-modules ()
19178 (interactive)
19179 (mapc 'require
19180 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19181 org-docbook org-exp org-html org-icalendar
19182 org-id org-latex
19183 org-publish org-remember org-table
19184 org-timer org-xoxo)))
19186 ;;;###autoload
19187 (defun org-reload (&optional uncompiled)
19188 "Reload all org lisp files.
19189 With prefix arg UNCOMPILED, load the uncompiled versions."
19190 (interactive "P")
19191 (require 'find-func)
19193 (dir-org (file-name-directory (org-find-library-name "org")))
19194 (dir-org-contrib (ignore-errors
19195 (file-name-directory
19196 (org-find-library-name "org-contribdir"))))
19197 (babel-files
19198 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19199 (append (list nil "comint" "eval" "exp" "keys"
19200 "lob" "ref" "table" "tangle")
19201 (delq nil
19202 (mapcar
19203 (lambda (lang)
19204 (when (cdr lang) (symbol-name (car lang))))
19205 org-babel-load-languages)))))
19206 (files
19207 (append (directory-files dir-org t file-re)
19208 babel-files
19209 (and dir-org-contrib
19210 (directory-files dir-org-contrib t file-re))))
19211 (remove-re (concat (if (featurep 'xemacs)
19212 "org-colview" "org-colview-xemacs")
19214 (setq files (mapcar 'file-name-sans-extension files))
19215 (setq files (mapcar
19216 (lambda (x) (if (string-match remove-re x) nil x))
19217 files))
19218 (setq files (delq nil files))
19219 (mapc
19220 (lambda (f)
19221 (when (featurep (intern (file-name-nondirectory f)))
19222 (if (and (not uncompiled)
19223 (file-exists-p (concat f ".elc")))
19224 (load (concat f ".elc") nil nil t)
19225 (load (concat f ".el") nil nil t))))
19226 files))
19227 (org-version))
19229 ;;;###autoload
19230 (defun org-customize ()
19231 "Call the customize function with org as argument."
19232 (interactive)
19233 (org-load-modules-maybe)
19234 (org-require-autoloaded-modules)
19235 (customize-browse 'org))
19237 (defun org-create-customize-menu ()
19238 "Create a full customization menu for Org-mode, insert it into the menu."
19239 (interactive)
19240 (org-load-modules-maybe)
19241 (org-require-autoloaded-modules)
19242 (if (fboundp 'customize-menu-create)
19243 (progn
19244 (easy-menu-change
19245 '("Org") "Customize"
19246 `(["Browse Org group" org-customize t]
19247 "--"
19248 ,(customize-menu-create 'org)
19249 ["Set" Custom-set t]
19250 ["Save" Custom-save t]
19251 ["Reset to Current" Custom-reset-current t]
19252 ["Reset to Saved" Custom-reset-saved t]
19253 ["Reset to Standard Settings" Custom-reset-standard t]))
19255 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19257 ;;;; Miscellaneous stuff
19259 ;;; Generally useful functions
19261 (defun org-get-at-bol (property)
19262 "Get text property PROPERTY at beginning of line."
19263 (get-text-property (point-at-bol) property))
19265 (defun org-find-text-property-in-string (prop s)
19266 "Return the first non-nil value of property PROP in string S."
19267 (or (get-text-property 0 prop s)
19268 (get-text-property (or (next-single-property-change 0 prop s) 0)
19269 prop s)))
19271 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19272 "Display the given MESSAGE as a warning."
19273 (if (fboundp 'display-warning)
19274 (display-warning 'org message
19275 (if (featurep 'xemacs) 'warning :warning))
19276 (let ((buf (get-buffer-create "*Org warnings*")))
19277 (with-current-buffer buf
19278 (goto-char (point-max))
19279 (insert "Warning (Org): " message)
19280 (unless (bolp)
19281 (newline)))
19282 (display-buffer buf)
19283 (sit-for 0))))
19285 (defun org-eval (form)
19286 "Eval FORM and return result."
19287 (condition-case error
19288 (eval form)
19289 (error (format "%%![Error: %s]" error))))
19291 (defun org-in-clocktable-p ()
19292 "Check if the cursor is in a clocktable."
19293 (let ((pos (point)) start)
19294 (save-excursion
19295 (end-of-line 1)
19297 (setq start (match-beginning 0))
19299 (>= (match-end 0) pos)
19300 start))))
19302 (defun org-in-commented-line ()
19303 "Is point in a line starting with `#'?"
19304 (equal (char-after (point-at-bol)) ?#))
19306 (defun org-in-indented-comment-line ()
19307 "Is point in a line starting with `#' after some white space?"
19308 (save-excursion
19309 (save-match-data
19310 (goto-char (point-at-bol))
19313 (defun org-in-verbatim-emphasis ()
19314 (save-match-data
19315 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19317 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19318 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19319 (if (and marker (marker-buffer marker)
19320 (buffer-live-p (marker-buffer marker)))
19321 (progn
19322 (org-pop-to-buffer-same-window (marker-buffer marker))
19323 (if (or (> marker (point-max)) (< marker (point-min)))
19324 (widen))
19325 (goto-char marker)
19326 (org-show-context 'org-goto))
19327 (if bookmark
19328 (bookmark-jump bookmark)
19329 (error "Cannot find location"))))
19331 (defun org-quote-csv-field (s)
19332 "Quote field for inclusion in CSV material."
19335 s))
19337 (defun org-force-self-insert (N)
19338 "Needed to enforce self-insert under remapping."
19339 (interactive "p")
19340 (self-insert-command N))
19342 (defun org-string-width (s)
19343 "Compute width of string, ignoring invisible characters.
19344 This ignores character with invisibility property `org-link', and also
19345 characters with property `org-cwidth', because these will become invisible
19346 upon the next fontification round."
19347 (let (b l)
19348 (when (or (eq t buffer-invisibility-spec)
19349 (assq 'org-link buffer-invisibility-spec))
19350 (while (setq b (text-property-any 0 (length s)
19351 'invisible 'org-link s))
19352 (setq s (concat (substring s 0 b)
19353 (substring s (or (next-single-property-change
19354 b 'invisible s) (length s)))))))
19355 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19356 (setq s (concat (substring s 0 b)
19357 (substring s (or (next-single-property-change
19358 b 'org-cwidth s) (length s))))))
19359 (setq l (string-width s) b -1)
19360 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19361 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19362 l))
19364 (defun org-shorten-string (s maxlength)
19365 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19366 If the string is shorter or has length MAXLENGTH, just return the
19367 original string. If it is longer, the functions finds a space in the
19368 string, breaks this string off at that locations and adds three dots
19369 as ellipsis. Including the ellipsis, the string will not be longer
19370 than MAXLENGTH. If finding a good breaking point in the string does
19371 not work, the string is just chopped off in the middle of a word
19372 if necessary."
19373 (if (<= (length s) maxlength)
19374 s
19375 (let* ((n (max (- maxlength 4) 1))
19377 (if (string-match re s)
19378 (concat (match-string 1 s) "...")
19379 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19381 (defun org-get-indentation (&optional line)
19382 "Get the indentation of the current line, interpreting tabs.
19383 When LINE is given, assume it represents a line and compute its indentation."
19384 (if line
19385 (if (string-match "^ *" (org-remove-tabs line))
19386 (match-end 0))
19387 (save-excursion
19388 (beginning-of-line 1)
19390 (current-column))))
19392 (defun org-get-string-indentation (s)
19393 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19394 (let ((n -1) (i 0) (w tab-width) c)
19395 (catch 'exit
19396 (while (< (setq n (1+ n)) (length s))
19397 (setq c (aref s n))
19398 (cond ((= c ?\ ) (setq i (1+ i)))
19400 (t (throw 'exit t)))))
19401 i))
19403 (defun org-remove-tabs (s &optional width)
19404 "Replace tabulators in S with spaces.
19405 Assumes that s is a single line, starting in column 0."
19406 (setq width (or width tab-width))
19408 (setq s (replace-match
19409 (make-string
19410 (- (* width (/ (+ (match-beginning 0) width) width))
19411 (match-beginning 0)) ?\ )
19412 t t s)))
19413 s)
19415 (defun org-fix-indentation (line ind)
19416 "Fix indentation in LINE.
19417 IND is a cons cell with target and minimum indentation.
19418 If the current indentation in LINE is smaller than the minimum,
19419 leave it alone. If it is larger than ind, set it to the target."
19420 (let* ((l (org-remove-tabs line))
19421 (i (org-get-indentation l))
19422 (i1 (car ind)) (i2 (cdr ind)))
19423 (if (>= i i2) (setq l (substring line i2)))
19424 (if (> i1 0)
19425 (concat (make-string i1 ?\ ) l)
19426 l)))
19428 (defun org-remove-indentation (code &optional n)
19429 "Remove the maximum common indentation from the lines in CODE.
19430 N may optionally be the number of spaces to remove."
19431 (with-temp-buffer
19432 (insert code)
19433 (org-do-remove-indentation n)
19434 (buffer-string)))
19436 (defun org-do-remove-indentation (&optional n)
19437 "Remove the maximum common indentation from the buffer."
19438 (untabify (point-min) (point-max))
19439 (let ((min 10000) re)
19440 (if n
19441 (setq min n)
19442 (goto-char (point-min))
19444 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19445 (unless (or (= min 0) (= min 10000))
19447 (goto-char (point-min))
19448 (while (re-search-forward re nil t)
19449 (replace-match "")
19450 (end-of-line 1))
19451 min)))
19453 (defun org-fill-template (template alist)
19454 "Find each %key of ALIST in TEMPLATE and replace it."
19455 (let ((case-fold-search nil)
19456 entry key value)
19457 (setq alist (sort (copy-sequence alist)
19458 (lambda (a b) (< (length (car a)) (length (car b))))))
19459 (while (setq entry (pop alist))
19460 (setq template
19461 (replace-regexp-in-string
19462 (concat "%" (regexp-quote (car entry)))
19463 (cdr entry) template t t)))
19464 template))
19466 (defun org-base-buffer (buffer)
19467 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19468 (if (not buffer)
19469 buffer
19470 (or (buffer-base-buffer buffer)
19471 buffer)))
19473 (defun org-trim (s)
19474 "Remove whitespace at beginning and end of string."
19477 s)
19479 (defun org-wrap (string &optional width lines)
19480 "Wrap string to either a number of lines, or a width in characters.
19481 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19482 that costs. If there is a word longer than WIDTH, the text is actually
19483 wrapped to the length of that word.
19484 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19485 many lines, whatever width that takes.
19486 The return value is a list of lines, without newlines at the end."
19488 (maxword (apply 'max (mapcar 'org-string-width words)))
19489 w ll)
19490 (cond (width
19491 (org-do-wrap words (max maxword width)))
19492 (lines
19493 (setq w maxword)
19494 (setq ll (org-do-wrap words maxword))
19495 (if (<= (length ll) lines)
19496 ll
19497 (setq ll words)
19498 (while (> (length ll) lines)
19499 (setq w (1+ w))
19500 (setq ll (org-do-wrap words w)))
19501 ll))
19502 (t (error "Cannot wrap this")))))
19504 (defun org-do-wrap (words width)
19505 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19506 (let (lines line)
19507 (while words
19508 (setq line (pop words))
19509 (while (and words (< (+ (length line) (length (car words))) width))
19510 (setq line (concat line " " (pop words))))
19511 (setq lines (push line lines)))
19512 (nreverse lines)))
19514 (defun org-split-string (string &optional separators)
19515 "Splits STRING into substrings at SEPARATORS.
19516 No empty strings are returned if there are matches at the beginning
19517 and end of string."
19519 (start 0)
19520 notfirst
19521 (list nil))
19522 (while (and (string-match rexp string
19523 (if (and notfirst
19524 (= start (match-beginning 0))
19525 (< start (length string)))
19526 (1+ start) start))
19527 (< (match-beginning 0) (length string)))
19528 (setq notfirst t)
19529 (or (eq (match-beginning 0) 0)
19530 (and (eq (match-beginning 0) (match-end 0))
19531 (eq (match-beginning 0) start))
19532 (setq list
19533 (cons (substring string start (match-beginning 0))
19534 list)))
19535 (setq start (match-end 0)))
19536 (or (eq start (length string))
19537 (setq list
19538 (cons (substring string start)
19539 list)))
19540 (nreverse list)))
19542 (defun org-quote-vert (s)
19544 (while (string-match "|" s)
19546 s)
19548 (defun org-uuidgen-p (s)
19549 "Is S an ID created by UUIDGEN?"
19550 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19552 (defun org-context ()
19553 "Return a list of contexts of the current cursor position.
19554 If several contexts apply, all are returned.
19555 Each context entry is a list with a symbol naming the context, and
19556 two positions indicating start and end of the context. Possible
19557 contexts are:
19559 :headline anywhere in a headline
19560 :headline-stars on the leading stars in a headline
19561 :todo-keyword on a TODO keyword (including DONE) in a headline
19562 :tags on the TAGS in a headline
19563 :priority on the priority cookie in a headline
19564 :item on the first line of a plain list item
19565 :item-bullet on the bullet/number of a plain list item
19566 :checkbox on the checkbox in a plain list item
19567 :table in an org-mode table
19568 :table-special on a special filed in a table
19569 :table-table in a table.el table
19570 :link on a hyperlink
19571 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19572 :target on a <<target>>
19573 :radio-target on a <<<radio-target>>>
19574 :latex-fragment on a LaTeX fragment
19575 :latex-preview on a LaTeX fragment with overlaid preview image
19577 This function expects the position to be visible because it uses font-lock
19578 faces as a help to recognize the following contexts: :table-special, :link,
19579 and :keyword."
19580 (let* ((f (get-text-property (point) 'face))
19581 (faces (if (listp f) f (list f)))
19582 (p (point)) clist o)
19583 ;; First the large context
19584 (cond
19585 ((org-at-heading-p t)
19586 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19587 (when (progn
19588 (beginning-of-line 1)
19589 (looking-at org-todo-line-tags-regexp))
19590 (push (org-point-in-group p 1 :headline-stars) clist)
19591 (push (org-point-in-group p 2 :todo-keyword) clist)
19592 (push (org-point-in-group p 4 :tags) clist))
19593 (goto-char p)
19596 (push (org-point-in-group p 0 :priority) clist)))
19598 ((org-at-item-p)
19599 (push (org-point-in-group p 2 :item-bullet) clist)
19600 (push (list :item (point-at-bol)
19601 (save-excursion (org-end-of-item) (point)))
19602 clist)
19603 (and (org-at-item-checkbox-p)
19604 (push (org-point-in-group p 0 :checkbox) clist)))
19606 ((org-at-table-p)
19607 (push (list :table (org-table-begin) (org-table-end)) clist)
19608 (if (memq 'org-formula faces)
19609 (push (list :table-special
19610 (previous-single-property-change p 'face)
19611 (next-single-property-change p 'face)) clist)))
19612 ((org-at-table-p 'any)
19613 (push (list :table-table) clist)))
19614 (goto-char p)
19616 ;; Now the small context
19617 (cond
19618 ((org-at-timestamp-p)
19619 (push (org-point-in-group p 0 :timestamp) clist))
19620 ((memq 'org-link faces)
19621 (push (list :link
19622 (previous-single-property-change p 'face)
19623 (next-single-property-change p 'face)) clist))
19624 ((memq 'org-special-keyword faces)
19625 (push (list :keyword
19626 (previous-single-property-change p 'face)
19627 (next-single-property-change p 'face)) clist))
19628 ((org-at-target-p)
19629 (push (org-point-in-group p 0 :target) clist)
19630 (goto-char (1- (match-beginning 0)))
19631 (if (looking-at org-radio-target-regexp)
19632 (push (org-point-in-group p 0 :radio-target) clist))
19633 (goto-char p))
19634 ((setq o (car (delq nil
19635 (mapcar
19636 (lambda (x)
19637 (if (memq x org-latex-fragment-image-overlays) x))
19638 (overlays-at (point))))))
19639 (push (list :latex-fragment
19640 (overlay-start o) (overlay-end o)) clist)
19641 (push (list :latex-preview
19642 (overlay-start o) (overlay-end o)) clist))
19643 ((org-inside-LaTeX-fragment-p)
19644 ;; FIXME: positions wrong.
19645 (push (list :latex-fragment (point) (point)) clist)))
19647 (setq clist (nreverse (delq nil clist)))
19648 clist))
19650 ;; FIXME: Compare with at-regexp-p Do we need both?
19651 (defun org-in-regexp (re &optional nlines visually)
19652 "Check if point is inside a match of regexp.
19653 Normally only the current line is checked, but you can include NLINES extra
19654 lines both before and after point into the search.
19655 If VISUALLY is set, require that the cursor is not after the match but
19656 really on, so that the block visually is on the match."
19657 (catch 'exit
19658 (let ((pos (point))
19659 (eol (point-at-eol (+ 1 (or nlines 0))))
19660 (inc (if visually 1 0)))
19661 (save-excursion
19662 (beginning-of-line (- 1 (or nlines 0)))
19663 (while (re-search-forward re eol t)
19664 (if (and (<= (match-beginning 0) pos)
19665 (>= (+ inc (match-end 0)) pos))
19666 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19668 (defun org-at-regexp-p (regexp)
19669 "Is point inside a match of REGEXP in the current line?"
19670 (catch 'exit
19671 (save-excursion
19672 (let ((pos (point)) (end (point-at-eol)))
19673 (beginning-of-line 1)
19674 (while (re-search-forward regexp end t)
19675 (if (and (<= (match-beginning 0) pos)
19676 (>= (match-end 0) pos))
19677 (throw 'exit t)))
19678 nil))))
19680 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19681 "Non-nil when point is between matches of START-RE and END-RE.
19683 Also return a non-nil value when point is on one of the matches.
19685 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19686 buffer positions. Default values are the positions of headlines
19687 surrounding the point.
19689 The functions returns a cons cell whose car (resp. cdr) is the
19690 position before START-RE (resp. after END-RE)."
19691 (save-match-data
19692 (let ((pos (point))
19693 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19694 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19695 beg end)
19696 (save-excursion
19697 ;; Point is on a block when on START-RE or if START-RE can be
19698 ;; found before it...
19699 (and (or (org-at-regexp-p start-re)
19700 (re-search-backward start-re limit-up t))
19701 (setq beg (match-beginning 0))
19702 ;; ... and END-RE after it...
19703 (goto-char (match-end 0))
19704 (re-search-forward end-re limit-down t)
19705 (> (setq end (match-end 0)) pos)
19706 ;; ... without another START-RE in-between.
19707 (goto-char (match-beginning 0))
19708 (not (re-search-backward start-re (1+ beg) t))
19709 ;; Return value.
19710 (cons beg end))))))
19712 (defun org-in-block-p (names)
19713 "Non-nil when point belongs to a block whose name belongs to NAMES.
19715 NAMES is a list of strings containing names of blocks.
19717 Return first block name matched, or nil. Beware that in case of
19718 nested blocks, the returned name may not belong to the closest
19719 block from point."
19720 (save-match-data
19721 (catch 'exit
19722 (let ((case-fold-search t)
19723 (lim-up (save-excursion (outline-previous-heading)))
19724 (lim-down (save-excursion (outline-next-heading))))
19725 (mapc (lambda (name)
19726 (let ((n (regexp-quote name)))
19727 (when (org-between-regexps-p
19730 lim-up lim-down)
19731 (throw 'exit n))))
19732 names))
19733 nil)))
19735 (defun org-occur-in-agenda-files (regexp &optional nlines)
19736 "Call `multi-occur' with buffers for all agenda files."
19738 (let* ((files (org-agenda-files))
19739 (tnames (mapcar 'file-truename files))
19740 (extra org-agenda-text-search-extra-files)
19741 f)
19742 (when (eq (car extra) 'agenda-archives)
19743 (setq extra (cdr extra))
19744 (setq files (org-add-archive-files files)))
19745 (while (setq f (pop extra))
19746 (unless (member (file-truename f) tnames)
19747 (add-to-list 'files f 'append)
19748 (add-to-list 'tnames (file-truename f) 'append)))
19749 (multi-occur
19750 (mapcar (lambda (x)
19751 (with-current-buffer
19752 (or (get-file-buffer x) (find-file-noselect x))
19753 (widen)
19754 (current-buffer)))
19755 files)
19756 regexp)))
19758 (if (boundp 'occur-mode-find-occurrence-hook)
19759 ;; Emacs 23
19760 (add-hook 'occur-mode-find-occurrence-hook
19761 (lambda ()
19762 (when (eq major-mode 'org-mode)
19763 (org-reveal))))
19764 ;; Emacs 22
19765 (defadvice occur-mode-goto-occurrence
19766 (after org-occur-reveal activate)
19767 (and (eq major-mode 'org-mode) (org-reveal)))
19768 (defadvice occur-mode-goto-occurrence-other-window
19769 (after org-occur-reveal activate)
19770 (and (eq major-mode 'org-mode) (org-reveal)))
19771 (defadvice occur-mode-display-occurrence
19772 (after org-occur-reveal activate)
19773 (when (eq major-mode 'org-mode)
19774 (let ((pos (occur-mode-find-occurrence)))
19775 (with-current-buffer (marker-buffer pos)
19776 (save-excursion
19777 (goto-char pos)
19778 (org-reveal)))))))
19780 (defun org-occur-link-in-agenda-files ()
19781 "Create a link and search for it in the agendas.
19782 The link is not stored in `org-stored-links', it is just created
19783 for the search purpose."
19784 (interactive)
19785 (let ((link (condition-case nil
19786 (org-store-link nil)
19787 (error "Unable to create a link to here"))))
19788 (org-occur-in-agenda-files (regexp-quote link))))
19790 (defun org-uniquify (list)
19791 "Remove duplicate elements from LIST."
19792 (let (res)
19793 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19794 res))
19796 (defun org-delete-all (elts list)
19797 "Remove all elements in ELTS from LIST."
19798 (while elts
19799 (setq list (delete (pop elts) list)))
19800 list)
19802 (defun org-count (cl-item cl-seq)
19803 "Count the number of occurrences of ITEM in SEQ.
19804 Taken from `count' in cl-seq.el with all keyword arguments removed."
19805 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19806 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19807 (while (< cl-start cl-end)
19808 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19809 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19810 (setq cl-start (1+ cl-start)))
19811 cl-count))
19813 (defun org-remove-if (predicate seq)
19814 "Remove everything from SEQ that fulfills PREDICATE."
19815 (let (res e)
19816 (while seq
19817 (setq e (pop seq))
19818 (if (not (funcall predicate e)) (push e res)))
19819 (nreverse res)))
19821 (defun org-remove-if-not (predicate seq)
19822 "Remove everything from SEQ that does not fulfill PREDICATE."
19823 (let (res e)
19824 (while seq
19825 (setq e (pop seq))
19826 (if (funcall predicate e) (push e res)))
19827 (nreverse res)))
19829 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19830 "Reduce two-argument FUNCTION across SEQ.
19831 Taken from `reduce' in cl-seq.el with all keyword arguments but
19833 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19834 (cadr (memq :initial-value cl-keys)))
19835 (cl-seq (pop cl-seq))
19836 (t (funcall cl-func)))))
19837 (while cl-seq
19838 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19839 cl-accum))
19841 (defun org-back-over-empty-lines ()
19842 "Move backwards over whitespace, to the beginning of the first empty line.
19843 Returns the number of empty lines passed."
19844 (let ((pos (point)))
19845 (if (cdr (assoc 'heading org-blank-before-new-entry))
19847 (unless (eobp)
19848 (forward-line -1)))
19849 (beginning-of-line 2)
19850 (goto-char (min (point) pos))
19851 (count-lines (point) pos)))
19853 (defun org-skip-whitespace ()
19856 (defun org-point-in-group (point group &optional context)
19857 "Check if POINT is in match-group GROUP.
19858 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19859 match. If the match group does not exist or point is not inside it,
19860 return nil."
19861 (and (match-beginning group)
19862 (>= point (match-beginning group))
19863 (<= point (match-end group))
19864 (if context
19865 (list context (match-beginning group) (match-end group))
19866 t)))
19868 (defun org-switch-to-buffer-other-window (&rest args)
19869 "Switch to buffer in a second window on the current frame.
19870 In particular, do not allow pop-up frames.
19871 Returns the newly created buffer."
19872 (let (pop-up-frames special-display-buffer-names special-display-regexps
19873 special-display-function)
19874 (apply 'switch-to-buffer-other-window args)))
19876 (defun org-combine-plists (&rest plists)
19877 "Create a single property list from all plists in PLISTS.
19878 The process starts by copying the first list, and then setting properties
19879 from the other lists. Settings in the last list are the most significant
19880 ones and overrule settings in the other lists."
19881 (let ((rtn (copy-sequence (pop plists)))
19882 p v ls)
19883 (while plists
19884 (setq ls (pop plists))
19885 (while ls
19886 (setq p (pop ls) v (pop ls))
19887 (setq rtn (plist-put rtn p v))))
19888 rtn))
19890 (defun org-move-line-down (arg)
19891 "Move the current line down. With prefix argument, move it past ARG lines."
19892 (interactive "p")
19893 (let ((col (current-column))
19894 beg end pos)
19895 (beginning-of-line 1) (setq beg (point))
19896 (beginning-of-line 2) (setq end (point))
19897 (beginning-of-line (+ 1 arg))
19898 (setq pos (move-marker (make-marker) (point)))
19899 (insert (delete-and-extract-region beg end))
19900 (goto-char pos)
19901 (org-move-to-column col)))
19903 (defun org-move-line-up (arg)
19904 "Move the current line up. With prefix argument, move it past ARG lines."
19905 (interactive "p")
19906 (let ((col (current-column))
19907 beg end pos)
19908 (beginning-of-line 1) (setq beg (point))
19909 (beginning-of-line 2) (setq end (point))
19910 (beginning-of-line (- arg))
19911 (setq pos (move-marker (make-marker) (point)))
19912 (insert (delete-and-extract-region beg end))
19913 (goto-char pos)
19914 (org-move-to-column col)))
19916 (defun org-replace-escapes (string table)
19917 "Replace %-escapes in STRING with values in TABLE.
19919 The sequences in STRING may contain normal field width and padding information,
19921 so values can contain further %-escapes if they are define later in TABLE."
19922 (let ((tbl (copy-alist table))
19923 (case-fold-search nil)
19924 (pchg 0)
19925 e re rpl)
19926 (while (setq e (pop tbl))
19927 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19928 (when (and (cdr e) (string-match re (cdr e)))
19929 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19930 (safe "SREF"))
19931 (add-text-properties 0 3 (list 'sref sref) safe)
19932 (setcdr e (replace-match safe t t (cdr e)))))
19933 (while (string-match re string)
19934 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19935 (cdr e)))
19936 (setq string (replace-match rpl t t string))))
19937 (while (setq pchg (next-property-change pchg string))
19938 (let ((sref (get-text-property pchg 'sref string)))
19939 (when (and sref (string-match "SREF" string pchg))
19940 (setq string (replace-match sref t t string)))))
19941 string))
19943 (defun org-sublist (list start end)
19944 "Return a section of LIST, from START to END.
19945 Counting starts at 1."
19946 (let (rtn (c start))
19947 (setq list (nthcdr (1- start) list))
19948 (while (and list (<= c end))
19949 (push (pop list) rtn)
19950 (setq c (1+ c)))
19951 (nreverse rtn)))
19953 (defun org-find-base-buffer-visiting (file)
19954 "Like `find-buffer-visiting' but always return the base buffer and
19955 not an indirect buffer."
19956 (let ((buf (or (get-file-buffer file)
19957 (find-buffer-visiting file))))
19958 (if buf
19959 (or (buffer-base-buffer buf) buf)
19960 nil)))
19962 (defun org-image-file-name-regexp (&optional extensions)
19963 "Return regexp matching the file names of images.
19964 If EXTENSIONS is given, only match these."
19965 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19966 (image-file-name-regexp)
19967 (let ((image-file-name-extensions
19968 (or extensions
19969 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19970 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19972 (regexp-opt (nconc (mapcar 'upcase
19973 image-file-name-extensions)
19974 image-file-name-extensions)
19975 t)
19978 (defun org-file-image-p (file &optional extensions)
19979 "Return non-nil if FILE is an image."
19980 (save-match-data
19981 (string-match (org-image-file-name-regexp extensions) file)))
19983 (defun org-get-cursor-date ()
19984 "Return the date at cursor in as a time.
19985 This works in the calendar and in the agenda, anywhere else it just
19986 returns the current time."
19987 (let (date day defd)
19988 (cond
19989 ((eq major-mode 'calendar-mode)
19990 (setq date (calendar-cursor-to-date)
19991 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19992 ((eq major-mode 'org-agenda-mode)
19993 (setq day (get-text-property (point) 'day))
19994 (if day
19995 (setq date (calendar-gregorian-from-absolute day)
19996 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19997 (nth 2 date))))))
19998 (or defd (current-time))))
20000 (defvar org-agenda-action-marker (make-marker)
20001 "Marker pointing to the entry for the next agenda action.")
20003 (defun org-mark-entry-for-agenda-action ()
20004 "Mark the current entry as target of an agenda action.
20005 Agenda actions are actions executed from the agenda with the key `k',
20006 which make use of the date at the cursor."
20007 (interactive)
20008 (move-marker org-agenda-action-marker
20009 (save-excursion (org-back-to-heading t) (point))
20010 (current-buffer))
20011 (message
20012 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20014 (defun org-mark-subtree ()
20015 "Mark the current subtree.
20016 This puts point at the start of the current subtree, and mark at the end.
20018 If point is in an inline task, mark that task instead."
20019 (interactive)
20020 (let ((inline-task-p
20021 (and (featurep 'org-inlinetask)
20022 (org-inlinetask-in-task-p)))
20023 (beg))
20024 ;; Get beginning of subtree
20025 (cond
20026 (inline-task-p (org-inlinetask-goto-beginning))
20027 ((org-at-heading-p) (beginning-of-line))
20028 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20029 (setq beg (point))
20030 ;; Get end of it
20031 (if inline-task-p
20032 (org-inlinetask-goto-end)
20033 (org-end-of-subtree))
20034 ;; Mark zone
20035 (push-mark (point) nil t)
20036 (goto-char beg)))
20038 ;;; Paragraph filling stuff.
20039 ;; We want this to be just right, so use the full arsenal.
20041 (defun org-indent-line-function ()
20042 "Indent line depending on context."
20043 (interactive)
20044 (let* ((pos (point))
20045 (itemp (org-at-item-p))
20046 (case-fold-search t)
20048 (inline-task-p (and (featurep 'org-inlinetask)
20049 (org-inlinetask-in-task-p)))
20050 (inline-re (and inline-task-p
20051 (org-inlinetask-outline-regexp)))
20052 column)
20053 (beginning-of-line 1)
20054 (cond
20055 ;; Comments
20056 ((looking-at "# ") (setq column 0))
20057 ;; Headings
20058 ((looking-at org-outline-regexp) (setq column 0))
20059 ;; Included files
20061 ;; Footnote definition
20062 ((looking-at org-footnote-definition-re) (setq column 0))
20063 ;; Literal examples
20065 (setq column (org-get-indentation))) ; do nothing
20066 ;; Lists
20067 ((ignore-errors (goto-char (org-in-item-p)))
20068 (setq column (if itemp
20069 (org-get-indentation)
20070 (org-list-item-body-column (point))))
20071 (goto-char pos))
20072 ;; Drawers
20074 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20075 (save-excursion
20076 (goto-char (1- (match-beginning 1)))
20077 (setq column (current-column))))
20078 ;; Special blocks
20080 (save-excursion
20081 (re-search-backward
20083 (setq column (org-get-indentation (match-string 0))))
20086 (save-excursion
20088 (setq column
20089 (cond ((equal (downcase (match-string 1)) "src")
20090 ;; src blocks: let `org-edit-src-exit' handle them
20091 (org-get-indentation))
20092 ((equal (downcase (match-string 1)) "example")
20093 (max (org-get-indentation)
20094 (org-get-indentation (match-string 0))))
20095 (t
20096 (org-get-indentation (match-string 0))))))
20097 ;; This line has nothing special, look at the previous relevant
20098 ;; line to compute indentation
20099 (t
20100 (beginning-of-line 0)
20101 (while (and (not (bobp))
20102 (not (looking-at org-drawer-regexp))
20103 ;; When point started in an inline task, do not move
20104 ;; above task starting line.
20105 (not (and inline-task-p (looking-at inline-re)))
20106 ;; Skip drawers, blocks, empty lines, verbatim,
20107 ;; comments, tables, footnotes definitions, lists,
20108 ;; inline tasks.
20110 (re-search-backward org-drawer-regexp nil t))
20114 (looking-at org-footnote-definition-re)
20115 (and (ignore-errors (goto-char (org-in-item-p)))
20116 (goto-char
20117 (org-list-get-top-point (org-list-struct))))
20118 (and (not inline-task-p)
20119 (featurep 'org-inlinetask)
20120 (org-inlinetask-in-task-p)
20121 (or (org-inlinetask-goto-beginning) t))))
20122 (beginning-of-line 0))
20123 (cond
20124 ;; There was an heading above.
20126 (if (not org-adapt-indentation)
20127 (setq column 0)
20128 (goto-char (match-end 0))
20129 (setq column (current-column))))
20130 ;; A drawer had started and is unfinished
20131 ((looking-at org-drawer-regexp)
20132 (goto-char (1- (match-beginning 1)))
20133 (setq column (current-column)))
20134 ;; Else, nothing noticeable found: get indentation and go on.
20135 (t (setq column (org-get-indentation))))))
20136 ;; Now apply indentation and move cursor accordingly
20137 (goto-char pos)
20138 (if (<= (current-column) (current-indentation))
20139 (org-indent-line-to column)
20140 (save-excursion (org-indent-line-to column)))
20141 ;; Special polishing for properties, see `org-property-format'
20142 (setq column (current-column))
20143 (beginning-of-line 1)
20144 (if (looking-at
20146 (replace-match (concat (match-string 1)
20147 (format org-property-format
20148 (match-string 2) (match-string 3)))
20149 t t))
20150 (org-move-to-column column)))
20152 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20153 "Variable to store copy of `adaptive-fill-regexp'.
20154 Since `adaptive-fill-regexp' is set to never match, we need to
20155 store a backup of its value before entering `org-mode' so that
20156 the functionality can be provided as a fall-back.")
20158 (defun org-set-autofill-regexps ()
20159 (interactive)
20160 ;; In the paragraph separator we include headlines, because filling
20161 ;; text in a line directly attached to a headline would otherwise
20162 ;; fill the headline as well.
20165 ;; The paragraph starter includes hand-formatted lists.
20166 (org-set-local
20167 'paragraph-start
20168 (concat
20177 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20178 ;; But only if the user has not turned off tables or fixed-width regions
20179 (org-set-local
20180 'auto-fill-inhibit-regexp
20181 (concat org-outline-regexp
20184 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20185 (concat
20187 (if org-enable-table-editor "|" "")
20188 (if org-enable-fixed-width-editor ":" "")
20189 "]"))))
20190 ;; We use our own fill-paragraph function, to make sure that tables
20191 ;; and fixed-width regions are not wrapped. That function will pass
20192 ;; through to `fill-paragraph' when appropriate.
20193 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20194 ;; Prevent auto-fill from inserting unwanted new items.
20195 (if (boundp 'fill-nobreak-predicate)
20196 (org-set-local 'fill-nobreak-predicate
20197 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20198 fill-nobreak-predicate
20199 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20200 ;; Adaptive filling: To get full control, first make sure that
20201 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20202 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20203 (org-set-local 'org-adaptive-fill-regexp-backup
20204 adaptive-fill-regexp))
20206 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20207 (org-set-local 'adaptive-fill-function
20208 'org-adaptive-fill-function)
20209 (org-set-local
20210 'align-mode-rules-list
20211 '((org-in-buffer-settings
20213 (modes . '(org-mode))))))
20215 (defun org-fill-item-nobreak-p ()
20216 "Non-nil when a line break at point would insert a new item."
20217 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20219 (defun org-fill-paragraph (&optional justify)
20220 "Re-align a table, pass through to fill-paragraph if no table."
20221 (let ((table-p (org-at-table-p))
20222 (table.el-p (org-at-table.el-p))
20223 (itemp (org-in-item-p)))
20224 (cond ((and (equal (char-after (point-at-bol)) ?*)
20225 (save-excursion (goto-char (point-at-bol))
20226 (looking-at org-outline-regexp)))
20227 t) ; skip headlines
20228 (table.el-p t) ; skip table.el tables
20229 (table-p (org-table-align) t) ; align Org tables
20230 (itemp ; align text in items
20231 (let* ((struct (save-excursion (goto-char itemp)
20232 (org-list-struct)))
20233 (parents (org-list-parents-alist struct))
20234 (children (org-list-get-children itemp struct parents))
20235 beg end prev next prefix)
20236 ;; Determine in which part of item point is: before
20237 ;; first child, after last child, between two
20238 ;; sub-lists, or simply in item if there's no child.
20239 (cond
20240 ((not children)
20241 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20242 beg itemp
20243 end (org-list-get-item-end itemp struct)))
20244 ((< (point) (setq next (car children)))
20245 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20246 beg itemp
20247 end next))
20248 ((> (point) (setq prev (car (last children))))
20249 (setq beg (org-list-get-item-end prev struct)
20250 end (org-list-get-item-end itemp struct)
20251 prefix (save-excursion
20252 (goto-char beg)
20254 (make-string (current-column) ?\ ))))
20255 (t (catch 'exit
20256 (while (setq next (pop children))
20257 (if (> (point) next)
20258 (setq prev next)
20259 (setq beg (org-list-get-item-end prev struct)
20260 end next
20261 prefix (save-excursion
20262 (goto-char beg)
20264 (make-string (current-column) ?\ )))
20265 (throw 'exit nil))))))
20266 ;; Use `fill-paragraph' with buffer narrowed to item
20267 ;; without any child, and with our computed PREFIX.
20268 (flet ((fill-context-prefix (from to &optional flr) prefix))
20269 (save-restriction
20270 (narrow-to-region beg end)
20271 (save-excursion (fill-paragraph justify)))) t))
20272 ;; Special case where point is not in a list but is on
20273 ;; a paragraph adjacent to a list: make sure this paragraph
20274 ;; doesn't get merged with the end of the list by narrowing
20275 ;; buffer first.
20276 ((save-excursion (forward-paragraph -1)
20277 (setq itemp (org-in-item-p)))
20278 (let ((struct (save-excursion (goto-char itemp)
20279 (org-list-struct))))
20280 (save-restriction
20281 (narrow-to-region (org-list-get-bottom-point struct)
20282 (save-excursion (forward-paragraph 1)
20283 (point)))
20284 (fill-paragraph justify) t)))
20285 ;; Else simply call `fill-paragraph'.
20286 (t nil))))
20288 ;; For reference, this is the default value of adaptive-fill-regexp
20291 (defun org-adaptive-fill-function ()
20292 "Return a fill prefix for org-mode files."
20293 (let (itemp)
20294 (save-excursion
20295 (cond
20296 ;; Comment line
20298 (match-string-no-properties 0))
20299 ;; Plain list item
20300 ((org-at-item-p)
20301 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20302 ;; Point is in a list after `backward-paragraph': original
20303 ;; point wasn't in the list, or filling would have been taken
20304 ;; care of by `org-auto-fill-function', but the list and the
20305 ;; real paragraph are not separated by a blank line. Thus, move
20306 ;; point after the list to go back to real paragraph and
20307 ;; determine fill-prefix.
20308 ((setq itemp (org-in-item-p))
20309 (goto-char itemp)
20310 (let* ((struct (org-list-struct))
20311 (bottom (org-list-get-bottom-point struct)))
20312 (goto-char bottom)
20313 (make-string (org-get-indentation) ?\ )))
20314 ;; Other text
20315 ((looking-at org-adaptive-fill-regexp-backup)
20316 (match-string-no-properties 0))))))
20318 (defun org-auto-fill-function ()
20319 "Auto-fill function."
20320 (let (itemp prefix)
20321 ;; When in a list, compute an appropriate fill-prefix and make
20322 ;; sure it will be used by `do-auto-fill'.
20323 (if (setq itemp (org-in-item-p))
20324 (progn
20325 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20326 (flet ((fill-context-prefix (from to &optional flr) prefix))
20327 (do-auto-fill)))
20328 ;; Else just use `do-auto-fill'.
20329 (do-auto-fill))))
20331 ;;; Other stuff.
20333 (defun org-toggle-fixed-width-section (arg)
20334 "Toggle the fixed-width export.
20335 If there is no active region, the QUOTE keyword at the current headline is
20336 inserted or removed. When present, it causes the text between this headline
20337 and the next to be exported as fixed-width text, and unmodified.
20338 If there is an active region, this command adds or removes a colon as the
20339 first character of this line. If the first character of a line is a colon,
20340 this line is also exported in fixed-width font."
20341 (interactive "P")
20342 (let* ((cc 0)
20343 (regionp (org-region-active-p))
20344 (beg (if regionp (region-beginning) (point)))
20345 (end (if regionp (region-end)))
20346 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20347 (case-fold-search nil)
20349 off)
20350 (if regionp
20351 (save-excursion
20352 (goto-char beg)
20353 (setq cc (current-column))
20354 (beginning-of-line 1)
20355 (setq off (looking-at re))
20356 (while (> nlines 0)
20357 (setq nlines (1- nlines))
20358 (beginning-of-line 1)
20359 (cond
20360 (arg
20361 (org-move-to-column cc t)
20363 (forward-line -1))
20364 ((and off (looking-at re))
20365 (replace-match "" t t nil 1))
20366 ((not off) (org-move-to-column cc t) (insert ": ")))
20367 (forward-line 1)))
20368 (save-excursion
20369 (org-back-to-heading)
20370 (cond
20371 ((looking-at (format org-heading-keyword-regexp-format
20372 org-quote-string))
20373 (goto-char (match-end 1))
20374 (looking-at (concat " +" org-quote-string))
20375 (replace-match "" t t)
20376 (when (eolp) (insert " ")))
20377 ((looking-at org-outline-regexp)
20378 (goto-char (match-end 0))
20379 (insert org-quote-string " ")))))))
20381 (defun org-reftex-citation ()
20382 "Use reftex-citation to insert a citation into the buffer.
20383 This looks for a line like
20385 #+BIBLIOGRAPHY: foo plain option:-d
20387 and derives from it that foo.bib is the bibliography file relevant
20388 for this document. It then installs the necessary environment for RefTeX
20389 to work in this buffer and calls `reftex-citation' to insert a citation
20390 into the buffer.
20392 Export of such citations to both LaTeX and HTML is handled by the contributed
20393 package org-exp-bibtex by Taru Karttunen."
20394 (interactive)
20395 (let ((reftex-docstruct-symbol 'rds)
20397 rds bib)
20398 (save-excursion
20399 (save-restriction
20400 (widen)
20401 (let ((case-fold-search t)
20403 (if (not (save-excursion
20404 (or (re-search-forward re nil t)
20405 (re-search-backward re nil t))))
20406 (error "No bibliography defined in file")
20407 (setq bib (concat (match-string 1) ".bib")
20408 rds (list (list 'bib bib)))))))
20409 (call-interactively 'reftex-citation)))
20411 ;;;; Functions extending outline functionality
20413 (defun org-beginning-of-line (&optional arg)
20414 "Go to the beginning of the current line. If that is invisible, continue
20415 to a visible line beginning. This makes the function of C-a more intuitive.
20416 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20417 first attempt, and only move to after the tags when the cursor is already
20418 beyond the end of the headline."
20419 (interactive "P")
20420 (let ((pos (point))
20421 (special (if (consp org-special-ctrl-a/e)
20422 (car org-special-ctrl-a/e)
20423 org-special-ctrl-a/e))
20424 refpos)
20425 (if (org-bound-and-true-p line-move-visual)
20426 (beginning-of-visual-line 1)
20427 (beginning-of-line 1))
20428 (if (and arg (fboundp 'move-beginning-of-line))
20429 (call-interactively 'move-beginning-of-line)
20430 (if (bobp)
20431 nil
20432 (backward-char 1)
20433 (if (org-truely-invisible-p)
20434 (while (and (not (bobp)) (org-truely-invisible-p))
20435 (backward-char 1)
20436 (beginning-of-line 1))
20437 (forward-char 1))))
20438 (when special
20439 (cond
20440 ((and (looking-at org-complex-heading-regexp)
20441 (= (char-after (match-end 1)) ?\ ))
20442 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20443 (point-at-eol)))
20444 (goto-char
20445 (if (eq special t)
20446 (cond ((> pos refpos) refpos)
20447 ((= pos (point)) refpos)
20448 (t (point)))
20449 (cond ((> pos (point)) (point))
20450 ((not (eq last-command this-command)) (point))
20451 (t refpos)))))
20452 ((org-at-item-p)
20453 ;; Being at an item and not looking at an the item means point
20454 ;; was previously moved to beginning of a visual line, whiche
20455 ;; doesn't contain the item. Therefore, do nothing special,
20456 ;; just stay here.
20457 (when (looking-at org-list-full-item-re)
20458 ;; Set special position at first white space character after
20459 ;; bullet, and check-box, if any.
20460 (let ((after-bullet
20461 (let ((box (match-end 3)))
20462 (if (not box) (match-end 1)
20463 (let ((after (char-after box)))
20464 (if (and after (= after ? )) (1+ box) box))))))
20465 ;; Special case: Move point to special position when
20466 ;; currently after it or at beginning of line.
20467 (if (eq special t)
20468 (when (or (> pos after-bullet) (= (point) pos))
20469 (goto-char after-bullet))
20470 ;; Reversed case: Move point to special position when
20471 ;; point was already at beginning of line and command is
20472 ;; repeated.
20473 (when (and (= (point) pos) (eq last-command this-command))
20474 (goto-char after-bullet))))))))
20475 (org-no-warnings
20476 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20478 (defun org-end-of-line (&optional arg)
20479 "Go to the end of the line.
20480 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20481 first attempt, and only move to after the tags when the cursor is already
20482 beyond the end of the headline."
20483 (interactive "P")
20484 (let ((special (if (consp org-special-ctrl-a/e)
20485 (cdr org-special-ctrl-a/e)
20486 org-special-ctrl-a/e)))
20487 (cond
20488 ((or (not special) arg
20489 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20490 (call-interactively
20491 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20492 ((fboundp 'move-end-of-line) 'move-end-of-line)
20493 (t 'end-of-line))))
20494 ((org-at-heading-p)
20495 (let ((pos (point)))
20496 (beginning-of-line 1)
20498 (if (eq special t)
20499 (if (or (< pos (match-beginning 1))
20500 (= pos (match-end 0)))
20501 (goto-char (match-beginning 1))
20502 (goto-char (match-end 0)))
20503 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20504 (goto-char (match-end 0))
20505 (goto-char (match-beginning 1))))
20506 (call-interactively (if (fboundp 'move-end-of-line)
20507 'move-end-of-line
20508 'end-of-line)))))
20509 ((org-at-drawer-p)
20510 (move-end-of-line 1)
20511 (when (overlays-at (1- (point))) (backward-char 1)))
20512 ;; At an item: Move before any hidden text.
20513 (t (call-interactively
20514 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20515 ((fboundp 'move-end-of-line) 'move-end-of-line)
20516 (t 'end-of-line)))))
20517 (org-no-warnings
20518 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20520 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20521 (define-key org-mode-map "\C-e" 'org-end-of-line)
20523 (defun org-backward-sentence (&optional arg)
20524 "Go to beginning of sentence, or beginning of table field.
20525 This will call `backward-sentence' or `org-table-beginning-of-field',
20526 depending on context."
20527 (interactive "P")
20528 (cond
20529 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20530 (t (call-interactively 'backward-sentence))))
20532 (defun org-forward-sentence (&optional arg)
20533 "Go to end of sentence, or end of table field.
20534 This will call `forward-sentence' or `org-table-end-of-field',
20535 depending on context."
20536 (interactive "P")
20537 (cond
20538 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20539 (t (call-interactively 'forward-sentence))))
20541 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20542 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20544 (defun org-kill-line (&optional arg)
20545 "Kill line, to tags or end of line."
20546 (interactive "P")
20547 (cond
20548 ((or (not org-special-ctrl-k)
20549 (bolp)
20550 (not (org-at-heading-p)))
20551 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20552 org-ctrl-k-protect-subtree)
20553 (if (or (eq org-ctrl-k-protect-subtree 'error)
20554 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20555 (error "C-k aborted - would kill hidden subtree")))
20556 (call-interactively 'kill-line))
20558 (kill-region (point) (match-beginning 1))
20559 (org-set-tags nil t))
20560 (t (kill-region (point) (point-at-eol)))))
20562 (define-key org-mode-map "\C-k" 'org-kill-line)
20564 (defun org-yank (&optional arg)
20565 "Yank. If the kill is a subtree, treat it specially.
20566 This command will look at the current kill and check if is a single
20567 subtree, or a series of subtrees[1]. If it passes the test, and if the
20568 cursor is at the beginning of a line or after the stars of a currently
20569 empty headline, then the yank is handled specially. How exactly depends
20570 on the value of the following variables, both set by default.
20572 org-yank-folded-subtrees
20573 When set, the subtree(s) will be folded after insertion, but only
20574 if doing so would now swallow text after the yanked text.
20576 org-yank-adjusted-subtrees
20577 When set, the subtree will be promoted or demoted in order to
20578 fit into the local outline tree structure, which means that the level
20579 will be adjusted so that it becomes the smaller one of the two
20580 *visible* surrounding headings.
20582 Any prefix to this command will cause `yank' to be called directly with
20584 will just
20585 plainly yank the text as it is.
20587 \[1] The test checks if the first non-white line is a heading
20588 and if there are no other headings with fewer stars."
20589 (interactive "P")
20590 (org-yank-generic 'yank arg))
20592 (defun org-yank-generic (command arg)
20593 "Perform some yank-like command.
20595 This function implements the behavior described in the `org-yank'
20596 documentation. However, it has been generalized to work for any
20597 interactive command with similar behavior."
20599 ;; pretend to be command COMMAND
20600 (setq this-command command)
20602 (if arg
20603 (call-interactively command)
20605 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20606 (and (org-kill-is-subtree-p)
20607 (or (bolp)
20609 (string-match
20611 (buffer-substring (point-at-bol) (point)))))))
20612 swallowp)
20613 (cond
20614 ((and subtreep org-yank-folded-subtrees)
20615 (let ((beg (point))
20616 end)
20617 (if (and subtreep org-yank-adjusted-subtrees)
20618 (org-paste-subtree nil nil 'for-yank)
20619 (call-interactively command))
20621 (setq end (point))
20622 (goto-char beg)
20623 (when (and (bolp) subtreep
20624 (not (setq swallowp
20625 (org-yank-folding-would-swallow-text beg end))))
20626 (org-with-limited-levels
20627 (or (looking-at org-outline-regexp)
20628 (re-search-forward org-outline-regexp-bol end t))
20629 (while (and (< (point) end) (looking-at org-outline-regexp))
20630 (hide-subtree)
20631 (org-cycle-show-empty-lines 'folded)
20632 (condition-case nil
20633 (outline-forward-same-level 1)
20634 (error (goto-char end))))))
20635 (when swallowp
20636 (message
20637 "Inserted text not folded because that would swallow text"))
20639 (goto-char end)
20641 (beginning-of-line 1)
20642 (push-mark beg 'nomsg)))
20643 ((and subtreep org-yank-adjusted-subtrees)
20644 (let ((beg (point-at-bol)))
20645 (org-paste-subtree nil nil 'for-yank)
20646 (push-mark beg 'nomsg)))
20647 (t
20648 (call-interactively command))))))
20650 (defun org-yank-folding-would-swallow-text (beg end)
20651 "Would hide-subtree at BEG swallow any text after END?"
20652 (let (level)
20653 (org-with-limited-levels
20654 (save-excursion
20655 (goto-char beg)
20656 (when (or (looking-at org-outline-regexp)
20657 (re-search-forward org-outline-regexp-bol end t))
20658 (setq level (org-outline-level)))
20659 (goto-char end)
20661 (if (or (eobp)
20662 (and (bolp) (looking-at org-outline-regexp)
20663 (<= (org-outline-level) level)))
20664 nil ; Nothing would be swallowed
20665 t))))) ; something would swallow
20667 (define-key org-mode-map "\C-y" 'org-yank)
20669 (defun org-truely-invisible-p ()
20670 "Check if point is at a character currently not visible.
20671 This version does not only check the character property, but also
20672 `visible-mode'."
20673 ;; Early versions of noutline don't have `outline-invisible-p'.
20674 (if (org-bound-and-true-p visible-mode)
20675 nil
20676 (outline-invisible-p)))
20678 (defun org-invisible-p2 ()
20679 "Check if point is at a character currently not visible."
20680 (save-excursion
20681 (if (and (eolp) (not (bobp))) (backward-char 1))
20682 ;; Early versions of noutline don't have `outline-invisible-p'.
20683 (outline-invisible-p)))
20685 (defun org-back-to-heading (&optional invisible-ok)
20686 "Call `outline-back-to-heading', but provide a better error message."
20687 (condition-case nil
20688 (outline-back-to-heading invisible-ok)
20689 (error (error "Before first headline at position %d in buffer %s"
20690 (point) (current-buffer)))))
20692 (defun org-beginning-of-defun ()
20693 "Go to the beginning of the subtree, i.e. back to the heading."
20694 (org-back-to-heading))
20695 (defun org-end-of-defun ()
20696 "Go to the end of the subtree."
20697 (org-end-of-subtree nil t))
20699 (defun org-before-first-heading-p ()
20700 "Before first heading?"
20701 (save-excursion
20702 (end-of-line)
20703 (null (re-search-backward org-outline-regexp-bol nil t))))
20705 (defun org-at-heading-p (&optional ignored)
20706 (outline-on-heading-p t))
20707 ;; Compatibility alias with Org versions < 7.8.03
20708 (defalias 'org-on-heading-p 'org-at-heading-p)
20710 (defun org-at-drawer-p nil
20711 "Whether point is at a drawer."
20712 (save-excursion
20713 (move-beginning-of-line 1)
20714 (looking-at org-drawer-regexp)))
20716 (defun org-point-at-end-of-empty-headline ()
20717 "If point is at the end of an empty headline, return t, else nil.
20718 If the heading only contains a TODO keyword, it is still still considered
20719 empty."
20721 (save-excursion
20722 (beginning-of-line 1)
20723 (let ((case-fold-search nil))
20724 (looking-at org-todo-line-regexp)))
20725 (string= (match-string 3) "")))
20727 (defun org-at-heading-or-item-p ()
20728 (or (org-at-heading-p) (org-at-item-p)))
20730 (defun org-at-target-p ()
20731 (or (org-in-regexp org-radio-target-regexp)
20732 (org-in-regexp org-target-regexp)))
20733 ;; Compatibility alias with Org versions < 7.8.03
20734 (defalias 'org-on-target-p 'org-at-target-p)
20736 (defun org-up-heading-all (arg)
20737 "Move to the heading line of which the present line is a subheading.
20738 This function considers both visible and invisible heading lines.
20739 With argument, move up ARG levels."
20740 (if (fboundp 'outline-up-heading-all)
20741 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20742 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20744 (defun org-up-heading-safe ()
20745 "Move to the heading line of which the present line is a subheading.
20746 This version will not throw an error. It will return the level of the
20747 headline found, or nil if no higher level is found.
20749 Also, this function will be a lot faster than `outline-up-heading',
20750 because it relies on stars being the outline starters. This can really
20751 make a significant difference in outlines with very many siblings."
20752 (let (start-level re)
20753 (org-back-to-heading t)
20754 (setq start-level (funcall outline-level))
20755 (if (equal start-level 1)
20756 nil
20758 (if (re-search-backward re nil t)
20759 (funcall outline-level)))))
20761 (defun org-first-sibling-p ()
20762 "Is this heading the first child of its parents?"
20763 (interactive)
20764 (let ((re org-outline-regexp-bol)
20765 level l)
20766 (unless (org-at-heading-p t)
20767 (error "Not at a heading"))
20768 (setq level (funcall outline-level))
20769 (save-excursion
20770 (if (not (re-search-backward re nil t))
20771 t
20772 (setq l (funcall outline-level))
20773 (< l level)))))
20775 (defun org-goto-sibling (&optional previous)
20776 "Goto the next sibling, even if it is invisible.
20777 When PREVIOUS is set, go to the previous sibling instead. Returns t
20778 when a sibling was found. When none is found, return nil and don't
20779 move point."
20780 (let ((fun (if previous 're-search-backward 're-search-forward))
20781 (pos (point))
20782 (re org-outline-regexp-bol)
20783 level l)
20784 (when (condition-case nil (org-back-to-heading t) (error nil))
20785 (setq level (funcall outline-level))
20786 (catch 'exit
20787 (or previous (forward-char 1))
20788 (while (funcall fun re nil t)
20789 (setq l (funcall outline-level))
20790 (when (< l level) (goto-char pos) (throw 'exit nil))
20791 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20792 (goto-char pos)
20793 nil))))
20795 (defun org-show-siblings ()
20796 "Show all siblings of the current headline."
20797 (save-excursion
20798 (while (org-goto-sibling) (org-flag-heading nil)))
20799 (save-excursion
20800 (while (org-goto-sibling 'previous)
20801 (org-flag-heading nil))))
20803 (defun org-goto-first-child ()
20804 "Goto the first child, even if it is invisible.
20805 Return t when a child was found. Otherwise don't move point and
20806 return nil."
20807 (let (level (pos (point)) (re org-outline-regexp-bol))
20808 (when (condition-case nil (org-back-to-heading t) (error nil))
20809 (setq level (outline-level))
20810 (forward-char 1)
20811 (if (and (re-search-forward re nil t) (> (outline-level) level))
20812 (progn (goto-char (match-beginning 0)) t)
20813 (goto-char pos) nil))))
20815 (defun org-show-hidden-entry ()
20816 "Show an entry where even the heading is hidden."
20817 (save-excursion
20818 (org-show-entry)))
20820 (defun org-flag-heading (flag &optional entry)
20821 "Flag the current heading. FLAG non-nil means make invisible.
20822 When ENTRY is non-nil, show the entire entry."
20823 (save-excursion
20824 (org-back-to-heading t)
20825 ;; Check if we should show the entire entry
20826 (if entry
20827 (progn
20828 (org-show-entry)
20829 (save-excursion
20830 (and (outline-next-heading)
20831 (org-flag-heading nil))))
20832 (outline-flag-region (max (point-min) (1- (point)))
20833 (save-excursion (outline-end-of-heading) (point))
20834 flag))))
20836 (defun org-get-next-sibling ()
20837 "Move to next heading of the same level, and return point.
20838 If there is no such heading, return nil.
20839 This is like outline-next-sibling, but invisible headings are ok."
20840 (let ((level (funcall outline-level)))
20841 (outline-next-heading)
20842 (while (and (not (eobp)) (> (funcall outline-level) level))
20843 (outline-next-heading))
20844 (if (or (eobp) (< (funcall outline-level) level))
20845 nil
20846 (point))))
20848 (defun org-get-last-sibling ()
20849 "Move to previous heading of the same level, and return point.
20850 If there is no such heading, return nil."
20851 (let ((opoint (point))
20852 (level (funcall outline-level)))
20853 (outline-previous-heading)
20854 (when (and (/= (point) opoint) (outline-on-heading-p t))
20855 (while (and (> (funcall outline-level) level)
20856 (not (bobp)))
20857 (outline-previous-heading))
20858 (if (< (funcall outline-level) level)
20859 nil
20860 (point)))))
20862 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20863 ;; This contains an exact copy of the original function, but it uses
20864 ;; `org-back-to-heading', to make it work also in invisible
20865 ;; trees. And is uses an invisible-OK argument.
20866 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20867 ;; Furthermore, when used inside Org, finding the end of a large subtree
20868 ;; with many children and grandchildren etc, this can be much faster
20869 ;; than the outline version.
20870 (org-back-to-heading invisible-OK)
20871 (let ((first t)
20872 (level (funcall outline-level)))
20873 (if (and (eq major-mode 'org-mode) (< level 1000))
20874 ;; A true heading (not a plain list item), in Org-mode
20875 ;; This means we can easily find the end by looking
20876 ;; only for the right number of stars. Using a regexp to do
20877 ;; this is so much faster than using a Lisp loop.
20879 (forward-char 1)
20880 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20881 ;; something else, do it the slow way
20882 (while (and (not (eobp))
20883 (or first (> (funcall outline-level) level)))
20884 (setq first nil)
20885 (outline-next-heading)))
20886 (unless to-heading
20888 (progn
20889 ;; Go to end of line before heading
20890 (forward-char -1)
20892 ;; leave blank line before heading
20893 (forward-char -1))))))
20894 (point))
20896 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20897 "Use Org version in org-mode, for dramatic speed-up."
20898 (if (eq major-mode 'org-mode)
20899 (progn
20900 (org-end-of-subtree nil t)
20901 (unless (eobp) (backward-char 1)))
20902 ad-do-it))
20904 (defun org-end-of-meta-data-and-drawers ()
20905 "Jump to the first text after meta data and drawers in the current entry.
20906 This will move over empty lines, lines with planning time stamps,
20907 clocking lines, and drawers."
20908 (org-back-to-heading t)
20909 (let ((end (save-excursion (outline-next-heading) (point)))
20912 (forward-line 1)
20913 (while (re-search-forward re end t)
20914 (if (not (match-end 1))
20915 ;; empty or planning line
20916 (forward-line 1)
20917 ;; a drawer, find the end
20919 (forward-line 1)))
20921 (point)))
20923 (defun org-forward-same-level (arg &optional invisible-ok)
20924 "Move forward to the arg'th subheading at same level as this one.
20925 Stop at the first and last subheadings of a superior heading.
20926 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20927 it wil also look at invisible ones."
20928 (interactive "p")
20929 (org-back-to-heading invisible-ok)
20930 (org-at-heading-p)
20931 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20933 l)
20934 (forward-char 1)
20935 (while (> arg 0)
20936 (while (and (re-search-forward re nil 'move)
20937 (setq l (- (match-end 0) (match-beginning 0) 1))
20938 (= l level)
20939 (not invisible-ok)
20940 (progn (backward-char 1) (outline-invisible-p)))
20941 (if (< l level) (setq arg 1)))
20942 (setq arg (1- arg)))
20943 (beginning-of-line 1)))
20945 (defun org-backward-same-level (arg &optional invisible-ok)
20946 "Move backward to the arg'th subheading at same level as this one.
20947 Stop at the first and last subheadings of a superior heading."
20948 (interactive "p")
20949 (org-back-to-heading)
20950 (org-at-heading-p)
20951 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20953 l)
20954 (while (> arg 0)
20955 (while (and (re-search-backward re nil 'move)
20956 (setq l (- (match-end 0) (match-beginning 0) 1))
20957 (= l level)
20958 (not invisible-ok)
20959 (outline-invisible-p))
20960 (if (< l level) (setq arg 1)))
20961 (setq arg (1- arg)))))
20963 (defun org-show-subtree ()
20964 "Show everything after this heading at deeper levels."
20965 (outline-flag-region
20966 (point)
20967 (save-excursion
20968 (org-end-of-subtree t t))
20969 nil))
20971 (defun org-show-entry ()
20972 "Show the body directly following this heading.
20973 Show the heading too, if it is currently invisible."
20974 (interactive)
20975 (save-excursion
20976 (condition-case nil
20977 (progn
20978 (org-back-to-heading t)
20979 (outline-flag-region
20980 (max (point-min) (1- (point)))
20981 (save-excursion
20982 (if (re-search-forward
20984 (match-beginning 1)
20985 (point-max)))
20986 nil)
20987 (org-cycle-hide-drawers 'children))
20988 (error nil))))
20990 (defun org-make-options-regexp (kwds &optional extra)
20991 "Make a regular expression for keyword lines."
20992 (concat
20993 "^"
21000 ;; Make isearch reveal the necessary context
21001 (defun org-isearch-end ()
21002 "Reveal context after isearch exits."
21003 (when isearch-success ; only if search was successful
21004 (if (featurep 'xemacs)
21005 ;; Under XEmacs, the hook is run in the correct place,
21006 ;; we directly show the context.
21007 (org-show-context 'isearch)
21008 ;; In Emacs the hook runs *before* restoring the overlays.
21009 ;; So we have to use a one-time post-command-hook to do this.
21010 ;; (Emacs 22 has a special variable, see function `org-mode')
21011 (unless (and (boundp 'isearch-mode-end-hook-quit)
21012 isearch-mode-end-hook-quit)
21013 ;; Only when the isearch was not quitted.
21014 (org-add-hook 'post-command-hook 'org-isearch-post-command
21015 'append 'local)))))
21017 (defun org-isearch-post-command ()
21018 "Remove self from hook, and show context."
21019 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21020 (org-show-context 'isearch))
21023 ;;;; Integration with and fixes for other packages
21025 ;;; Imenu support
21027 (defvar org-imenu-markers nil
21028 "All markers currently used by Imenu.")
21029 (make-variable-buffer-local 'org-imenu-markers)
21031 (defun org-imenu-new-marker (&optional pos)
21032 "Return a new marker for use by Imenu, and remember the marker."
21033 (let ((m (make-marker)))
21034 (move-marker m (or pos (point)))
21035 (push m org-imenu-markers)
21036 m))
21038 (defun org-imenu-get-tree ()
21039 "Produce the index for Imenu."
21040 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21041 (setq org-imenu-markers nil)
21042 (let* ((n org-imenu-depth)
21043 (re (concat "^" (org-get-limited-outline-regexp)))
21044 (subs (make-vector (1+ n) nil))
21045 (last-level 0)
21046 m level head)
21047 (save-excursion
21048 (save-restriction
21049 (widen)
21050 (goto-char (point-max))
21051 (while (re-search-backward re nil t)
21052 (setq level (org-reduced-level (funcall outline-level)))
21053 (when (and (<= level n)
21054 (looking-at org-complex-heading-regexp))
21055 (setq head (org-link-display-format
21056 (org-match-string-no-properties 4))
21057 m (org-imenu-new-marker))
21058 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21059 (if (>= level last-level)
21060 (push (cons head m) (aref subs level))
21061 (push (cons head (aref subs (1+ level))) (aref subs level))
21062 (loop for i from (1+ level) to n do (aset subs i nil)))
21063 (setq last-level level)))))
21064 (aref subs 1)))
21066 (eval-after-load "imenu"
21067 '(progn
21068 (add-hook 'imenu-after-jump-hook
21069 (lambda ()
21070 (if (eq major-mode 'org-mode)
21071 (org-show-context 'org-goto))))))
21073 (defun org-link-display-format (link)
21074 "Replace a link with either the description, or the link target
21075 if no description is present"
21076 (save-match-data
21077 (if (string-match org-bracket-link-analytic-regexp link)
21078 (replace-match (if (match-end 5)
21079 (match-string 5 link)
21080 (concat (match-string 1 link)
21081 (match-string 3 link)))
21082 nil t link)
21083 link)))
21085 (defun org-toggle-link-display ()
21086 "Toggle the literal or descriptive display of links."
21087 (interactive)
21088 (if org-descriptive-links
21089 (progn (org-remove-from-invisibility-spec '(org-link))
21090 (org-restart-font-lock)
21091 (setq org-descriptive-links nil))
21092 (progn (add-to-invisibility-spec '(org-link))
21093 (org-restart-font-lock)
21094 (setq org-descriptive-links t))))
21096 ;; Speedbar support
21098 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21099 "Overlay marking the agenda restriction line in speedbar.")
21100 (overlay-put org-speedbar-restriction-lock-overlay
21101 'face 'org-agenda-restriction-lock)
21102 (overlay-put org-speedbar-restriction-lock-overlay
21103 'help-echo "Agendas are currently limited to this item.")
21104 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21106 (defun org-speedbar-set-agenda-restriction ()
21107 "Restrict future agenda commands to the location at point in speedbar.
21109 (interactive)
21110 (require 'org-agenda)
21111 (let (p m tp np dir txt)
21112 (cond
21113 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21114 'org-imenu t))
21115 (setq m (get-text-property p 'org-imenu-marker))
21116 (with-current-buffer (marker-buffer m)
21117 (goto-char m)
21118 (org-agenda-set-restriction-lock 'subtree)))
21119 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21120 'speedbar-function 'speedbar-find-file))
21121 (setq tp (previous-single-property-change
21122 (1+ p) 'speedbar-function)
21123 np (next-single-property-change
21124 tp 'speedbar-function)
21125 dir (speedbar-line-directory)
21126 txt (buffer-substring-no-properties (or tp (point-min))
21127 (or np (point-max))))
21128 (with-current-buffer (find-file-noselect
21129 (let ((default-directory dir))
21130 (expand-file-name txt)))
21131 (unless (eq major-mode 'org-mode)
21132 (error "Cannot restrict to non-Org-mode file"))
21133 (org-agenda-set-restriction-lock 'file)))
21134 (t (error "Don't know how to restrict Org-mode's agenda")))
21135 (move-overlay org-speedbar-restriction-lock-overlay
21136 (point-at-bol) (point-at-eol))
21137 (setq current-prefix-arg nil)
21138 (org-agenda-maybe-redo)))
21140 (eval-after-load "speedbar"
21141 '(progn
21142 (speedbar-add-supported-extension ".org")
21143 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21144 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21145 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21146 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21147 (add-hook 'speedbar-visiting-tag-hook
21148 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21150 ;;; Fixes and Hacks for problems with other packages
21152 ;; Make flyspell not check words in links, to not mess up our keymap
21153 (defun org-mode-flyspell-verify ()
21154 "Don't let flyspell put overlays at active buttons, or on
21155 {todo,all-time,additional-option-like}-keywords."
21156 (let ((pos (max (1- (point)) (point-min)))
21157 (word (thing-at-point 'word)))
21158 (and (not (get-text-property pos 'keymap))
21159 (not (get-text-property pos 'org-no-flyspell))
21160 (not (member word org-todo-keywords-1))
21161 (not (member word org-all-time-keywords))
21162 (not (member word org-additional-option-like-keywords)))))
21164 (defun org-remove-flyspell-overlays-in (beg end)
21165 "Remove flyspell overlays in region."
21166 (and (org-bound-and-true-p flyspell-mode)
21167 (fboundp 'flyspell-delete-region-overlays)
21168 (flyspell-delete-region-overlays beg end))
21169 (add-text-properties beg end '(org-no-flyspell t)))
21171 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21172 (eval-after-load "bookmark"
21173 '(if (boundp 'bookmark-after-jump-hook)
21174 ;; We can use the hook
21175 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21176 ;; Hook not available, use advice
21177 (defadvice bookmark-jump (after org-make-visible activate)
21178 "Make the position visible."
21179 (org-bookmark-jump-unhide))))
21181 ;; Make sure saveplace shows the location if it was hidden
21182 (eval-after-load "saveplace"
21183 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21184 "Make the position visible."
21185 (org-bookmark-jump-unhide)))
21187 ;; Make sure ecb shows the location if it was hidden
21188 (eval-after-load "ecb"
21189 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21190 "Make hierarchy visible when jumping into location from ECB tree buffer."
21191 (if (eq major-mode 'org-mode)
21192 (org-show-context))))
21194 (defun org-bookmark-jump-unhide ()
21195 "Unhide the current position, to show the bookmark location."
21196 (and (eq major-mode 'org-mode)
21197 (or (outline-invisible-p)
21198 (save-excursion (goto-char (max (point-min) (1- (point))))
21199 (outline-invisible-p)))
21200 (org-show-context 'bookmark-jump)))
21202 ;; Make session.el ignore our circular variable
21203 (eval-after-load "session"
21204 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21206 ;;;; Experimental code
21208 (defun org-closed-in-range ()
21209 "Sparse tree of items closed in a certain time range.
21210 Still experimental, may disappear in the future."
21211 (interactive)
21212 ;; Get the time interval from the user.
21213 (let* ((time1 (org-float-time
21214 (org-read-date nil 'to-time nil "Starting date: ")))
21215 (time2 (org-float-time
21216 (org-read-date nil 'to-time nil "End date:")))
21217 ;; callback function
21218 (callback (lambda ()
21219 (let ((time
21220 (org-float-time
21221 (apply 'encode-time
21222 (org-parse-time-string
21223 (match-string 1))))))
21224 ;; check if time in interval
21225 (and (>= time time1) (<= time time2))))))
21226 ;; make tree, check each match with the callback
21229 ;;;; Finish up
21231 (provide 'org)
21233 (run-hooks 'org-load-hook)
21235 ;;; org.el ends here