| blob | 4d3d804621c6f93577b2b49d12c1da865ca68ae9 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
10 ;; Version: 7.8.03
11 ;;
12 ;; This file is part of GNU Emacs.
13 ;;
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;;
28 ;;; Commentary:
29 ;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
32 ;;
33 ;; Org-mode develops organizational tasks around NOTES files that contain
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode, which makes it possible to keep the content of
36 ;; large files well structured. Visibility cycling and structure editing
37 ;; help to work with the tree. Tables are easily created with a built-in
38 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
39 ;; and scheduling. It dynamically compiles entries into an agenda that
40 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
41 ;; Plain text URL-like links connect to websites, emails, Usenet
42 ;; messages, BBDB entries, and any files related to the projects. For
43 ;; printing and sharing of notes, an Org-mode file can be exported as a
44 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
45 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; linked webpages.
47 ;;
48 ;; Installation and Activation
49 ;; ---------------------------
50 ;; See the corresponding sections in the manual at
51 ;;
52 ;; http://orgmode.org/org.html#Installation
53 ;;
54 ;; Documentation
55 ;; -------------
56 ;; The documentation of Org-mode can be found in the TeXInfo file. The
57 ;; distribution also contains a PDF version of it. At the homepage of
58 ;; Org-mode, you can read the same text online as HTML. There is also an
59 ;; excellent reference card made by Philip Rooke. This card can be found
60 ;; in the etc/ directory of Emacs 22.
61 ;;
62 ;; A list of recent changes can be found at
63 ;; http://orgmode.org/Changes.html
64 ;;
65 ;;; Code:
72 ;;;; Require other packages
80 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
92 ;; Other stuff we need.
110 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
115 ;; babel
124 ;; load languages based on value of `org-babel-load-languages'
126 ;;;###autoload
128 "Load the languages defined in `org-babel-load-languages'."
140 org-babel-load-languages))
143 "Languages which can be evaluated in Org-mode buffers.
144 This list can be used to load support for any of the languages
145 below, note that each language will depend on a different set of
146 system executables and/or Emacs modes. When a language is
148 with `org-babel-execute-src-block' bound by default to C-c
149 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
150 be set to remove code block evaluation from the C-c C-c
151 keybinding. By default only Emacs Lisp (which has no
152 requirements) is loaded."
156 :key-type
196 ;;;; Customization variables
198 "Remove ID property of clones of a subtree.
199 When non-nil, clones of a subtree don't inherit the ID property.
200 Otherwise they inherit the ID property with a new unique
201 identifier."
205 ;;; Version
211 "Show the org-mode version in the echo area.
212 With prefix arg HERE, insert it at point."
238 ;;; Compatibility constants
240 ;;; The custom variables
243 "Outline-based notes management and organizer."
249 "Mode hook for Org-mode, run after the mode was turned on."
254 "Hook that is run after org.el has been loaded."
259 "Hook that is run after an Org log buffer is created."
268 "Load all extensions listed in `org-modules'."
273 org-modules)
277 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
286 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
287 "Modules that should always be loaded together with org.el.
288 If a description starts with <C>, the file is not part of Emacs
289 and loading it will require that you have downloaded and properly installed
290 the org-mode distribution.
292 You can also use this system to load external packages (i.e. neither Org
293 core modules, nor modules from the CONTRIB directory). Just add symbols
294 to the end of the list. If the package is called org-xyz.el, then you need
295 to add the symbol `xyz', and the package must have a call to
297 (provide 'org-xyz)"
300 :type
331 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
340 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
349 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
365 "Non-nil means make shift-cursor commands select text when possible.
367 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
368 start selecting a region, or enlarge regions started in this way.
369 In Org-mode, in special contexts, these same keys are used for
370 other purposes, important enough to compete with shift selection.
371 Org tries to balance these needs by supporting `shift-select-mode'
372 outside these special contexts, under control of this variable.
374 The default of this variable is nil, to avoid confusing behavior. Shifted
375 cursor keys will then execute Org commands in the following contexts:
376 - on a headline, changing TODO state (left/right) and priority (up/down)
377 - on a time stamp, changing the time
378 - in a plain list item, changing the bullet type
379 - in a property definition line, switching between allowed values
380 - in the BEGIN line of a clock table (changing the time block).
381 Outside these contexts, the commands will throw an error.
383 When this variable is t and the cursor is not in a special
384 context, Org-mode will support shift-selection for making and
385 enlarging regions. To make this more effective, the bullet
386 cycling will no longer happen anywhere in an item line, but only
387 if the cursor is exactly on the bullet.
389 If you set this variable to the symbol `always', then the keys
390 will not be special in headlines, property lines, and item lines,
391 to make shift selection work there as well. If this is what you
392 want, you can use the following alternative commands: `C-c C-t'
393 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
394 can be used to switch TODO sets, `C-c -' to cycle item bullet
395 types, and properties can be edited by hand or in column view.
397 However, when the cursor is on a timestamp, shift-cursor commands
398 will still edit the time stamp - this is just too good to give up.
400 XEmacs user should have this variable set to nil, because
401 `shift-select-mode' is in Emacs 23 or later only."
409 "Shall some commands act upon headlines in the active region?
411 When set to `t', some commands will be performed in all headlines
412 within the active region.
414 When set to `start-level', some commands will be performed in all
415 headlines within the active region, provided that these headlines
416 are of the same level than the first one.
418 When set to a string, those commands will be performed on the
419 matching headlines within the active region. Such string must be
420 a tags/property/todo match as it is used in the agenda tags view.
422 The list of commands is: `org-schedule', `org-deadline',
423 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
424 `org-archive-to-archive-sibling'. The archiving commands skip
425 already archived entries."
434 "Options concerning startup of Org-mode."
439 "Non-nil means entering Org-mode will switch to OVERVIEW.
440 This can also be configured on a per-file basis by adding one of
441 the following lines anywhere in the buffer:
443 #+STARTUP: fold (or `overview', this is equivalent)
444 #+STARTUP: nofold (or `showall', this is equivalent)
445 #+STARTUP: content
446 #+STARTUP: showeverything"
455 "Non-nil means entering Org-mode will set `truncate-lines'.
456 This is useful since some lines containing links can be very long and
457 uninteresting. Also tables look terrible when wrapped."
462 "Non-nil means turn on `org-indent-mode' on startup.
463 This can also be configured on a per-file basis by adding one of
464 the following lines anywhere in the buffer:
466 #+STARTUP: indent
467 #+STARTUP: noindent"
475 When this option is turned on, you can use TeX-like syntax for sub- and
477 considered as a single item - so grouping with {} is normally not
478 needed. For example, the following things will be parsed as single
479 sub- or superscripts.
481 10^24 or 10^tau several digits will be considered 1 item.
482 10^-12 or 10^-tau a leading sign with digits or a word
483 x^2-y^3 will be read as x^2 - y^3, because items are
484 terminated by almost any nonword/nondigit char.
485 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
487 Still, ambiguity is possible - so when in doubt use {} to enclose the
488 sub/superscript. If you set this variable to the symbol `{}',
489 the braces are *required* in order to trigger interpretations as
491 frequently in plain text.
493 Not all export backends support this, but HTML does.
508 "Non-nil means turn on `org-beamer-mode' on startup.
509 This can also be configured on a per-file basis by adding one of
510 the following lines anywhere in the buffer:
512 #+STARTUP: beamer"
517 "Non-nil means align all tables when visiting a file.
518 This is useful when the column width in tables is forced with <N> cookies
519 in table fields. Such tables will look correct only after the first re-align.
520 This can also be configured on a per-file basis by adding one of
521 the following lines anywhere in the buffer:
522 #+STARTUP: align
523 #+STARTUP: noalign"
528 "Non-nil means show inline images when loading a new Org file.
529 This can also be configured on a per-file basis by adding one of
530 the following lines anywhere in the buffer:
531 #+STARTUP: inlineimages
532 #+STARTUP: noinlineimages"
537 "Non-nil means insert the first line setting Org-mode in empty files.
538 When the function `org-mode' is called interactively in an empty file, this
539 normally means that the file name does not automatically trigger Org-mode.
540 To ensure that the file will always be in Org-mode in the future, a
541 line enforcing Org-mode will be inserted into the buffer, if this option
542 has been set."
547 "Non-nil means use alternative key bindings for some keys.
548 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
549 These keys are also used by other packages like shift-selection-mode'
550 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
551 If you want to use Org-mode together with one of these other modes,
552 or more generally if you would like to move some Org-mode commands to
553 other keys, set this variable and configure the keys with the variable
554 `org-disputed-keys'.
556 This option is only relevant at load-time of Org-mode, and must be set
557 *before* org.el is loaded. Changing it requires a restart of Emacs to
558 become effective."
563 "Non-nil means use extra key sequence definitions for certain commands.
564 This happens automatically if you run XEmacs or if `window-system'
565 is nil. This variable lets you do the same manually. You must
566 set it before loading org.
568 Example: on Carbon Emacs 22 running graphically, with an external
569 keyboard on a Powerbook, the default way of setting M-left might
570 not work for either Alt or ESC. Setting this variable will make
571 it work for ESC."
585 "Keys for which Org-mode and other modes compete.
586 This is an alist, cars are the default keys, second element specifies
587 the alternative to use when `org-replace-disputed-keys' is t.
589 Keys can be specified in any syntax supported by `define-key'.
590 The value of this option takes effect only at Org-mode's startup,
591 therefore you'll have to restart Emacs to apply it after changing."
596 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
597 Or return the original if not disputed.
598 Also apply the translations defined in `org-xemacs-key-equivalents'."
603 org-disputed-keys)))
607 key)
617 "Define a key, possibly translated, as returned by `org-key'."
621 "The ellipsis to use in the Org-mode outline.
622 When nil, just use the standard three dots. When a string, use that instead,
623 When a face, use the standard 3 dots, but with the specified face.
624 The change affects only Org-mode (which will then use its own display table).
625 Changing this requires executing `M-x org-mode' in a buffer to become
626 effective."
636 "Keywords in Org-mode."
641 "String to mark deadline entries.
642 A deadline is this string, followed by a time stamp. Should be a word,
643 terminated by a colon. You can insert a schedule keyword and
645 Changes become only effective after restarting Emacs."
650 "String to mark scheduled TODO entries.
651 A schedule is this string, followed by a time stamp. Should be a word,
652 terminated by a colon. You can insert a schedule keyword and
654 Changes become only effective after restarting Emacs."
659 "String used as the prefix for timestamps logging closing a TODO entry."
664 "String used as prefix for timestamps clocking work hours on an item."
669 "Entries starting with this keyword will never be exported.
670 An entry can be toggled between COMMENT and normal with
672 Changes become only effective after restarting Emacs."
677 "Entries starting with this keyword will be exported in fixed-width font.
678 Quoting applies only to the text in the entry following the headline, and does
679 not extend beyond the next headline, even if that is lower level.
680 An entry can be toggled between QUOTE and normal with
687 "Regular expression for specifying repeated events.
691 "Options concerning the general structure of Org-mode files."
696 "Options about how to make context of a location visible."
720 "Non-nil means show full hierarchy when revealing a location.
721 Org-mode often shows locations in an org-mode file which might have
722 been invisible before. When this is set, the hierarchy of headings
723 above the exposed location is shown.
724 Turning this off for example for sparse trees makes them very compact.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. Valid contexts are
727 agenda when exposing an entry from the agenda
728 org-goto when using the command `org-goto' on key C-c C-j
729 occur-tree when using the command `org-occur' on key C-c /
730 tags-tree when constructing a sparse tree based on tags matches
731 link-search when exposing search matches associated with a link
732 mark-goto when exposing the jump goal of a mark
733 bookmark-jump when exposing a bookmark location
734 isearch when exiting from an incremental search
735 default default for all contexts not set explicitly"
740 "Non-nil means show following heading when revealing a location.
741 Org-mode often shows locations in an org-mode file which might have
742 been invisible before. When this is set, the heading following the
743 match is shown.
744 Turning this off for example for sparse trees makes them very compact,
745 but makes it harder to edit the location of the match. In such a case,
747 Instead of t, this can also be an alist specifying this option for different
748 contexts. See `org-show-hierarchy-above' for valid contexts."
753 "Non-nil means show all sibling heading when revealing a location.
754 Org-mode often shows locations in an org-mode file which might have
755 been invisible before. When this is set, the sibling of the current entry
756 heading are all made visible. If `org-show-hierarchy-above' is t,
757 the same happens on each level of the hierarchy above the current entry.
759 By default this is on for the isearch context, off for all other contexts.
760 Turning this off for example for sparse trees makes them very compact,
761 but makes it harder to edit the location of the match. In such a case,
763 Instead of t, this can also be an alist specifying this option for different
764 contexts. See `org-show-hierarchy-above' for valid contexts."
769 "Non-nil means show the entry below a headline when revealing a location.
770 Org-mode often shows locations in an org-mode file which might have
771 been invisible before. When this is set, the text below the headline that is
772 exposed is also shown.
774 By default this is off for all contexts.
775 Instead of t, this can also be an alist specifying this option for different
776 contexts. See `org-show-hierarchy-above' for valid contexts."
781 "How should indirect tree buffers be displayed?
782 This applies to indirect buffers created with the commands
784 Valid values are:
785 current-window Display in the current window
786 other-window Just display in another window.
787 dedicated-frame Create one new frame, and re-use it each time.
788 new-frame Make a new frame each time. Note that in this case
789 previously-made indirect buffers are kept, and you need to
790 kill these buffers yourself."
800 "Non-nil means activate single letter commands at beginning of a headline.
801 This may also be a function to test for appropriate locations where speed
802 commands should be active."
810 "Alist of additional speed commands.
811 This list will be checked before `org-speed-commands-default'
812 when the variable `org-use-speed-commands' is non-nil
813 and when the cursor is at the beginning of a headline.
814 The car if each entry is a string with a single letter, which must
815 be assigned to `self-insert-command' in the global map.
816 The cdr is either a command to be called interactively, a function
817 to be called, or a form to be evaluated.
818 An entry that is just a list with a single string will be interpreted
819 as a descriptive headline that will be added when listing the speed
820 commands in the Help buffer using the `?' speed command."
832 "Options concerning visibility cycling in Org-mode."
837 "Non-nil means skip CHILDREN state in entries that don't have any."
842 "Maximum level which should still be subject to visibility cycling.
843 Levels higher than this will, for cycling, be treated as text, not a headline.
844 When `org-odd-levels-only' is set, a value of N in this variable actually
845 means 2N-1 stars as the limiting headline.
846 When nil, cycle all levels.
847 Note that the limiting level of cycling is also influenced by
848 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
849 `org-inlinetask-min-level' is, cycling will be limited to levels one less
850 than its value."
857 "Names of drawers. Drawers are not opened by cycling on the headline above.
858 Drawers only open with a TAB on the drawer line itself. A drawer looks like
859 this:
860 :DRAWERNAME:
861 .....
862 :END:
864 the property API.
866 Drawers can be defined on the per-file basis with a line like:
868 #+DRAWERS: HIDDEN STATE PROPERTIES"
874 "Non-nil means entering Org-mode will fold all blocks.
875 This can also be set in on a per-file basis with
877 #+STARTUP: hideblocks
878 #+STARTUP: showblocks"
884 "Cycle globally if cursor is at beginning of buffer and not at a headline.
885 This makes it possible to do global cycling without having to use S-TAB or
887 of the buffer
888 must not be a headline - it may be empty or some other text. When used in
889 this way, `org-cycle-hook' is disables temporarily, to make sure the
890 cursor stays at the beginning of the buffer.
891 When this option is nil, don't do anything special at the beginning
892 of the buffer."
897 "Non-nil means cycle entry level or item indentation in new empty entries.
899 When the cursor is at the end of an empty headline, i.e with only stars
900 and maybe a TODO keyword, TAB will then switch the entry to become a child,
901 and then all possible ancestor states, before returning to the original state.
902 This makes data entry extremely fast: M-RET to create a new headline,
903 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
905 When the cursor is at the end of an empty plain list item, one TAB will
906 make it a subitem, two or more tabs will back up to make this an item
907 higher up in the item hierarchy."
912 "Where should `org-cycle' emulate TAB.
913 nil Never
914 white Only in completely white lines
915 whitestart Only at the beginning of lines, before the first non-white char
916 t Everywhere except in headlines
917 exc-hl-bol Everywhere except at the start of a headline
918 If TAB is used in a place where it does not emulate TAB, the current subtree
919 visibility is cycled."
926 ))
929 "Number of empty lines needed to keep an empty line between collapsed trees.
930 If you leave an empty line between the end of a subtree and the following
931 headline, this empty line is hidden when the subtree is folded.
932 Org-mode will leave (exactly) one empty line visible if the number of
933 empty lines is equal or larger to the number given in this variable.
934 So the default 2 means at least 2 empty lines after the end of a subtree
935 are needed to produce free space between a collapsed subtree and the
936 following headline.
938 If the number is negative, and the number of empty lines is at least -N,
939 all empty lines are shown.
941 Special case: when 0, never leave empty lines in collapsed view."
947 "Hook that is run before visibility cycling is happening.
948 The function(s) in this hook must accept a single argument which indicates
949 the new state that will be set right after running this hook. The
950 argument is a symbol. Before a global state change, it can have the values
951 `overview', `content', or `all'. Before a local state change, it can have
952 the values `folded', `children', or `subtree'."
957 org-cycle-hide-drawers
958 org-cycle-show-empty-lines
959 org-optimize-window-after-visibility-change)
960 "Hook that is run after `org-cycle' has changed the buffer visibility.
961 The function(s) in this hook must accept a single argument which indicates
962 the new state that was set by the most recent `org-cycle' command. The
963 argument is a symbol. After a global state change, it can have the values
964 `overview', `content', or `all'. After a local state change, it can have
965 the values `folded', `children', or `subtree'."
970 "Options concerning structure editing in Org-mode."
975 "Non-nil means skip even levels and only use odd levels for the outline.
976 This has the effect that two stars are being added/taken away in
977 promotion/demotion commands. It also influences how levels are
978 handled by the exporters.
979 Changing it requires restart of `font-lock-mode' to become effective
980 for fontification also in regions already fontified.
981 You may also set this on a per-file basis by adding one of the following
982 lines to the buffer:
984 #+STARTUP: odd
985 #+STARTUP: oddeven"
991 "Non-nil means adapt indentation to outline node level.
993 When this variable is set, Org assumes that you write outlines by
994 indenting text in each node to align with the headline (after the stars).
995 The following issues are influenced by this variable:
997 - When this is set and the *entire* text in an entry is indented, the
998 indentation is increased by one space in a demotion command, and
999 decreased by one in a promotion command. If any line in the entry
1000 body starts with text at column 0, indentation is not changed at all.
1002 - Property drawers and planning information is inserted indented when
1003 this variable s set. When nil, they will not be indented.
1005 - TAB indents a line relative to context. The lines below a headline
1006 will be indented when this variable is set.
1008 Note that this is all about true indentation, by adding and removing
1009 space characters. See also `org-indent.el' which does level-dependent
1010 indentation in a virtual way, i.e. at display time in Emacs."
1015 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1017 When t, `C-a' will bring back the cursor to the beginning of the
1018 headline text, i.e. after the stars and after a possible TODO
1019 keyword. In an item, this will be the position after bullet and
1020 check-box, if any. When the cursor is already at that position,
1021 another `C-a' will bring it to the beginning of the line.
1023 `C-e' will jump to the end of the headline, ignoring the presence
1024 of tags in the headline. A second `C-e' will then jump to the
1025 true end of the line, after any tags. This also means that, when
1026 this variable is non-nil, `C-e' also will never jump beyond the
1027 end of the heading of a folded section, i.e. not after the
1028 ellipses.
1030 When set to the symbol `reversed', the first `C-a' or `C-e' works
1031 normally, going to the true line boundary first. Only a directly
1032 following, identical keypress will bring the cursor to the
1033 special positions.
1035 This may also be a cons cell where the behavior for `C-a' and
1036 `C-e' is set separately."
1055 "Non-nil means `C-k' will behave specially in headlines.
1056 When nil, `C-k' will call the default `kill-line' command.
1057 When t, the following will happen while the cursor is in the headline:
1059 - When the cursor is at the beginning of a headline, kill the entire
1060 line and possible the folded subtree below the line.
1061 - When in the middle of the headline text, kill the headline up to the tags.
1062 - When after the headline text, kill the tags."
1067 "Non-nil means, do not delete a hidden subtree with C-k.
1068 When set to the symbol `error', simply throw an error when C-k is
1069 used to kill (part-of) a headline that has hidden text behind it.
1070 Any other non-nil value will result in a query to the user, if it is
1071 OK to kill that hidden subtree. When nil, kill without remorse."
1079 "Check if in invisible region before inserting or deleting a character.
1080 Valid values are:
1082 nil Do not check, so just do invisible edits.
1083 error Throw an error and do nothing.
1084 show Make point visible, and do the requested edit.
1085 show-and-error Make point visible, then throw an error and abort the edit.
1086 smart Make point visible, and do insertion/deletion if it is
1087 adjacent to visible text and the change feels predictable.
1088 Never delete a previously invisible character or add in the
1089 middle or right after an invisible region. Basically, this
1090 allows insertion and backward-delete right before ellipses.
1091 FIXME: maybe in this case we should not even show?"
1101 "Non-nil means when yanking subtrees, fold them.
1102 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1103 it starts with a heading and all other headings in it are either children
1104 or siblings, then fold all the subtrees. However, do this only if no
1105 text after the yank would be swallowed into a folded tree by this action."
1110 "Non-nil means when yanking subtrees, adjust the level.
1111 With this setting, `org-paste-subtree' is used to insert the subtree, see
1112 this function for details."
1117 "Non-nil means M-RET will split the line at the cursor position.
1118 When nil, it will go to the end of the line before making a
1119 new line.
1120 You may also set this option in a different way for different
1121 contexts. Valid contexts are:
1123 headline when creating a new headline
1124 item when creating a new item
1125 table in a table field
1126 default the value to be used for all contexts not explicitly
1127 customized"
1144 "Non-nil means insert new headings after the current subtree.
1145 When nil, the new heading is created directly after the current line.
1148 for the duration of the command."
1154 "Should `org-insert-heading' leave a blank line before new heading/item?
1155 The value is an alist, with `heading' and `plain-list-item' as CAR,
1156 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1157 which case Org will look at the surrounding headings/items and try to
1158 make an intelligent decision whether to insert a blank line or not.
1160 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1161 set, the setting here is ignored and no empty line is inserted, to avoid
1162 breaking the list structure."
1175 "Hook being run after inserting a new heading."
1181 This currently only means they are never auto-wrapped.
1182 When nil, such lines will be treated like ordinary lines.
1183 See also the QUOTE keyword."
1188 "Non-nil means typing characters in `org-goto' starts incremental search."
1193 "Options concerning sparse trees in Org-mode."
1198 "Non-nil means highlight all matches that define a sparse tree.
1199 The highlights will automatically disappear the next time the buffer is
1200 changed by an edit command."
1205 "Non-nil means any change to the buffer will remove temporary highlights.
1206 Such highlights are created by `org-occur' and `org-clock-display'.
1207 When nil, `C-c C-c needs to be used to get rid of the highlights.
1208 The highlights created by `org-preview-latex-fragment' always need
1209 `C-c C-c' to be removed."
1216 "Hook that is run after `org-occur' has constructed a sparse tree.
1217 This can be used to recenter the window to show as much of the structure
1218 as possible."
1223 "Options concerning imenu and speedbar in Org-mode."
1228 "The maximum level for Imenu access to Org-mode headlines.
1229 This also applied for speedbar access."
1234 "Options concerning tables in Org-mode."
1240 When nil, such lines will be treated like ordinary lines.
1242 When equal to the symbol `optimized', the table editor will be optimized to
1243 do the following:
1244 - Automatic overwrite mode in front of whitespace in table fields.
1245 This makes the structure of the table stay in tact as long as the edited
1246 field does not exceed the column width.
1247 - Minimize the number of realigns. Normally, the table is aligned each time
1248 TAB or RET are pressed to move to another field. With optimization this
1249 happens only if changes to a field might have changed the column width.
1250 Optimization requires replacing the functions `self-insert-command',
1251 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1252 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1253 very good at guessing when a re-align will be necessary, but you can always
1256 If you would like to use the optimized version in Org-mode, but the
1257 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1259 This variable can be used to turn on and off the table editor during a session,
1260 but in order to toggle optimization, a restart is required.
1262 See also the variable `org-table-auto-blank-field'."
1270 "Non-nil means cluster self-insert commands for undo when possible.
1271 If this is set, then, like in the Emacs command loop, 20 consecutive
1272 characters will be undone together.
1273 This is configurable, because there is some impact on typing performance."
1278 "Non-nil means TAB will automatically notice a table.el table.
1279 When it sees such a table, it moves point into it and - if necessary -
1280 calls `table-recognize-table'."
1285 "Options concerning links in Org-mode."
1290 "Buffer-local version of `org-link-abbrev-alist', which see.
1295 "Alist of link abbreviations.
1296 The car of each element is a string, to be replaced at the start of a link.
1298 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1300 [[linkkey:tag][description]]
1302 The 'linkkey' must be a word word, starting with a letter, followed
1303 by letters, numbers, '-' or '_'.
1305 If REPLACE is a string, the tag will simply be appended to create the link.
1308 be inserted at that point (see the function `url-hexify-string').
1310 REPLACE may also be a function that will be called with the tag as the
1311 only argument to create the link, which should be returned as a string.
1313 See the manual for examples."
1323 "Non-nil means Org will display descriptive links.
1324 E.g. [[http://orgmode.org][Org website]] will be displayed as
1326 description. When set to `nil', Org will display the full links
1327 literally.
1329 You can interactively set the value of this variable by calling
1330 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1335 "How the path name in file links should be stored.
1336 Valid values are:
1338 relative Relative to the current directory, i.e. the directory of the file
1339 into which the link is being inserted.
1340 absolute Absolute path, if possible with ~ for home directory.
1341 noabbrev Absolute path, no abbreviation of home directory.
1342 adaptive Use relative path for files in the current directory and sub-
1343 directories of it. For other files, use an absolute path."
1352 "Types of links that should be activated in Org-mode files.
1353 This is a list of symbols, each leading to the activation of a certain link
1354 type. In principle, it does not hurt to turn on most link types - there may
1355 be a small gain when turning off unused link types. The types are:
1357 bracket The recommended [[link][description]] or [[link]] links with hiding.
1358 angle Links in angular brackets that may contain whitespace like
1359 <bbdb:Carsten Dominik>.
1360 plain Plain links in normal text, no whitespace, like http://google.com.
1361 radio Text that is matched by a radio target, see manual for details.
1362 tag Tag settings in a headline (link to tag search).
1363 date Time stamps (link to calendar).
1364 footnote Footnote labels.
1366 Changing this variable requires a restart of Emacs to become effective."
1378 "Function to use to generate link descriptions from links.
1379 If nil the link location will be used. This function must take
1380 two parameters; the first is the link and the second the
1381 description `org-insert-link' has generated, and should return the
1382 description to use."
1387 "Options concerning storing links in Org-mode."
1392 "Format of the description part of a link to an email or usenet message.
1393 The following %-escapes will be replaced by corresponding information:
1401 %s subject
1402 %d date
1403 %m message-id.
1405 You may use normal field width specification between the % and the letter.
1406 This is for example useful to limit the length of the subject.
1420 It should match if the message is from the user him/herself."
1425 "Non-nil means storing a link to an Org file will use entry IDs.
1427 Note that before this variable is even considered, org-id must be loaded,
1428 so please customize `org-modules' and turn it on.
1430 The variable can have the following values:
1432 t Create an ID if needed to make a link to the current entry.
1434 create-if-interactive
1435 If `org-store-link' is called directly (interactively, as a user
1436 command), do create an ID to support the link. But when doing the
1437 job for remember, only use the ID if it already exists. The
1438 purpose of this setting is to avoid proliferation of unwanted
1439 IDs, just because you happen to be in an Org file when you
1440 call `org-remember' that automatically and preemptively
1441 creates a link. If you do want to get an ID link in a remember
1442 template to an entry not having an ID, create it first by
1443 explicitly creating a link to it, using `C-c C-l' first.
1445 create-if-interactive-and-no-custom-id
1446 Like create-if-interactive, but do not create an ID if there is
1447 a CUSTOM_ID property defined in the entry. This is the default.
1449 use-existing
1450 Use existing ID, do not create one.
1452 nil Never use an ID to make a link, instead link using a text search for
1453 the headline text."
1458 create-if-interactive)
1460 create-if-interactive-and-no-custom-id)
1465 "Non-nil means file links from `org-store-link' contain context.
1466 A search string will be added to the file name with :: as separator and
1467 used to find the context when the link is activated by the command
1468 `org-open-at-point'. When this option is t, the entire active region
1469 will be placed in the search string of the file link. If set to a
1470 positive integer, only the first n lines of context will be stored.
1473 negates this setting for the duration of the command."
1478 "Non-nil means keep link in list for entire session.
1480 The command `org-store-link' adds a link pointing to the current
1481 location to an internal list. These links accumulate during a session.
1482 The command `org-insert-link' can be used to insert links into any
1483 Org-mode file (offering completion for all stored links). When this
1485 will be removed from the list, to make completing the unused links
1486 more efficient."
1491 "Options concerning following links in Org-mode."
1496 "Function to translate links with different syntax to Org syntax.
1497 This can be used to translate links created for example by the Planner
1498 or emacs-wiki packages to Org syntax.
1499 The function must accept two parameters, a TYPE containing the link
1501 which is everything after the link protocol. It should return a cons
1502 with possibly modified values of type and path.
1503 Org contains a function for this, so if you set this variable to
1504 `org-translate-link-from-planner', you should be able follow many
1505 links created by planner."
1510 "Hook that is run after a link has been followed."
1515 "Non-nil means on links TAB will follow the link.
1516 Needs to be set before org.el is loaded.
1517 This really should not be used, it does not make sense, and the
1518 implementation is bad."
1523 "Non-nil means on links RET will follow the link."
1529 "Non-nil means mouse-1 on a link will follow the link.
1530 A longer mouse click will still set point. Does not work on XEmacs.
1531 Needs to be set before org.el is loaded."
1536 "Number of different positions to be recorded in the ring.
1537 Changing this requires a restart of Emacs to work correctly."
1542 "Non-nil means internal links in Org files must exactly match a headline.
1543 When nil, the link search tries to match a phrase with all words
1544 in the search text."
1550 query-to-create)))
1558 "Setup the frame configuration for following links.
1559 When following a link with Emacs, it may often be useful to display
1560 this link in another window or frame. This variable can be used to
1561 set this up for the different types of links.
1562 For VM, use any of
1563 `vm-visit-folder'
1564 `vm-visit-folder-other-window'
1565 `vm-visit-folder-other-frame'
1566 For Gnus, use any of
1567 `gnus'
1568 `gnus-other-frame'
1569 `org-gnus-no-new-news'
1570 For FILE, use any of
1571 `find-file'
1572 `find-file-other-window'
1573 `find-file-other-frame'
1574 For Wanderlust use any of
1575 `wl'
1576 `wl-other-frame'
1577 For the calendar, use the variable `calendar-setup'.
1578 For BBDB, it is currently only possible to display the matches in
1579 another window."
1603 "Non-nil means use indirect buffer to display infile links.
1604 Activating internal links (from one location in a file to another location
1605 in the same file) normally just jumps to the location. When the link is
1607 is displayed in
1608 another window. When this option is set, the other window actually displays
1609 an indirect buffer clone of the current buffer, to avoid any visibility
1610 changes to the current buffer."
1615 "Non-nil means `org-open-file' will open non-existing files.
1616 When nil, an error will be generated.
1617 This variable applies only to external applications because they
1618 might choke on non-existing files. If the link is to a file that
1619 will be opened in Emacs, the variable is ignored."
1624 "Non-nil means a link to a directory really means to index.org.
1625 When nil, following a directory link will run dired or open a finder/explorer
1626 window on that directory."
1631 "Function and arguments to call for following mailto links.
1632 This is a list with the first element being a Lisp function, and the
1633 remaining elements being arguments to the function. In string arguments,
1634 %a will be replaced by the address, and %s will be replaced by the subject
1635 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1644 "Non-nil means ask for confirmation before executing shell links.
1645 Shell links can be dangerous: just think about a link
1647 [[shell:rm -rf ~/*][Google Search]]
1650 but really it would remove your entire home directory.
1651 Therefore we advise against setting this variable to nil.
1652 Just change it to `y-or-n-p' if you want to confirm with a
1660 'safe-local-variable
1664 "A regexp to skip confirmation for shell links."
1669 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1670 Elisp links can be dangerous: just think about a link
1675 but really it would remove your entire home directory.
1676 Therefore we advise against setting this variable to nil.
1677 Just change it to `y-or-n-p' if you want to confirm with a
1685 'safe-local-variable
1689 "A regexp to skip confirmation for Elisp links."
1697 "Default file applications on a UNIX or GNU/Linux system.
1708 "Default file applications on a MacOS X system.
1710 for some files for which the OS does not have a good default.
1718 'mswindows-shell-execute
1723 'mswindows-shell-execute
1726 "Default file applications on a Windows NT system.
1731 '(
1736 )
1737 "External applications for opening `file:path' items in a document.
1738 Org-mode uses system defaults for different file types, but
1739 you can use this variable to set the application for a given file
1740 extension. The entries in this list are cons cells where the car identifies
1741 files and the cdr the corresponding command. Possible values for the
1742 file identifier are
1744 ways, depending on its contents:
1746 - Alphanumeric characters only:
1747 Match links with this file extension.
1749 to open PDFs with evince.
1751 - Regular expression: Match links where the
1752 filename matches the regexp. If you want to
1753 use groups here, use shy groups.
1757 to open *.html and *.xhtml with firefox.
1759 - Regular expression which contains (non-shy) groups:
1761 anything after that, matches the regexp.
1762 In a custom command string, %1, %2, etc. are replaced with
1763 the parts of the link that were matched by the groups.
1764 For backwards compatibility, if a command string is given
1765 that does not use any of the group matches, this case is
1766 handled identically to the second one (i.e. match against
1767 file name only).
1768 In a custom lisp form, you can access the group matches with
1769 (match-string n link).
1772 to open [[file:document.pdf::5]] with evince at page 5.
1774 `directory' Matches a directory
1775 `remote' Matches a remote file, accessible through tramp or efs.
1776 Remote files most likely should be visited through Emacs
1777 because external applications cannot handle such paths.
1778 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1779 so all files Emacs knows how to handle. Using this with
1780 command `emacs' will open most files in Emacs. Beware that this
1781 will also open html files inside Emacs, unless you add
1783 t Default for files not matched by any of the other options.
1784 `system' The system command to open files, like `open' on Windows
1785 and Mac OS X, and mailcap under GNU/Linux. This is the command
1786 that will be selected if you call `C-c C-o' with a double
1789 Possible values for the command are:
1790 `emacs' The file will be visited by the current Emacs process.
1791 `default' Use the default application for this file type, which is the
1792 association for t in the list, most likely in the system-specific
1793 part.
1794 This can be used to overrule an unwanted setting in the
1795 system-specific variable.
1797 This command is specified by the entry whose car is `system'.
1798 Most likely, the system-specific version of this variable
1799 does define this command, but you can overrule/replace it
1800 here.
1801 string A command to be executed by a shell; %s will be replaced
1802 by the path to the file.
1803 sexp A Lisp form which will be evaluated. The file path will
1804 be available in the Lisp variable `file'.
1805 For more examples, see the system specific constants
1806 `org-file-apps-defaults-macosx'
1807 `org-file-apps-defaults-windowsnt'
1808 `org-file-apps-defaults-gnu'."
1818 auto-mode))
1829 "Options concerning refiling entries in Org-mode."
1834 "Directory with org files.
1835 This is just a default location to look for Org files. There is no need
1836 at all to put your files into this directory. It is only used in the
1837 following situations:
1839 1. When a remember template specifies a target file that is not an
1840 absolute path. The path will then be interpreted relative to
1841 `org-directory'
1842 2. When a remember note is filed away in an interactive way (when exiting the
1843 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1844 with `org-directory' as the default path."
1850 "Default target for storing notes.
1851 Used as a fall back file for org-remember.el and org-capture.el, for
1852 templates that do not specify a target file."
1857 file))
1860 "The default interface to be used for `org-goto'.
1861 Allowed values are:
1862 outline The interface shows an outline of the relevant file
1863 and the correct heading is found by moving through
1864 the outline or by searching with incremental search.
1865 outline-path-completion Headlines in the current buffer are offered via
1866 completion. This is the interface also used by
1867 the refile command."
1874 "Maximum target level when running `org-goto' with refile interface."
1879 "Non-nil means store new notes at the beginning of a file or entry.
1880 When nil, new notes will be filed to the end of a file or entry.
1881 This can also be a list with cons cells of regular expressions that
1882 are matched against file names, and values."
1892 "Information to record when a task is refiled.
1894 Possible values are:
1896 nil Don't add anything
1897 time Add a time stamp to the task
1898 note Prompt for a note and add it with template `org-log-note-headings'
1900 This option can also be set with on a per-file-basis with
1902 #+STARTUP: nologrefile
1903 #+STARTUP: logrefile
1904 #+STARTUP: lognoterefile
1906 You can have local logging settings for a subtree by setting the LOGGING
1907 property to one or more of these keywords.
1909 When bulk-refiling from the agenda, the value `note' is forbidden and
1910 will temporarily be changed to `time'."
1920 This is a list of cons cells. Each cell contains:
1921 - a specification of the files to be considered, either a list of files,
1922 or a symbol whose function or variable value will be used to retrieve
1923 a file name or a list of file names. If you use `org-agenda-files' for
1924 that, all agenda files will be scanned for targets. Nil means consider
1925 headings in the current buffer.
1926 - A specification of how to find candidate refile targets. This may be
1927 any of:
1929 This tag has to be present in all target headlines, inheritance will
1930 not be considered.
1932 todo keyword.
1934 headlines that are refiling targets.
1935 - a cons cell (:level . N). Any headline of level N is considered a target.
1936 Note that, when `org-odd-levels-only' is set, level corresponds to
1937 order in hierarchy, not to the number of stars.
1938 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1939 Note that, when `org-odd-levels-only' is set, level corresponds to
1940 order in hierarchy, not to the number of stars.
1942 Each element of this list generates a set of possible targets.
1943 The union of these sets is presented (with completion) to
1944 the user by `org-refile'.
1946 You can set the variable `org-refile-target-verify-function' to a function
1947 to verify each headline found by the simple criteria above.
1949 When this variable is nil, all top-level headlines in the current buffer
1950 are used, equivalent to the value `((nil . (:level . 1))'."
1966 "Function to verify if the headline at point should be a refile target.
1967 The function will be called without arguments, with point at the
1968 beginning of the headline. It should return t and leave point
1969 where it is if the headline is a valid target for refiling.
1971 If the target should not be selected, the function must return nil.
1972 In addition to this, it may move point to a place from where the search
1973 should be continued. For example, the function may decide that the entire
1974 subtree of the current entry should be excluded and move point to the end
1975 of the subtree."
1980 "Non-nil means cache refile targets to speed up the process.
1981 The cache for a particular file will be updated automatically when
1982 the buffer has been killed, or when any of the marker used for flagging
1983 refile targets no longer points at a live buffer.
1984 If you have added new entries to a buffer that might themselves be targets,
1985 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1986 find that easier, `C-u C-u C-u C-c C-w'."
1991 "Non-nil means provide refile targets as paths.
1992 So a level 3 headline will be available as level1/level2/level3.
1994 When the value is `file', also include the file name (without directory)
1995 into the path. In this case, you can also stop the completion after
1996 the file name, to get entries inserted as top level in the file.
1998 When `full-file-path', include the full file path."
2007 "Non-nil means complete the outline path in hierarchical steps.
2008 When Org-mode uses the refile interface to select an outline path
2009 \(see variable `org-refile-use-outline-path'), the completion of
2010 the path can be done is a single go, or if can be done in steps down
2011 the headline hierarchy. Going in steps is probably the best if you
2012 do not use a special completion package like `ido' or `icicles'.
2013 However, when using these packages, going in one step can be very
2014 fast, while still showing the whole path to the entry."
2019 "Non-nil means allow to create new nodes as refile targets.
2021 of an existing node. When the value of this variable is `confirm',
2022 new node creation must be confirmed by the user (recommended)
2023 When nil, the completion must match an existing entry.
2025 Note that, if the new heading is not seen by the criteria
2026 listed in `org-refile-targets', multiple instances of the same
2027 heading would be created by trying again to file under the new
2028 heading."
2036 "Non-nil means also refile active region within a subtree.
2038 By default `org-refile' doesn't allow refiling regions if they
2039 don't contain a set of subtrees, but it might be convenient to
2040 do so sometimes: in that case, the first line of the region is
2041 converted to a headline before refiling."
2046 "Options concerning TODO items in Org-mode."
2051 "Options concerning Progress logging in Org-mode."
2058 "The available interpretation symbols for customizing `org-todo-keywords'.
2062 "List of TODO entry keyword sequences and their interpretation.
2065 Each sequence starts with a symbol, either `sequence' or `type',
2066 indicating if the keywords should be interpreted as a sequence of
2067 action steps, or as different types of TODO items. The first
2068 keywords are states requiring action - these states will select a headline
2069 for inclusion into the global TODO list Org-mode produces. If one of
2072 the last keyword is treated as the only DONE state of the sequence.
2075 additional state where no keyword is present. For details about this
2076 cycling, see the manual.
2078 TODO keywords and interpretation can also be set on a per-file basis with
2079 the special #+SEQ_TODO and #+TYP_TODO lines.
2081 Each keyword can optionally specify a character for fast state selection
2082 \(in combination with the variable `org-use-fast-todo-selection')
2083 and specifiers for state change logging, using the same syntax
2086 indicates to record a time stamp each time this state is selected.
2088 Each keyword may also specify if a timestamp or a note should be
2089 recorded when entering or leaving the state, by adding additional
2090 characters in the parenthesis after the keyword. This looks like this:
2092 record only the time of the state change. With X and Y being either
2094 Y when leaving the state if and only if the *target* state does not
2095 define X. You may omit any of the fast-selection key or X or /Y,
2096 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2098 For backward compatibility, this variable may also be just a list
2099 of keywords - in this case the interpretation (sequence or type) will be
2100 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2110 ;;Quick and dirty way to see
2111 ;;`org-todo-interpretations'. This takes the
2112 ;;place of item arguments
2113 :convert-widget
2120 org-todo-interpretation-widgets))
2121 widget))
2152 "Controls how TODO keywords are interpreted.
2153 This variable is in principle obsolete and is only used for
2154 backward compatibility, if the interpretation of todo keywords is
2155 not given already in `org-todo-keywords'. See that variable for
2156 more information."
2163 "Non-nil means use the fast todo selection scheme with C-c C-t.
2164 This variable describes if and under what circumstances the cycling
2165 mechanism for TODO keywords will be replaced by a single-key, direct
2166 selection scheme.
2168 When nil, fast selection is never used.
2170 When the symbol `prefix', it will be used when `org-todo' is called with
2171 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2172 in an agenda buffer.
2174 When t, fast selection is used by default. In this case, the prefix
2175 argument forces cycling instead.
2177 In all cases, the special interface is only used if access keys have actually
2178 been assigned by the user, i.e. if keywords in the configuration are followed
2179 by a letter in parenthesis, like TODO(t)."
2187 "Non-nil means update todo statistics after insert and toggle.
2188 ALL-HEADLINES means update todo statistics by including headlines
2189 with no TODO keyword as well, counting them as not done.
2190 A list of TODO keywords means the same, but skip keywords that are
2191 not in this list.
2193 When this is set, todo statistics is updated in the parent of the
2194 current entry each time a todo state is changed."
2204 "Non-nil means TODO statistics covers just direct children.
2205 When nil, all entries in the subtree are considered.
2206 This has only an effect if `org-provide-todo-statistics' is set.
2207 To set this to nil for only a single subtree, use a COOKIE_DATA
2213 "Hook which is run after the state of a TODO item was changed.
2214 The new state (a string with a TODO keyword, or nil) is available in the
2215 Lisp variable `state'."
2220 "Hook for functions that are allowed to block a state change.
2222 Each function gets as its single argument a property list, see
2223 `org-trigger-hook' for more information about this list.
2225 If any of the functions in this hook returns nil, the state change
2229 "Hook for functions that are triggered by a state change.
2231 Each function gets as its single argument a property list with at least
2232 the following elements:
2234 (:type type-of-change :position pos-at-entry-start
2235 :from old-state :to new-state)
2237 Depending on the type, more properties may be present.
2239 This mechanism is currently implemented for:
2241 TODO state changes
2242 ------------------
2243 :type todo-state-change
2244 :from previous state (keyword as a string), or nil, or a symbol
2245 'todo' or 'done', to indicate the general type of state.
2249 "Non-nil means undone TODO entries will block switching the parent to DONE.
2250 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2251 be blocked if any prior sibling is not yet done.
2252 Finally, if the parent is blocked because of ordered siblings of its own,
2253 the child will also be blocked.
2254 This variable needs to be set before org.el is loaded, and you need to
2255 restart Emacs after a change to make the change effective. The only way
2256 to change is while Emacs is running is through the customize interface."
2268 "Non-nil means unchecked boxes will block switching the parent to DONE.
2269 When this is nil, checkboxes have no influence on switching TODO states.
2270 When non-nil, you first need to check off all check boxes before the TODO
2271 entry can be switched to DONE.
2272 This variable needs to be set before org.el is loaded, and you need to
2273 restart Emacs after a change to make the change effective. The only way
2274 to change is while Emacs is running is through the customize interface."
2286 "Non-nil means inserting a TODO heading is treated as state change.
2288 logging will apply if appropriate. When nil, the new TODO item will
2289 be inserted directly, and no logging will take place."
2294 "Non-nil means switching TODO states with S-cursor counts as state change.
2295 This is the default behavior. However, setting this to nil allows a
2296 convenient way to select a TODO state and bypass any logging associated
2297 with that."
2302 "Tag changes that should be triggered by TODO state changes.
2303 This is a list. Each entry is
2305 (state-change (tag . flag) .......)
2307 State-change can be a string with a state, and empty string to indicate the
2308 state that has no TODO keyword, or it can be one of the symbols `todo'
2309 or `done', meaning any not-done or done state, respectively."
2323 "Information to record when a task moves to the DONE state.
2325 Possible values are:
2327 nil Don't add anything, just change the keyword
2328 time Add a time stamp to the task
2329 note Prompt for a note and add it with template `org-log-note-headings'
2331 This option can also be set with on a per-file-basis with
2333 #+STARTUP: nologdone
2334 #+STARTUP: logdone
2335 #+STARTUP: lognotedone
2337 You can have local logging settings for a subtree by setting the LOGGING
2338 property to one or more of these keywords."
2346 ;; Normalize old uses of org-log-done.
2353 "Information to record when the scheduling date of a tasks is modified.
2355 Possible values are:
2357 nil Don't add anything, just change the date
2358 time Add a time stamp to the task
2359 note Prompt for a note and add it with template `org-log-note-headings'
2361 This option can also be set with on a per-file-basis with
2363 #+STARTUP: nologreschedule
2364 #+STARTUP: logreschedule
2365 #+STARTUP: lognotereschedule"
2374 "Information to record when the deadline date of a tasks is modified.
2376 Possible values are:
2378 nil Don't add anything, just change the date
2379 time Add a time stamp to the task
2380 note Prompt for a note and add it with template `org-log-note-headings'
2382 This option can also be set with on a per-file-basis with
2384 #+STARTUP: nologredeadline
2385 #+STARTUP: logredeadline
2386 #+STARTUP: lognoteredeadline
2388 You can have local logging settings for a subtree by setting the LOGGING
2389 property to one or more of these keywords."
2398 "Non-nil means record a note when clocking out of an item.
2399 This can also be configured on a per-file basis by adding one of
2400 the following lines anywhere in the buffer:
2402 #+STARTUP: lognoteclock-out
2403 #+STARTUP: nolognoteclock-out"
2409 "Non-nil means the CLOSED time stamp will contain date and time.
2410 When nil, only the date will be recorded."
2424 "Headings for notes added to entries.
2425 The value is an alist, with the car being a symbol indicating the note
2426 context, and the cdr is the heading to be used. The heading may also be the
2427 empty string.
2428 %t in the heading will be replaced by a time stamp.
2429 %T will be an active time stamp instead the default inactive one
2430 %d will be replaced by a short-format time stamp.
2431 %D will be replaced by an active short-format time stamp.
2432 %s will be replaced by the new TODO state, in double quotes.
2433 %S will be replaced by the old TODO state, in double quotes.
2434 %u will be replaced by the user name.
2435 %U will be replaced by the full user name.
2437 In fact, it is not a good idea to change the `state' entry, because
2438 agenda log mode depends on the format of these entries."
2444 "Heading when changing todo state (todo sequence only)"
2458 "Non-nil means insert state change notes and time stamps into a drawer.
2459 When nil, state changes notes will be inserted after the headline and
2460 any scheduling and clock lines, but not inside a drawer.
2462 The value of this variable should be the name of the drawer to use.
2463 LOGBOOK is proposed as the default drawer for this purpose, you can
2464 also set this to a string to define the drawer of your choice.
2468 If this variable is set, `org-log-state-notes-insert-after-drawers'
2469 will be ignored.
2471 You can set the property LOG_INTO_DRAWER to overrule this setting for
2472 a subtree."
2484 "Return the value of `org-log-into-drawer', but let properties overrule.
2485 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2486 used instead of the default value."
2494 "Non-nil means insert state change notes after any drawers in entry.
2495 Only the drawers that *immediately* follow the headline and the
2496 deadline/scheduled line are skipped.
2497 When nil, insert notes right after the heading and perhaps the line
2498 with deadline/scheduling if present.
2500 This variable will have no effect if `org-log-into-drawer' is
2501 set."
2507 "Non-nil means the latest state note will be directly after heading.
2508 When nil, the state change notes will be ordered according to time."
2514 "The TODO state to which a repeater should return the repeating task.
2515 By default this is the first task in a TODO sequence, or the previous state
2516 in a TODO_TYP set. But you can specify another task here.
2517 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2523 "Non-nil means record moving through the DONE state when triggering repeat.
2524 An auto-repeating task is immediately switched back to TODO when
2527 record a closing note, there will be no record of the task moving
2528 through DONE. This variable forces taking a note anyway.
2530 nil Don't force a record
2531 time Record a time stamp
2532 note Record a note
2534 This option can also be set with on a per-file-basis with
2536 #+STARTUP: logrepeat
2537 #+STARTUP: lognoterepeat
2538 #+STARTUP: nologrepeat
2540 You can have local logging settings for a subtree by setting the LOGGING
2541 property to one or more of these keywords."
2551 "Priorities in Org-mode."
2556 "Non-nil means priority commands are active.
2557 When nil, these commands will be disabled, so that you never accidentally
2558 set a priority."
2563 "The highest priority of TODO items. A character like ?A, ?B etc.
2564 Must have a smaller ASCII number than `org-lowest-priority'."
2569 "The lowest priority of TODO items. A character like ?A, ?B etc.
2570 Must have a larger ASCII number than `org-highest-priority'."
2575 "The default priority of TODO items.
2576 This is the priority an item gets if no explicit priority is given.
2577 When starting to cycle on an empty priority the first step in the cycle
2578 depends on `org-priority-start-cycle-with-default'. The resulting first
2579 step priority must not exceed the range from `org-highest-priority' to
2580 `org-lowest-priority' which means that `org-default-priority' has to be
2581 in this range exclusive or inclusive the range boundaries. Else the
2582 first step refuses to set the default and the second will fall back
2583 to (depending on the command used) the highest or lowest priority."
2588 "Non-nil means start with default priority when starting to cycle.
2589 When this is nil, the first step in the cycle will be (depending on the
2590 command used) one higher or lower than the default priority.
2591 See also `org-default-priority'."
2596 "Function to extract the priority from a string.
2597 The string is normally the headline. If this is nil Org computes the
2598 priority from the priority cookie like [#A] in the headline. It returns
2599 an integer, increasing by 1000 for each priority level.
2600 The user can set a different function here, which should take a string
2601 as an argument and return the numeric priority."
2606 "Options concerning time stamps and deadlines in Org-mode."
2611 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2612 When nil, these labeled time stamps are forces into the second line of an
2613 entry, just after the headline. When scheduling from the global TODO list,
2614 the time stamp will always be forced into the second line."
2619 "Formats for `format-time-string' which are used for time stamps.
2623 "Number of minutes to round time stamps to.
2624 These are two values, the first applies when first creating a time stamp.
2625 The second applies when changing it with the commands `S-up' and `S-down'.
2626 When changing the time stamp, this means that it will change in steps
2627 of N minutes, as given by the second value.
2629 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2630 numbers should be factors of 60, so for example 5, 10, 15.
2632 When this is larger than 1, you can still force an exact time stamp by using
2633 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2634 and by using a prefix arg to `S-up/down' to specify the exact number
2635 of minutes to shift."
2645 ;; Normalize old customizations of this variable.
2649 org-time-stamp-rounding-minutes)))
2652 "Non-nil means overlay custom formats over all time stamps.
2653 The formats are defined through the variable `org-time-stamp-custom-formats'.
2654 To turn this on on a per-file basis, insert anywhere in the file:
2655 #+STARTUP: customtime"
2663 "Custom formats for time stamps. See `format-time-string' for the syntax.
2664 These are overlaid over the default ISO format if the variable
2665 `org-display-custom-times' is set. Time like %H:%M should be at the
2666 end of the second format. The custom formats are also honored by export
2667 commands, if custom time display is turned on at the time of export."
2672 "Get the right format for a time string."
2677 f)))
2680 "The format string used when creating CLOCKSUM lines.
2681 This is also used when org-mode generates a time duration."
2687 org-mode generates a time duration."
2692 "The format string used when creating CLOCKSUM lines, or when
2693 org-mode generates a time duration."
2698 "No. of days before expiration during which a deadline becomes active.
2699 This variable governs the display in sparse trees and in the agenda.
2700 When 0 or negative, it means use this number (the absolute value of it)
2701 even if a deadline has a different individual lead time specified.
2703 Custom commands can set this variable in the options section."
2709 "Non-nil means assume future for incomplete date input from user.
2710 This affects the following situations:
2711 1. The user gives a month but not a year.
2714 2. The user gives a day, but no month.
2717 it will be considered as *this* month.
2719 If you set this variable to the symbol `time', then also the following
2720 will work:
2722 3. If the user gives a time, but no day. If the time is before now,
2723 to will be interpreted as tomorrow.
2725 Currently none of this works for ISO week specifications.
2727 When this option is nil, the current day, month and year will always be
2728 used as defaults.
2730 See also `org-agenda-jump-prefer-future'."
2738 "Should the agenda jump command prefer the future for incomplete dates?
2739 The default is to do the same as configured in `org-read-date-prefer-future'.
2740 But you can also set a deviating value here.
2741 This may t or nil, or the symbol `org-read-date-prefer-future'."
2746 org-read-date-prefer-future)
2751 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2753 Depending on the system Emacs is running on, certain dates cannot
2754 be represented with the type used internally to represent time.
2755 Dates between 1970-1-1 and 2038-1-1 can always be represented
2756 correctly. Some systems allow for earlier dates, some for later,
2757 some for both. One way to find out it to insert any date into an
2758 Org buffer, putting the cursor on the year and hitting S-up and
2759 S-down to test the range.
2761 When this variable is set to t, the date/time prompt will not let
2762 you specify dates outside the 1970-2037 range, so it is certain that
2763 these dates will work in whatever version of Emacs you are
2764 running, and also that you can move a file from one Emacs implementation
2765 to another. WHenever Org is forcing the year for you, it will display
2766 a message and beep.
2768 When this variable is nil, Org will check if the date is
2769 representable in the specific Emacs implementation you are using.
2770 If not, it will force a year, usually the current year, and beep
2771 to remind you. Currently this setting is not recommended because
2772 the likelihood that you will open your Org files in an Emacs that
2773 has limited date range is not negligible.
2775 A workaround for this problem is to use diary sexp dates for time
2776 stamps outside of this range."
2781 "Non-nil means display current interpretation of date prompt live.
2782 This display will be in an overlay, in the minibuffer."
2787 "Non-nil means pop up a calendar when prompting for a date.
2788 In the calendar, the date can be selected with mouse-1. However, the
2789 minibuffer will also be active, and you can simply enter the date as well.
2790 When nil, only the minibuffer will be available."
2798 "Hook to be used to set up keys for the date/time interface.
2799 Add key definitions to `minibuffer-local-map', which will be a temporary
2800 copy."
2805 "The hour when your day really ends. Must be an integer.
2806 This has influence for the following applications:
2808 the time given here, the day recognized as TODAY is actually yesterday.
2809 - When a date is read from the user and it is still before the time given
2810 here, the current date and time will be assumed to be yesterday, 23:59.
2811 Also, timestamps inserted in remember templates follow this rule.
2813 IMPORTANT: This is a feature whose implementation is and likely will
2814 remain incomplete. Really, it is only here because past midnight seems to
2815 be the favorite working time of John Wiegley :-)"
2820 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2821 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2823 23:59 of the previous day."
2828 "Non-nil means S-down will increase the time in a time stamp.
2829 When nil, S-up will increase."
2834 "Non-nil means make the calendar window follow timestamp changes.
2835 When a timestamp is modified and the calendar window is visible, it will be
2836 moved to the new date."
2841 "Options concerning tags in Org-mode."
2846 "List of tags allowed in Org-mode files.
2847 When this list is nil, Org-mode will base TAG input on what is already in the
2848 buffer.
2849 The value of this variable is an alist, the car of each entry must be a
2850 keyword as a string, the cdr may be a character that is used to select
2851 that tag through the fast-tag-selection interface.
2852 See the manual for details."
2867 "List of tags that will always appear in all Org-mode files.
2868 This is in addition to any in buffer settings or customizations
2869 of `org-tag-alist'.
2870 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2871 The value of this variable is an alist, the car of each entry must be a
2872 keyword as a string, the cdr may be a character that is used to select
2873 that tag through the fast-tag-selection interface.
2874 See the manual for details.
2875 To disable these tags on a per-file basis, insert anywhere in the file:
2876 #+STARTUP: noptag"
2887 "If non-nil, always offer completion for all tags of all agenda files.
2888 Instead of customizing this variable directly, you might want to
2889 set it locally for capture buffers, because there no list of
2890 tags in that file can be created dynamically (there are none).
2892 (add-hook 'org-capture-mode-hook
2893 (lambda ()
2894 (set (make-local-variable
2895 'org-complete-tags-always-offer-all-agenda-tags)
2896 t)))"
2901 "List of tags that can be inherited by all entries in the file.
2902 The tags will be inherited if the variable `org-use-tag-inheritance'
2903 says they should be.
2907 "Non-nil means use fast tag selection scheme.
2908 This is a special interface to select and deselect tags with single keys.
2909 When nil, fast selection is never used.
2910 When the symbol `auto', fast selection is used if and only if selection
2911 characters for tags have been configured, either through the variable
2912 `org-tag-alist' or through a #+TAGS line in the buffer.
2913 When t, fast selection is always used and selection keys are assigned
2914 automatically if necessary."
2922 "Non-nil means fast tag selection exits after first change.
2923 When nil, you have to press RET to exit it.
2924 During fast tag selection, you can toggle this flag with `C-c'.
2925 This variable can also have the value `expert'. In this case, the window
2926 displaying the tags menu is not even shown, until you press C-c again."
2934 "Non-nil means fast tags selection interface will also offer TODO states.
2938 "The column to which tags should be indented in a headline.
2939 If this number is positive, it specifies the column. If it is negative,
2940 it means that the tags should be flushright to that column. For example,
2941 -80 works well for a normal 80 character screen.
2942 When 0, place tags directly after headline text, with only one space in
2943 between."
2948 "Non-nil keeps tags aligned when modifying headlines.
2949 Some operations (i.e. demoting) change the length of a headline and
2950 therefore shift the tags around. With this option turned on, after
2951 each such operation the tags are again aligned to `org-tags-column'."
2956 "Non-nil means tags in levels apply also for sublevels.
2957 When nil, only the tags directly given in a specific line apply there.
2958 This may also be a list of tags that should be inherited, or a regexp that
2959 matches tags that should be inherited. Additional control is possible
2960 with the variable `org-tags-exclude-from-inheritance' which gives an
2961 explicit list of tags to be excluded from inheritance., even if the value of
2962 `org-use-tag-inheritance' would select it for inheritance.
2964 If this option is t, a match early-on in a tree can lead to a large
2965 number of matches in the subtree when constructing the agenda or creating
2966 a sparse tree. If you only want to see the first match in a tree during
2967 a search, check out the variable `org-tags-match-list-sublevels'."
2976 "List of tags that should never be inherited.
2977 This is a way to exclude a few tags from inheritance. For way to do
2978 the opposite, to actively allow inheritance for selected tags,
2979 see the variable `org-use-tag-inheritance'."
2984 "Check if TAG is one that should be inherited."
2996 "Non-nil means list also sublevels of headlines matching a search.
2997 This variable applies to tags/property searches, and also to stuck
2998 projects because this search is based on a tags match as well.
3000 When set to the symbol `indented', sublevels are indented with
3001 leading dots.
3003 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3004 the sublevels of a headline matching a tag search often also match
3005 the same search. Listing all of them can create very long lists.
3006 Setting this variable to nil causes subtrees of a match to be skipped.
3008 This variable is semi-obsolete and probably should always be true. It
3009 is better to limit inheritance to certain tags using the variables
3010 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3018 "When set, tags are sorted using this function as a comparator."
3034 "Options concerning properties in Org-mode."
3039 "How property key/value pairs should be formatted by `indent-line'.
3040 When `indent-line' hits a property definition, it will format the line
3041 according to this format, mainly to make sure that the values are
3042 lined-up with respect to each other."
3047 "Alist of properties and functions to adjust inserted values.
3048 Elements of this alist must be of the form
3050 ([string] [function])
3052 where [string] must be a property name and [function] must be a
3053 lambda expression: this lambda expression must take one argument,
3054 the value to adjust, and return the new value as a string.
3058 and the clock summary:
3061 (let ((clocksum (org-clock-sum-current-item))
3062 (effort (org-duration-string-to-minutes
3064 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3069 "Non-nil means properties apply also for sublevels.
3071 This setting is chiefly used during property searches. Turning it on can
3072 cause significant overhead when doing a search, which is why it is not
3073 on by default.
3075 When nil, only the properties directly given in the current entry count.
3076 When t, every property is inherited. The value may also be a list of
3077 properties that should have inheritance, or a regular expression matching
3078 properties that should be inherited.
3080 However, note that some special properties use inheritance under special
3081 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3083 for valid values of a property.
3085 Note for programmers:
3086 When querying an entry with `org-entry-get', you can control if inheritance
3087 should be used. By default, `org-entry-get' looks only at the local
3088 properties. You can request inheritance by setting the inherit argument
3089 to t (to force inheritance) or to `selective' (to respect the setting
3090 in this variable)."
3099 "Check if PROPERTY is one that should be inherited."
3110 "The default column format, if no other format has been defined.
3111 This variable can be set on the per-file basis by inserting a line
3113 #+COLUMNS: %25ITEM ....."
3118 "The ellipses to be used when a field in column view is truncated.
3119 When this is the empty string, as many characters as possible are shown,
3120 but then there will be no visual indication that the field has been truncated.
3121 When this is a string of length N, the last N characters of a truncated
3122 field are replaced by this string. If the column is narrower than the
3123 ellipses string, only part of the ellipses string will be shown."
3128 "Function that modifies values for display in column view.
3129 For example, it can be used to cut out a certain part from a time stamp.
3130 The function must take 2 arguments:
3132 column-title The title of the column (*not* the property name)
3133 value The value that should be modified.
3135 The function should return the value that should be displayed,
3136 or nil if the normal value should be used."
3141 "The property that is being used to keep track of effort estimates.
3142 Effort estimates given in this property need to have the format H:MM."
3150 "List of property/value pairs that can be inherited by any entry.
3152 These are fixed values, for the preset properties. The user variable
3153 that can be used to add to this list is `org-global-properties'.
3155 The entries in this list are cons cells where the car is a property
3156 name and cdr is a string with the value. If the value represents
3161 "List of property/value pairs that can be inherited by any entry.
3163 This list will be combined with the constant `org-global-properties-fixed'.
3165 The entries in this list are cons cells where the car is a property
3166 name and cdr is a string with the value.
3168 You can set buffer-local values for the same purpose in the variable
3169 `org-file-properties' this by adding lines like
3171 #+PROPERTY: NAME VALUE"
3178 "List of property/value pairs that can be inherited by any entry.
3179 Valid for the current buffer.
3184 "Options concerning agenda views in Org-mode."
3189 "Variable used by org files to set a category for agenda display.
3190 Such files should use a file variable to set it, for example
3194 or contain a special line
3196 #+CATEGORY: ELisp
3198 If the file does not specify a category, then file's base name
3204 "The files to be used for agenda display.
3208 If an entry is a directory, all files in that directory that are matched by
3209 `org-agenda-file-regexp' will be part of the file list.
3211 If the value of the variable is not a list but a single file name, then
3212 the list of agenda files is actually stored and maintained in that file, one
3213 agenda file per line. In this file paths can be given relative to
3214 `org-directory'. Tilde expansion and environment variable substitution
3215 are also made."
3222 "Regular expression to match files for `org-agenda-files'.
3223 If any element in the list in that variable contains a directory instead
3224 of a normal file, all files in that directory that are matched by this
3225 regular expression will be included."
3230 "List of extra files to be searched by text search commands.
3231 These files will be search in addition to the agenda files by the
3232 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3233 Note that these files will only be searched for text search commands,
3234 not for the other agenda views like todo lists, tag searches or the weekly
3235 agenda. This variable is intended to list notes and possibly archive files
3236 that should also be searched by these two commands.
3237 In fact, if the first element in the list is the symbol `agenda-archives',
3238 than all archive files of all agenda files will be added to the search
3239 scope."
3250 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3251 A nil value means to remove them, after a query, from the list."
3256 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3257 The command `org-calendar-goto-agenda' will be bound to this key. The
3258 default is the character `c' because then `c' can be used to switch back and
3259 forth between agenda and calendar."
3264 "The key to be installed in `calendar-mode-map' for agenda-action.
3265 The command `org-agenda-action' will be bound to this key. The
3266 default is the character `k' because we use the same key in the agenda."
3271 "The key to be installed in `calendar-mode-map' for adding diary entries.
3272 This option is irrelevant until `org-agenda-diary-file' has been configured
3273 to point to an Org-mode file. When that is the case, the command
3274 `org-agenda-diary-entry' will be bound to the key given here, by default
3275 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3276 if you want to continue doing this, you need to change this to a different
3277 key."
3282 "File to which to add new entries with the `i' key in agenda and calendar.
3283 When this is the symbol `diary-file', the functionality in the Emacs
3284 calendar will be used to add entries to the `diary-file'. But when this
3285 points to a file, `org-agenda-diary-entry' will be used instead."
3301 org-calendar-insert-diary-entry-key
3305 "Options for embedding LaTeX code into Org-mode."
3313 "Options for creating images from LaTeX fragments.
3314 This is a property list with the following properties:
3316 `default' means use the foreground of the default face.
3318 `default' means use the background of the default face.
3319 :scale a scaling factor for the size of the images, to get more pixels
3320 :html-foreground, :html-background, :html-scale
3321 the same numbers for HTML export.
3322 :matchers a list indicating which matchers should be used to
3323 find LaTeX fragments. Valid members of this list are:
3334 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3335 When nil, just push out a message."
3340 Use this to specify additional executable file say a jar file.
3342 When using MathToWeb as the converter, specify the full-path to
3343 your mathtoweb.jar file."
3350 "Command to convert LaTeX fragments to MathML.
3351 Replace format-specifiers in the command as noted below and use
3352 `shell-command' to convert LaTeX to MathML.
3353 %j: Executable file in fully expanded form as specified by
3354 `org-latex-to-mathml-jar-file'.
3355 %I: Input LaTeX file in fully expanded form
3356 %o: Output MathML file
3357 This command is used by `org-create-math-formula'.
3359 When using MathToWeb as the converter, set this to
3367 "Return t if `org-latex-to-mathml-convert-command' is usable."
3370 org-latex-to-mathml-convert-command)
3372 org-latex-to-mathml-convert-command))))
3377 t))))))
3384 \[PACKAGES]
3385 \[DEFAULT-PACKAGES]
3386 % The settings below are copied from fullpage.sty
3399 "The document header used for processing LaTeX fragments.
3400 It is imperative that this header make sure that no page number
3401 appears on the page. The package defined in the variables
3402 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3404 will be appended."
3411 "Set the packages alist and make sure it has 3 elements per entry."
3415 x))
3416 val)))
3420 "Get the packages alist and make sure it has 3 elements per entry."
3424 x))
3427 ;; The following variables are defined here because is it also used
3428 ;; when formatting latex fragments. Originally it was part of the
3429 ;; LaTeX exporter, which is why the name includes "export".
3446 )
3447 "Alist of default packages to be inserted in the header.
3448 Change this only if one of the packages here causes an incompatibility
3449 with another package you are using.
3450 The packages in this list are needed by one part or another of Org-mode
3451 to function properly.
3453 - inputenc, fontenc: for basic font and character selection
3454 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3455 for interpreting the entities in `org-entities'. You can skip some of these
3456 packages if you don't use any of the symbols in it.
3457 - graphicx: for including images
3458 - float, wrapfig: for figure placement
3459 - longtable: for long tables
3460 - hyperref: for cross references
3462 Therefore you should not modify this variable unless you know what you
3463 are doing. The one reason to change it anyway is that you might be loading
3464 some other package that conflicts with one of the default packages.
3466 If SNIPPET-FLAG is t, the package also needs to be included when
3467 compiling LaTeX snippets into images for inclusion into HTML."
3480 "Alist of packages to be inserted in every LaTeX header.
3481 These will be inserted after `org-export-latex-default-packages-alist'.
3483 SNIPPET-FLAG, when t, indicates that this package is also needed when
3484 turning LaTeX snippets into images for inclusion into HTML.
3485 Make sure that you only list packages here which:
3486 - you want in every file
3487 - do not conflict with the default packages in
3488 `org-export-latex-default-packages-alist'
3489 - do not conflict with the setup in `org-format-latex-header'."
3503 "Settings for Org-mode appearance."
3508 "Non-nil means fontify only the stars in each headline.
3509 When nil, the entire headline is fontified.
3510 Changing it requires restart of `font-lock-mode' to become effective
3511 also in regions already fontified."
3516 "Non-nil means hide the first N-1 stars in a headline.
3517 This works by using the face `org-hide' for these stars. This
3518 face is white for a light background, and black for a dark
3519 background. You may have to customize the face `org-hide' to
3520 make this work.
3521 Changing it requires restart of `font-lock-mode' to become effective
3522 also in regions already fontified.
3523 You may also set this on a per-file basis by adding one of the following
3524 lines to the buffer:
3526 #+STARTUP: hidestars
3527 #+STARTUP: showstars"
3532 "List of symbols corresponding to keywords to be hidden the org buffer.
3533 For example, a value '(title) for this list will make the document's title
3534 appear in the buffer without the initial #+TITLE: keyword."
3542 "Non-nil means change the face of a headline if it is marked DONE.
3543 Normally, only the TODO/DONE keyword indicates the state of a headline.
3544 When this is non-nil, the headline after the keyword is set to the
3545 `org-headline-done' as an additional indication."
3550 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3551 Changing this variable requires a restart of Emacs to take effect."
3556 "Non-nil means fontify the whole line for headings.
3557 This is useful when setting a background color for the
3558 org-level-* faces."
3563 "Non-nil means fontify what is treated specially by the exporters."
3568 "Non-nil mean font-lock should hide the emphasis marker characters."
3573 "Non-nil means show entities as UTF8 characters.
3579 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3584 "Regular expression for matching emphasis.
3585 After a match, the match groups contain these elements:
3586 0 The match of the full regular expression, including the characters
3587 before and after the proper match
3588 1 The character before the proper match, or empty at beginning of line
3589 2 The proper match, including the leading and trailing markers
3590 3 The leading marker like * or /, indicating the type of highlighting
3591 4 The text between the emphasis markers, not including the markers
3598 "Set variable and compute the emphasis regular expression."
3602 org-emphasis-alist org-emphasis-regexp-components)
3614 ;; make sure special characters appear at the right position in the class
3626 ;; Make the regexp
3634 body1
3646 body1
3654 "Components used to build the regular expression for emphasis.
3655 This is a list with five entries. Terminology: In an emphasis string
3659 specify what is allowed/forbidden in each part:
3661 pre Chars allowed as prematch. Beginning of line will be allowed too.
3662 post Chars allowed as postmatch. End of line will be allowed too.
3663 border The chars *forbidden* as border characters.
3665 non-shy groups here, and don't allow newline here.
3666 newline The maximum number of newlines allowed in an emphasis exp.
3668 Use customize to modify this, or restart Emacs after changing it."
3687 )
3688 "Special syntax for emphasized text.
3689 Text starting and ending with a special character will be emphasized, for
3690 example *bold*, _underlined_ and /italic/. This variable sets the marker
3691 characters, the face to be used by font-lock for highlighting in Org-mode
3692 Emacs buffers, and the HTML tags to be used for this.
3693 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3694 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3695 Use customize to modify this, or restart Emacs after changing it."
3710 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3713 ;;; Miscellaneous options
3716 "Completion in Org-mode."
3721 "Non-nil means use ido completion wherever possible.
3722 Note that `ido-mode' must be active for this variable to be relevant.
3723 If you decide to turn this variable on, you might well want to turn off
3724 `org-outline-path-complete-in-steps'.
3725 See also `org-completion-use-iswitchb'."
3730 "Non-nil means use iswitchb completion wherever possible.
3731 Note that `iswitchb-mode' must be active for this variable to be relevant.
3732 If you decide to turn this variable on, you might well want to turn off
3733 `org-outline-path-complete-in-steps'.
3734 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3740 Normal means, no org-mode-specific context."
3744 ;;; Functions and variables from their packages
3745 ;; Declared here to avoid compiler warnings
3747 ;; XEmacs only
3753 ;; Emacs only
3756 ;; Various packages
3775 org-agenda-format-item "org-agenda"
3806 ;;; Autoload and prepare some org modules
3808 ;; Some table stuff that needs to be defined here, because it is used
3809 ;; by the functions setting up org-mode or checking for table context.
3822 "Detect the first line outside a table when searching from within it.
3825 ;; Autoload the functions in org-table.el that are needed by functions here.
3830 org-table-convert org-table-convert-region org-table-copy-down
3831 org-table-copy-region org-table-create
3832 org-table-create-or-convert-from-region
3833 org-table-create-with-table.el org-table-current-dline
3834 org-table-cut-region org-table-delete-column org-table-edit-field
3835 org-table-edit-formulas org-table-end org-table-eval-formula
3836 org-table-export org-table-field-info
3837 org-table-get-stored-formulas org-table-goto-column
3838 org-table-hline-and-move org-table-import org-table-insert-column
3839 org-table-insert-hline org-table-insert-row org-table-iterate
3840 org-table-justify-field-maybe org-table-kill-row
3841 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3842 org-table-move-column org-table-move-column-left
3843 org-table-move-column-right org-table-move-row
3844 org-table-move-row-down org-table-move-row-up
3845 org-table-next-field org-table-next-row org-table-paste-rectangle
3846 org-table-previous-field org-table-recalculate
3847 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3848 org-table-toggle-coordinate-overlays
3849 org-table-toggle-formula-debugger org-table-wrap-region
3850 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3851 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3852 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3855 "Return t if the cursor is inside an org-type table.
3856 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3861 org-table-line-regexp)))
3862 nil))
3866 "Return t if and only if we are at a table.el table."
3872 "If there is a table.el table nearby, recognize it and move into it."
3878 nil
3888 t
3893 t)
3894 nil)
3895 nil))
3898 "Return t if the cursor is inside a hline in a table."
3903 nil))
3908 "Apply FUNCTION to the start of all tables in the buffer."
3924 ;; Declare and autoload functions from org-exp.el & Co
3932 org-insert-export-options-template
3933 org-table-clean-before-export))
3936 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3937 org-export-region-as-ascii))
3940 org-replace-region-by-latex org-export-region-as-latex
3941 org-export-as-latex org-export-as-pdf
3942 org-export-as-pdf-and-open))
3945 org-export-as-html-batch org-export-as-html-to-buffer
3946 org-replace-region-by-html org-export-region-as-html
3947 org-export-as-html))
3950 org-replace-region-by-docbook org-export-region-as-docbook
3951 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3952 org-export-as-docbook))
3955 org-export-icalendar-all-agenda-files
3956 org-export-icalendar-combine-agenda-files))
3960 ;; Declare and autoload functions from org-agenda.el
3965 org-todo-list org-tags-view org-agenda-list-stuck-projects
3966 org-diary org-agenda-to-appt
3967 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3969 ;; Autoload org-remember
3974 org-remember-apply-template org-remember org-remember-handler)))
3979 org-capture-import-remember-templates)))
3981 ;; Autoload org-clock.el
3996 "Return non-nil if clock is currently running.
3997 The return value is actually the clock marker."
4002 "org-clock"
4004 org-clock-goto org-clock-sum org-clock-display
4005 org-clock-remove-overlays org-clock-report
4006 org-clocktable-shift org-dblock-write:clocktable
4007 org-get-clocktable org-resolve-clocks)))
4010 "If this is a CLOCK line, update it and return t.
4011 Otherwise, return nil."
4020 ts te h m s neg)
4023 nil)
4028 ;; The clock is running here
4049 t))))))
4052 "Check if the current buffer contains the running clock.
4053 If yes, offer to stop it and to save the buffer with the changes."
4062 "Check if this line starts a clock table, if yes, shift the time block."
4066 ;; Autoload org-timer.el
4070 "org-timer"
4072 org-timer-change-times-in-region
4073 org-timer-set-timer
4074 org-timer-reset-timers
4075 org-timer-show-remaining-time)))
4077 ;; Autoload org-feed.el
4081 "org-feed"
4085 ;; Autoload org-indent.el
4087 ;; Define the variable already here, to make sure we have it.
4089 "Non-nil if Org-Indent mode is enabled.
4094 "org-indent"
4097 ;; Autoload org-mobile.el
4101 "org-mobile"
4104 ;; Autoload archiving code
4105 ;; The stuff that is needed for cycling and tags has to be defined here.
4108 "Options concerning archiving in Org-mode."
4113 "The location where subtrees should be archived.
4115 The value of this variable is a string, consisting of two parts,
4116 separated by a double-colon. The first part is a filename and
4117 the second part is a headline.
4119 When the filename is omitted, archiving happens in the same file.
4120 %s in the filename will be replaced by the current file
4121 name (without the directory part). Archiving to a different file
4122 is useful to keep archived entries from contributing to the
4123 Org-mode Agenda.
4125 The archived entries will be filed as subtrees of the specified
4126 headline. When the headline is omitted, the subtrees are simply
4127 filed away at the end of the file, as top-level entries. Also in
4128 the heading you can use %s to represent the file name, this can be
4129 useful when using the same archive for a number of different files.
4131 Here are a few examples:
4133 If the current file is Projects.org, archive in file
4134 Projects.org_archive, as top-level trees. This is the default.
4137 Archive in the current file, under the top-level headline
4141 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4144 Archive in file ~/org/archive.org (absolute path), under headlines
4148 Archive in file ./basement (relative path), as level 3 trees
4151 You may set this option on a per-file basis by adding to the buffer a
4152 line like
4154 #+ARCHIVE: basement::** Finished Tasks
4156 You may also define it locally for a subtree by setting an ARCHIVE property
4157 in the entry. If such a property is found in an entry, or anywhere up
4158 the hierarchy, it will be used."
4163 "The tag that marks a subtree as archived.
4164 An archived subtree does not open during visibility cycling, and does
4165 not contribute to the agenda listings.
4166 After changing this, font-lock must be restarted in the relevant buffers to
4167 get the proper fontification."
4173 "Non-nil means the agenda will skip any items located in archived trees.
4174 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4175 variable is no longer recommended, you should leave it at the value t.
4176 Instead, use the key `v' to cycle the archives-mode in the agenda."
4182 "Non-nil means ignore archived trees when creating column view."
4188 "Non-nil means `org-cycle' will open archived trees.
4189 An archived tree is a tree marked with the tag ARCHIVE.
4190 When nil, archived trees will stay folded. You can still open them with
4191 normal outline commands like `show-all', but not with the cycling commands."
4197 "Non-nil means sparse tree construction shows matches in archived trees.
4198 When nil, matches in these trees are highlighted, but the trees are kept in
4199 collapsed state."
4205 "Re-hide all archived subtrees after a visibility state change."
4216 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4219 "Cycle subtree even if it is archived."
4226 "Re-hide all archived subtrees after a visibility state change."
4241 flag)))
4248 org-archive-to-archive-sibling org-toggle-archive-tag
4249 org-archive-subtree-default
4250 org-archive-subtree-default-with-confirmation)))
4252 ;; Autoload Column View Code
4260 org-columns-compute org-agenda-columns org-columns-remove-overlays
4263 ;; Autoload ID code
4271 org-id-get-with-outline-path-completion
4272 org-id-get-with-outline-drilling org-id-store-link
4273 org-id-goto org-id-find org-id-store-link))
4275 ;; Autoload Plotting Code
4280 ;;; Variables for pre-computed regular expressions, all buffer local
4298 "Matches a headline and puts everything into groups:
4299 group 1: the stars
4300 group 2: The todo keyword, maybe
4301 group 3: Priority cookie
4302 group 4: True headline
4306 "Printf format to make regexp to match an exact headline.
4307 This regexp will match the headline of any node which has the
4308 exact headline text that is put into the format, but may have any
4312 "Matches a headline and puts TODO state into group 2 if present.
4361 "Regular expression to match a plain time or time range.
4362 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4363 groups carry important information:
4364 0 the full match
4365 1 the first time, range or not
4373 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4374 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4375 groups carry important information:
4376 0 the full match
4377 7 hours of duration
4386 "Regular expression to match a timestamp time or time range.
4387 After a match, the following groups carry important information:
4388 0 the full match
4389 1 date plus weekday, for back referencing to make sure both times are on the same day
4390 2 the first time, range or not
4445 "Variable associated with STARTUP options for org-mode.
4446 Each element is a list of three items: The startup options as written
4447 in the #+STARTUP line, the corresponding variable, and the value to
4448 set this variable to if the option is found. An optional forth element PUSH
4452 "Update PROPS with KEY and VAL."
4466 "Printf format for a regexp matching an headline with some keyword.
4467 This regexp will match the headline of any node which has the
4468 exact keyword that is put into the format. The keyword isn't in
4472 "Printf format for a regexp matching an headline, possibly with some keyword.
4473 This regexp can match any headline with the specified keyword, or
4474 without a keyword. The keyword isn't in any group by default,
4478 "Precompute regular expressions for current buffer."
4498 kwds kws0 kwsa key log value cat arch tags const links hw dws
4499 tail sep kws1 prio props ftags drawers beamer-p
4521 ;; general TODO-like setup
4533 links)))
4540 props))))
4545 ftags
4555 l var val)
4585 ;; search for property blocks
4594 props)))))))
4611 ;; Process the TODO keywords
4613 ;; Use the global values as if they had been given locally.
4625 kws)))
4628 kwsa nil
4631 ;; 1 2
4639 kw)
4641 kws0)
4658 ;; Process the constants
4666 ;; Process the tags.
4677 tgs))
4685 ;; Compute the regular expressions and other local variables.
4686 ;; Using `org-outline-regexp-bol' would complicate them much,
4687 ;; because of the fixed white space at the end of that string.
4695 org-drawer-regexp
4699 org-not-done-keywords
4701 org-todo-regexp
4705 org-not-done-regexp
4709 org-not-done-heading-regexp
4711 org-todo-line-regexp
4713 org-complex-heading-regexp
4720 org-complex-heading-regexp-format
4725 ;; Stats cookies can be stuck to body.
4732 org-todo-line-tags-regexp
4739 org-deadline-time-regexp
4741 org-deadline-line-regexp
4743 org-scheduled-regexp
4745 org-scheduled-time-regexp
4747 org-closed-time-regexp
4749 org-keyword-time-regexp
4755 org-keyword-time-not-clock-regexp
4761 org-maybe-keyword-time-regexp
4767 org-planning-or-clock-line-re
4772 org-all-time-keywords
4775 org-clock-string org-closed-string))
4776 )
4781 "Return the contents of FILE, as a string."
4795 "Extract the log state setting from a TODO keyword string.
4809 "Remove a pair of parenthesis at the end of each string in LIST."
4813 x))
4814 list))
4817 "Assign fast keys to a keyword-key alist.
4818 Respect keys that are already there."
4836 ;;; Some variables used in various places
4843 "Function to be called when `C-c C-c' is used.
4847 ;; FIXME: Occasionally check by commenting these, to make sure
4848 ;; no other functions uses these, forgetting to let-bind them.
4853 ;; Defined somewhere in this file, but used before definition.
4859 ;;;; Define the Org-mode
4862 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
4865 ;; We use a before-change function to check if a table might need
4866 ;; an update.
4868 "Indicates that a table might need an update.
4869 This variable is set by `org-before-change-function'.
4872 "Every change indicates that a table might need an update."
4882 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4883 ;; some places -- e.g. see the macro org-with-limited-levels.
4884 ;;
4885 ;; In Org buffers, the value of `outline-regexp' is that of
4886 ;; `org-outline-regexp'. The only function still directly relying on
4887 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4888 ;; job when `orgstruct-mode' is active.
4892 "Regexp to match Org headlines.
4893 This is similar to `org-outline-regexp' but additionally makes
4897 "Matches an headline, putting stars and text into groups.
4900 ;;;###autoload
4902 "Outline-based notes management and organizer, alias
4905 Org-mode develops organizational tasks around a NOTES file which
4906 contains information about projects as plain text. Org-mode is
4907 implemented on top of outline-mode, which is ideal to keep the content
4908 of large files well structured. It supports ToDo items, deadlines and
4909 time stamps, which magically appear in the diary listing of the Emacs
4910 calendar. Tables are easily created with a built-in table editor.
4911 Plain text URL-like links connect to websites, emails (VM), Usenet
4912 messages (Gnus), BBDB entries, and any files related to the project.
4913 For printing and sharing of notes, an Org-mode file (or a part of it)
4914 can be exported as a structured ASCII or HTML file.
4916 The following commands are available:
4920 ;; Get rid of Outline menus, they are not needed
4921 ;; Need to do this here because define-derived-mode sets up
4922 ;; the keymap so late. Still, it is a waste to call this each time
4923 ;; we switch another buffer into org-mode.
4926 ;; Assume this is Greg's port, it uses easymenu
4952 org-display-table 4
4955 org-ellipsis)))
4960 ;; tag faces set outside customize.... force initialization.
4962 ;; Calc embedded
4968 ;; Activate before-change-function
4972 ;; Check for running clock before killing a buffer
4974 ;; Paragraphs and auto-filling
4978 ;; Beginning/end of defun
4981 ;; Next error for sparse trees
4983 ;; Make sure dependence stuff works reliably, even for users who set it
4984 ;; too late :-(
4996 ;; Comment characters
5000 ;; Align options lines
5002 'align-mode-rules-list
5007 ;; Imenu
5011 ;; Make isearch reveal context
5014 ;; Emacs 21 and XEmacs make use of the hook
5016 ;; Emacs 22 deals with this through a special variable
5020 ;; Turn on org-beamer-mode?
5023 ;; Setup the pcomplete hooks
5036 ;; If empty file that did not turn on org-mode automatically, make it to.
5061 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5071 "Return today date, considering `org-extend-today-until'."
5076 ;;;; Font-Lock stuff, including the activators
5107 "Regular expression used to analyze links.
5108 Here is what the match groups contain after a match:
5109 1: http:
5110 2: http
5111 3: path
5112 4: [desc]
5120 "Number of stacked braces for sub/superscript matching.
5121 This has to be set before loading org.el to be effective."
5126 "Create a regular expression which will match a balanced sexp.
5127 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5128 as single character strings.
5129 The regexp returned will match the entire expression including the
5130 delimiters. It will also define a single group which contains the
5131 match except for the outermost delimiters. The maximum depth of
5132 stacked delimiters is N. Escaping delimiters is not possible."
5161 "Update the link regular expressions.
5162 This should be called after the variable `org-link-types' has changed."
5166 org-link-re-with-space
5172 org-link-re-with-space2
5178 org-link-re-with-space3
5183 org-angle-link-re
5189 org-plain-link-re
5193 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5194 org-bracket-link-regexp
5196 org-bracket-link-analytic-regexp
5204 org-bracket-link-analytic-regexp++
5212 org-any-link-re
5221 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5223 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5224 "Regular expression matching time strings for analysis.
5225 This one does not require the space after the date, so it can be used
5227 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5243 "Regular expression matching a time stamp or time stamp range.
5249 "Run through the buffer and add overlays to emphasized strings."
5258 'face
5271 rtn))
5274 "Insert or change an emphasis, i.e. a font like bold or italic.
5275 If there is an active region, change that region to a new emphasis.
5276 If there is no region, just insert the marker characters and position
5277 the cursor between them.
5278 CHAR should be either the marker character, or the first character of the
5279 HTML tag associated with that emphasis. If CHAR is a space, the means
5280 to remove the emphasis of the selected region.
5281 If char is not given (for example in an interactive call) it
5282 will be prompted for."
5333 "Run through the buffer and add overlays to links."
5342 nil
5348 t)))))
5356 t)))
5359 "When non-nil, fontify code in code blocks."
5370 "Fontify #+ lines and blocks, in the correct ways."
5373 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5374 limit t)
5382 end end1 quoting block-type ovl)
5385 ;; a single line of backend-specific content
5393 ; for backend-specific code
5394 t)
5396 ;; Truly a block
5408 beg end
5416 ;; remove old background overlays
5421 ;; add a background overlay
5435 t))
5448 ;; just any other in-buffer setting, but not indented
5452 t)
5460 t)
5468 "Run through the buffer and add overlays to links."
5476 t)))
5479 "Run through the buffer and add overlays to footnotes."
5486 'keymap org-mouse-map
5487 'help-echo
5489 "Footnote definition"
5491 'font-lock-fontified t
5492 'font-lock-multiline t
5496 "Run through the buffer and add overlays to bracketed links."
5500 ;; FIXME: above we should remove the escapes.
5501 ;; but that requires another match, protecting match data,
5502 ;; a lot of overhead for font-lock.
5509 ;; We need to remove the invisible property here. Table narrowing
5510 ;; may have made some of this invisible.
5528 t)))
5531 "Run through the buffer and add overlays to dates."
5543 t)))
5552 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5556 "Run through the buffer and add overlays to target matches."
5564 'keymap org-mouse-map
5568 t)))))
5571 "Find all radio targets in this file and update the regular expression."
5586 t)))
5593 ;; This should be with the exporter code, but we also use if for font-locking
5603 "Compute regular expression for stuff treated specially by exporters."
5610 org-latex-regexps)))
5638 org-entities)))
5642 org-latex-entities)
5643 nil))
5645 ))
5646 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5649 org-export-html-special-string-regexps)))
5654 ))))
5656 'org-latex-and-specials-regexp
5661 "Run through the buffer and add overlays to links."
5665 limit t))
5679 rtn)))
5682 "Restart `font-lock-mode', to force refontification."
5688 "Return a list of all targets in this file.
5689 With optional argument RADIO, only find radio targets."
5691 rtn)
5696 rtn)))
5699 "Make regular expression matching all strings in TARGETS.
5700 The regular expression finds the targets also if there is a line break
5701 between words."
5710 x)
5711 targets
5723 t)))
5726 "Compute the outline level of the heading at point.
5727 This function assumes that the cursor is at the beginning of a line matched
5728 by `outline-regexp'. Otherwise it returns garbage.
5729 If this is called at a normal headline, the level is the number of stars.
5730 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5737 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5744 "Functions that can manipulate `org-font-lock-extra-keywords'.
5745 This is called after `org-font-lock-extra-keywords' is defined, but before
5746 it is installed to be used by font lock. This can be useful if something
5757 ;; Call the hook
5759 ;; Headlines
5766 ;; Table lines
5769 ;; Table internals
5774 ;; Drawers
5777 ;; Properties
5781 ;; Links
5791 ;; TODO keyword
5793 org-todo-regexp)
5795 ;; DONE
5803 nil)
5804 ;; Priorities
5806 ;; Tags
5808 ;; Special keywords
5813 ;; Emphasis
5818 ;; Checkboxes
5819 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5824 ;; Description list items
5827 ;; ARCHIVEd headings
5829 org-outline-regexp-bol
5832 ;; Specials
5836 ;; Code
5838 ;; COMMENT
5845 ;; Blocks and meta lines
5847 )))
5850 ;; Now set the full font-lock-keywords
5857 "Toggle the composition display of entities as UTF8 characters."
5869 "Find an entity to fontify."
5875 limit t)
5887 nil))))
5890 "Fontify string S like in Org-mode."
5902 "Get the right face for match N in font-lock matching of headlines."
5915 "Get the right face for a TODO keyword KWD.
5916 If KWD is a number, get the corresponding match group."
5924 "Create a face list that inherits INHERIT, but sets the foreground color.
5925 When FACE-OR-COLOR is not a string, just return it."
5929 face-or-color)
5930 face-or-color))
5933 "Add the special tag faces."
5942 "Add the special priority faces."
5949 org-priority-faces)))
5954 "Get the right face for a TODO keyword KWD.
5955 If KWD is a number, get the corresponding match group."
5962 "Remove fontification and activation overlays from links."
5967 deactivate-mark buffer-file-name buffer-file-truename)
5971 invisible t intangible t
5972 org-no-flyspell t org-emphasis t))
5982 "Remove specific display properties that have been added by font lock.
5983 The will remove the raise properties that are used to show superscripts
5984 and subscripts."
5994 "Add raise properties to sub/superscripts."
5998 org-match-substring-regexp
5999 org-match-substring-with-braces-regexp)
6000 limit t)
6010 ;; FIXME: Should we go back one character here, for a_b^c
6011 ;; (goto-char (1- pos)) ;????????????????????
6013 t
6015 'display
6031 t)))))
6033 ;;;; Visibility cycling, including org-goto and indirect buffer
6035 ;;; Cycling
6042 ;;;###autoload
6047 "TAB-action and visibility cycling for Org-mode.
6049 This is the command invoked in Org-mode by the TAB key. Its main purpose
6050 is outline visibility cycling, but it also invokes other actions
6051 in special contexts.
6053 - When this function is called with a prefix argument, rotate the entire
6054 buffer through 3 states (global cycling)
6055 1. OVERVIEW: Show only top-level headlines.
6056 2. CONTENTS: Show all headlines of all levels, but no body text.
6057 3. SHOW ALL: Show everything.
6058 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6059 determined by the variable `org-startup-folded', and by any VISIBILITY
6060 properties in the buffer.
6061 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6062 including any drawers.
6064 - When inside a table, re-align the table and move to the next field.
6066 - When point is at the beginning of a headline, rotate the subtree started
6067 by this line through 3 different states (local cycling)
6068 1. FOLDED: Only the main headline is shown.
6069 2. CHILDREN: The main headline and the direct children are shown.
6070 From this state, you can move to one of the children
6071 and zoom in further.
6072 3. SUBTREE: Show the entire subtree, including body text.
6073 If there is no subtree, switch directly from CHILDREN to FOLDED.
6075 - When point is at the beginning of an empty headline and the variable
6076 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6077 of the headline by demoting and promoting it to likely levels. This
6078 speeds up creation document structure by pressing TAB once or several
6079 times right after creating a new headline.
6081 - When there is a numeric prefix, go up to a heading with level ARG, do
6082 a `show-subtree' and return to the previous cursor position. If ARG
6083 is negative, go up that many levels.
6085 - When point is not at the beginning of a headline, execute the global
6086 binding for TAB, which is re-indenting the line. See the option
6087 `org-cycle-emulate-tab' for details.
6089 - Special case: if point is at the beginning of the buffer and there is
6090 no headline in line 1, this function will act as if called with prefix arg
6091 (C-u TAB, same as S-TAB) also when called without prefix arg.
6092 But only if also the variable `org-cycle-global-at-bob' is t."
6102 org-inlinetask-min-level
6107 limit-level)))
6110 outline-regexp
6118 org-cycle-hook))
6122 ;; special case: use global cycling
6136 ;; Table: enter it or move to the next field.
6147 ;; Global cycling: delegate to `org-cycle-internal-global'.
6150 ;; Drawers: delegate to `org-flag-drawer'.
6158 ;; Show-subtree, ARG levels up from here.
6166 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6174 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6181 ;; From there: TAB emulation and template completion.
6203 t
6212 "Do the global cycling action."
6213 ;; Hack to avoid display of messages for .org attachments in Gnus
6218 ;; We just created the overview - now do table of contents
6219 ;; This can be slow in very large buffers, so indicate action
6229 ;; We just showed the table of contents - now show everything
6237 ;; Default action: go to overview
6245 "Do the local cycling action."
6247 ;; First, determine end of headline (EOH), end of subtree or item
6248 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6272 ;; Determine end invisible part of buffer (EOL)
6274 ;; XEmacs doesn't have `next-single-char-property-change'
6284 ;; Find out what to do next and set `this-command'
6287 ;; Nothing is hidden behind this heading
6299 org-cycle-skip-children-state-if-no-children))))
6300 ;; Entire subtree is hidden in one line: children view
6308 ;; Fold every list in subtree to top-level items.
6330 ;; We just showed the children, or no children are there,
6331 ;; now show everything.
6338 ;; Default action: hide the subtree.
6345 ;;;###autoload
6347 "Cycle the global visibility. For details see `org-cycle'.
6349 With a numeric prefix, show all headlines up to that level."
6365 "Set the visibility required by startup options and properties."
6380 "Switch subtree visibilities according to :VISIBILITY: property."
6387 nil t)
6411 ;; This function uses outline-regexp instead of the more fundamental
6412 ;; org-outline-regexp so that org-cycle-global works outside of Org
6413 ;; buffers, where outline-regexp is needed.
6415 "Switch to overview mode, showing only top-level headlines.
6416 Really, this shows all headlines with level equal or greater than the level
6417 of the first headline in the buffer. This is important, because if the
6418 first headline is not level one, then (hide-sublevels 1) gives confusing
6419 results."
6430 "Show all headlines in the buffer, like a table of contents.
6431 With numerical argument N, show content up to level N."
6434 ;; Visit all headings and show their offspring
6441 t)
6450 "Adjust the window after a change in outline visibility.
6451 This function is the default value of the hook `org-cycle-hook'."
6461 "Remove outline overlays that do not contain non-white stuff."
6471 "Fix visibility issues after moving a subtree."
6472 ;; First, find a reasonable region to look at:
6473 ;; Start two siblings above, end three below
6491 ;; Properly fold already folded siblings
6502 "Show empty lines above all visible headlines.
6503 The region to be covered depends on STATE when called through
6504 `org-cycle-hook'. Lisp program can use t for STATE to get the
6505 entire buffer covered. Note that an empty line is only shown if there
6506 are at least `org-cycle-separator-lines' empty lines before the headline."
6516 beg end b e)
6540 ;; Never hide empty lines at the end of the file.
6550 "Move to the parent and re-show empty lines before visible headlines."
6556 "Return `org-agenda-files' list, plus all open org-mode files.
6557 This is useful for operations that need to scan all of a user's
6558 open and agenda-wise Org files."
6566 files))
6569 "Return the beginning position of the current entry."
6573 "Return the end position of the current entry."
6577 "Re-hide all drawers after a visibility state change."
6603 "Is the end of the current subtree visible?"
6608 "Move cursor to the first headline and recenter the headline.
6609 Optional argument N means put the headline into the Nth line of the window."
6615 ;;; Saving and restoring visibility
6618 "Return a list of the locations of all outline overlays.
6619 These are overlays with the `invisible' property value `outline'.
6620 The return value is a list of cons cells, with start and stop
6621 positions for each overlay.
6622 If USE-MARKERS is set, return the positions as markers."
6640 "Create visibility overlays for all positions in DATA.
6641 DATA should have been made by `org-outline-overlay-data'."
6649 data)))))
6651 ;;; Folding of blocks
6658 "Call FUNCTION at the head of all source blocks in the current buffer.
6659 Optional arguments START and END can be used to limit the range."
6671 "Toggle the visibility of all blocks in the current buffer."
6675 "Fold all blocks in the current buffer."
6681 "Unfold all blocks in the current buffer."
6687 "Toggle visibility of block at point."
6698 "Toggle the visibility of the current block."
6705 ov)
6721 ;; make the block accessible to isearch
6723 ov 'isearch-open-invisible
6734 ;; org-tab-after-check-for-cycling-hook
6736 ;; Remove overlays when changing major mode
6741 ;;; Org-goto
6747 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6763 nil)
6764 (org-defkey map "q" 'org-goto-quit)
6765 (org-defkey map "n" 'outline-next-visible-heading)
6766 (org-defkey map "p" 'outline-previous-visible-heading)
6767 (org-defkey map "f" 'outline-forward-same-level)
6768 (org-defkey map "b" 'outline-backward-same-level)
6769 (org-defkey map "u" 'outline-up-heading))
6770 (org-defkey map "/" 'org-occur)
6771 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6772 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6773 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6774 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6775 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6776 map))
6778 (defconst org-goto-help
6779 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6780 RET=jump to location [Q]uit and return to previous location
6781 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6783 (defvar org-goto-start-pos) ; dynamically scoped parameter
6785 ;; FIXME: Docstring does not mention both interfaces
6786 (defun org-goto (&optional alternative-interface)
6787 "Look up a different location in the current file, keeping current visibility.
6789 When you want look-up or go to a different location in a document, the
6790 fastest way is often to fold the entire buffer and then dive into the tree.
6791 This method has the disadvantage, that the previous location will be folded,
6792 which may not be what you want.
6794 This command works around this by showing a copy of the current buffer
6795 in an indirect buffer, in overview mode. You can dive into the tree in
6796 that copy, use org-occur and incremental search to find a location.
6797 When pressing RET or `Q', the command returns to the original buffer in
6798 which the visibility is still unchanged. After RET is will also jump to
6799 the location selected in the indirect buffer and expose the headline
6800 hierarchy above."
6801 (interactive "P")
6802 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6803 (org-refile-use-outline-path t)
6804 (org-refile-target-verify-function nil)
6805 (interface
6806 (if (not alternative-interface)
6807 org-goto-interface
6808 (if (eq org-goto-interface 'outline)
6809 'outline-path-completion
6810 'outline)))
6811 (org-goto-start-pos (point))
6812 (selected-point
6813 (if (eq interface 'outline)
6814 (car (org-get-location (current-buffer) org-goto-help))
6815 (let ((pa (org-refile-get-location "Goto")))
6816 (org-refile-check-position pa)
6817 (nth 3 pa)))))
6818 (if selected-point
6819 (progn
6820 (org-mark-ring-push org-goto-start-pos)
6821 (goto-char selected-point)
6822 (if (or (outline-invisible-p) (org-invisible-p2))
6823 (org-show-context 'org-goto)))
6824 (message "Quit"))))
6826 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6827 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6828 (defvar org-goto-local-auto-isearch-map) ; defined below
6830 (defun org-get-location (buf help)
6831 "Let the user select a location in the Org-mode buffer BUF.
6832 This function uses a recursive edit. It returns the selected position
6833 or nil."
6834 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6835 (isearch-hide-immediately nil)
6836 (isearch-search-fun-function
6837 (lambda () 'org-goto-local-search-headings))
6838 (org-goto-selected-point org-goto-exit-command)
6839 (pop-up-frames nil)
6840 (special-display-buffer-names nil)
6841 (special-display-regexps nil)
6842 (special-display-function nil))
6843 (save-excursion
6844 (save-window-excursion
6845 (delete-other-windows)
6846 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6847 (org-pop-to-buffer-same-window
6848 (condition-case nil
6849 (make-indirect-buffer (current-buffer) "*org-goto*")
6850 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6851 (with-output-to-temp-buffer "*Help*"
6852 (princ help))
6853 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6854 (setq buffer-read-only nil)
6855 (let ((org-startup-truncated t)
6856 (org-startup-folded nil)
6857 (org-startup-align-all-tables nil))
6858 (org-mode)
6859 (org-overview))
6860 (setq buffer-read-only t)
6861 (if (and (boundp 'org-goto-start-pos)
6862 (integer-or-marker-p org-goto-start-pos))
6863 (let ((org-show-hierarchy-above t)
6864 (org-show-siblings t)
6865 (org-show-following-heading t))
6866 (goto-char org-goto-start-pos)
6867 (and (outline-invisible-p) (org-show-context)))
6868 (goto-char (point-min)))
6869 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6870 (message "Select location and press RET")
6871 (use-local-map org-goto-map)
6872 (recursive-edit)
6873 ))
6874 (kill-buffer "*org-goto*")
6875 (cons org-goto-selected-point org-goto-exit-command)))
6877 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6878 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6879 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6880 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6882 (defun org-goto-local-search-headings (string bound noerror)
6883 "Search and make sure that any matches are in headlines."
6884 (catch 'return
6885 (while (if isearch-forward
6886 (search-forward string bound noerror)
6887 (search-backward string bound noerror))
6888 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6889 (and (member :headline context)
6890 (not (member :tags context))))
6891 (throw 'return (point))))))
6893 (defun org-goto-local-auto-isearch ()
6894 "Start isearch."
6895 (interactive)
6896 (goto-char (point-min))
6897 (let ((keys (this-command-keys)))
6898 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6899 (isearch-mode t)
6900 (isearch-process-search-char (string-to-char keys)))))
6902 (defun org-goto-ret (&optional arg)
6903 "Finish `org-goto' by going to the new location."
6904 (interactive "P")
6905 (setq org-goto-selected-point (point)
6906 org-goto-exit-command 'return)
6907 (throw 'exit nil))
6909 (defun org-goto-left ()
6910 "Finish `org-goto' by going to the new location."
6911 (interactive)
6912 (if (org-at-heading-p)
6913 (progn
6914 (beginning-of-line 1)
6915 (setq org-goto-selected-point (point)
6916 org-goto-exit-command 'left)
6917 (throw 'exit nil))
6918 (error "Not on a heading")))
6920 (defun org-goto-right ()
6921 "Finish `org-goto' by going to the new location."
6922 (interactive)
6923 (if (org-at-heading-p)
6924 (progn
6925 (setq org-goto-selected-point (point)
6926 org-goto-exit-command 'right)
6927 (throw 'exit nil))
6928 (error "Not on a heading")))
6930 (defun org-goto-quit ()
6931 "Finish `org-goto' without cursor motion."
6932 (interactive)
6933 (setq org-goto-selected-point nil)
6934 (setq org-goto-exit-command 'quit)
6935 (throw 'exit nil))
6937 ;;; Indirect buffer display of subtrees
6939 (defvar org-indirect-dedicated-frame nil
6940 "This is the frame being used for indirect tree display.")
6941 (defvar org-last-indirect-buffer nil)
6943 (defun org-tree-to-indirect-buffer (&optional arg)
6944 "Create indirect buffer and narrow it to current subtree.
6945 With numerical prefix ARG, go up to this level and then take that tree.
6946 If ARG is negative, go up that many levels.
6947 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6948 indirect buffer previously made with this command, to avoid proliferation of
6949 indirect buffers. However, when you call the command with a \
6951 when `org-indirect-buffer-display' is `new-frame', the last buffer
6952 is kept so that you can work with several indirect buffers at the same time.
6953 If `org-indirect-buffer-display' is `dedicated-frame', the \
6955 requests that a new frame be made for the new buffer, so that the dedicated
6956 frame is not changed."
6957 (interactive "P")
6958 (let ((cbuf (current-buffer))
6959 (cwin (selected-window))
6960 (pos (point))
6961 beg end level heading ibuf)
6962 (save-excursion
6963 (org-back-to-heading t)
6964 (when (numberp arg)
6965 (setq level (org-outline-level))
6966 (if (< arg 0) (setq arg (+ level arg)))
6967 (while (> (setq level (org-outline-level)) arg)
6968 (outline-up-heading 1 t)))
6969 (setq beg (point)
6970 heading (org-get-heading))
6971 (org-end-of-subtree t t)
6972 (if (org-at-heading-p) (backward-char 1))
6973 (setq end (point)))
6974 (if (and (buffer-live-p org-last-indirect-buffer)
6975 (not (eq org-indirect-buffer-display 'new-frame))
6976 (not arg))
6977 (kill-buffer org-last-indirect-buffer))
6978 (setq ibuf (org-get-indirect-buffer cbuf)
6979 org-last-indirect-buffer ibuf)
6980 (cond
6981 ((or (eq org-indirect-buffer-display 'new-frame)
6982 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6983 (select-frame (make-frame))
6984 (delete-other-windows)
6985 (org-pop-to-buffer-same-window ibuf)
6986 (org-set-frame-title heading))
6987 ((eq org-indirect-buffer-display 'dedicated-frame)
6988 (raise-frame
6989 (select-frame (or (and org-indirect-dedicated-frame
6990 (frame-live-p org-indirect-dedicated-frame)
6991 org-indirect-dedicated-frame)
6992 (setq org-indirect-dedicated-frame (make-frame)))))
6993 (delete-other-windows)
6994 (org-pop-to-buffer-same-window ibuf)
6995 (org-set-frame-title (concat "Indirect: " heading)))
6996 ((eq org-indirect-buffer-display 'current-window)
6997 (org-pop-to-buffer-same-window ibuf))
6998 ((eq org-indirect-buffer-display 'other-window)
6999 (pop-to-buffer ibuf))
7000 (t (error "Invalid value")))
7001 (if (featurep 'xemacs)
7002 (save-excursion (org-mode) (turn-on-font-lock)))
7003 (narrow-to-region beg end)
7004 (show-all)
7005 (goto-char pos)
7006 (run-hook-with-args 'org-cycle-hook 'all)
7007 (and (window-live-p cwin) (select-window cwin))))
7009 (defun org-get-indirect-buffer (&optional buffer)
7010 (setq buffer (or buffer (current-buffer)))
7011 (let ((n 1) (base (buffer-name buffer)) bname)
7012 (while (buffer-live-p
7013 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7014 (setq n (1+ n)))
7015 (condition-case nil
7016 (make-indirect-buffer buffer bname 'clone)
7017 (error (make-indirect-buffer buffer bname)))))
7019 (defun org-set-frame-title (title)
7020 "Set the title of the current frame to the string TITLE."
7021 ;; FIXME: how to name a single frame in XEmacs???
7022 (unless (featurep 'xemacs)
7023 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7025 ;;;; Structure editing
7027 ;;; Inserting headlines
7029 (defun org-previous-line-empty-p ()
7030 (save-excursion
7031 (and (not (bobp))
7032 (or (beginning-of-line 0) t)
7033 (save-match-data
7036 (defun org-insert-heading (&optional force-heading invisible-ok)
7037 "Insert a new heading or item with same depth at point.
7038 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7039 If point is at the beginning of a headline, insert a sibling before the
7040 current headline. If point is not at the beginning, split the line,
7041 create the new headline with the text in the current line after point
7042 \(but see also the variable `org-M-RET-may-split-line').
7044 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7045 This is important for non-interactive uses of the command."
7046 (interactive "P")
7047 (if (or (= (buffer-size) 0)
7048 (and (not (save-excursion
7049 (and (ignore-errors (org-back-to-heading invisible-ok))
7050 (org-at-heading-p))))
7051 (or force-heading (not (org-in-item-p)))))
7052 (progn
7054 (run-hooks 'org-insert-heading-hook))
7055 (when (or force-heading (not (org-insert-item)))
7056 (let* ((empty-line-p nil)
7057 (level nil)
7058 (on-heading (org-at-heading-p))
7059 (head (save-excursion
7060 (condition-case nil
7061 (progn
7062 (org-back-to-heading invisible-ok)
7063 (when (and (not on-heading)
7064 (featurep 'org-inlinetask)
7065 (integerp org-inlinetask-min-level)
7066 (>= (length (match-string 0))
7067 org-inlinetask-min-level))
7068 ;; Find a heading level before the inline task
7069 (while (and (setq level (org-up-heading-safe))
7070 (>= level org-inlinetask-min-level)))
7071 (if (org-at-heading-p)
7072 (org-back-to-heading invisible-ok)
7073 (error "This should not happen")))
7074 (setq empty-line-p (org-previous-line-empty-p))
7075 (match-string 0))
7076 (error "*"))))
7077 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7078 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7079 pos hide-previous previous-pos)
7080 (cond
7081 ((and (org-at-heading-p) (bolp)
7082 (or (bobp)
7083 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7084 ;; insert before the current line
7085 (open-line (if blank 2 1)))
7086 ((and (bolp)
7087 (not org-insert-heading-respect-content)
7088 (or (bobp)
7089 (save-excursion
7090 (backward-char 1) (not (outline-invisible-p)))))
7091 ;; insert right here
7092 nil)
7093 (t
7094 ;; somewhere in the line
7095 (save-excursion
7096 (setq previous-pos (point-at-bol))
7097 (end-of-line)
7098 (setq hide-previous (outline-invisible-p)))
7099 (and org-insert-heading-respect-content (org-show-subtree))
7100 (let ((split
7101 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7102 (save-excursion
7103 (let ((p (point)))
7104 (goto-char (point-at-bol))
7105 (and (looking-at org-complex-heading-regexp)
7106 (match-beginning 4)
7107 (> p (match-beginning 4)))))))
7108 tags pos)
7109 (cond
7110 (org-insert-heading-respect-content
7111 (org-end-of-subtree nil t)
7112 (when (featurep 'org-inlinetask)
7113 (while (and (not (eobp))
7115 (>= (length (match-string 1))
7116 org-inlinetask-min-level))
7117 (org-end-of-subtree nil t)))
7118 (or (bolp) (newline))
7119 (or (org-previous-line-empty-p)
7120 (and blank (newline)))
7121 (open-line 1))
7122 ((org-at-heading-p)
7123 (when hide-previous
7124 (show-children)
7125 (org-show-entry))
7127 (setq tags (and (match-end 2) (match-string 2)))
7128 (and (match-end 1)
7129 (delete-region (match-beginning 1) (match-end 1)))
7130 (setq pos (point-at-bol))
7131 (or split (end-of-line 1))
7132 (delete-horizontal-space)
7134 (buffer-substring (point-at-bol) (point)))
7135 (insert " "))
7136 (newline (if blank 2 1))
7137 (when tags
7138 (save-excursion
7139 (goto-char pos)
7140 (end-of-line 1)
7141 (insert " " tags)
7142 (org-set-tags nil 'align))))
7143 (t
7144 (or split (end-of-line 1))
7145 (newline (if blank 2 1)))))))
7146 (insert head) (just-one-space)
7147 (setq pos (point))
7148 (end-of-line 1)
7149 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7150 (when (and org-insert-heading-respect-content hide-previous)
7151 (save-excursion
7152 (goto-char previous-pos)
7153 (hide-subtree)))
7154 (run-hooks 'org-insert-heading-hook)))))
7156 (defun org-get-heading (&optional no-tags no-todo)
7157 "Return the heading of the current entry, without the stars.
7158 When NO-TAGS is non-nil, don't include tags.
7159 When NO-TODO is non-nil, don't include TODO keywords."
7160 (save-excursion
7161 (org-back-to-heading t)
7162 (cond
7163 ((and no-tags no-todo)
7164 (looking-at org-complex-heading-regexp)
7165 (match-string 4))
7166 (no-tags
7167 (looking-at (concat org-outline-regexp
7170 (match-string 1))
7171 (no-todo
7172 (looking-at org-todo-line-regexp)
7173 (match-string 3))
7174 (t (looking-at org-heading-regexp)
7175 (match-string 2)))))
7177 (defun org-heading-components ()
7178 "Return the components of the current heading.
7179 This is a list with the following elements:
7180 - the level as an integer
7181 - the reduced level, different if `org-odd-levels-only' is set.
7182 - the TODO keyword, or nil
7183 - the priority character, like ?A, or nil if no priority is given
7184 - the headline text itself, or the tags string if no headline text
7185 - the tags string, or nil."
7186 (save-excursion
7187 (org-back-to-heading t)
7188 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7189 (list (length (match-string 1))
7190 (org-reduced-level (length (match-string 1)))
7191 (org-match-string-no-properties 2)
7192 (and (match-end 3) (aref (match-string 3) 2))
7193 (org-match-string-no-properties 4)
7194 (org-match-string-no-properties 5)))))
7196 (defun org-get-entry ()
7197 "Get the entry text, after heading, entire subtree."
7198 (save-excursion
7199 (org-back-to-heading t)
7200 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7202 (defun org-insert-heading-after-current ()
7203 "Insert a new heading with same level as current, after current subtree."
7204 (interactive)
7205 (org-back-to-heading)
7206 (org-insert-heading)
7207 (org-move-subtree-down)
7208 (end-of-line 1))
7210 (defun org-insert-heading-respect-content ()
7211 (interactive)
7212 (let ((org-insert-heading-respect-content t))
7213 (org-insert-heading t)))
7215 (defun org-insert-todo-heading-respect-content (&optional force-state)
7216 (interactive "P")
7217 (let ((org-insert-heading-respect-content t))
7218 (org-insert-todo-heading force-state t)))
7220 (defun org-insert-todo-heading (arg &optional force-heading)
7221 "Insert a new heading with the same level and TODO state as current heading.
7222 If the heading has no TODO state, or if the state is DONE, use the first
7223 state (TODO by default). Also with prefix arg, force first state."
7224 (interactive "P")
7225 (when (or force-heading (not (org-insert-item 'checkbox)))
7226 (org-insert-heading force-heading)
7227 (save-excursion
7228 (org-back-to-heading)
7229 (outline-previous-heading)
7230 (looking-at org-todo-line-regexp))
7231 (let*
7232 ((new-mark-x
7233 (if (or arg
7234 (not (match-beginning 2))
7235 (member (match-string 2) org-done-keywords))
7236 (car org-todo-keywords-1)
7237 (match-string 2)))
7238 (new-mark
7239 (or
7240 (run-hook-with-args-until-success
7241 'org-todo-get-default-hook new-mark-x nil)
7242 new-mark-x)))
7243 (beginning-of-line 1)
7244 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7245 (if org-treat-insert-todo-heading-as-state-change
7246 (org-todo new-mark)
7247 (insert new-mark " "))))
7248 (when org-provide-todo-statistics
7249 (org-update-parent-todo-statistics))))
7251 (defun org-insert-subheading (arg)
7252 "Insert a new subheading and demote it.
7253 Works for outline headings and for plain lists alike."
7254 (interactive "P")
7255 (org-insert-heading arg)
7256 (cond
7257 ((org-at-heading-p) (org-do-demote))
7258 ((org-at-item-p) (org-indent-item))))
7260 (defun org-insert-todo-subheading (arg)
7261 "Insert a new subheading with TODO keyword or checkbox and demote it.
7262 Works for outline headings and for plain lists alike."
7263 (interactive "P")
7264 (org-insert-todo-heading arg)
7265 (cond
7266 ((org-at-heading-p) (org-do-demote))
7267 ((org-at-item-p) (org-indent-item))))
7269 ;;; Promotion and Demotion
7271 (defvar org-after-demote-entry-hook nil
7272 "Hook run after an entry has been demoted.
7273 The cursor will be at the beginning of the entry.
7274 When a subtree is being demoted, the hook will be called for each node.")
7276 (defvar org-after-promote-entry-hook nil
7277 "Hook run after an entry has been promoted.
7278 The cursor will be at the beginning of the entry.
7279 When a subtree is being promoted, the hook will be called for each node.")
7281 (defun org-promote-subtree ()
7282 "Promote the entire subtree.
7283 See also `org-promote'."
7284 (interactive)
7285 (save-excursion
7286 (org-with-limited-levels (org-map-tree 'org-promote)))
7287 (org-fix-position-after-promote))
7289 (defun org-demote-subtree ()
7290 "Demote the entire subtree. See `org-demote'.
7291 See also `org-promote'."
7292 (interactive)
7293 (save-excursion
7294 (org-with-limited-levels (org-map-tree 'org-demote)))
7295 (org-fix-position-after-promote))
7298 (defun org-do-promote ()
7299 "Promote the current heading higher up the tree.
7300 If the region is active in `transient-mark-mode', promote all headings
7301 in the region."
7302 (interactive)
7303 (save-excursion
7304 (if (org-region-active-p)
7305 (org-map-region 'org-promote (region-beginning) (region-end))
7306 (org-promote)))
7307 (org-fix-position-after-promote))
7309 (defun org-do-demote ()
7310 "Demote the current heading lower down the tree.
7311 If the region is active in `transient-mark-mode', demote all headings
7312 in the region."
7313 (interactive)
7314 (save-excursion
7315 (if (org-region-active-p)
7316 (org-map-region 'org-demote (region-beginning) (region-end))
7317 (org-demote)))
7318 (org-fix-position-after-promote))
7320 (defun org-fix-position-after-promote ()
7321 "Make sure that after pro/demotion cursor position is right."
7322 (let ((pos (point)))
7323 (when (save-excursion
7324 (beginning-of-line 1)
7325 (looking-at org-todo-line-regexp)
7326 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7327 (cond ((eobp) (insert " "))
7328 ((eolp) (insert " "))
7329 ((equal (char-after) ?\ ) (forward-char 1))))))
7331 (defun org-current-level ()
7332 "Return the level of the current entry, or nil if before the first headline.
7333 The level is the number of stars at the beginning of the headline."
7334 (save-excursion
7335 (org-with-limited-levels
7336 (if (ignore-errors (org-back-to-heading t))
7337 (funcall outline-level)))))
7339 (defun org-get-previous-line-level ()
7340 "Return the outline depth of the last headline before the current line.
7341 Returns 0 for the first headline in the buffer, and nil if before the
7342 first headline."
7343 (let ((current-level (org-current-level))
7344 (prev-level (when (> (line-number-at-pos) 1)
7345 (save-excursion
7346 (beginning-of-line 0)
7347 (org-current-level)))))
7348 (cond ((null current-level) nil) ; Before first headline
7349 ((null prev-level) 0) ; At first headline
7350 (prev-level))))
7352 (defun org-reduced-level (l)
7353 "Compute the effective level of a heading.
7354 This takes into account the setting of `org-odd-levels-only'."
7355 (cond
7356 ((zerop l) 0)
7357 (org-odd-levels-only (1+ (floor (/ l 2))))
7358 (t l)))
7360 (defun org-level-increment ()
7361 "Return the number of stars that will be added or removed at a
7362 time to headlines when structure editing, based on the value of
7363 `org-odd-levels-only'."
7364 (if org-odd-levels-only 2 1))
7366 (defun org-get-valid-level (level &optional change)
7367 "Rectify a level change under the influence of `org-odd-levels-only'
7368 LEVEL is a current level, CHANGE is by how much the level should be
7369 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7370 even level numbers will become the next higher odd number."
7371 (if org-odd-levels-only
7372 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7373 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7374 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7375 (max 1 (+ level (or change 0)))))
7377 (if (boundp 'define-obsolete-function-alias)
7378 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7379 (define-obsolete-function-alias 'org-get-legal-level
7380 'org-get-valid-level)
7381 (define-obsolete-function-alias 'org-get-legal-level
7382 'org-get-valid-level "23.1")))
7384 (defun org-promote ()
7385 "Promote the current heading higher up the tree.
7386 If the region is active in `transient-mark-mode', promote all headings
7387 in the region."
7388 (org-back-to-heading t)
7389 (let* ((level (save-match-data (funcall outline-level)))
7390 (after-change-functions (remove 'flyspell-after-change-function
7391 after-change-functions))
7392 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7393 (diff (abs (- level (length up-head) -1))))
7394 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7395 (replace-match up-head nil t)
7396 ;; Fixup tag positioning
7397 (and org-auto-align-tags (org-set-tags nil t))
7398 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7399 (run-hooks 'org-after-promote-entry-hook)))
7401 (defun org-demote ()
7402 "Demote the current heading lower down the tree.
7403 If the region is active in `transient-mark-mode', demote all headings
7404 in the region."
7405 (org-back-to-heading t)
7406 (let* ((level (save-match-data (funcall outline-level)))
7407 (after-change-functions (remove 'flyspell-after-change-function
7408 after-change-functions))
7409 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7410 (diff (abs (- level (length down-head) -1))))
7411 (replace-match down-head nil t)
7412 ;; Fixup tag positioning
7413 (and org-auto-align-tags (org-set-tags nil t))
7414 (if org-adapt-indentation (org-fixup-indentation diff))
7415 (run-hooks 'org-after-demote-entry-hook)))
7417 (defun org-cycle-level ()
7418 "Cycle the level of an empty headline through possible states.
7419 This goes first to child, then to parent, level, then up the hierarchy.
7420 After top level, it switches back to sibling level."
7421 (interactive)
7422 (let ((org-adapt-indentation nil))
7423 (when (org-point-at-end-of-empty-headline)
7424 (setq this-command 'org-cycle-level) ; Only needed for caching
7425 (let ((cur-level (org-current-level))
7426 (prev-level (org-get-previous-line-level)))
7427 (cond
7428 ;; If first headline in file, promote to top-level.
7429 ((= prev-level 0)
7430 (loop repeat (/ (- cur-level 1) (org-level-increment))
7431 do (org-do-promote)))
7432 ;; If same level as prev, demote one.
7433 ((= prev-level cur-level)
7434 (org-do-demote))
7435 ;; If parent is top-level, promote to top level if not already.
7436 ((= prev-level 1)
7437 (loop repeat (/ (- cur-level 1) (org-level-increment))
7438 do (org-do-promote)))
7439 ;; If top-level, return to prev-level.
7440 ((= cur-level 1)
7441 (loop repeat (/ (- prev-level 1) (org-level-increment))
7442 do (org-do-demote)))
7443 ;; If less than prev-level, promote one.
7444 ((< cur-level prev-level)
7445 (org-do-promote))
7446 ;; If deeper than prev-level, promote until higher than
7447 ;; prev-level.
7448 ((> cur-level prev-level)
7449 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7450 do (org-do-promote))))
7451 t))))
7453 (defun org-map-tree (fun)
7454 "Call FUN for every heading underneath the current one."
7455 (org-back-to-heading)
7456 (let ((level (funcall outline-level)))
7457 (save-excursion
7458 (funcall fun)
7459 (while (and (progn
7460 (outline-next-heading)
7461 (> (funcall outline-level) level))
7462 (not (eobp)))
7463 (funcall fun)))))
7465 (defun org-map-region (fun beg end)
7466 "Call FUN for every heading between BEG and END."
7467 (let ((org-ignore-region t))
7468 (save-excursion
7469 (setq end (copy-marker end))
7470 (goto-char beg)
7471 (if (and (re-search-forward org-outline-regexp-bol nil t)
7472 (< (point) end))
7473 (funcall fun))
7474 (while (and (progn
7475 (outline-next-heading)
7476 (< (point) end))
7477 (not (eobp)))
7478 (funcall fun)))))
7480 (defvar org-property-end-re) ; silence byte-compiler
7481 (defun org-fixup-indentation (diff)
7482 "Change the indentation in the current entry by DIFF.
7483 However, if any line in the current entry has no indentation, or if it
7484 would end up with no indentation after the change, nothing at all is done."
7485 (save-excursion
7486 (let ((end (save-excursion (outline-next-heading)
7487 (point-marker)))
7488 (prohibit (if (> diff 0)
7491 col)
7492 (unless (save-excursion (end-of-line 1)
7493 (re-search-forward prohibit end t))
7494 (while (and (< (point) end)
7496 (goto-char (match-end 0))
7497 (setq col (current-column))
7498 (if (< diff 0) (replace-match ""))
7499 (org-indent-to-column (+ diff col))))
7500 (move-marker end nil))))
7502 (defun org-convert-to-odd-levels ()
7503 "Convert an org-mode file with all levels allowed to one with odd levels.
7504 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7505 level 5 etc."
7506 (interactive)
7507 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7508 (let ((outline-level 'org-outline-level)
7509 (org-odd-levels-only nil) n)
7510 (save-excursion
7511 (goto-char (point-min))
7513 (setq n (- (length (match-string 0)) 2))
7514 (while (>= (setq n (1- n)) 0)
7515 (org-demote))
7516 (end-of-line 1))))))
7518 (defun org-convert-to-oddeven-levels ()
7519 "Convert an org-mode file with only odd levels to one with odd/even levels.
7520 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7521 file contains a section with an even level, conversion would
7522 destroy the structure of the file. An error is signaled in this
7523 case."
7524 (interactive)
7525 (goto-char (point-min))
7526 ;; First check if there are no even levels
7528 (org-show-context t)
7529 (error "Not all levels are odd in this file. Conversion not possible"))
7530 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7531 (let ((outline-regexp org-outline-regexp)
7532 (outline-level 'org-outline-level)
7533 (org-odd-levels-only nil) n)
7534 (save-excursion
7535 (goto-char (point-min))
7537 (setq n (/ (1- (length (match-string 0))) 2))
7538 (while (>= (setq n (1- n)) 0)
7539 (org-promote))
7540 (end-of-line 1))))))
7542 (defun org-tr-level (n)
7543 "Make N odd if required."
7544 (if org-odd-levels-only (1+ (/ n 2)) n))
7546 ;;; Vertical tree motion, cutting and pasting of subtrees
7548 (defun org-move-subtree-up (&optional arg)
7549 "Move the current subtree up past ARG headlines of the same level."
7550 (interactive "p")
7551 (org-move-subtree-down (- (prefix-numeric-value arg))))
7553 (defun org-move-subtree-down (&optional arg)
7554 "Move the current subtree down past ARG headlines of the same level."
7555 (interactive "p")
7556 (setq arg (prefix-numeric-value arg))
7557 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7558 'org-get-last-sibling))
7559 (ins-point (make-marker))
7560 (cnt (abs arg))
7561 (col (current-column))
7562 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7563 ;; Select the tree
7564 (org-back-to-heading)
7565 (setq beg0 (point))
7566 (save-excursion
7567 (setq ne-beg (org-back-over-empty-lines))
7568 (setq beg (point)))
7569 (save-match-data
7570 (save-excursion (outline-end-of-heading)
7571 (setq folded (outline-invisible-p)))
7572 (outline-end-of-subtree))
7573 (outline-next-heading)
7574 (setq ne-end (org-back-over-empty-lines))
7575 (setq end (point))
7576 (goto-char beg0)
7577 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7578 ;; include less whitespace
7579 (save-excursion
7580 (goto-char beg)
7581 (forward-line (- ne-beg ne-end))
7582 (setq beg (point))))
7583 ;; Find insertion point, with error handling
7584 (while (> cnt 0)
7585 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7586 (progn (goto-char beg0)
7587 (error "Cannot move past superior level or buffer limit")))
7588 (setq cnt (1- cnt)))
7589 (if (> arg 0)
7590 ;; Moving forward - still need to move over subtree
7591 (progn (org-end-of-subtree t t)
7592 (save-excursion
7593 (org-back-over-empty-lines)
7594 (or (bolp) (newline)))))
7595 (setq ne-ins (org-back-over-empty-lines))
7596 (move-marker ins-point (point))
7597 (setq txt (buffer-substring beg end))
7598 (org-save-markers-in-region beg end)
7599 (delete-region beg end)
7600 (org-remove-empty-overlays-at beg)
7601 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7602 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7604 (let ((bbb (point)))
7605 (insert-before-markers txt)
7606 (org-reinstall-markers-in-region bbb)
7607 (move-marker ins-point bbb))
7609 (setq ins-end (point))
7610 (goto-char ins-point)
7611 (org-skip-whitespace)
7612 (when (and (< arg 0)
7613 (org-first-sibling-p)
7614 (> ne-ins ne-beg))
7615 ;; Move whitespace back to beginning
7616 (save-excursion
7617 (goto-char ins-end)
7618 (let ((kill-whole-line t))
7619 (kill-line (- ne-ins ne-beg)) (point)))
7621 (move-marker ins-point nil)
7622 (if folded
7623 (hide-subtree)
7624 (org-show-entry)
7625 (show-children)
7626 (org-cycle-hide-drawers 'children))
7627 (org-clean-visibility-after-subtree-move)
7628 ;; move back to the initial column we were at
7629 (move-to-column col)))
7631 (defvar org-subtree-clip ""
7632 "Clipboard for cut and paste of subtrees.
7633 This is actually only a copy of the kill, because we use the normal kill
7634 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7636 (defvar org-subtree-clip-folded nil
7637 "Was the last copied subtree folded?
7638 This is used to fold the tree back after pasting.")
7640 (defun org-cut-subtree (&optional n)
7641 "Cut the current subtree into the clipboard.
7642 With prefix arg N, cut this many sequential subtrees.
7643 This is a short-hand for marking the subtree and then cutting it."
7644 (interactive "p")
7645 (org-copy-subtree n 'cut))
7647 (defun org-copy-subtree (&optional n cut force-store-markers)
7648 "Cut the current subtree into the clipboard.
7649 With prefix arg N, cut this many sequential subtrees.
7650 This is a short-hand for marking the subtree and then copying it.
7651 If CUT is non-nil, actually cut the subtree.
7652 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7653 of some markers in the region, even if CUT is non-nil. This is
7654 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7655 (interactive "p")
7656 (let (beg end folded (beg0 (point)))
7657 (if (org-called-interactively-p 'any)
7658 (org-back-to-heading nil) ; take what looks like a subtree
7659 (org-back-to-heading t)) ; take what is really there
7660 (org-back-over-empty-lines)
7661 (setq beg (point))
7663 (save-match-data
7664 (save-excursion (outline-end-of-heading)
7665 (setq folded (outline-invisible-p)))
7666 (condition-case nil
7667 (org-forward-same-level (1- n) t)
7668 (error nil))
7669 (org-end-of-subtree t t))
7670 (org-back-over-empty-lines)
7671 (setq end (point))
7672 (goto-char beg0)
7673 (when (> end beg)
7674 (setq org-subtree-clip-folded folded)
7675 (when (or cut force-store-markers)
7676 (org-save-markers-in-region beg end))
7677 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7678 (setq org-subtree-clip (current-kill 0))
7679 (message "%s: Subtree(s) with %d characters"
7680 (if cut "Cut" "Copied")
7681 (length org-subtree-clip)))))
7683 (defun org-paste-subtree (&optional level tree for-yank)
7684 "Paste the clipboard as a subtree, with modification of headline level.
7685 The entire subtree is promoted or demoted in order to match a new headline
7686 level.
7688 If the cursor is at the beginning of a headline, the same level as
7689 that headline is used to paste the tree
7691 If not, the new level is derived from the *visible* headings
7692 before and after the insertion point, and taken to be the inferior headline
7693 level of the two. So if the previous visible heading is level 3 and the
7694 next is level 4 (or vice versa), level 4 will be used for insertion.
7695 This makes sure that the subtree remains an independent subtree and does
7696 not swallow low level entries.
7698 You can also force a different level, either by using a numeric prefix
7699 argument, or by inserting the heading marker by hand. For example, if the
7702 If optional TREE is given, use this text instead of the kill ring.
7704 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7705 move back over whitespace before inserting, and move point to the end of
7706 the inserted text when done."
7707 (interactive "P")
7708 (setq tree (or tree (and kill-ring (current-kill 0))))
7709 (unless (org-kill-is-subtree-p tree)
7710 (error "%s"
7711 (substitute-command-keys
7713 (org-with-limited-levels
7714 (let* ((visp (not (outline-invisible-p)))
7715 (txt tree)
7717 (old-level (if (string-match org-outline-regexp-bol txt)
7718 (- (match-end 0) (match-beginning 0) 1)
7719 -1))
7720 (force-level (cond (level (prefix-numeric-value level))
7722 (string-match
7724 (point-at-bol) (point))))
7725 (- (match-end 1) (match-beginning 1)))
7726 ((and (bolp)
7727 (looking-at org-outline-regexp))
7728 (- (match-end 0) (point) 1))
7729 (t nil)))
7730 (previous-level (save-excursion
7731 (condition-case nil
7732 (progn
7733 (outline-previous-visible-heading 1)
7734 (if (looking-at ^re_)
7735 (- (match-end 0) (match-beginning 0) 1)
7736 1))
7737 (error 1))))
7738 (next-level (save-excursion
7739 (condition-case nil
7740 (progn
7741 (or (looking-at org-outline-regexp)
7742 (outline-next-visible-heading 1))
7743 (if (looking-at ^re_)
7744 (- (match-end 0) (match-beginning 0) 1)
7745 1))
7746 (error 1))))
7747 (new-level (or force-level (max previous-level next-level)))
7748 (shift (if (or (= old-level -1)
7749 (= new-level -1)
7750 (= old-level new-level))
7751 0
7752 (- new-level old-level)))
7753 (delta (if (> shift 0) -1 1))
7754 (func (if (> shift 0) 'org-demote 'org-promote))
7755 (org-odd-levels-only nil)
7756 beg end newend)
7757 ;; Remove the forced level indicator
7758 (if force-level
7759 (delete-region (point-at-bol) (point)))
7760 ;; Paste
7761 (beginning-of-line (if (bolp) 1 2))
7762 (unless for-yank (org-back-over-empty-lines))
7763 (setq beg (point))
7764 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7765 (insert-before-markers txt)
7767 (setq newend (point))
7768 (org-reinstall-markers-in-region beg)
7769 (setq end (point))
7770 (goto-char beg)
7772 (setq beg (point))
7773 (if (and (outline-invisible-p) visp)
7774 (save-excursion (outline-show-heading)))
7775 ;; Shift if necessary
7776 (unless (= shift 0)
7777 (save-restriction
7778 (narrow-to-region beg end)
7779 (while (not (= shift 0))
7780 (org-map-region func (point-min) (point-max))
7781 (setq shift (+ delta shift)))
7782 (goto-char (point-min))
7783 (setq newend (point-max))))
7784 (when (or (org-called-interactively-p 'interactive) for-yank)
7785 (message "Clipboard pasted as level %d subtree" new-level))
7786 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7787 kill-ring
7788 (eq org-subtree-clip (current-kill 0))
7789 org-subtree-clip-folded)
7790 ;; The tree was folded before it was killed/copied
7791 (hide-subtree))
7792 (and for-yank (goto-char newend)))))
7794 (defun org-kill-is-subtree-p (&optional txt)
7795 "Check if the current kill is an outline subtree, or a set of trees.
7796 Returns nil if kill does not start with a headline, or if the first
7797 headline level is not the largest headline level in the tree.
7798 So this will actually accept several entries of equal levels as well,
7799 which is OK for `org-paste-subtree'.
7800 If optional TXT is given, check this string instead of the current kill."
7801 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7802 (re (org-get-limited-outline-regexp))
7803 (^re (concat "^" re))
7804 (start-level (and kill
7805 (string-match
7807 kill)
7808 (- (match-end 2) (match-beginning 2) 1)))
7809 (start (1+ (or (match-beginning 2) -1))))
7810 (if (not start-level)
7811 (progn
7812 nil) ;; does not even start with a heading
7813 (catch 'exit
7814 (while (setq start (string-match ^re kill (1+ start)))
7815 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7816 (throw 'exit nil)))
7817 t))))
7819 (defvar org-markers-to-move nil
7820 "Markers that should be moved with a cut-and-paste operation.
7821 Those markers are stored together with their positions relative to
7822 the start of the region.")
7824 (defun org-save-markers-in-region (beg end)
7825 "Check markers in region.
7826 If these markers are between BEG and END, record their position relative
7827 to BEG, so that after moving the block of text, we can put the markers back
7828 into place.
7829 This function gets called just before an entry or tree gets cut from the
7830 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7831 called immediately, to move the markers with the entries."
7832 (setq org-markers-to-move nil)
7833 (when (featurep 'org-clock)
7834 (org-clock-save-markers-for-cut-and-paste beg end))
7835 (when (featurep 'org-agenda)
7836 (org-agenda-save-markers-for-cut-and-paste beg end)))
7838 (defun org-check-and-save-marker (marker beg end)
7839 "Check if MARKER is between BEG and END.
7840 If yes, remember the marker and the distance to BEG."
7841 (when (and (marker-buffer marker)
7842 (equal (marker-buffer marker) (current-buffer)))
7843 (if (and (>= marker beg) (< marker end))
7844 (push (cons marker (- marker beg)) org-markers-to-move))))
7846 (defun org-reinstall-markers-in-region (beg)
7847 "Move all remembered markers to their position relative to BEG."
7848 (mapc (lambda (x)
7849 (move-marker (car x) (+ beg (cdr x))))
7850 org-markers-to-move)
7851 (setq org-markers-to-move nil))
7853 (defun org-narrow-to-subtree ()
7854 "Narrow buffer to the current subtree."
7855 (interactive)
7856 (save-excursion
7857 (save-match-data
7858 (org-with-limited-levels
7859 (narrow-to-region
7860 (progn (org-back-to-heading t) (point))
7861 (progn (org-end-of-subtree t t)
7862 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7863 (point)))))))
7865 (defun org-narrow-to-block ()
7866 "Narrow buffer to the current block."
7867 (interactive)
7868 (let* ((case-fold-search t)
7871 (if blockp
7872 (narrow-to-region (car blockp) (cdr blockp))
7873 (error "Not in a block"))))
7875 (eval-when-compile
7876 (defvar org-property-drawer-re))
7878 (defvar org-property-start-re) ;; defined below
7879 (defun org-clone-subtree-with-time-shift (n &optional shift)
7880 "Clone the task (subtree) at point N times.
7881 The clones will be inserted as siblings.
7883 In interactive use, the user will be prompted for the number of
7884 clones to be produced, and for a time SHIFT, which may be a
7885 repeater as used in time stamps, for example `+3d'.
7887 When a valid repeater is given and the entry contains any time
7888 stamps, the clones will become a sequence in time, with time
7889 stamps in the subtree shifted for each clone produced. If SHIFT
7890 is nil or the empty string, time stamps will be left alone. The
7891 ID property of the original subtree is removed.
7893 If the original subtree did contain time stamps with a repeater,
7894 the following will happen:
7895 - the repeater will be removed in each clone
7896 - an additional clone will be produced, with the current, unshifted
7897 date(s) in the entry.
7898 - the original entry will be placed *after* all the clones, with
7899 repeater intact.
7900 - the start days in the repeater in the original entry will be shifted
7901 to past the last clone.
7902 I this way you can spell out a number of instances of a repeating task,
7903 and still retain the repeater to cover future instances of the task."
7904 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7905 (let (beg end template task idprop
7906 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7907 (drawer-re org-drawer-regexp))
7908 (if (not (and (integerp n) (> n 0)))
7909 (error "Invalid number of replications %s" n))
7912 shift)))
7913 (error "Invalid shift specification %s" shift))
7914 (when doshift
7915 (setq shift-n (string-to-number (match-string 1 shift))
7916 shift-what (cdr (assoc (match-string 2 shift)
7917 '(("d" . day) ("w" . week)
7918 ("m" . month) ("y" . year))))))
7919 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7920 (setq nmin 1 nmax n)
7921 (org-back-to-heading t)
7922 (setq beg (point))
7923 (setq idprop (org-entry-get nil "ID"))
7924 (org-end-of-subtree t t)
7926 (setq end (point))
7927 (setq template (buffer-substring beg end))
7928 (when (and doshift
7930 (delete-region beg end)
7931 (setq end beg)
7932 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7933 (goto-char end)
7934 (loop for n from nmin to nmax do
7935 ;; prepare clone
7936 (with-temp-buffer
7937 (insert template)
7938 (org-mode)
7939 (goto-char (point-min))
7940 (org-show-subtree)
7941 (and idprop (if org-clone-delete-id
7942 (org-entry-delete nil "ID")
7943 (org-id-get-create t)))
7944 (unless (= n 0)
7946 (kill-whole-line))
7947 (goto-char (point-min))
7948 (while (re-search-forward drawer-re nil t)
7949 (mapc (lambda (d)
7950 (org-remove-empty-drawer-at d (point))) org-drawers)))
7951 (goto-char (point-min))
7952 (when doshift
7953 (while (re-search-forward org-ts-regexp-both nil t)
7954 (org-timestamp-change (* n shift-n) shift-what))
7955 (unless (= n n-no-remove)
7956 (goto-char (point-min))
7957 (while (re-search-forward org-ts-regexp nil t)
7958 (save-excursion
7959 (goto-char (match-beginning 0))
7961 (delete-region (match-beginning 1) (match-end 1)))))))
7962 (setq task (buffer-string)))
7963 (insert task))
7964 (goto-char beg)))
7966 ;;; Outline Sorting
7968 (defun org-sort (with-case)
7969 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7970 Optional argument WITH-CASE means sort case-sensitively."
7971 (interactive "P")
7972 (cond
7973 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7974 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7975 (t
7976 (org-call-with-arg 'org-sort-entries with-case))))
7978 (defun org-sort-remove-invisible (s)
7979 (remove-text-properties 0 (length s) org-rm-props s)
7980 (while (string-match org-bracket-link-regexp s)
7981 (setq s (replace-match (if (match-end 2)
7982 (match-string 3 s)
7983 (match-string 1 s)) t t s)))
7984 s)
7986 (defvar org-priority-regexp) ; defined later in the file
7988 (defvar org-after-sorting-entries-or-items-hook nil
7989 "Hook that is run after a bunch of entries or items have been sorted.
7990 When children are sorted, the cursor is in the parent line when this
7991 hook gets called. When a region or a plain list is sorted, the cursor
7992 will be in the first entry of the sorted region/list.")
7994 (defun org-sort-entries
7995 (&optional with-case sorting-type getkey-func compare-func property)
7996 "Sort entries on a certain level of an outline tree.
7997 If there is an active region, the entries in the region are sorted.
7998 Else, if the cursor is before the first entry, sort the top-level items.
7999 Else, the children of the entry at point are sorted.
8001 Sorting can be alphabetically, numerically, by date/time as given by
8002 a time stamp, by a property or by priority.
8004 The command prompts for the sorting type unless it has been given to the
8005 function through the SORTING-TYPE argument, which needs to be a character,
8006 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8007 precise meaning of each character:
8009 n Numerically, by converting the beginning of the entry/item to a number.
8010 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8011 t By date/time, either the first active time stamp in the entry, or, if
8012 none exist, by the first inactive one.
8013 s By the scheduled date/time.
8014 d By deadline date/time.
8015 c By creation time, which is assumed to be the first inactive time stamp
8016 at the beginning of a line.
8017 p By priority according to the cookie.
8018 r By the value of a property.
8020 Capital letters will reverse the sort order.
8022 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8023 called with point at the beginning of the record. It must return either
8024 a string or a number that should serve as the sorting key for that record.
8026 Comparing entries ignores case by default. However, with an optional argument
8027 WITH-CASE, the sorting considers case as well."
8028 (interactive "P")
8029 (let ((case-func (if with-case 'identity 'downcase))
8030 start beg end stars re re2
8031 txt what tmp)
8032 ;; Find beginning and end of region to sort
8033 (cond
8034 ((org-region-active-p)
8035 ;; we will sort the region
8036 (setq end (region-end)
8037 what "region")
8038 (goto-char (region-beginning))
8039 (if (not (org-at-heading-p)) (outline-next-heading))
8040 (setq start (point)))
8041 ((or (org-at-heading-p)
8042 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8043 ;; we will sort the children of the current headline
8044 (org-back-to-heading)
8045 (setq start (point)
8046 end (progn (org-end-of-subtree t t)
8048 (org-back-over-empty-lines)
8049 (point))
8050 what "children")
8051 (goto-char start)
8052 (show-subtree)
8053 (outline-next-heading))
8054 (t
8055 ;; we will sort the top-level entries in this file
8056 (goto-char (point-min))
8057 (or (org-at-heading-p) (outline-next-heading))
8058 (setq start (point))
8059 (goto-char (point-max))
8060 (beginning-of-line 1)
8062 ;; File ends in a non-white line
8063 (end-of-line 1)
8065 (setq end (point-max))
8066 (setq what "top-level")
8067 (goto-char start)
8068 (show-all)))
8070 (setq beg (point))
8071 (if (>= beg end) (error "Nothing to sort"))
8074 (setq stars (match-string 1)
8075 re (concat "^" (regexp-quote stars) " +")
8077 txt (buffer-substring beg end))
8079 (if (and (not (equal stars "*")) (string-match re2 txt))
8080 (error "Region to sort contains a level above the first entry"))
8082 (unless sorting-type
8083 (message
8084 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8086 A/N/T/S/D/C/P/O/F means reversed:"
8087 what)
8088 (setq sorting-type (read-char-exclusive))
8090 (and (= (downcase sorting-type) ?f)
8091 (setq getkey-func
8092 (org-icompleting-read "Sort using function: "
8093 obarray 'fboundp t nil nil))
8094 (setq getkey-func (intern getkey-func)))
8096 (and (= (downcase sorting-type) ?r)
8097 (setq property
8098 (org-icompleting-read "Property: "
8099 (mapcar 'list (org-buffer-property-keys t))
8100 nil t))))
8102 (message "Sorting entries...")
8104 (save-restriction
8105 (narrow-to-region start end)
8106 (let ((dcst (downcase sorting-type))
8107 (case-fold-search nil)
8108 (now (current-time)))
8109 (sort-subr
8110 (/= dcst sorting-type)
8111 ;; This function moves to the beginning character of the "record" to
8112 ;; be sorted.
8113 (lambda nil
8114 (if (re-search-forward re nil t)
8115 (goto-char (match-beginning 0))
8116 (goto-char (point-max))))
8117 ;; This function moves to the last character of the "record" being
8118 ;; sorted.
8119 (lambda nil
8120 (save-match-data
8121 (condition-case nil
8122 (outline-forward-same-level 1)
8123 (error
8124 (goto-char (point-max))))))
8125 ;; This function returns the value that gets sorted against.
8126 (lambda nil
8127 (cond
8128 ((= dcst ?n)
8129 (if (looking-at org-complex-heading-regexp)
8130 (string-to-number (match-string 4))
8131 nil))
8132 ((= dcst ?a)
8133 (if (looking-at org-complex-heading-regexp)
8134 (funcall case-func (match-string 4))
8135 nil))
8136 ((= dcst ?t)
8137 (let ((end (save-excursion (outline-next-heading) (point))))
8138 (if (or (re-search-forward org-ts-regexp end t)
8139 (re-search-forward org-ts-regexp-both end t))
8140 (org-time-string-to-seconds (match-string 0))
8141 (org-float-time now))))
8142 ((= dcst ?c)
8143 (let ((end (save-excursion (outline-next-heading) (point))))
8144 (if (re-search-forward
8146 end t)
8147 (org-time-string-to-seconds (match-string 0))
8148 (org-float-time now))))
8149 ((= dcst ?s)
8150 (let ((end (save-excursion (outline-next-heading) (point))))
8151 (if (re-search-forward org-scheduled-time-regexp end t)
8152 (org-time-string-to-seconds (match-string 1))
8153 (org-float-time now))))
8154 ((= dcst ?d)
8155 (let ((end (save-excursion (outline-next-heading) (point))))
8156 (if (re-search-forward org-deadline-time-regexp end t)
8157 (org-time-string-to-seconds (match-string 1))
8158 (org-float-time now))))
8159 ((= dcst ?p)
8160 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8161 (string-to-char (match-string 2))
8162 org-default-priority))
8163 ((= dcst ?r)
8164 (or (org-entry-get nil property) ""))
8165 ((= dcst ?o)
8166 (if (looking-at org-complex-heading-regexp)
8167 (- 9999 (length (member (match-string 2)
8168 org-todo-keywords-1)))))
8169 ((= dcst ?f)
8170 (if getkey-func
8171 (progn
8172 (setq tmp (funcall getkey-func))
8173 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8174 tmp)
8175 (error "Invalid key function `%s'" getkey-func)))
8176 (t (error "Invalid sorting type `%c'" sorting-type))))
8177 nil
8178 (cond
8179 ((= dcst ?a) 'string<)
8180 ((= dcst ?f) compare-func)
8181 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8182 (t nil)))))
8183 (run-hooks 'org-after-sorting-entries-or-items-hook)
8184 (message "Sorting entries...done")))
8186 (defun org-do-sort (table what &optional with-case sorting-type)
8187 "Sort TABLE of WHAT according to SORTING-TYPE.
8188 The user will be prompted for the SORTING-TYPE if the call to this
8189 function does not specify it. WHAT is only for the prompt, to indicate
8190 what is being sorted. The sorting key will be extracted from
8191 the car of the elements of the table.
8192 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8193 (unless sorting-type
8194 (message
8195 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8196 what)
8197 (setq sorting-type (read-char-exclusive)))
8198 (let ((dcst (downcase sorting-type))
8199 extractfun comparefun)
8200 ;; Define the appropriate functions
8201 (cond
8202 ((= dcst ?n)
8203 (setq extractfun 'string-to-number
8204 comparefun (if (= dcst sorting-type) '< '>)))
8205 ((= dcst ?a)
8206 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8207 (lambda(x) (downcase (org-sort-remove-invisible x))))
8208 comparefun (if (= dcst sorting-type)
8209 'string<
8210 (lambda (a b) (and (not (string< a b))
8211 (not (string= a b)))))))
8212 ((= dcst ?t)
8213 (setq extractfun
8214 (lambda (x)
8215 (if (or (string-match org-ts-regexp x)
8216 (string-match org-ts-regexp-both x))
8217 (org-float-time
8218 (org-time-string-to-time (match-string 0 x)))
8219 0))
8220 comparefun (if (= dcst sorting-type) '< '>)))
8221 (t (error "Invalid sorting type `%c'" sorting-type)))
8223 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8224 table)
8225 (lambda (a b) (funcall comparefun (car a) (car b))))))
8228 ;;; The orgstruct minor mode
8230 ;; Define a minor mode which can be used in other modes in order to
8231 ;; integrate the org-mode structure editing commands.
8233 ;; This is really a hack, because the org-mode structure commands use
8234 ;; keys which normally belong to the major mode. Here is how it
8235 ;; works: The minor mode defines all the keys necessary to operate the
8236 ;; structure commands, but wraps the commands into a function which
8237 ;; tests if the cursor is currently at a headline or a plain list
8238 ;; item. If that is the case, the structure command is used,
8239 ;; temporarily setting many Org-mode variables like regular
8240 ;; expressions for filling etc. However, when any of those keys is
8241 ;; used at a different location, function uses `key-binding' to look
8242 ;; up if the key has an associated command in another currently active
8243 ;; keymap (minor modes, major mode, global), and executes that
8244 ;; command. There might be problems if any of the keys is otherwise
8245 ;; used as a prefix key.
8247 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8248 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8249 ;; addresses this by checking explicitly for both bindings.
8251 (defvar orgstruct-mode-map (make-sparse-keymap)
8252 "Keymap for the minor `orgstruct-mode'.")
8254 (defvar org-local-vars nil
8255 "List of local variables, for use by `orgstruct-mode'.")
8257 ;;;###autoload
8258 (define-minor-mode orgstruct-mode
8259 "Toggle the minor mode `orgstruct-mode'.
8260 This mode is for using Org-mode structure commands in other
8261 modes. The following keys behave as if Org-mode were active, if
8262 the cursor is on a headline, or on a plain list item (both as
8263 defined by Org-mode).
8265 M-up Move entry/item up
8266 M-down Move entry/item down
8267 M-left Promote
8268 M-right Demote
8269 M-S-up Move entry/item up
8270 M-S-down Move entry/item down
8271 M-S-left Promote subtree
8272 M-S-right Demote subtree
8273 M-q Fill paragraph and items like in Org-mode
8274 C-c ^ Sort entries
8275 C-c - Cycle list bullet
8276 TAB Cycle item visibility
8277 M-RET Insert new heading/item
8278 S-M-RET Insert new TODO heading / Checkbox item
8279 C-c C-c Set tags / toggle checkbox"
8280 nil " OrgStruct" nil
8281 (org-load-modules-maybe)
8282 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8284 ;;;###autoload
8285 (defun turn-on-orgstruct ()
8286 "Unconditionally turn on `orgstruct-mode'."
8287 (orgstruct-mode 1))
8289 (defun orgstruct++-mode (&optional arg)
8290 "Toggle `orgstruct-mode', the enhanced version of it.
8291 In addition to setting orgstruct-mode, this also exports all indentation
8292 and autofilling variables from org-mode into the buffer. It will also
8293 recognize item context in multiline items.
8294 Note that turning off orgstruct-mode will *not* remove the
8295 indentation/paragraph settings. This can only be done by refreshing the
8297 (interactive "P")
8298 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8299 (if (< arg 1)
8300 (orgstruct-mode -1)
8301 (orgstruct-mode 1)
8302 (let (var val)
8303 (mapc
8304 (lambda (x)
8305 (when (string-match
8307 (symbol-name (car x)))
8308 (setq var (car x) val (nth 1 x))
8309 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8310 org-local-vars)
8311 (org-set-local 'orgstruct-is-++ t))))
8313 (defvar orgstruct-is-++ nil
8314 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8315 (make-variable-buffer-local 'orgstruct-is-++)
8317 ;;;###autoload
8318 (defun turn-on-orgstruct++ ()
8319 "Unconditionally turn on `orgstruct++-mode'."
8320 (orgstruct++-mode 1))
8322 (defun orgstruct-error ()
8323 "Error when there is no default binding for a structure key."
8324 (interactive)
8325 (error "This key has no function outside structure elements"))
8327 (defun orgstruct-setup ()
8328 "Setup orgstruct keymaps."
8329 (let ((nfunc 0)
8330 (bindings
8331 (list
8332 '([(meta up)] org-metaup)
8333 '([(meta down)] org-metadown)
8334 '([(meta left)] org-metaleft)
8335 '([(meta right)] org-metaright)
8336 '([(meta shift up)] org-shiftmetaup)
8337 '([(meta shift down)] org-shiftmetadown)
8338 '([(meta shift left)] org-shiftmetaleft)
8339 '([(meta shift right)] org-shiftmetaright)
8340 '([?\e (up)] org-metaup)
8341 '([?\e (down)] org-metadown)
8342 '([?\e (left)] org-metaleft)
8343 '([?\e (right)] org-metaright)
8344 '([?\e (shift up)] org-shiftmetaup)
8345 '([?\e (shift down)] org-shiftmetadown)
8346 '([?\e (shift left)] org-shiftmetaleft)
8347 '([?\e (shift right)] org-shiftmetaright)
8348 '([(shift up)] org-shiftup)
8349 '([(shift down)] org-shiftdown)
8350 '([(shift left)] org-shiftleft)
8351 '([(shift right)] org-shiftright)
8352 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8353 '("\M-q" fill-paragraph)
8354 '("\C-c^" org-sort)
8355 '("\C-c-" org-cycle-list-bullet)))
8356 elt key fun cmd)
8357 (while (setq elt (pop bindings))
8358 (setq nfunc (1+ nfunc))
8359 (setq key (org-key (car elt))
8360 fun (nth 1 elt)
8361 cmd (orgstruct-make-binding fun nfunc key))
8362 (org-defkey orgstruct-mode-map key cmd))
8364 ;; Special treatment needed for TAB and RET
8365 (org-defkey orgstruct-mode-map [(tab)]
8366 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8367 (org-defkey orgstruct-mode-map "\C-i"
8368 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8370 (org-defkey orgstruct-mode-map "\M-\C-m"
8371 (orgstruct-make-binding 'org-insert-heading 105
8372 "\M-\C-m" [(meta return)]))
8373 (org-defkey orgstruct-mode-map [(meta return)]
8374 (orgstruct-make-binding 'org-insert-heading 106
8375 [(meta return)] "\M-\C-m"))
8377 (org-defkey orgstruct-mode-map [(shift meta return)]
8378 (orgstruct-make-binding 'org-insert-todo-heading 107
8379 [(meta return)] "\M-\C-m"))
8381 (org-defkey orgstruct-mode-map "\e\C-m"
8382 (orgstruct-make-binding 'org-insert-heading 108
8383 "\e\C-m" [?\e (return)]))
8384 (org-defkey orgstruct-mode-map [?\e (return)]
8385 (orgstruct-make-binding 'org-insert-heading 109
8386 [?\e (return)] "\e\C-m"))
8387 (org-defkey orgstruct-mode-map [?\e (shift return)]
8388 (orgstruct-make-binding 'org-insert-todo-heading 110
8389 [?\e (return)] "\e\C-m"))
8391 (unless org-local-vars
8392 (setq org-local-vars (org-get-local-variables)))
8394 t))
8396 (defun orgstruct-make-binding (fun n &rest keys)
8397 "Create a function for binding in the structure minor mode.
8398 FUN is the command to call inside a table. N is used to create a unique
8399 command name. KEYS are keys that should be checked in for a command
8400 to execute outside of tables."
8401 (eval
8402 (list 'defun
8403 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8404 '(arg)
8406 "Outside of structure, run the binding of `"
8407 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8408 "'.")
8409 '(interactive "p")
8410 (list 'if
8411 `(org-context-p 'headline 'item
8412 (and orgstruct-is-++
8413 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8414 'item-body))
8415 (list 'org-run-like-in-org-mode (list 'quote fun))
8416 (list 'let '(orgstruct-mode)
8417 (list 'call-interactively
8418 (append '(or)
8419 (mapcar (lambda (k)
8420 (list 'key-binding k))
8421 keys)
8422 '('orgstruct-error))))))))
8424 (defun org-context-p (&rest contexts)
8425 "Check if local context is any of CONTEXTS.
8426 Possible values in the list of contexts are `table', `headline', and `item'."
8427 (let ((pos (point)))
8428 (goto-char (point-at-bol))
8429 (prog1 (or (and (memq 'table contexts)
8431 (and (memq 'headline contexts)
8432 (looking-at org-outline-regexp))
8433 (and (memq 'item contexts)
8435 (and (memq 'item-body contexts)
8436 (org-in-item-p)))
8437 (goto-char pos))))
8439 (defun org-get-local-variables ()
8440 "Return a list of all local variables in an org-mode buffer."
8441 (let (varlist)
8442 (with-current-buffer (get-buffer-create "*Org tmp*")
8443 (erase-buffer)
8444 (org-mode)
8445 (setq varlist (buffer-local-variables)))
8446 (kill-buffer "*Org tmp*")
8447 (delq nil
8448 (mapcar
8449 (lambda (x)
8450 (setq x
8451 (if (symbolp x)
8452 (list x)
8453 (list (car x) (list 'quote (cdr x)))))
8454 (if (string-match
8455 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8456 (symbol-name (car x)))
8457 x nil))
8458 varlist))))
8460 (defun org-clone-local-variables (from-buffer &optional regexp)
8461 "Clone local variables from FROM-BUFFER.
8462 Optional argument REGEXP selects variables to clone."
8463 (mapc
8464 (lambda (pair)
8465 (and (symbolp (car pair))
8466 (or (null regexp)
8467 (string-match regexp (symbol-name (car pair))))
8468 (set (make-local-variable (car pair))
8469 (cdr pair))))
8470 (buffer-local-variables from-buffer)))
8472 ;;;###autoload
8473 (defun org-run-like-in-org-mode (cmd)
8474 "Run a command, pretending that the current buffer is in Org-mode.
8475 This will temporarily bind local variables that are typically bound in
8476 Org-mode to the values they have in Org-mode, and then interactively
8477 call CMD."
8478 (org-load-modules-maybe)
8479 (unless org-local-vars
8480 (setq org-local-vars (org-get-local-variables)))
8481 (eval (list 'let org-local-vars
8482 (list 'call-interactively (list 'quote cmd)))))
8484 ;;;; Archiving
8486 (defun org-get-category (&optional pos force-refresh)
8487 "Get the category applying to position POS."
8488 (if force-refresh (org-refresh-category-properties))
8489 (let ((pos (or pos (point))))
8490 (or (get-text-property pos 'org-category)
8491 (progn (org-refresh-category-properties)
8492 (get-text-property pos 'org-category)))))
8494 (defun org-refresh-category-properties ()
8495 "Refresh category text properties in the buffer."
8496 (let ((def-cat (cond
8497 ((null org-category)
8498 (if buffer-file-name
8499 (file-name-sans-extension
8500 (file-name-nondirectory buffer-file-name))
8501 "???"))
8502 ((symbolp org-category) (symbol-name org-category))
8503 (t org-category)))
8504 beg end cat pos optionp)
8505 (org-unmodified
8506 (save-excursion
8507 (save-restriction
8508 (widen)
8509 (goto-char (point-min))
8510 (put-text-property (point) (point-max) 'org-category def-cat)
8511 (while (re-search-forward
8513 (setq pos (match-end 0)
8514 optionp (equal (char-after (match-beginning 0)) ?#)
8515 cat (org-trim (match-string 2)))
8516 (if optionp
8517 (setq beg (point-at-bol) end (point-max))
8518 (org-back-to-heading t)
8519 (setq beg (point) end (org-end-of-subtree t t)))
8520 (put-text-property beg end 'org-category cat)
8521 (put-text-property beg end 'org-category-position beg)
8522 (goto-char pos)))))))
8525 ;;;; Link Stuff
8527 ;;; Link abbreviations
8529 (defun org-link-expand-abbrev (link)
8530 "Apply replacements as defined in `org-link-abbrev-alist."
8532 (let* ((key (match-string 1 link))
8533 (as (or (assoc key org-link-abbrev-alist-local)
8534 (assoc key org-link-abbrev-alist)))
8535 (tag (and (match-end 2) (match-string 3 link)))
8536 rpl)
8537 (if (not as)
8538 link
8539 (setq rpl (cdr as))
8540 (cond
8541 ((symbolp rpl) (funcall rpl tag))
8542 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8543 ((string-match "%h" rpl)
8544 (replace-match (url-hexify-string (or tag "")) t t rpl))
8545 (t (concat rpl tag)))))
8546 link))
8548 ;;; Storing and inserting links
8550 (defvar org-insert-link-history nil
8551 "Minibuffer history for links inserted with `org-insert-link'.")
8553 (defvar org-stored-links nil
8554 "Contains the links stored with `org-store-link'.")
8556 (defvar org-store-link-plist nil
8557 "Plist with info about the most recently link created with `org-store-link'.")
8559 (defvar org-link-protocols nil
8560 "Link protocols added to Org-mode using `org-add-link-type'.")
8562 (defvar org-store-link-functions nil
8563 "List of functions that are called to create and store a link.
8564 Each function will be called in turn until one returns a non-nil
8565 value. Each function should check if it is responsible for creating
8566 this link (for example by looking at the major mode).
8567 If not, it must exit and return nil.
8568 If yes, it should return a non-nil value after a calling
8569 `org-store-link-props' with a list of properties and values.
8570 Special properties are:
8574 This is obligatory as well.
8575 :description Optional default description for the second pair
8576 of brackets in an Org-mode link. The user can still change
8577 this when inserting this link into an Org-mode buffer.
8579 In addition to these, any additional properties can be specified
8580 and then used in remember templates.")
8582 (defun org-add-link-type (type &optional follow export)
8583 "Add TYPE to the list of `org-link-types'.
8584 Re-compute all regular expressions depending on `org-link-types'
8586 FOLLOW and EXPORT are two functions.
8588 FOLLOW should take the link path as the single argument and do whatever
8589 is necessary to follow the link, for example find a file or display
8590 a mail message.
8592 EXPORT should format the link path for export to one of the export formats.
8593 It should be a function accepting three arguments:
8596 desc the description of the link, if any, or a description added by
8597 org-export-normalize-links if there is none
8598 format the export format, a symbol like `html' or `latex' or `ascii'..
8600 The function may use the FORMAT information to return different values
8601 depending on the format. The return value will be put literally into
8602 the exported file. If the return value is nil, this means Org should
8603 do what it normally does with links which do not have EXPORT defined.
8605 Org-mode has a built-in default for exporting links. If you are happy with
8606 this default, there is no need to define an export function for the link
8607 type. For a simple example of an export function, see `org-bbdb.el'."
8608 (add-to-list 'org-link-types type t)
8609 (org-make-link-regexps)
8610 (if (assoc type org-link-protocols)
8611 (setcdr (assoc type org-link-protocols) (list follow export))
8612 (push (list type follow export) org-link-protocols)))
8614 (defvar org-agenda-buffer-name)
8616 ;;;###autoload
8617 (defun org-store-link (arg)
8619 This link is added to `org-stored-links' and can later be inserted
8622 For some link types, a prefix arg is interpreted:
8623 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8624 For file links, arg negates `org-context-in-file-links'."
8625 (interactive "P")
8626 (org-load-modules-maybe)
8627 (setq org-store-link-plist nil) ; reset
8628 (org-with-limited-levels
8629 (let (link cpltxt desc description search txt custom-id agenda-link)
8630 (cond
8632 ((run-hook-with-args-until-success 'org-store-link-functions)
8633 (setq link (plist-get org-store-link-plist :link)
8634 desc (or (plist-get org-store-link-plist :description) link)))
8636 ((equal (buffer-name) "*Org Edit Src Example*")
8637 (let (label gc)
8638 (while (or (not label)
8639 (save-excursion
8640 (save-restriction
8641 (widen)
8642 (goto-char (point-min))
8643 (re-search-forward
8644 (regexp-quote (format org-coderef-label-format label))
8645 nil t))))
8646 (when label (message "Label exists already") (sit-for 2))
8647 (setq label (read-string "Code line label: " label)))
8648 (end-of-line 1)
8649 (setq link (format org-coderef-label-format label))
8650 (setq gc (- 79 (length link)))
8651 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8652 (insert link)
8653 (setq link (concat "(" label ")") desc nil)))
8655 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8656 ;; We are in the agenda, link to referenced location
8657 (let ((m (or (get-text-property (point) 'org-hd-marker)
8658 (get-text-property (point) 'org-marker))))
8659 (when m
8660 (org-with-point-at m
8661 (setq agenda-link
8662 (if (org-called-interactively-p 'any)
8663 (call-interactively 'org-store-link)
8664 (org-store-link nil)))))))
8666 ((eq major-mode 'calendar-mode)
8667 (let ((cd (calendar-cursor-to-date)))
8668 (setq link
8669 (format-time-string
8670 (car org-time-stamp-formats)
8671 (apply 'encode-time
8672 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8673 nil nil nil))))
8674 (org-store-link-props :type "calendar" :date cd)))
8676 ((eq major-mode 'w3-mode)
8677 (setq cpltxt (if (and (buffer-name)
8678 (not (string-match "Untitled" (buffer-name))))
8679 (buffer-name)
8680 (url-view-url t))
8681 link (org-make-link (url-view-url t)))
8682 (org-store-link-props :type "w3" :url (url-view-url t)))
8684 ((eq major-mode 'w3m-mode)
8685 (setq cpltxt (or w3m-current-title w3m-current-url)
8686 link (org-make-link w3m-current-url))
8687 (org-store-link-props :type "w3m" :url (url-view-url t)))
8689 ((setq search (run-hook-with-args-until-success
8690 'org-create-file-search-functions))
8691 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8692 "::" search))
8693 (setq cpltxt (or description link)))
8695 ((eq major-mode 'image-mode)
8696 (setq cpltxt (concat "file:"
8697 (abbreviate-file-name buffer-file-name))
8698 link (org-make-link cpltxt))
8699 (org-store-link-props :type "image" :file buffer-file-name))
8701 ((eq major-mode 'dired-mode)
8702 ;; link to the file in the current line
8703 (let ((file (dired-get-filename nil t)))
8704 (setq file (if file
8705 (abbreviate-file-name
8706 (expand-file-name (dired-get-filename nil t)))
8707 ;; otherwise, no file so use current directory.
8708 default-directory))
8709 (setq cpltxt (concat "file:" file)
8710 link (org-make-link cpltxt))))
8712 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8713 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8714 (cond
8716 (setq cpltxt
8717 (concat "file:"
8718 (abbreviate-file-name
8719 (buffer-file-name (buffer-base-buffer)))
8720 "::" (match-string 1))
8721 link (org-make-link cpltxt)))
8722 ((and (featurep 'org-id)
8723 (or (eq org-link-to-org-use-id t)
8724 (and (eq org-link-to-org-use-id 'create-if-interactive)
8725 (org-called-interactively-p 'any))
8726 (and (eq org-link-to-org-use-id
8727 'create-if-interactive-and-no-custom-id)
8728 (org-called-interactively-p 'any)
8729 (not custom-id))
8730 (and org-link-to-org-use-id
8731 (org-entry-get nil "ID"))))
8732 ;; We can make a link using the ID.
8733 (setq link (condition-case nil
8734 (prog1 (org-id-store-link)
8735 (setq desc (plist-get org-store-link-plist
8736 :description)))
8737 (error
8738 ;; probably before first headline, link to file only
8739 (concat "file:"
8740 (abbreviate-file-name
8741 (buffer-file-name (buffer-base-buffer))))))))
8742 (t
8743 ;; Just link to current headline
8744 (setq cpltxt (concat "file:"
8745 (abbreviate-file-name
8746 (buffer-file-name (buffer-base-buffer)))))
8747 ;; Add a context search string
8748 (when (org-xor org-context-in-file-links arg)
8749 (setq txt (cond
8750 ((org-at-heading-p) nil)
8751 ((org-region-active-p)
8752 (buffer-substring (region-beginning) (region-end)))
8753 (t nil)))
8755 (setq cpltxt
8756 (concat cpltxt "::"
8757 (condition-case nil
8758 (org-make-org-heading-search-string txt)
8759 (error "")))
8760 desc (or (nth 4 (ignore-errors
8761 (org-heading-components))) "NONE"))))
8763 (setq cpltxt (substring cpltxt 0 -2)))
8764 (setq link (org-make-link cpltxt)))))
8766 ((buffer-file-name (buffer-base-buffer))
8767 ;; Just link to this file here.
8768 (setq cpltxt (concat "file:"
8769 (abbreviate-file-name
8770 (buffer-file-name (buffer-base-buffer)))))
8771 ;; Add a context string
8772 (when (org-xor org-context-in-file-links arg)
8773 (setq txt (if (org-region-active-p)
8774 (buffer-substring (region-beginning) (region-end))
8775 (buffer-substring (point-at-bol) (point-at-eol))))
8776 ;; Only use search option if there is some text.
8778 (setq cpltxt
8779 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8780 desc "NONE")))
8781 (setq link (org-make-link cpltxt)))
8783 ((org-called-interactively-p 'interactive)
8784 (error "Cannot link to a buffer which is not visiting a file"))
8786 (t (setq link nil)))
8788 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8789 (setq link (or link cpltxt)
8790 desc (or desc cpltxt))
8791 (if (equal desc "NONE") (setq desc nil))
8793 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8794 (progn
8795 (setq org-stored-links
8796 (cons (list link desc) org-stored-links))
8797 (message "Stored: %s" (or desc link))
8798 (when custom-id
8799 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8800 "::#" custom-id))
8801 (setq org-stored-links
8802 (cons (list link desc) org-stored-links))))
8803 (or agenda-link (and link (org-make-link-string link desc)))))))
8805 (defun org-store-link-props (&rest plist)
8806 "Store link properties, extract names and addresses."
8807 (let (x adr)
8808 (when (setq x (plist-get plist :from))
8809 (setq adr (mail-extract-address-components x))
8810 (setq plist (plist-put plist :fromname (car adr)))
8811 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8812 (when (setq x (plist-get plist :to))
8813 (setq adr (mail-extract-address-components x))
8814 (setq plist (plist-put plist :toname (car adr)))
8815 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8816 (let ((from (plist-get plist :from))
8817 (to (plist-get plist :to)))
8818 (when (and from to org-from-is-user-regexp)
8819 (setq plist
8820 (plist-put plist :fromto
8821 (if (string-match org-from-is-user-regexp from)
8822 (concat "to %t")
8823 (concat "from %f"))))))
8824 (setq org-store-link-plist plist))
8826 (defun org-add-link-props (&rest plist)
8827 "Add these properties to the link property list."
8828 (let (key value)
8829 (while plist
8830 (setq key (pop plist) value (pop plist))
8831 (setq org-store-link-plist
8832 (plist-put org-store-link-plist key value)))))
8834 (defun org-email-link-description (&optional fmt)
8835 "Return the description part of an email link.
8836 This takes information from `org-store-link-plist' and formats it
8837 according to FMT (default from `org-email-link-description-format')."
8838 (setq fmt (or fmt org-email-link-description-format))
8839 (let* ((p org-store-link-plist)
8840 (to (plist-get p :toaddress))
8841 (from (plist-get p :fromaddress))
8842 (table
8843 (list
8844 (cons "%c" (plist-get p :fromto))
8845 (cons "%F" (plist-get p :from))
8846 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8847 (cons "%T" (plist-get p :to))
8848 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8849 (cons "%s" (plist-get p :subject))
8850 (cons "%d" (plist-get p :date))
8851 (cons "%m" (plist-get p :message-id)))))
8852 (when (string-match "%c" fmt)
8853 ;; Check if the user wrote this message
8854 (if (and org-from-is-user-regexp from to
8855 (save-match-data (string-match org-from-is-user-regexp from)))
8856 (setq fmt (replace-match "to %t" t t fmt))
8857 (setq fmt (replace-match "from %f" t t fmt))))
8858 (org-replace-escapes fmt table)))
8860 (defun org-make-org-heading-search-string (&optional string heading)
8861 "Make search string for STRING or current headline."
8862 (interactive)
8863 (let ((s (or string (org-get-heading)))
8864 (lines org-context-in-file-links))
8865 (unless (and string (not heading))
8866 ;; We are using a headline, clean up garbage in there.
8867 (if (string-match org-todo-regexp s)
8868 (setq s (replace-match "" t t s)))
8870 (setq s (replace-match "" t t s)))
8871 (setq s (org-trim s))
8874 (setq s (replace-match "" t t s)))
8875 (while (string-match org-ts-regexp s)
8876 (setq s (replace-match "" t t s))))
8877 (or string (setq s (concat "*" s))) ; Add * for headlines
8878 (when (and string (integerp lines) (> lines 0))
8880 (when (< lines (length slines))
8881 (setq s (mapconcat
8882 'identity
8883 (reverse (nthcdr (- (length slines) lines)
8887 (defun org-make-link (&rest strings)
8888 "Concatenate STRINGS."
8889 (apply 'concat strings))
8891 (defun org-make-link-string (link &optional description)
8892 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8894 (error "Empty link"))
8895 (when (and description
8896 (stringp description)
8898 (setq description nil))
8899 (when (stringp description)
8900 ;; Remove brackets from the description, they are fatal.
8902 (setq description (replace-match "{" t t description)))
8904 (setq description (replace-match "}" t t description))))
8905 (when (equal link description)
8906 ;; No description needed, it is identical
8907 (setq description nil))
8908 (when (and (not description)
8909 (not (string-match (org-image-file-name-regexp) link))
8910 (not (equal link (org-link-escape link))))
8911 (setq description (org-extract-attributes link)))
8912 (setq link
8913 (cond ((string-match (org-image-file-name-regexp) link) link)
8914 ((string-match org-link-types-re link)
8915 (concat (match-string 1 link)
8916 (org-link-escape (substring link (match-end 1)))))
8917 (t (org-link-escape link))))
8918 (concat "[[" link "]"
8919 (if description (concat "[" description "]") "")
8920 "]"))
8922 (defconst org-link-escape-chars
8923 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8924 "List of characters that should be escaped in link.
8925 This is the list that is used for internal purposes.")
8927 (defvar org-url-encoding-use-url-hexify nil)
8929 (defconst org-link-escape-chars-browser
8930 '(?\ )
8931 "List of escapes for characters that are problematic in links.
8932 This is the list that is used before handing over to the browser.")
8934 (defun org-link-escape (text &optional table merge)
8935 "Return percent escaped representation of TEXT.
8936 TEXT is a string with the text to escape.
8937 Optional argument TABLE is a list with characters that should be
8938 escaped. When nil, `org-link-escape-chars' is used.
8939 If optional argument MERGE is set, merge TABLE into
8940 `org-link-escape-chars'."
8941 (if (and org-url-encoding-use-url-hexify (not table))
8942 (url-hexify-string text)
8943 (cond
8944 ((and table merge)
8945 (mapc (lambda (defchr)
8946 (unless (member defchr table)
8947 (setq table (cons defchr table)))) org-link-escape-chars))
8948 ((null table)
8949 (setq table org-link-escape-chars)))
8950 (mapconcat
8951 (lambda (char)
8952 (if (or (member char table)
8953 (< char 32) (= char 37) (> char 126))
8954 (mapconcat (lambda (sequence-element)
8955 (format "%%%.2X" sequence-element))
8956 (or (encode-coding-char char 'utf-8)
8957 (error "Unable to percent escape character: %s"
8958 (char-to-string char))) "")
8959 (char-to-string char))) text "")))
8961 (defun org-link-unescape (str)
8962 "Unhex hexified Unicode strings as returned from the JavaScript function
8963 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8964 (unless (and (null str) (string= "" str))
8965 (let ((pos 0) (case-fold-search t) unhexed)
8967 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8968 (setq str (replace-match unhexed t t str))
8969 (setq pos (+ pos (length unhexed))))))
8970 str)
8972 (defun org-link-unescape-compound (hex)
8973 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8974 Note: this function also decodes single byte encodings like
8976 (save-match-data
8977 (let* ((bytes (cdr (split-string hex "%")))
8978 (ret "")
8979 (eat 0)
8980 (sum 0))
8981 (while bytes
8982 (let* ((val (string-to-number (pop bytes) 16))
8983 (shift-xor
8984 (if (= 0 eat)
8985 (cond
8986 ((>= val 252) (cons 6 252))
8987 ((>= val 248) (cons 5 248))
8988 ((>= val 240) (cons 4 240))
8989 ((>= val 224) (cons 3 224))
8990 ((>= val 192) (cons 2 192))
8991 (t (cons 0 0)))
8992 (cons 6 128))))
8993 (if (>= val 192) (setq eat (car shift-xor)))
8994 (setq val (logxor val (cdr shift-xor)))
8995 (setq sum (+ (lsh sum (car shift-xor)) val))
8996 (if (> eat 0) (setq eat (- eat 1)))
8997 (cond
8998 ((= 0 eat) ;multi byte
8999 (setq ret (concat ret (org-char-to-string sum)))
9000 (setq sum 0))
9001 ((not bytes) ; single byte(s)
9002 (setq ret (org-link-unescape-single-byte-sequence hex))))
9003 )) ;; end (while bytes
9004 ret )))
9006 (defun org-link-unescape-single-byte-sequence (hex)
9007 "Unhexify hex-encoded single byte character sequences."
9008 (mapconcat (lambda (byte)
9009 (char-to-string (string-to-number byte 16)))
9010 (cdr (split-string hex "%")) ""))
9012 (defun org-xor (a b)
9013 "Exclusive or."
9014 (if a (not b) b))
9016 (defun org-fixup-message-id-for-http (s)
9017 "Replace special characters in a message id, so it can be used in an http query."
9018 (when (string-match "%" s)
9019 (setq s (mapconcat (lambda (c)
9020 (if (eq c ?%)
9021 "%25"
9022 (char-to-string c)))
9023 s "")))
9024 (while (string-match "<" s)
9025 (setq s (replace-match "%3C" t t s)))
9026 (while (string-match ">" s)
9027 (setq s (replace-match "%3E" t t s)))
9028 (while (string-match "@" s)
9029 (setq s (replace-match "%40" t t s)))
9030 s)
9032 ;;;###autoload
9033 (defun org-insert-link-global ()
9034 "Insert a link like Org-mode does.
9035 This command can be called in any mode to insert a link in Org-mode syntax."
9036 (interactive)
9037 (org-load-modules-maybe)
9038 (org-run-like-in-org-mode 'org-insert-link))
9040 (defun org-insert-link (&optional complete-file link-location default-description)
9041 "Insert a link. At the prompt, enter the link.
9043 Completion can be used to insert any of the link protocol prefixes like
9044 http or ftp in use.
9046 The history can be used to select a link previously stored with
9047 `org-store-link'. When the empty string is entered (i.e. if you just
9048 press RET at the prompt), the link defaults to the most recently
9049 stored link. As SPC triggers completion in the minibuffer, you need to
9050 use M-SPC or C-q SPC to force the insertion of a space character.
9052 You will also be prompted for a description, and if one is given, it will
9053 be displayed in the buffer instead of the link.
9055 If there is already a link at point, this command will allow you to edit link
9056 and description parts.
9059 be selected using completion. The path to the file will be relative to the
9060 current directory if the file is in the current directory or a subdirectory.
9061 Otherwise, the link will be the absolute path as completed in the minibuffer
9062 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9063 option `org-link-file-path-type'.
9066 the current directory or below.
9069 `org-keep-stored-link-after-insertion'.
9071 If `org-make-link-description-function' is non-nil, this function will be
9072 called with the link target, and the result will be the default
9073 link description.
9075 If the LINK-LOCATION parameter is non-nil, this value will be
9076 used as the link location instead of reading one interactively.
9078 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9079 be used as the default description."
9080 (interactive "P")
9081 (let* ((wcf (current-window-configuration))
9082 (region (if (org-region-active-p)
9083 (buffer-substring (region-beginning) (region-end))))
9084 (remove (and region (list (region-beginning) (region-end))))
9085 (desc region)
9086 tmphist ; byte-compile incorrectly complains about this
9087 (link link-location)
9088 entry file all-prefixes)
9089 (cond
9090 (link-location) ; specified by arg, just use it.
9091 ((org-in-regexp org-bracket-link-regexp 1)
9092 ;; We do have a link at point, and we are going to edit it.
9093 (setq remove (list (match-beginning 0) (match-end 0)))
9094 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9095 (setq link (read-string "Link: "
9096 (org-link-unescape
9097 (org-match-string-no-properties 1)))))
9098 ((or (org-in-regexp org-angle-link-re)
9099 (org-in-regexp org-plain-link-re))
9100 ;; Convert to bracket link
9101 (setq remove (list (match-beginning 0) (match-end 0))
9102 link (read-string "Link: "
9103 (org-remove-angle-brackets (match-string 0)))))
9104 ((member complete-file '((4) (16)))
9105 ;; Completing read for file names.
9106 (setq link (org-file-complete-link complete-file)))
9107 (t
9108 ;; Read link, with completion for stored links.
9109 (with-output-to-temp-buffer "*Org Links*"
9110 (princ "Insert a link.
9112 (when org-stored-links
9114 (princ (mapconcat
9115 (lambda (x)
9116 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9118 (let ((cw (selected-window)))
9119 (select-window (get-buffer-window "*Org Links*" 'visible))
9120 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9121 (unless (pos-visible-in-window-p (point-max))
9122 (org-fit-window-to-buffer))
9123 (and (window-live-p cw) (select-window cw)))
9124 ;; Fake a link history, containing the stored links.
9125 (setq tmphist (append (mapcar 'car org-stored-links)
9126 org-insert-link-history))
9127 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9128 (mapcar 'car org-link-abbrev-alist)
9129 org-link-types))
9130 (unwind-protect
9131 (progn
9132 (setq link
9133 (let ((org-completion-use-ido nil)
9134 (org-completion-use-iswitchb nil))
9135 (org-completing-read
9136 "Link: "
9137 (append
9138 (mapcar (lambda (x) (list (concat x ":")))
9139 all-prefixes)
9140 (mapcar 'car org-stored-links))
9141 nil nil nil
9142 'tmphist
9143 (car (car org-stored-links)))))
9145 (error "No link selected"))
9146 (if (or (member link all-prefixes)
9147 (and (equal ":" (substring link -1))
9148 (member (substring link 0 -1) all-prefixes)
9149 (setq link (substring link 0 -1))))
9150 (setq link (org-link-try-special-completion link))))
9151 (set-window-configuration wcf)
9152 (kill-buffer "*Org Links*"))
9153 (setq entry (assoc link org-stored-links))
9154 (or entry (push link org-insert-link-history))
9155 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9156 (not org-keep-stored-link-after-insertion))
9157 (setq org-stored-links (delq (assoc link org-stored-links)
9158 org-stored-links)))
9159 (setq desc (or desc (nth 1 entry)))))
9161 (if (string-match org-plain-link-re link)
9162 ;; URL-like link, normalize the use of angular brackets.
9163 (setq link (org-make-link (org-remove-angle-brackets link))))
9165 ;; Check if we are linking to the current file with a search option
9166 ;; If yes, simplify the link by using only the search option.
9167 (when (and buffer-file-name
9169 (let* ((path (match-string 1 link))
9170 (case-fold-search nil)
9171 (search (match-string 2 link)))
9172 (save-match-data
9173 (if (equal (file-truename buffer-file-name) (file-truename path))
9174 ;; We are linking to this same file, with a search option
9175 (setq link search)))))
9177 ;; Check if we can/should use a relative path. If yes, simplify the link
9179 (let* ((type (match-string 1 link))
9180 (path (match-string 2 link))
9181 (origpath path)
9182 (case-fold-search nil))
9183 (cond
9184 ((or (eq org-link-file-path-type 'absolute)
9185 (equal complete-file '(16)))
9186 (setq path (abbreviate-file-name (expand-file-name path))))
9187 ((eq org-link-file-path-type 'noabbrev)
9188 (setq path (expand-file-name path)))
9189 ((eq org-link-file-path-type 'relative)
9190 (setq path (file-relative-name path)))
9191 (t
9192 (save-match-data
9193 (if (string-match (concat "^" (regexp-quote
9194 (expand-file-name
9195 (file-name-as-directory
9196 default-directory))))
9197 (expand-file-name path))
9198 ;; We are linking a file with relative path name.
9199 (setq path (substring (expand-file-name path)
9200 (match-end 0)))
9201 (setq path (abbreviate-file-name (expand-file-name path)))))))
9202 (setq link (concat type path))
9203 (if (equal desc origpath)
9204 (setq desc path))))
9206 (if org-make-link-description-function
9207 (setq desc (funcall org-make-link-description-function link desc))
9208 (if default-description (setq desc default-description)))
9210 (setq desc (read-string "Description: " desc))
9212 (if remove (apply 'delete-region remove))
9213 (insert (org-make-link-string link desc))))
9215 (defun org-link-try-special-completion (type)
9216 "If there is completion support for link type TYPE, offer it."
9217 (let ((fun (intern (concat "org-" type "-complete-link"))))
9218 (if (functionp fun)
9219 (funcall fun)
9220 (read-string "Link (no completion support): " (concat type ":")))))
9222 (defun org-file-complete-link (&optional arg)
9223 "Create a file link using completion."
9224 (let (file link)
9225 (setq file (read-file-name "File: "))
9226 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9227 (pwd1 (file-name-as-directory (abbreviate-file-name
9228 (expand-file-name ".")))))
9229 (cond
9230 ((equal arg '(16))
9231 (setq link (org-make-link
9232 "file:"
9233 (abbreviate-file-name (expand-file-name file)))))
9235 (setq link (org-make-link "file:" (match-string 1 file))))
9237 (expand-file-name file))
9238 (setq link (org-make-link
9239 "file:" (match-string 1 (expand-file-name file)))))
9240 (t (setq link (org-make-link "file:" file)))))
9241 link))
9243 (defun org-completing-read (&rest args)
9244 "Completing-read with SPACE being a normal character."
9245 (let ((enable-recursive-minibuffers t)
9246 (minibuffer-local-completion-map
9247 (copy-keymap minibuffer-local-completion-map)))
9248 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9249 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9250 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9251 (apply 'org-icompleting-read args)))
9253 (defun org-completing-read-no-i (&rest args)
9254 (let (org-completion-use-ido org-completion-use-iswitchb)
9255 (apply 'org-completing-read args)))
9257 (defun org-iswitchb-completing-read (prompt choices &rest args)
9258 "Use iswitch as a completing-read replacement to choose from choices.
9259 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9260 from."
9261 (let* ((iswitchb-use-virtual-buffers nil)
9262 (iswitchb-make-buflist-hook
9263 (lambda ()
9264 (setq iswitchb-temp-buflist choices))))
9265 (iswitchb-read-buffer prompt)))
9267 (defun org-icompleting-read (&rest args)
9268 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9269 (org-without-partial-completion
9270 (if (and org-completion-use-ido
9271 (fboundp 'ido-completing-read)
9272 (boundp 'ido-mode) ido-mode
9273 (listp (second args)))
9274 (let ((ido-enter-matching-directory nil))
9275 (apply 'ido-completing-read (concat (car args))
9276 (if (consp (car (nth 1 args)))
9277 (mapcar 'car (nth 1 args))
9278 (nth 1 args))
9279 (cddr args)))
9280 (if (and org-completion-use-iswitchb
9281 (boundp 'iswitchb-mode) iswitchb-mode
9282 (listp (second args)))
9283 (apply 'org-iswitchb-completing-read (concat (car args))
9284 (if (consp (car (nth 1 args)))
9285 (mapcar 'car (nth 1 args))
9286 (nth 1 args))
9287 (cddr args))
9288 (apply 'completing-read args)))))
9290 (defun org-extract-attributes (s)
9291 "Extract the attributes cookie from a string and set as text property."
9292 (let (a attr (start 0) key value)
9293 (save-match-data
9295 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9297 (setq key (match-string 1 a) value (match-string 2 a)
9298 start (match-end 0)
9299 attr (plist-put attr (intern key) value))))
9300 (org-add-props s nil 'org-attr attr))
9301 s))
9303 (defun org-extract-attributes-from-string (tag)
9304 (let (key value attr)
9306 (setq key (match-string 1 tag) value (match-string 2 tag)
9307 tag (replace-match "" t t tag)
9308 attr (plist-put attr (intern key) value)))
9309 (cons tag attr)))
9311 (defun org-attributes-to-string (plist)
9312 "Format a property list into an HTML attribute list."
9313 (let ((s "") key value)
9314 (while plist
9315 (setq key (pop plist) value (pop plist))
9316 (and value
9318 s))
9320 ;;; Opening/following a link
9322 (defvar org-link-search-failed nil)
9324 (defvar org-open-link-functions nil
9325 "Hook for functions finding a plain text link.
9326 These functions must take a single argument, the link content.
9327 They will be called for links that look like [[link text][description]]
9331 These functions will be called *before* Org attempts to resolve the
9332 link by doing text searches in the current buffer - so if you want a
9334 handle this as a special case.
9336 When the function does handle the link, it must return a non-nil value.
9337 If it decides that it is not responsible for this link, it must return
9338 nil to indicate that that Org-mode can continue with other options
9339 like exact and fuzzy text search.")
9341 (defun org-next-link ()
9342 "Move forward to the next link.
9343 If the link is in hidden text, expose it."
9344 (interactive)
9345 (when (and org-link-search-failed (eq this-command last-command))
9346 (goto-char (point-min))
9347 (message "Link search wrapped back to beginning of buffer"))
9348 (setq org-link-search-failed nil)
9349 (let* ((pos (point))
9350 (ct (org-context))
9351 (a (assoc :link ct)))
9352 (if a (goto-char (nth 2 a)))
9353 (if (re-search-forward org-any-link-re nil t)
9354 (progn
9355 (goto-char (match-beginning 0))
9356 (if (outline-invisible-p) (org-show-context)))
9357 (goto-char pos)
9358 (setq org-link-search-failed t)
9359 (error "No further link found"))))
9361 (defun org-previous-link ()
9362 "Move backward to the previous link.
9363 If the link is in hidden text, expose it."
9364 (interactive)
9365 (when (and org-link-search-failed (eq this-command last-command))
9366 (goto-char (point-max))
9367 (message "Link search wrapped back to end of buffer"))
9368 (setq org-link-search-failed nil)
9369 (let* ((pos (point))
9370 (ct (org-context))
9371 (a (assoc :link ct)))
9372 (if a (goto-char (nth 1 a)))
9373 (if (re-search-backward org-any-link-re nil t)
9374 (progn
9375 (goto-char (match-beginning 0))
9376 (if (outline-invisible-p) (org-show-context)))
9377 (goto-char pos)
9378 (setq org-link-search-failed t)
9379 (error "No further link found"))))
9381 (defun org-translate-link (s)
9382 "Translate a link string if a translation function has been defined."
9383 (if (and org-link-translation-function
9384 (fboundp org-link-translation-function)
9386 (progn
9387 (setq s (funcall org-link-translation-function
9388 (match-string 1) (match-string 2)))
9389 (concat (car s) ":" (cdr s)))
9390 s))
9392 (defun org-translate-link-from-planner (type path)
9393 "Translate a link from Emacs Planner syntax so that Org can follow it.
9394 This is still an experimental function, your mileage may vary."
9395 (cond
9396 ((member type '("http" "https" "news" "ftp"))
9397 ;; standard Internet links are the same.
9398 nil)
9399 ((and (equal type "irc") (string-match "^//" path))
9400 ;; Planner has two / at the beginning of an irc link, we have 1.
9401 ;; We should have zero, actually....
9402 (setq path (substring path 1)))
9403 ((and (equal type "lisp") (string-match "^/" path))
9404 ;; Planner has a slash, we do not.
9405 (setq type "elisp" path (substring path 1)))
9407 ;; A typical message link. Planner has the id after the final slash,
9408 ;; we separate it with a hash mark
9409 (setq path (concat (match-string 1 path) "#"
9410 (org-remove-angle-brackets (match-string 2 path)))))
9411 )
9412 (cons type path))
9414 (defun org-find-file-at-mouse (ev)
9415 "Open file link or URL at mouse."
9416 (interactive "e")
9417 (mouse-set-point ev)
9418 (org-open-at-point 'in-emacs))
9420 (defun org-open-at-mouse (ev)
9421 "Open file link or URL at mouse.
9422 See the docstring of `org-open-file' for details."
9423 (interactive "e")
9424 (mouse-set-point ev)
9425 (if (eq major-mode 'org-agenda-mode)
9426 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9427 (org-open-at-point))
9429 (defvar org-window-config-before-follow-link nil
9430 "The window configuration before following a link.
9431 This is saved in case the need arises to restore it.")
9433 (defvar org-open-link-marker (make-marker)
9434 "Marker pointing to the location where `org-open-at-point; was called.")
9436 ;;;###autoload
9437 (defun org-open-at-point-global ()
9438 "Follow a link like Org-mode does.
9439 This command can be called in any mode to follow a link that has
9440 Org-mode syntax."
9441 (interactive)
9442 (org-run-like-in-org-mode 'org-open-at-point))
9444 ;;;###autoload
9445 (defun org-open-link-from-string (s &optional arg reference-buffer)
9446 "Open a link in the string S, as if it was in Org-mode."
9448 (let ((reference-buffer (or reference-buffer (current-buffer))))
9449 (with-temp-buffer
9450 (let ((org-inhibit-startup (not reference-buffer)))
9451 (org-mode)
9452 (insert s)
9453 (goto-char (point-min))
9454 (when reference-buffer
9455 (setq org-link-abbrev-alist-local
9456 (with-current-buffer reference-buffer
9457 org-link-abbrev-alist-local)))
9458 (org-open-at-point arg reference-buffer)))))
9460 (defvar org-open-at-point-functions nil
9461 "Hook that is run when following a link at point.
9463 Functions in this hook must return t if they identify and follow
9464 a link at point. If they don't find anything interesting at point,
9465 they must return nil.")
9467 (defun org-open-at-point (&optional arg reference-buffer)
9468 "Open link at or after point.
9469 If there is no link at point, this function will search forward up to
9470 the end of the current line.
9471 Normally, files will be opened by an appropriate application. If the
9472 optional prefix argument ARG is non-nil, Emacs will visit the file.
9473 With a double prefix argument, try to open outside of Emacs, in the
9474 application the system uses for this file type."
9475 (interactive "P")
9476 ;; if in a code block, then open the block's results
9477 (unless (call-interactively #'org-babel-open-src-block-result)
9478 (org-load-modules-maybe)
9479 (move-marker org-open-link-marker (point))
9480 (setq org-window-config-before-follow-link (current-window-configuration))
9481 (org-remove-occur-highlights nil nil t)
9482 (cond
9483 ((and (org-at-heading-p)
9484 (not (org-in-regexp
9489 (not (get-text-property (point) 'org-linked-text)))
9490 (or (org-offer-links-in-entry arg)
9491 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9492 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9493 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9494 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9495 (not (org-in-regexp org-bracket-link-regexp)))
9496 (org-footnote-action))
9497 (t
9498 (let (type path link line search (pos (point)))
9499 (catch 'match
9500 (save-excursion
9502 (when (org-in-regexp org-bracket-link-regexp 1)
9503 (setq link (org-extract-attributes
9504 (org-link-unescape (org-match-string-no-properties 1))))
9506 (setq link (replace-match " " t t link)))
9507 (setq link (org-link-expand-abbrev link))
9508 (cond
9509 ((or (file-name-absolute-p link)
9511 (setq type "file" path link))
9512 ((string-match org-link-re-with-space3 link)
9513 (setq type (match-string 1 link) path (match-string 2 link)))
9514 (t (setq type "thisfile" path link)))
9515 (throw 'match t)))
9517 (when (get-text-property (point) 'org-linked-text)
9518 (setq type "thisfile"
9519 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9520 (1+ (point)) (point))
9521 path (buffer-substring
9522 (or (previous-single-property-change pos 'org-linked-text)
9523 (point-min))
9524 (or (next-single-property-change pos 'org-linked-text)
9525 (point-max))))
9526 (throw 'match t))
9528 (save-excursion
9529 (when (or (org-in-regexp org-angle-link-re)
9530 (org-in-regexp org-plain-link-re))
9531 (setq type (match-string 1)
9532 path (org-link-unescape (match-string 2)))
9533 (throw 'match t)))
9534 (save-excursion
9536 (setq type "tags"
9537 path (match-string 1))
9538 (while (string-match ":" path)
9539 (setq path (replace-match "+" t t path)))
9540 (throw 'match t)))
9542 (setq type "tree-match"
9543 path (match-string 1))
9544 (throw 'match t)))
9545 (unless path
9546 (error "No link found"))
9548 ;; switch back to reference buffer
9549 ;; needed when if called in a temporary buffer through
9550 ;; org-open-link-from-string
9551 (with-current-buffer (or reference-buffer (current-buffer))
9553 ;; Remove any trailing spaces in path
9555 (setq path (replace-match "" t t path)))
9556 (if (and org-link-translation-function
9557 (fboundp org-link-translation-function))
9558 ;; Check if we need to translate the link
9559 (let ((tmp (funcall org-link-translation-function type path)))
9560 (setq type (car tmp) path (cdr tmp))))
9562 (cond
9564 ((assoc type org-link-protocols)
9565 (funcall (nth 1 (assoc type org-link-protocols)) path))
9567 ((equal type "mailto")
9568 (let ((cmd (car org-link-mailto-program))
9569 (args (cdr org-link-mailto-program)) args1
9570 (address path) (subject "") a)
9572 (setq address (match-string 1 path)
9573 subject (org-link-escape (match-string 2 path))))
9574 (while args
9575 (cond
9576 ((not (stringp (car args))) (push (pop args) args1))
9577 (t (setq a (pop args))
9578 (if (string-match "%a" a)
9579 (setq a (replace-match address t t a)))
9580 (if (string-match "%s" a)
9581 (setq a (replace-match subject t t a)))
9582 (push a args1))))
9583 (apply cmd (nreverse args1))))
9585 ((member type '("http" "https" "ftp" "news"))
9586 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9587 (org-link-escape
9588 path org-link-escape-chars-browser)
9589 path))))
9591 ((string= type "doi")
9592 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9593 (org-link-escape
9594 path org-link-escape-chars-browser)
9595 path))))
9597 ((member type '("message"))
9598 (browse-url (concat type ":" path)))
9600 ((string= type "tags")
9601 (org-tags-view arg path))
9603 ((string= type "tree-match")
9606 ((string= type "file")
9608 (setq line (string-to-number (match-string 1 path))
9609 path (substring path 0 (match-beginning 0)))
9611 (setq search (match-string 1 path)
9612 path (substring path 0 (match-beginning 0)))))
9613 (if (string-match "[*?{]" (file-name-nondirectory path))
9614 (dired path)
9615 (org-open-file path arg line search)))
9617 ((string= type "shell")
9618 (let ((cmd path))
9619 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9620 (string-match org-confirm-shell-link-not-regexp cmd))
9621 (not org-confirm-shell-link-function)
9622 (funcall org-confirm-shell-link-function
9624 (org-add-props cmd nil
9625 'face 'org-warning))))
9626 (progn
9627 (message "Executing %s" cmd)
9628 (shell-command cmd))
9629 (error "Abort"))))
9631 ((string= type "elisp")
9632 (let ((cmd path))
9633 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9634 (string-match org-confirm-elisp-link-not-regexp cmd))
9635 (not org-confirm-elisp-link-function)
9636 (funcall org-confirm-elisp-link-function
9638 (org-add-props cmd nil
9639 'face 'org-warning))))
9640 (message "%s => %s" cmd
9641 (if (equal (string-to-char cmd) ?\()
9642 (eval (read cmd))
9643 (call-interactively (read cmd))))
9644 (error "Abort"))))
9646 ((and (string= type "thisfile")
9647 (run-hook-with-args-until-success
9648 'org-open-link-functions path)))
9650 ((string= type "thisfile")
9651 (if arg
9652 (switch-to-buffer-other-window
9653 (org-get-buffer-for-internal-link (current-buffer)))
9654 (org-mark-ring-push))
9655 (let ((cmd `(org-link-search
9656 ,path
9657 ,(cond ((equal arg '(4)) ''occur)
9658 ((equal arg '(16)) ''org-occur)
9659 (t nil))
9660 ,pos)))
9661 (condition-case nil (let ((org-link-search-inhibit-query t))
9662 (eval cmd))
9663 (error (progn (widen) (eval cmd))))))
9665 (t
9666 (browse-url-at-point)))))))
9667 (move-marker org-open-link-marker nil)
9668 (run-hook-with-args 'org-follow-link-hook)))
9670 (defun org-offer-links-in-entry (&optional nth zero)
9671 "Offer links in the current entry and follow the selected link.
9672 If there is only one link, follow it immediately as well.
9673 If NTH is an integer, immediately pick the NTH link found.
9674 If ZERO is a string, check also this string for a link, and if
9675 there is one, offer it as link number zero."
9679 (cnt ?0)
9680 (in-emacs (if (integerp nth) nil nth))
9681 have-zero end links link c)
9682 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9683 (push (match-string 0 zero) links)
9684 (setq cnt (1- cnt) have-zero t))
9685 (save-excursion
9686 (org-back-to-heading t)
9687 (setq end (save-excursion (outline-next-heading) (point)))
9688 (while (re-search-forward re end t)
9689 (push (match-string 0) links))
9690 (setq links (org-uniquify (reverse links))))
9692 (cond
9693 ((null links)
9694 (message "No links"))
9695 ((equal (length links) 1)
9696 (setq link (list (car links))))
9697 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9698 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9699 (t ; we have to select a link
9700 (save-excursion
9701 (save-window-excursion
9702 (delete-other-windows)
9703 (with-output-to-temp-buffer "*Select Link*"
9704 (mapc (lambda (l)
9705 (if (not (string-match org-bracket-link-regexp l))
9707 (org-remove-angle-brackets l)))
9708 (if (match-end 3)
9710 (match-string 3 l) (match-string 1 l)))
9712 (match-string 1 l))))))
9713 links))
9714 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9715 (message "Select link to open, RET to open all:")
9716 (setq c (read-char-exclusive))
9717 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9718 (when (equal c ?q) (error "Abort"))
9719 (if (equal c ?\C-m)
9720 (setq link links)
9721 (setq nth (- c ?0))
9722 (if have-zero (setq nth (1+ nth)))
9723 (unless (and (integerp nth) (>= (length links) nth))
9724 (error "Invalid link selection"))
9725 (setq link (list (nth (1- nth) links))))))
9726 (if link
9727 (let ((buf (current-buffer)))
9728 (dolist (l link)
9729 (org-open-link-from-string l in-emacs buf))
9730 t)
9731 nil)))
9733 ;; Add special file links that specify the way of opening
9735 (org-add-link-type "file+sys" 'org-open-file-with-system)
9736 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9737 (defun org-open-file-with-system (path)
9738 "Open file at PATH using the system way of opening it."
9739 (org-open-file path 'system))
9740 (defun org-open-file-with-emacs (path)
9741 "Open file at PATH in Emacs."
9742 (org-open-file path 'emacs))
9743 (defun org-remove-file-link-modifiers ()
9744 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9745 (goto-char (point-min))
9747 (org-if-unprotected
9748 (replace-match "file:" t t))))
9749 (eval-after-load "org-exp"
9750 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9751 'org-remove-file-link-modifiers))
9753 ;;;; Time estimates
9755 (defun org-get-effort (&optional pom)
9756 "Get the effort estimate for the current entry."
9757 (org-entry-get pom org-effort-property))
9759 ;;; File search
9761 (defvar org-create-file-search-functions nil
9762 "List of functions to construct the right search string for a file link.
9763 These functions are called in turn with point at the location to
9764 which the link should point.
9766 A function in the hook should first test if it would like to
9767 handle this file type, for example by checking the `major-mode'
9768 or the file extension. If it decides not to handle this file, it
9769 should just return nil to give other functions a chance. If it
9770 does handle the file, it must return the search string to be used
9771 when following the link. The search string will be part of the
9772 file link, given after a double colon, and `org-open-at-point'
9773 will automatically search for it. If special measures must be
9774 taken to make the search successful, another function should be
9775 added to the companion hook `org-execute-file-search-functions',
9776 which see.
9778 A function in this hook may also use `setq' to set the variable
9779 `description' to provide a suggestion for the descriptive text to
9780 be used for this link when it gets inserted into an Org-mode
9783 (defvar org-execute-file-search-functions nil
9784 "List of functions to execute a file search triggered by a link.
9786 Functions added to this hook must accept a single argument, the
9787 search string that was part of the file link, the part after the
9788 double colon. The function must first check if it would like to
9789 handle this search, for example by checking the `major-mode' or
9790 the file extension. If it decides not to handle this search, it
9791 should just return nil to give other functions a chance. If it
9792 does handle the search, it must return a non-nil value to keep
9793 other functions from trying.
9795 Each function can access the current prefix argument through the
9796 variable `current-prefix-argument'. Note that a single prefix is
9797 used to force opening a link in Emacs, so it may be good to only
9798 use a numeric or double prefix to guide the search function.
9800 In case this is needed, a function in this hook can also restore
9801 the window configuration before `org-open-at-point' was called using:
9803 (set-window-configuration org-window-config-before-follow-link)")
9805 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9806 (defun org-link-search (s &optional type avoid-pos stealth)
9807 "Search for a link search option.
9808 If S is surrounded by forward slashes, it is interpreted as a
9809 regular expression. In org-mode files, this will create an `org-occur'
9810 sparse tree. In ordinary files, `occur' will be used to list matches.
9811 If the current buffer is in `dired-mode', grep will be used to search
9812 in all files. If AVOID-POS is given, ignore matches near that position.
9814 When optional argument STEALTH is non-nil, do not modify
9815 visibility around point, thus ignoring
9816 `org-show-hierarchy-above', `org-show-following-heading' and
9817 `org-show-siblings' variables."
9818 (let ((case-fold-search t)
9822 org-emphasis-alist)
9824 (pos (point))
9825 (pre nil) (post nil)
9826 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9827 (cond
9828 ;; First check if there are any special search functions
9829 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9830 ;; Now try the builtin stuff
9831 ((and (equal (string-to-char s0) ?#)
9832 (> (length s0) 1)
9833 (save-excursion
9834 (goto-char (point-min))
9835 (and
9836 (re-search-forward
9838 (setq type 'dedicated
9839 pos (match-beginning 0))))
9840 ;; There is an exact target for this
9841 (goto-char pos)
9842 (org-back-to-heading t)))
9843 ((save-excursion
9844 (goto-char (point-min))
9845 (and
9846 (re-search-forward
9847 (concat "<<" (regexp-quote s0) ">>") nil t)
9848 (setq type 'dedicated
9849 pos (match-beginning 0))))
9850 ;; There is an exact target for this
9851 (goto-char pos))
9853 (save-excursion
9854 (goto-char (point-min))
9855 (and
9856 (re-search-forward
9857 (concat "[^[]" (regexp-quote
9858 (format org-coderef-label-format
9859 (match-string 1 s0))))
9860 nil t)
9861 (setq type 'dedicated
9862 pos (1+ (match-beginning 0))))))
9863 ;; There is a coderef target for this
9864 (goto-char pos))
9866 ;; A regular expression
9867 (cond
9868 ((eq major-mode 'org-mode)
9869 (org-occur (match-string 1 s)))
9870 ;;((eq major-mode 'dired-mode)
9871 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9872 (t (org-do-occur (match-string 1 s)))))
9873 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9874 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9875 (goto-char (point-min))
9876 (cond
9877 ((let (case-fold-search)
9878 (re-search-forward (format org-complex-heading-regexp-format
9879 (regexp-quote s))
9880 nil t))
9881 ;; OK, found a match
9882 (setq type 'dedicated)
9883 (goto-char (match-beginning 0)))
9884 ((and (not org-link-search-inhibit-query)
9885 (eq org-link-search-must-match-exact-headline 'query-to-create)
9886 (y-or-n-p "No match - create this as a new heading? "))
9887 (goto-char (point-max))
9888 (or (bolp) (newline))
9890 (beginning-of-line 0))
9891 (t
9892 (goto-char pos)
9893 (error "No match"))))
9894 (t
9895 ;; A normal search string
9896 (when (equal (string-to-char s) ?*)
9897 ;; Anchor on headlines, post may include tags.
9900 s (substring s 1)))
9901 (remove-text-properties
9902 0 (length s)
9903 '(face nil mouse-face nil keymap nil fontified nil) s)
9904 ;; Make a series of regular expressions to find a match
9913 re4 (concat "[^a-zA-Z_]" re4_)
9915 re1 (concat pre re2 post)
9916 re3 (concat pre (if pre re4_ re4) post)
9917 re5 (concat pre ".*" re4)
9918 re2 (concat pre re2)
9919 re2a (concat pre (if pre re2a_ re2a))
9920 re4 (concat pre (if pre re4_ re4))
9924 ))
9925 (cond
9926 ((eq type 'org-occur) (org-occur reall))
9927 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9928 (t (goto-char (point-min))
9929 (setq type 'fuzzy)
9930 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9931 (org-search-not-self 1 re1 nil t)
9932 (org-search-not-self 1 re2 nil t)
9933 (org-search-not-self 1 re2a nil t)
9934 (org-search-not-self 1 re3 nil t)
9935 (org-search-not-self 1 re4 nil t)
9936 (org-search-not-self 1 re5 nil t)
9937 )
9938 (goto-char (match-beginning 1))
9939 (goto-char pos)
9940 (error "No match"))))))
9941 (and (eq major-mode 'org-mode)
9942 (not stealth)
9943 (org-show-context 'link-search))
9944 type))
9946 (defun org-search-not-self (group &rest args)
9947 "Execute `re-search-forward', but only accept matches that do not
9948 enclose the position of `org-open-link-marker'."
9949 (let ((m org-open-link-marker))
9950 (catch 'exit
9951 (while (apply 're-search-forward args)
9952 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9953 (goto-char (match-end group))
9954 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9955 (> (match-beginning 0) (marker-position m))
9956 (< (match-end 0) (marker-position m)))
9957 (save-match-data
9958 (or (not (org-in-regexp
9959 org-bracket-link-analytic-regexp 1))
9960 (not (match-end 4)) ; no description
9961 (and (<= (match-beginning 4) (point))
9962 (>= (match-end 4) (point))))))
9963 (throw 'exit (point))))))))
9965 (defun org-get-buffer-for-internal-link (buffer)
9966 "Return a buffer to be used for displaying the link target of internal links."
9967 (cond
9968 ((not org-display-internal-link-with-indirect-buffer)
9969 buffer)
9970 ((string-match "(Clone)$" (buffer-name buffer))
9971 (message "Buffer is already a clone, not making another one")
9972 ;; we also do not modify visibility in this case
9973 buffer)
9974 (t ; make a new indirect buffer for displaying the link
9975 (let* ((bn (buffer-name buffer))
9976 (ibn (concat bn "(Clone)"))
9977 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9978 (with-current-buffer ib (org-overview))
9979 ib))))
9981 (defun org-do-occur (regexp &optional cleanup)
9982 "Call the Emacs command `occur'.
9983 If CLEANUP is non-nil, remove the printout of the regular expression
9984 in the *Occur* buffer. This is useful if the regex is long and not useful
9985 to read."
9986 (occur regexp)
9987 (when cleanup
9988 (let ((cwin (selected-window)) win beg end)
9989 (when (setq win (get-buffer-window "*Occur*"))
9990 (select-window win))
9991 (goto-char (point-min))
9992 (when (re-search-forward "match[a-z]+" nil t)
9993 (setq beg (match-end 0))
9995 (setq end (1- (match-beginning 0)))))
9996 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9997 (goto-char (point-min))
9998 (select-window cwin))))
10000 ;;; The mark ring for links jumps
10002 (defvar org-mark-ring nil
10003 "Mark ring for positions before jumps in Org-mode.")
10004 (defvar org-mark-ring-last-goto nil
10005 "Last position in the mark ring used to go back.")
10006 ;; Fill and close the ring
10007 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10008 (loop for i from 1 to org-mark-ring-length do
10009 (push (make-marker) org-mark-ring))
10010 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10011 org-mark-ring)
10013 (defun org-mark-ring-push (&optional pos buffer)
10014 "Put the current position or POS into the mark ring and rotate it."
10015 (interactive)
10016 (setq pos (or pos (point)))
10017 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10018 (move-marker (car org-mark-ring)
10019 (or pos (point))
10020 (or buffer (current-buffer)))
10021 (message "%s"
10022 (substitute-command-keys
10025 (defun org-mark-ring-goto (&optional n)
10026 "Jump to the previous position in the mark ring.
10027 With prefix arg N, jump back that many stored positions. When
10028 called several times in succession, walk through the entire ring.
10029 Org-mode commands jumping to a different position in the current file,
10030 or to another Org-mode file, automatically push the old position
10031 onto the ring."
10032 (interactive "p")
10033 (let (p m)
10034 (if (eq last-command this-command)
10035 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10036 (setq p org-mark-ring))
10037 (setq org-mark-ring-last-goto p)
10038 (setq m (car p))
10039 (org-pop-to-buffer-same-window (marker-buffer m))
10040 (goto-char m)
10041 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10043 (defun org-remove-angle-brackets (s)
10044 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10045 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10046 s)
10047 (defun org-add-angle-brackets (s)
10048 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10049 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10050 s)
10051 (defun org-remove-double-quotes (s)
10054 s)
10056 ;;; Following specific links
10058 (defun org-follow-timestamp-link ()
10059 (cond
10060 ((org-at-date-range-p t)
10061 (let ((org-agenda-start-on-weekday)
10062 (t1 (match-string 1))
10063 (t2 (match-string 2)))
10064 (setq t1 (time-to-days (org-time-string-to-time t1))
10065 t2 (time-to-days (org-time-string-to-time t2)))
10066 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10067 ((org-at-timestamp-p t)
10068 (org-agenda-list nil (time-to-days (org-time-string-to-time
10069 (substring (match-string 1) 0 10)))
10070 1))
10071 (t (error "This should not happen"))))
10074 ;;; Following file links
10075 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10076 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10077 (declare-function mailcap-mime-info
10078 "mailcap" (string &optional request no-decode))
10079 (defvar org-wait nil)
10080 (defun org-open-file (path &optional in-emacs line search)
10081 "Open the file at PATH.
10082 First, this expands any special file name abbreviations. Then the
10083 configuration variable `org-file-apps' is checked if it contains an
10084 entry for this file type, and if yes, the corresponding command is launched.
10086 If no application is found, Emacs simply visits the file.
10088 With optional prefix argument IN-EMACS, Emacs will visit the file.
10090 prefix arg, Org tries to avoid opening in Emacs
10091 and to use an external application to visit the file.
10093 Optional LINE specifies a line to go to, optional SEARCH a string
10094 to search for. If LINE or SEARCH is given, the file will be
10095 opened in Emacs, unless an entry from org-file-apps that makes
10096 use of groups in a regexp matches.
10098 If you want to change the way frames are used when following a
10099 link, please customize `org-link-frame-setup'.
10101 If the file does not exist, an error is thrown."
10102 (let* ((file (if (equal path "")
10103 buffer-file-name
10104 (substitute-in-file-name (expand-file-name path))))
10105 (file-apps (append org-file-apps (org-default-apps)))
10106 (apps (org-remove-if
10107 'org-file-apps-entry-match-against-dlink-p file-apps))
10108 (apps-dlink (org-remove-if-not
10109 'org-file-apps-entry-match-against-dlink-p file-apps))
10110 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10111 (dirp (if remp nil (file-directory-p file)))
10112 (file (if (and dirp org-open-directory-means-index-dot-org)
10113 (concat (file-name-as-directory file) "index.org")
10114 file))
10115 (a-m-a-p (assq 'auto-mode apps))
10116 (dfile (downcase file))
10117 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10118 (link (cond ((and (eq line nil)
10119 (eq search nil))
10120 file)
10121 (line
10122 (concat file "::" (number-to-string line)))
10123 (search
10124 (concat file "::" search))))
10125 (dlink (downcase link))
10126 (old-buffer (current-buffer))
10127 (old-pos (point))
10128 (old-mode major-mode)
10129 ext cmd link-match-data)
10131 (setq ext (match-string 1 dfile))
10133 (setq ext (match-string 1 dfile))))
10134 (cond
10135 ((member in-emacs '((16) system))
10136 (setq cmd (cdr (assoc 'system apps))))
10137 (in-emacs (setq cmd 'emacs))
10138 (t
10139 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10140 (and dirp (cdr (assoc 'directory apps)))
10141 ; first, try matching against apps-dlink
10142 ; if we get a match here, store the match data for later
10143 (let ((match (assoc-default dlink apps-dlink
10144 'string-match)))
10145 (if match
10146 (progn (setq link-match-data (match-data))
10147 match)
10148 (progn (setq in-emacs (or in-emacs line search))
10149 nil))) ; if we have no match in apps-dlink,
10150 ; always open the file in emacs if line or search
10151 ; is given (for backwards compatibility)
10152 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10153 'string-match)
10154 (cdr (assoc ext apps))
10155 (cdr (assoc t apps))))))
10156 (when (eq cmd 'system)
10157 (setq cmd (cdr (assoc 'system apps))))
10158 (when (eq cmd 'default)
10159 (setq cmd (cdr (assoc t apps))))
10160 (when (eq cmd 'mailcap)
10161 (require 'mailcap)
10162 (mailcap-parse-mailcaps)
10163 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10164 (command (mailcap-mime-info mime-type)))
10165 (if (stringp command)
10166 (setq cmd command)
10167 (setq cmd 'emacs))))
10168 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10169 (not (file-exists-p file))
10170 (not org-open-non-existing-files))
10171 (error "No such file: %s" file))
10172 (cond
10174 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10176 (setq cmd (replace-match "%s" t t cmd)))
10177 (while (string-match "%s" cmd)
10178 (setq cmd (replace-match
10179 (save-match-data
10180 (shell-quote-argument
10181 (convert-standard-filename file)))
10182 t t cmd)))
10184 ;; Replace "%1", "%2" etc. in command with group matches from regex
10185 (save-match-data
10186 (let ((match-index 1)
10187 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10188 (set-match-data link-match-data)
10189 (while (<= match-index number-of-groups)
10190 (let ((regex (concat "%" (number-to-string match-index)))
10191 (replace-with (match-string match-index dlink)))
10192 (while (string-match regex cmd)
10193 (setq cmd (replace-match replace-with t t cmd))))
10194 (setq match-index (+ match-index 1)))))
10196 (save-window-excursion
10197 (start-process-shell-command cmd nil cmd)
10198 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10199 ))
10200 ((or (stringp cmd)
10201 (eq cmd 'emacs))
10202 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10203 (widen)
10204 (if line (org-goto-line line)
10205 (if search (org-link-search search))))
10206 ((consp cmd)
10207 (let ((file (convert-standard-filename file)))
10208 (save-match-data
10209 (set-match-data link-match-data)
10210 (eval cmd))))
10211 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10212 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10213 (or (not (equal old-buffer (current-buffer)))
10214 (not (equal old-pos (point))))
10215 (org-mark-ring-push old-pos old-buffer))))
10217 (defun org-file-apps-entry-match-against-dlink-p (entry)
10218 "This function returns non-nil if `entry' uses a regular
10219 expression which should be matched against the whole link by
10220 org-open-file.
10222 It assumes that is the case when the entry uses a regular
10223 expression which has at least one grouping construct and the
10224 action is either a lisp form or a command string containing
10225 '%1', i.e. using at least one subexpression match as a
10226 parameter."
10227 (let ((selector (car entry))
10228 (action (cdr entry)))
10229 (if (stringp selector)
10230 (and (> (regexp-opt-depth selector) 0)
10231 (or (and (stringp action)
10232 (string-match "%[0-9]" action))
10233 (consp action)))
10234 nil)))
10236 (defun org-default-apps ()
10237 "Return the default applications for this operating system."
10238 (cond
10239 ((eq system-type 'darwin)
10240 org-file-apps-defaults-macosx)
10241 ((eq system-type 'windows-nt)
10242 org-file-apps-defaults-windowsnt)
10243 (t org-file-apps-defaults-gnu)))
10245 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10246 "Convert extensions to regular expressions in the cars of LIST.
10247 Also, weed out any non-string entries, because the return value is used
10248 only for regexp matching.
10249 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10250 point to the symbol `emacs', indicating that the file should
10251 be opened in Emacs."
10252 (append
10253 (delq nil
10254 (mapcar (lambda (x)
10255 (if (not (stringp (car x)))
10256 nil
10258 x
10260 list))
10261 (if add-auto-mode
10262 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10264 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10265 (defun org-file-remote-p (file)
10266 "Test whether FILE specifies a location on a remote system.
10267 Return non-nil if the location is indeed remote.
10271 (cond ((fboundp 'file-remote-p)
10272 (file-remote-p file))
10273 ((fboundp 'tramp-handle-file-remote-p)
10274 (tramp-handle-file-remote-p file))
10275 ((and (boundp 'ange-ftp-name-format)
10276 (string-match (car ange-ftp-name-format) file))
10277 t)
10278 (t nil)))
10281 ;;;; Refiling
10283 (defun org-get-org-file ()
10284 "Read a filename, with default directory `org-directory'."
10285 (let ((default (or org-default-notes-file remember-data-file)))
10286 (read-file-name (format "File name [%s]: " default)
10287 (file-name-as-directory org-directory)
10288 default)))
10290 (defun org-notes-order-reversed-p ()
10291 "Check if the current file should receive notes in reversed order."
10292 (cond
10293 ((not org-reverse-note-order) nil)
10294 ((eq t org-reverse-note-order) t)
10295 ((not (listp org-reverse-note-order)) nil)
10296 (t (catch 'exit
10297 (let ((all org-reverse-note-order)
10298 entry)
10299 (while (setq entry (pop all))
10300 (if (string-match (car entry) buffer-file-name)
10301 (throw 'exit (cdr entry))))
10302 nil)))))
10304 (defvar org-refile-target-table nil
10305 "The list of refile targets, created by `org-refile'.")
10307 (defvar org-agenda-new-buffers nil
10308 "Buffers created to visit agenda files.")
10310 (defvar org-refile-cache nil
10311 "Cache for refile targets.")
10313 (defvar org-refile-markers nil
10314 "All the markers used for caching refile locations.")
10316 (defun org-refile-marker (pos)
10317 "Get a new refile marker, but only if caching is in use."
10318 (if (not org-refile-use-cache)
10319 pos
10320 (let ((m (make-marker)))
10321 (move-marker m pos)
10322 (push m org-refile-markers)
10323 m)))
10325 (defun org-refile-cache-clear ()
10326 "Clear the refile cache and disable all the markers."
10327 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10328 (setq org-refile-markers nil)
10329 (setq org-refile-cache nil)
10330 (message "Refile cache has been cleared"))
10332 (defun org-refile-cache-check-set (set)
10333 "Check if all the markers in the cache still have live buffers."
10334 (let (marker)
10335 (catch 'exit
10336 (while (and set (setq marker (nth 3 (pop set))))
10337 ;; if org-refile-use-outline-path is 'file, marker may be nil
10338 (when (and marker (null (marker-buffer marker)))
10339 (message "not found") (sit-for 3)
10340 (throw 'exit nil)))
10341 t)))
10343 (defun org-refile-cache-put (set &rest identifiers)
10344 "Push the refile targets SET into the cache, under IDENTIFIERS."
10345 (let* ((key (sha1 (prin1-to-string identifiers)))
10346 (entry (assoc key org-refile-cache)))
10347 (if entry
10348 (setcdr entry set)
10349 (push (cons key set) org-refile-cache))))
10351 (defun org-refile-cache-get (&rest identifiers)
10352 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10353 (cond
10354 ((not org-refile-cache) nil)
10355 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10356 (t
10357 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10358 org-refile-cache))))
10359 (and set (org-refile-cache-check-set set) set)))))
10361 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10362 "Produce a table with refile targets."
10363 (let ((case-fold-search nil)
10364 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10365 (entries (or org-refile-targets '((nil . (:level . 1)))))
10366 targets tgs txt re files f desc descre fast-path-p level pos0)
10367 (message "Getting targets...")
10368 (with-current-buffer (or default-buffer (current-buffer))
10369 (while (setq entry (pop entries))
10370 (setq files (car entry) desc (cdr entry))
10371 (setq fast-path-p nil)
10372 (cond
10373 ((null files) (setq files (list (current-buffer))))
10374 ((eq files 'org-agenda-files)
10375 (setq files (org-agenda-files 'unrestricted)))
10376 ((and (symbolp files) (fboundp files))
10377 (setq files (funcall files)))
10378 ((and (symbolp files) (boundp files))
10379 (setq files (symbol-value files))))
10380 (if (stringp files) (setq files (list files)))
10381 (cond
10382 ((eq (car desc) :tag)
10384 ((eq (car desc) :todo)
10386 ((eq (car desc) :regexp)
10387 (setq descre (cdr desc)))
10388 ((eq (car desc) :level)
10390 (if org-odd-levels-only
10391 (1- (* 2 (cdr desc)))
10392 (cdr desc)))
10394 ((eq (car desc) :maxlevel)
10395 (setq fast-path-p t)
10397 (if org-odd-levels-only
10398 (1- (* 2 (cdr desc)))
10399 (cdr desc)))
10401 (t (error "Bad refiling target description %s" desc)))
10402 (while (setq f (pop files))
10403 (with-current-buffer
10404 (if (bufferp f) f (org-get-agenda-file-buffer f))
10405 (or
10406 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10407 (progn
10408 (if (bufferp f) (setq f (buffer-file-name
10409 (buffer-base-buffer f))))
10410 (setq f (and f (expand-file-name f)))
10411 (if (eq org-refile-use-outline-path 'file)
10412 (push (list (file-name-nondirectory f) f nil nil) tgs))
10413 (save-excursion
10414 (save-restriction
10415 (widen)
10416 (goto-char (point-min))
10417 (while (re-search-forward descre nil t)
10418 (goto-char (setq pos0 (point-at-bol)))
10419 (catch 'next
10420 (when org-refile-target-verify-function
10421 (save-match-data
10422 (or (funcall org-refile-target-verify-function)
10423 (throw 'next t))))
10424 (when (and (looking-at org-complex-heading-regexp)
10425 (not (member (match-string 4) excluded-entries))
10426 (match-string 4))
10427 (setq level (org-reduced-level
10428 (- (match-end 1) (match-beginning 1)))
10429 txt (org-link-display-format (match-string 4))
10431 re (format org-complex-heading-regexp-format
10432 (regexp-quote (match-string 4))))
10433 (when org-refile-use-outline-path
10434 (setq txt (mapconcat
10435 'org-protect-slash
10436 (append
10437 (if (eq org-refile-use-outline-path
10438 'file)
10439 (list (file-name-nondirectory
10440 (buffer-file-name
10441 (buffer-base-buffer))))
10442 (if (eq org-refile-use-outline-path
10443 'full-file-path)
10444 (list (buffer-file-name
10445 (buffer-base-buffer)))))
10446 (org-get-outline-path fast-path-p
10447 level txt)
10448 (list txt))
10449 "/")))
10450 (push (list txt f re (org-refile-marker (point)))
10451 tgs)))
10452 (when (= (point) pos0)
10453 ;; verification function has not moved point
10454 (goto-char (point-at-eol))))))))
10455 (when org-refile-use-cache
10456 (org-refile-cache-put tgs (buffer-file-name) descre))
10457 (setq targets (append tgs targets))
10458 ))))
10459 (message "Getting targets...done")
10460 (nreverse targets)))
10462 (defun org-protect-slash (s)
10463 (while (string-match "/" s)
10465 s)
10467 (defvar org-olpa (make-vector 20 nil))
10469 (defun org-get-outline-path (&optional fastp level heading)
10470 "Return the outline path to the current entry, as a list.
10472 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10473 routine which makes outline path derivations for an entire file,
10474 avoiding backtracing. Refile target collection makes use of that."
10475 (if fastp
10476 (progn
10477 (if (> level 19)
10478 (error "Outline path failure, more than 19 levels"))
10479 (loop for i from level upto 19 do
10480 (aset org-olpa i nil))
10481 (prog1
10482 (delq nil (append org-olpa nil))
10483 (aset org-olpa level heading)))
10484 (let (rtn case-fold-search)
10485 (save-excursion
10486 (save-restriction
10487 (widen)
10488 (while (org-up-heading-safe)
10489 (when (looking-at org-complex-heading-regexp)
10490 (push (org-match-string-no-properties 4) rtn)))
10491 rtn)))))
10493 (defun org-format-outline-path (path &optional width prefix)
10494 "Format the outline path PATH for display.
10495 Width is the maximum number of characters that is available.
10496 Prefix is a prefix to be included in the returned string,
10497 such as the file name."
10498 (setq width (or width 79))
10499 (if prefix (setq width (- width (length prefix))))
10500 (if (not path)
10501 (or prefix "")
10502 (let* ((nsteps (length path))
10503 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10504 (maxwidth (if (<= total-width width)
10505 10000 ;; everything fits
10506 ;; we need to shorten the level headings
10507 (/ (- width nsteps) nsteps)))
10508 (org-odd-levels-only nil)
10509 (n 0)
10510 (total (1+ (length prefix))))
10511 (setq maxwidth (max maxwidth 10))
10512 (concat prefix
10513 (mapconcat
10514 (lambda (h)
10515 (setq n (1+ n))
10516 (if (and (= n nsteps) (< maxwidth 10000))
10517 (setq maxwidth (- total-width total)))
10518 (if (< (length h) maxwidth)
10519 (progn (setq total (+ total (length h) 1)) h)
10520 (setq h (substring h 0 (- maxwidth 2))
10521 total (+ total maxwidth 1))
10523 (setq h (substring h 0 (match-beginning 0))))
10524 (setq h (concat h "..")))
10525 (org-add-props h nil 'face
10526 (nth (% (1- n) org-n-level-faces)
10527 org-level-faces))
10528 h)
10529 path "/")))))
10531 (defun org-display-outline-path (&optional file current)
10532 "Display the current outline path in the echo area."
10533 (interactive "P")
10534 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10535 (case-fold-search nil)
10536 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10537 (if current (setq path (append path
10538 (save-excursion
10539 (org-back-to-heading t)
10540 (if (looking-at org-complex-heading-regexp)
10541 (list (match-string 4)))))))
10542 (message "%s"
10543 (org-format-outline-path
10544 path
10545 (1- (frame-width))
10546 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10548 (defvar org-refile-history nil
10549 "History for refiling operations.")
10551 (defvar org-after-refile-insert-hook nil
10552 "Hook run after `org-refile' has inserted its stuff at the new location.
10553 Note that this is still *before* the stuff will be removed from
10554 the *old* location.")
10556 (defvar org-capture-last-stored-marker)
10557 (defun org-refile (&optional goto default-buffer rfloc)
10558 "Move the entry or entries at point to another heading.
10559 The list of target headings is compiled using the information in
10560 `org-refile-targets', which see.
10562 At the target location, the entry is filed as a subitem of the target
10563 heading. Depending on `org-reverse-note-order', the new subitem will
10564 either be the first or the last subitem.
10566 If there is an active region, all entries in that region will be moved.
10567 However, the region must fulfill the requirement that the first heading
10568 is the first one sets the top-level of the moved text - at most siblings
10569 below it are allowed.
10571 With prefix arg GOTO, the command will only visit the target location
10572 and not actually move anything.
10575 go to the location where the last refiling operation has put the subtree.
10576 With a prefix argument of `2', refile to the running clock.
10578 RFLOC can be a refile location obtained in a different way.
10580 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10582 If you are using target caching (see `org-refile-use-cache'),
10583 You have to clear the target cache in order to find new targets.
10584 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10585 prefix argument (`C-u C-u C-u C-c C-w')."
10587 (interactive "P")
10588 (if (member goto '(0 (64)))
10589 (org-refile-cache-clear)
10590 (let* ((cbuf (current-buffer))
10591 (regionp (org-region-active-p))
10592 (region-start (and regionp (region-beginning)))
10593 (region-end (and regionp (region-end)))
10594 (region-length (and regionp (- region-end region-start)))
10595 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10596 pos it nbuf file re level reversed)
10597 (setq last-command nil)
10598 (when regionp
10599 (goto-char region-start)
10600 (or (bolp) (goto-char (point-at-bol)))
10601 (setq region-start (point))
10602 (unless (or (org-kill-is-subtree-p
10603 (buffer-substring region-start region-end))
10604 (prog1 org-refile-active-region-within-subtree
10605 (org-toggle-heading)))
10606 (error "The region is not a (sequence of) subtree(s)")))
10607 (if (equal goto '(16))
10608 (org-refile-goto-last-stored)
10609 (when (or
10610 (and (equal goto 2)
10611 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10612 (prog1
10613 (setq it (list (or org-clock-heading "running clock")
10614 (buffer-file-name
10615 (marker-buffer org-clock-hd-marker))
10616 ""
10617 (marker-position org-clock-hd-marker)))
10618 (setq goto nil)))
10619 (setq it (or rfloc
10620 (let (heading-text)
10621 (save-excursion
10622 (unless goto
10623 (org-back-to-heading t)
10624 (setq heading-text
10625 (nth 4 (org-heading-components))))
10626 (org-refile-get-location
10627 (cond (goto "Goto")
10628 (regionp "Refile region to")
10631 default-buffer
10632 org-refile-allow-creating-parent-nodes
10633 goto))))))
10634 (setq file (nth 1 it)
10635 re (nth 2 it)
10636 pos (nth 3 it))
10637 (if (and (not goto)
10638 pos
10639 (equal (buffer-file-name) file)
10640 (if regionp
10641 (and (>= pos region-start)
10642 (<= pos region-end))
10643 (and (>= pos (point))
10644 (< pos (save-excursion
10645 (org-end-of-subtree t t))))))
10646 (error "Cannot refile to position inside the tree or region"))
10648 (setq nbuf (or (find-buffer-visiting file)
10649 (find-file-noselect file)))
10650 (if goto
10651 (progn
10652 (org-pop-to-buffer-same-window nbuf)
10653 (goto-char pos)
10654 (org-show-context 'org-goto))
10655 (if regionp
10656 (progn
10657 (org-kill-new (buffer-substring region-start region-end))
10658 (org-save-markers-in-region region-start region-end))
10659 (org-copy-subtree 1 nil t))
10660 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10661 (find-file-noselect file)))
10662 (setq reversed (org-notes-order-reversed-p))
10663 (save-excursion
10664 (save-restriction
10665 (widen)
10666 (if pos
10667 (progn
10668 (goto-char pos)
10669 (looking-at org-outline-regexp)
10670 (setq level (org-get-valid-level (funcall outline-level) 1))
10671 (goto-char
10672 (if reversed
10673 (or (outline-next-heading) (point-max))
10674 (or (save-excursion (org-get-next-sibling))
10675 (org-end-of-subtree t t)
10676 (point-max)))))
10677 (setq level 1)
10678 (if (not reversed)
10679 (goto-char (point-max))
10680 (goto-char (point-min))
10681 (or (outline-next-heading) (goto-char (point-max)))))
10682 (if (not (bolp)) (newline))
10683 (org-paste-subtree level)
10684 (when org-log-refile
10685 (org-add-log-setup 'refile nil nil 'findpos
10686 org-log-refile)
10687 (unless (eq org-log-refile 'note)
10688 (save-excursion (org-add-log-note))))
10689 (and org-auto-align-tags (org-set-tags nil t))
10690 (bookmark-set "org-refile-last-stored")
10691 ;; If we are refiling for capture, make sure that the
10692 ;; last-capture pointers point here
10693 (when (org-bound-and-true-p org-refile-for-capture)
10694 (bookmark-set "org-capture-last-stored-marker")
10695 (move-marker org-capture-last-stored-marker (point)))
10696 (if (fboundp 'deactivate-mark) (deactivate-mark))
10697 (run-hooks 'org-after-refile-insert-hook))))
10698 (if regionp
10699 (delete-region (point) (+ (point) region-length))
10700 (org-cut-subtree))
10701 (when (featurep 'org-inlinetask)
10702 (org-inlinetask-remove-END-maybe))
10703 (setq org-markers-to-move nil)
10706 (defun org-refile-goto-last-stored ()
10707 "Go to the location where the last refile was stored."
10708 (interactive)
10709 (bookmark-jump "org-refile-last-stored")
10710 (message "This is the location of the last refile"))
10712 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10713 no-exclude)
10714 "Prompt the user for a refile location, using PROMPT.
10715 PROMPT should not be suffixed with a colon and a space, because
10716 this function appends the default value from
10717 `org-refile-history' automatically, if that is not empty.
10718 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10719 this is used for the GOTO interface."
10720 (let ((org-refile-targets org-refile-targets)
10721 (org-refile-use-outline-path org-refile-use-outline-path)
10722 excluded-entries)
10723 (when (and (eq major-mode 'org-mode)
10724 (not org-refile-use-cache)
10725 (not no-exclude))
10726 (org-map-tree
10727 (lambda()
10728 (setq excluded-entries
10729 (append excluded-entries (list (org-get-heading t t)))))))
10730 (setq org-refile-target-table
10731 (org-refile-get-targets default-buffer excluded-entries)))
10732 (unless org-refile-target-table
10733 (error "No refile targets"))
10734 (let* ((prompt (concat prompt
10735 (and (car org-refile-history)
10736 (concat " (default " (car org-refile-history) ")"))
10737 ": "))
10738 (cbuf (current-buffer))
10739 (partial-completion-mode nil)
10740 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10741 (cfunc (if (and org-refile-use-outline-path
10742 org-outline-path-complete-in-steps)
10743 'org-olpath-completing-read
10744 'org-icompleting-read))
10745 (extra (if org-refile-use-outline-path "/" ""))
10746 (filename (and cfn (expand-file-name cfn)))
10747 (tbl (mapcar
10748 (lambda (x)
10749 (if (and (not (member org-refile-use-outline-path
10750 '(file full-file-path)))
10751 (not (equal filename (nth 1 x))))
10752 (cons (concat (car x) extra " ("
10753 (file-name-nondirectory (nth 1 x)) ")")
10754 (cdr x))
10755 (cons (concat (car x) extra) (cdr x))))
10756 org-refile-target-table))
10757 (completion-ignore-case t)
10758 pa answ parent-target child parent old-hist)
10759 (setq old-hist org-refile-history)
10760 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10761 nil 'org-refile-history (car org-refile-history)))
10762 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10763 (org-refile-check-position pa)
10764 (if pa
10765 (progn
10766 (when (or (not org-refile-history)
10767 (not (eq old-hist org-refile-history))
10768 (not (equal (car pa) (car org-refile-history))))
10769 (setq org-refile-history
10770 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10771 org-refile-history
10772 (cdr org-refile-history))))
10773 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10774 (pop org-refile-history)))
10775 pa)
10777 (progn
10778 (setq parent (match-string 1 answ)
10779 child (match-string 2 answ))
10780 (setq parent-target (or (assoc parent tbl)
10781 (assoc (concat parent "/") tbl)))
10782 (when (and parent-target
10783 (or (eq new-nodes t)
10784 (and (eq new-nodes 'confirm)
10786 child)))))
10787 (org-refile-new-child parent-target child)))
10788 (error "Invalid target location")))))
10790 (defun org-refile-check-position (refile-pointer)
10791 "Check if the refile pointer matches the readline to which it points."
10792 (let* ((file (nth 1 refile-pointer))
10793 (re (nth 2 refile-pointer))
10794 (pos (nth 3 refile-pointer))
10795 buffer)
10796 (when (org-string-nw-p re)
10797 (setq buffer (if (markerp pos)
10798 (marker-buffer pos)
10799 (or (find-buffer-visiting file)
10800 (find-file-noselect file))))
10801 (with-current-buffer buffer
10802 (save-excursion
10803 (save-restriction
10804 (widen)
10805 (goto-char pos)
10806 (beginning-of-line 1)
10807 (unless (org-looking-at-p re)
10808 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10810 (defun org-refile-new-child (parent-target child)
10811 "Use refile target PARENT-TARGET to add new CHILD below it."
10812 (unless parent-target
10813 (error "Cannot find parent for new node"))
10814 (let ((file (nth 1 parent-target))
10815 (pos (nth 3 parent-target))
10816 level)
10817 (with-current-buffer (or (find-buffer-visiting file)
10818 (find-file-noselect file))
10819 (save-excursion
10820 (save-restriction
10821 (widen)
10822 (if pos
10823 (goto-char pos)
10824 (goto-char (point-max))
10825 (if (not (bolp)) (newline)))
10826 (when (looking-at org-outline-regexp)
10827 (setq level (funcall outline-level))
10828 (org-end-of-subtree t t))
10829 (org-back-over-empty-lines)
10831 (if pos (org-get-valid-level level 1) 1) ?*)
10833 (beginning-of-line 0)
10834 (list (concat (car parent-target) "/" child) file "" (point)))))))
10836 (defun org-olpath-completing-read (prompt collection &rest args)
10837 "Read an outline path like a file name."
10838 (let ((thetable collection)
10839 (org-completion-use-ido nil) ; does not work with ido.
10840 (org-completion-use-iswitchb nil)) ; or iswitchb
10841 (apply
10842 'org-icompleting-read prompt
10843 (lambda (string predicate &optional flag)
10844 (let (rtn r f (l (length string)))
10845 (cond
10846 ((eq flag nil)
10847 ;; try completion
10848 (try-completion string thetable))
10849 ((eq flag t)
10850 ;; all-completions
10851 (setq rtn (all-completions string thetable predicate))
10852 (mapcar
10853 (lambda (x)
10854 (setq r (substring x l))
10855 (if (string-match " ([^)]*)$" x)
10856 (setq f (match-string 0 x))
10857 (setq f ""))
10858 (if (string-match "/" r)
10859 (concat string (substring r 0 (match-end 0)) f)
10860 x))
10861 rtn))
10862 ((eq flag 'lambda)
10863 ;; exact match?
10864 (assoc string thetable)))
10865 ))
10866 args)))
10868 ;;;; Dynamic blocks
10870 (defun org-find-dblock (name)
10871 "Find the first dynamic block with name NAME in the buffer.
10872 If not found, stay at current position and return nil."
10873 (let (pos)
10874 (save-excursion
10875 (goto-char (point-min))
10877 nil t)
10878 (match-beginning 0))))
10879 (if pos (goto-char pos))
10880 pos))
10882 (defconst org-dblock-start-re
10884 "Matches the start line of a dynamic block, with parameters.")
10887 "Matches the end of a dynamic block.")
10889 (defun org-create-dblock (plist)
10890 "Create a dynamic block section, with parameters taken from PLIST.
10891 PLIST must contain a :name entry which is used as name of the block."
10893 (end-of-line 1)
10894 (newline))
10895 (let ((col (current-column))
10896 (name (plist-get plist :name)))
10897 (insert "#+BEGIN: " name)
10898 (while plist
10899 (if (eq (car plist) :name)
10900 (setq plist (cddr plist))
10901 (insert " " (prin1-to-string (pop plist)))))
10903 (beginning-of-line -2)))
10905 (defun org-prepare-dblock ()
10906 "Prepare dynamic block for refresh.
10907 This empties the block, puts the cursor at the insert position and returns
10908 the property list including an extra property :name with the block name."
10909 (unless (looking-at org-dblock-start-re)
10910 (error "Not at a dynamic block"))
10911 (let* ((begdel (1+ (match-end 0)))
10912 (name (org-no-properties (match-string 1)))
10913 (params (append (list :name name)
10914 (read (concat "(" (match-string 3) ")")))))
10915 (save-excursion
10916 (beginning-of-line 1)
10918 (setq params (plist-put params :indentation-column (current-column))))
10919 (unless (re-search-forward org-dblock-end-re nil t)
10920 (error "Dynamic block not terminated"))
10921 (setq params
10922 (append params
10923 (list :content (buffer-substring
10924 begdel (match-beginning 0)))))
10925 (delete-region begdel (match-beginning 0))
10926 (goto-char begdel)
10927 (open-line 1)
10928 params))
10930 (defun org-map-dblocks (&optional command)
10931 "Apply COMMAND to all dynamic blocks in the current buffer.
10932 If COMMAND is not given, use `org-update-dblock'."
10933 (let ((cmd (or command 'org-update-dblock)))
10934 (save-excursion
10935 (goto-char (point-min))
10936 (while (re-search-forward org-dblock-start-re nil t)
10937 (goto-char (match-beginning 0))
10938 (save-excursion
10939 (condition-case nil
10940 (funcall cmd)
10941 (error (message "Error during update of dynamic block"))))
10942 (unless (re-search-forward org-dblock-end-re nil t)
10943 (error "Dynamic block not terminated"))))))
10945 (defun org-dblock-update (&optional arg)
10946 "User command for updating dynamic blocks.
10947 Update the dynamic block at point. With prefix ARG, update all dynamic
10948 blocks in the buffer."
10949 (interactive "P")
10950 (if arg
10951 (org-update-all-dblocks)
10952 (or (looking-at org-dblock-start-re)
10953 (org-beginning-of-dblock))
10954 (org-update-dblock)))
10956 (defun org-update-dblock ()
10957 "Update the dynamic block at point.
10958 This means to empty the block, parse for parameters and then call
10959 the correct writing function."
10960 (interactive)
10961 (save-window-excursion
10962 (let* ((pos (point))
10963 (line (org-current-line))
10964 (params (org-prepare-dblock))
10965 (name (plist-get params :name))
10966 (indent (plist-get params :indentation-column))
10967 (cmd (intern (concat "org-dblock-write:" name))))
10968 (message "Updating dynamic block `%s' at line %d..." name line)
10969 (funcall cmd params)
10970 (message "Updating dynamic block `%s' at line %d...done" name line)
10971 (goto-char pos)
10972 (when (and indent (> indent 0))
10973 (setq indent (make-string indent ?\ ))
10974 (save-excursion
10975 (org-beginning-of-dblock)
10976 (forward-line 1)
10977 (while (not (looking-at org-dblock-end-re))
10978 (insert indent)
10979 (beginning-of-line 2))
10980 (when (looking-at org-dblock-end-re)
10982 (replace-match ""))
10983 (insert indent)))))))
10985 (defun org-beginning-of-dblock ()
10986 "Find the beginning of the dynamic block at point.
10987 Error if there is no such block at point."
10988 (let ((pos (point))
10989 beg)
10990 (end-of-line 1)
10991 (if (and (re-search-backward org-dblock-start-re nil t)
10992 (setq beg (match-beginning 0))
10993 (re-search-forward org-dblock-end-re nil t)
10994 (> (match-end 0) pos))
10995 (goto-char beg)
10996 (goto-char pos)
10997 (error "Not in a dynamic block"))))
10999 (defun org-update-all-dblocks ()
11000 "Update all dynamic blocks in the buffer.
11001 This function can be used in a hook."
11002 (interactive)
11003 (when (eq major-mode 'org-mode)
11004 (org-map-dblocks 'org-update-dblock)))
11007 ;;;; Completion
11009 (defconst org-additional-option-like-keywords
11010 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11011 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11012 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11013 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11014 "BEGIN:" "END:"
11015 "ORGTBL" "TBLFM:" "TBLNAME:"
11016 "BEGIN_EXAMPLE" "END_EXAMPLE"
11017 "BEGIN_QUOTE" "END_QUOTE"
11018 "BEGIN_VERSE" "END_VERSE"
11019 "BEGIN_CENTER" "END_CENTER"
11020 "BEGIN_SRC" "END_SRC"
11021 "BEGIN_RESULT" "END_RESULT"
11022 "NAME:" "RESULTS:"
11023 "HEADER:" "HEADERS:"
11024 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11025 "CAPTION:" "LABEL:"
11026 "SETUPFILE:"
11027 "INCLUDE:"
11028 "BIND:"
11029 "MACRO:"))
11031 (defcustom org-structure-template-alist
11032 '(
11045 ("L" "#+LaTeX: "
11049 ("H" "#+HTML: "
11052 ("A" "#+ASCII: ")
11053 ("i" "#+INDEX: ?"
11054 "#+INDEX: ?")
11055 ("I" "#+INCLUDE %file ?"
11057 )
11058 "Structure completion elements.
11059 This is a list of abbreviation keys and values. The value gets inserted
11060 if you type `<' followed by the key and then press the completion key,
11061 usually `M-TAB'. %file will be replaced by a file name after prompting
11062 for the file using completion. The cursor will be placed at the position
11063 of the `?` in the template.
11064 There are two templates for each key, the first uses the original Org syntax,
11065 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11066 the default when the /org-mtags.el/ module has been loaded. See also the
11067 variable `org-mtags-prefer-muse-templates'."
11068 :group 'org-completion
11069 :type '(repeat
11070 (string :tag "Key")
11071 (string :tag "Template")
11072 (string :tag "Muse Template")))
11074 (defun org-try-structure-completion ()
11075 "Try to complete a structure template before point.
11077 expands them."
11078 (let ((l (buffer-substring (point-at-bol) (point)))
11079 a)
11082 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11083 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11084 (match-beginning 1)) a)
11085 t)))
11087 (defun org-complete-expand-structure-template (start cell)
11088 "Expand a structure template."
11089 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11090 (rpl (nth (if musep 2 1) cell))
11091 (ind ""))
11092 (delete-region start (point))
11094 (cond
11095 ((bolp))
11097 (setq ind (buffer-substring (point-at-bol) (point))))
11098 (t (newline))))
11099 (setq start (point))
11100 (if (string-match "%file" rpl)
11101 (setq rpl (replace-match
11102 (concat
11104 (save-match-data
11105 (abbreviate-file-name (read-file-name "Include file: ")))
11107 t t rpl)))
11110 (insert rpl)
11113 ;;;; TODO, DEADLINE, Comments
11115 (defun org-toggle-comment ()
11116 "Change the COMMENT state of an entry."
11117 (interactive)
11118 (save-excursion
11119 (org-back-to-heading)
11120 (let (case-fold-search)
11121 (cond
11122 ((looking-at (format org-heading-keyword-regexp-format
11123 org-comment-string))
11124 (goto-char (match-end 1))
11125 (looking-at (concat " +" org-comment-string))
11126 (replace-match "" t t)
11127 (when (eolp) (insert " ")))
11128 ((looking-at org-outline-regexp)
11129 (goto-char (match-end 0))
11130 (insert org-comment-string " "))))))
11132 (defvar org-last-todo-state-is-todo nil
11133 "This is non-nil when the last TODO state change led to a TODO state.
11134 If the last change removed the TODO tag or switched to DONE, then
11135 this is nil.")
11137 (defvar org-setting-tags nil) ; dynamically skipped
11139 (defvar org-todo-setup-filter-hook nil
11140 "Hook for functions that pre-filter todo specs.
11141 Each function takes a todo spec and returns either nil or the spec
11142 transformed into canonical form." )
11144 (defvar org-todo-get-default-hook nil
11145 "Hook for functions that get a default item for todo.
11146 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11147 nil or a string to be used for the todo mark." )
11149 (defvar org-agenda-headline-snapshot-before-repeat)
11151 (defun org-current-effective-time ()
11152 "Return current time adjusted for `org-extend-today-until' variable"
11153 (let* ((ct (org-current-time))
11154 (dct (decode-time ct))
11155 (ct1
11156 (if (and org-use-effective-time
11157 (< (nth 2 dct) org-extend-today-until))
11158 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11159 ct)))
11160 ct1))
11162 (defun org-todo-yesterday (&optional arg)
11163 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11164 (interactive "P")
11165 (if (eq major-mode 'org-agenda-mode)
11166 (apply 'org-agenda-todo-yesterday arg)
11167 (let* ((hour (third (decode-time
11168 (org-current-time))))
11169 (org-extend-today-until (1+ hour)))
11170 (org-todo arg))))
11172 (defun org-todo (&optional arg)
11173 "Change the TODO state of an item.
11174 The state of an item is given by a keyword at the start of the heading,
11175 like
11176 *** TODO Write paper
11177 *** DONE Call mom
11179 The different keywords are specified in the variable `org-todo-keywords'.
11181 So for this example: when the item starts with TODO, it is changed to DONE.
11182 When it starts with DONE, the DONE is removed. And when neither TODO nor
11183 DONE are present, add TODO at the beginning of the heading.
11186 state.
11187 With numeric prefix arg, switch to that state.
11189 keywords (nextset).
11191 With a numeric prefix arg of 0, inhibit note taking for the change.
11193 For calling through lisp, arg is also interpreted in the following way:
11194 'none -> empty state
11196 'done -> switch to DONE
11197 'nextset -> switch to the next set of keywords
11198 'previousset -> switch to the previous set of keywords
11200 really is a member of `org-todo-keywords'."
11201 (interactive "P")
11202 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11203 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11204 'region-start-level 'region))
11205 org-loop-over-headlines-in-active-region)
11206 (org-map-entries
11207 `(org-todo ,arg)
11208 org-loop-over-headlines-in-active-region
11209 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11210 (if (equal arg '(16)) (setq arg 'nextset))
11211 (let ((org-blocker-hook org-blocker-hook)
11212 (case-fold-search nil))
11213 (when (equal arg '(64))
11214 (setq arg nil org-blocker-hook nil))
11215 (when (and org-blocker-hook
11216 (or org-inhibit-blocking
11217 (org-entry-get nil "NOBLOCKING")))
11218 (setq org-blocker-hook nil))
11219 (save-excursion
11220 (catch 'exit
11221 (org-back-to-heading t)
11222 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11225 (let* ((match-data (match-data))
11226 (startpos (point-at-bol))
11227 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11228 (org-log-done org-log-done)
11229 (org-log-repeat org-log-repeat)
11230 (org-todo-log-states org-todo-log-states)
11231 (org-inhibit-logging
11232 (if (equal arg 0)
11233 (progn (setq arg nil) 'note) org-inhibit-logging))
11234 (this (match-string 1))
11235 (hl-pos (match-beginning 0))
11236 (head (org-get-todo-sequence-head this))
11237 (ass (assoc head org-todo-kwd-alist))
11238 (interpret (nth 1 ass))
11239 (done-word (nth 3 ass))
11240 (final-done-word (nth 4 ass))
11241 (last-state (or this ""))
11242 (completion-ignore-case t)
11243 (member (member this org-todo-keywords-1))
11244 (tail (cdr member))
11245 (state (cond
11246 ((and org-todo-key-trigger
11247 (or (and (equal arg '(4))
11248 (eq org-use-fast-todo-selection 'prefix))
11249 (and (not arg) org-use-fast-todo-selection
11250 (not (eq org-use-fast-todo-selection
11251 'prefix)))))
11252 ;; Use fast selection
11253 (org-fast-todo-selection))
11254 ((and (equal arg '(4))
11255 (or (not org-use-fast-todo-selection)
11256 (not org-todo-key-trigger)))
11257 ;; Read a state with completion
11258 (org-icompleting-read
11259 "State: " (mapcar (lambda(x) (list x))
11260 org-todo-keywords-1)
11261 nil t))
11262 ((eq arg 'right)
11263 (if this
11264 (if tail (car tail) nil)
11265 (car org-todo-keywords-1)))
11266 ((eq arg 'left)
11267 (if (equal member org-todo-keywords-1)
11268 nil
11269 (if this
11270 (nth (- (length org-todo-keywords-1)
11271 (length tail) 2)
11272 org-todo-keywords-1)
11273 (org-last org-todo-keywords-1))))
11274 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11275 (setq arg nil))) ; hack to fall back to cycling
11276 (arg
11277 ;; user or caller requests a specific state
11278 (cond
11279 ((equal arg "") nil)
11280 ((eq arg 'none) nil)
11281 ((eq arg 'done) (or done-word (car org-done-keywords)))
11282 ((eq arg 'nextset)
11283 (or (car (cdr (member head org-todo-heads)))
11284 (car org-todo-heads)))
11285 ((eq arg 'previousset)
11286 (let ((org-todo-heads (reverse org-todo-heads)))
11287 (or (car (cdr (member head org-todo-heads)))
11288 (car org-todo-heads))))
11289 ((car (member arg org-todo-keywords-1)))
11290 ((stringp arg)
11291 (error "State `%s' not valid in this file" arg))
11292 ((nth (1- (prefix-numeric-value arg))
11293 org-todo-keywords-1))))
11294 ((null member) (or head (car org-todo-keywords-1)))
11295 ((equal this final-done-word) nil) ;; -> make empty
11296 ((null tail) nil) ;; -> first entry
11297 ((memq interpret '(type priority))
11298 (if (eq this-command last-command)
11299 (car tail)
11300 (if (> (length tail) 0)
11301 (or done-word (car org-done-keywords))
11302 nil)))
11303 (t
11304 (car tail))))
11305 (state (or
11306 (run-hook-with-args-until-success
11307 'org-todo-get-default-hook state last-state)
11308 state))
11309 (next (if state (concat " " state " ") " "))
11310 (change-plist (list :type 'todo-state-change :from this :to state
11311 :position startpos))
11312 dolog now-done-p)
11313 (when org-blocker-hook
11314 (setq org-last-todo-state-is-todo
11315 (not (member this org-done-keywords)))
11316 (unless (save-excursion
11317 (save-match-data
11318 (org-with-wide-buffer
11319 (run-hook-with-args-until-failure
11320 'org-blocker-hook change-plist))))
11321 (if (org-called-interactively-p 'interactive)
11322 (error "TODO state change from %s to %s blocked" this state)
11323 ;; fail silently
11324 (message "TODO state change from %s to %s blocked" this state)
11325 (throw 'exit nil))))
11326 (store-match-data match-data)
11327 (replace-match next t t)
11328 (unless (pos-visible-in-window-p hl-pos)
11329 (message "TODO state changed to %s" (org-trim next)))
11330 (unless head
11331 (setq head (org-get-todo-sequence-head state)
11332 ass (assoc head org-todo-kwd-alist)
11333 interpret (nth 1 ass)
11334 done-word (nth 3 ass)
11335 final-done-word (nth 4 ass)))
11336 (when (memq arg '(nextset previousset))
11337 (message "Keyword-Set %d/%d: %s"
11338 (- (length org-todo-sets) -1
11339 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11340 (length org-todo-sets)
11341 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11342 (setq org-last-todo-state-is-todo
11343 (not (member state org-done-keywords)))
11344 (setq now-done-p (and (member state org-done-keywords)
11345 (not (member this org-done-keywords))))
11346 (and logging (org-local-logging logging))
11347 (when (and (or org-todo-log-states org-log-done)
11348 (not (eq org-inhibit-logging t))
11349 (not (memq arg '(nextset previousset))))
11350 ;; we need to look at recording a time and note
11351 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11352 (nth 2 (assoc this org-todo-log-states))))
11353 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11354 (setq dolog 'time))
11355 (when (and state
11356 (member state org-not-done-keywords)
11357 (not (member this org-not-done-keywords)))
11358 ;; This is now a todo state and was not one before
11359 ;; If there was a CLOSED time stamp, get rid of it.
11360 (org-add-planning-info nil nil 'closed))
11361 (when (and now-done-p org-log-done)
11362 ;; It is now done, and it was not done before
11363 (org-add-planning-info 'closed (org-current-effective-time))
11364 (if (and (not dolog) (eq 'note org-log-done))
11365 (org-add-log-setup 'done state this 'findpos 'note)))
11366 (when (and state dolog)
11367 ;; This is a non-nil state, and we need to log it
11368 (org-add-log-setup 'state state this 'findpos dolog)))
11369 ;; Fixup tag positioning
11370 (org-todo-trigger-tag-changes state)
11371 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11372 (when org-provide-todo-statistics
11373 (org-update-parent-todo-statistics))
11374 (run-hooks 'org-after-todo-state-change-hook)
11375 (if (and arg (not (member state org-done-keywords)))
11376 (setq head (org-get-todo-sequence-head state)))
11377 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11378 ;; Do we need to trigger a repeat?
11379 (when now-done-p
11380 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11381 ;; This is for the agenda, take a snapshot of the headline.
11382 (save-match-data
11383 (setq org-agenda-headline-snapshot-before-repeat
11384 (org-get-heading))))
11385 (org-auto-repeat-maybe state))
11386 ;; Fixup cursor location if close to the keyword
11387 (if (and (outline-on-heading-p)
11388 (not (bolp))
11389 (save-excursion (beginning-of-line 1)
11390 (looking-at org-todo-line-regexp))
11391 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11392 (progn
11393 (goto-char (or (match-end 2) (match-end 1)))
11394 (and (looking-at " ") (just-one-space))))
11395 (when org-trigger-hook
11396 (save-excursion
11397 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11399 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11400 "Block turning an entry into a TODO, using the hierarchy.
11401 This checks whether the current task should be blocked from state
11402 changes. Such blocking occurs when:
11404 1. The task has children which are not all in a completed state.
11406 2. A task has a parent with the property :ORDERED:, and there
11407 are siblings prior to the current task with incomplete
11408 status.
11410 3. The parent of the task is blocked because it has siblings that should
11411 be done first, or is child of a block grandparent TODO entry."
11413 (if (not org-enforce-todo-dependencies)
11414 t ; if locally turned off don't block
11415 (catch 'dont-block
11416 ;; If this is not a todo state change, or if this entry is already DONE,
11417 ;; do not block
11418 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11419 (member (plist-get change-plist :from)
11420 (cons 'done org-done-keywords))
11421 (member (plist-get change-plist :to)
11422 (cons 'todo org-not-done-keywords))
11423 (not (plist-get change-plist :to)))
11424 (throw 'dont-block t))
11425 ;; If this task has children, and any are undone, it's blocked
11426 (save-excursion
11427 (org-back-to-heading t)
11428 (let ((this-level (funcall outline-level)))
11429 (outline-next-heading)
11430 (let ((child-level (funcall outline-level)))
11431 (while (and (not (eobp))
11432 (> child-level this-level))
11433 ;; this todo has children, check whether they are all
11434 ;; completed
11435 (if (and (not (org-entry-is-done-p))
11436 (org-entry-is-todo-p))
11437 (throw 'dont-block nil))
11438 (outline-next-heading)
11439 (setq child-level (funcall outline-level))))))
11440 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11441 ;; any previous siblings are undone, it's blocked
11442 (save-excursion
11443 (org-back-to-heading t)
11444 (let* ((pos (point))
11445 (parent-pos (and (org-up-heading-safe) (point))))
11446 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11447 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11448 (forward-line 1)
11449 (re-search-forward org-not-done-heading-regexp pos t))
11450 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11451 ;; Search further up the hierarchy, to see if an ancestor is blocked
11452 (while t
11453 (goto-char parent-pos)
11454 (if (not (looking-at org-not-done-heading-regexp))
11455 (throw 'dont-block t)) ; do not block, parent is not a TODO
11456 (setq pos (point))
11457 (setq parent-pos (and (org-up-heading-safe) (point)))
11458 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11459 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11460 (forward-line 1)
11461 (re-search-forward org-not-done-heading-regexp pos t))
11462 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11464 (defcustom org-track-ordered-property-with-tag nil
11465 "Should the ORDERED property also be shown as a tag?
11466 The ORDERED property decides if an entry should require subtasks to be
11467 completed in sequence. Since a property is not very visible, setting
11468 this option means that toggling the ORDERED property with the command
11469 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11470 not relevant for the behavior, but it makes things more visible.
11472 Note that toggling the tag with tags commands will not change the property
11473 and therefore not influence behavior!
11475 This can be t, meaning the tag ORDERED should be used, It can also be a
11476 string to select a different tag for this task."
11477 :group 'org-todo
11478 :type '(choice
11479 (const :tag "No tracking" nil)
11480 (const :tag "Track with ORDERED tag" t)
11481 (string :tag "Use other tag")))
11483 (defun org-toggle-ordered-property ()
11484 "Toggle the ORDERED property of the current entry.
11485 For better visibility, you can track the value of this property with a tag.
11486 See variable `org-track-ordered-property-with-tag'."
11487 (interactive)
11488 (let* ((t1 org-track-ordered-property-with-tag)
11489 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11490 (save-excursion
11491 (org-back-to-heading)
11492 (if (org-entry-get nil "ORDERED")
11493 (progn
11494 (org-delete-property "ORDERED")
11495 (and tag (org-toggle-tag tag 'off))
11496 (message "Subtasks can be completed in arbitrary order"))
11497 (org-entry-put nil "ORDERED" "t")
11498 (and tag (org-toggle-tag tag 'on))
11499 (message "Subtasks must be completed in sequence")))))
11501 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11502 (defun org-block-todo-from-checkboxes (change-plist)
11503 "Block turning an entry into a TODO, using checkboxes.
11504 This checks whether the current task should be blocked from state
11505 changes because there are unchecked boxes in this entry."
11506 (if (not org-enforce-todo-checkbox-dependencies)
11507 t ; if locally turned off don't block
11508 (catch 'dont-block
11509 ;; If this is not a todo state change, or if this entry is already DONE,
11510 ;; do not block
11511 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11512 (member (plist-get change-plist :from)
11513 (cons 'done org-done-keywords))
11514 (member (plist-get change-plist :to)
11515 (cons 'todo org-not-done-keywords))
11516 (not (plist-get change-plist :to)))
11517 (throw 'dont-block t))
11518 ;; If this task has checkboxes that are not checked, it's blocked
11519 (save-excursion
11520 (org-back-to-heading t)
11521 (let ((beg (point)) end)
11522 (outline-next-heading)
11523 (setq end (point))
11524 (goto-char beg)
11525 (if (org-list-search-forward
11526 (concat (org-item-beginning-re)
11529 end t)
11530 (progn
11531 (if (boundp 'org-blocked-by-checkboxes)
11532 (setq org-blocked-by-checkboxes t))
11533 (throw 'dont-block nil)))))
11534 t))) ; do not block
11536 (defun org-entry-blocked-p ()
11537 "Is the current entry blocked?"
11538 (if (org-entry-get nil "NOBLOCKING")
11539 nil ;; Never block this entry
11540 (not
11541 (run-hook-with-args-until-failure
11542 'org-blocker-hook
11543 (list :type 'todo-state-change
11544 :position (point)
11545 :from 'todo
11546 :to 'done)))))
11548 (defun org-update-statistics-cookies (all)
11549 "Update the statistics cookie, either from TODO or from checkboxes.
11550 This should be called with the cursor in a line with a statistics cookie."
11551 (interactive "P")
11552 (if all
11553 (progn
11554 (org-update-checkbox-count 'all)
11555 (org-map-entries 'org-update-parent-todo-statistics))
11556 (if (not (org-at-heading-p))
11557 (org-update-checkbox-count)
11558 (let ((pos (move-marker (make-marker) (point)))
11559 end l1 l2)
11560 (ignore-errors (org-back-to-heading t))
11561 (if (not (org-at-heading-p))
11562 (org-update-checkbox-count)
11563 (setq l1 (org-outline-level))
11564 (setq end (save-excursion
11565 (outline-next-heading)
11566 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11567 (point)))
11568 (if (and (save-excursion
11569 (re-search-forward
11571 (not (save-excursion (re-search-forward
11573 (org-update-checkbox-count)
11574 (if (and l2 (> l2 l1))
11575 (progn
11576 (goto-char end)
11577 (org-update-parent-todo-statistics))
11578 (goto-char pos)
11579 (beginning-of-line 1)
11580 (while (re-search-forward
11582 (point-at-eol) t)
11583 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11584 (goto-char pos)
11585 (move-marker pos nil)))))
11587 (defvar org-entry-property-inherited-from) ;; defined below
11588 (defun org-update-parent-todo-statistics ()
11589 "Update any statistics cookie in the parent of the current headline.
11590 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11591 the entire subtree and this will travel up the hierarchy and update
11592 statistics everywhere."
11593 (let* ((prop (save-excursion (org-up-heading-safe)
11594 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11595 (recursive (or (not org-hierarchical-todo-statistics)
11597 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11598 0))
11599 (first t)
11601 level ltoggle l1 new ndel
11602 (cnt-all 0) (cnt-done 0) is-percent kwd
11603 checkbox-beg ov ovs ove cookie-present)
11604 (catch 'exit
11605 (save-excursion
11606 (beginning-of-line 1)
11607 (setq ltoggle (funcall outline-level))
11608 ;; Three situations are to consider:
11610 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11611 ;; to the top-level ancestor on the headline;
11613 ;; 2. If parent has "recursive" property, repeat up to the
11614 ;; headline setting that property, taking inheritance into
11615 ;; account;
11617 ;; 3. Else, move up to direct parent and proceed only once.
11618 (while (and (setq level (org-up-heading-safe))
11619 (or recursive first)
11620 (>= (point) lim))
11621 (setq first nil cookie-present nil)
11622 (unless (and level
11623 (not (string-match
11625 (downcase (or (org-entry-get nil "COOKIE_DATA")
11626 "")))))
11627 (throw 'exit nil))
11628 (while (re-search-forward box-re (point-at-eol) t)
11629 (setq cnt-all 0 cnt-done 0 cookie-present t)
11630 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11631 (save-match-data
11632 (unless (outline-next-heading) (throw 'exit nil))
11633 (while (and (looking-at org-complex-heading-regexp)
11634 (> (setq l1 (length (match-string 1))) level))
11635 (setq kwd (and (or recursive (= l1 ltoggle))
11636 (match-string 2)))
11637 (if (or (eq org-provide-todo-statistics 'all-headlines)
11638 (and (listp org-provide-todo-statistics)
11639 (or (member kwd org-provide-todo-statistics)
11640 (member kwd org-done-keywords))))
11641 (setq cnt-all (1+ cnt-all))
11642 (if (eq org-provide-todo-statistics t)
11643 (and kwd (setq cnt-all (1+ cnt-all)))))
11644 (and (member kwd org-done-keywords)
11645 (setq cnt-done (1+ cnt-done)))
11646 (outline-next-heading)))
11647 (setq new
11648 (if is-percent
11649 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11650 (format "[%d/%d]" cnt-done cnt-all))
11651 ndel (- (match-end 0) checkbox-beg))
11652 ;; handle overlays when updating cookie from column view
11653 (when (setq ov (car (overlays-at checkbox-beg)))
11654 (setq ovs (overlay-start ov) ove (overlay-end ov))
11655 (delete-overlay ov))
11656 (goto-char checkbox-beg)
11657 (insert new)
11658 (delete-region (point) (+ (point) ndel))
11659 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11660 (when ov (move-overlay ov ovs ove)))
11661 (when cookie-present
11662 (run-hook-with-args 'org-after-todo-statistics-hook
11663 cnt-done (- cnt-all cnt-done))))))
11664 (run-hooks 'org-todo-statistics-hook)))
11666 (defvar org-after-todo-statistics-hook nil
11667 "Hook that is called after a TODO statistics cookie has been updated.
11668 Each function is called with two arguments: the number of not-done entries
11669 and the number of done entries.
11671 For example, the following function, when added to this hook, will switch
11672 an entry to DONE when all children are done, and back to TODO when new
11673 entries are set to a TODO status. Note that this hook is only called
11674 when there is a statistics cookie in the headline!
11676 (defun org-summary-todo (n-done n-not-done)
11678 (let (org-log-done org-log-states) ; turn off logging
11680 ")
11682 (defvar org-todo-statistics-hook nil
11683 "Hook that is run whenever Org thinks TODO statistics should be updated.
11684 This hook runs even if there is no statistics cookie present, in which case
11685 `org-after-todo-statistics-hook' would not run.")
11687 (defun org-todo-trigger-tag-changes (state)
11688 "Apply the changes defined in `org-todo-state-tags-triggers'."
11689 (let ((l org-todo-state-tags-triggers)
11690 changes)
11691 (when (or (not state) (equal state ""))
11692 (setq changes (append changes (cdr (assoc "" l)))))
11693 (when (and (stringp state) (> (length state) 0))
11694 (setq changes (append changes (cdr (assoc state l)))))
11695 (when (member state org-not-done-keywords)
11696 (setq changes (append changes (cdr (assoc 'todo l)))))
11697 (when (member state org-done-keywords)
11698 (setq changes (append changes (cdr (assoc 'done l)))))
11699 (dolist (c changes)
11700 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11702 (defun org-local-logging (value)
11703 "Get logging settings from a property VALUE."
11704 (let* (words w a)
11705 ;; directly set the variables, they are already local.
11706 (setq org-log-done nil
11707 org-log-repeat nil
11708 org-todo-log-states nil)
11709 (setq words (org-split-string value))
11710 (while (setq w (pop words))
11711 (cond
11712 ((setq a (assoc w org-startup-options))
11713 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11714 (set (nth 1 a) (nth 2 a))))
11715 ((setq a (org-extract-log-state-settings w))
11716 (and (member (car a) org-todo-keywords-1)
11717 (push a org-todo-log-states)))))))
11719 (defun org-get-todo-sequence-head (kwd)
11720 "Return the head of the TODO sequence to which KWD belongs.
11721 If KWD is not set, check if there is a text property remembering the
11722 right sequence."
11723 (let (p)
11724 (cond
11725 ((not kwd)
11726 (or (get-text-property (point-at-bol) 'org-todo-head)
11727 (progn
11728 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11729 nil (point-at-eol)))
11730 (get-text-property p 'org-todo-head))))
11731 ((not (member kwd org-todo-keywords-1))
11732 (car org-todo-keywords-1))
11733 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11735 (defun org-fast-todo-selection ()
11736 "Fast TODO keyword selection with single keys.
11737 Returns the new TODO keyword, or nil if no state change should occur."
11738 (let* ((fulltable org-todo-key-alist)
11739 (done-keywords org-done-keywords) ;; needed for the faces.
11740 (maxlen (apply 'max (mapcar
11741 (lambda (x)
11742 (if (stringp (car x)) (string-width (car x)) 0))
11743 fulltable)))
11744 (expert nil)
11745 (fwidth (+ maxlen 3 1 3))
11746 (ncol (/ (- (window-width) 4) fwidth))
11747 tg cnt e c tbl
11748 groups ingroup)
11749 (save-excursion
11750 (save-window-excursion
11751 (if expert
11752 (set-buffer (get-buffer-create " *Org todo*"))
11753 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11754 (erase-buffer)
11755 (org-set-local 'org-done-keywords done-keywords)
11756 (setq tbl fulltable cnt 0)
11757 (while (setq e (pop tbl))
11758 (cond
11759 ((equal e '(:startgroup))
11760 (push '() groups) (setq ingroup t)
11761 (when (not (= cnt 0))
11762 (setq cnt 0)
11764 (insert "{ "))
11765 ((equal e '(:endgroup))
11766 (setq ingroup nil cnt 0)
11768 ((equal e '(:newline))
11769 (when (not (= cnt 0))
11770 (setq cnt 0)
11772 (setq e (car tbl))
11773 (while (equal (car tbl) '(:newline))
11775 (setq tbl (cdr tbl)))))
11776 (t
11777 (setq tg (car e) c (cdr e))
11778 (if ingroup (push tg (car groups)))
11779 (setq tg (org-add-props tg nil 'face
11780 (org-get-todo-face tg)))
11781 (if (and (= cnt 0) (not ingroup)) (insert " "))
11782 (insert "[" c "] " tg (make-string
11783 (- fwidth 4 (length tg)) ?\ ))
11784 (when (= (setq cnt (1+ cnt)) ncol)
11786 (if ingroup (insert " "))
11787 (setq cnt 0)))))
11789 (goto-char (point-min))
11790 (if (not expert) (org-fit-window-to-buffer))
11791 (message "[a-z..]:Set [SPC]:clear")
11792 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11793 (cond
11794 ((or (= c ?\C-g)
11795 (and (= c ?q) (not (rassoc c fulltable))))
11796 (setq quit-flag t))
11797 ((= c ?\ ) nil)
11798 ((setq e (rassoc c fulltable) tg (car e))
11799 tg)
11800 (t (setq quit-flag t)))))))
11802 (defun org-entry-is-todo-p ()
11803 (member (org-get-todo-state) org-not-done-keywords))
11805 (defun org-entry-is-done-p ()
11806 (member (org-get-todo-state) org-done-keywords))
11808 (defun org-get-todo-state ()
11809 (save-excursion
11810 (org-back-to-heading t)
11811 (and (looking-at org-todo-line-regexp)
11812 (match-end 2)
11813 (match-string 2))))
11815 (defun org-at-date-range-p (&optional inactive-ok)
11816 "Is the cursor inside a date range?"
11817 (interactive)
11818 (save-excursion
11819 (catch 'exit
11820 (let ((pos (point)))
11822 (skip-chars-backward "<[")
11823 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11824 (>= (match-end 0) pos)
11825 (throw 'exit t))
11827 (skip-chars-backward "<[")
11828 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11829 (>= (match-end 0) pos)
11830 (throw 'exit t)))
11831 nil)))
11833 (defun org-get-repeat (&optional tagline)
11834 "Check if there is a deadline/schedule with repeater in this entry."
11835 (save-match-data
11836 (save-excursion
11837 (org-back-to-heading t)
11838 (and (re-search-forward (if tagline
11840 org-repeat-re)
11841 (org-entry-end-position) t)
11842 (match-string-no-properties 1)))))
11844 (defvar org-last-changed-timestamp)
11845 (defvar org-last-inserted-timestamp)
11846 (defvar org-log-post-message)
11847 (defvar org-log-note-purpose)
11848 (defvar org-log-note-how)
11849 (defvar org-log-note-extra)
11850 (defun org-auto-repeat-maybe (done-word)
11851 "Check if the current headline contains a repeated deadline/schedule.
11852 If yes, set TODO state back to what it was and change the base date
11853 of repeating deadline/scheduled time stamps to new date.
11854 This function is run automatically after each state change to a DONE state."
11855 ;; last-state is dynamically scoped into this function
11856 (let* ((repeat (org-get-repeat))
11857 (aa (assoc last-state org-todo-kwd-alist))
11858 (interpret (nth 1 aa))
11859 (head (nth 2 aa))
11860 (whata '(("d" . day) ("m" . month) ("y" . year)))
11861 (msg "Entry repeats: ")
11862 (org-log-done nil)
11863 (org-todo-log-states nil)
11864 re type n what ts time to-state)
11865 (when repeat
11866 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11867 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11868 org-todo-repeat-to-state))
11869 (unless (and to-state (member to-state org-todo-keywords-1))
11870 (setq to-state (if (eq interpret 'type) last-state head)))
11871 (org-todo to-state)
11872 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11873 (org-entry-put nil "LAST_REPEAT" (format-time-string
11874 (org-time-stamp-format t t))))
11875 (when org-log-repeat
11876 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11877 (memq 'org-add-log-note post-command-hook))
11878 ;; OK, we are already setup for some record
11879 (if (eq org-log-repeat 'note)
11880 ;; make sure we take a note, not only a time stamp
11881 (setq org-log-note-how 'note))
11882 ;; Set up for taking a record
11883 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11884 last-state
11885 'findpos org-log-repeat)))
11886 (org-back-to-heading t)
11887 (org-add-planning-info nil nil 'closed)
11891 (while (re-search-forward
11892 re (save-excursion (outline-next-heading) (point)) t)
11893 (setq type (if (match-end 1) org-scheduled-string
11894 (if (match-end 3) org-deadline-string "Plain:"))
11895 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11897 (setq n (string-to-number (match-string 2 ts))
11898 what (match-string 3 ts))
11899 (if (equal what "w") (setq n (* n 7) what "d"))
11900 ;; Preparation, see if we need to modify the start date for the change
11901 (when (match-end 1)
11902 (setq time (save-match-data (org-time-string-to-time ts)))
11903 (cond
11904 ((equal (match-string 1 ts) ".")
11905 ;; Shift starting date to today
11906 (org-timestamp-change
11907 (- (org-today) (time-to-days time))
11908 'day))
11909 ((equal (match-string 1 ts) "+")
11910 (let ((nshiftmax 10) (nshift 0))
11911 (while (or (= nshift 0)
11912 (<= (time-to-days time)
11913 (time-to-days (current-time))))
11914 (when (= (incf nshift) nshiftmax)
11915 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11916 (error "Abort")))
11917 (org-timestamp-change n (cdr (assoc what whata)))
11918 (org-at-timestamp-p t)
11919 (setq ts (match-string 1))
11920 (setq time (save-match-data (org-time-string-to-time ts)))))
11921 (org-timestamp-change (- n) (cdr (assoc what whata)))
11922 ;; rematch, so that we have everything in place for the real shift
11923 (org-at-timestamp-p t)
11924 (setq ts (match-string 1))
11926 (org-timestamp-change n (cdr (assoc what whata)))
11927 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11928 (setq org-log-post-message msg)
11929 (message "%s" msg))))
11931 (defun org-show-todo-tree (arg)
11932 "Make a compact tree which shows all headlines marked with TODO.
11933 The tree will show the lines where the regexp matches, and all higher
11934 headlines above the match.
11936 With a numeric prefix N, construct a sparse tree for the Nth element
11937 of `org-todo-keywords-1'."
11938 (interactive "P")
11939 (let ((case-fold-search nil)
11940 (kwd-re
11941 (cond ((null arg) org-not-done-regexp)
11942 ((equal arg '(4))
11943 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11944 (mapcar 'list org-todo-keywords-1))))
11948 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11949 (regexp-quote (nth (1- (prefix-numeric-value arg))
11950 org-todo-keywords-1)))
11951 (t (error "Invalid prefix argument: %s" arg)))))
11952 (message "%d TODO entries found"
11953 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11955 (defun org-deadline (&optional remove time)
11957 With argument REMOVE, remove any deadline from the item.
11958 With argument TIME, set the deadline at the corresponding date. TIME
11960 (interactive "P")
11961 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11962 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11963 'region-start-level 'region))
11964 org-loop-over-headlines-in-active-region)
11965 (org-map-entries
11966 `(org-deadline ',remove ,time)
11967 org-loop-over-headlines-in-active-region
11968 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11969 (let* ((old-date (org-entry-get nil "DEADLINE"))
11970 (repeater (and old-date
11971 (string-match
11973 old-date)
11974 (match-string 1 old-date))))
11975 (if remove
11976 (progn
11977 (when (and old-date org-log-redeadline)
11978 (org-add-log-setup 'deldeadline nil old-date 'findpos
11979 org-log-redeadline))
11980 (org-remove-timestamp-with-keyword org-deadline-string)
11981 (message "Item no longer has a deadline."))
11982 (org-add-planning-info 'deadline time 'closed)
11983 (when (and old-date org-log-redeadline
11984 (not (equal old-date
11985 (substring org-last-inserted-timestamp 1 -1))))
11986 (org-add-log-setup 'redeadline nil old-date 'findpos
11987 org-log-redeadline))
11988 (when repeater
11989 (save-excursion
11990 (org-back-to-heading t)
11991 (when (re-search-forward (concat org-deadline-string " "
11992 org-last-inserted-timestamp)
11993 (save-excursion
11994 (outline-next-heading) (point)) t)
11995 (goto-char (1- (match-end 0)))
11996 (insert " " repeater)
11997 (setq org-last-inserted-timestamp
11998 (concat (substring org-last-inserted-timestamp 0 -1)
11999 " " repeater
12000 (substring org-last-inserted-timestamp -1))))))
12001 (message "Deadline on %s" org-last-inserted-timestamp)))))
12003 (defun org-schedule (&optional remove time)
12004 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12005 With argument REMOVE, remove any scheduling date from the item.
12006 With argument TIME, scheduled at the corresponding date. TIME can
12008 (interactive "P")
12009 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12010 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12011 'region-start-level 'region))
12012 org-loop-over-headlines-in-active-region)
12013 (org-map-entries
12014 `(org-schedule ',remove ,time)
12015 org-loop-over-headlines-in-active-region
12016 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12017 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12018 (repeater (and old-date
12019 (string-match
12021 old-date)
12022 (match-string 1 old-date))))
12023 (if remove
12024 (progn
12025 (when (and old-date org-log-reschedule)
12026 (org-add-log-setup 'delschedule nil old-date 'findpos
12027 org-log-reschedule))
12028 (org-remove-timestamp-with-keyword org-scheduled-string)
12029 (message "Item is no longer scheduled."))
12030 (org-add-planning-info 'scheduled time 'closed)
12031 (when (and old-date org-log-reschedule
12032 (not (equal old-date
12033 (substring org-last-inserted-timestamp 1 -1))))
12034 (org-add-log-setup 'reschedule nil old-date 'findpos
12035 org-log-reschedule))
12036 (when repeater
12037 (save-excursion
12038 (org-back-to-heading t)
12039 (when (re-search-forward (concat org-scheduled-string " "
12040 org-last-inserted-timestamp)
12041 (save-excursion
12042 (outline-next-heading) (point)) t)
12043 (goto-char (1- (match-end 0)))
12044 (insert " " repeater)
12045 (setq org-last-inserted-timestamp
12046 (concat (substring org-last-inserted-timestamp 0 -1)
12047 " " repeater
12048 (substring org-last-inserted-timestamp -1))))))
12049 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12051 (defun org-get-scheduled-time (pom &optional inherit)
12052 "Get the scheduled time as a time tuple, of a format suitable
12053 for calling org-schedule with, or if there is no scheduling,
12054 returns nil."
12055 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12056 (when time
12057 (apply 'encode-time (org-parse-time-string time)))))
12059 (defun org-get-deadline-time (pom &optional inherit)
12060 "Get the deadline as a time tuple, of a format suitable for
12061 calling org-deadline with, or if there is no scheduling, returns
12062 nil."
12063 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12064 (when time
12065 (apply 'encode-time (org-parse-time-string time)))))
12067 (defun org-remove-timestamp-with-keyword (keyword)
12068 "Remove all time stamps with KEYWORD in the current entry."
12070 beg)
12071 (save-excursion
12072 (org-back-to-heading t)
12073 (setq beg (point))
12074 (outline-next-heading)
12075 (while (re-search-backward re beg t)
12076 (replace-match "")
12078 (equal (char-before) ?\ ))
12079 (backward-delete-char 1)
12081 (point-at-bol) (point-at-eol)))
12082 (delete-region (point-at-bol)
12083 (min (point-max) (1+ (point-at-eol))))))))))
12085 (defun org-add-planning-info (what &optional time &rest remove)
12086 "Insert new timestamp with keyword in the line directly after the headline.
12087 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12088 If non is given, the user is prompted for a date.
12089 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12090 be removed."
12091 (interactive)
12092 (let (org-time-was-given org-end-time-was-given ts
12093 end default-time default-input)
12095 (catch 'exit
12096 (when (and (memq what '(scheduled deadline))
12097 (or (not time)
12098 (and (stringp time)
12099 (string-match "^[-+]+[0-9]" time))))
12100 ;; Try to get a default date/time from existing timestamp
12101 (save-excursion
12102 (org-back-to-heading t)
12103 (setq end (save-excursion (outline-next-heading) (point)))
12104 (when (re-search-forward (if (eq what 'scheduled)
12105 org-scheduled-time-regexp
12106 org-deadline-time-regexp)
12107 end t)
12108 (setq ts (match-string 1)
12109 default-time
12110 (apply 'encode-time (org-parse-time-string ts))
12111 default-input (and ts (org-get-compact-tod ts))))))
12112 (when what
12113 (setq time
12114 (if (stringp time)
12115 ;; This is a string (relative or absolute), set proper date
12116 (apply 'encode-time
12117 (org-read-date-analyze
12118 time default-time (decode-time default-time)))
12119 ;; If necessary, get the time from the user
12120 (or time (org-read-date nil 'to-time nil nil
12121 default-time default-input)))))
12123 (when (and org-insert-labeled-timestamps-at-point
12124 (member what '(scheduled deadline)))
12125 (insert
12126 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12127 (org-insert-time-stamp time org-time-was-given
12128 nil nil nil (list org-end-time-was-given))
12129 (setq what nil))
12130 (save-excursion
12131 (save-restriction
12132 (let (col list elt ts buffer-invisibility-spec)
12133 (org-back-to-heading t)
12135 (goto-char (match-end 1))
12136 (setq col (current-column))
12137 (goto-char (match-end 0))
12139 (when (and (not what)
12140 (not (looking-at
12142 org-keyword-time-not-clock-regexp))))
12143 ;; Nothing to add, nothing to remove...... :-)
12144 (throw 'exit nil))
12145 (if (and (not (looking-at org-outline-regexp))
12148 (not (equal (match-string 1) org-clock-string)))
12149 (narrow-to-region (match-beginning 0) (match-end 0))
12151 (backward-char 1)
12152 (narrow-to-region (point) (point))
12153 (and org-adapt-indentation (org-indent-to-column col)))
12154 ;; Check if we have to remove something.
12155 (setq list (cons what remove))
12156 (while list
12157 (setq elt (pop list))
12158 (when (or (and (eq elt 'scheduled)
12159 (re-search-forward org-scheduled-time-regexp nil t))
12160 (and (eq elt 'deadline)
12161 (re-search-forward org-deadline-time-regexp nil t))
12162 (and (eq elt 'closed)
12163 (re-search-forward org-closed-time-regexp nil t)))
12164 (replace-match "")
12165 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12167 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12168 (when what
12169 (insert
12170 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12171 (cond ((eq what 'scheduled) org-scheduled-string)
12172 ((eq what 'deadline) org-deadline-string)
12173 ((eq what 'closed) org-closed-string))
12174 " ")
12175 (setq ts (org-insert-time-stamp
12176 time
12177 (or org-time-was-given
12178 (and (eq what 'closed) org-log-done-with-time))
12179 (eq what 'closed)
12180 nil nil (list org-end-time-was-given)))
12181 (insert
12182 (if (not (or (bolp) (eq (char-before) ?\ )
12183 (memq (char-after) '(32 10))
12184 (eobp))) " " ""))
12185 (end-of-line 1))
12186 (goto-char (point-min))
12187 (widen)
12190 (delete-region (1- (point)) (point-at-eol)))
12191 ts))))))
12193 (defvar org-log-note-marker (make-marker))
12194 (defvar org-log-note-purpose nil)
12195 (defvar org-log-note-state nil)
12196 (defvar org-log-note-previous-state nil)
12197 (defvar org-log-note-how nil)
12198 (defvar org-log-note-extra nil)
12199 (defvar org-log-note-window-configuration nil)
12200 (defvar org-log-note-return-to (make-marker))
12201 (defvar org-log-note-effective-time nil
12202 "Remembered current time so that dynamically scoped
12203 `org-extend-today-until' affects tha timestamps in state change
12204 log")
12206 (defvar org-log-post-message nil
12207 "Message to be displayed after a log note has been stored.
12208 The auto-repeater uses this.")
12210 (defun org-add-note ()
12211 "Add a note to the current entry.
12212 This is done in the same way as adding a state change note."
12213 (interactive)
12214 (org-add-log-setup 'note nil nil 'findpos nil))
12216 (defvar org-property-end-re)
12217 (defun org-add-log-setup (&optional purpose state prev-state
12218 findpos how extra)
12219 "Set up the post command hook to take a note.
12220 If this is about to TODO state change, the new state is expected in STATE.
12221 When FINDPOS is non-nil, find the correct position for the note in
12222 the current entry. If not, assume that it can be inserted at point.
12223 HOW is an indicator what kind of note should be created.
12224 EXTRA is additional text that will be inserted into the notes buffer."
12225 (let* ((org-log-into-drawer (org-log-into-drawer))
12226 (drawer (cond ((stringp org-log-into-drawer)
12227 org-log-into-drawer)
12228 (org-log-into-drawer "LOGBOOK")
12229 (t nil))))
12230 (save-restriction
12231 (save-excursion
12232 (when findpos
12233 (org-back-to-heading t)
12234 (narrow-to-region (point) (save-excursion
12235 (outline-next-heading) (point)))
12239 (goto-char (match-end 0))
12240 (cond
12241 (drawer
12243 nil t)
12244 (progn
12245 (goto-char (match-end 0))
12246 (or org-log-states-order-reversed
12247 (and (re-search-forward org-property-end-re nil t)
12248 (goto-char (1- (match-beginning 0))))))
12250 (beginning-of-line 0)
12251 (org-indent-line-function)
12252 (beginning-of-line 2)
12253 (org-indent-line-function)
12254 (end-of-line 0)))
12255 ((and org-log-state-notes-insert-after-drawers
12256 (save-excursion
12257 (forward-line) (looking-at org-drawer-regexp)))
12258 (forward-line)
12259 (while (looking-at org-drawer-regexp)
12260 (goto-char (match-end 0))
12261 (re-search-forward org-property-end-re (point-max) t)
12262 (forward-line))
12263 (forward-line -1)))
12264 (unless org-log-states-order-reversed
12266 (org-skip-over-state-notes)
12268 (move-marker org-log-note-marker (point))
12269 (setq org-log-note-purpose purpose
12270 org-log-note-state state
12271 org-log-note-previous-state prev-state
12272 org-log-note-how how
12273 org-log-note-extra extra
12274 org-log-note-effective-time (org-current-effective-time))
12275 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12277 (defun org-skip-over-state-notes ()
12278 "Skip past the list of State notes in an entry."
12280 (when (ignore-errors (goto-char (org-in-item-p)))
12281 (let* ((struct (org-list-struct))
12282 (prevs (org-list-prevs-alist struct)))
12284 (goto-char (or (org-list-get-next-item (point) struct prevs)
12285 (org-list-get-item-end (point) struct)))))))
12287 (defun org-add-log-note (&optional purpose)
12288 "Pop up a window for taking a note, and add this note later at point."
12289 (remove-hook 'post-command-hook 'org-add-log-note)
12290 (setq org-log-note-window-configuration (current-window-configuration))
12291 (delete-other-windows)
12292 (move-marker org-log-note-return-to (point))
12293 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12294 (goto-char org-log-note-marker)
12295 (org-switch-to-buffer-other-window "*Org Note*")
12296 (erase-buffer)
12297 (if (memq org-log-note-how '(time state))
12298 (let (current-prefix-arg) (org-store-log-note))
12299 (let ((org-inhibit-startup t)) (org-mode))
12300 (insert (format "# Insert note for %s.
12302 (cond
12303 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12304 ((eq org-log-note-purpose 'done) "closed todo item")
12305 ((eq org-log-note-purpose 'state)
12307 (or org-log-note-previous-state "")
12308 (or org-log-note-state "")))
12309 ((eq org-log-note-purpose 'reschedule)
12310 "rescheduling")
12311 ((eq org-log-note-purpose 'delschedule)
12312 "no longer scheduled")
12313 ((eq org-log-note-purpose 'redeadline)
12314 "changing deadline")
12315 ((eq org-log-note-purpose 'deldeadline)
12316 "removing deadline")
12317 ((eq org-log-note-purpose 'refile)
12318 "refiling")
12319 ((eq org-log-note-purpose 'note)
12320 "this entry")
12321 (t (error "This should not happen")))))
12322 (if org-log-note-extra (insert org-log-note-extra))
12323 (org-set-local 'org-finish-function 'org-store-log-note)
12324 (run-hooks 'org-log-buffer-setup-hook)))
12326 (defvar org-note-abort nil) ; dynamically scoped
12327 (defun org-store-log-note ()
12328 "Finish taking a log note, and insert it to where it belongs."
12329 (let ((txt (buffer-string))
12330 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12331 lines ind bul)
12332 (kill-buffer (current-buffer))
12334 (setq txt (replace-match "" t t txt)))
12336 (setq txt (replace-match "" t t txt)))
12339 (setq note
12340 (org-replace-escapes
12341 note
12342 (list (cons "%u" (user-login-name))
12343 (cons "%U" user-full-name)
12344 (cons "%t" (format-time-string
12345 (org-time-stamp-format 'long 'inactive)
12346 org-log-note-effective-time))
12347 (cons "%T" (format-time-string
12348 (org-time-stamp-format 'long nil)
12349 org-log-note-effective-time))
12350 (cons "%d" (format-time-string
12351 (org-time-stamp-format nil 'inactive)
12352 org-log-note-effective-time))
12353 (cons "%D" (format-time-string
12354 (org-time-stamp-format nil nil)
12355 org-log-note-effective-time))
12356 (cons "%s" (if org-log-note-state
12358 ""))
12359 (cons "%S" (if org-log-note-previous-state
12363 (push note lines))
12364 (when (or current-prefix-arg org-note-abort)
12365 (when org-log-into-drawer
12366 (org-remove-empty-drawer-at
12367 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12368 org-log-note-marker))
12369 (setq lines nil))
12370 (when lines
12371 (with-current-buffer (marker-buffer org-log-note-marker)
12372 (save-excursion
12373 (goto-char org-log-note-marker)
12374 (move-marker org-log-note-marker nil)
12375 (end-of-line 1)
12377 (setq ind (save-excursion
12378 (if (ignore-errors (goto-char (org-in-item-p)))
12379 (let ((struct (org-list-struct)))
12380 (org-list-get-ind
12381 (org-list-get-top-point struct) struct))
12383 (cond
12384 ((and (org-at-heading-p)
12385 org-adapt-indentation)
12386 (1+ (org-current-level)))
12387 ((org-at-heading-p) 0)
12388 (t (org-get-indentation))))))
12389 (setq bul (org-list-bullet-string "-"))
12390 (org-indent-line-to ind)
12391 (insert bul (pop lines))
12392 (let ((ind-body (+ (length bul) ind)))
12393 (while lines
12395 (org-indent-line-to ind-body)
12396 (insert (pop lines))))
12397 (message "Note stored")
12398 (org-back-to-heading t)
12399 (org-cycle-hide-drawers 'children)))))
12400 (set-window-configuration org-log-note-window-configuration)
12401 (with-current-buffer (marker-buffer org-log-note-return-to)
12402 (goto-char org-log-note-return-to))
12403 (move-marker org-log-note-return-to nil)
12404 (and org-log-post-message (message "%s" org-log-post-message)))
12406 (defun org-remove-empty-drawer-at (drawer pos)
12407 "Remove an empty drawer DRAWER at position POS.
12408 POS may also be a marker."
12409 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12410 (save-excursion
12411 (save-restriction
12412 (widen)
12413 (goto-char pos)
12414 (if (org-in-regexp
12416 (replace-match ""))))))
12418 (defun org-sparse-tree (&optional arg)
12419 "Create a sparse tree, prompt for the details.
12420 This command can create sparse trees. You first need to select the type
12421 of match used to create the tree:
12423 t Show all TODO entries.
12424 T Show entries with a specific TODO keyword.
12425 m Show entries selected by a tags/property match.
12426 p Enter a property name and its value (both with completion on existing
12427 names/values) and show entries with that property.
12428 r Show entries matching a regular expression (`/' can be used as well)
12429 d Show deadlines due within `org-deadline-warning-days'.
12430 b Show deadlines and scheduled items before a date.
12431 a Show deadlines and scheduled items after a date."
12432 (interactive "P")
12433 (let (ans kwd value)
12434 (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")
12435 (setq ans (read-char-exclusive))
12436 (cond
12437 ((equal ans ?d)
12438 (call-interactively 'org-check-deadlines))
12439 ((equal ans ?b)
12440 (call-interactively 'org-check-before-date))
12441 ((equal ans ?a)
12442 (call-interactively 'org-check-after-date))
12443 ((equal ans ?D)
12444 (call-interactively 'org-check-dates-range))
12445 ((equal ans ?t)
12446 (org-show-todo-tree nil))
12447 ((equal ans ?T)
12448 (org-show-todo-tree '(4)))
12449 ((member ans '(?T ?m))
12450 (call-interactively 'org-match-sparse-tree))
12451 ((member ans '(?p ?P))
12452 (setq kwd (org-icompleting-read "Property: "
12453 (mapcar 'list (org-buffer-property-keys))))
12454 (setq value (org-icompleting-read "Value: "
12455 (mapcar 'list (org-property-values kwd))))
12458 (org-match-sparse-tree arg (concat kwd "=" value)))
12459 ((member ans '(?r ?R ?/))
12460 (call-interactively 'org-occur))
12463 (defvar org-occur-highlights nil
12464 "List of overlays used for occur matches.")
12465 (make-variable-buffer-local 'org-occur-highlights)
12466 (defvar org-occur-parameters nil
12467 "Parameters of the active org-occur calls.
12468 This is a list, each call to org-occur pushes as cons cell,
12469 containing the regular expression and the callback, onto the list.
12470 The list can contain several entries if `org-occur' has been called
12471 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12472 will only contain one set of parameters. When the highlights are
12473 removed (for example with `C-c C-c', or with the next edit (depending
12474 on `org-remove-highlights-with-change'), this variable is emptied
12475 as well.")
12476 (make-variable-buffer-local 'org-occur-parameters)
12478 (defun org-occur (regexp &optional keep-previous callback)
12479 "Make a compact tree which shows all matches of REGEXP.
12480 The tree will show the lines where the regexp matches, and all higher
12481 headlines above the match. It will also show the heading after the match,
12482 to make sure editing the matching entry is easy.
12483 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12484 call to `org-occur' will be kept, to allow stacking of calls to this
12485 command.
12486 If CALLBACK is non-nil, it is a function which is called to confirm
12487 that the match should indeed be shown."
12489 (when (equal regexp "")
12490 (error "Regexp cannot be empty"))
12491 (unless keep-previous
12492 (org-remove-occur-highlights nil nil t))
12493 (push (cons regexp callback) org-occur-parameters)
12494 (let ((cnt 0))
12495 (save-excursion
12496 (goto-char (point-min))
12497 (if (or (not keep-previous) ; do not want to keep
12498 (not org-occur-highlights)) ; no previous matches
12499 ;; hide everything
12500 (org-overview))
12501 (while (re-search-forward regexp nil t)
12502 (when (or (not callback)
12503 (save-match-data (funcall callback)))
12504 (setq cnt (1+ cnt))
12505 (when org-highlight-sparse-tree-matches
12506 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12507 (org-show-context 'occur-tree))))
12508 (when org-remove-highlights-with-change
12509 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12510 nil 'local))
12511 (unless org-sparse-tree-open-archived-trees
12512 (org-hide-archived-subtrees (point-min) (point-max)))
12513 (run-hooks 'org-occur-hook)
12514 (if (org-called-interactively-p 'interactive)
12515 (message "%d match(es) for regexp %s" cnt regexp))
12516 cnt))
12518 (defun org-occur-next-match (&optional n reset)
12519 "Function for `next-error-function' to find sparse tree matches.
12520 N is the number of matches to move, when negative move backwards.
12521 RESET is entirely ignored - this function always goes back to the
12522 starting point when no match is found."
12523 (let* ((limit (if (< n 0) (point-min) (point-max)))
12524 (search-func (if (< n 0)
12525 'previous-single-char-property-change
12526 'next-single-char-property-change))
12527 (n (abs n))
12528 (pos (point))
12529 p1)
12530 (catch 'exit
12531 (while (setq p1 (funcall search-func (point) 'org-type))
12532 (when (equal p1 limit)
12533 (goto-char pos)
12534 (error "No more matches"))
12535 (when (equal (get-char-property p1 'org-type) 'org-occur)
12536 (setq n (1- n))
12537 (when (= n 0)
12538 (goto-char p1)
12539 (throw 'exit (point))))
12540 (goto-char p1))
12541 (goto-char p1)
12542 (error "No more matches"))))
12544 (defun org-show-context (&optional key)
12545 "Make sure point and context are visible.
12546 How much context is shown depends upon the variables
12547 `org-show-hierarchy-above', `org-show-following-heading',
12548 `org-show-entry-below' and `org-show-siblings'."
12549 (let ((heading-p (org-at-heading-p t))
12550 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12551 (following-p (org-get-alist-option org-show-following-heading key))
12552 (entry-p (org-get-alist-option org-show-entry-below key))
12553 (siblings-p (org-get-alist-option org-show-siblings key)))
12554 (catch 'exit
12555 ;; Show heading or entry text
12556 (if (and heading-p (not entry-p))
12557 (org-flag-heading nil) ; only show the heading
12558 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12559 (org-show-hidden-entry))) ; show entire entry
12560 (when following-p
12561 ;; Show next sibling, or heading below text
12562 (save-excursion
12563 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12564 (org-flag-heading nil))))
12565 (when siblings-p (org-show-siblings))
12566 (when hierarchy-p
12567 ;; show all higher headings, possibly with siblings
12568 (save-excursion
12569 (while (and (condition-case nil
12570 (progn (org-up-heading-all 1) t)
12571 (error nil))
12572 (not (bobp)))
12573 (org-flag-heading nil)
12574 (when siblings-p (org-show-siblings))))))))
12576 (defvar org-reveal-start-hook nil
12577 "Hook run before revealing a location.")
12579 (defun org-reveal (&optional siblings)
12580 "Show current entry, hierarchy above it, and the following headline.
12581 This can be used to show a consistent set of context around locations
12582 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12583 not t for the search context.
12585 With optional argument SIBLINGS, on each level of the hierarchy all
12586 siblings are shown. This repairs the tree structure to what it would
12587 look like when opened with hierarchical calls to `org-cycle'.
12589 go to the parent and show the
12590 entire tree."
12591 (interactive "P")
12592 (run-hooks 'org-reveal-start-hook)
12593 (let ((org-show-hierarchy-above t)
12594 (org-show-following-heading t)
12595 (org-show-siblings (if siblings t org-show-siblings)))
12596 (org-show-context nil))
12597 (when (equal siblings '(16))
12598 (save-excursion
12599 (when (org-up-heading-safe)
12600 (org-show-subtree)
12601 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12603 (defun org-highlight-new-match (beg end)
12604 "Highlight from BEG to END and mark the highlight is an occur headline."
12605 (let ((ov (make-overlay beg end)))
12606 (overlay-put ov 'face 'secondary-selection)
12607 (overlay-put ov 'org-type 'org-occur)
12608 (push ov org-occur-highlights)))
12610 (defun org-remove-occur-highlights (&optional beg end noremove)
12611 "Remove the occur highlights from the buffer.
12612 BEG and END are ignored. If NOREMOVE is nil, remove this function
12613 from the `before-change-functions' in the current buffer."
12614 (interactive)
12615 (unless org-inhibit-highlight-removal
12616 (mapc 'delete-overlay org-occur-highlights)
12617 (setq org-occur-highlights nil)
12618 (setq org-occur-parameters nil)
12619 (unless noremove
12620 (remove-hook 'before-change-functions
12621 'org-remove-occur-highlights 'local))))
12623 ;;;; Priorities
12626 "Regular expression matching the priority indicator.")
12628 (defvar org-remove-priority-next-time nil)
12630 (defun org-priority-up ()
12631 "Increase the priority of the current item."
12632 (interactive)
12633 (org-priority 'up))
12635 (defun org-priority-down ()
12636 "Decrease the priority of the current item."
12637 (interactive)
12638 (org-priority 'down))
12640 (defun org-priority (&optional action)
12641 "Change the priority of an item by ARG.
12642 ACTION can be `set', `up', `down', or a character."
12643 (interactive)
12644 (unless org-enable-priority-commands
12645 (error "Priority commands are disabled"))
12646 (setq action (or action 'set))
12647 (let (current new news have remove)
12648 (save-excursion
12649 (org-back-to-heading t)
12650 (if (looking-at org-priority-regexp)
12651 (setq current (string-to-char (match-string 2))
12652 have t))
12653 (cond
12654 ((eq action 'remove)
12655 (setq remove t new ?\ ))
12656 ((or (eq action 'set)
12657 (if (featurep 'xemacs) (characterp action) (integerp action)))
12658 (if (not (eq action 'set))
12659 (setq new action)
12660 (message "Priority %c-%c, SPC to remove: "
12661 org-highest-priority org-lowest-priority)
12662 (save-match-data
12663 (setq new (read-char-exclusive))))
12664 (if (and (= (upcase org-highest-priority) org-highest-priority)
12665 (= (upcase org-lowest-priority) org-lowest-priority))
12666 (setq new (upcase new)))
12667 (cond ((equal new ?\ ) (setq remove t))
12668 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12669 (error "Priority must be between `%c' and `%c'"
12670 org-highest-priority org-lowest-priority))))
12671 ((eq action 'up)
12672 (setq new (if have
12673 (1- current) ; normal cycling
12674 ;; last priority was empty
12675 (if (eq last-command this-command)
12676 org-lowest-priority ; wrap around empty to lowest
12677 ;; default
12678 (if org-priority-start-cycle-with-default
12679 org-default-priority
12680 (1- org-default-priority))))))
12681 ((eq action 'down)
12682 (setq new (if have
12683 (1+ current) ; normal cycling
12684 ;; last priority was empty
12685 (if (eq last-command this-command)
12686 org-highest-priority ; wrap around empty to highest
12687 ;; default
12688 (if org-priority-start-cycle-with-default
12689 org-default-priority
12690 (1+ org-default-priority))))))
12691 (t (error "Invalid action")))
12692 (if (or (< (upcase new) org-highest-priority)
12693 (> (upcase new) org-lowest-priority))
12694 (if (and (memq action '(up down))
12695 (not have) (not (eq last-command this-command)))
12696 ;; `new' is from default priority
12697 (error
12698 "The default can not be set, see `org-default-priority' why")
12699 ;; normal cycling: `new' is beyond highest/lowest priority
12700 ;; and is wrapped around to the empty priority
12701 (setq remove t)))
12702 (setq news (format "%c" new))
12703 (if have
12704 (if remove
12705 (replace-match "" t t nil 1)
12706 (replace-match news t t nil 2))
12707 (if remove
12708 (error "No priority cookie found in line")
12709 (let ((case-fold-search nil))
12710 (looking-at org-todo-line-regexp))
12711 (if (match-end 2)
12712 (progn
12713 (goto-char (match-end 2))
12714 (insert " [#" news "]"))
12715 (goto-char (match-beginning 3))
12716 (insert "[#" news "] "))))
12717 (org-preserve-lc (org-set-tags nil 'align)))
12718 (if remove
12719 (message "Priority removed")
12720 (message "Priority of current item set to %s" news))))
12722 (defun org-get-priority (s)
12723 "Find priority cookie and return priority."
12724 (if (functionp org-get-priority-function)
12725 (funcall org-get-priority-function)
12726 (save-match-data
12727 (if (not (string-match org-priority-regexp s))
12728 (* 1000 (- org-lowest-priority org-default-priority))
12729 (* 1000 (- org-lowest-priority
12730 (string-to-char (match-string 2 s))))))))
12732 ;;;; Tags
12734 (defvar org-agenda-archives-mode)
12735 (defvar org-map-continue-from nil
12736 "Position from where mapping should continue.
12737 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12739 (defvar org-scanner-tags nil
12740 "The current tag list while the tags scanner is running.")
12741 (defvar org-trust-scanner-tags nil
12742 "Should `org-get-tags-at' use the tags for the scanner.
12743 This is for internal dynamical scoping only.
12744 When this is non-nil, the function `org-get-tags-at' will return the value
12745 of `org-scanner-tags' instead of building the list by itself. This
12746 can lead to large speed-ups when the tags scanner is used in a file with
12747 many entries, and when the list of tags is retrieved, for example to
12748 obtain a list of properties. Building the tags list for each entry in such
12749 a file becomes an N^2 operation - but with this variable set, it scales
12750 as N.")
12752 (defun org-scan-tags (action matcher &optional todo-only start-level)
12753 "Scan headline tags with inheritance and produce output ACTION.
12755 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12756 or `agenda' to produce an entry list for an agenda view. It can also be
12757 a Lisp form or a function that should be called at each matched headline, in
12758 this case the return value is a list of all return values from these calls.
12760 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12761 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12762 only lines with a TODO keyword are included in the output.
12764 START-LEVEL can be a string with asterisks, reducing the scope to
12765 headlines matching this string."
12766 (require 'org-agenda)
12767 (let* ((re (concat "^"
12768 (if start-level
12769 ;; Get the correct level to match
12771 org-outline-regexp)
12774 (org-re
12776 (props (list 'face 'default
12777 'done-face 'org-agenda-done
12778 'undone-face 'default
12779 'mouse-face 'highlight
12780 'org-not-done-regexp org-not-done-regexp
12781 'org-todo-regexp org-todo-regexp
12782 'org-complex-heading-regexp org-complex-heading-regexp
12783 'help-echo
12784 (format "mouse-2 or RET jump to org file %s"
12785 (abbreviate-file-name
12786 (or (buffer-file-name (buffer-base-buffer))
12787 (buffer-name (buffer-base-buffer)))))))
12788 (case-fold-search nil)
12789 (org-map-continue-from nil)
12790 lspos tags
12791 (tags-alist (list (cons 0 org-file-tags)))
12792 (llast 0) rtn rtn1 level category i txt
12793 todo marker entry priority)
12794 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12795 (setq action (list 'lambda nil action)))
12796 (save-excursion
12797 (goto-char (point-min))
12798 (when (eq action 'sparse-tree)
12799 (org-overview)
12800 (org-remove-occur-highlights))
12801 (while (re-search-forward re nil t)
12802 (setq org-map-continue-from nil)
12803 (catch :skip
12804 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12805 tags (if (match-end 4) (org-match-string-no-properties 4)))
12806 (goto-char (setq lspos (match-beginning 0)))
12807 (setq level (org-reduced-level (funcall outline-level))
12808 category (org-get-category))
12809 (setq i llast llast level)
12810 ;; remove tag lists from same and sublevels
12811 (while (>= i level)
12812 (when (setq entry (assoc i tags-alist))
12813 (setq tags-alist (delete entry tags-alist)))
12814 (setq i (1- i)))
12815 ;; add the next tags
12816 (when tags
12817 (setq tags (org-split-string tags ":")
12818 tags-alist
12819 (cons (cons level tags) tags-alist)))
12820 ;; compile tags for current headline
12821 (setq tags-list
12822 (if org-use-tag-inheritance
12823 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12824 tags)
12825 org-scanner-tags tags-list)
12826 (when org-use-tag-inheritance
12827 (setcdr (car tags-alist)
12828 (mapcar (lambda (x)
12829 (setq x (copy-sequence x))
12830 (org-add-prop-inherited x))
12831 (cdar tags-alist))))
12832 (when (and tags org-use-tag-inheritance
12833 (or (not (eq t org-use-tag-inheritance))
12834 org-tags-exclude-from-inheritance))
12835 ;; selective inheritance, remove uninherited ones
12836 (setcdr (car tags-alist)
12837 (org-remove-uninherited-tags (cdar tags-alist))))
12838 (when (and
12840 ;; eval matcher only when the todo condition is OK
12841 (and (or (not todo-only) (member todo org-not-done-keywords))
12842 (let ((case-fold-search t)) (eval matcher)))
12844 ;; Call the skipper, but return t if it does not skip,
12845 ;; so that the `and' form continues evaluating
12846 (progn
12847 (unless (eq action 'sparse-tree) (org-agenda-skip))
12848 t)
12850 ;; Check if timestamps are deselecting this entry
12851 (or (not todo-only)
12852 (and (member todo org-not-done-keywords)
12853 (or (not org-agenda-tags-todo-honor-ignore-options)
12854 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12856 ;; Extra check for the archive tag
12857 ;; FIXME: Does the skipper already do this????
12858 (or
12859 (not (member org-archive-tag tags-list))
12860 ;; we have an archive tag, should we use this anyway?
12861 (or (not org-agenda-skip-archived-trees)
12862 (and (eq action 'agenda) org-agenda-archives-mode))))
12864 ;; select this headline
12866 (cond
12867 ((eq action 'sparse-tree)
12868 (and org-highlight-sparse-tree-matches
12869 (org-get-heading) (match-end 0)
12870 (org-highlight-new-match
12871 (match-beginning 0) (match-beginning 1)))
12872 (org-show-context 'tags-tree))
12873 ((eq action 'agenda)
12874 (setq txt (org-agenda-format-item
12875 ""
12876 (concat
12877 (if (eq org-tags-match-list-sublevels 'indented)
12878 (make-string (1- level) ?.) "")
12879 (org-get-heading))
12880 category
12881 tags-list)
12882 priority (org-get-priority txt))
12883 (goto-char lspos)
12884 (setq marker (org-agenda-new-marker))
12885 (org-add-props txt props
12886 'org-marker marker 'org-hd-marker marker 'org-category category
12887 'todo-state todo
12888 'priority priority 'type "tagsmatch")
12889 (push txt rtn))
12890 ((functionp action)
12891 (setq org-map-continue-from nil)
12892 (save-excursion
12893 (setq rtn1 (funcall action))
12894 (push rtn1 rtn)))
12895 (t (error "Invalid action")))
12897 ;; if we are to skip sublevels, jump to end of subtree
12898 (unless org-tags-match-list-sublevels
12899 (org-end-of-subtree t)
12900 (backward-char 1))))
12901 ;; Get the correct position from where to continue
12902 (if org-map-continue-from
12903 (goto-char org-map-continue-from)
12904 (and (= (point) lspos) (end-of-line 1)))))
12905 (when (and (eq action 'sparse-tree)
12906 (not org-sparse-tree-open-archived-trees))
12907 (org-hide-archived-subtrees (point-min) (point-max)))
12908 (nreverse rtn)))
12910 (defun org-remove-uninherited-tags (tags)
12911 "Remove all tags that are not inherited from the list TAGS."
12912 (cond
12913 ((eq org-use-tag-inheritance t)
12914 (if org-tags-exclude-from-inheritance
12915 (org-delete-all org-tags-exclude-from-inheritance tags)
12916 tags))
12917 ((not org-use-tag-inheritance) nil)
12918 ((stringp org-use-tag-inheritance)
12919 (delq nil (mapcar
12920 (lambda (x)
12921 (if (and (string-match org-use-tag-inheritance x)
12922 (not (member x org-tags-exclude-from-inheritance)))
12923 x nil))
12924 tags)))
12925 ((listp org-use-tag-inheritance)
12926 (delq nil (mapcar
12927 (lambda (x)
12928 (if (member x org-use-tag-inheritance) x nil))
12929 tags)))))
12931 (defvar todo-only) ;; dynamically scoped
12933 (defun org-match-sparse-tree (&optional todo-only match)
12934 "Create a sparse tree according to tags string MATCH.
12935 MATCH can contain positive and negative selection of tags, like
12937 If optional argument TODO-ONLY is non-nil, only select lines that are
12938 also TODO lines."
12939 (interactive "P")
12940 (org-prepare-agenda-buffers (list (current-buffer)))
12941 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12943 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12945 (defvar org-cached-props nil)
12946 (defun org-cached-entry-get (pom property)
12947 (if (or (eq t org-use-property-inheritance)
12948 (and (stringp org-use-property-inheritance)
12949 (string-match org-use-property-inheritance property))
12950 (and (listp org-use-property-inheritance)
12951 (member property org-use-property-inheritance)))
12952 ;; Caching is not possible, check it directly
12953 (org-entry-get pom property 'inherit)
12954 ;; Get all properties, so that we can do complicated checks easily
12955 (cdr (assoc property (or org-cached-props
12956 (setq org-cached-props
12957 (org-entry-properties pom)))))))
12959 (defun org-global-tags-completion-table (&optional files)
12960 "Return the list of all tags in all agenda buffer/files.
12961 Optional FILES argument is a list of files to which can be used
12962 instead of the agenda files."
12963 (save-excursion
12964 (org-uniquify
12965 (delq nil
12966 (apply 'append
12967 (mapcar
12968 (lambda (file)
12969 (set-buffer (find-file-noselect file))
12970 (append (org-get-buffer-tags)
12971 (mapcar (lambda (x) (if (stringp (car-safe x))
12972 (list (car-safe x)) nil))
12973 org-tag-alist)))
12974 (if (and files (car files))
12975 files
12976 (org-agenda-files))))))))
12978 (defun org-make-tags-matcher (match)
12979 "Create the TAGS/TODO matcher form for the selection string MATCH."
12980 ;; todo-only is scoped dynamically into this function, and the function
12981 ;; may change it if the matcher asks for it.
12982 (unless match
12983 ;; Get a new match request, with completion
12984 (let ((org-last-tags-completion-table
12985 (org-global-tags-completion-table)))
12986 (setq match (org-completing-read-no-i
12987 "Match: " 'org-tags-completion-function nil nil nil
12988 'org-tags-history))))
12990 ;; Parse the string and create a lisp form
12991 (let ((match0 match)
12992 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12993 minus tag mm
12994 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12995 orterms term orlist re-p str-p level-p level-op time-p
12996 prop-p pn pv po gv rest)
12997 (if (string-match "/+" match)
12998 ;; match contains also a todo-matching request
12999 (progn
13000 (setq tagsmatch (substring match 0 (match-beginning 0))
13001 todomatch (substring match (match-end 0)))
13002 (if (string-match "^!" todomatch)
13003 (setq todo-only t todomatch (substring todomatch 1)))
13005 (setq todomatch nil)))
13006 ;; only matching tags
13007 (setq tagsmatch match todomatch nil))
13009 ;; Make the tags matcher
13011 (setq tagsmatcher t)
13012 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13013 (while (setq term (pop orterms))
13015 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13016 (while (string-match re term)
13017 (setq rest (substring term (match-end 0))
13018 minus (and (match-end 1)
13019 (equal (match-string 1 term) "-"))
13020 tag (save-match-data (replace-regexp-in-string
13022 (match-string 2 term)))
13023 re-p (equal (string-to-char tag) ?{)
13024 level-p (match-end 4)
13025 prop-p (match-end 5)
13026 mm (cond
13027 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13028 (level-p
13029 (setq level-op (org-op-to-function (match-string 3 term)))
13030 `(,level-op level ,(string-to-number
13031 (match-string 4 term))))
13032 (prop-p
13033 (setq pn (match-string 5 term)
13034 po (match-string 6 term)
13035 pv (match-string 7 term)
13036 re-p (equal (string-to-char pv) ?{)
13038 time-p (save-match-data
13040 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13041 (if time-p (setq pv (org-matcher-time pv)))
13042 (setq po (org-op-to-function po (if time-p 'time str-p)))
13043 (cond
13044 ((equal pn "CATEGORY")
13045 (setq gv '(get-text-property (point) 'org-category)))
13046 ((equal pn "TODO")
13047 (setq gv 'todo))
13048 (t
13049 (setq gv `(org-cached-entry-get nil ,pn))))
13050 (if re-p
13051 (if (eq po 'org<>)
13052 `(not (string-match ,pv (or ,gv "")))
13053 `(string-match ,pv (or ,gv "")))
13054 (if str-p
13055 `(,po (or ,gv "") ,pv)
13056 `(,po (string-to-number (or ,gv ""))
13057 ,(string-to-number pv) ))))
13058 (t `(member ,tag tags-list)))
13059 mm (if minus (list 'not mm) mm)
13060 term rest)
13061 (push mm tagsmatcher))
13062 (push (if (> (length tagsmatcher) 1)
13063 (cons 'and tagsmatcher)
13064 (car tagsmatcher))
13065 orlist)
13066 (setq tagsmatcher nil))
13067 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13068 (setq tagsmatcher
13069 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13070 ;; Make the todo matcher
13072 (setq todomatcher t)
13073 (setq orterms (org-split-string todomatch "|") orlist nil)
13074 (while (setq term (pop orterms))
13075 (while (string-match re term)
13076 (setq minus (and (match-end 1)
13077 (equal (match-string 1 term) "-"))
13078 kwd (match-string 2 term)
13079 re-p (equal (string-to-char kwd) ?{)
13080 term (substring term (match-end 0))
13081 mm (if re-p
13082 `(string-match ,(substring kwd 1 -1) todo)
13083 (list 'equal 'todo kwd))
13084 mm (if minus (list 'not mm) mm))
13085 (push mm todomatcher))
13086 (push (if (> (length todomatcher) 1)
13087 (cons 'and todomatcher)
13088 (car todomatcher))
13089 orlist)
13090 (setq todomatcher nil))
13091 (setq todomatcher (if (> (length orlist) 1)
13092 (cons 'or orlist) (car orlist))))
13094 ;; Return the string and lisp forms of the matcher
13095 (setq matcher (if todomatcher
13096 (list 'and tagsmatcher todomatcher)
13097 tagsmatcher))
13098 (cons match0 matcher)))
13100 (defun org-op-to-function (op &optional stringp)
13101 "Turn an operator into the appropriate function."
13102 (setq op
13103 (cond
13104 ((equal op "<" ) '(< string< org-time<))
13105 ((equal op ">" ) '(> org-string> org-time>))
13106 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13107 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13108 ((member op '("=" "==")) '(= string= org-time=))
13109 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13110 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13112 (defun org<> (a b) (not (= a b)))
13113 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13114 (defun org-string>= (a b) (not (string< a b)))
13115 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13116 (defun org-string<> (a b) (not (string= a b)))
13117 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13118 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13119 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13120 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13121 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13122 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13123 (defun org-2ft (s)
13124 "Convert S to a floating point time.
13125 If S is already a number, just return it. If it is a string, parse
13126 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13127 (cond
13128 ((numberp s) s)
13129 ((stringp s)
13130 (condition-case nil
13131 (float-time (apply 'encode-time (org-parse-time-string s)))
13132 (error 0.)))
13133 (t 0.)))
13135 (defun org-time-today ()
13136 "Time in seconds today at 0:00.
13137 Returns the float number of seconds since the beginning of the
13138 epoch to the beginning of today (00:00)."
13139 (float-time (apply 'encode-time
13140 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13142 (defun org-matcher-time (s)
13143 "Interpret a time comparison value."
13144 (save-match-data
13145 (cond
13146 ((string= s "<now>") (float-time))
13147 ((string= s "<today>") (org-time-today))
13148 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13149 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13151 (+ (org-time-today)
13152 (* (string-to-number (match-string 1 s))
13153 (cdr (assoc (match-string 2 s)
13154 '(("d" . 86400.0) ("w" . 604800.0)
13155 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13156 (t (org-2ft s)))))
13158 (defun org-match-any-p (re list)
13159 "Does re match any element of list?"
13160 (setq list (mapcar (lambda (x) (string-match re x)) list))
13161 (delq nil list))
13163 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13164 (defvar org-tags-overlay (make-overlay 1 1))
13165 (org-detach-overlay org-tags-overlay)
13167 (defun org-get-local-tags-at (&optional pos)
13168 "Get a list of tags defined in the current headline."
13169 (org-get-tags-at pos 'local))
13171 (defun org-get-local-tags ()
13172 "Get a list of tags defined in the current headline."
13173 (org-get-tags-at nil 'local))
13175 (defun org-get-tags-at (&optional pos local)
13176 "Get a list of all headline tags applicable at POS.
13177 POS defaults to point. If tags are inherited, the list contains
13178 the targets in the same sequence as the headlines appear, i.e.
13179 the tags of the current headline come last.
13180 When LOCAL is non-nil, only return tags from the current headline,
13181 ignore inherited ones."
13182 (interactive)
13183 (if (and org-trust-scanner-tags
13184 (or (not pos) (equal pos (point)))
13185 (not local))
13186 org-scanner-tags
13187 (let (tags ltags lastpos parent)
13188 (save-excursion
13189 (save-restriction
13190 (widen)
13191 (goto-char (or pos (point)))
13192 (save-match-data
13193 (catch 'done
13194 (condition-case nil
13195 (progn
13196 (org-back-to-heading t)
13197 (while (not (equal lastpos (point)))
13198 (setq lastpos (point))
13199 (when (looking-at
13201 (setq ltags (org-split-string
13202 (org-match-string-no-properties 1) ":"))
13203 (when parent
13204 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13205 (setq tags (append
13206 (if parent
13207 (org-remove-uninherited-tags ltags)
13208 ltags)
13209 tags)))
13210 (or org-use-tag-inheritance (throw 'done t))
13211 (if local (throw 'done t))
13212 (or (org-up-heading-safe) (error nil))
13213 (setq parent t)))
13214 (error nil)))))
13215 (if local
13216 tags
13217 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13219 (defun org-add-prop-inherited (s)
13220 (add-text-properties 0 (length s) '(inherited t) s)
13221 s)
13223 (defun org-toggle-tag (tag &optional onoff)
13224 "Toggle the tag TAG for the current line.
13225 If ONOFF is `on' or `off', don't toggle but set to this state."
13226 (let (res current)
13227 (save-excursion
13228 (org-back-to-heading t)
13230 (point-at-eol) t)
13231 (progn
13232 (setq current (match-string 1))
13233 (replace-match ""))
13234 (setq current ""))
13235 (setq current (nreverse (org-split-string current ":")))
13236 (cond
13237 ((eq onoff 'on)
13238 (setq res t)
13239 (or (member tag current) (push tag current)))
13240 ((eq onoff 'off)
13241 (or (not (member tag current)) (setq current (delete tag current))))
13242 (t (if (member tag current)
13243 (setq current (delete tag current))
13244 (setq res t)
13245 (push tag current))))
13246 (end-of-line 1)
13247 (if current
13248 (progn
13249 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13250 (org-set-tags nil t))
13251 (delete-horizontal-space))
13252 (run-hooks 'org-after-tags-change-hook))
13253 res))
13255 (defun org-align-tags-here (to-col)
13256 ;; Assumes that this is a headline
13257 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13258 (beginning-of-line 1)
13260 (< pos (match-beginning 2)))
13261 (progn
13262 (setq tags-l (- (match-end 2) (match-beginning 2)))
13263 (goto-char (match-beginning 1))
13264 (insert " ")
13265 (delete-region (point) (1+ (match-beginning 2)))
13266 (setq ncol (max (current-column)
13267 (1+ col)
13268 (if (> to-col 0)
13269 to-col
13270 (- (abs to-col) tags-l))))
13271 (setq p (point))
13272 (insert (make-string (- ncol (current-column)) ?\ ))
13273 (setq ncol (current-column))
13274 (when indent-tabs-mode (tabify p (point-at-eol)))
13275 (org-move-to-column (min ncol col) t))
13276 (goto-char pos))))
13278 (defun org-set-tags-command (&optional arg just-align)
13279 "Call the set-tags command for the current entry."
13280 (interactive "P")
13281 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
13282 (org-set-tags arg just-align)
13283 (save-excursion
13284 (org-back-to-heading t)
13285 (org-set-tags arg just-align))))
13287 (defun org-set-tags-to (data)
13288 "Set the tags of the current entry to DATA, replacing the current tags.
13289 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13290 If DATA is nil or the empty string, any tags will be removed."
13291 (interactive "sTags: ")
13292 (setq data
13293 (cond
13294 ((eq data nil) "")
13295 ((equal data "") "")
13296 ((stringp data)
13297 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13298 ":"))
13299 ((listp data)
13300 (concat ":" (mapconcat 'identity data ":") ":"))
13301 (t nil)))
13302 (when data
13303 (save-excursion
13304 (org-back-to-heading t)
13305 (when (looking-at org-complex-heading-regexp)
13306 (if (match-end 5)
13307 (progn
13308 (goto-char (match-beginning 5))
13309 (insert data)
13310 (delete-region (point) (point-at-eol))
13311 (org-set-tags nil 'align))
13312 (goto-char (point-at-eol))
13313 (insert " " data)
13314 (org-set-tags nil 'align)))
13315 (beginning-of-line 1)
13317 (delete-region (match-beginning 1) (match-end 1))))))
13319 (defun org-align-all-tags ()
13320 "Align the tags i all headings."
13321 (interactive)
13322 (save-excursion
13323 (or (ignore-errors (org-back-to-heading t))
13324 (outline-next-heading))
13325 (if (org-at-heading-p)
13326 (org-set-tags t)
13327 (message "No headings"))))
13329 (defvar org-indent-indentation-per-level)
13330 (defun org-set-tags (&optional arg just-align)
13331 "Set the tags for the current headline.
13332 With prefix ARG, realign all tags in headings in the current buffer."
13333 (interactive "P")
13334 (let* ((re org-outline-regexp-bol)
13335 (current (unless arg (org-get-tags-string)))
13336 (col (current-column))
13337 (org-setting-tags t)
13338 table current-tags inherited-tags ; computed below when needed
13339 tags p0 c0 c1 rpl di tc level)
13340 (if arg
13341 (save-excursion
13342 (goto-char (point-min))
13343 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13344 (while (re-search-forward re nil t)
13345 (org-set-tags nil t)
13346 (end-of-line 1)))
13347 (message "All tags realigned to column %d" org-tags-column))
13348 (if just-align
13349 (setq tags current)
13350 ;; Get a new set of tags from the user
13351 (save-excursion
13352 (setq table (append org-tag-persistent-alist
13353 (or org-tag-alist (org-get-buffer-tags))
13354 (and
13355 org-complete-tags-always-offer-all-agenda-tags
13356 (org-global-tags-completion-table
13357 (org-agenda-files))))
13358 org-last-tags-completion-table table
13359 current-tags (org-split-string current ":")
13360 inherited-tags (nreverse
13361 (nthcdr (length current-tags)
13362 (nreverse (org-get-tags-at))))
13363 tags
13364 (if (or (eq t org-use-fast-tag-selection)
13365 (and org-use-fast-tag-selection
13366 (delq nil (mapcar 'cdr table))))
13367 (org-fast-tag-selection
13368 current-tags inherited-tags table
13369 (if org-fast-tag-selection-include-todo
13370 org-todo-key-alist))
13371 (let ((org-add-colon-after-tag-completion t))
13372 (org-trim
13373 (org-icompleting-read "Tags: "
13374 'org-tags-completion-function
13375 nil nil current 'org-tags-history))))))
13376 (while (string-match "[-+&]+" tags)
13377 ;; No boolean logic, just a list
13378 (setq tags (replace-match ":" t t tags))))
13380 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13382 (if org-tags-sort-function
13383 (setq tags (mapconcat 'identity
13384 (sort (org-split-string
13385 tags (org-re "[^[:alnum:]_@#%]+"))
13386 org-tags-sort-function) ":")))
13389 (setq tags "")
13390 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13391 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13393 ;; Insert new tags at the correct column
13394 (beginning-of-line 1)
13395 (setq level (or (and (looking-at org-outline-regexp)
13396 (- (match-end 0) (point) 1))
13397 1))
13398 (cond
13399 ((and (equal current "") (equal tags "")))
13400 ((re-search-forward
13402 (point-at-eol) t)
13403 (if (equal tags "")
13404 (setq rpl "")
13405 (goto-char (match-beginning 0))
13406 (setq c0 (current-column)
13407 ;; compute offset for the case of org-indent-mode active
13408 di (if org-indent-mode
13409 (* (1- org-indent-indentation-per-level) (1- level))
13410 0)
13411 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13412 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13413 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13414 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13415 (replace-match rpl t t)
13416 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13417 tags)
13418 (t (error "Tags alignment failed")))
13419 (org-move-to-column col)
13420 (unless just-align
13421 (run-hooks 'org-after-tags-change-hook)))))
13423 (defun org-change-tag-in-region (beg end tag off)
13424 "Add or remove TAG for each entry in the region.
13425 This works in the agenda, and also in an org-mode buffer."
13426 (interactive
13427 (list (region-beginning) (region-end)
13428 (let ((org-last-tags-completion-table
13429 (if (eq major-mode 'org-mode)
13430 (org-get-buffer-tags)
13431 (org-global-tags-completion-table))))
13432 (org-icompleting-read
13433 "Tag: " 'org-tags-completion-function nil nil nil
13434 'org-tags-history))
13435 (progn
13437 (equal (read-char-exclusive) ?r))))
13438 (if (fboundp 'deactivate-mark) (deactivate-mark))
13439 (let ((agendap (equal major-mode 'org-agenda-mode))
13440 l1 l2 m buf pos newhead (cnt 0))
13441 (goto-char end)
13442 (setq l2 (1- (org-current-line)))
13443 (goto-char beg)
13444 (setq l1 (org-current-line))
13445 (loop for l from l1 to l2 do
13446 (org-goto-line l)
13447 (setq m (get-text-property (point) 'org-hd-marker))
13448 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13449 (and agendap m))
13450 (setq buf (if agendap (marker-buffer m) (current-buffer))
13451 pos (if agendap m (point)))
13452 (with-current-buffer buf
13453 (save-excursion
13454 (save-restriction
13455 (goto-char pos)
13456 (setq cnt (1+ cnt))
13457 (org-toggle-tag tag (if off 'off 'on))
13458 (setq newhead (org-get-heading)))))
13459 (and agendap (org-agenda-change-all-lines newhead m))))
13460 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13462 (defun org-tags-completion-function (string predicate &optional flag)
13463 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13464 (confirm (lambda (x) (stringp (car x)))))
13466 (setq s1 (match-string 1 string)
13467 s2 (match-string 2 string))
13468 (setq s1 "" s2 string))
13469 (cond
13470 ((eq flag nil)
13471 ;; try completion
13472 (setq rtn (try-completion s2 ctable confirm))
13473 (if (stringp rtn)
13474 (setq rtn
13475 (concat s1 s2 (substring rtn (length s2))
13476 (if (and org-add-colon-after-tag-completion
13477 (assoc rtn ctable))
13478 ":" ""))))
13479 rtn)
13480 ((eq flag t)
13481 ;; all-completions
13482 (all-completions s2 ctable confirm)
13483 )
13484 ((eq flag 'lambda)
13485 ;; exact match?
13486 (assoc s2 ctable)))
13487 ))
13489 (defun org-fast-tag-insert (kwd tags face &optional end)
13490 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13491 (insert (format "%-12s" (concat kwd ":"))
13492 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13493 (or end "")))
13495 (defun org-fast-tag-show-exit (flag)
13496 (save-excursion
13497 (org-goto-line 3)
13499 (replace-match ""))
13500 (when flag
13501 (end-of-line 1)
13502 (org-move-to-column (- (window-width) 19) t)
13503 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13505 (defun org-set-current-tags-overlay (current prefix)
13506 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13507 (if (featurep 'xemacs)
13508 (org-overlay-display org-tags-overlay (concat prefix s)
13509 'secondary-selection)
13510 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13511 (org-overlay-display org-tags-overlay (concat prefix s)))))
13513 (defvar org-last-tag-selection-key nil)
13514 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13515 "Fast tag selection with single keys.
13516 CURRENT is the current list of tags in the headline, INHERITED is the
13517 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13518 possibly with grouping information. TODO-TABLE is a similar table with
13519 TODO keywords, should these have keys assigned to them.
13520 If the keys are nil, a-z are automatically assigned.
13521 Returns the new tags string, or nil to not change the current settings."
13522 (let* ((fulltable (append table todo-table))
13523 (maxlen (apply 'max (mapcar
13524 (lambda (x)
13525 (if (stringp (car x)) (string-width (car x)) 0))
13526 fulltable)))
13527 (buf (current-buffer))
13528 (expert (eq org-fast-tag-selection-single-key 'expert))
13529 (buffer-tags nil)
13530 (fwidth (+ maxlen 3 1 3))
13531 (ncol (/ (- (window-width) 4) fwidth))
13532 (i-face 'org-done)
13533 (c-face 'org-todo)
13534 tg cnt e c char c1 c2 ntable tbl rtn
13535 ov-start ov-end ov-prefix
13536 (exit-after-next org-fast-tag-selection-single-key)
13537 (done-keywords org-done-keywords)
13538 groups ingroup)
13539 (save-excursion
13540 (beginning-of-line 1)
13541 (if (looking-at
13543 (setq ov-start (match-beginning 1)
13544 ov-end (match-end 1)
13545 ov-prefix "")
13546 (setq ov-start (1- (point-at-eol))
13547 ov-end (1+ ov-start))
13549 (setq ov-prefix
13550 (concat
13551 (buffer-substring (1- (point)) (point))
13552 (if (> (current-column) org-tags-column)
13553 " "
13554 (make-string (- org-tags-column (current-column)) ?\ ))))))
13555 (move-overlay org-tags-overlay ov-start ov-end)
13556 (save-window-excursion
13557 (if expert
13558 (set-buffer (get-buffer-create " *Org tags*"))
13559 (delete-other-windows)
13560 (split-window-vertically)
13561 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13562 (erase-buffer)
13563 (org-set-local 'org-done-keywords done-keywords)
13566 (org-fast-tag-show-exit exit-after-next)
13567 (org-set-current-tags-overlay current ov-prefix)
13568 (setq tbl fulltable char ?a cnt 0)
13569 (while (setq e (pop tbl))
13570 (cond
13571 ((equal (car e) :startgroup)
13572 (push '() groups) (setq ingroup t)
13573 (when (not (= cnt 0))
13574 (setq cnt 0)
13576 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13577 ((equal (car e) :endgroup)
13578 (setq ingroup nil cnt 0)
13580 ((equal e '(:newline))
13581 (when (not (= cnt 0))
13582 (setq cnt 0)
13584 (setq e (car tbl))
13585 (while (equal (car tbl) '(:newline))
13587 (setq tbl (cdr tbl)))))
13588 (t
13589 (setq tg (copy-sequence (car e)) c2 nil)
13590 (if (cdr e)
13591 (setq c (cdr e))
13592 ;; automatically assign a character.
13593 (setq c1 (string-to-char
13594 (downcase (substring
13595 tg (if (= (string-to-char tg) ?@) 1 0)))))
13596 (if (or (rassoc c1 ntable) (rassoc c1 table))
13597 (while (or (rassoc char ntable) (rassoc char table))
13598 (setq char (1+ char)))
13599 (setq c2 c1))
13600 (setq c (or c2 char)))
13601 (if ingroup (push tg (car groups)))
13602 (setq tg (org-add-props tg nil 'face
13603 (cond
13604 ((not (assoc tg table))
13605 (org-get-todo-face tg))
13606 ((member tg current) c-face)
13607 ((member tg inherited) i-face)
13608 (t nil))))
13609 (if (and (= cnt 0) (not ingroup)) (insert " "))
13610 (insert "[" c "] " tg (make-string
13611 (- fwidth 4 (length tg)) ?\ ))
13612 (push (cons tg c) ntable)
13613 (when (= (setq cnt (1+ cnt)) ncol)
13615 (if ingroup (insert " "))
13616 (setq cnt 0)))))
13617 (setq ntable (nreverse ntable))
13619 (goto-char (point-min))
13620 (if (not expert) (org-fit-window-to-buffer))
13621 (setq rtn
13622 (catch 'exit
13623 (while t
13624 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13625 (if (not groups) "no " "")
13626 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13627 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13628 (setq org-last-tag-selection-key c)
13629 (cond
13631 ((= c ?!)
13632 (setq groups (not groups))
13633 (goto-char (point-min))
13634 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13635 ((= c ?\C-c)
13636 (if (not expert)
13637 (org-fast-tag-show-exit
13638 (setq exit-after-next (not exit-after-next)))
13639 (setq expert nil)
13640 (delete-other-windows)
13641 (set-window-buffer (split-window-vertically) " *Org tags*")
13642 (org-switch-to-buffer-other-window " *Org tags*")
13643 (org-fit-window-to-buffer)))
13644 ((or (= c ?\C-g)
13645 (and (= c ?q) (not (rassoc c ntable))))
13646 (org-detach-overlay org-tags-overlay)
13647 (setq quit-flag t))
13648 ((= c ?\ )
13649 (setq current nil)
13650 (if exit-after-next (setq exit-after-next 'now)))
13652 (condition-case nil
13653 (setq tg (org-icompleting-read
13654 "Tag: "
13655 (or buffer-tags
13656 (with-current-buffer buf
13657 (org-get-buffer-tags)))))
13658 (quit (setq tg "")))
13660 (add-to-list 'buffer-tags (list tg))
13661 (if (member tg current)
13662 (setq current (delete tg current))
13663 (push tg current)))
13664 (if exit-after-next (setq exit-after-next 'now)))
13665 ((setq e (rassoc c todo-table) tg (car e))
13666 (with-current-buffer buf
13667 (save-excursion (org-todo tg)))
13668 (if exit-after-next (setq exit-after-next 'now)))
13669 ((setq e (rassoc c ntable) tg (car e))
13670 (if (member tg current)
13671 (setq current (delete tg current))
13672 (loop for g in groups do
13673 (if (member tg g)
13674 (mapc (lambda (x)
13675 (setq current (delete x current)))
13676 g)))
13677 (push tg current))
13678 (if exit-after-next (setq exit-after-next 'now))))
13680 ;; Create a sorted list
13681 (setq current
13682 (sort current
13683 (lambda (a b)
13684 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13685 (if (eq exit-after-next 'now) (throw 'exit t))
13686 (goto-char (point-min))
13687 (beginning-of-line 2)
13688 (delete-region (point) (point-at-eol))
13689 (org-fast-tag-insert "Current" current c-face)
13690 (org-set-current-tags-overlay current ov-prefix)
13691 (while (re-search-forward
13693 (setq tg (match-string 1))
13694 (add-text-properties
13695 (match-beginning 1) (match-end 1)
13696 (list 'face
13697 (cond
13698 ((member tg current) c-face)
13699 ((member tg inherited) i-face)
13700 (t (get-text-property (match-beginning 1) 'face))))))
13701 (goto-char (point-min)))))
13702 (org-detach-overlay org-tags-overlay)
13703 (if rtn
13704 (mapconcat 'identity current ":")
13705 nil))))
13707 (defun org-get-tags-string ()
13708 "Get the TAGS string in the current headline."
13709 (unless (org-at-heading-p t)
13710 (error "Not on a heading"))
13711 (save-excursion
13712 (beginning-of-line 1)
13714 (org-match-string-no-properties 1)
13715 "")))
13717 (defun org-get-tags ()
13718 "Get the list of tags specified in the current headline."
13719 (org-split-string (org-get-tags-string) ":"))
13721 (defun org-get-buffer-tags ()
13722 "Get a table of all tags used in the buffer, for completion."
13723 (let (tags)
13724 (save-excursion
13725 (goto-char (point-min))
13726 (while (re-search-forward
13728 (when (equal (char-after (point-at-bol 0)) ?*)
13729 (mapc (lambda (x) (add-to-list 'tags x))
13730 (org-split-string (org-match-string-no-properties 1) ":")))))
13731 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13732 (mapcar 'list tags)))
13734 ;;;; The mapping API
13736 ;;;###autoload
13737 (defun org-map-entries (func &optional match scope &rest skip)
13738 "Call FUNC at each headline selected by MATCH in SCOPE.
13740 FUNC is a function or a lisp form. The function will be called without
13741 arguments, with the cursor positioned at the beginning of the headline.
13742 The return values of all calls to the function will be collected and
13743 returned as a list.
13745 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13746 does not need to preserve point. After evaluation, the cursor will be
13747 moved to the end of the line (presumably of the headline of the
13748 processed entry) and search continues from there. Under some
13749 circumstances, this may not produce the wanted results. For example,
13750 if you have removed (e.g. archived) the current (sub)tree it could
13751 mean that the next entry will be skipped entirely. In such cases, you
13752 can specify the position from where search should continue by making
13753 FUNC set the variable `org-map-continue-from' to the desired buffer
13754 position.
13756 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13757 Only headlines that are matched by this query will be considered during
13758 the iteration. When MATCH is nil or t, all headlines will be
13759 visited by the iteration.
13761 SCOPE determines the scope of this command. It can be any of:
13763 nil The current buffer, respecting the restriction if any
13764 tree The subtree started with the entry at point
13765 region The entries within the active region, if any
13766 region-start-level
13767 The entries within the active region, but only those at
13768 the same level than the first one.
13769 file The current buffer, without restriction
13770 file-with-archives
13771 The current buffer, and any archives associated with it
13772 agenda All agenda files
13773 agenda-with-archives
13774 All agenda files with any archive files associated with them
13775 \(file1 file2 ...)
13776 If this is a list, all files in the list will be scanned
13778 The remaining args are treated as settings for the skipping facilities of
13779 the scanner. The following items can be given here:
13781 archive skip trees with the archive tag.
13782 comment skip trees with the COMMENT keyword
13783 function or Emacs Lisp form:
13784 will be used as value for `org-agenda-skip-function', so whenever
13785 the function returns t, FUNC will not be called for that
13786 entry and search will continue from the point where the
13787 function leaves it.
13789 If your function needs to retrieve the tags including inherited tags
13790 at the *current* entry, you can use the value of the variable
13791 `org-scanner-tags' which will be much faster than getting the value
13792 with `org-get-tags-at'. If your function gets properties with
13793 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13794 to t around the call to `org-entry-properties' to get the same speedup.
13795 Note that if your function moves around to retrieve tags and properties at
13796 a *different* entry, you cannot use these techniques."
13797 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13798 (not (org-region-active-p)))
13799 (let* ((org-agenda-archives-mode nil) ; just to make sure
13800 (org-agenda-skip-archived-trees (memq 'archive skip))
13801 (org-agenda-skip-comment-trees (memq 'comment skip))
13802 (org-agenda-skip-function
13803 (car (org-delete-all '(comment archive) skip)))
13804 (org-tags-match-list-sublevels t)
13805 (start-level (eq scope 'region-start-level))
13806 matcher file res
13807 org-todo-keywords-for-agenda
13808 org-done-keywords-for-agenda
13809 org-todo-keyword-alist-for-agenda
13810 org-drawers-for-agenda
13811 org-tag-alist-for-agenda)
13813 (cond
13814 ((eq match t) (setq matcher t))
13815 ((eq match nil) (setq matcher t))
13816 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13818 (save-excursion
13819 (save-restriction
13820 (cond ((eq scope 'tree)
13821 (org-back-to-heading t)
13822 (org-narrow-to-subtree)
13823 (setq scope nil))
13824 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13825 (org-region-active-p))
13826 ;; If needed, set start-level to a string like "2"
13827 (when start-level
13828 (save-excursion
13829 (goto-char (region-beginning))
13830 (unless (org-at-heading-p) (outline-next-heading))
13831 (setq start-level (org-current-level))))
13832 (narrow-to-region (region-beginning)
13833 (save-excursion
13834 (goto-char (region-end))
13835 (unless (and (bolp) (org-at-heading-p))
13836 (outline-next-heading))
13837 (point)))
13838 (setq scope nil)))
13840 (if (not scope)
13841 (progn
13842 (org-prepare-agenda-buffers
13843 (list (buffer-file-name (current-buffer))))
13844 (setq res (org-scan-tags func matcher nil start-level)))
13845 ;; Get the right scope
13846 (cond
13847 ((and scope (listp scope) (symbolp (car scope)))
13848 (setq scope (eval scope)))
13849 ((eq scope 'agenda)
13850 (setq scope (org-agenda-files t)))
13851 ((eq scope 'agenda-with-archives)
13852 (setq scope (org-agenda-files t))
13853 (setq scope (org-add-archive-files scope)))
13854 ((eq scope 'file)
13855 (setq scope (list (buffer-file-name))))
13856 ((eq scope 'file-with-archives)
13857 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13858 (org-prepare-agenda-buffers scope)
13859 (while (setq file (pop scope))
13860 (with-current-buffer (org-find-base-buffer-visiting file)
13861 (save-excursion
13862 (save-restriction
13863 (widen)
13864 (goto-char (point-min))
13865 (setq res (append res (org-scan-tags func matcher))))))))))
13866 res)))
13868 ;;;; Properties
13870 ;;; Setting and retrieving properties
13872 (defconst org-special-properties
13873 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13874 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13875 "The special properties valid in Org-mode.
13877 These are properties that are not defined in the property drawer,
13878 but in some other way.")
13880 (defconst org-default-properties
13881 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13882 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13883 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13884 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13885 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13886 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13887 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13888 "Some properties that are used by Org-mode for various purposes.
13889 Being in this list makes sure that they are offered for completion.")
13892 "Regular expression matching the first line of a property drawer.")
13895 "Regular expression matching the last line of a property drawer.")
13898 "Regular expression matching the first line of a property drawer.")
13901 "Regular expression matching the first line of a property drawer.")
13903 (defconst org-property-drawer-re
13906 "Matches an entire property drawer.")
13908 (defconst org-clock-drawer-re
13911 "Matches an entire clock drawer.")
13913 (defsubst org-re-property (property)
13914 "Return a regexp matching PROPERTY.
13915 Match group 1 will be set to the value "
13918 (defun org-property-action ()
13919 "Do an action on properties."
13920 (interactive)
13921 (let (c)
13922 (org-at-property-p)
13923 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13924 (setq c (read-char-exclusive))
13925 (cond
13926 ((equal c ?s)
13927 (call-interactively 'org-set-property))
13928 ((equal c ?d)
13929 (call-interactively 'org-delete-property))
13930 ((equal c ?D)
13931 (call-interactively 'org-delete-property-globally))
13932 ((equal c ?c)
13933 (call-interactively 'org-compute-property-at-point))
13934 (t (error "No such property action %c" c)))))
13936 (defun org-set-effort (&optional value)
13937 "Set the effort property of the current entry.
13938 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13939 allowed value."
13940 (interactive "P")
13941 (if (equal value 0) (setq value 10))
13942 (let* ((completion-ignore-case t)
13943 (prop org-effort-property)
13944 (cur (org-entry-get nil prop))
13945 (allowed (org-property-get-allowed-values nil prop 'table))
13946 (existing (mapcar 'list (org-property-values prop)))
13947 rpl
13948 (val (cond
13949 ((stringp value) value)
13950 ((and allowed (integerp value))
13951 (or (car (nth (1- value) allowed))
13952 (car (org-last allowed))))
13953 (allowed
13954 (message "Select 1-9,0, [RET%s]: %s"
13955 (if cur (concat "=" cur) "")
13956 (mapconcat 'car allowed " "))
13957 (setq rpl (read-char-exclusive))
13959 cur
13960 (setq rpl (- rpl ?0))
13961 (if (equal rpl 0) (setq rpl 10))
13962 (if (and (> rpl 0) (<= rpl (length allowed)))
13963 (car (nth (1- rpl) allowed))
13964 (org-completing-read "Effort: " allowed nil))))
13965 (t
13966 (let (org-completion-use-ido org-completion-use-iswitchb)
13967 (org-completing-read
13969 (concat "[" cur "]") "")
13970 ": ")
13971 existing nil nil "" nil cur))))))
13972 (unless (equal (org-entry-get nil prop) val)
13973 (org-entry-put nil prop val))
13974 (message "%s is now %s" prop val)))
13976 (defun org-at-property-p ()
13977 "Is cursor inside a property drawer?"
13978 (save-excursion
13979 (beginning-of-line 1)
13981 (save-match-data ;; Used by calling procedures
13982 (let ((p (point))
13983 (range (unless (org-before-first-heading-p)
13984 (org-get-property-block))))
13985 (and range (<= (car range) p) (< p (cdr range))))))))
13987 (defun org-get-property-block (&optional beg end force)
13988 "Return the (beg . end) range of the body of the property drawer.
13989 BEG and END can be beginning and end of subtree, if not given
13990 they will be found.
13991 If the drawer does not exist and FORCE is non-nil, create the drawer."
13992 (catch 'exit
13993 (save-excursion
13994 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13995 (end (or end (progn (outline-next-heading) (point)))))
13996 (goto-char beg)
13997 (if (re-search-forward org-property-start-re end t)
13998 (setq beg (1+ (match-end 0)))
13999 (if force
14000 (save-excursion
14001 (org-insert-property-drawer)
14002 (setq end (progn (outline-next-heading) (point))))
14003 (throw 'exit nil))
14004 (goto-char beg)
14005 (if (re-search-forward org-property-start-re end t)
14006 (setq beg (1+ (match-end 0)))))
14007 (if (re-search-forward org-property-end-re end t)
14008 (setq end (match-beginning 0))
14009 (or force (throw 'exit nil))
14010 (goto-char beg)
14011 (setq end beg)
14012 (org-indent-line-function)
14014 (cons beg end)))))
14016 (defun org-entry-properties (&optional pom which specific)
14017 "Get all properties of the entry at point-or-marker POM.
14018 This includes the TODO keyword, the tags, time strings for deadline,
14019 scheduled, and clocking, and any additional properties defined in the
14020 entry. The return value is an alist, keys may occur multiple times
14021 if the property key was used several times.
14022 POM may also be nil, in which case the current entry is used.
14023 If WHICH is nil or `all', get all properties. If WHICH is
14024 `special' or `standard', only get that subclass. If WHICH
14025 is a string only get exactly this property. SPECIFIC can be a string, the
14026 specific property we are interested in. Specifying it can speed
14027 things up because then unnecessary parsing is avoided."
14028 (setq which (or which 'all))
14029 (org-with-point-at pom
14030 (let ((clockstr (substring org-clock-string 0 -1))
14031 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14032 (case-fold-search nil)
14033 beg end range props sum-props key key1 value string clocksum)
14034 (save-excursion
14035 (when (condition-case nil
14036 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14037 (error nil))
14038 (setq beg (point))
14039 (setq sum-props (get-text-property (point) 'org-summaries))
14040 (setq clocksum (get-text-property (point) :org-clock-minutes))
14041 (outline-next-heading)
14042 (setq end (point))
14043 (when (memq which '(all special))
14044 ;; Get the special properties, like TODO and tags
14045 (goto-char beg)
14046 (when (and (or (not specific) (string= specific "TODO"))
14047 (looking-at org-todo-line-regexp) (match-end 2))
14048 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14049 (when (and (or (not specific) (string= specific "PRIORITY"))
14050 (looking-at org-priority-regexp))
14051 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14052 (when (or (not specific) (string= specific "FILE"))
14053 (push (cons "FILE" buffer-file-name) props))
14054 (when (and (or (not specific) (string= specific "TAGS"))
14055 (setq value (org-get-tags-string))
14057 (push (cons "TAGS" value) props))
14058 (when (and (or (not specific) (string= specific "ALLTAGS"))
14059 (setq value (org-get-tags-at)))
14060 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14061 ":"))
14062 props))
14063 (when (or (not specific) (string= specific "BLOCKED"))
14064 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14065 (when (or (not specific)
14066 (member specific
14067 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14068 "TIMESTAMP" "TIMESTAMP_IA")))
14069 (catch 'match
14070 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14071 (setq key (if (match-end 1)
14072 (substring (org-match-string-no-properties 1)
14073 0 -1))
14074 string (if (equal key clockstr)
14075 (org-no-properties
14076 (org-trim
14077 (buffer-substring
14078 (match-beginning 3) (goto-char
14079 (point-at-eol)))))
14080 (substring (org-match-string-no-properties 3)
14081 1 -1)))
14082 ;; Get the correct property name from the key. This is
14083 ;; necessary if the user has configured time keywords.
14084 (setq key1 (concat key ":"))
14085 (cond
14086 ((not key)
14087 (setq key
14088 (if (= (char-after (match-beginning 3)) ?\[)
14089 "TIMESTAMP_IA" "TIMESTAMP")))
14090 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14091 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14092 ((equal key1 org-closed-string) (setq key "CLOSED"))
14093 ((equal key1 org-clock-string) (setq key "CLOCK")))
14094 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14095 (progn
14096 (push (cons key string) props)
14097 ;; no need to search further if match is found
14098 (throw 'match t))
14099 (when (or (equal key "CLOCK") (not (assoc key props)))
14100 (push (cons key string) props))))))
14101 )
14103 (when (memq which '(all standard))
14104 ;; Get the standard properties, like :PROP: ...
14105 (setq range (org-get-property-block beg end))
14106 (when range
14107 (goto-char (car range))
14108 (while (re-search-forward
14110 (cdr range) t)
14111 (setq key (org-match-string-no-properties 1)
14112 value (org-trim (or (org-match-string-no-properties 2) "")))
14113 (unless (member key excluded)
14114 (push (cons key (or value "")) props)))))
14115 (if clocksum
14116 (push (cons "CLOCKSUM"
14117 (org-columns-number-to-string (/ (float clocksum) 60.)
14118 'add_times))
14119 props))
14120 (unless (assoc "CATEGORY" props)
14121 (push (cons "CATEGORY" (org-get-category)) props))
14122 (append sum-props (nreverse props)))))))
14124 (defun org-entry-get (pom property &optional inherit literal-nil)
14125 "Get value of PROPERTY for entry at point-or-marker POM.
14126 If INHERIT is non-nil and the entry does not have the property,
14127 then also check higher levels of the hierarchy.
14128 If INHERIT is the symbol `selective', use inheritance only if the setting
14129 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14130 If the property is present but empty, the return value is the empty string.
14131 If the property is not present at all, nil is returned.
14134 do not interpret it as the list atom nil. This is used for inheritance
14136 (org-with-point-at pom
14137 (if (and inherit (if (eq inherit 'selective)
14138 (org-property-inherit-p property)
14139 t))
14140 (org-entry-get-with-inheritance property literal-nil)
14141 (if (member property org-special-properties)
14142 ;; We need a special property. Use `org-entry-properties' to
14143 ;; retrieve it, but specify the wanted property
14144 (cdr (assoc property (org-entry-properties nil 'special property)))
14145 (let ((range (unless (org-before-first-heading-p)
14146 (org-get-property-block))))
14147 (when (and range (goto-char (car range)))
14148 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14149 (cond
14150 ((re-search-forward
14151 (org-re-property property) (cdr range) t)
14152 (if (match-end 1) (org-match-string-no-properties 1) ""))
14153 ((re-search-forward
14154 (org-re-property (concat property "+")) (cdr range) t)
14155 (cdr (assoc
14156 property
14157 (org-update-property-plist
14158 (concat property "+")
14159 (if (match-end 1) (org-match-string-no-properties 1) "")
14160 (list (or (assoc property org-file-properties)
14161 (assoc property org-global-properties)
14162 (assoc property org-global-properties-fixed)
14163 ))))))))))))))
14165 (defun org-property-or-variable-value (var &optional inherit)
14166 "Check if there is a property fixing the value of VAR.
14167 If yes, return this value. If not, return the current value of the variable."
14168 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14170 (read prop)
14171 (symbol-value var))))
14173 (defun org-entry-delete (pom property)
14174 "Delete the property PROPERTY from entry at point-or-marker POM."
14175 (org-with-point-at pom
14176 (if (member property org-special-properties)
14177 nil ; cannot delete these properties.
14178 (let ((range (org-get-property-block)))
14179 (if (and range
14180 (goto-char (car range))
14181 (re-search-forward
14182 (org-re-property property)
14183 (cdr range) t))
14184 (progn
14185 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14186 t)
14187 nil)))))
14189 ;; Multi-values properties are properties that contain multiple values
14190 ;; These values are assumed to be single words, separated by whitespace.
14191 (defun org-entry-add-to-multivalued-property (pom property value)
14192 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14193 (let* ((old (org-entry-get pom property))
14195 (setq value (org-entry-protect-space value))
14196 (unless (member value values)
14197 (setq values (cons value values))
14198 (org-entry-put pom property
14199 (mapconcat 'identity values " ")))))
14201 (defun org-entry-remove-from-multivalued-property (pom property value)
14202 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14203 (let* ((old (org-entry-get pom property))
14205 (setq value (org-entry-protect-space value))
14206 (when (member value values)
14207 (setq values (delete value values))
14208 (org-entry-put pom property
14209 (mapconcat 'identity values " ")))))
14211 (defun org-entry-member-in-multivalued-property (pom property value)
14212 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14213 (let* ((old (org-entry-get pom property))
14215 (setq value (org-entry-protect-space value))
14216 (member value values)))
14218 (defun org-entry-get-multivalued-property (pom property)
14219 "Return a list of values in a multivalued property."
14220 (let* ((value (org-entry-get pom property))
14222 (mapcar 'org-entry-restore-space values)))
14224 (defun org-entry-put-multivalued-property (pom property &rest values)
14225 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14226 VALUES should be a list of strings. Spaces will be protected."
14227 (org-entry-put pom property
14228 (mapconcat 'org-entry-protect-space values " "))
14229 (let* ((value (org-entry-get pom property))
14231 (mapcar 'org-entry-restore-space values)))
14233 (defun org-entry-protect-space (s)
14234 "Protect spaces and newline in string S."
14235 (while (string-match " " s)
14236 (setq s (replace-match "%20" t t s)))
14238 (setq s (replace-match "%0A" t t s)))
14239 s)
14241 (defun org-entry-restore-space (s)
14242 "Restore spaces and newline in string S."
14243 (while (string-match "%20" s)
14244 (setq s (replace-match " " t t s)))
14245 (while (string-match "%0A" s)
14247 s)
14249 (defvar org-entry-property-inherited-from (make-marker)
14250 "Marker pointing to the entry from where a property was inherited.
14251 Each call to `org-entry-get-with-inheritance' will set this marker to the
14252 location of the entry where the inheritance search matched. If there was
14253 no match, the marker will point nowhere.
14254 Note that also `org-entry-get' calls this function, if the INHERIT flag
14255 is set.")
14257 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14258 "Get entry property, and search higher levels if not present.
14259 The search will stop at the first ancestor which has the property defined.
14261 should be considered as undefined (this is the meaning of nil here).
14263 (move-marker org-entry-property-inherited-from nil)
14264 (let (tmp)
14265 (unless (org-before-first-heading-p)
14266 (save-excursion
14267 (save-restriction
14268 (widen)
14269 (catch 'ex
14270 (while t
14271 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14272 (org-back-to-heading t)
14273 (move-marker org-entry-property-inherited-from (point))
14274 (throw 'ex tmp))
14275 (or (org-up-heading-safe) (throw 'ex nil)))))))
14276 (setq tmp (or tmp
14277 (cdr (assoc property org-file-properties))
14278 (cdr (assoc property org-global-properties))
14279 (cdr (assoc property org-global-properties-fixed))))
14280 (if literal-nil tmp (org-not-nil tmp))))
14282 (defvar org-property-changed-functions nil
14283 "Hook called when the value of a property has changed.
14284 Each hook function should accept two arguments, the name of the property
14285 and the new value.")
14287 (defun org-entry-put (pom property value)
14288 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14289 (org-with-point-at pom
14290 (org-back-to-heading t)
14291 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14292 range)
14293 (cond
14294 ((equal property "TODO")
14296 (not (member value org-todo-keywords-1)))
14298 (if (or (not value)
14300 (setq value 'none))
14301 (org-todo value)
14302 (org-set-tags nil 'align))
14303 ((equal property "PRIORITY")
14305 (string-to-char value) ?\ ))
14306 (org-set-tags nil 'align))
14307 ((equal property "SCHEDULED")
14308 (if (re-search-forward org-scheduled-time-regexp end t)
14309 (cond
14310 ((eq value 'earlier) (org-timestamp-change -1 'day))
14311 ((eq value 'later) (org-timestamp-change 1 'day))
14312 (t (call-interactively 'org-schedule)))
14313 (call-interactively 'org-schedule)))
14314 ((equal property "DEADLINE")
14315 (if (re-search-forward org-deadline-time-regexp end t)
14316 (cond
14317 ((eq value 'earlier) (org-timestamp-change -1 'day))
14318 ((eq value 'later) (org-timestamp-change 1 'day))
14319 (t (call-interactively 'org-deadline)))
14320 (call-interactively 'org-deadline)))
14321 ((member property org-special-properties)
14322 (error "The %s property can not yet be set with `org-entry-put'"
14323 property))
14324 (t ; a non-special property
14325 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14326 (setq range (org-get-property-block beg end 'force))
14327 (goto-char (car range))
14328 (if (re-search-forward
14329 (org-re-property property) (cdr range) t)
14330 (progn
14331 (delete-region (match-beginning 0) (match-end 0))
14332 (goto-char (match-beginning 0)))
14333 (goto-char (cdr range))
14335 (backward-char 1)
14336 (org-indent-line-function))
14337 (insert ":" property ":")
14338 (and value (insert " " value))
14339 (org-indent-line-function)))))
14340 (run-hook-with-args 'org-property-changed-functions property value)))
14342 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14343 "Get all property keys in the current buffer.
14344 With INCLUDE-SPECIALS, also list the special properties that reflect things
14345 like tags and TODO state.
14346 With INCLUDE-DEFAULTS, also include properties that has special meaning
14347 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14348 and others.
14349 With INCLUDE-COLUMNS, also include property names given in COLUMN
14350 formats in the current buffer."
14351 (let (rtn range cfmt s p)
14352 (save-excursion
14353 (save-restriction
14354 (widen)
14355 (goto-char (point-min))
14356 (while (re-search-forward org-property-start-re nil t)
14357 (setq range (org-get-property-block))
14358 (goto-char (car range))
14359 (while (re-search-forward
14361 (cdr range) t)
14362 (add-to-list 'rtn (org-match-string-no-properties 1)))
14363 (outline-next-heading))))
14365 (when include-specials
14366 (setq rtn (append org-special-properties rtn)))
14368 (when include-defaults
14369 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14370 (add-to-list 'rtn org-effort-property))
14372 (when include-columns
14373 (save-excursion
14374 (save-restriction
14375 (widen)
14376 (goto-char (point-min))
14377 (while (re-search-forward
14379 nil t)
14380 (setq cfmt (match-string 2) s 0)
14382 cfmt s)
14383 (setq s (match-end 0)
14384 p (match-string 1 cfmt))
14385 (unless (or (equal p "ITEM")
14386 (member p org-special-properties))
14387 (add-to-list 'rtn (match-string 1 cfmt))))))))
14389 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14391 (defun org-property-values (key)
14392 "Return a list of all values of property KEY in the current buffer."
14393 (save-excursion
14394 (save-restriction
14395 (widen)
14396 (goto-char (point-min))
14397 (let ((re (org-re-property key))
14398 values)
14399 (while (re-search-forward re nil t)
14400 (add-to-list 'values (org-trim (match-string 1))))
14401 (delete "" values)))))
14403 (defun org-insert-property-drawer ()
14404 "Insert a property drawer into the current entry."
14405 (org-back-to-heading t)
14406 (looking-at org-outline-regexp)
14407 (let ((indent (if org-adapt-indentation
14408 (- (match-end 0) (match-beginning 0))
14409 0))
14410 (beg (point))
14412 end hiddenp)
14413 (outline-next-heading)
14414 (setq end (point))
14415 (goto-char beg)
14416 (while (re-search-forward re end t))
14417 (setq hiddenp (outline-invisible-p))
14418 (end-of-line 1)
14421 (if (member (match-string 1) '("CLOCK:" ":END:"))
14422 ;; just skip this line
14423 (beginning-of-line 2)
14424 ;; Drawer start, find the end
14426 (beginning-of-line 1)))
14427 (org-skip-over-state-notes)
14429 (if (eq (char-before) ?*) (forward-char 1))
14431 (beginning-of-line 0)
14432 (org-indent-to-column indent)
14433 (beginning-of-line 2)
14434 (org-indent-to-column indent)
14435 (beginning-of-line 0)
14436 (if hiddenp
14437 (save-excursion
14438 (org-back-to-heading t)
14439 (hide-entry))
14440 (org-flag-drawer t))))
14442 (defun org-insert-drawer (&optional arg drawer)
14443 "Insert a drawer at point.
14445 Optional argument DRAWER, when non-nil, is a string representing
14446 drawer's name. Otherwise, the user is prompted for a name.
14448 If a region is active, insert the drawer around that region
14449 instead.
14451 Point is left between drawer's boundaries."
14452 (interactive "P")
14453 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
14454 "LOGBOOK"))
14455 ;; SYSTEM-DRAWERS is a list of drawer names that are used
14456 ;; internally by Org. They are meant to be inserted
14457 ;; automatically.
14458 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
14459 ;; Remove system drawers from list. Note: For some reason,
14460 ;; `org-completing-read' ignores the predicate while
14461 ;; `completing-read' handles it fine.
14462 (drawer (if arg "PROPERTIES"
14463 (or drawer
14464 (completing-read
14465 "Drawer: " org-drawers
14466 (lambda (d) (not (member d system-drawers))))))))
14467 (cond
14468 ;; With C-u, fall back on `org-insert-property-drawer'
14469 (arg (org-insert-property-drawer))
14470 ;; With an active region, insert a drawer at point.
14471 ((not (org-region-active-p))
14472 (progn
14475 (forward-line -2)))
14476 ;; Otherwise, insert the drawer at point
14477 (t
14478 (let ((rbeg (region-beginning))
14479 (rend (copy-marker (region-end))))
14480 (unwind-protect
14481 (progn
14482 (goto-char rbeg)
14483 (beginning-of-line)
14484 (when (save-excursion
14485 (re-search-forward org-outline-regexp-bol rend t))
14486 (error "Drawers cannot contain headlines"))
14487 ;; Position point at the beginning of the first
14488 ;; non-blank line in region. Insert drawer's opening
14489 ;; there, then indent it.
14490 (org-skip-whitespace)
14491 (beginning-of-line)
14493 (forward-line -1)
14494 (indent-for-tab-command)
14495 ;; Move point to the beginning of the first blank line
14496 ;; after the last non-blank line in region. Insert
14497 ;; drawer's closing, then indent it.
14498 (goto-char rend)
14501 (indent-for-tab-command)
14503 ;; Clear marker, whatever the outcome of insertion is.
14504 (set-marker rend nil)))))))
14506 (defvar org-property-set-functions-alist nil
14507 "Property set function alist.
14508 Each entry should have the following format:
14510 (PROPERTY . READ-FUNCTION)
14512 The read function will be called with the same argument as
14513 `org-completing-read'.")
14515 (defun org-set-property-function (property)
14516 "Get the function that should be used to set PROPERTY.
14517 This is computed according to `org-property-set-functions-alist'."
14518 (or (cdr (assoc property org-property-set-functions-alist))
14519 'org-completing-read))
14521 (defun org-read-property-value (property)
14522 "Read PROPERTY value from user."
14523 (let* ((completion-ignore-case t)
14524 (allowed (org-property-get-allowed-values nil property 'table))
14525 (cur (org-entry-get nil property))
14526 (prompt (concat property " value"
14528 (concat " [" cur "]") "") ": "))
14529 (set-function (org-set-property-function property))
14530 (val (if allowed
14531 (funcall set-function prompt allowed nil
14532 (not (get-text-property 0 'org-unrestricted
14533 (caar allowed))))
14534 (let (org-completion-use-ido org-completion-use-iswitchb)
14535 (funcall set-function prompt
14536 (mapcar 'list (org-property-values property))
14537 nil nil "" nil cur)))))
14538 (if (equal val "")
14539 cur
14540 val)))
14542 (defvar org-last-set-property nil)
14543 (defun org-read-property-name ()
14544 "Read a property name."
14545 (let* ((completion-ignore-case t)
14546 (keys (org-buffer-property-keys nil t t))
14547 (default-prop (or (save-excursion
14548 (save-match-data
14549 (beginning-of-line)
14551 (null (string= (match-string 1) "END"))
14552 (match-string 1))))
14553 org-last-set-property))
14554 (property (org-icompleting-read
14555 (concat "Property"
14556 (if default-prop (concat " [" default-prop "]") "")
14557 ": ")
14558 (mapcar 'list keys)
14559 nil nil nil nil
14560 default-prop
14561 )))
14562 (if (member property keys)
14563 property
14564 (or (cdr (assoc (downcase property)
14565 (mapcar (lambda (x) (cons (downcase x) x))
14566 keys)))
14567 property))))
14569 (defun org-set-property (property value)
14570 "In the current entry, set PROPERTY to VALUE.
14571 When called interactively, this will prompt for a property name, offering
14572 completion on existing and default properties. And then it will prompt
14573 for a value, offering completion either on allowed values (via an inherited
14574 xxx_ALL property) or on existing values in other instances of this property
14575 in the current file."
14576 (interactive (list nil nil))
14577 (let* ((property (or property (org-read-property-name)))
14578 (value (or value (org-read-property-value property)))
14579 (fn (assoc property org-properties-postprocess-alist)))
14580 (setq org-last-set-property property)
14581 ;; Possibly postprocess the inserted value:
14582 (when fn (setq value (funcall (cadr fn) value)))
14583 (unless (equal (org-entry-get nil property) value)
14584 (org-entry-put nil property value))))
14586 (defun org-delete-property (property)
14587 "In the current entry, delete PROPERTY."
14588 (interactive
14589 (let* ((completion-ignore-case t)
14590 (prop (org-icompleting-read "Property: "
14591 (org-entry-properties nil 'standard))))
14592 (list prop)))
14593 (message "Property %s %s" property
14594 (if (org-entry-delete nil property)
14595 "deleted"
14596 "was not present in the entry")))
14598 (defun org-delete-property-globally (property)
14599 "Remove PROPERTY globally, from all entries."
14600 (interactive
14601 (let* ((completion-ignore-case t)
14602 (prop (org-icompleting-read
14603 "Globally remove property: "
14604 (mapcar 'list (org-buffer-property-keys)))))
14605 (list prop)))
14606 (save-excursion
14607 (save-restriction
14608 (widen)
14609 (goto-char (point-min))
14610 (let ((cnt 0))
14611 (while (re-search-forward
14612 (org-re-property property)
14613 nil t)
14614 (setq cnt (1+ cnt))
14615 (replace-match ""))
14618 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14620 (defun org-compute-property-at-point ()
14621 "Compute the property at point.
14622 This looks for an enclosing column format, extracts the operator and
14623 then applies it to the property in the column format's scope."
14624 (interactive)
14625 (unless (org-at-property-p)
14626 (error "Not at a property"))
14627 (let ((prop (org-match-string-no-properties 2)))
14628 (org-columns-get-format-and-top-level)
14629 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14630 (error "No operator defined for property %s" prop))
14631 (org-columns-compute prop)))
14633 (defvar org-property-allowed-value-functions nil
14634 "Hook for functions supplying allowed values for a specific property.
14635 The functions must take a single argument, the name of the property, and
14637 the values, this means that these values are intended as defaults for
14638 completion, but that other values should be allowed too.
14639 The functions must return nil if they are not responsible for this
14640 property.")
14642 (defun org-property-get-allowed-values (pom property &optional table)
14643 "Get allowed values for the property PROPERTY.
14644 When TABLE is non-nil, return an alist that can directly be used for
14645 completion."
14646 (let (vals)
14647 (cond
14648 ((equal property "TODO")
14649 (setq vals (org-with-point-at pom
14650 (append org-todo-keywords-1 '("")))))
14651 ((equal property "PRIORITY")
14652 (let ((n org-lowest-priority))
14653 (while (>= n org-highest-priority)
14654 (push (char-to-string n) vals)
14655 (setq n (1- n)))))
14656 ((member property org-special-properties))
14657 ((setq vals (run-hook-with-args-until-success
14658 'org-property-allowed-value-functions property)))
14659 (t
14660 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14662 (setq vals (car (read-from-string (concat "(" vals ")"))))
14663 (setq vals (mapcar (lambda (x)
14664 (cond ((stringp x) x)
14665 ((numberp x) (number-to-string x))
14666 ((symbolp x) (symbol-name x))
14667 (t "???")))
14668 vals)))))
14669 (when (member ":ETC" vals)
14670 (setq vals (remove ":ETC" vals))
14671 (org-add-props (car vals) '(org-unrestricted t)))
14672 (if table (mapcar 'list vals) vals)))
14674 (defun org-property-previous-allowed-value (&optional previous)
14675 "Switch to the next allowed value for this property."
14676 (interactive)
14677 (org-property-next-allowed-value t))
14679 (defun org-property-next-allowed-value (&optional previous)
14680 "Switch to the next allowed value for this property."
14681 (interactive)
14682 (unless (org-at-property-p)
14683 (error "Not at a property"))
14684 (let* ((key (match-string 2))
14685 (value (match-string 3))
14686 (allowed (or (org-property-get-allowed-values (point) key)
14687 (and (member value '("[ ]" "[-]" "[X]"))
14688 '("[ ]" "[X]"))))
14689 nval)
14690 (unless allowed
14691 (error "Allowed values for this property have not been defined"))
14692 (if previous (setq allowed (reverse allowed)))
14693 (if (member value allowed)
14694 (setq nval (car (cdr (member value allowed)))))
14695 (setq nval (or nval (car allowed)))
14696 (if (equal nval value)
14697 (error "Only one allowed value for this property"))
14698 (org-at-property-p)
14699 (replace-match (concat " :" key ": " nval) t t)
14700 (org-indent-line-function)
14701 (beginning-of-line 1)
14703 (run-hook-with-args 'org-property-changed-functions key nval)))
14705 (defun org-find-olp (path &optional this-buffer)
14706 "Return a marker pointing to the entry at outline path OLP.
14707 If anything goes wrong, throw an error.
14708 You can wrap this call to catch the error like this:
14710 (condition-case msg
14711 (org-mobile-locate-entry (match-string 4))
14712 (error (nth 1 msg)))
14714 The return value will then be either a string with the error message,
14715 or a marker if everything is OK.
14717 If THIS-BUFFER is set, the outline path does not contain a file,
14718 only headings."
14719 (let* ((file (if this-buffer buffer-file-name (pop path)))
14720 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14721 (level 1)
14722 (lmin 1)
14723 (lmax 1)
14724 limit re end found pos heading cnt flevel)
14725 (unless buffer (error "File not found :%s" file))
14726 (with-current-buffer buffer
14727 (save-excursion
14728 (save-restriction
14729 (widen)
14730 (setq limit (point-max))
14731 (goto-char (point-min))
14732 (while (setq heading (pop path))
14733 (setq re (format org-complex-heading-regexp-format
14734 (regexp-quote heading)))
14735 (setq cnt 0 pos (point))
14736 (while (re-search-forward re end t)
14737 (setq level (- (match-end 1) (match-beginning 1)))
14738 (if (and (>= level lmin) (<= level lmax))
14739 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14740 (when (= cnt 0) (error "Heading not found on level %d: %s"
14741 lmax heading))
14742 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14743 lmax heading))
14744 (goto-char found)
14745 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14746 (setq end (save-excursion (org-end-of-subtree t t))))
14747 (when (org-at-heading-p)
14748 (move-marker (make-marker) (point))))))))
14750 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14751 "Find node HEADING in BUFFER.
14752 Return a marker to the heading if it was found, or nil if not.
14753 If POS-ONLY is set, return just the position instead of a marker.
14755 The heading text must match exact, but it may have a TODO keyword,
14756 a priority cookie and tags in the standard locations."
14757 (with-current-buffer (or buffer (current-buffer))
14758 (save-excursion
14759 (save-restriction
14760 (widen)
14761 (goto-char (point-min))
14762 (let (case-fold-search)
14763 (if (re-search-forward
14764 (format org-complex-heading-regexp-format
14765 (regexp-quote heading)) nil t)
14766 (if pos-only
14767 (match-beginning 0)
14768 (move-marker (make-marker) (match-beginning 0)))))))))
14770 (defun org-find-exact-heading-in-directory (heading &optional dir)
14771 "Find Org node headline HEADING in all .org files in directory DIR.
14772 When the target headline is found, return a marker to this location."
14773 (let ((files (directory-files (or dir default-directory)
14775 file visiting m buffer)
14776 (catch 'found
14777 (while (setq file (pop files))
14778 (message "trying %s" file)
14779 (setq visiting (org-find-base-buffer-visiting file))
14780 (setq buffer (or visiting (find-file-noselect file)))
14781 (setq m (org-find-exact-headline-in-buffer
14782 heading buffer))
14783 (when (and (not m) (not visiting)) (kill-buffer buffer))
14784 (and m (throw 'found m))))))
14786 (defun org-find-entry-with-id (ident)
14787 "Locate the entry that contains the ID property with exact value IDENT.
14788 IDENT can be a string, a symbol or a number, this function will search for
14789 the string representation of it.
14790 Return the position where this entry starts, or nil if there is no such entry."
14791 (interactive "sID: ")
14792 (let ((id (cond
14793 ((stringp ident) ident)
14794 ((symbol-name ident) (symbol-name ident))
14795 ((numberp ident) (number-to-string ident))
14796 (t (error "IDENT %s must be a string, symbol or number" ident))))
14797 (case-fold-search nil))
14798 (save-excursion
14799 (save-restriction
14800 (widen)
14801 (goto-char (point-min))
14802 (when (re-search-forward
14804 nil t)
14805 (org-back-to-heading t)
14806 (point))))))
14808 ;;;; Timestamps
14810 (defvar org-last-changed-timestamp nil)
14811 (defvar org-last-inserted-timestamp nil
14812 "The last time stamp inserted with `org-insert-time-stamp'.")
14813 (defvar org-time-was-given) ; dynamically scoped parameter
14814 (defvar org-end-time-was-given) ; dynamically scoped parameter
14815 (defvar org-ts-what) ; dynamically scoped parameter
14817 (defun org-time-stamp (arg &optional inactive)
14818 "Prompt for a date/time and insert a time stamp.
14819 If the user specifies a time like HH:MM, or if this command is called
14820 with a prefix argument, the time stamp will contain date and time.
14821 Otherwise, only the date will be included. All parts of a date not
14822 specified by the user will be filled in from the current date/time.
14823 So if you press just return without typing anything, the time stamp
14824 will represent the current date/time. If there is already a timestamp
14825 at the cursor, it will be modified."
14826 (interactive "P")
14827 (let* ((ts nil)
14828 (default-time
14829 ;; Default time is either today, or, when entering a range,
14830 ;; the range start.
14831 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14832 (save-excursion
14833 (re-search-backward
14835 (- (point) 20) t)))
14836 (apply 'encode-time (org-parse-time-string (match-string 1)))
14837 (current-time)))
14838 (default-input (and ts (org-get-compact-tod ts)))
14839 (repeater (save-excursion
14840 (save-match-data
14841 (beginning-of-line)
14842 (when (re-search-forward
14844 (save-excursion (progn (end-of-line) (point))) t)
14845 (match-string 0)))))
14846 org-time-was-given org-end-time-was-given time)
14847 (cond
14848 ((and (org-at-timestamp-p t)
14849 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14850 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14851 (insert "--")
14852 (setq time (let ((this-command this-command))
14853 (org-read-date arg 'totime nil nil
14854 default-time default-input inactive)))
14855 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14856 ((org-at-timestamp-p t)
14857 (setq time (let ((this-command this-command))
14858 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14859 (when (org-at-timestamp-p t) ; just to get the match data
14860 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14861 (replace-match "")
14862 (setq org-last-changed-timestamp
14863 (org-insert-time-stamp
14864 time (or org-time-was-given arg)
14865 inactive nil nil (list org-end-time-was-given)))
14866 (when repeater (goto-char (1- (point))) (insert " " repeater)
14867 (setq org-last-changed-timestamp
14868 (concat (substring org-last-inserted-timestamp 0 -1)
14869 " " repeater ">"))))
14870 (message "Timestamp updated"))
14871 (t
14872 (setq time (let ((this-command this-command))
14873 (org-read-date arg 'totime nil nil default-time default-input inactive)))
14874 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14875 nil nil (list org-end-time-was-given))))))
14877 ;; FIXME: can we use this for something else, like computing time differences?
14878 (defun org-get-compact-tod (s)
14879 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14880 (let* ((t1 (match-string 1 s))
14881 (h1 (string-to-number (match-string 2 s)))
14882 (m1 (string-to-number (match-string 3 s)))
14883 (t2 (and (match-end 4) (match-string 5 s)))
14884 (h2 (and t2 (string-to-number (match-string 6 s))))
14885 (m2 (and t2 (string-to-number (match-string 7 s))))
14886 dh dm)
14887 (if (not t2)
14888 t1
14889 (setq dh (- h2 h1) dm (- m2 m1))
14890 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14891 (concat t1 "+" (number-to-string dh)
14892 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14894 (defun org-time-stamp-inactive (&optional arg)
14895 "Insert an inactive time stamp.
14896 An inactive time stamp is enclosed in square brackets instead of angle
14897 brackets. It is inactive in the sense that it does not trigger agenda entries,
14898 does not link to the calendar and cannot be changed with the S-cursor keys.
14899 So these are more for recording a certain time/date."
14900 (interactive "P")
14901 (org-time-stamp arg 'inactive))
14903 (defvar org-date-ovl (make-overlay 1 1))
14904 (overlay-put org-date-ovl 'face 'org-warning)
14905 (org-detach-overlay org-date-ovl)
14907 (defvar org-ans1) ; dynamically scoped parameter
14908 (defvar org-ans2) ; dynamically scoped parameter
14910 (defvar org-plain-time-of-day-regexp) ; defined below
14912 (defvar org-overriding-default-time nil) ; dynamically scoped
14913 (defvar org-read-date-overlay nil)
14914 (defvar org-dcst nil) ; dynamically scoped
14915 (defvar org-read-date-history nil)
14916 (defvar org-read-date-final-answer nil)
14917 (defvar org-read-date-analyze-futurep nil)
14918 (defvar org-read-date-analyze-forced-year nil)
14920 (defun org-read-date (&optional with-time to-time from-string prompt
14921 default-time default-input inactive)
14922 "Read a date, possibly a time, and make things smooth for the user.
14923 The prompt will suggest to enter an ISO date, but you can also enter anything
14924 which will at least partially be understood by `parse-time-string'.
14925 Unrecognized parts of the date will default to the current day, month, year,
14926 hour and minute. If this command is called to replace a timestamp at point,
14927 or to enter the second timestamp of a range, the default time is taken
14928 from the existing stamp. Furthermore, the command prefers the future,
14929 so if you are giving a date where the year is not given, and the day-month
14930 combination is already past in the current year, it will assume you
14931 mean next year. For details, see the manual. A few examples:
14933 3-2-5 --> 2003-02-05
14934 feb 15 --> currentyear-02-15
14935 2/15 --> currentyear-02-15
14936 sep 12 9 --> 2009-09-12
14937 12:45 --> today 12:45
14938 22 sept 0:34 --> currentyear-09-22 0:34
14939 12 --> currentyear-currentmonth-12
14940 Fri --> nearest Friday (today or later)
14941 etc.
14943 Furthermore you can specify a relative date by giving, as the *first* thing
14944 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14945 change in days weeks, months, years.
14946 With a single plus or minus, the date is relative to today. With a double
14947 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14948 +4d --> four days from today
14949 +4 --> same as above
14950 +2w --> two weeks from today
14951 ++5 --> five days from default date
14953 The function understands only English month and weekday abbreviations,
14954 but this can be configured with the variables `parse-time-months' and
14955 `parse-time-weekdays'.
14957 While prompting, a calendar is popped up - you can also select the
14958 date with the mouse (button 1). The calendar shows a period of three
14959 months. To scroll it to other months, use the keys `>' and `<'.
14960 If you don't like the calendar, turn it off with
14961 \(setq org-read-date-popup-calendar nil)
14963 With optional argument TO-TIME, the date will immediately be converted
14964 to an internal time.
14965 With an optional argument WITH-TIME, the prompt will suggest to also
14966 insert a time. Note that when WITH-TIME is not set, you can still
14967 enter a time, and this function will inform the calling routine about
14968 this change. The calling routine may then choose to change the format
14969 used to insert the time stamp into the buffer to include the time.
14970 With optional argument FROM-STRING, read from this string instead from
14971 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14972 the time/date that is used for everything that is not specified by the
14973 user."
14974 (require 'parse-time)
14975 (let* ((org-time-stamp-rounding-minutes
14976 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14977 (org-dcst org-display-custom-times)
14978 (ct (org-current-time))
14979 (def (or org-overriding-default-time default-time ct))
14980 (defdecode (decode-time def))
14981 (dummy (progn
14982 (when (< (nth 2 defdecode) org-extend-today-until)
14983 (setcar (nthcdr 2 defdecode) -1)
14984 (setcar (nthcdr 1 defdecode) 59)
14985 (setq def (apply 'encode-time defdecode)
14986 defdecode (decode-time def)))))
14987 (calendar-frame-setup nil)
14988 (calendar-setup nil)
14989 (calendar-move-hook nil)
14990 (calendar-view-diary-initially-flag nil)
14991 (calendar-view-holidays-initially-flag nil)
14992 (timestr (format-time-string
14993 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14994 (prompt (concat (if prompt (concat prompt " ") "")
14995 (format "Date+time [%s]: " timestr)))
14996 ans (org-ans0 "") org-ans1 org-ans2 final)
14998 (cond
14999 (from-string (setq ans from-string))
15000 (org-read-date-popup-calendar
15001 (save-excursion
15002 (save-window-excursion
15003 (calendar)
15004 (unwind-protect
15005 (progn
15006 (calendar-forward-day (- (time-to-days def)
15007 (calendar-absolute-from-gregorian
15008 (calendar-current-date))))
15009 (org-eval-in-calendar nil t)
15010 (let* ((old-map (current-local-map))
15011 (map (copy-keymap calendar-mode-map))
15012 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
15013 (org-defkey map (kbd "RET") 'org-calendar-select)
15014 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
15015 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
15016 (org-defkey minibuffer-local-map [(meta shift left)]
15017 (lambda () (interactive)
15018 (org-eval-in-calendar '(calendar-backward-month 1))))
15019 (org-defkey minibuffer-local-map [(meta shift right)]
15020 (lambda () (interactive)
15021 (org-eval-in-calendar '(calendar-forward-month 1))))
15022 (org-defkey minibuffer-local-map [(meta shift up)]
15023 (lambda () (interactive)
15024 (org-eval-in-calendar '(calendar-backward-year 1))))
15025 (org-defkey minibuffer-local-map [(meta shift down)]
15026 (lambda () (interactive)
15027 (org-eval-in-calendar '(calendar-forward-year 1))))
15028 (org-defkey minibuffer-local-map [?\e (shift left)]
15029 (lambda () (interactive)
15030 (org-eval-in-calendar '(calendar-backward-month 1))))
15031 (org-defkey minibuffer-local-map [?\e (shift right)]
15032 (lambda () (interactive)
15033 (org-eval-in-calendar '(calendar-forward-month 1))))
15034 (org-defkey minibuffer-local-map [?\e (shift up)]
15035 (lambda () (interactive)
15036 (org-eval-in-calendar '(calendar-backward-year 1))))
15037 (org-defkey minibuffer-local-map [?\e (shift down)]
15038 (lambda () (interactive)
15039 (org-eval-in-calendar '(calendar-forward-year 1))))
15040 (org-defkey minibuffer-local-map [(shift up)]
15041 (lambda () (interactive)
15042 (org-eval-in-calendar '(calendar-backward-week 1))))
15043 (org-defkey minibuffer-local-map [(shift down)]
15044 (lambda () (interactive)
15045 (org-eval-in-calendar '(calendar-forward-week 1))))
15046 (org-defkey minibuffer-local-map [(shift left)]
15047 (lambda () (interactive)
15048 (org-eval-in-calendar '(calendar-backward-day 1))))
15049 (org-defkey minibuffer-local-map [(shift right)]
15050 (lambda () (interactive)
15051 (org-eval-in-calendar '(calendar-forward-day 1))))
15052 (org-defkey minibuffer-local-map ">"
15053 (lambda () (interactive)
15054 (org-eval-in-calendar '(scroll-calendar-left 1))))
15055 (org-defkey minibuffer-local-map "<"
15056 (lambda () (interactive)
15057 (org-eval-in-calendar '(scroll-calendar-right 1))))
15058 (org-defkey minibuffer-local-map "\C-v"
15059 (lambda () (interactive)
15060 (org-eval-in-calendar
15061 '(calendar-scroll-left-three-months 1))))
15062 (org-defkey minibuffer-local-map "\M-v"
15063 (lambda () (interactive)
15064 (org-eval-in-calendar
15065 '(calendar-scroll-right-three-months 1))))
15066 (run-hooks 'org-read-date-minibuffer-setup-hook)
15067 (unwind-protect
15068 (progn
15069 (use-local-map map)
15070 (setq org-read-date-inactive inactive)
15071 (add-hook 'post-command-hook 'org-read-date-display)
15072 (setq org-ans0 (read-string prompt default-input
15073 'org-read-date-history nil))
15074 ;; org-ans0: from prompt
15075 ;; org-ans1: from mouse click
15076 ;; org-ans2: from calendar motion
15077 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15078 (remove-hook 'post-command-hook 'org-read-date-display)
15079 (use-local-map old-map)
15080 (when org-read-date-overlay
15081 (delete-overlay org-read-date-overlay)
15082 (setq org-read-date-overlay nil)))))
15083 (bury-buffer "*Calendar*")))))
15085 (t ; Naked prompt only
15086 (unwind-protect
15087 (setq ans (read-string prompt default-input
15088 'org-read-date-history timestr))
15089 (when org-read-date-overlay
15090 (delete-overlay org-read-date-overlay)
15091 (setq org-read-date-overlay nil)))))
15093 (setq final (org-read-date-analyze ans def defdecode))
15095 (when org-read-date-analyze-forced-year
15096 (message "Year was forced into %s"
15097 (if org-read-date-force-compatible-dates
15098 "compatible range (1970-2037)"
15099 "range representable on this machine"))
15100 (ding))
15102 ;; One round trip to get rid of 34th of August and stuff like that....
15103 (setq final (decode-time (apply 'encode-time final)))
15105 (setq org-read-date-final-answer ans)
15107 (if to-time
15108 (apply 'encode-time final)
15109 (if (and (boundp 'org-time-was-given) org-time-was-given)
15110 (format "%04d-%02d-%02d %02d:%02d"
15111 (nth 5 final) (nth 4 final) (nth 3 final)
15112 (nth 2 final) (nth 1 final))
15113 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15115 (defvar def)
15116 (defvar defdecode)
15117 (defvar with-time)
15118 (defvar org-read-date-inactive)
15119 (defun org-read-date-display ()
15120 "Display the current date prompt interpretation in the minibuffer."
15121 (when org-read-date-display-live
15122 (when org-read-date-overlay
15123 (delete-overlay org-read-date-overlay))
15124 (let ((p (point)))
15125 (end-of-line 1)
15126 (while (not (equal (buffer-substring
15127 (max (point-min) (- (point) 4)) (point))
15128 " "))
15129 (insert " "))
15130 (goto-char p))
15131 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15132 " " (or org-ans1 org-ans2)))
15133 (org-end-time-was-given nil)
15134 (f (org-read-date-analyze ans def defdecode))
15135 (fmts (if org-dcst
15136 org-time-stamp-custom-formats
15137 org-time-stamp-formats))
15138 (fmt (if (or with-time
15139 (and (boundp 'org-time-was-given) org-time-was-given))
15140 (cdr fmts)
15141 (car fmts)))
15142 (txt (format-time-string fmt (apply 'encode-time f)))
15143 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
15144 (txt (concat "=> " txt)))
15145 (when (and org-end-time-was-given
15146 (string-match org-plain-time-of-day-regexp txt))
15147 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15148 org-end-time-was-given
15149 (substring txt (match-end 0)))))
15150 (when org-read-date-analyze-futurep
15151 (setq txt (concat txt " (=>F)")))
15152 (setq org-read-date-overlay
15153 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15154 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15156 (defun org-read-date-analyze (ans def defdecode)
15157 "Analyze the combined answer of the date prompt."
15158 ;; FIXME: cleanup and comment
15159 (let ((nowdecode (decode-time (current-time)))
15160 delta deltan deltaw deltadef year month day
15161 hour minute second wday pm h2 m2 tl wday1
15162 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15163 (setq org-read-date-analyze-futurep nil
15164 org-read-date-analyze-forced-year nil)
15166 (setq ans "+0"))
15168 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15169 (setq ans (replace-match "" t t ans)
15170 deltan (car delta)
15171 deltaw (nth 1 delta)
15172 deltadef (nth 2 delta)))
15174 ;; Check if there is an iso week date in there
15175 ;; If yes, store the info and postpone interpreting it until the rest
15176 ;; of the parsing is done
15177 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15178 (setq iso-year (if (match-end 1)
15179 (org-small-year-to-year
15180 (string-to-number (match-string 1 ans))))
15181 iso-weekday (if (match-end 3)
15182 (string-to-number (match-string 3 ans)))
15183 iso-week (string-to-number (match-string 2 ans)))
15184 (setq ans (replace-match "" t t ans)))
15186 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15187 (when (string-match
15189 (setq year (if (match-end 2)
15190 (string-to-number (match-string 2 ans))
15191 (progn (setq kill-year t)
15192 (string-to-number (format-time-string "%Y"))))
15193 month (string-to-number (match-string 3 ans))
15194 day (string-to-number (match-string 4 ans)))
15195 (if (< year 100) (setq year (+ 2000 year)))
15197 t nil ans)))
15199 ;; Help matching dotted european dates
15200 (when (string-match
15201 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15202 (setq year (if (match-end 3)
15203 (string-to-number (match-string 3 ans))
15204 (progn (setq kill-year t)
15205 (string-to-number (format-time-string "%Y"))))
15206 day (string-to-number (match-string 1 ans))
15207 month (string-to-number (match-string 2 ans))
15209 t nil ans)))
15211 ;; Help matching american dates, like 5/30 or 5/30/7
15212 (when (string-match
15213 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15214 (setq year (if (match-end 4)
15215 (string-to-number (match-string 4 ans))
15216 (progn (setq kill-year t)
15217 (string-to-number (format-time-string "%Y"))))
15218 month (string-to-number (match-string 1 ans))
15219 day (string-to-number (match-string 2 ans)))
15220 (if (< year 100) (setq year (+ 2000 year)))
15222 t nil ans)))
15223 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15224 ;; If there is a time with am/pm, and *no* time without it, we convert
15225 ;; so that matching will be successful.
15226 (loop for i from 1 to 2 do ; twice, for end time as well
15229 (setq hour (string-to-number (match-string 1 ans))
15230 minute (if (match-end 3)
15231 (string-to-number (match-string 3 ans))
15232 0)
15233 pm (equal ?p
15234 (string-to-char (downcase (match-string 4 ans)))))
15235 (if (and (= hour 12) (not pm))
15236 (setq hour 0)
15237 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15238 (setq ans (replace-match (format "%02d:%02d" hour minute)
15239 t t ans))))
15241 ;; Check if a time range is given as a duration
15242 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15243 (setq hour (string-to-number (match-string 1 ans))
15244 h2 (+ hour (string-to-number (match-string 3 ans)))
15245 minute (string-to-number (match-string 2 ans))
15246 m2 (+ minute (if (match-end 5) (string-to-number
15247 (match-string 5 ans))0)))
15248 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15249 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15250 t t ans)))
15252 ;; Check if there is a time range
15253 (when (boundp 'org-end-time-was-given)
15254 (setq org-time-was-given nil)
15255 (when (and (string-match org-plain-time-of-day-regexp ans)
15256 (match-end 8))
15257 (setq org-end-time-was-given (match-string 8 ans))
15258 (setq ans (concat (substring ans 0 (match-beginning 7))
15259 (substring ans (match-end 7))))))
15261 (setq tl (parse-time-string ans)
15262 day (or (nth 3 tl) (nth 3 defdecode))
15263 month (or (nth 4 tl)
15264 (if (and org-read-date-prefer-future
15265 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15266 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15267 (nth 4 defdecode)))
15268 year (or (and (not kill-year) (nth 5 tl))
15269 (if (and org-read-date-prefer-future
15270 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15271 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15272 (nth 5 defdecode)))
15273 hour (or (nth 2 tl) (nth 2 defdecode))
15274 minute (or (nth 1 tl) (nth 1 defdecode))
15275 second (or (nth 0 tl) 0)
15276 wday (nth 6 tl))
15278 (when (and (eq org-read-date-prefer-future 'time)
15279 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15280 (equal day (nth 3 nowdecode))
15281 (equal month (nth 4 nowdecode))
15282 (equal year (nth 5 nowdecode))
15283 (nth 2 tl)
15284 (or (< (nth 2 tl) (nth 2 nowdecode))
15285 (and (= (nth 2 tl) (nth 2 nowdecode))
15286 (nth 1 tl)
15287 (< (nth 1 tl) (nth 1 nowdecode)))))
15288 (setq day (1+ day)
15289 futurep t))
15291 ;; Special date definitions below
15292 (cond
15293 (iso-week
15294 ;; There was an iso week
15295 (require 'cal-iso)
15296 (setq futurep nil)
15297 (setq year (or iso-year year)
15298 day (or iso-weekday wday 1)
15299 wday nil ; to make sure that the trigger below does not match
15300 iso-date (calendar-gregorian-from-absolute
15301 (calendar-absolute-from-iso
15302 (list iso-week day year))))
15303 ; FIXME: Should we also push ISO weeks into the future?
15304 ; (when (and org-read-date-prefer-future
15305 ; (not iso-year)
15306 ; (< (calendar-absolute-from-gregorian iso-date)
15307 ; (time-to-days (current-time))))
15308 ; (setq year (1+ year)
15309 ; iso-date (calendar-gregorian-from-absolute
15310 ; (calendar-absolute-from-iso
15311 ; (list iso-week day year)))))
15312 (setq month (car iso-date)
15313 year (nth 2 iso-date)
15314 day (nth 1 iso-date)))
15315 (deltan
15316 (setq futurep nil)
15317 (unless deltadef
15318 (let ((now (decode-time (current-time))))
15319 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15320 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15321 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15322 ((equal deltaw "m") (setq month (+ month deltan)))
15323 ((equal deltaw "y") (setq year (+ year deltan)))))
15324 ((and wday (not (nth 3 tl)))
15325 (setq futurep nil)
15326 ;; Weekday was given, but no day, so pick that day in the week
15327 ;; on or after the derived date.
15328 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15329 (unless (equal wday wday1)
15330 (setq day (+ day (% (- wday wday1 -7) 7))))))
15331 (if (and (boundp 'org-time-was-given)
15332 (nth 2 tl))
15333 (setq org-time-was-given t))
15334 (if (< year 100) (setq year (+ 2000 year)))
15335 ;; Check of the date is representable
15336 (if org-read-date-force-compatible-dates
15337 (progn
15338 (if (< year 1970)
15339 (setq year 1970 org-read-date-analyze-forced-year t))
15340 (if (> year 2037)
15341 (setq year 2037 org-read-date-analyze-forced-year t)))
15342 (condition-case nil
15343 (ignore (encode-time second minute hour day month year))
15344 (error
15345 (setq year (nth 5 defdecode))
15346 (setq org-read-date-analyze-forced-year t))))
15347 (setq org-read-date-analyze-futurep futurep)
15348 (list second minute hour day month year)))
15350 (defvar parse-time-weekdays)
15352 (defun org-read-date-get-relative (s today default)
15353 "Check string S for special relative date string.
15354 TODAY and DEFAULT are internal times, for today and for a default.
15355 Return shift list (N what def-flag)
15357 N is the number of WHATs to shift.
15358 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15359 the DEFAULT date rather than TODAY."
15360 (require 'parse-time)
15361 (when (and
15362 (string-match
15363 (concat
15368 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15369 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15370 (string-to-char (substring (match-string 1 s) -1))
15371 ?+))
15372 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15373 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15374 (what (if (match-end 3) (match-string 3 s) "d"))
15375 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15376 (date (if rel default today))
15377 (wday (nth 6 (decode-time date)))
15378 delta)
15379 (if wday1
15380 (progn
15381 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15382 (if (= dir ?-) (setq delta (- delta 7)))
15383 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15384 (list delta "d" rel))
15385 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15387 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15388 "Turn a user-specified date into the internal representation.
15389 The internal representation needed by the calendar is (month day year).
15390 This is a wrapper to handle the brain-dead convention in calendar that
15391 user function argument order change dependent on argument order."
15392 (if (boundp 'calendar-date-style)
15393 (cond
15394 ((eq calendar-date-style 'american)
15395 (list arg1 arg2 arg3))
15396 ((eq calendar-date-style 'european)
15397 (list arg2 arg1 arg3))
15398 ((eq calendar-date-style 'iso)
15399 (list arg2 arg3 arg1)))
15400 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15401 (if (org-bound-and-true-p european-calendar-style)
15402 (list arg2 arg1 arg3)
15403 (list arg1 arg2 arg3)))))
15405 (defun org-eval-in-calendar (form &optional keepdate)
15406 "Eval FORM in the calendar window and return to current window.
15407 Also, store the cursor date in variable org-ans2."
15408 (let ((sf (selected-frame))
15409 (sw (selected-window)))
15410 (select-window (get-buffer-window "*Calendar*" t))
15411 (eval form)
15412 (when (and (not keepdate) (calendar-cursor-to-date))
15413 (let* ((date (calendar-cursor-to-date))
15414 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15415 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15416 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15417 (select-window sw)
15418 (org-select-frame-set-input-focus sf)))
15420 (defun org-calendar-select ()
15421 "Return to `org-read-date' with the date currently selected.
15422 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15423 (interactive)
15424 (when (calendar-cursor-to-date)
15425 (let* ((date (calendar-cursor-to-date))
15426 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15427 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15428 (if (active-minibuffer-window) (exit-minibuffer))))
15430 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15431 "Insert a date stamp for the date given by the internal TIME.
15432 WITH-HM means use the stamp format that includes the time of the day.
15433 INACTIVE means use square brackets instead of angular ones, so that the
15434 stamp will not contribute to the agenda.
15435 PRE and POST are optional strings to be inserted before and after the
15436 stamp.
15437 The command returns the inserted time stamp."
15438 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15439 stamp)
15440 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15441 (insert-before-markers (or pre ""))
15442 (when (listp extra)
15443 (setq extra (car extra))
15444 (if (and (stringp extra)
15446 (setq extra (format "-%02d:%02d"
15447 (string-to-number (match-string 1 extra))
15448 (string-to-number (match-string 2 extra))))
15449 (setq extra nil)))
15450 (when extra
15451 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15452 (insert-before-markers (setq stamp (format-time-string fmt time)))
15453 (insert-before-markers (or post ""))
15454 (setq org-last-inserted-timestamp stamp)))
15456 (defun org-toggle-time-stamp-overlays ()
15457 "Toggle the use of custom time stamp formats."
15458 (interactive)
15459 (setq org-display-custom-times (not org-display-custom-times))
15460 (unless org-display-custom-times
15461 (let ((p (point-min)) (bmp (buffer-modified-p)))
15462 (while (setq p (next-single-property-change p 'display))
15463 (if (and (get-text-property p 'display)
15464 (eq (get-text-property p 'face) 'org-date))
15465 (remove-text-properties
15466 p (setq p (next-single-property-change p 'display))
15467 '(display t))))
15468 (set-buffer-modified-p bmp)))
15469 (if (featurep 'xemacs)
15470 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15471 (org-restart-font-lock)
15472 (setq org-table-may-need-update t)
15473 (if org-display-custom-times
15474 (message "Time stamps are overlaid with custom format")
15475 (message "Time stamp overlays removed")))
15477 (defun org-display-custom-time (beg end)
15478 "Overlay modified time stamp format over timestamp between BEG and END."
15479 (let* ((ts (buffer-substring beg end))
15480 t1 w1 with-hm tf time str w2 (off 0))
15481 (save-match-data
15482 (setq t1 (org-parse-time-string ts t))
15483 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15484 (setq off (- (match-end 0) (match-beginning 0)))))
15485 (setq end (- end off))
15486 (setq w1 (- end beg)
15487 with-hm (and (nth 1 t1) (nth 2 t1))
15488 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15489 time (org-fix-decoded-time t1)
15490 str (org-add-props
15491 (format-time-string
15492 (substring tf 1 -1) (apply 'encode-time time))
15493 nil 'mouse-face 'highlight)
15494 w2 (length str))
15495 (if (not (= w2 w1))
15496 (add-text-properties (1+ beg) (+ 2 beg)
15497 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15498 (if (featurep 'xemacs)
15499 (progn
15500 (put-text-property beg end 'invisible t)
15501 (put-text-property beg end 'end-glyph (make-glyph str)))
15502 (put-text-property beg end 'display str))))
15504 (defun org-translate-time (string)
15505 "Translate all timestamps in STRING to custom format.
15506 But do this only if the variable `org-display-custom-times' is set."
15507 (when org-display-custom-times
15508 (save-match-data
15509 (let* ((start 0)
15510 (re org-ts-regexp-both)
15511 t1 with-hm inactive tf time str beg end)
15512 (while (setq start (string-match re string start))
15513 (setq beg (match-beginning 0)
15514 end (match-end 0)
15515 t1 (save-match-data
15516 (org-parse-time-string (substring string beg end) t))
15517 with-hm (and (nth 1 t1) (nth 2 t1))
15518 inactive (equal (substring string beg (1+ beg)) "[")
15519 tf (funcall (if with-hm 'cdr 'car)
15520 org-time-stamp-custom-formats)
15521 time (org-fix-decoded-time t1)
15522 str (format-time-string
15523 (concat
15524 (if inactive "[" "<") (substring tf 1 -1)
15525 (if inactive "]" ">"))
15526 (apply 'encode-time time))
15527 string (replace-match str t t string)
15528 start (+ start (length str)))))))
15529 string)
15531 (defun org-fix-decoded-time (time)
15532 "Set 0 instead of nil for the first 6 elements of time.
15533 Don't touch the rest."
15534 (let ((n 0))
15535 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15537 (defun org-days-to-time (timestamp-string)
15538 "Difference between TIMESTAMP-STRING and now in days."
15539 (- (time-to-days (org-time-string-to-time timestamp-string))
15540 (time-to-days (current-time))))
15542 (defun org-deadline-close (timestamp-string &optional ndays)
15543 "Is the time in TIMESTAMP-STRING close to the current date?"
15544 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15545 (and (< (org-days-to-time timestamp-string) ndays)
15546 (not (org-entry-is-done-p))))
15548 (defun org-get-wdays (ts)
15549 "Get the deadline lead time appropriate for timestring TS."
15550 (cond
15551 ((<= org-deadline-warning-days 0)
15552 ;; 0 or negative, enforce this value no matter what
15553 (- org-deadline-warning-days))
15555 ;; lead time is specified.
15556 (floor (* (string-to-number (match-string 1 ts))
15557 (cdr (assoc (match-string 2 ts)
15558 '(("d" . 1) ("w" . 7)
15559 ("m" . 30.4) ("y" . 365.25)))))))
15560 ;; go for the default.
15561 (t org-deadline-warning-days)))
15563 (defun org-calendar-select-mouse (ev)
15564 "Return to `org-read-date' with the date currently selected.
15565 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15566 (interactive "e")
15567 (mouse-set-point ev)
15568 (when (calendar-cursor-to-date)
15569 (let* ((date (calendar-cursor-to-date))
15570 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15571 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15572 (if (active-minibuffer-window) (exit-minibuffer))))
15574 (defun org-check-deadlines (ndays)
15575 "Check if there are any deadlines due or past due.
15576 A deadline is considered due if it happens within `org-deadline-warning-days'
15577 days from today's date. If the deadline appears in an entry marked DONE,
15578 it is not shown. The prefix arg NDAYS can be used to test that many
15580 (interactive "P")
15581 (let* ((org-warn-days
15582 (cond
15583 ((equal ndays '(4)) 100000)
15584 (ndays (prefix-numeric-value ndays))
15585 (t (abs org-deadline-warning-days))))
15586 (case-fold-search nil)
15588 (callback
15589 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15591 (message "%d deadlines past-due or due within %d days"
15592 (org-occur regexp nil callback)
15593 org-warn-days)))
15595 (defun org-check-before-date (date)
15596 "Check if there are deadlines or scheduled entries before DATE."
15597 (interactive (list (org-read-date)))
15598 (let ((case-fold-search nil)
15602 (callback
15603 (lambda () (time-less-p
15604 (org-time-string-to-time (match-string 2))
15605 (org-time-string-to-time date)))))
15606 (message "%d entries before %s"
15607 (org-occur regexp nil callback) date)))
15609 (defun org-check-after-date (date)
15610 "Check if there are deadlines or scheduled entries after DATE."
15611 (interactive (list (org-read-date)))
15612 (let ((case-fold-search nil)
15616 (callback
15617 (lambda () (not
15618 (time-less-p
15619 (org-time-string-to-time (match-string 2))
15620 (org-time-string-to-time date))))))
15621 (message "%d entries after %s"
15622 (org-occur regexp nil callback) date)))
15624 (defun org-check-dates-range (start-date end-date)
15625 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15626 (interactive (list (org-read-date nil nil nil "Range starts")
15627 (org-read-date nil nil nil "Range end")))
15628 (let ((case-fold-search nil)
15632 (callback
15633 (lambda ()
15634 (let ((match (match-string 2)))
15635 (and
15636 (not (time-less-p
15637 (org-time-string-to-time match)
15638 (org-time-string-to-time start-date)))
15639 (time-less-p
15640 (org-time-string-to-time match)
15641 (org-time-string-to-time end-date)))))))
15642 (message "%d entries between %s and %s"
15643 (org-occur regexp nil callback) start-date end-date)))
15645 (defun org-evaluate-time-range (&optional to-buffer)
15646 "Evaluate a time range by computing the difference between start and end.
15647 Normally the result is just printed in the echo area, but with prefix arg
15648 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15649 If the time range is actually in a table, the result is inserted into the
15650 next column.
15651 For time difference computation, a year is assumed to be exactly 365
15652 days in order to avoid rounding problems."
15653 (interactive "P")
15654 (or
15655 (org-clock-update-time-maybe)
15656 (save-excursion
15657 (unless (org-at-date-range-p t)
15658 (goto-char (point-at-bol))
15659 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15660 (if (not (org-at-date-range-p t))
15661 (error "Not at a time-stamp range, and none found in current line")))
15662 (let* ((ts1 (match-string 1))
15663 (ts2 (match-string 2))
15664 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15665 (match-end (match-end 0))
15666 (time1 (org-time-string-to-time ts1))
15667 (time2 (org-time-string-to-time ts2))
15668 (t1 (org-float-time time1))
15669 (t2 (org-float-time time2))
15670 (diff (abs (- t2 t1)))
15671 (negative (< (- t2 t1) 0))
15672 ;; (ys (floor (* 365 24 60 60)))
15673 (ds (* 24 60 60))
15674 (hs (* 60 60))
15675 (fy "%dy %dd %02d:%02d")
15676 (fy1 "%dy %dd")
15677 (fd "%dd %02d:%02d")
15678 (fd1 "%dd")
15679 (fh "%02d:%02d")
15680 y d h m align)
15681 (if havetime
15682 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15683 y 0
15684 d (floor (/ diff ds)) diff (mod diff ds)
15685 h (floor (/ diff hs)) diff (mod diff hs)
15686 m (floor (/ diff 60)))
15687 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15688 y 0
15689 d (floor (+ (/ diff ds) 0.5))
15690 h 0 m 0))
15691 (if (not to-buffer)
15692 (message "%s" (org-make-tdiff-string y d h m))
15693 (if (org-at-table-p)
15694 (progn
15695 (goto-char match-end)
15696 (setq align t)
15697 (and (looking-at " *|") (goto-char (match-end 0))))
15698 (goto-char match-end))
15699 (if (looking-at
15701 (replace-match ""))
15702 (if negative (insert " -"))
15703 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15704 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15705 (insert " " (format fh h m))))
15706 (if align (org-table-align))
15707 (message "Time difference inserted")))))
15709 (defun org-make-tdiff-string (y d h m)
15710 (let ((fmt "")
15711 (l nil))
15712 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15713 l (push y l)))
15714 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15715 l (push d l)))
15716 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15717 l (push h l)))
15718 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15719 l (push m l)))
15720 (apply 'format fmt (nreverse l))))
15722 (defun org-time-string-to-time (s &optional buffer pos)
15723 (condition-case errdata
15724 (apply 'encode-time (org-parse-time-string s))
15726 s (if (not (and buffer pos))
15727 ""
15728 (format " at %d in buffer `%s'" pos buffer))
15729 (cdr errdata)))))
15731 (defun org-time-string-to-seconds (s)
15732 (org-float-time (org-time-string-to-time s)))
15734 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15735 "Convert a time stamp to an absolute day number.
15736 If there is a specifier for a cyclic time stamp, get the closest date to
15737 DAYNR.
15738 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15739 The variable date is bound by the calendar when this is called."
15740 (cond
15742 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15743 daynr
15744 (+ daynr 1000)))
15746 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15747 (time-to-days (current-time))) (match-string 0 s)
15748 prefer show-all))
15749 (t (time-to-days
15750 (condition-case errdata
15751 (apply 'encode-time (org-parse-time-string s))
15753 s (if (not (and buffer pos))
15754 ""
15755 (format " at %d in buffer `%s'" pos buffer))
15756 (cdr errdata))))))))
15758 (defun org-days-to-iso-week (days)
15759 "Return the iso week number."
15760 (require 'cal-iso)
15761 (car (calendar-iso-from-absolute days)))
15763 (defun org-small-year-to-year (year)
15764 "Convert 2-digit years into 4-digit years.
15765 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15766 The year 2000 cannot be abbreviated. Any year larger than 99
15767 is returned unchanged."
15768 (if (< year 38)
15769 (setq year (+ 2000 year))
15770 (if (< year 100)
15771 (setq year (+ 1900 year))))
15772 year)
15774 (defun org-time-from-absolute (d)
15775 "Return the time corresponding to date D.
15776 D may be an absolute day number, or a calendar-type list (month day year)."
15777 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15778 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15780 (defun org-calendar-holiday ()
15781 "List of holidays, for Diary display in Org-mode."
15782 (require 'holidays)
15783 (let ((hl (funcall
15784 (if (fboundp 'calendar-check-holidays)
15785 'calendar-check-holidays 'check-calendar-holidays) date)))
15786 (if hl (mapconcat 'identity hl "; "))))
15788 (defun org-diary-sexp-entry (sexp entry date)
15789 "Process a SEXP diary ENTRY for DATE."
15790 (require 'diary-lib)
15791 (let ((result (if calendar-debug-sexp
15792 (let ((stack-trace-on-error t))
15793 (eval (car (read-from-string sexp))))
15794 (condition-case nil
15795 (eval (car (read-from-string sexp)))
15796 (error
15797 (beep)
15798 (message "Bad sexp at line %d in %s: %s"
15799 (org-current-line)
15800 (buffer-file-name) sexp)
15801 (sleep-for 2))))))
15802 (cond ((stringp result) (split-string result "; "))
15803 ((and (consp result)
15804 (not (consp (cdr result)))
15805 (stringp (cdr result))) (cdr result))
15806 ((and (consp result)
15807 (stringp (car result))) result)
15808 (result entry)
15809 (t nil))))
15811 (defun org-diary-to-ical-string (frombuf)
15812 "Get iCalendar entries from diary entries in buffer FROMBUF.
15813 This uses the icalendar.el library."
15814 (let* ((tmpdir (if (featurep 'xemacs)
15815 (temp-directory)
15816 temporary-file-directory))
15817 (tmpfile (make-temp-name
15818 (expand-file-name "orgics" tmpdir)))
15819 buf rtn b e)
15820 (with-current-buffer frombuf
15821 (icalendar-export-region (point-min) (point-max) tmpfile)
15822 (setq buf (find-buffer-visiting tmpfile))
15823 (set-buffer buf)
15824 (goto-char (point-min))
15825 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15826 (setq b (match-beginning 0)))
15827 (goto-char (point-max))
15828 (if (re-search-backward "^END:VEVENT" nil t)
15829 (setq e (match-end 0)))
15831 (kill-buffer buf)
15832 (delete-file tmpfile)
15833 rtn))
15835 (defun org-closest-date (start current change prefer show-all)
15836 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15837 When PREFER is `past', return a date that is either CURRENT or past.
15838 When PREFER is `future', return a date that is either CURRENT or future.
15839 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15840 ;; Make the proper lists from the dates
15841 (catch 'exit
15842 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15843 dn dw sday cday n1 n2 n0
15844 d m y y1 y2 date1 date2 nmonths nm ny m2)
15846 (setq start (org-date-to-gregorian start)
15847 current (org-date-to-gregorian
15848 (if show-all
15849 current
15850 (time-to-days (current-time))))
15851 sday (calendar-absolute-from-gregorian start)
15852 cday (calendar-absolute-from-gregorian current))
15854 (if (<= cday sday) (throw 'exit sday))
15857 (setq dn (string-to-number (match-string 1 change))
15858 dw (cdr (assoc (match-string 2 change) a1)))
15859 (error "Invalid change specifier: %s" change))
15860 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15861 (cond
15862 ((eq dw 'day)
15863 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15864 n2 (+ n1 dn)))
15865 ((eq dw 'year)
15866 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15867 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15868 (setq date1 (list m d y1)
15869 n1 (calendar-absolute-from-gregorian date1)
15870 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15871 n2 (calendar-absolute-from-gregorian date2)))
15872 ((eq dw 'month)
15873 ;; approx number of month between the two dates
15874 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15875 ;; How often does dn fit in there?
15876 (setq d (nth 1 start) m (car start) y (nth 2 start)
15877 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15878 m (+ m nm)
15879 ny (floor (/ m 12))
15880 y (+ y ny)
15881 m (- m (* ny 12)))
15882 (while (> m 12) (setq m (- m 12) y (1+ y)))
15883 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15884 (setq m2 (+ m dn) y2 y)
15885 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15886 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15887 (while (<= n2 cday)
15888 (setq n1 n2 m m2 y y2)
15889 (setq m2 (+ m dn) y2 y)
15890 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15891 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15892 ;; Make sure n1 is the earlier date
15893 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15894 (if show-all
15895 (cond
15896 ((eq prefer 'past) (if (= cday n2) n2 n1))
15897 ((eq prefer 'future) (if (= cday n1) n1 n2))
15898 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15899 (cond
15900 ((eq prefer 'past) (if (= cday n2) n2 n1))
15901 ((eq prefer 'future) (if (= cday n1) n1 n2))
15902 (t (if (= cday n1) n1 n2)))))))
15904 (defun org-date-to-gregorian (date)
15905 "Turn any specification of DATE into a Gregorian date for the calendar."
15906 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15907 ((and (listp date) (= (length date) 3)) date)
15908 ((stringp date)
15909 (setq date (org-parse-time-string date))
15910 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15911 ((listp date)
15912 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15914 (defun org-parse-time-string (s &optional nodefault)
15915 "Parse the standard Org-mode time string.
15916 This should be a lot faster than the normal `parse-time-string'.
15917 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15918 hour and minute fields will be nil if not given."
15919 (if (string-match org-ts-regexp0 s)
15920 (list 0
15921 (if (or (match-beginning 8) (not nodefault))
15922 (string-to-number (or (match-string 8 s) "0")))
15923 (if (or (match-beginning 7) (not nodefault))
15924 (string-to-number (or (match-string 7 s) "0")))
15925 (string-to-number (match-string 4 s))
15926 (string-to-number (match-string 3 s))
15927 (string-to-number (match-string 2 s))
15928 nil nil nil)
15929 (error "Not a standard Org-mode time string: %s" s)))
15931 (defun org-timestamp-up (&optional arg)
15932 "Increase the date item at the cursor by one.
15933 If the cursor is on the year, change the year. If it is on the month,
15934 the day or the time, change that.
15935 With prefix ARG, change by that many units."
15936 (interactive "p")
15937 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15939 (defun org-timestamp-down (&optional arg)
15940 "Decrease the date item at the cursor by one.
15941 If the cursor is on the year, change the year. If it is on the month,
15942 the day or the time, change that.
15943 With prefix ARG, change by that many units."
15944 (interactive "p")
15945 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15947 (defun org-timestamp-up-day (&optional arg)
15948 "Increase the date in the time stamp by one day.
15949 With prefix ARG, change that many days."
15950 (interactive "p")
15951 (if (and (not (org-at-timestamp-p t))
15952 (org-at-heading-p))
15953 (org-todo 'up)
15954 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15956 (defun org-timestamp-down-day (&optional arg)
15957 "Decrease the date in the time stamp by one day.
15958 With prefix ARG, change that many days."
15959 (interactive "p")
15960 (if (and (not (org-at-timestamp-p t))
15961 (org-at-heading-p))
15962 (org-todo 'down)
15963 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15965 (defun org-at-timestamp-p (&optional inactive-ok)
15966 "Determine if the cursor is in or at a timestamp."
15967 (interactive)
15968 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15969 (pos (point))
15970 (ans (or (looking-at tsr)
15971 (save-excursion
15973 (if (> (point) (point-min)) (backward-char 1))
15974 (and (looking-at tsr)
15975 (> (- (match-end 0) pos) -1))))))
15976 (and ans
15977 (boundp 'org-ts-what)
15978 (setq org-ts-what
15979 (cond
15980 ((= pos (match-beginning 0)) 'bracket)
15981 ;; Point is considered to be "on the bracket" whether
15982 ;; it's really on it or right after it.
15983 ((or (= pos (1- (match-end 0)))
15984 (= pos (match-end 0))) 'bracket)
15985 ((org-pos-in-match-range pos 2) 'year)
15986 ((org-pos-in-match-range pos 3) 'month)
15987 ((org-pos-in-match-range pos 7) 'hour)
15988 ((org-pos-in-match-range pos 8) 'minute)
15989 ((or (org-pos-in-match-range pos 4)
15990 (org-pos-in-match-range pos 5)) 'day)
15991 ((and (> pos (or (match-end 8) (match-end 5)))
15992 (< pos (match-end 0)))
15993 (- pos (or (match-end 8) (match-end 5))))
15994 (t 'day))))
15995 ans))
15997 (defun org-toggle-timestamp-type ()
15998 "Toggle the type (<active> or [inactive]) of a time stamp."
15999 (interactive)
16000 (when (org-at-timestamp-p t)
16001 (let ((beg (match-beginning 0)) (end (match-end 0))
16002 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
16003 (save-excursion
16004 (goto-char beg)
16005 (while (re-search-forward "[][<>]" end t)
16006 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
16007 t t)))
16008 (message "Timestamp is now %sactive"
16009 (if (equal (char-after beg) ?<) "" "in")))))
16011 (defun org-timestamp-change (n &optional what updown)
16012 "Change the date in the time stamp at point.
16013 The date will be changed by N times WHAT. WHAT can be `day', `month',
16014 `year', `minute', `second'. If WHAT is not given, the cursor position
16015 in the timestamp determines what will be changed."
16016 (let ((origin (point)) origin-cat
16017 with-hm inactive
16018 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
16019 org-ts-what
16020 extra rem
16021 ts time time0)
16022 (if (not (org-at-timestamp-p t))
16023 (error "Not at a timestamp"))
16024 (if (and (not what) (eq org-ts-what 'bracket))
16025 (org-toggle-timestamp-type)
16026 ;; Point isn't on brackets. Remember the part of the time-stamp
16027 ;; the point was in. Indeed, size of time-stamps may change,
16028 ;; but point must be kept in the same category nonetheless.
16029 (setq origin-cat org-ts-what)
16030 (if (and (not what) (not (eq org-ts-what 'day))
16031 org-display-custom-times
16032 (get-text-property (point) 'display)
16033 (not (get-text-property (1- (point)) 'display)))
16034 (setq org-ts-what 'day))
16035 (setq org-ts-what (or what org-ts-what)
16036 inactive (= (char-after (match-beginning 0)) ?\[)
16037 ts (match-string 0))
16038 (replace-match "")
16039 (if (string-match
16041 ts)
16042 (setq extra (match-string 1 ts)))
16044 (setq with-hm t))
16045 (setq time0 (org-parse-time-string ts))
16046 (when (and updown
16047 (eq org-ts-what 'minute)
16048 (not current-prefix-arg))
16049 ;; This looks like s-up and s-down. Change by one rounding step.
16050 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
16051 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
16052 (setcar (cdr time0) (+ (nth 1 time0)
16053 (if (> n 0) (- rem) (- dm rem))))))
16054 (setq time
16055 (encode-time (or (car time0) 0)
16056 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16057 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16058 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16059 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16060 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16061 (nthcdr 6 time0)))
16062 (when (and (member org-ts-what '(hour minute))
16063 extra
16065 (setq extra (org-modify-ts-extra
16066 extra
16067 (if (eq org-ts-what 'hour) 2 5)
16068 n dm)))
16069 (when (integerp org-ts-what)
16070 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16071 (if (eq what 'calendar)
16072 (let ((cal-date (org-get-date-from-calendar)))
16073 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16074 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16075 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16076 (setcar time0 (or (car time0) 0))
16077 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16078 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16079 (setq time (apply 'encode-time time0))))
16080 ;; Insert the new time-stamp, and ensure point stays in the same
16081 ;; category as before (i.e. not after the last position in that
16082 ;; category).
16083 (let ((pos (point)))
16084 ;; Stay before inserted string. `save-excursion' is of no use.
16085 (setq org-last-changed-timestamp
16086 (org-insert-time-stamp time with-hm inactive nil nil extra))
16087 (goto-char pos))
16088 (save-match-data
16089 (looking-at org-ts-regexp3)
16090 (goto-char (cond
16091 ;; `day' category ends before `hour' if any, or at
16092 ;; the end of the day name.
16093 ((eq origin-cat 'day)
16094 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16095 ((eq origin-cat 'hour) (min (match-end 7) origin))
16096 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16097 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16098 ;; `year' and `month' have both fixed size: point
16099 ;; couldn't have moved into another part.
16100 (t origin))))
16101 ;; Update clock if on a CLOCK line.
16102 (org-clock-update-time-maybe)
16103 ;; Try to recenter the calendar window, if any.
16104 (if (and org-calendar-follow-timestamp-change
16105 (get-buffer-window "*Calendar*" t)
16106 (memq org-ts-what '(day month year)))
16107 (org-recenter-calendar (time-to-days time))))))
16109 (defun org-modify-ts-extra (s pos n dm)
16110 "Change the different parts of the lead-time and repeat fields in timestamp."
16111 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16112 ng h m new rem)
16113 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16114 (cond
16115 ((or (org-pos-in-match-range pos 2)
16116 (org-pos-in-match-range pos 3))
16117 (setq m (string-to-number (match-string 3 s))
16118 h (string-to-number (match-string 2 s)))
16119 (if (org-pos-in-match-range pos 2)
16120 (setq h (+ h n))
16121 (setq n (* dm (org-no-warnings (signum n))))
16122 (when (not (= 0 (setq rem (% m dm))))
16123 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16124 (setq m (+ m n)))
16125 (if (< m 0) (setq m (+ m 60) h (1- h)))
16126 (if (> m 59) (setq m (- m 60) h (1+ h)))
16127 (setq h (min 24 (max 0 h)))
16128 (setq ng 1 new (format "-%02d:%02d" h m)))
16129 ((org-pos-in-match-range pos 6)
16130 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16131 ((org-pos-in-match-range pos 5)
16132 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16134 ((org-pos-in-match-range pos 9)
16135 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16136 ((org-pos-in-match-range pos 8)
16137 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16139 (when ng
16140 (setq s (concat
16141 (substring s 0 (match-beginning ng))
16142 new
16143 (substring s (match-end ng))))))
16144 s))
16146 (defun org-recenter-calendar (date)
16147 "If the calendar is visible, recenter it to DATE."
16148 (let* ((win (selected-window))
16149 (cwin (get-buffer-window "*Calendar*" t))
16150 (calendar-move-hook nil))
16151 (when cwin
16152 (select-window cwin)
16153 (calendar-goto-date (if (listp date) date
16154 (calendar-gregorian-from-absolute date)))
16155 (select-window win))))
16157 (defun org-goto-calendar (&optional arg)
16158 "Go to the Emacs calendar at the current date.
16159 If there is a time stamp in the current line, go to that date.
16160 A prefix ARG can be used to force the current date."
16161 (interactive "P")
16162 (let ((tsr org-ts-regexp) diff
16163 (calendar-move-hook nil)
16164 (calendar-view-holidays-initially-flag nil)
16165 (calendar-view-diary-initially-flag nil))
16166 (if (or (org-at-timestamp-p)
16167 (save-excursion
16168 (beginning-of-line 1)
16169 (looking-at (concat ".*" tsr))))
16170 (let ((d1 (time-to-days (current-time)))
16171 (d2 (time-to-days
16172 (org-time-string-to-time (match-string 1)))))
16173 (setq diff (- d2 d1))))
16174 (calendar)
16175 (calendar-goto-today)
16176 (if (and diff (not arg)) (calendar-forward-day diff))))
16178 (defun org-get-date-from-calendar ()
16179 "Return a list (month day year) of date at point in calendar."
16180 (with-current-buffer "*Calendar*"
16181 (save-match-data
16182 (calendar-cursor-to-date))))
16184 (defun org-date-from-calendar ()
16185 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16186 If there is already a time stamp at the cursor position, update it."
16187 (interactive)
16188 (if (org-at-timestamp-p t)
16189 (org-timestamp-change 0 'calendar)
16190 (let ((cal-date (org-get-date-from-calendar)))
16191 (org-insert-time-stamp
16192 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16194 (defun org-minutes-to-hh:mm-string (m)
16195 "Compute H:MM from a number of minutes."
16196 (let ((h (/ m 60)))
16197 (setq m (- m (* 60 h)))
16198 (format org-time-clocksum-format h m)))
16200 (defun org-hh:mm-string-to-minutes (s)
16201 "Convert a string H:MM to a number of minutes.
16202 If the string is just a number, interpret it as minutes.
16203 In fact, the first hh:mm or number in the string will be taken,
16204 there can be extra stuff in the string.
16205 If no number is found, the return value is 0."
16206 (cond
16207 ((integerp s) s)
16209 (+ (* (string-to-number (match-string 1 s)) 60)
16210 (string-to-number (match-string 2 s))))
16212 (string-to-number (match-string 1 s)))
16213 (t 0)))
16215 (defcustom org-effort-durations
16216 `(("h" . 60)
16217 ("d" . ,(* 60 8))
16218 ("w" . ,(* 60 8 5))
16219 ("m" . ,(* 60 8 5 4))
16220 ("y" . ,(* 60 8 5 40)))
16221 "Conversion factor to minutes for an effort modifier.
16223 Each entry has the form (MODIFIER . MINUTES).
16225 In an effort string, a number followed by MODIFIER is multiplied
16226 by the specified number of MINUTES to obtain an effort in
16227 minutes.
16231 :group 'org-agenda
16232 :type '(alist :key-type (string :tag "Modifier")
16233 :value-type (number :tag "Minutes")))
16235 (defun org-duration-string-to-minutes (s)
16236 "Convert a duration string S to minutes.
16238 A bare number is interpreted as minutes, modifiers can be set by
16239 customizing `org-effort-durations' (which see).
16241 Entries containing a colon are interpreted as H:MM by
16242 `org-hh:mm-string-to-minutes'."
16243 (let ((result 0)
16245 (regexp-opt (mapcar 'car org-effort-durations))
16247 (while (string-match re s)
16248 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16249 (string-to-number (match-string 1 s))))
16250 (setq s (replace-match "" nil t s)))
16251 (incf result (org-hh:mm-string-to-minutes s))
16252 result))
16254 ;;;; Files
16256 (defun org-save-all-org-buffers ()
16257 "Save all Org-mode buffers without user confirmation."
16258 (interactive)
16259 (message "Saving all Org-mode buffers...")
16260 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16261 (when (featurep 'org-id) (org-id-locations-save))
16262 (message "Saving all Org-mode buffers... done"))
16264 (defun org-revert-all-org-buffers ()
16265 "Revert all Org-mode buffers.
16266 Prompt for confirmation when there are unsaved changes.
16267 Be sure you know what you are doing before letting this function
16268 overwrite your changes.
16270 This function is useful in a setup where one tracks org files
16271 with a version control system, to revert on one machine after pulling
16272 changes from another. I believe the procedure must be like this:
16274 1. M-x org-save-all-org-buffers
16275 2. Pull changes from the other machine, resolve conflicts
16276 3. M-x org-revert-all-org-buffers"
16277 (interactive)
16278 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16279 (error "Abort"))
16280 (save-excursion
16281 (save-window-excursion
16282 (mapc
16283 (lambda (b)
16284 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16285 (with-current-buffer b buffer-file-name))
16286 (org-pop-to-buffer-same-window b)
16287 (revert-buffer t 'no-confirm)))
16288 (buffer-list))
16289 (when (and (featurep 'org-id) org-id-track-globally)
16290 (org-id-locations-load)))))
16292 ;;;; Agenda files
16294 ;;;###autoload
16295 (defun org-switchb (&optional arg)
16296 "Switch between Org buffers.
16297 With one prefix argument, restrict available buffers to files.
16298 With two prefix arguments, restrict available buffers to agenda files.
16300 Defaults to `iswitchb' for buffer name completion.
16301 Set `org-completion-use-ido' to make it use ido instead."
16302 (interactive "P")
16303 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16304 ((equal arg '(16)) (org-buffer-list 'agenda))
16305 (t (org-buffer-list))))
16306 (org-completion-use-iswitchb org-completion-use-iswitchb)
16307 (org-completion-use-ido org-completion-use-ido))
16308 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16309 (setq org-completion-use-iswitchb t))
16310 (org-pop-to-buffer-same-window
16311 (org-icompleting-read "Org buffer: "
16312 (mapcar 'list (mapcar 'buffer-name blist))
16313 nil t))))
16315 ;;; Define some older names previously used for this functionality
16316 ;;;###autoload
16317 (defalias 'org-ido-switchb 'org-switchb)
16318 ;;;###autoload
16319 (defalias 'org-iswitchb 'org-switchb)
16321 (defun org-buffer-list (&optional predicate exclude-tmp)
16322 "Return a list of Org buffers.
16323 PREDICATE can be `export', `files' or `agenda'.
16325 export restrict the list to Export buffers.
16326 files restrict the list to buffers visiting Org files.
16327 agenda restrict the list to buffers visiting agenda files.
16329 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16330 (let* ((bfn nil)
16331 (agenda-files (and (eq predicate 'agenda)
16332 (mapcar 'file-truename (org-agenda-files t))))
16333 (filter
16334 (cond
16335 ((eq predicate 'files)
16336 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16337 ((eq predicate 'export)
16338 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16339 ((eq predicate 'agenda)
16340 (lambda (b)
16341 (with-current-buffer b
16342 (and (eq major-mode 'org-mode)
16343 (setq bfn (buffer-file-name b))
16344 (member (file-truename bfn) agenda-files)))))
16345 (t (lambda (b) (with-current-buffer b
16346 (or (eq major-mode 'org-mode)
16347 (string-match "\*Org .*Export"
16348 (buffer-name b)))))))))
16349 (delq nil
16350 (mapcar
16351 (lambda(b)
16352 (if (and (funcall filter b)
16353 (or (not exclude-tmp)
16354 (not (string-match "tmp" (buffer-name b)))))
16355 b
16356 nil))
16357 (buffer-list)))))
16359 (defun org-agenda-files (&optional unrestricted archives)
16360 "Get the list of agenda files.
16361 Optional UNRESTRICTED means return the full list even if a restriction
16362 is currently in place.
16363 When ARCHIVES is t, include all archive files that are really being
16364 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16365 `org-agenda-archives-mode' is t."
16366 (let ((files
16367 (cond
16368 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16369 ((stringp org-agenda-files) (org-read-agenda-file-list))
16370 ((listp org-agenda-files) org-agenda-files)
16371 (t (error "Invalid value of `org-agenda-files'")))))
16372 (setq files (apply 'append
16373 (mapcar (lambda (f)
16374 (if (file-directory-p f)
16375 (directory-files
16376 f t org-agenda-file-regexp)
16377 (list f)))
16378 files)))
16379 (when org-agenda-skip-unavailable-files
16380 (setq files (delq nil
16381 (mapcar (function
16382 (lambda (file)
16383 (and (file-readable-p file) file)))
16384 files))))
16385 (when (or (eq archives t)
16386 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16387 (setq files (org-add-archive-files files)))
16388 files))
16390 (defun org-agenda-file-p (&optional file)
16391 "Return non-nil, if FILE is an agenda file.
16392 If FILE is omitted, use the file associated with the current
16393 buffer."
16394 (member (or file (buffer-file-name))
16395 (org-agenda-files t)))
16397 (defun org-edit-agenda-file-list ()
16398 "Edit the list of agenda files.
16399 Depending on setup, this either uses customize to edit the variable
16400 `org-agenda-files', or it visits the file that is holding the list. In the
16401 latter case, the buffer is set up in a way that saving it automatically kills
16402 the buffer and restores the previous window configuration."
16403 (interactive)
16404 (if (stringp org-agenda-files)
16405 (let ((cw (current-window-configuration)))
16406 (find-file org-agenda-files)
16407 (org-set-local 'org-window-configuration cw)
16408 (org-add-hook 'after-save-hook
16409 (lambda ()
16410 (set-window-configuration
16411 (prog1 org-window-configuration
16412 (kill-buffer (current-buffer))))
16413 (org-install-agenda-files-menu)
16414 (message "New agenda file list installed"))
16415 nil 'local)
16416 (message "%s" (substitute-command-keys
16418 (customize-variable 'org-agenda-files)))
16420 (defun org-store-new-agenda-file-list (list)
16421 "Set new value for the agenda file list and save it correctly."
16422 (if (stringp org-agenda-files)
16423 (let ((fe (org-read-agenda-file-list t)) b u)
16424 (while (setq b (find-buffer-visiting org-agenda-files))
16425 (kill-buffer b))
16426 (with-temp-file org-agenda-files
16427 (insert
16428 (mapconcat
16429 (lambda (f) ;; Keep un-expanded entries.
16430 (if (setq u (assoc f fe))
16431 (cdr u)
16432 f))
16435 (let ((org-mode-hook nil) (org-inhibit-startup t)
16436 (org-insert-mode-line-in-empty-file nil))
16437 (setq org-agenda-files list)
16438 (customize-save-variable 'org-agenda-files org-agenda-files))))
16440 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16441 "Read the list of agenda files from a file.
16442 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16443 filenames, used by `org-store-new-agenda-file-list' to write back
16444 un-expanded file names."
16445 (when (file-directory-p org-agenda-files)
16446 (error "`org-agenda-files' cannot be a single directory"))
16447 (when (stringp org-agenda-files)
16448 (with-temp-buffer
16449 (insert-file-contents org-agenda-files)
16450 (mapcar
16451 (lambda (f)
16452 (let ((e (expand-file-name (substitute-in-file-name f)
16453 org-directory)))
16454 (if pair-with-expansion
16455 (cons e f)
16456 e)))
16459 ;;;###autoload
16460 (defun org-cycle-agenda-files ()
16461 "Cycle through the files in `org-agenda-files'.
16462 If the current buffer visits an agenda file, find the next one in the list.
16463 If the current buffer does not, find the first agenda file."
16464 (interactive)
16465 (let* ((fs (org-agenda-files t))
16466 (files (append fs (list (car fs))))
16467 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16468 file)
16469 (unless files (error "No agenda files"))
16470 (catch 'exit
16471 (while (setq file (pop files))
16472 (if (equal (file-truename file) tcf)
16473 (when (car files)
16474 (find-file (car files))
16475 (throw 'exit t))))
16476 (find-file (car fs)))
16477 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16479 (defun org-agenda-file-to-front (&optional to-end)
16480 "Move/add the current file to the top of the agenda file list.
16481 If the file is not present in the list, it is added to the front. If it is
16482 present, it is moved there. With optional argument TO-END, add/move to the
16483 end of the list."
16484 (interactive "P")
16485 (let ((org-agenda-skip-unavailable-files nil)
16486 (file-alist (mapcar (lambda (x)
16487 (cons (file-truename x) x))
16488 (org-agenda-files t)))
16489 (ctf (file-truename buffer-file-name))
16490 x had)
16491 (setq x (assoc ctf file-alist) had x)
16493 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16494 (if to-end
16495 (setq file-alist (append (delq x file-alist) (list x)))
16496 (setq file-alist (cons x (delq x file-alist))))
16497 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16498 (org-install-agenda-files-menu)
16499 (message "File %s to %s of agenda file list"
16500 (if had "moved" "added") (if to-end "end" "front"))))
16502 (defun org-remove-file (&optional file)
16503 "Remove current file from the list of files in variable `org-agenda-files'.
16504 These are the files which are being checked for agenda entries.
16505 Optional argument FILE means use this file instead of the current."
16506 (interactive)
16507 (let* ((org-agenda-skip-unavailable-files nil)
16508 (file (or file buffer-file-name))
16509 (true-file (file-truename file))
16510 (afile (abbreviate-file-name file))
16511 (files (delq nil (mapcar
16512 (lambda (x)
16513 (if (equal true-file
16514 (file-truename x))
16515 nil x))
16516 (org-agenda-files t)))))
16517 (if (not (= (length files) (length (org-agenda-files t))))
16518 (progn
16519 (org-store-new-agenda-file-list files)
16520 (org-install-agenda-files-menu)
16521 (message "Removed file: %s" afile))
16522 (message "File was not in list: %s (not removed)" afile))))
16524 (defun org-file-menu-entry (file)
16525 (vector file (list 'find-file file) t))
16527 (defun org-check-agenda-file (file)
16528 "Make sure FILE exists. If not, ask user what to do."
16529 (when (not (file-exists-p file))
16530 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16531 (abbreviate-file-name file))
16532 (let ((r (downcase (read-char-exclusive))))
16533 (cond
16534 ((equal r ?r)
16535 (org-remove-file file)
16536 (throw 'nextfile t))
16537 (t (error "Abort"))))))
16539 (defun org-get-agenda-file-buffer (file)
16540 "Get a buffer visiting FILE. If the buffer needs to be created, add
16541 it to the list of buffers which might be released later."
16542 (let ((buf (org-find-base-buffer-visiting file)))
16543 (if buf
16544 buf ; just return it
16545 ;; Make a new buffer and remember it
16546 (setq buf (find-file-noselect file))
16547 (if buf (push buf org-agenda-new-buffers))
16548 buf)))
16550 (defun org-release-buffers (blist)
16551 "Release all buffers in list, asking the user for confirmation when needed.
16552 When a buffer is unmodified, it is just killed. When modified, it is saved
16553 \(if the user agrees) and then killed."
16554 (let (buf file)
16555 (while (setq buf (pop blist))
16556 (setq file (buffer-file-name buf))
16557 (when (and (buffer-modified-p buf)
16558 file
16559 (y-or-n-p (format "Save file %s? " file)))
16560 (with-current-buffer buf (save-buffer)))
16561 (kill-buffer buf))))
16563 (defun org-prepare-agenda-buffers (files)
16564 "Create buffers for all agenda files, protect archived trees and comments."
16565 (interactive)
16566 (let ((pa '(:org-archived t))
16567 (pc '(:org-comment t))
16568 (pall '(:org-archived t :org-comment t))
16569 (inhibit-read-only t)
16570 (rea (concat ":" org-archive-tag ":"))
16571 bmp file re)
16572 (save-excursion
16573 (save-restriction
16574 (while (setq file (pop files))
16575 (catch 'nextfile
16576 (if (bufferp file)
16577 (set-buffer file)
16578 (org-check-agenda-file file)
16579 (set-buffer (org-get-agenda-file-buffer file)))
16580 (widen)
16581 (setq bmp (buffer-modified-p))
16582 (org-refresh-category-properties)
16583 (setq org-todo-keywords-for-agenda
16584 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16585 (setq org-done-keywords-for-agenda
16586 (append org-done-keywords-for-agenda org-done-keywords))
16587 (setq org-todo-keyword-alist-for-agenda
16588 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16589 (setq org-drawers-for-agenda
16590 (append org-drawers-for-agenda org-drawers))
16591 (setq org-tag-alist-for-agenda
16592 (append org-tag-alist-for-agenda org-tag-alist))
16594 (save-excursion
16595 (remove-text-properties (point-min) (point-max) pall)
16596 (when org-agenda-skip-archived-trees
16597 (goto-char (point-min))
16598 (while (re-search-forward rea nil t)
16599 (if (org-at-heading-p t)
16600 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16601 (goto-char (point-min))
16602 (setq re (format org-heading-keyword-regexp-format
16603 org-comment-string))
16604 (while (re-search-forward re nil t)
16605 (add-text-properties
16606 (match-beginning 0) (org-end-of-subtree t) pc)))
16607 (set-buffer-modified-p bmp)))))
16608 (setq org-todo-keywords-for-agenda
16609 (org-uniquify org-todo-keywords-for-agenda))
16610 (setq org-todo-keyword-alist-for-agenda
16611 (org-uniquify org-todo-keyword-alist-for-agenda)
16612 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16614 ;;;; Embedded LaTeX
16616 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16617 "Keymap for the minor `org-cdlatex-mode'.")
16619 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16620 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16621 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16622 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16623 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16625 (defvar org-cdlatex-texmathp-advice-is-done nil
16626 "Flag remembering if we have applied the advice to texmathp already.")
16628 (define-minor-mode org-cdlatex-mode
16629 "Toggle the minor `org-cdlatex-mode'.
16630 This mode supports entering LaTeX environment and math in LaTeX fragments
16631 in Org-mode.
16633 nil " OCDL" nil
16634 (when org-cdlatex-mode
16635 (require 'cdlatex)
16636 (run-hooks 'cdlatex-mode-hook)
16637 (cdlatex-compute-tables))
16638 (unless org-cdlatex-texmathp-advice-is-done
16639 (setq org-cdlatex-texmathp-advice-is-done t)
16640 (defadvice texmathp (around org-math-always-on activate)
16641 "Always return t in org-mode buffers.
16642 This is because we want to insert math symbols without dollars even outside
16643 the LaTeX math segments. If Orgmode thinks that point is actually inside
16644 an embedded LaTeX fragment, let texmathp do its job.
16646 (interactive)
16647 (let (p)
16648 (cond
16649 ((not (eq major-mode 'org-mode)) ad-do-it)
16650 ((eq this-command 'cdlatex-math-symbol)
16651 (setq ad-return-value t
16652 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16653 (t
16654 (let ((p (org-inside-LaTeX-fragment-p)))
16655 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16656 (setq ad-return-value t
16657 texmathp-why '("Org-mode embedded math" . 0))
16658 (if p ad-do-it)))))))))
16660 (defun turn-on-org-cdlatex ()
16661 "Unconditionally turn on `org-cdlatex-mode'."
16662 (org-cdlatex-mode 1))
16664 (defun org-inside-LaTeX-fragment-p ()
16665 "Test if point is inside a LaTeX fragment.
16667 sequence appearing also before point.
16668 Even though the matchers for math are configurable, this function assumes
16670 delimiters are skipped when they have been removed by customization.
16671 The return value is nil, or a cons cell with the delimiter and the
16672 position of this delimiter.
16674 This function does a reasonably good job, but can locally be fooled by
16675 for example currency specifications. For example it will assume being in
16677 fragments that are properly closed, but during editing, we have to live
16678 with the uncertainty caused by missing closing delimiters. This function
16679 looks only before point, not after."
16680 (catch 'exit
16681 (let ((pos (point))
16682 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16683 (lim (progn
16685 (point)))
16686 dd-on str (start 0) m re)
16687 (goto-char pos)
16688 (when dodollar
16690 re (nth 1 (assoc "$" org-latex-regexps)))
16691 (while (string-match re str start)
16692 (cond
16693 ((= (match-end 0) (length str))
16694 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16695 ((= (match-end 0) (- (length str) 5))
16696 (throw 'exit nil))
16697 (t (setq start (match-end 0))))))
16698 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16699 (goto-char pos)
16700 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16701 (and (match-beginning 2) (throw 'exit nil))
16702 ;; count $$
16704 (setq dd-on (not dd-on)))
16705 (goto-char pos)
16706 (if dd-on (cons "$$" m))))))
16708 (defun org-inside-latex-macro-p ()
16709 "Is point inside a LaTeX macro or its arguments?"
16710 (save-match-data
16711 (org-in-regexp
16714 (defun org-try-cdlatex-tab ()
16715 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16716 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16717 - inside a LaTeX fragment, or
16718 - after the first word in a line, where an abbreviation expansion could
16719 insert a LaTeX environment."
16720 (when org-cdlatex-mode
16721 (cond
16722 ;; Before any word on the line: No expansion possible.
16724 ;; Just after first word on the line: Expand it. Make sure it
16725 ;; cannot happen on headlines, though.
16726 ((save-excursion
16727 (skip-chars-backward "a-zA-Z0-9*")
16729 (and (bolp) (not (org-at-heading-p))))
16730 (cdlatex-tab) t)
16731 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16733 (defun org-cdlatex-underscore-caret (&optional arg)
16734 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16735 Revert to the normal definition outside of these fragments."
16736 (interactive "P")
16737 (if (org-inside-LaTeX-fragment-p)
16738 (call-interactively 'cdlatex-sub-superscript)
16739 (let (org-cdlatex-mode)
16740 (call-interactively (key-binding (vector last-input-event))))))
16742 (defun org-cdlatex-math-modify (&optional arg)
16743 "Execute `cdlatex-math-modify' in LaTeX fragments.
16744 Revert to the normal definition outside of these fragments."
16745 (interactive "P")
16746 (if (org-inside-LaTeX-fragment-p)
16747 (call-interactively 'cdlatex-math-modify)
16748 (let (org-cdlatex-mode)
16749 (call-interactively (key-binding (vector last-input-event))))))
16751 (defvar org-latex-fragment-image-overlays nil
16752 "List of overlays carrying the images of latex fragments.")
16753 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16755 (defun org-remove-latex-fragment-image-overlays ()
16756 "Remove all overlays with LaTeX fragment images in current buffer."
16757 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16758 (setq org-latex-fragment-image-overlays nil))
16760 (defun org-preview-latex-fragment (&optional subtree)
16761 "Preview the LaTeX fragment at point, or all locally or globally.
16762 If the cursor is in a LaTeX fragment, create the image and overlay
16763 it over the source code. If there is no fragment at point, display
16764 all fragments in the current text, from one headline to the next. With
16765 prefix SUBTREE, display all fragments in the current subtree. With a
16767 the cursor is before the first headline,
16768 display all fragments in the buffer.
16770 (interactive "P")
16771 (unless buffer-file-name
16772 (error "Can't preview LaTeX fragment in a non-file buffer"))
16773 (org-remove-latex-fragment-image-overlays)
16774 (save-excursion
16775 (save-restriction
16776 (let (beg end at msg)
16777 (cond
16778 ((or (equal subtree '(16))
16779 (not (save-excursion
16780 (re-search-backward org-outline-regexp-bol nil t))))
16781 (setq beg (point-min) end (point-max)
16782 msg "Creating images for buffer...%s"))
16783 ((equal subtree '(4))
16784 (org-back-to-heading)
16785 (setq beg (point) end (org-end-of-subtree t)
16786 msg "Creating images for subtree...%s"))
16787 (t
16788 (if (setq at (org-inside-LaTeX-fragment-p))
16789 (goto-char (max (point-min) (- (cdr at) 2)))
16790 (org-back-to-heading))
16791 (setq beg (point) end (progn (outline-next-heading) (point))
16792 msg (if at "Creating image...%s"
16793 "Creating images for entry...%s"))))
16794 (message msg "")
16795 (narrow-to-region beg end)
16796 (goto-char beg)
16797 (org-format-latex
16798 (concat "ltxpng/" (file-name-sans-extension
16799 (file-name-nondirectory
16800 buffer-file-name)))
16801 default-directory 'overlays msg at 'forbuffer 'dvipng)
16802 (message msg "done. Use `C-c C-c' to remove images.")))))
16804 (defvar org-latex-regexps
16806 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16809 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16813 "Regular expressions for matching embedded LaTeX.")
16815 (defvar org-export-have-math nil) ;; dynamic scoping
16816 (defun org-format-latex (prefix &optional dir overlays msg at
16817 forbuffer processing-type)
16818 "Replace LaTeX fragments with links to an image, and produce images.
16819 Some of the options can be changed using the variable
16820 `org-format-latex-options'."
16821 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16822 (let* ((prefixnodir (file-name-nondirectory prefix))
16823 (absprefix (expand-file-name prefix dir))
16824 (todir (file-name-directory absprefix))
16825 (opt org-format-latex-options)
16826 (matchers (plist-get opt :matchers))
16827 (re-list org-latex-regexps)
16828 (org-format-latex-header-extra
16829 (plist-get (org-infile-export-plist) :latex-header-extra))
16830 (cnt 0) txt hash link beg end re e checkdir
16831 executables-checked string
16832 m n block-type block linkfile movefile ov)
16833 ;; Check the different regular expressions
16834 (while (setq e (pop re-list))
16835 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16837 (when (member m matchers)
16838 (goto-char (point-min))
16839 (while (re-search-forward re nil t)
16840 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16841 (not (get-text-property (match-beginning n)
16842 'org-protected))
16843 (or (not overlays)
16844 (not (eq (get-char-property (match-beginning n)
16845 'org-overlay-type)
16846 'org-latex-overlay))))
16847 (setq org-export-have-math t)
16848 (cond
16849 ((eq processing-type 'verbatim)
16850 ;; Leave the text verbatim, just protect it
16851 (add-text-properties (match-beginning n) (match-end n)
16852 '(org-protected t)))
16853 ((eq processing-type 'mathjax)
16854 ;; Prepare for MathJax processing
16855 (setq string (match-string n))
16856 (if (member m '("$" "$1"))
16857 (save-excursion
16858 (delete-region (match-beginning n) (match-end n))
16859 (goto-char (match-beginning n))
16862 '(org-protected t))))
16863 (add-text-properties (match-beginning n) (match-end n)
16864 '(org-protected t))))
16865 ((eq processing-type 'dvipng)
16866 ;; Process to an image
16867 (setq txt (match-string n)
16868 beg (match-beginning n) end (match-end n)
16869 cnt (1+ cnt))
16870 (let (print-length print-level) ; make sure full list is printed
16871 (setq hash (sha1 (prin1-to-string
16872 (list org-format-latex-header
16873 org-format-latex-header-extra
16874 org-export-latex-default-packages-alist
16875 org-export-latex-packages-alist
16876 org-format-latex-options
16877 forbuffer txt)))
16878 linkfile (format "%s_%s.png" prefix hash)
16879 movefile (format "%s_%s.png" absprefix hash)))
16880 (setq link (concat block "[[file:" linkfile "]]" block))
16881 (if msg (message msg cnt))
16882 (goto-char beg)
16883 (unless checkdir ; make sure the directory exists
16884 (setq checkdir t)
16885 (or (file-directory-p todir) (make-directory todir t)))
16887 (unless executables-checked
16888 (org-check-external-command
16889 "latex" "needed to convert LaTeX fragments to images")
16890 (org-check-external-command
16891 "dvipng" "needed to convert LaTeX fragments to images")
16892 (setq executables-checked t))
16894 (unless (file-exists-p movefile)
16895 (org-create-formula-image
16896 txt movefile opt forbuffer))
16897 (if overlays
16898 (progn
16899 (mapc (lambda (o)
16900 (if (eq (overlay-get o 'org-overlay-type)
16901 'org-latex-overlay)
16902 (delete-overlay o)))
16903 (overlays-in beg end))
16904 (setq ov (make-overlay beg end))
16905 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16906 (if (featurep 'xemacs)
16907 (progn
16908 (overlay-put ov 'invisible t)
16909 (overlay-put
16910 ov 'end-glyph
16911 (make-glyph (vector 'png :file movefile))))
16912 (overlay-put
16913 ov 'display
16914 (list 'image :type 'png :file movefile :ascent 'center)))
16915 (push ov org-latex-fragment-image-overlays)
16916 (goto-char end))
16917 (delete-region beg end)
16918 (insert (org-add-props link
16919 (list 'org-latex-src
16920 (replace-regexp-in-string
16922 'org-latex-src-embed-type
16923 (if block-type 'paragraph 'character))))))
16924 ((eq processing-type 'mathml)
16925 ;; Process to MathML
16926 (unless executables-checked
16927 (unless (save-match-data (org-format-latex-mathml-available-p))
16928 (error "LaTeX to MathML converter not configured"))
16929 (setq executables-checked t))
16930 (setq txt (match-string n)
16931 beg (match-beginning n) end (match-end n)
16932 cnt (1+ cnt))
16933 (if msg (message msg cnt))
16934 (goto-char beg)
16935 (delete-region beg end)
16936 (insert (org-format-latex-as-mathml
16937 txt block-type prefix dir)))
16938 (t
16939 (error "Unknown conversion type %s for latex fragments"
16940 processing-type)))))))))
16942 (defun org-create-math-formula (latex-frag &optional mathml-file)
16943 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16944 Use `org-latex-to-mathml-convert-command'. If the conversion is
16946 elements otherwise return nil. When MATHML-FILE is specified,
16947 write the results in to that file. When invoked as an
16948 interactive command, prompt for LATEX-FRAG, with initial value
16949 set to the current active region and echo the results for user
16950 inspection."
16951 (interactive (list (let ((frag (when (region-active-p)
16952 (buffer-substring-no-properties
16953 (region-beginning) (region-end)))))
16954 (read-string "LaTeX Fragment: " frag nil frag))))
16955 (unless latex-frag (error "Invalid latex-frag"))
16956 (let* ((tmp-in-file (file-relative-name
16957 (make-temp-name (expand-file-name "ltxmathml-in"))))
16958 (ignore (write-region latex-frag nil tmp-in-file))
16959 (tmp-out-file (file-relative-name
16960 (make-temp-name (expand-file-name "ltxmathml-out"))))
16961 (cmd (format-spec
16962 org-latex-to-mathml-convert-command
16963 `((?j . ,(shell-quote-argument
16964 (expand-file-name org-latex-to-mathml-jar-file)))
16965 (?I . ,(shell-quote-argument tmp-in-file))
16966 (?o . ,(shell-quote-argument tmp-out-file)))))
16967 mathml shell-command-output)
16968 (when (org-called-interactively-p 'any)
16969 (unless (org-format-latex-mathml-available-p)
16970 (error "LaTeX to MathML converter not configured")))
16971 (message "Running %s" cmd)
16972 (setq shell-command-output (shell-command-to-string cmd))
16973 (setq mathml
16974 (when (file-readable-p tmp-out-file)
16975 (with-current-buffer (find-file-noselect tmp-out-file t)
16976 (goto-char (point-min))
16977 (when (re-search-forward
16978 (concat
16979 (regexp-quote
16982 (regexp-quote "</math>")) nil t)
16983 (prog1 (match-string 0) (kill-buffer))))))
16984 (cond
16985 (mathml
16986 (setq mathml
16988 (when mathml-file
16989 (write-region mathml nil mathml-file))
16990 (when (org-called-interactively-p 'any)
16991 (message mathml)))
16992 ((message "LaTeX to MathML conversion failed")
16993 (message shell-command-output)))
16994 (delete-file tmp-in-file)
16995 (when (file-exists-p tmp-out-file)
16996 (delete-file tmp-out-file))
16997 mathml))
16999 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
17000 prefix &optional dir)
17001 "Use `org-create-math-formula' but check local cache first."
17002 (let* ((absprefix (expand-file-name prefix dir))
17003 (print-length nil) (print-level nil)
17004 (formula-id (concat
17005 "formula-"
17006 (sha1
17007 (prin1-to-string
17008 (list latex-frag
17009 org-latex-to-mathml-convert-command)))))
17010 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
17011 (formula-cache-dir (file-name-directory formula-cache)))
17013 (unless (file-directory-p formula-cache-dir)
17014 (make-directory formula-cache-dir t))
17016 (unless (file-exists-p formula-cache)
17017 (org-create-math-formula latex-frag formula-cache))
17019 (if (file-exists-p formula-cache)
17020 ;; Successful conversion. Return the link to MathML file.
17021 (org-add-props
17022 (format "[[file:%s]]" (file-relative-name formula-cache dir))
17024 'org-latex-src-embed-type (if latex-frag-type
17025 'paragraph 'character)))
17026 ;; Failed conversion. Return the LaTeX fragment verbatim
17027 (add-text-properties
17028 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
17029 latex-frag)))
17031 ;; This function borrows from Ganesh Swami's latex2png.el
17032 (defun org-create-formula-image (string tofile options buffer)
17033 "This calls dvipng."
17034 (require 'org-latex)
17035 (let* ((tmpdir (if (featurep 'xemacs)
17036 (temp-directory)
17037 temporary-file-directory))
17038 (texfilebase (make-temp-name
17039 (expand-file-name "orgtex" tmpdir)))
17040 (texfile (concat texfilebase ".tex"))
17041 (dvifile (concat texfilebase ".dvi"))
17042 (pngfile (concat texfilebase ".png"))
17043 (fnh (if (featurep 'xemacs)
17044 (font-height (get-face-font 'default))
17045 (face-attribute 'default :height nil)))
17046 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
17047 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
17048 (fg (or (plist-get options (if buffer :foreground :html-foreground))
17049 "Black"))
17050 (bg (or (plist-get options (if buffer :background :html-background))
17051 "Transparent")))
17052 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
17053 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
17054 (with-temp-file texfile
17055 (insert (org-splice-latex-header
17056 org-format-latex-header
17057 org-export-latex-default-packages-alist
17058 org-export-latex-packages-alist t
17059 org-format-latex-header-extra))
17061 (require 'org-latex)
17062 (org-export-latex-fix-inputenc))
17063 (let ((dir default-directory))
17064 (condition-case nil
17065 (progn
17066 (cd tmpdir)
17067 (call-process "latex" nil nil nil texfile))
17068 (error nil))
17069 (cd dir))
17070 (if (not (file-exists-p dvifile))
17071 (progn (message "Failed to create dvi file from %s" texfile) nil)
17072 (condition-case nil
17073 (call-process "dvipng" nil nil nil
17074 "-fg" fg "-bg" bg
17075 "-D" dpi
17076 ;;"-x" scale "-y" scale
17077 "-T" "tight"
17078 "-o" pngfile
17079 dvifile)
17080 (error nil))
17081 (if (not (file-exists-p pngfile))
17082 (if org-format-latex-signal-error
17083 (error "Failed to create png file from %s" texfile)
17084 (message "Failed to create png file from %s" texfile)
17085 nil)
17086 ;; Use the requested file name and clean up
17087 (copy-file pngfile tofile 'replace)
17088 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17089 (delete-file (concat texfilebase e)))
17090 pngfile))))
17092 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17093 "Fill a LaTeX header template TPL.
17094 In the template, the following place holders will be recognized:
17097 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17099 [NO-PACKAGES] do not include PKG
17100 [EXTRA] the string EXTRA
17101 [NO-EXTRA] do not include EXTRA
17103 For backward compatibility, if both the positive and the negative place
17105 assumed to be present at the end of the template.
17106 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17107 EXTRA is a string.
17108 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17109 (let (rpl (end ""))
17111 (setq rpl (if (or (match-end 1) (not def-pkg))
17112 "" (org-latex-packages-to-string def-pkg snippets-p t))
17113 tpl (replace-match rpl t t tpl))
17114 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17117 (setq rpl (if (or (match-end 1) (not pkg))
17118 "" (org-latex-packages-to-string pkg snippets-p t))
17119 tpl (replace-match rpl t t tpl))
17120 (if pkg (setq end
17122 (org-latex-packages-to-string pkg snippets-p)))))
17125 (setq rpl (if (or (match-end 1) (not extra))
17127 tpl (replace-match rpl t t tpl))
17133 tpl)))
17135 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17137 (setq pkg (mapconcat (lambda(p)
17138 (cond
17139 ((stringp p) p)
17140 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17141 (format "%% Package %s omitted" (cadr p)))
17142 ((equal "" (car p))
17144 (t
17146 (car p) (cadr p)))))
17147 pkg
17151 (defun org-dvipng-color (attr)
17152 "Return an rgb color specification for dvipng."
17153 (apply 'format "rgb %s %s %s"
17154 (mapcar 'org-normalize-color
17155 (color-values (face-attribute 'default attr nil)))))
17157 (defun org-normalize-color (value)
17158 "Return string to be used as color value for an RGB component."
17159 (format "%g" (/ value 65535.0)))
17161 ;; Image display
17164 (defvar org-inline-image-overlays nil)
17165 (make-variable-buffer-local 'org-inline-image-overlays)
17167 (defun org-toggle-inline-images (&optional include-linked)
17168 "Toggle the display of inline images.
17169 INCLUDE-LINKED is passed to `org-display-inline-images'."
17170 (interactive "P")
17171 (if org-inline-image-overlays
17172 (progn
17173 (org-remove-inline-images)
17174 (message "Inline image display turned off"))
17175 (org-display-inline-images include-linked)
17176 (if org-inline-image-overlays
17177 (message "%d images displayed inline"
17178 (length org-inline-image-overlays))
17179 (message "No images to display inline"))))
17181 (defun org-display-inline-images (&optional include-linked refresh beg end)
17182 "Display inline images.
17183 Normally only links without a description part are inlined, because this
17184 is how it will work for export. When INCLUDE-LINKED is set, also links
17185 with a description part will be inlined. This can be nice for a quick
17186 look at those images, but it does not reflect what exported files will look
17187 like.
17188 When REFRESH is set, refresh existing images between BEG and END.
17189 This will create new image displays only if necessary.
17190 BEG and END default to the buffer boundaries."
17191 (interactive "P")
17192 (unless refresh
17193 (org-remove-inline-images)
17194 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17195 (save-excursion
17196 (save-restriction
17197 (widen)
17198 (setq beg (or beg (point-min)) end (or end (point-max)))
17199 (goto-char (point-min))
17201 (substring (org-image-file-name-regexp) 0 -2)
17203 old file ov img)
17204 (while (re-search-forward re end t)
17205 (setq old (get-char-property-and-overlay (match-beginning 1)
17206 'org-image-overlay))
17207 (setq file (expand-file-name
17208 (concat (or (match-string 3) "") (match-string 4))))
17209 (when (file-exists-p file)
17210 (if (and (car-safe old) refresh)
17211 (image-refresh (overlay-get (cdr old) 'display))
17212 (setq img (save-match-data (create-image file)))
17213 (when img
17214 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17215 (overlay-put ov 'display img)
17216 (overlay-put ov 'face 'default)
17217 (overlay-put ov 'org-image-overlay t)
17218 (overlay-put ov 'modification-hooks
17219 (list 'org-display-inline-modification-hook))
17220 (push ov org-inline-image-overlays)))))))))
17222 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17223 "Remove inline-display overlay if a corresponding region is modified."
17224 (let ((inhibit-modification-hooks t))
17225 (when (and ov after)
17226 (delete ov org-inline-image-overlays)
17227 (delete-overlay ov))))
17229 (defun org-remove-inline-images ()
17230 "Remove inline display of images."
17231 (interactive)
17232 (mapc 'delete-overlay org-inline-image-overlays)
17233 (setq org-inline-image-overlays nil))
17235 ;;;; Key bindings
17237 ;; Outline functions from `outline-mode-prefix-map'
17238 ;; that can be remapped in Org:
17239 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17240 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17241 (define-key org-mode-map [remap outline-forward-same-level]
17242 'org-forward-same-level)
17243 (define-key org-mode-map [remap outline-backward-same-level]
17244 'org-backward-same-level)
17245 (define-key org-mode-map [remap show-branches]
17246 'org-kill-note-or-show-branches)
17247 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17248 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17249 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17251 ;; Outline functions from `outline-mode-prefix-map'
17252 ;; that can not be remapped in Org:
17253 ;; - the column "key binding" shows whether the Outline function is still
17254 ;; available in Org mode on the same key that it has been bound to in
17255 ;; Outline mode:
17256 ;; - "overridden": key used for a different functionality in Org mode
17257 ;; - else: key still bound to the same Outline function in Org mode
17258 ;; | Outline function | key binding | Org replacement |
17259 ;; |------------------------------------+-------------+-----------------------|
17260 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17261 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17262 ;; | `show-children' | `C-c C-i' | visibility cycling |
17263 ;; | `hide-subtree' | overridden | visibility cycling |
17264 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17265 ;; | `hide-body' | overridden | no replacement |
17266 ;; | `show-all' | overridden | no replacement |
17267 ;; | `hide-entry' | overridden | visibility cycling |
17268 ;; | `show-entry' | overridden | no replacement |
17269 ;; | `hide-leaves' | overridden | no replacement |
17270 ;; | `hide-sublevels' | overridden | no replacement |
17271 ;; | `hide-other' | overridden | no replacement |
17272 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17273 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17275 ;; Make `C-c C-x' a prefix key
17276 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17278 ;; TAB key with modifiers
17279 (org-defkey org-mode-map "\C-i" 'org-cycle)
17280 (org-defkey org-mode-map [(tab)] 'org-cycle)
17281 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17282 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17284 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17285 ;; The following line is necessary under Suse GNU/Linux
17286 (unless (featurep 'xemacs)
17287 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17288 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17289 (define-key org-mode-map [backtab] 'org-shifttab)
17291 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17292 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17293 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17295 ;; Cursor keys with modifiers
17296 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17297 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17298 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17299 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17301 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17302 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17303 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17304 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17306 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17307 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17308 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17309 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17311 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17312 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17313 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17314 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17316 ;; Babel keys
17317 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17318 (mapc (lambda (pair)
17319 (define-key org-babel-map (car pair) (cdr pair)))
17320 org-babel-key-bindings)
17322 ;;; Extra keys for tty access.
17323 ;; We only set them when really needed because otherwise the
17324 ;; menus don't show the simple keys
17326 (when (or org-use-extra-keys
17327 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17328 (not window-system))
17329 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17330 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17331 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17332 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17333 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17334 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17335 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17336 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17337 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17338 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17339 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17340 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17341 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17342 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17343 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17344 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17345 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17346 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17347 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17348 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17349 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17350 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17351 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17352 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17353 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17354 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17355 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17356 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17358 ;; All the other keys
17360 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17361 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17362 (if (boundp 'narrow-map)
17363 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17364 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17365 (if (boundp 'narrow-map)
17366 (org-defkey narrow-map "b" 'org-narrow-to-block)
17367 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17368 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17369 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17370 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17371 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17372 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17373 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
17374 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17375 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17376 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17377 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17378 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17379 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17380 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17381 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17382 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17383 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17384 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17386 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17387 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17388 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17389 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17390 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17391 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17392 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17393 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17394 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17395 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17396 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17397 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17398 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17399 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17400 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17401 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17402 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17403 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17404 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17405 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17407 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17408 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17409 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17410 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17411 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17412 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17413 (org-defkey org-mode-map "\C-c^" 'org-sort)
17414 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17415 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17416 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17417 (org-defkey org-mode-map "\C-m" 'org-return)
17418 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17419 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17420 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17421 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17422 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17423 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17424 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17425 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17426 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17427 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17428 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17429 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17430 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17431 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17432 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17433 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17434 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17435 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17436 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17437 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17438 (org-defkey org-mode-map "\C-c\C-@" 'org-mark-list)
17439 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17440 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17442 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17443 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17444 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17445 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17447 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17448 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17449 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17450 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17451 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17452 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17453 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17454 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17455 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17456 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17458 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17459 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17460 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17461 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17462 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17463 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17464 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17466 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17467 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17468 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17469 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17470 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17472 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17474 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17476 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17477 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17479 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17482 (when (featurep 'xemacs)
17483 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17486 (defconst org-speed-commands-default
17487 '(
17488 ("Outline Navigation")
17489 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17490 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17491 ("f" . (org-speed-move-safe 'org-forward-same-level))
17492 ("b" . (org-speed-move-safe 'org-backward-same-level))
17493 ("u" . (org-speed-move-safe 'outline-up-heading))
17494 ("j" . org-goto)
17495 ("g" . (org-refile t))
17496 ("Outline Visibility")
17497 ("c" . org-cycle)
17498 ("C" . org-shifttab)
17499 (" " . org-display-outline-path)
17500 ("Outline Structure Editing")
17501 ("U" . org-shiftmetaup)
17502 ("D" . org-shiftmetadown)
17503 ("r" . org-metaright)
17504 ("l" . org-metaleft)
17505 ("R" . org-shiftmetaright)
17506 ("L" . org-shiftmetaleft)
17507 ("i" . (progn (forward-char 1) (call-interactively
17508 'org-insert-heading-respect-content)))
17509 ("^" . org-sort)
17510 ("w" . org-refile)
17511 ("a" . org-archive-subtree-default-with-confirmation)
17512 ("." . org-mark-subtree)
17513 ("Clock Commands")
17514 ("I" . org-clock-in)
17515 ("O" . org-clock-out)
17516 ("Meta Data Editing")
17517 ("t" . org-todo)
17518 ("0" . (org-priority ?\ ))
17519 ("1" . (org-priority ?A))
17520 ("2" . (org-priority ?B))
17521 ("3" . (org-priority ?C))
17522 (";" . org-set-tags-command)
17523 ("e" . org-set-effort)
17524 ("Agenda Views etc")
17525 ("v" . org-agenda)
17526 ("/" . org-sparse-tree)
17527 ("Misc")
17528 ("o" . org-open-at-point)
17529 ("?" . org-speed-command-help)
17530 ("<" . (org-agenda-set-restriction-lock 'subtree))
17531 (">" . (org-agenda-remove-restriction-lock))
17532 )
17533 "The default speed commands.")
17535 (defun org-print-speed-command (e)
17536 (if (> (length (car e)) 1)
17537 (progn
17539 (princ (car e))
17541 (princ (make-string (length (car e)) ?-))
17543 (princ (car e))
17544 (princ " ")
17545 (if (symbolp (cdr e))
17546 (princ (symbol-name (cdr e)))
17547 (prin1 (cdr e)))
17550 (defun org-speed-command-help ()
17551 "Show the available speed commands."
17552 (interactive)
17553 (if (not org-use-speed-commands)
17554 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17555 (with-output-to-temp-buffer "*Help*"
17557 (mapc 'org-print-speed-command org-speed-commands-user)
17560 (mapc 'org-print-speed-command org-speed-commands-default))
17561 (with-current-buffer "*Help*"
17562 (setq truncate-lines t))))
17564 (defun org-speed-move-safe (cmd)
17565 "Execute CMD, but make sure that the cursor always ends up in a headline.
17566 If not, return to the original position and throw an error."
17567 (interactive)
17568 (let ((pos (point)))
17569 (call-interactively cmd)
17570 (unless (and (bolp) (org-at-heading-p))
17571 (goto-char pos)
17572 (error "Boundary reached while executing %s" cmd))))
17574 (defvar org-self-insert-command-undo-counter 0)
17576 (defvar org-table-auto-blank-field) ; defined in org-table.el
17577 (defvar org-speed-command nil)
17579 (defun org-speed-command-default-hook (keys)
17580 "Hook for activating single-letter speed commands.
17581 `org-speed-commands-default' specifies a minimal command set.
17582 Use `org-speed-commands-user' for further customization."
17583 (when (or (and (bolp) (looking-at org-outline-regexp))
17584 (and (functionp org-use-speed-commands)
17585 (funcall org-use-speed-commands)))
17586 (cdr (assoc keys (append org-speed-commands-user
17587 org-speed-commands-default)))))
17589 (defun org-babel-speed-command-hook (keys)
17590 "Hook for activating single-letter code block commands."
17591 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17592 (cdr (assoc keys org-babel-key-bindings))))
17594 (defcustom org-speed-command-hook
17595 '(org-speed-command-default-hook org-babel-speed-command-hook)
17596 "Hook for activating speed commands at strategic locations.
17597 Hook functions are called in sequence until a valid handler is
17598 found.
17600 Each hook takes a single argument, a user-pressed command key
17601 which is also a `self-insert-command' from the global map.
17603 Within the hook, examine the cursor position and the command key
17604 and return nil or a valid handler as appropriate. Handler could
17605 be one of an interactive command, a function, or a form.
17607 Set `org-use-speed-commands' to non-nil value to enable this
17608 hook. The default setting is `org-speed-command-default-hook'."
17609 :group 'org-structure
17610 :type 'hook)
17612 (defun org-self-insert-command (N)
17613 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17614 If the cursor is in a table looking at whitespace, the whitespace is
17615 overwritten, and the table is not marked as requiring realignment."
17616 (interactive "p")
17617 (org-check-before-invisible-edit 'insert)
17618 (cond
17619 ((and org-use-speed-commands
17620 (setq org-speed-command
17621 (run-hook-with-args-until-success
17622 'org-speed-command-hook (this-command-keys))))
17623 (cond
17624 ((commandp org-speed-command)
17625 (setq this-command org-speed-command)
17626 (call-interactively org-speed-command))
17627 ((functionp org-speed-command)
17628 (funcall org-speed-command))
17629 ((and org-speed-command (listp org-speed-command))
17630 (eval org-speed-command))
17631 (t (let (org-use-speed-commands)
17632 (call-interactively 'org-self-insert-command)))))
17633 ((and
17634 (org-table-p)
17635 (progn
17636 ;; check if we blank the field, and if that triggers align
17637 (and (featurep 'org-table) org-table-auto-blank-field
17638 (member last-command
17639 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17641 ;; got extra space, this field does not determine column width
17642 (let (org-table-may-need-update) (org-table-blank-field))
17643 ;; no extra space, this field may determine column width
17644 (org-table-blank-field)))
17645 t)
17646 (eq N 1)
17648 (let (org-table-may-need-update)
17649 (goto-char (1- (match-end 0)))
17650 (delete-char -1)
17651 (goto-char (match-beginning 0))
17652 (self-insert-command N)))
17653 (t
17654 (setq org-table-may-need-update t)
17655 (self-insert-command N)
17656 (org-fix-tags-on-the-fly)
17657 (if org-self-insert-cluster-for-undo
17658 (if (not (eq last-command 'org-self-insert-command))
17659 (setq org-self-insert-command-undo-counter 1)
17660 (if (>= org-self-insert-command-undo-counter 20)
17661 (setq org-self-insert-command-undo-counter 1)
17662 (and (> org-self-insert-command-undo-counter 0)
17663 buffer-undo-list (listp buffer-undo-list)
17664 (not (cadr buffer-undo-list)) ; remove nil entry
17665 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17666 (setq org-self-insert-command-undo-counter
17667 (1+ org-self-insert-command-undo-counter))))))))
17669 (defun org-check-before-invisible-edit (kind)
17670 "Check is editing if kind KIND would be dangerous with invisible text around.
17671 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17672 ;; First, try to get out of here as quickly as possible, to reduce overhead
17673 (if (and org-catch-invisible-edits
17674 (or (not (boundp 'visible-mode)) (not visible-mode))
17675 (or (get-char-property (point) 'invisible)
17676 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17677 ;; OK, we need to take a closer look
17678 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17679 (invisible-before-point (if (bobp) nil (get-char-property
17680 (1- (point)) 'invisible)))
17681 (border-and-ok-direction
17682 (or
17683 ;; Check if we are acting predictably before invisible text
17684 (and invisible-at-point (not invisible-before-point)
17685 (memq kind '(insert delete-backward)))
17686 ;; Check if we are acting predictably after invisible text
17687 ;; This works not well, and I have turned it off. It seems
17688 ;; better to always show and stop after invisible text.
17689 ;; (and (not invisible-at-point) invisible-before-point
17690 ;; (memq kind '(insert delete)))
17691 )))
17693 (when (or (memq invisible-at-point '(outline org-hide-block))
17694 (memq invisible-before-point '(outline org-hide-block)))
17695 (if (eq org-catch-invisible-edits 'error)
17696 (error "Editing in invisible areas is prohibited - make visible first"))
17697 ;; Make the area visible
17698 (save-excursion
17699 (if invisible-before-point
17700 (goto-char (previous-single-char-property-change
17701 (point) 'invisible)))
17702 (org-cycle))
17703 (cond
17704 ((eq org-catch-invisible-edits 'show)
17705 ;; That's it, we do the edit after showing
17706 (message
17707 "Unfolding invisible region around point before editing")
17708 (sit-for 1))
17709 ((and (eq org-catch-invisible-edits 'smart)
17710 border-and-ok-direction)
17711 (message "Unfolding invisible region around point before editing"))
17712 (t
17713 ;; Don't do the edit, make the user repeat it in full visibility
17714 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17716 (defun org-fix-tags-on-the-fly ()
17717 (when (and (equal (char-after (point-at-bol)) ?*)
17718 (org-at-heading-p))
17719 (org-align-tags-here org-tags-column)))
17721 (defun org-delete-backward-char (N)
17722 "Like `delete-backward-char', insert whitespace at field end in tables.
17723 When deleting backwards, in tables this function will insert whitespace in
17725 still be marked for re-alignment if the field did fill the entire column,
17726 because, in this case the deletion might narrow the column."
17727 (interactive "p")
17728 (org-check-before-invisible-edit 'delete-backward)
17729 (if (and (org-table-p)
17730 (eq N 1)
17731 (string-match "|" (buffer-substring (point-at-bol) (point)))
17732 (looking-at ".*?|"))
17733 (let ((pos (point))
17735 (c org-table-may-need-update))
17736 (backward-delete-char N)
17737 (if (not overwrite-mode)
17738 (progn
17739 (skip-chars-forward "^|")
17740 (insert " ")
17741 (goto-char (1- pos))))
17742 ;; noalign: if there were two spaces at the end, this field
17743 ;; does not determine the width of the column.
17744 (if noalign (setq org-table-may-need-update c)))
17745 (backward-delete-char N)
17746 (org-fix-tags-on-the-fly)))
17748 (defun org-delete-char (N)
17749 "Like `delete-char', but insert whitespace at field end in tables.
17750 When deleting characters, in tables this function will insert whitespace in
17752 still be marked for re-alignment if the field did fill the entire column,
17753 because, in this case the deletion might narrow the column."
17754 (interactive "p")
17755 (org-check-before-invisible-edit 'delete)
17756 (if (and (org-table-p)
17757 (not (bolp))
17758 (not (= (char-after) ?|))
17759 (eq N 1))
17760 (if (looking-at ".*?|")
17761 (let ((pos (point))
17763 (c org-table-may-need-update))
17764 (replace-match (concat
17765 (substring (match-string 0) 1 -1)
17766 " |"))
17767 (goto-char pos)
17768 ;; noalign: if there were two spaces at the end, this field
17769 ;; does not determine the width of the column.
17770 (if noalign (setq org-table-may-need-update c)))
17771 (delete-char N))
17772 (delete-char N)
17773 (org-fix-tags-on-the-fly)))
17775 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17776 (put 'org-self-insert-command 'delete-selection t)
17777 (put 'orgtbl-self-insert-command 'delete-selection t)
17778 (put 'org-delete-char 'delete-selection 'supersede)
17779 (put 'org-delete-backward-char 'delete-selection 'supersede)
17780 (put 'org-yank 'delete-selection 'yank)
17782 ;; Make `flyspell-mode' delay after some commands
17783 (put 'org-self-insert-command 'flyspell-delayed t)
17784 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17785 (put 'org-delete-char 'flyspell-delayed t)
17786 (put 'org-delete-backward-char 'flyspell-delayed t)
17788 ;; Make pabbrev-mode expand after org-mode commands
17789 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17790 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17792 ;; How to do this: Measure non-white length of current string
17793 ;; If equal to column width, we should realign.
17795 (defun org-remap (map &rest commands)
17796 "In MAP, remap the functions given in COMMANDS.
17797 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17798 (let (new old)
17799 (while commands
17800 (setq old (pop commands) new (pop commands))
17801 (if (fboundp 'command-remapping)
17802 (org-defkey map (vector 'remap old) new)
17803 (substitute-key-definition old new map global-map)))))
17805 (when (eq org-enable-table-editor 'optimized)
17806 ;; If the user wants maximum table support, we need to hijack
17807 ;; some standard editing functions
17808 (org-remap org-mode-map
17809 'self-insert-command 'org-self-insert-command
17810 'delete-char 'org-delete-char
17811 'delete-backward-char 'org-delete-backward-char)
17812 (org-defkey org-mode-map "|" 'org-force-self-insert))
17814 (defvar org-ctrl-c-ctrl-c-hook nil
17815 "Hook for functions attaching themselves to `C-c C-c'.
17817 This can be used to add additional functionality to the C-c C-c
17818 key which executes context-dependent commands. This hook is run
17819 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17820 run after the last test.
17822 Each function will be called with no arguments. The function
17823 must check if the context is appropriate for it to act. If yes,
17824 it should do its thing and then return a non-nil value. If the
17825 context is wrong, just do nothing and return nil.")
17827 (defvar org-ctrl-c-ctrl-c-final-hook nil
17828 "Hook for functions attaching themselves to `C-c C-c'.
17830 This can be used to add additional functionality to the C-c C-c
17831 key which executes context-dependent commands. This hook is run
17832 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17833 before the first test.
17835 Each function will be called with no arguments. The function
17836 must check if the context is appropriate for it to act. If yes,
17837 it should do its thing and then return a non-nil value. If the
17838 context is wrong, just do nothing and return nil.")
17840 (defvar org-tab-first-hook nil
17841 "Hook for functions to attach themselves to TAB.
17842 See `org-ctrl-c-ctrl-c-hook' for more information.
17843 This hook runs as the first action when TAB is pressed, even before
17844 `org-cycle' messes around with the `outline-regexp' to cater for
17845 inline tasks and plain list item folding.
17846 If any function in this hook returns t, any other actions that
17847 would have been caused by TAB (such as table field motion or visibility
17848 cycling) will not occur.")
17850 (defvar org-tab-after-check-for-table-hook nil
17851 "Hook for functions to attach themselves to TAB.
17852 See `org-ctrl-c-ctrl-c-hook' for more information.
17853 This hook runs after it has been established that the cursor is not in a
17854 table, but before checking if the cursor is in a headline or if global cycling
17855 should be done.
17856 If any function in this hook returns t, not other actions like visibility
17857 cycling will be done.")
17859 (defvar org-tab-after-check-for-cycling-hook nil
17860 "Hook for functions to attach themselves to TAB.
17861 See `org-ctrl-c-ctrl-c-hook' for more information.
17862 This hook runs after it has been established that not table field motion and
17863 not visibility should be done because of current context. This is probably
17864 the place where a package like yasnippets can hook in.")
17866 (defvar org-tab-before-tab-emulation-hook nil
17867 "Hook for functions to attach themselves to TAB.
17868 See `org-ctrl-c-ctrl-c-hook' for more information.
17869 This hook runs after every other options for TAB have been exhausted, but
17872 (defvar org-metaleft-hook nil
17873 "Hook for functions attaching themselves to `M-left'.
17874 See `org-ctrl-c-ctrl-c-hook' for more information.")
17875 (defvar org-metaright-hook nil
17876 "Hook for functions attaching themselves to `M-right'.
17877 See `org-ctrl-c-ctrl-c-hook' for more information.")
17878 (defvar org-metaup-hook nil
17879 "Hook for functions attaching themselves to `M-up'.
17880 See `org-ctrl-c-ctrl-c-hook' for more information.")
17881 (defvar org-metadown-hook nil
17882 "Hook for functions attaching themselves to `M-down'.
17883 See `org-ctrl-c-ctrl-c-hook' for more information.")
17884 (defvar org-shiftmetaleft-hook nil
17885 "Hook for functions attaching themselves to `M-S-left'.
17886 See `org-ctrl-c-ctrl-c-hook' for more information.")
17887 (defvar org-shiftmetaright-hook nil
17888 "Hook for functions attaching themselves to `M-S-right'.
17889 See `org-ctrl-c-ctrl-c-hook' for more information.")
17890 (defvar org-shiftmetaup-hook nil
17891 "Hook for functions attaching themselves to `M-S-up'.
17892 See `org-ctrl-c-ctrl-c-hook' for more information.")
17893 (defvar org-shiftmetadown-hook nil
17894 "Hook for functions attaching themselves to `M-S-down'.
17895 See `org-ctrl-c-ctrl-c-hook' for more information.")
17896 (defvar org-metareturn-hook nil
17897 "Hook for functions attaching themselves to `M-RET'.
17898 See `org-ctrl-c-ctrl-c-hook' for more information.")
17899 (defvar org-shiftup-hook nil
17900 "Hook for functions attaching themselves to `S-up'.
17901 See `org-ctrl-c-ctrl-c-hook' for more information.")
17902 (defvar org-shiftup-final-hook nil
17903 "Hook for functions attaching themselves to `S-up'.
17904 This one runs after all other options except shift-select have been excluded.
17905 See `org-ctrl-c-ctrl-c-hook' for more information.")
17906 (defvar org-shiftdown-hook nil
17907 "Hook for functions attaching themselves to `S-down'.
17908 See `org-ctrl-c-ctrl-c-hook' for more information.")
17909 (defvar org-shiftdown-final-hook nil
17910 "Hook for functions attaching themselves to `S-down'.
17911 This one runs after all other options except shift-select have been excluded.
17912 See `org-ctrl-c-ctrl-c-hook' for more information.")
17913 (defvar org-shiftleft-hook nil
17914 "Hook for functions attaching themselves to `S-left'.
17915 See `org-ctrl-c-ctrl-c-hook' for more information.")
17916 (defvar org-shiftleft-final-hook nil
17917 "Hook for functions attaching themselves to `S-left'.
17918 This one runs after all other options except shift-select have been excluded.
17919 See `org-ctrl-c-ctrl-c-hook' for more information.")
17920 (defvar org-shiftright-hook nil
17921 "Hook for functions attaching themselves to `S-right'.
17922 See `org-ctrl-c-ctrl-c-hook' for more information.")
17923 (defvar org-shiftright-final-hook nil
17924 "Hook for functions attaching themselves to `S-right'.
17925 This one runs after all other options except shift-select have been excluded.
17926 See `org-ctrl-c-ctrl-c-hook' for more information.")
17928 (defun org-modifier-cursor-error ()
17929 "Throw an error, a modified cursor command was applied in wrong context."
17930 (error "This command is active in special context like tables, headlines or items"))
17932 (defun org-shiftselect-error ()
17933 "Throw an error because Shift-Cursor command was applied in wrong context."
17934 (if (and (boundp 'shift-select-mode) shift-select-mode)
17935 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17936 (error "This command works only in special context like headlines or timestamps")))
17938 (defun org-call-for-shift-select (cmd)
17939 (let ((this-command-keys-shift-translated t))
17940 (call-interactively cmd)))
17942 (defun org-shifttab (&optional arg)
17943 "Global visibility cycling or move to previous table field.
17944 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17945 on context.
17946 See the individual commands for more information."
17947 (interactive "P")
17948 (cond
17949 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17950 ((integerp arg)
17951 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17952 (message "Content view to level: %d" arg)
17953 (org-content (prefix-numeric-value arg2))
17954 (setq org-cycle-global-status 'overview)))
17955 (t (call-interactively 'org-global-cycle))))
17957 (defun org-shiftmetaleft ()
17958 "Promote subtree or delete table column.
17959 Calls `org-promote-subtree', `org-outdent-item',
17960 or `org-table-delete-column', depending on context.
17961 See the individual commands for more information."
17962 (interactive)
17963 (cond
17964 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17965 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17966 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17967 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17968 (t (org-modifier-cursor-error))))
17970 (defun org-shiftmetaright ()
17971 "Demote subtree or insert table column.
17972 Calls `org-demote-subtree', `org-indent-item',
17973 or `org-table-insert-column', depending on context.
17974 See the individual commands for more information."
17975 (interactive)
17976 (cond
17977 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17978 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17979 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17980 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17981 (t (org-modifier-cursor-error))))
17983 (defun org-shiftmetaup (&optional arg)
17984 "Move subtree up or kill table row.
17985 Calls `org-move-subtree-up' or `org-table-kill-row' or
17986 `org-move-item-up' depending on context. See the individual commands
17987 for more information."
17988 (interactive "P")
17989 (cond
17990 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17991 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17992 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17993 ((org-at-item-p) (call-interactively 'org-move-item-up))
17994 (t (org-modifier-cursor-error))))
17996 (defun org-shiftmetadown (&optional arg)
17997 "Move subtree down or insert table row.
17998 Calls `org-move-subtree-down' or `org-table-insert-row' or
17999 `org-move-item-down', depending on context. See the individual
18000 commands for more information."
18001 (interactive "P")
18002 (cond
18003 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
18004 ((org-at-table-p) (call-interactively 'org-table-insert-row))
18005 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18006 ((org-at-item-p) (call-interactively 'org-move-item-down))
18007 (t (org-modifier-cursor-error))))
18009 (defsubst org-hidden-tree-error ()
18010 (error
18011 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
18013 (defun org-metaleft (&optional arg)
18014 "Promote heading or move table column to left.
18015 Calls `org-do-promote' or `org-table-move-column', depending on context.
18016 With no specific context, calls the Emacs default `backward-word'.
18017 See the individual commands for more information."
18018 (interactive "P")
18019 (cond
18020 ((run-hook-with-args-until-success 'org-metaleft-hook))
18021 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
18022 ((org-with-limited-levels
18023 (or (org-at-heading-p)
18024 (and (org-region-active-p)
18025 (save-excursion
18026 (goto-char (region-beginning))
18027 (org-at-heading-p)))))
18028 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18029 (call-interactively 'org-do-promote))
18030 ;; At an inline task.
18031 ((org-at-heading-p)
18032 (call-interactively 'org-inlinetask-promote))
18033 ((or (org-at-item-p)
18034 (and (org-region-active-p)
18035 (save-excursion
18036 (goto-char (region-beginning))
18037 (org-at-item-p))))
18038 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18039 (call-interactively 'org-outdent-item))
18040 (t (call-interactively 'backward-word))))
18042 (defun org-metaright (&optional arg)
18043 "Demote a subtree, a list item or move table column to right.
18044 In front of a drawer or a block keyword, indent it correctly.
18045 With no specific context, calls the Emacs default `forward-word'.
18046 See the individual commands for more information."
18047 (interactive "P")
18048 (cond
18049 ((run-hook-with-args-until-success 'org-metaright-hook))
18050 ((org-at-table-p) (call-interactively 'org-table-move-column))
18051 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
18052 ((org-at-block-p) (call-interactively 'org-indent-block))
18053 ((org-with-limited-levels
18054 (or (org-at-heading-p)
18055 (and (org-region-active-p)
18056 (save-excursion
18057 (goto-char (region-beginning))
18058 (org-at-heading-p)))))
18059 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18060 (call-interactively 'org-do-demote))
18061 ;; At an inline task.
18062 ((org-at-heading-p)
18063 (call-interactively 'org-inlinetask-demote))
18064 ((or (org-at-item-p)
18065 (and (org-region-active-p)
18066 (save-excursion
18067 (goto-char (region-beginning))
18068 (org-at-item-p))))
18069 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18070 (call-interactively 'org-indent-item))
18071 (t (call-interactively 'forward-word))))
18073 (defun org-check-for-hidden (what)
18074 "Check if there are hidden headlines/items in the current visual line.
18075 WHAT can be either `headlines' or `items'. If the current line is
18076 an outline or item heading and it has a folded subtree below it,
18077 this function returns t, nil otherwise."
18078 (let ((re (cond
18079 ((eq what 'headlines) org-outline-regexp-bol)
18080 ((eq what 'items) (org-item-beginning-re))
18081 (t (error "This should not happen"))))
18082 beg end)
18083 (save-excursion
18084 (catch 'exit
18085 (unless (org-region-active-p)
18086 (setq beg (point-at-bol))
18087 (beginning-of-line 2)
18088 (while (and (not (eobp)) ;; this is like `next-line'
18089 (get-char-property (1- (point)) 'invisible))
18090 (beginning-of-line 2))
18091 (setq end (point))
18092 (goto-char beg)
18093 (goto-char (point-at-eol))
18094 (setq end (max end (point)))
18095 (while (re-search-forward re end t)
18096 (if (get-char-property (match-beginning 0) 'invisible)
18097 (throw 'exit t))))
18098 nil))))
18100 (defun org-metaup (&optional arg)
18101 "Move subtree up or move table row up.
18102 Calls `org-move-subtree-up' or `org-table-move-row' or
18103 `org-move-item-up', depending on context. See the individual commands
18104 for more information."
18105 (interactive "P")
18106 (cond
18107 ((run-hook-with-args-until-success 'org-metaup-hook))
18108 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18109 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18110 ((org-at-item-p) (call-interactively 'org-move-item-up))
18111 (t (transpose-lines 1) (beginning-of-line -1))))
18113 (defun org-metadown (&optional arg)
18114 "Move subtree down or move table row down.
18115 Calls `org-move-subtree-down' or `org-table-move-row' or
18116 `org-move-item-down', depending on context. See the individual
18117 commands for more information."
18118 (interactive "P")
18119 (cond
18120 ((run-hook-with-args-until-success 'org-metadown-hook))
18121 ((org-at-table-p) (call-interactively 'org-table-move-row))
18122 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18123 ((org-at-item-p) (call-interactively 'org-move-item-down))
18124 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18126 (defun org-shiftup (&optional arg)
18127 "Increase item in timestamp or increase priority of current headline.
18128 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18129 depending on context. See the individual commands for more information."
18130 (interactive "P")
18131 (cond
18132 ((run-hook-with-args-until-success 'org-shiftup-hook))
18133 ((and org-support-shift-select (org-region-active-p))
18134 (org-call-for-shift-select 'previous-line))
18135 ((org-at-timestamp-p t)
18136 (call-interactively (if org-edit-timestamp-down-means-later
18137 'org-timestamp-down 'org-timestamp-up)))
18138 ((and (not (eq org-support-shift-select 'always))
18139 org-enable-priority-commands
18140 (org-at-heading-p))
18141 (call-interactively 'org-priority-up))
18142 ((and (not org-support-shift-select) (org-at-item-p))
18143 (call-interactively 'org-previous-item))
18144 ((org-clocktable-try-shift 'up arg))
18145 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18146 (org-support-shift-select
18147 (org-call-for-shift-select 'previous-line))
18148 (t (org-shiftselect-error))))
18150 (defun org-shiftdown (&optional arg)
18151 "Decrease item in timestamp or decrease priority of current headline.
18152 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18153 depending on context. See the individual commands for more information."
18154 (interactive "P")
18155 (cond
18156 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18157 ((and org-support-shift-select (org-region-active-p))
18158 (org-call-for-shift-select 'next-line))
18159 ((org-at-timestamp-p t)
18160 (call-interactively (if org-edit-timestamp-down-means-later
18161 'org-timestamp-up 'org-timestamp-down)))
18162 ((and (not (eq org-support-shift-select 'always))
18163 org-enable-priority-commands
18164 (org-at-heading-p))
18165 (call-interactively 'org-priority-down))
18166 ((and (not org-support-shift-select) (org-at-item-p))
18167 (call-interactively 'org-next-item))
18168 ((org-clocktable-try-shift 'down arg))
18169 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18170 (org-support-shift-select
18171 (org-call-for-shift-select 'next-line))
18172 (t (org-shiftselect-error))))
18174 (defun org-shiftright (&optional arg)
18175 "Cycle the thing at point or in the current line, depending on context.
18176 Depending on context, this does one of the following:
18178 - switch a timestamp at point one day into the future
18179 - on a headline, switch to the next TODO keyword.
18180 - on an item, switch entire list to the next bullet type
18181 - on a property line, switch to the next allowed value
18182 - on a clocktable definition line, move time block into the future"
18183 (interactive "P")
18184 (cond
18185 ((run-hook-with-args-until-success 'org-shiftright-hook))
18186 ((and org-support-shift-select (org-region-active-p))
18187 (org-call-for-shift-select 'forward-char))
18188 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18189 ((and (not (eq org-support-shift-select 'always))
18190 (org-at-heading-p))
18191 (let ((org-inhibit-logging
18192 (not org-treat-S-cursor-todo-selection-as-state-change))
18193 (org-inhibit-blocking
18194 (not org-treat-S-cursor-todo-selection-as-state-change)))
18195 (org-call-with-arg 'org-todo 'right)))
18196 ((or (and org-support-shift-select
18197 (not (eq org-support-shift-select 'always))
18198 (org-at-item-bullet-p))
18199 (and (not org-support-shift-select) (org-at-item-p)))
18200 (org-call-with-arg 'org-cycle-list-bullet nil))
18201 ((and (not (eq org-support-shift-select 'always))
18202 (org-at-property-p))
18203 (call-interactively 'org-property-next-allowed-value))
18204 ((org-clocktable-try-shift 'right arg))
18205 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18206 (org-support-shift-select
18207 (org-call-for-shift-select 'forward-char))
18208 (t (org-shiftselect-error))))
18210 (defun org-shiftleft (&optional arg)
18211 "Cycle the thing at point or in the current line, depending on context.
18212 Depending on context, this does one of the following:
18214 - switch a timestamp at point one day into the past
18215 - on a headline, switch to the previous TODO keyword.
18216 - on an item, switch entire list to the previous bullet type
18217 - on a property line, switch to the previous allowed value
18218 - on a clocktable definition line, move time block into the past"
18219 (interactive "P")
18220 (cond
18221 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18222 ((and org-support-shift-select (org-region-active-p))
18223 (org-call-for-shift-select 'backward-char))
18224 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18225 ((and (not (eq org-support-shift-select 'always))
18226 (org-at-heading-p))
18227 (let ((org-inhibit-logging
18228 (not org-treat-S-cursor-todo-selection-as-state-change))
18229 (org-inhibit-blocking
18230 (not org-treat-S-cursor-todo-selection-as-state-change)))
18231 (org-call-with-arg 'org-todo 'left)))
18232 ((or (and org-support-shift-select
18233 (not (eq org-support-shift-select 'always))
18234 (org-at-item-bullet-p))
18235 (and (not org-support-shift-select) (org-at-item-p)))
18236 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18237 ((and (not (eq org-support-shift-select 'always))
18238 (org-at-property-p))
18239 (call-interactively 'org-property-previous-allowed-value))
18240 ((org-clocktable-try-shift 'left arg))
18241 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18242 (org-support-shift-select
18243 (org-call-for-shift-select 'backward-char))
18244 (t (org-shiftselect-error))))
18246 (defun org-shiftcontrolright ()
18247 "Switch to next TODO set."
18248 (interactive)
18249 (cond
18250 ((and org-support-shift-select (org-region-active-p))
18251 (org-call-for-shift-select 'forward-word))
18252 ((and (not (eq org-support-shift-select 'always))
18253 (org-at-heading-p))
18254 (org-call-with-arg 'org-todo 'nextset))
18255 (org-support-shift-select
18256 (org-call-for-shift-select 'forward-word))
18257 (t (org-shiftselect-error))))
18259 (defun org-shiftcontrolleft ()
18260 "Switch to previous TODO set."
18261 (interactive)
18262 (cond
18263 ((and org-support-shift-select (org-region-active-p))
18264 (org-call-for-shift-select 'backward-word))
18265 ((and (not (eq org-support-shift-select 'always))
18266 (org-at-heading-p))
18267 (org-call-with-arg 'org-todo 'previousset))
18268 (org-support-shift-select
18269 (org-call-for-shift-select 'backward-word))
18270 (t (org-shiftselect-error))))
18272 (defun org-shiftcontrolup ()
18273 "Change timestamps synchronously up in CLOCK log lines."
18274 (interactive)
18275 (cond ((and (not org-support-shift-select)
18276 (org-at-clock-log-p)
18277 (org-at-timestamp-p t))
18278 (org-clock-timestamps-up))
18279 (t (org-shiftselect-error))))
18281 (defun org-shiftcontroldown ()
18282 "Change timestamps synchronously down in CLOCK log lines."
18283 (interactive)
18284 (cond ((and (not org-support-shift-select)
18285 (org-at-clock-log-p)
18286 (org-at-timestamp-p t))
18287 (org-clock-timestamps-down))
18288 (t (org-shiftselect-error))))
18290 (defun org-ctrl-c-ret ()
18291 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18292 (interactive)
18293 (cond
18294 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18295 (t (call-interactively 'org-insert-heading))))
18297 (defun org-find-visible ()
18298 (let ((s (point)))
18299 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18300 (get-char-property s 'invisible)))
18301 s))
18302 (defun org-find-invisible ()
18303 (let ((s (point)))
18304 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18305 (not (get-char-property s 'invisible))))
18306 s))
18308 (defun org-copy-visible (beg end)
18309 "Copy the visible parts of the region."
18310 (interactive "r")
18311 (let (snippets s)
18312 (save-excursion
18313 (save-restriction
18314 (narrow-to-region beg end)
18315 (setq s (goto-char (point-min)))
18316 (while (not (= (point) (point-max)))
18317 (goto-char (org-find-invisible))
18318 (push (buffer-substring s (point)) snippets)
18319 (setq s (goto-char (org-find-visible))))))
18320 (kill-new (apply 'concat (nreverse snippets)))))
18322 (defun org-copy-special ()
18323 "Copy region in table or copy current subtree.
18324 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18325 See the individual commands for more information."
18326 (interactive)
18327 (call-interactively
18328 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18330 (defun org-cut-special ()
18331 "Cut region in table or cut current subtree.
18332 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18333 See the individual commands for more information."
18334 (interactive)
18335 (call-interactively
18336 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18338 (defun org-paste-special (arg)
18339 "Paste rectangular region into table, or past subtree relative to level.
18340 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18341 See the individual commands for more information."
18342 (interactive "P")
18343 (if (org-at-table-p)
18344 (org-table-paste-rectangle)
18345 (org-paste-subtree arg)))
18347 (defun org-edit-special (&optional arg)
18348 "Call a special editor for the stuff at point.
18349 When at a table, call the formula editor with `org-table-edit-formulas'.
18350 When at the first line of an src example, call `org-edit-src-code'.
18351 When in an #+include line, visit the include file. Otherwise call
18352 `ffap' to visit the file at point."
18353 (interactive)
18354 ;; possibly prep session before editing source
18355 (when arg
18356 (let* ((info (org-babel-get-src-block-info))
18357 (lang (nth 0 info))
18358 (params (nth 2 info))
18359 (session (cdr (assoc :session params))))
18360 (when (and info session) ;; we are in a source-code block with a session
18361 (funcall
18362 (intern (concat "org-babel-prep-session:" lang)) session params))))
18363 (cond ;; proceed with `org-edit-special'
18364 ((save-excursion
18365 (beginning-of-line 1)
18366 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18367 (find-file (org-trim (match-string 1))))
18368 ((org-edit-src-code))
18369 ((org-edit-fixed-width-region))
18370 ((org-at-table.el-p)
18371 (org-edit-src-code))
18372 ((or (org-at-table-p)
18373 (save-excursion
18374 (beginning-of-line 1)
18376 (call-interactively 'org-table-edit-formulas))
18377 (t (call-interactively 'ffap))))
18379 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18380 (defun org-ctrl-c-ctrl-c (&optional arg)
18381 "Set tags in headline, or update according to changed information at point.
18383 This command does many different things, depending on context:
18385 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18386 this is what we do.
18388 - If the cursor is on a statistics cookie, update it.
18390 - If the cursor is in a headline, prompt for tags and insert them
18391 into the current line, aligned to `org-tags-column'. When called
18392 with prefix arg, realign all tags in the current buffer.
18394 - If the cursor is in one of the special #+KEYWORD lines, this
18395 triggers scanning the buffer for these lines and updating the
18396 information.
18398 - If the cursor is inside a table, realign the table. This command
18399 works even if the automatic table editor has been turned off.
18401 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18402 the entire table.
18404 - If the cursor is at a footnote reference or definition, jump to
18405 the corresponding definition or references, respectively.
18407 - If the cursor is a the beginning of a dynamic block, update it.
18409 - If the current buffer is a capture buffer, close note and file it.
18411 - If the cursor is on a <<<target>>>, update radio targets and
18412 corresponding links in this buffer.
18414 - If the cursor is on a numbered item in a plain list, renumber the
18415 ordered list.
18417 - If the cursor is on a checkbox, toggle it.
18419 - If the cursor is on a code block, evaluate it. The variable
18420 `org-confirm-babel-evaluate' can be used to control prompting
18421 before code block evaluation, by default every code block
18422 evaluation requires confirmation. Code block evaluation can be
18423 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18424 (interactive "P")
18425 (let ((org-enable-table-editor t))
18426 (cond
18427 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18428 org-occur-highlights
18429 org-latex-fragment-image-overlays)
18430 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18431 (org-remove-occur-highlights)
18432 (org-remove-latex-fragment-image-overlays)
18433 (message "Temporary highlights/overlays removed from current buffer"))
18434 ((and (local-variable-p 'org-finish-function (current-buffer))
18435 (fboundp org-finish-function))
18436 (funcall org-finish-function))
18437 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18438 ((org-in-regexp org-ts-regexp-both)
18439 (org-timestamp-change 0 'day))
18440 ((or (looking-at org-property-start-re)
18441 (org-at-property-p))
18442 (call-interactively 'org-property-action))
18443 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18445 (or (org-at-heading-p) (org-at-item-p)))
18446 (call-interactively 'org-update-statistics-cookies))
18447 ((org-at-heading-p) (call-interactively 'org-set-tags))
18448 ((org-at-table.el-p)
18449 (message "Use C-c ' to edit table.el tables"))
18450 ((org-at-table-p)
18451 (org-table-maybe-eval-formula)
18452 (if arg
18453 (call-interactively 'org-table-recalculate)
18454 (org-table-maybe-recalculate-line))
18455 (call-interactively 'org-table-align)
18456 (orgtbl-send-table 'maybe))
18457 ((or (org-footnote-at-reference-p)
18458 (org-footnote-at-definition-p))
18459 (call-interactively 'org-footnote-action))
18460 ((org-at-item-checkbox-p)
18461 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18462 ;; list only if at top item.
18463 (let* ((cbox (match-string 1))
18464 (struct (org-list-struct))
18465 (old-struct (copy-tree struct))
18466 (parents (org-list-parents-alist struct))
18467 (orderedp (org-entry-get nil "ORDERED"))
18468 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18469 block-item)
18470 ;; Use a light version of `org-toggle-checkbox' to avoid
18471 ;; computing list structure twice.
18472 (let ((new-box (cond
18473 ((equal arg '(16)) "[-]")
18474 ((equal arg '(4)) nil)
18475 ((equal "[X]" cbox) "[ ]")
18476 (t "[X]"))))
18477 (if (and firstp arg)
18478 ;; If at first item of sub-list, remove check-box from
18479 ;; every item at the same level.
18480 (mapc
18481 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18482 (org-list-get-all-items
18483 (point-at-bol) struct (org-list-prevs-alist struct)))
18484 (org-list-set-checkbox (point-at-bol) struct new-box)))
18485 ;; Replicate `org-list-write-struct', while grabbing a return
18486 ;; value from `org-list-struct-fix-box'.
18487 (org-list-struct-fix-ind struct parents 2)
18488 (org-list-struct-fix-item-end struct)
18489 (let ((prevs (org-list-prevs-alist struct)))
18490 (org-list-struct-fix-bul struct prevs)
18491 (org-list-struct-fix-ind struct parents)
18492 (setq block-item
18493 (org-list-struct-fix-box struct parents prevs orderedp)))
18494 (org-list-struct-apply-struct struct old-struct)
18495 (org-update-checkbox-count-maybe)
18496 (when block-item
18497 (message
18498 "Checkboxes were removed due to unchecked box at line %d"
18499 (org-current-line block-item)))
18500 (when firstp (org-list-send-list 'maybe))))
18501 ((org-at-item-p)
18502 ;; Cursor at an item: repair list. Do checkbox related actions
18503 ;; only if function was called with an argument. Send list only
18504 ;; if at top item.
18505 (let* ((struct (org-list-struct))
18506 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18507 old-struct)
18508 (when arg
18509 (setq old-struct (copy-tree struct))
18510 (if firstp
18511 ;; If at first item of sub-list, add check-box to every
18512 ;; item at the same level.
18513 (mapc
18514 (lambda (pos)
18515 (unless (org-list-get-checkbox pos struct)
18516 (org-list-set-checkbox pos struct "[ ]")))
18517 (org-list-get-all-items
18518 (point-at-bol) struct (org-list-prevs-alist struct)))
18519 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18520 (org-list-write-struct
18521 struct (org-list-parents-alist struct) old-struct)
18522 (when arg (org-update-checkbox-count-maybe))
18523 (when firstp (org-list-send-list 'maybe))))
18524 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18525 ;; Dynamic block
18526 (beginning-of-line 1)
18527 (save-excursion (org-update-dblock)))
18528 ((save-excursion
18529 (beginning-of-line 1)
18531 (cond
18532 ((equal (match-string 1) "TBLFM")
18533 ;; Recalculate the table before this line
18534 (save-excursion
18535 (beginning-of-line 1)
18537 (if (org-at-table-p)
18538 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18539 (t
18540 (let ((org-inhibit-startup-visibility-stuff t)
18541 (org-startup-align-all-tables nil))
18542 (when (boundp 'org-table-coordinate-overlays)
18543 (mapc 'delete-overlay org-table-coordinate-overlays)
18544 (setq org-table-coordinate-overlays nil))
18545 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18546 (message "Local setup has been refreshed"))))
18547 ((org-clock-update-time-maybe))
18548 (t
18549 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18550 (error "C-c C-c can do nothing useful at this location"))))))
18552 (defun org-mode-restart ()
18553 "Restart Org-mode, to scan again for special lines.
18554 Also updates the keyword regular expressions."
18555 (interactive)
18556 (org-mode)
18557 (message "Org-mode restarted"))
18559 (defun org-kill-note-or-show-branches ()
18560 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18561 (interactive)
18562 (if (not org-finish-function)
18563 (progn
18564 (hide-subtree)
18565 (call-interactively 'show-branches))
18566 (let ((org-note-abort t))
18567 (funcall org-finish-function))))
18569 (defun org-return (&optional indent)
18570 "Goto next table row or insert a newline.
18571 Calls `org-table-next-row' or `newline', depending on context.
18572 See the individual commands for more information."
18573 (interactive)
18574 (cond
18575 ((or (bobp) (org-in-src-block-p))
18576 (if indent (newline-and-indent) (newline)))
18577 ((org-at-table-p)
18578 (org-table-justify-field-maybe)
18579 (call-interactively 'org-table-next-row))
18580 ;; when `newline-and-indent' is called within a list, make sure
18581 ;; text moved stays inside the item.
18582 ((and (org-in-item-p) indent)
18583 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18584 (progn
18585 (save-match-data (newline))
18586 (org-indent-line-to (length (match-string 0))))
18587 (let ((ind (org-get-indentation)))
18588 (newline)
18589 (if (org-looking-back org-list-end-re)
18590 (org-indent-line-function)
18591 (org-indent-line-to ind)))))
18592 ((and org-return-follows-link
18593 (let ((tprop (get-text-property (point) 'face)))
18594 (or (eq tprop 'org-link)
18595 (and (listp tprop) (memq 'org-link tprop)))))
18596 (call-interactively 'org-open-at-point))
18597 ((and (org-at-heading-p)
18598 (looking-at
18600 (org-show-entry)
18601 (end-of-line 1)
18602 (newline))
18603 (t (if indent (newline-and-indent) (newline)))))
18605 (defun org-return-indent ()
18606 "Goto next table row or insert a newline and indent.
18607 Calls `org-table-next-row' or `newline-and-indent', depending on
18608 context. See the individual commands for more information."
18609 (interactive)
18610 (org-return t))
18612 (defun org-ctrl-c-star ()
18613 "Compute table, or change heading status of lines.
18614 Calls `org-table-recalculate' or `org-toggle-heading',
18615 depending on context."
18616 (interactive)
18617 (cond
18618 ((org-at-table-p)
18619 (call-interactively 'org-table-recalculate))
18620 (t
18621 ;; Convert all lines in region to list items
18622 (call-interactively 'org-toggle-heading))))
18624 (defun org-ctrl-c-minus ()
18625 "Insert separator line in table or modify bullet status of line.
18626 Also turns a plain line or a region of lines into list items.
18627 Calls `org-table-insert-hline', `org-toggle-item', or
18628 `org-cycle-list-bullet', depending on context."
18629 (interactive)
18630 (cond
18631 ((org-at-table-p)
18632 (call-interactively 'org-table-insert-hline))
18633 ((org-region-active-p)
18634 (call-interactively 'org-toggle-item))
18635 ((org-in-item-p)
18636 (call-interactively 'org-cycle-list-bullet))
18637 (t
18638 (call-interactively 'org-toggle-item))))
18640 (defun org-toggle-item (arg)
18641 "Convert headings or normal lines to items, items to normal lines.
18642 If there is no active region, only the current line is considered.
18644 If the first non blank line in the region is an headline, convert
18645 all headlines to items, shifting text accordingly.
18647 If it is an item, convert all items to normal lines.
18649 If it is normal text, change region into an item. With a prefix
18650 argument ARG, change each line in region into an item."
18651 (interactive "P")
18652 (let ((shift-text
18653 (function
18654 ;; Shift text in current section to IND, from point to END.
18655 ;; The function leaves point to END line.
18656 (lambda (ind end)
18657 (let ((min-i 1000) (end (copy-marker end)))
18658 ;; First determine the minimum indentation (MIN-I) of
18659 ;; the text.
18660 (save-excursion
18661 (catch 'exit
18662 (while (< (point) end)
18663 (let ((i (org-get-indentation)))
18664 (cond
18665 ;; Skip blank lines and inline tasks.
18667 ((looking-at org-outline-regexp-bol))
18668 ;; We can't find less than 0 indentation.
18669 ((zerop i) (throw 'exit (setq min-i 0)))
18670 ((< i min-i) (setq min-i i))))
18671 (forward-line))))
18672 ;; Then indent each line so that a line indented to
18673 ;; MIN-I becomes indented to IND. Ignore blank lines
18674 ;; and inline tasks in the process.
18675 (let ((delta (- ind min-i)))
18676 (while (< (point) end)
18678 (looking-at org-outline-regexp-bol))
18679 (org-indent-line-to (+ (org-get-indentation) delta)))
18680 (forward-line)))))))
18681 (skip-blanks
18682 (function
18683 ;; Return beginning of first non-blank line, starting from
18684 ;; line at POS.
18685 (lambda (pos)
18686 (save-excursion
18687 (goto-char pos)
18689 (point-at-bol)))))
18690 beg end)
18691 ;; Determine boundaries of changes.
18692 (if (org-region-active-p)
18693 (setq beg (funcall skip-blanks (region-beginning))
18694 end (copy-marker (region-end)))
18695 (setq beg (funcall skip-blanks (point-at-bol))
18696 end (copy-marker (point-at-eol))))
18697 ;; Depending on the starting line, choose an action on the text
18698 ;; between BEG and END.
18699 (org-with-limited-levels
18700 (save-excursion
18701 (goto-char beg)
18702 (cond
18703 ;; Case 1. Start at an item: de-itemize. Note that it only
18704 ;; happens when a region is active: `org-ctrl-c-minus'
18705 ;; would call `org-cycle-list-bullet' otherwise.
18706 ((org-at-item-p)
18707 (while (< (point) end)
18708 (when (org-at-item-p)
18710 (delete-region (point) (match-end 0)))
18711 (forward-line)))
18712 ;; Case 2. Start at an heading: convert to items.
18713 ((org-at-heading-p)
18714 (let* ((bul (org-list-bullet-string "-"))
18715 (bul-len (length bul))
18716 ;; Indentation of the first heading. It should be
18717 ;; relative to the indentation of its parent, if any.
18718 (start-ind (save-excursion
18719 (cond
18720 ((not org-adapt-indentation) 0)
18721 ((not (outline-previous-heading)) 0)
18722 (t (length (match-string 0))))))
18723 ;; Level of first heading. Further headings will be
18724 ;; compared to it to determine hierarchy in the list.
18725 (ref-level (org-reduced-level (org-outline-level))))
18726 (while (< (point) end)
18727 (let* ((level (org-reduced-level (org-outline-level)))
18728 (delta (max 0 (- level ref-level))))
18729 ;; If current headline is less indented than the first
18730 ;; one, set it as reference, in order to preserve
18731 ;; subtrees.
18732 (when (< level ref-level) (setq ref-level level))
18733 (replace-match bul t t)
18734 (org-indent-line-to (+ start-ind (* delta bul-len)))
18735 ;; Ensure all text down to END (or SECTION-END) belongs
18736 ;; to the newly created item.
18737 (let ((section-end (save-excursion
18738 (or (outline-next-heading) (point)))))
18739 (forward-line)
18740 (funcall shift-text
18741 (+ start-ind (* (1+ delta) bul-len))
18742 (min end section-end)))))))
18743 ;; Case 3. Normal line with ARG: turn each non-item line into
18744 ;; an item.
18745 (arg
18746 (while (< (point) end)
18747 (unless (or (org-at-heading-p) (org-at-item-p))
18749 (replace-match
18751 (forward-line)))
18752 ;; Case 4. Normal line without ARG: make the first line of
18753 ;; region an item, and shift indentation of others
18754 ;; lines to set them as item's body.
18755 (t (let* ((bul (org-list-bullet-string "-"))
18756 (bul-len (length bul))
18757 (ref-ind (org-get-indentation)))
18759 (insert bul)
18760 (forward-line)
18761 (while (< (point) end)
18762 ;; Ensure that lines less indented than first one
18763 ;; still get included in item body.
18764 (funcall shift-text
18765 (+ ref-ind bul-len)
18766 (min end (save-excursion (or (outline-next-heading)
18767 (point)))))
18768 (forward-line)))))))))
18770 (defun org-toggle-heading (&optional nstars)
18771 "Convert headings to normal text, or items or text to headings.
18772 If there is no active region, only the current line is considered.
18774 If the first non blank line is an headline, remove the stars from
18775 all headlines in the region.
18777 If it is a plain list item, turn all plain list items into headings.
18779 If it is a normal line, turn each and every normal line (i.e. not
18780 an heading or an item) in the region into a heading.
18782 When converting a line into a heading, the number of stars is chosen
18783 such that the lines become children of the current entry. However,
18784 when a prefix argument is given, its value determines the number of
18785 stars to add."
18786 (interactive "P")
18787 (let ((skip-blanks
18788 (function
18789 ;; Return beginning of first non-blank line, starting from
18790 ;; line at POS.
18791 (lambda (pos)
18792 (save-excursion
18793 (goto-char pos)
18795 (point-at-bol)))))
18796 beg end)
18797 ;; Determine boundaries of changes. If region ends at a bol, do
18798 ;; not consider the last line to be in the region.
18799 (if (org-region-active-p)
18800 (setq beg (funcall skip-blanks (region-beginning))
18801 end (copy-marker (save-excursion
18802 (goto-char (region-end))
18803 (if (bolp) (point) (point-at-eol)))))
18804 (setq beg (funcall skip-blanks (point-at-bol))
18805 end (copy-marker (point-at-eol))))
18806 ;; Ensure inline tasks don't count as headings.
18807 (org-with-limited-levels
18808 (save-excursion
18809 (goto-char beg)
18810 (cond
18811 ;; Case 1. Started at an heading: de-star headings.
18812 ((org-at-heading-p)
18813 (while (< (point) end)
18814 (when (org-at-heading-p t)
18815 (looking-at org-outline-regexp) (replace-match ""))
18816 (forward-line)))
18817 ;; Case 2. Started at an item: change items into headlines.
18818 ;; One star will be added by `org-list-to-subtree'.
18819 ((org-at-item-p)
18820 (let* ((stars (make-string
18821 (if nstars
18822 ;; subtract the star that will be added again by
18823 ;; `org-list-to-subtree'
18824 (1- (prefix-numeric-value current-prefix-arg))
18825 (or (org-current-level) 0))
18826 ?*))
18827 (add-stars
18828 (cond (nstars "") ; stars from prefix only
18829 ((equal stars "") "") ; before first heading
18830 (org-odd-levels-only "*") ; inside heading, odd
18831 (t "")))) ; inside heading, oddeven
18832 (while (< (point) end)
18833 (when (org-at-item-p)
18834 ;; Pay attention to cases when region ends before list.
18835 (let* ((struct (org-list-struct))
18836 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18837 (save-restriction
18838 (narrow-to-region (point) list-end)
18839 (insert
18840 (org-list-to-subtree
18841 (org-list-parse-list t)
18842 '(:istart (concat stars add-stars (funcall get-stars depth))
18843 :icount (concat stars add-stars (funcall get-stars depth))))))))
18844 (forward-line))))
18845 ;; Case 3. Started at normal text: make every line an heading,
18846 ;; skipping headlines and items.
18847 (t (let* ((stars (make-string
18848 (if nstars
18849 (prefix-numeric-value current-prefix-arg)
18850 (or (org-current-level) 0))
18851 ?*))
18852 (add-stars
18853 (cond (nstars "") ; stars from prefix only
18854 ((equal stars "") "*") ; before first heading
18855 (org-odd-levels-only "**") ; inside heading, odd
18856 (t "*"))) ; inside heading, oddeven
18857 (rpl (concat stars add-stars " ")))
18858 (while (< (point) end)
18859 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18861 (replace-match (concat rpl (match-string 2))))
18862 (forward-line)))))))))
18864 (defun org-meta-return (&optional arg)
18865 "Insert a new heading or wrap a region in a table.
18866 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18867 See the individual commands for more information."
18868 (interactive "P")
18869 (cond
18870 ((run-hook-with-args-until-success 'org-metareturn-hook))
18871 ((or (org-at-drawer-p) (org-at-property-p))
18872 (newline-and-indent))
18873 ((org-at-table-p)
18874 (call-interactively 'org-table-wrap-region))
18875 (t (call-interactively 'org-insert-heading))))
18877 ;;; Menu entries
18879 ;; Define the Org-mode menus
18880 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18881 '("Tbl"
18882 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18883 ["Next Field" org-cycle (org-at-table-p)]
18884 ["Previous Field" org-shifttab (org-at-table-p)]
18885 ["Next Row" org-return (org-at-table-p)]
18886 "--"
18887 ["Blank Field" org-table-blank-field (org-at-table-p)]
18888 ["Edit Field" org-table-edit-field (org-at-table-p)]
18889 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18890 "--"
18891 ("Column"
18892 ["Move Column Left" org-metaleft (org-at-table-p)]
18893 ["Move Column Right" org-metaright (org-at-table-p)]
18894 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18895 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18896 ("Row"
18897 ["Move Row Up" org-metaup (org-at-table-p)]
18898 ["Move Row Down" org-metadown (org-at-table-p)]
18899 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18900 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18901 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18902 "--"
18903 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18904 ("Rectangle"
18905 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18906 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18907 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18908 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18909 "--"
18910 ("Calculate"
18911 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18912 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18913 ["Edit Formulas" org-edit-special (org-at-table-p)]
18914 "--"
18915 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18916 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18917 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18918 "--"
18919 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18920 "--"
18921 ["Sum Column/Rectangle" org-table-sum
18922 (or (org-at-table-p) (org-region-active-p))]
18923 ["Which Column?" org-table-current-column (org-at-table-p)])
18924 ["Debug Formulas"
18925 org-table-toggle-formula-debugger
18926 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18927 ["Show Col/Row Numbers"
18928 org-table-toggle-coordinate-overlays
18929 :style toggle
18930 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18931 "--"
18932 ["Create" org-table-create (and (not (org-at-table-p))
18933 org-enable-table-editor)]
18934 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18935 ["Import from File" org-table-import (not (org-at-table-p))]
18936 ["Export to File" org-table-export (org-at-table-p)]
18937 "--"
18938 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18940 (easy-menu-define org-org-menu org-mode-map "Org menu"
18941 '("Org"
18942 ("Show/Hide"
18943 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18944 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18945 ["Sparse Tree..." org-sparse-tree t]
18946 ["Reveal Context" org-reveal t]
18947 ["Show All" show-all t]
18948 "--"
18949 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18950 "--"
18951 ["New Heading" org-insert-heading t]
18952 ("Navigate Headings"
18953 ["Up" outline-up-heading t]
18954 ["Next" outline-next-visible-heading t]
18955 ["Previous" outline-previous-visible-heading t]
18956 ["Next Same Level" outline-forward-same-level t]
18957 ["Previous Same Level" outline-backward-same-level t]
18958 "--"
18959 ["Jump" org-goto t])
18960 ("Edit Structure"
18961 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18962 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18963 "--"
18964 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18965 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18966 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18967 "--"
18968 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18969 "--"
18970 ["Copy visible text" org-copy-visible t]
18971 "--"
18972 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18973 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18974 ["Demote Heading" org-metaright (not (org-at-table-p))]
18975 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18976 "--"
18977 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18978 "--"
18979 ["Convert to odd levels" org-convert-to-odd-levels t]
18980 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18981 ("Editing"
18982 ["Emphasis..." org-emphasize t]
18983 ["Edit Source Example" org-edit-special t]
18984 "--"
18985 ["Footnote new/jump" org-footnote-action t]
18986 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18987 ("Archive"
18988 ["Archive (default method)" org-archive-subtree-default t]
18989 "--"
18990 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18991 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18992 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18993 )
18994 "--"
18995 ("Hyperlinks"
18996 ["Store Link (Global)" org-store-link t]
18997 ["Find existing link to here" org-occur-link-in-agenda-files t]
18998 ["Insert Link" org-insert-link t]
18999 ["Follow Link" org-open-at-point t]
19000 "--"
19001 ["Next link" org-next-link t]
19002 ["Previous link" org-previous-link t]
19003 "--"
19004 ["Descriptive Links"
19005 org-toggle-link-display
19006 :style radio
19007 :selected org-descriptive-links
19008 ]
19009 ["Literal Links"
19010 org-toggle-link-display
19011 :style radio
19012 :selected (not org-descriptive-links)])
19013 "--"
19014 ("TODO Lists"
19015 ["TODO/DONE/-" org-todo t]
19016 ("Select keyword"
19017 ["Next keyword" org-shiftright (org-at-heading-p)]
19018 ["Previous keyword" org-shiftleft (org-at-heading-p)]
19019 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
19020 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
19021 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
19022 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
19023 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
19024 "--"
19025 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
19026 :selected org-enforce-todo-dependencies :style toggle :active t]
19027 "Settings for tree at point"
19028 ["Do Children sequentially" org-toggle-ordered-property :style radio
19029 :selected (org-entry-get nil "ORDERED")
19030 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19031 ["Do Children parallel" org-toggle-ordered-property :style radio
19032 :selected (not (org-entry-get nil "ORDERED"))
19033 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
19034 "--"
19035 ["Set Priority" org-priority t]
19036 ["Priority Up" org-shiftup t]
19037 ["Priority Down" org-shiftdown t]
19038 "--"
19039 ["Get news from all feeds" org-feed-update-all t]
19040 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
19041 ["Customize feeds" (customize-variable 'org-feed-alist) t])
19042 ("TAGS and Properties"
19043 ["Set Tags" org-set-tags-command t]
19044 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
19045 "--"
19046 ["Set property" org-set-property t]
19047 ["Column view of properties" org-columns t]
19048 ["Insert Column View DBlock" org-insert-columns-dblock t])
19049 ("Dates and Scheduling"
19050 ["Timestamp" org-time-stamp t]
19051 ["Timestamp (inactive)" org-time-stamp-inactive t]
19052 ("Change Date"
19053 ["1 Day Later" org-shiftright t]
19054 ["1 Day Earlier" org-shiftleft t]
19055 ["1 ... Later" org-shiftup t]
19056 ["1 ... Earlier" org-shiftdown t])
19057 ["Compute Time Range" org-evaluate-time-range t]
19058 ["Schedule Item" org-schedule t]
19059 ["Deadline" org-deadline t]
19060 "--"
19061 ["Custom time format" org-toggle-time-stamp-overlays
19062 :style radio :selected org-display-custom-times]
19063 "--"
19064 ["Goto Calendar" org-goto-calendar t]
19065 ["Date from Calendar" org-date-from-calendar t]
19066 "--"
19067 ["Start/Restart Timer" org-timer-start t]
19068 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19069 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19070 ["Insert Timer String" org-timer t]
19071 ["Insert Timer Item" org-timer-item t])
19072 ("Logging work"
19073 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19074 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19075 ["Clock out" org-clock-out t]
19076 ["Clock cancel" org-clock-cancel t]
19077 "--"
19078 ["Mark as default task" org-clock-mark-default-task t]
19079 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19080 ["Goto running clock" org-clock-goto t]
19081 "--"
19082 ["Display times" org-clock-display t]
19083 ["Create clock table" org-clock-report t]
19084 "--"
19085 ["Record DONE time"
19086 (progn (setq org-log-done (not org-log-done))
19087 (message "Switching to %s will %s record a timestamp"
19088 (car org-done-keywords)
19089 (if org-log-done "automatically" "not")))
19090 :style toggle :selected org-log-done])
19091 "--"
19092 ["Agenda Command..." org-agenda t]
19093 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19094 ("File List for Agenda")
19095 ("Special views current file"
19096 ["TODO Tree" org-show-todo-tree t]
19097 ["Check Deadlines" org-check-deadlines t]
19098 ["Timeline" org-timeline t]
19099 ["Tags/Property tree" org-match-sparse-tree t])
19100 "--"
19101 ["Export/Publish..." org-export t]
19102 ("LaTeX"
19103 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19104 :selected org-cdlatex-mode]
19105 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19106 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19107 ["Modify math symbol" org-cdlatex-math-modify
19108 (org-inside-LaTeX-fragment-p)]
19109 ["Insert citation" org-reftex-citation t]
19110 "--"
19111 ["Template for BEAMER" org-insert-beamer-options-template t])
19112 "--"
19113 ("MobileOrg"
19114 ["Push Files and Views" org-mobile-push t]
19115 ["Get Captured and Flagged" org-mobile-pull t]
19116 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19117 "--"
19118 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19119 "--"
19120 ("Documentation"
19121 ["Show Version" org-version t]
19122 ["Info Documentation" org-info t])
19123 ("Customize"
19124 ["Browse Org Group" org-customize t]
19125 "--"
19126 ["Expand This Menu" org-create-customize-menu
19127 (fboundp 'customize-menu-create)])
19128 ["Send bug report" org-submit-bug-report t]
19129 "--"
19130 ("Refresh/Reload"
19131 ["Refresh setup current buffer" org-mode-restart t]
19132 ["Reload Org (after update)" org-reload t]
19133 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19134 ))
19136 (defun org-info (&optional node)
19137 "Read documentation for Org-mode in the info system.
19138 With optional NODE, go directly to that node."
19139 (interactive)
19140 (info (format "(org)%s" (or node ""))))
19142 ;;;###autoload
19143 (defun org-submit-bug-report ()
19144 "Submit a bug report on Org-mode via mail.
19146 Don't hesitate to report any problems or inaccurate documentation.
19148 If you don't have setup sending mail from (X)Emacs, please copy the
19149 output buffer into your mail program, as it gives us important
19150 information about your Org-mode version and configuration."
19151 (interactive)
19152 (require 'reporter)
19153 (org-load-modules-maybe)
19154 (org-require-autoloaded-modules)
19155 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19156 (reporter-submit-bug-report
19157 "emacs-orgmode@gnu.org"
19158 (org-version)
19159 (let (list)
19160 (save-window-excursion
19161 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19162 (delete-other-windows)
19163 (erase-buffer)
19164 (insert "You are about to submit a bug report to the Org-mode mailing list.
19166 We would like to add your full Org-mode and Outline configuration to the
19167 bug report. This greatly simplifies the work of the maintainer and
19168 other experts on the mailing list.
19170 HOWEVER, some variables you have customized may contain private
19171 information. The names of customers, colleagues, or friends, might
19172 appear in the form of file names, tags, todo states, or search strings.
19173 If you answer yes to the prompt, you might want to check and remove
19174 such private information before sending the email.")
19175 (add-text-properties (point-min) (point-max) '(face org-warning))
19176 (when (yes-or-no-p "Include your Org-mode configuration ")
19177 (mapatoms
19178 (lambda (v)
19179 (and (boundp v)
19181 (or (and (symbol-value v)
19183 (and
19184 (get v 'custom-type) (get v 'standard-value)
19185 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19186 (push v list)))))
19187 (kill-buffer (get-buffer "*Warn about privacy*"))
19188 list))
19189 nil nil
19190 "Remember to cover the basics, that is, what you expected to happen and
19191 what in fact did happen. You don't know how to make a good report? See
19193 http://orgmode.org/manual/Feedback.html#Feedback
19195 Your bug report will be posted to the Org-mode mailing list.
19196 ------------------------------------------------------------------------")
19197 (save-excursion
19202 (defun org-install-agenda-files-menu ()
19203 (let ((bl (buffer-list)))
19204 (save-excursion
19205 (while bl
19206 (set-buffer (pop bl))
19207 (if (eq major-mode 'org-mode) (setq bl nil)))
19208 (when (eq major-mode 'org-mode)
19209 (easy-menu-change
19210 '("Org") "File List for Agenda"
19211 (append
19212 (list
19213 ["Edit File List" (org-edit-agenda-file-list) t]
19214 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19215 ["Remove Current File from List" org-remove-file t]
19216 ["Cycle through agenda files" org-cycle-agenda-files t]
19217 ["Occur in all agenda files" org-occur-in-agenda-files t]
19218 "--")
19219 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19221 ;;;; Documentation
19223 ;;;###autoload
19224 (defun org-require-autoloaded-modules ()
19225 (interactive)
19226 (mapc 'require
19227 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19228 org-docbook org-exp org-html org-icalendar
19229 org-id org-latex
19230 org-publish org-remember org-table
19231 org-timer org-xoxo)))
19233 ;;;###autoload
19234 (defun org-reload (&optional uncompiled)
19235 "Reload all org lisp files.
19236 With prefix arg UNCOMPILED, load the uncompiled versions."
19237 (interactive "P")
19238 (require 'find-func)
19240 (dir-org (file-name-directory (org-find-library-name "org")))
19241 (dir-org-contrib (ignore-errors
19242 (file-name-directory
19243 (org-find-library-name "org-contribdir"))))
19244 (babel-files
19245 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19246 (append (list nil "comint" "eval" "exp" "keys"
19247 "lob" "ref" "table" "tangle")
19248 (delq nil
19249 (mapcar
19250 (lambda (lang)
19251 (when (cdr lang) (symbol-name (car lang))))
19252 org-babel-load-languages)))))
19253 (files
19254 (append (directory-files dir-org t file-re)
19255 babel-files
19256 (and dir-org-contrib
19257 (directory-files dir-org-contrib t file-re))))
19258 (remove-re (concat (if (featurep 'xemacs)
19259 "org-colview" "org-colview-xemacs")
19261 (setq files (mapcar 'file-name-sans-extension files))
19262 (setq files (mapcar
19263 (lambda (x) (if (string-match remove-re x) nil x))
19264 files))
19265 (setq files (delq nil files))
19266 (mapc
19267 (lambda (f)
19268 (when (featurep (intern (file-name-nondirectory f)))
19269 (if (and (not uncompiled)
19270 (file-exists-p (concat f ".elc")))
19271 (load (concat f ".elc") nil nil t)
19272 (load (concat f ".el") nil nil t))))
19273 files))
19274 (org-version))
19276 ;;;###autoload
19277 (defun org-customize ()
19278 "Call the customize function with org as argument."
19279 (interactive)
19280 (org-load-modules-maybe)
19281 (org-require-autoloaded-modules)
19282 (customize-browse 'org))
19284 (defun org-create-customize-menu ()
19285 "Create a full customization menu for Org-mode, insert it into the menu."
19286 (interactive)
19287 (org-load-modules-maybe)
19288 (org-require-autoloaded-modules)
19289 (if (fboundp 'customize-menu-create)
19290 (progn
19291 (easy-menu-change
19292 '("Org") "Customize"
19293 `(["Browse Org group" org-customize t]
19294 "--"
19295 ,(customize-menu-create 'org)
19296 ["Set" Custom-set t]
19297 ["Save" Custom-save t]
19298 ["Reset to Current" Custom-reset-current t]
19299 ["Reset to Saved" Custom-reset-saved t]
19300 ["Reset to Standard Settings" Custom-reset-standard t]))
19302 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19304 ;;;; Miscellaneous stuff
19306 ;;; Generally useful functions
19308 (defun org-get-at-bol (property)
19309 "Get text property PROPERTY at beginning of line."
19310 (get-text-property (point-at-bol) property))
19312 (defun org-find-text-property-in-string (prop s)
19313 "Return the first non-nil value of property PROP in string S."
19314 (or (get-text-property 0 prop s)
19315 (get-text-property (or (next-single-property-change 0 prop s) 0)
19316 prop s)))
19318 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19319 "Display the given MESSAGE as a warning."
19320 (if (fboundp 'display-warning)
19321 (display-warning 'org message
19322 (if (featurep 'xemacs) 'warning :warning))
19323 (let ((buf (get-buffer-create "*Org warnings*")))
19324 (with-current-buffer buf
19325 (goto-char (point-max))
19326 (insert "Warning (Org): " message)
19327 (unless (bolp)
19328 (newline)))
19329 (display-buffer buf)
19330 (sit-for 0))))
19332 (defun org-eval (form)
19333 "Eval FORM and return result."
19334 (condition-case error
19335 (eval form)
19336 (error (format "%%![Error: %s]" error))))
19338 (defun org-in-commented-line ()
19339 "Is point in a line starting with `#'?"
19340 (equal (char-after (point-at-bol)) ?#))
19342 (defun org-in-indented-comment-line ()
19343 "Is point in a line starting with `#' after some white space?"
19344 (save-excursion
19345 (save-match-data
19346 (goto-char (point-at-bol))
19349 (defun org-in-verbatim-emphasis ()
19350 (save-match-data
19351 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19353 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19354 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19355 (if (and marker (marker-buffer marker)
19356 (buffer-live-p (marker-buffer marker)))
19357 (progn
19358 (org-pop-to-buffer-same-window (marker-buffer marker))
19359 (if (or (> marker (point-max)) (< marker (point-min)))
19360 (widen))
19361 (goto-char marker)
19362 (org-show-context 'org-goto))
19363 (if bookmark
19364 (bookmark-jump bookmark)
19365 (error "Cannot find location"))))
19367 (defun org-quote-csv-field (s)
19368 "Quote field for inclusion in CSV material."
19371 s))
19373 (defun org-force-self-insert (N)
19374 "Needed to enforce self-insert under remapping."
19375 (interactive "p")
19376 (self-insert-command N))
19378 (defun org-string-width (s)
19379 "Compute width of string, ignoring invisible characters.
19380 This ignores character with invisibility property `org-link', and also
19381 characters with property `org-cwidth', because these will become invisible
19382 upon the next fontification round."
19383 (let (b l)
19384 (when (or (eq t buffer-invisibility-spec)
19385 (assq 'org-link buffer-invisibility-spec))
19386 (while (setq b (text-property-any 0 (length s)
19387 'invisible 'org-link s))
19388 (setq s (concat (substring s 0 b)
19389 (substring s (or (next-single-property-change
19390 b 'invisible s) (length s)))))))
19391 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19392 (setq s (concat (substring s 0 b)
19393 (substring s (or (next-single-property-change
19394 b 'org-cwidth s) (length s))))))
19395 (setq l (string-width s) b -1)
19396 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19397 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19398 l))
19400 (defun org-shorten-string (s maxlength)
19401 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19402 If the string is shorter or has length MAXLENGTH, just return the
19403 original string. If it is longer, the functions finds a space in the
19404 string, breaks this string off at that locations and adds three dots
19405 as ellipsis. Including the ellipsis, the string will not be longer
19406 than MAXLENGTH. If finding a good breaking point in the string does
19407 not work, the string is just chopped off in the middle of a word
19408 if necessary."
19409 (if (<= (length s) maxlength)
19410 s
19411 (let* ((n (max (- maxlength 4) 1))
19413 (if (string-match re s)
19414 (concat (match-string 1 s) "...")
19415 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19417 (defun org-get-indentation (&optional line)
19418 "Get the indentation of the current line, interpreting tabs.
19419 When LINE is given, assume it represents a line and compute its indentation."
19420 (if line
19421 (if (string-match "^ *" (org-remove-tabs line))
19422 (match-end 0))
19423 (save-excursion
19424 (beginning-of-line 1)
19426 (current-column))))
19428 (defun org-get-string-indentation (s)
19429 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19430 (let ((n -1) (i 0) (w tab-width) c)
19431 (catch 'exit
19432 (while (< (setq n (1+ n)) (length s))
19433 (setq c (aref s n))
19434 (cond ((= c ?\ ) (setq i (1+ i)))
19436 (t (throw 'exit t)))))
19437 i))
19439 (defun org-remove-tabs (s &optional width)
19440 "Replace tabulators in S with spaces.
19441 Assumes that s is a single line, starting in column 0."
19442 (setq width (or width tab-width))
19444 (setq s (replace-match
19445 (make-string
19446 (- (* width (/ (+ (match-beginning 0) width) width))
19447 (match-beginning 0)) ?\ )
19448 t t s)))
19449 s)
19451 (defun org-fix-indentation (line ind)
19452 "Fix indentation in LINE.
19453 IND is a cons cell with target and minimum indentation.
19454 If the current indentation in LINE is smaller than the minimum,
19455 leave it alone. If it is larger than ind, set it to the target."
19456 (let* ((l (org-remove-tabs line))
19457 (i (org-get-indentation l))
19458 (i1 (car ind)) (i2 (cdr ind)))
19459 (if (>= i i2) (setq l (substring line i2)))
19460 (if (> i1 0)
19461 (concat (make-string i1 ?\ ) l)
19462 l)))
19464 (defun org-remove-indentation (code &optional n)
19465 "Remove the maximum common indentation from the lines in CODE.
19466 N may optionally be the number of spaces to remove."
19467 (with-temp-buffer
19468 (insert code)
19469 (org-do-remove-indentation n)
19470 (buffer-string)))
19472 (defun org-do-remove-indentation (&optional n)
19473 "Remove the maximum common indentation from the buffer."
19474 (untabify (point-min) (point-max))
19475 (let ((min 10000) re)
19476 (if n
19477 (setq min n)
19478 (goto-char (point-min))
19480 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19481 (unless (or (= min 0) (= min 10000))
19483 (goto-char (point-min))
19484 (while (re-search-forward re nil t)
19485 (replace-match "")
19486 (end-of-line 1))
19487 min)))
19489 (defun org-fill-template (template alist)
19490 "Find each %key of ALIST in TEMPLATE and replace it."
19491 (let ((case-fold-search nil)
19492 entry key value)
19493 (setq alist (sort (copy-sequence alist)
19494 (lambda (a b) (< (length (car a)) (length (car b))))))
19495 (while (setq entry (pop alist))
19496 (setq template
19497 (replace-regexp-in-string
19498 (concat "%" (regexp-quote (car entry)))
19499 (cdr entry) template t t)))
19500 template))
19502 (defun org-base-buffer (buffer)
19503 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19504 (if (not buffer)
19505 buffer
19506 (or (buffer-base-buffer buffer)
19507 buffer)))
19509 (defun org-trim (s)
19510 "Remove whitespace at beginning and end of string."
19513 s)
19515 (defun org-wrap (string &optional width lines)
19516 "Wrap string to either a number of lines, or a width in characters.
19517 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19518 that costs. If there is a word longer than WIDTH, the text is actually
19519 wrapped to the length of that word.
19520 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19521 many lines, whatever width that takes.
19522 The return value is a list of lines, without newlines at the end."
19524 (maxword (apply 'max (mapcar 'org-string-width words)))
19525 w ll)
19526 (cond (width
19527 (org-do-wrap words (max maxword width)))
19528 (lines
19529 (setq w maxword)
19530 (setq ll (org-do-wrap words maxword))
19531 (if (<= (length ll) lines)
19532 ll
19533 (setq ll words)
19534 (while (> (length ll) lines)
19535 (setq w (1+ w))
19536 (setq ll (org-do-wrap words w)))
19537 ll))
19538 (t (error "Cannot wrap this")))))
19540 (defun org-do-wrap (words width)
19541 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19542 (let (lines line)
19543 (while words
19544 (setq line (pop words))
19545 (while (and words (< (+ (length line) (length (car words))) width))
19546 (setq line (concat line " " (pop words))))
19547 (setq lines (push line lines)))
19548 (nreverse lines)))
19550 (defun org-split-string (string &optional separators)
19551 "Splits STRING into substrings at SEPARATORS.
19552 No empty strings are returned if there are matches at the beginning
19553 and end of string."
19555 (start 0)
19556 notfirst
19557 (list nil))
19558 (while (and (string-match rexp string
19559 (if (and notfirst
19560 (= start (match-beginning 0))
19561 (< start (length string)))
19562 (1+ start) start))
19563 (< (match-beginning 0) (length string)))
19564 (setq notfirst t)
19565 (or (eq (match-beginning 0) 0)
19566 (and (eq (match-beginning 0) (match-end 0))
19567 (eq (match-beginning 0) start))
19568 (setq list
19569 (cons (substring string start (match-beginning 0))
19570 list)))
19571 (setq start (match-end 0)))
19572 (or (eq start (length string))
19573 (setq list
19574 (cons (substring string start)
19575 list)))
19576 (nreverse list)))
19578 (defun org-quote-vert (s)
19580 (while (string-match "|" s)
19582 s)
19584 (defun org-uuidgen-p (s)
19585 "Is S an ID created by UUIDGEN?"
19586 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19588 (defun org-in-src-block-p nil
19589 "Whether point is in a code source block."
19590 (let (ov)
19591 (when (setq ov (overlays-at (point)))
19592 (memq 'org-block-background
19593 (overlay-properties
19594 (car ov))))))
19596 (defun org-context ()
19597 "Return a list of contexts of the current cursor position.
19598 If several contexts apply, all are returned.
19599 Each context entry is a list with a symbol naming the context, and
19600 two positions indicating start and end of the context. Possible
19601 contexts are:
19603 :headline anywhere in a headline
19604 :headline-stars on the leading stars in a headline
19605 :todo-keyword on a TODO keyword (including DONE) in a headline
19606 :tags on the TAGS in a headline
19607 :priority on the priority cookie in a headline
19608 :item on the first line of a plain list item
19609 :item-bullet on the bullet/number of a plain list item
19610 :checkbox on the checkbox in a plain list item
19611 :table in an org-mode table
19612 :table-special on a special filed in a table
19613 :table-table in a table.el table
19614 :clocktable in a clocktable
19615 :src-block in a source block
19616 :link on a hyperlink
19617 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
19618 :target on a <<target>>
19619 :radio-target on a <<<radio-target>>>
19620 :latex-fragment on a LaTeX fragment
19621 :latex-preview on a LaTeX fragment with overlaid preview image
19623 This function expects the position to be visible because it uses font-lock
19624 faces as a help to recognize the following contexts: :table-special, :link,
19625 and :keyword."
19626 (let* ((f (get-text-property (point) 'face))
19627 (faces (if (listp f) f (list f)))
19628 (case-fold-search t)
19629 (p (point)) clist o)
19630 ;; First the large context
19631 (cond
19632 ((org-at-heading-p t)
19633 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19634 (when (progn
19635 (beginning-of-line 1)
19636 (looking-at org-todo-line-tags-regexp))
19637 (push (org-point-in-group p 1 :headline-stars) clist)
19638 (push (org-point-in-group p 2 :todo-keyword) clist)
19639 (push (org-point-in-group p 4 :tags) clist))
19640 (goto-char p)
19643 (push (org-point-in-group p 0 :priority) clist)))
19645 ((org-at-item-p)
19646 (push (org-point-in-group p 2 :item-bullet) clist)
19647 (push (list :item (point-at-bol)
19648 (save-excursion (org-end-of-item) (point)))
19649 clist)
19650 (and (org-at-item-checkbox-p)
19651 (push (org-point-in-group p 0 :checkbox) clist)))
19653 ((org-at-table-p)
19654 (push (list :table (org-table-begin) (org-table-end)) clist)
19655 (if (memq 'org-formula faces)
19656 (push (list :table-special
19657 (previous-single-property-change p 'face)
19658 (next-single-property-change p 'face)) clist)))
19659 ((org-at-table-p 'any)
19660 (push (list :table-table) clist)))
19661 (goto-char p)
19663 ;; New the "medium" contexts: clocktables, source blocks
19664 (cond ((org-in-clocktable-p)
19665 (push (list :clocktable
19667 (search-backward "#+BEGIN: clocktable" nil t))
19668 (match-beginning 0))
19670 (match-end 0))) clist))
19671 ((org-in-src-block-p)
19672 (push (list :src-block
19674 (search-backward "#+BEGIN_SRC" nil t))
19675 (match-beginning 0))
19676 (and (search-forward "#+END_SRC" nil t)
19677 (match-beginning 0))) clist)))
19678 (goto-char p)
19680 ;; Now the small context
19681 (cond
19682 ((org-at-timestamp-p)
19683 (push (org-point-in-group p 0 :timestamp) clist))
19684 ((memq 'org-link faces)
19685 (push (list :link
19686 (previous-single-property-change p 'face)
19687 (next-single-property-change p 'face)) clist))
19688 ((memq 'org-special-keyword faces)
19689 (push (list :keyword
19690 (previous-single-property-change p 'face)
19691 (next-single-property-change p 'face)) clist))
19692 ((org-at-target-p)
19693 (push (org-point-in-group p 0 :target) clist)
19694 (goto-char (1- (match-beginning 0)))
19695 (if (looking-at org-radio-target-regexp)
19696 (push (org-point-in-group p 0 :radio-target) clist))
19697 (goto-char p))
19698 ((setq o (car (delq nil
19699 (mapcar
19700 (lambda (x)
19701 (if (memq x org-latex-fragment-image-overlays) x))
19702 (overlays-at (point))))))
19703 (push (list :latex-fragment
19704 (overlay-start o) (overlay-end o)) clist)
19705 (push (list :latex-preview
19706 (overlay-start o) (overlay-end o)) clist))
19707 ((org-inside-LaTeX-fragment-p)
19708 ;; FIXME: positions wrong.
19709 (push (list :latex-fragment (point) (point)) clist)))
19711 (setq clist (nreverse (delq nil clist)))
19712 clist))
19714 ;; FIXME: Compare with at-regexp-p Do we need both?
19715 (defun org-in-regexp (re &optional nlines visually)
19716 "Check if point is inside a match of regexp.
19717 Normally only the current line is checked, but you can include NLINES extra
19718 lines both before and after point into the search.
19719 If VISUALLY is set, require that the cursor is not after the match but
19720 really on, so that the block visually is on the match."
19721 (catch 'exit
19722 (let ((pos (point))
19723 (eol (point-at-eol (+ 1 (or nlines 0))))
19724 (inc (if visually 1 0)))
19725 (save-excursion
19726 (beginning-of-line (- 1 (or nlines 0)))
19727 (while (re-search-forward re eol t)
19728 (if (and (<= (match-beginning 0) pos)
19729 (>= (+ inc (match-end 0)) pos))
19730 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19732 (defun org-at-regexp-p (regexp)
19733 "Is point inside a match of REGEXP in the current line?"
19734 (catch 'exit
19735 (save-excursion
19736 (let ((pos (point)) (end (point-at-eol)))
19737 (beginning-of-line 1)
19738 (while (re-search-forward regexp end t)
19739 (if (and (<= (match-beginning 0) pos)
19740 (>= (match-end 0) pos))
19741 (throw 'exit t)))
19742 nil))))
19744 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19745 "Non-nil when point is between matches of START-RE and END-RE.
19747 Also return a non-nil value when point is on one of the matches.
19749 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19750 buffer positions. Default values are the positions of headlines
19751 surrounding the point.
19753 The functions returns a cons cell whose car (resp. cdr) is the
19754 position before START-RE (resp. after END-RE)."
19755 (save-match-data
19756 (let ((pos (point))
19757 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19758 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19759 beg end)
19760 (save-excursion
19761 ;; Point is on a block when on START-RE or if START-RE can be
19762 ;; found before it...
19763 (and (or (org-at-regexp-p start-re)
19764 (re-search-backward start-re limit-up t))
19765 (setq beg (match-beginning 0))
19766 ;; ... and END-RE after it...
19767 (goto-char (match-end 0))
19768 (re-search-forward end-re limit-down t)
19769 (> (setq end (match-end 0)) pos)
19770 ;; ... without another START-RE in-between.
19771 (goto-char (match-beginning 0))
19772 (not (re-search-backward start-re (1+ beg) t))
19773 ;; Return value.
19774 (cons beg end))))))
19776 (defun org-in-block-p (names)
19777 "Non-nil when point belongs to a block whose name belongs to NAMES.
19779 NAMES is a list of strings containing names of blocks.
19781 Return first block name matched, or nil. Beware that in case of
19782 nested blocks, the returned name may not belong to the closest
19783 block from point."
19784 (save-match-data
19785 (catch 'exit
19786 (let ((case-fold-search t)
19787 (lim-up (save-excursion (outline-previous-heading)))
19788 (lim-down (save-excursion (outline-next-heading))))
19789 (mapc (lambda (name)
19790 (let ((n (regexp-quote name)))
19791 (when (org-between-regexps-p
19794 lim-up lim-down)
19795 (throw 'exit n))))
19796 names))
19797 nil)))
19799 (defun org-occur-in-agenda-files (regexp &optional nlines)
19800 "Call `multi-occur' with buffers for all agenda files."
19802 (let* ((files (org-agenda-files))
19803 (tnames (mapcar 'file-truename files))
19804 (extra org-agenda-text-search-extra-files)
19805 f)
19806 (when (eq (car extra) 'agenda-archives)
19807 (setq extra (cdr extra))
19808 (setq files (org-add-archive-files files)))
19809 (while (setq f (pop extra))
19810 (unless (member (file-truename f) tnames)
19811 (add-to-list 'files f 'append)
19812 (add-to-list 'tnames (file-truename f) 'append)))
19813 (multi-occur
19814 (mapcar (lambda (x)
19815 (with-current-buffer
19816 (or (get-file-buffer x) (find-file-noselect x))
19817 (widen)
19818 (current-buffer)))
19819 files)
19820 regexp)))
19822 (if (boundp 'occur-mode-find-occurrence-hook)
19823 ;; Emacs 23
19824 (add-hook 'occur-mode-find-occurrence-hook
19825 (lambda ()
19826 (when (eq major-mode 'org-mode)
19827 (org-reveal))))
19828 ;; Emacs 22
19829 (defadvice occur-mode-goto-occurrence
19830 (after org-occur-reveal activate)
19831 (and (eq major-mode 'org-mode) (org-reveal)))
19832 (defadvice occur-mode-goto-occurrence-other-window
19833 (after org-occur-reveal activate)
19834 (and (eq major-mode 'org-mode) (org-reveal)))
19835 (defadvice occur-mode-display-occurrence
19836 (after org-occur-reveal activate)
19837 (when (eq major-mode 'org-mode)
19838 (let ((pos (occur-mode-find-occurrence)))
19839 (with-current-buffer (marker-buffer pos)
19840 (save-excursion
19841 (goto-char pos)
19842 (org-reveal)))))))
19844 (defun org-occur-link-in-agenda-files ()
19845 "Create a link and search for it in the agendas.
19846 The link is not stored in `org-stored-links', it is just created
19847 for the search purpose."
19848 (interactive)
19849 (let ((link (condition-case nil
19850 (org-store-link nil)
19851 (error "Unable to create a link to here"))))
19852 (org-occur-in-agenda-files (regexp-quote link))))
19854 (defun org-uniquify (list)
19855 "Remove duplicate elements from LIST."
19856 (let (res)
19857 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19858 res))
19860 (defun org-delete-all (elts list)
19861 "Remove all elements in ELTS from LIST."
19862 (while elts
19863 (setq list (delete (pop elts) list)))
19864 list)
19866 (defun org-count (cl-item cl-seq)
19867 "Count the number of occurrences of ITEM in SEQ.
19868 Taken from `count' in cl-seq.el with all keyword arguments removed."
19869 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19870 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19871 (while (< cl-start cl-end)
19872 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19873 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19874 (setq cl-start (1+ cl-start)))
19875 cl-count))
19877 (defun org-remove-if (predicate seq)
19878 "Remove everything from SEQ that fulfills PREDICATE."
19879 (let (res e)
19880 (while seq
19881 (setq e (pop seq))
19882 (if (not (funcall predicate e)) (push e res)))
19883 (nreverse res)))
19885 (defun org-remove-if-not (predicate seq)
19886 "Remove everything from SEQ that does not fulfill PREDICATE."
19887 (let (res e)
19888 (while seq
19889 (setq e (pop seq))
19890 (if (funcall predicate e) (push e res)))
19891 (nreverse res)))
19893 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19894 "Reduce two-argument FUNCTION across SEQ.
19895 Taken from `reduce' in cl-seq.el with all keyword arguments but
19897 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19898 (cadr (memq :initial-value cl-keys)))
19899 (cl-seq (pop cl-seq))
19900 (t (funcall cl-func)))))
19901 (while cl-seq
19902 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19903 cl-accum))
19905 (defun org-back-over-empty-lines ()
19906 "Move backwards over whitespace, to the beginning of the first empty line.
19907 Returns the number of empty lines passed."
19908 (let ((pos (point)))
19909 (if (cdr (assoc 'heading org-blank-before-new-entry))
19911 (unless (eobp)
19912 (forward-line -1)))
19913 (beginning-of-line 2)
19914 (goto-char (min (point) pos))
19915 (count-lines (point) pos)))
19917 (defun org-skip-whitespace ()
19920 (defun org-point-in-group (point group &optional context)
19921 "Check if POINT is in match-group GROUP.
19922 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19923 match. If the match group does not exist or point is not inside it,
19924 return nil."
19925 (and (match-beginning group)
19926 (>= point (match-beginning group))
19927 (<= point (match-end group))
19928 (if context
19929 (list context (match-beginning group) (match-end group))
19930 t)))
19932 (defun org-switch-to-buffer-other-window (&rest args)
19933 "Switch to buffer in a second window on the current frame.
19934 In particular, do not allow pop-up frames.
19935 Returns the newly created buffer."
19936 (let (pop-up-frames special-display-buffer-names special-display-regexps
19937 special-display-function)
19938 (apply 'switch-to-buffer-other-window args)))
19940 (defun org-combine-plists (&rest plists)
19941 "Create a single property list from all plists in PLISTS.
19942 The process starts by copying the first list, and then setting properties
19943 from the other lists. Settings in the last list are the most significant
19944 ones and overrule settings in the other lists."
19945 (let ((rtn (copy-sequence (pop plists)))
19946 p v ls)
19947 (while plists
19948 (setq ls (pop plists))
19949 (while ls
19950 (setq p (pop ls) v (pop ls))
19951 (setq rtn (plist-put rtn p v))))
19952 rtn))
19954 (defun org-move-line-down (arg)
19955 "Move the current line down. With prefix argument, move it past ARG lines."
19956 (interactive "p")
19957 (let ((col (current-column))
19958 beg end pos)
19959 (beginning-of-line 1) (setq beg (point))
19960 (beginning-of-line 2) (setq end (point))
19961 (beginning-of-line (+ 1 arg))
19962 (setq pos (move-marker (make-marker) (point)))
19963 (insert (delete-and-extract-region beg end))
19964 (goto-char pos)
19965 (org-move-to-column col)))
19967 (defun org-move-line-up (arg)
19968 "Move the current line up. With prefix argument, move it past ARG lines."
19969 (interactive "p")
19970 (let ((col (current-column))
19971 beg end pos)
19972 (beginning-of-line 1) (setq beg (point))
19973 (beginning-of-line 2) (setq end (point))
19974 (beginning-of-line (- arg))
19975 (setq pos (move-marker (make-marker) (point)))
19976 (insert (delete-and-extract-region beg end))
19977 (goto-char pos)
19978 (org-move-to-column col)))
19980 (defun org-replace-escapes (string table)
19981 "Replace %-escapes in STRING with values in TABLE.
19983 The sequences in STRING may contain normal field width and padding information,
19985 so values can contain further %-escapes if they are define later in TABLE."
19986 (let ((tbl (copy-alist table))
19987 (case-fold-search nil)
19988 (pchg 0)
19989 e re rpl)
19990 (while (setq e (pop tbl))
19991 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19992 (when (and (cdr e) (string-match re (cdr e)))
19993 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19994 (safe "SREF"))
19995 (add-text-properties 0 3 (list 'sref sref) safe)
19996 (setcdr e (replace-match safe t t (cdr e)))))
19997 (while (string-match re string)
19998 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19999 (cdr e)))
20000 (setq string (replace-match rpl t t string))))
20001 (while (setq pchg (next-property-change pchg string))
20002 (let ((sref (get-text-property pchg 'sref string)))
20003 (when (and sref (string-match "SREF" string pchg))
20004 (setq string (replace-match sref t t string)))))
20005 string))
20007 (defun org-sublist (list start end)
20008 "Return a section of LIST, from START to END.
20009 Counting starts at 1."
20010 (let (rtn (c start))
20011 (setq list (nthcdr (1- start) list))
20012 (while (and list (<= c end))
20013 (push (pop list) rtn)
20014 (setq c (1+ c)))
20015 (nreverse rtn)))
20017 (defun org-find-base-buffer-visiting (file)
20018 "Like `find-buffer-visiting' but always return the base buffer and
20019 not an indirect buffer."
20020 (let ((buf (or (get-file-buffer file)
20021 (find-buffer-visiting file))))
20022 (if buf
20023 (or (buffer-base-buffer buf) buf)
20024 nil)))
20026 (defun org-image-file-name-regexp (&optional extensions)
20027 "Return regexp matching the file names of images.
20028 If EXTENSIONS is given, only match these."
20029 (if (and (not extensions) (fboundp 'image-file-name-regexp))
20030 (image-file-name-regexp)
20031 (let ((image-file-name-extensions
20032 (or extensions
20033 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
20034 "xbm" "xpm" "pbm" "pgm" "ppm"))))
20036 (regexp-opt (nconc (mapcar 'upcase
20037 image-file-name-extensions)
20038 image-file-name-extensions)
20039 t)
20042 (defun org-file-image-p (file &optional extensions)
20043 "Return non-nil if FILE is an image."
20044 (save-match-data
20045 (string-match (org-image-file-name-regexp extensions) file)))
20047 (defun org-get-cursor-date ()
20048 "Return the date at cursor in as a time.
20049 This works in the calendar and in the agenda, anywhere else it just
20050 returns the current time."
20051 (let (date day defd)
20052 (cond
20053 ((eq major-mode 'calendar-mode)
20054 (setq date (calendar-cursor-to-date)
20055 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
20056 ((eq major-mode 'org-agenda-mode)
20057 (setq day (get-text-property (point) 'day))
20058 (if day
20059 (setq date (calendar-gregorian-from-absolute day)
20060 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
20061 (nth 2 date))))))
20062 (or defd (current-time))))
20064 (defvar org-agenda-action-marker (make-marker)
20065 "Marker pointing to the entry for the next agenda action.")
20067 (defun org-mark-entry-for-agenda-action ()
20068 "Mark the current entry as target of an agenda action.
20069 Agenda actions are actions executed from the agenda with the key `k',
20070 which make use of the date at the cursor."
20071 (interactive)
20072 (move-marker org-agenda-action-marker
20073 (save-excursion (org-back-to-heading t) (point))
20074 (current-buffer))
20075 (message
20076 "Entry marked for action; press `k' at desired date in agenda or calendar"))
20078 (defun org-mark-subtree ()
20079 "Mark the current subtree.
20080 This puts point at the start of the current subtree, and mark at the end.
20082 If point is in an inline task, mark that task instead."
20083 (interactive)
20084 (let ((inline-task-p
20085 (and (featurep 'org-inlinetask)
20086 (org-inlinetask-in-task-p)))
20087 (beg))
20088 ;; Get beginning of subtree
20089 (cond
20090 (inline-task-p (org-inlinetask-goto-beginning))
20091 ((org-at-heading-p) (beginning-of-line))
20092 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20093 (setq beg (point))
20094 ;; Get end of it
20095 (if inline-task-p
20096 (org-inlinetask-goto-end)
20097 (org-end-of-subtree))
20098 ;; Mark zone
20099 (push-mark (point) nil t)
20100 (goto-char beg)))
20102 ;;; Paragraph filling stuff.
20103 ;; We want this to be just right, so use the full arsenal.
20105 (defun org-indent-line-function ()
20106 "Indent line depending on context."
20107 (interactive)
20108 (let* ((pos (point))
20109 (itemp (org-at-item-p))
20110 (case-fold-search t)
20112 (inline-task-p (and (featurep 'org-inlinetask)
20113 (org-inlinetask-in-task-p)))
20114 (inline-re (and inline-task-p
20115 (org-inlinetask-outline-regexp)))
20116 column)
20117 (beginning-of-line 1)
20118 (cond
20119 ;; Comments
20120 ((looking-at "# ") (setq column 0))
20121 ;; Headings
20122 ((looking-at org-outline-regexp) (setq column 0))
20123 ;; Included files
20125 ;; Footnote definition
20126 ((looking-at org-footnote-definition-re) (setq column 0))
20127 ;; Literal examples
20129 (setq column (org-get-indentation))) ; do nothing
20130 ;; Lists
20131 ((ignore-errors (goto-char (org-in-item-p)))
20132 (setq column (if itemp
20133 (org-get-indentation)
20134 (org-list-item-body-column (point))))
20135 (goto-char pos))
20136 ;; Drawers
20138 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20139 (save-excursion
20140 (goto-char (1- (match-beginning 1)))
20141 (setq column (current-column))))
20142 ;; Special blocks
20144 (save-excursion
20145 (re-search-backward
20147 (setq column (org-get-indentation (match-string 0))))
20150 (save-excursion
20152 (setq column
20153 (cond ((equal (downcase (match-string 1)) "src")
20154 ;; src blocks: let `org-edit-src-exit' handle them
20155 (org-get-indentation))
20156 ((equal (downcase (match-string 1)) "example")
20157 (max (org-get-indentation)
20158 (org-get-indentation (match-string 0))))
20159 (t
20160 (org-get-indentation (match-string 0))))))
20161 ;; This line has nothing special, look at the previous relevant
20162 ;; line to compute indentation
20163 (t
20164 (beginning-of-line 0)
20165 (while (and (not (bobp))
20166 (not (looking-at org-drawer-regexp))
20167 ;; When point started in an inline task, do not move
20168 ;; above task starting line.
20169 (not (and inline-task-p (looking-at inline-re)))
20170 ;; Skip drawers, blocks, empty lines, verbatim,
20171 ;; comments, tables, footnotes definitions, lists,
20172 ;; inline tasks.
20174 (re-search-backward org-drawer-regexp nil t))
20178 (looking-at org-footnote-definition-re)
20179 (and (ignore-errors (goto-char (org-in-item-p)))
20180 (goto-char
20181 (org-list-get-top-point (org-list-struct))))
20182 (and (not inline-task-p)
20183 (featurep 'org-inlinetask)
20184 (org-inlinetask-in-task-p)
20185 (or (org-inlinetask-goto-beginning) t))))
20186 (beginning-of-line 0))
20187 (cond
20188 ;; There was an heading above.
20190 (if (not org-adapt-indentation)
20191 (setq column 0)
20192 (goto-char (match-end 0))
20193 (setq column (current-column))))
20194 ;; A drawer had started and is unfinished
20195 ((looking-at org-drawer-regexp)
20196 (goto-char (1- (match-beginning 1)))
20197 (setq column (current-column)))
20198 ;; Else, nothing noticeable found: get indentation and go on.
20199 (t (setq column (org-get-indentation))))))
20200 ;; Now apply indentation and move cursor accordingly
20201 (goto-char pos)
20202 (if (<= (current-column) (current-indentation))
20203 (org-indent-line-to column)
20204 (save-excursion (org-indent-line-to column)))
20205 ;; Special polishing for properties, see `org-property-format'
20206 (setq column (current-column))
20207 (beginning-of-line 1)
20208 (if (looking-at
20210 (replace-match (concat (match-string 1)
20211 (format org-property-format
20212 (match-string 2) (match-string 3)))
20213 t t))
20214 (org-move-to-column column)))
20216 (defun org-indent-drawer ()
20217 "Indent the drawer at point."
20218 (interactive)
20219 (let ((p (point))
20220 (e (and (save-excursion (re-search-forward ":END:" nil t))
20221 (match-end 0)))
20222 (folded
20223 (save-excursion
20224 (end-of-line)
20225 (when (overlays-at (point))
20226 (member 'invisible (overlay-properties
20227 (car (overlays-at (point)))))))))
20228 (when folded (org-cycle))
20229 (indent-for-tab-command)
20230 (while (and (move-beginning-of-line 2) (< (point) e))
20231 (indent-for-tab-command))
20232 (goto-char p)
20233 (when folded (org-cycle)))
20234 (message "Drawer at point indented"))
20236 (defun org-indent-block ()
20237 "Indent the block at point."
20238 (interactive)
20239 (let ((p (point))
20240 (case-fold-search t)
20242 (match-end 0)))
20243 (folded
20244 (save-excursion
20245 (end-of-line)
20246 (when (overlays-at (point))
20247 (member 'invisible (overlay-properties
20248 (car (overlays-at (point)))))))))
20249 (when folded (org-cycle))
20250 (indent-for-tab-command)
20251 (while (and (move-beginning-of-line 2) (< (point) e))
20252 (indent-for-tab-command))
20253 (goto-char p)
20254 (when folded (org-cycle)))
20255 (message "Block at point indented"))
20257 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20258 "Variable to store copy of `adaptive-fill-regexp'.
20259 Since `adaptive-fill-regexp' is set to never match, we need to
20260 store a backup of its value before entering `org-mode' so that
20261 the functionality can be provided as a fall-back.")
20263 (defun org-set-autofill-regexps ()
20264 (interactive)
20265 ;; In the paragraph separator we include headlines, because filling
20266 ;; text in a line directly attached to a headline would otherwise
20267 ;; fill the headline as well.
20270 ;; The paragraph starter includes hand-formatted lists.
20271 (org-set-local
20272 'paragraph-start
20273 (concat
20282 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20283 ;; But only if the user has not turned off tables or fixed-width regions
20284 (org-set-local
20285 'auto-fill-inhibit-regexp
20286 (concat org-outline-regexp
20289 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20290 (concat
20292 (if org-enable-table-editor "|" "")
20293 (if org-enable-fixed-width-editor ":" "")
20294 "]"))))
20295 ;; We use our own fill-paragraph function, to make sure that tables
20296 ;; and fixed-width regions are not wrapped. That function will pass
20297 ;; through to `fill-paragraph' when appropriate.
20298 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20299 ;; Prevent auto-fill from inserting unwanted new items.
20300 (if (boundp 'fill-nobreak-predicate)
20301 (org-set-local
20302 'fill-nobreak-predicate
20303 (org-uniquify
20304 (append fill-nobreak-predicate
20305 '(org-fill-item-nobreak-p org-fill-line-break-nobreak-p)))))
20306 ;; Adaptive filling: To get full control, first make sure that
20307 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20308 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20309 (org-set-local 'org-adaptive-fill-regexp-backup
20310 adaptive-fill-regexp))
20312 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20313 (org-set-local 'adaptive-fill-function
20314 'org-adaptive-fill-function)
20315 (org-set-local
20316 'align-mode-rules-list
20317 '((org-in-buffer-settings
20319 (modes . '(org-mode))))))
20321 (defun org-fill-item-nobreak-p ()
20322 "Non-nil when a line break at point would insert a new item."
20323 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20325 (defun org-fill-line-break-nobreak-p ()
20326 "Non-nil when a line break at point would create an Org line break."
20327 (save-excursion
20332 (defun org-fill-paragraph (&optional justify)
20333 "Re-align a table, pass through to fill-paragraph if no table."
20334 (let ((table-p (org-at-table-p))
20335 (table.el-p (org-at-table.el-p))
20336 (itemp (org-in-item-p)))
20337 (cond ((and (equal (char-after (point-at-bol)) ?*)
20338 (save-excursion (goto-char (point-at-bol))
20339 (looking-at org-outline-regexp)))
20340 t) ; skip headlines
20341 (table.el-p t) ; skip table.el tables
20342 (table-p (org-table-align) t) ; align Org tables
20343 (itemp ; align text in items
20344 (let* ((struct (save-excursion (goto-char itemp)
20345 (org-list-struct)))
20346 (parents (org-list-parents-alist struct))
20347 (children (org-list-get-children itemp struct parents))
20348 beg end prev next prefix)
20349 ;; Determine in which part of item point is: before
20350 ;; first child, after last child, between two
20351 ;; sub-lists, or simply in item if there's no child.
20352 (cond
20353 ((not children)
20354 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20355 beg itemp
20356 end (org-list-get-item-end itemp struct)))
20357 ((< (point) (setq next (car children)))
20358 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20359 beg itemp
20360 end next))
20361 ((> (point) (setq prev (car (last children))))
20362 (setq beg (org-list-get-item-end prev struct)
20363 end (org-list-get-item-end itemp struct)
20364 prefix (save-excursion
20365 (goto-char beg)
20367 (make-string (current-column) ?\ ))))
20368 (t (catch 'exit
20369 (while (setq next (pop children))
20370 (if (> (point) next)
20371 (setq prev next)
20372 (setq beg (org-list-get-item-end prev struct)
20373 end next
20374 prefix (save-excursion
20375 (goto-char beg)
20377 (make-string (current-column) ?\ )))
20378 (throw 'exit nil))))))
20379 ;; Use `fill-paragraph' with buffer narrowed to item
20380 ;; without any child, and with our computed PREFIX.
20381 (flet ((fill-context-prefix (from to &optional flr) prefix))
20382 (save-restriction
20383 (narrow-to-region beg end)
20384 (save-excursion (fill-paragraph justify)))) t))
20385 ;; Special case where point is not in a list but is on
20386 ;; a paragraph adjacent to a list: make sure this paragraph
20387 ;; doesn't get merged with the end of the list by narrowing
20388 ;; buffer first.
20389 ((save-excursion (forward-paragraph -1)
20390 (setq itemp (org-in-item-p)))
20391 (let ((struct (save-excursion (goto-char itemp)
20392 (org-list-struct))))
20393 (save-restriction
20394 (narrow-to-region (org-list-get-bottom-point struct)
20395 (save-excursion (forward-paragraph 1)
20396 (point)))
20397 (fill-paragraph justify) t)))
20398 ;; Else simply call `fill-paragraph'.
20399 (t nil))))
20401 ;; For reference, this is the default value of adaptive-fill-regexp
20404 (defun org-adaptive-fill-function ()
20405 "Return a fill prefix for org-mode files."
20406 (let (itemp)
20407 (save-excursion
20408 (cond
20409 ;; Comment line
20411 (match-string-no-properties 0))
20412 ;; Plain list item
20413 ((org-at-item-p)
20414 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20415 ;; Point is in a list after `backward-paragraph': original
20416 ;; point wasn't in the list, or filling would have been taken
20417 ;; care of by `org-auto-fill-function', but the list and the
20418 ;; real paragraph are not separated by a blank line. Thus, move
20419 ;; point after the list to go back to real paragraph and
20420 ;; determine fill-prefix.
20421 ((setq itemp (org-in-item-p))
20422 (goto-char itemp)
20423 (let* ((struct (org-list-struct))
20424 (bottom (org-list-get-bottom-point struct)))
20425 (goto-char bottom)
20426 (make-string (org-get-indentation) ?\ )))
20427 ;; Other text
20428 ((looking-at org-adaptive-fill-regexp-backup)
20429 (match-string-no-properties 0))))))
20431 (defun org-auto-fill-function ()
20432 "Auto-fill function."
20433 (let (itemp prefix)
20434 ;; When in a list, compute an appropriate fill-prefix and make
20435 ;; sure it will be used by `do-auto-fill'.
20436 (if (setq itemp (org-in-item-p))
20437 (progn
20438 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20439 (flet ((fill-context-prefix (from to &optional flr) prefix))
20440 (do-auto-fill)))
20441 ;; Else just use `do-auto-fill'.
20442 (do-auto-fill))))
20444 ;;; Other stuff.
20446 (defun org-toggle-fixed-width-section (arg)
20447 "Toggle the fixed-width export.
20448 If there is no active region, the QUOTE keyword at the current headline is
20449 inserted or removed. When present, it causes the text between this headline
20450 and the next to be exported as fixed-width text, and unmodified.
20451 If there is an active region, this command adds or removes a colon as the
20452 first character of this line. If the first character of a line is a colon,
20453 this line is also exported in fixed-width font."
20454 (interactive "P")
20455 (let* ((cc 0)
20456 (regionp (org-region-active-p))
20457 (beg (if regionp (region-beginning) (point)))
20458 (end (if regionp (region-end)))
20459 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20460 (case-fold-search nil)
20462 off)
20463 (if regionp
20464 (save-excursion
20465 (goto-char beg)
20466 (setq cc (current-column))
20467 (beginning-of-line 1)
20468 (setq off (looking-at re))
20469 (while (> nlines 0)
20470 (setq nlines (1- nlines))
20471 (beginning-of-line 1)
20472 (cond
20473 (arg
20474 (org-move-to-column cc t)
20476 (forward-line -1))
20477 ((and off (looking-at re))
20478 (replace-match "" t t nil 1))
20479 ((not off) (org-move-to-column cc t) (insert ": ")))
20480 (forward-line 1)))
20481 (save-excursion
20482 (org-back-to-heading)
20483 (cond
20484 ((looking-at (format org-heading-keyword-regexp-format
20485 org-quote-string))
20486 (goto-char (match-end 1))
20487 (looking-at (concat " +" org-quote-string))
20488 (replace-match "" t t)
20489 (when (eolp) (insert " ")))
20490 ((looking-at org-outline-regexp)
20491 (goto-char (match-end 0))
20492 (insert org-quote-string " ")))))))
20494 (defun org-reftex-citation ()
20495 "Use reftex-citation to insert a citation into the buffer.
20496 This looks for a line like
20498 #+BIBLIOGRAPHY: foo plain option:-d
20500 and derives from it that foo.bib is the bibliography file relevant
20501 for this document. It then installs the necessary environment for RefTeX
20502 to work in this buffer and calls `reftex-citation' to insert a citation
20503 into the buffer.
20505 Export of such citations to both LaTeX and HTML is handled by the contributed
20506 package org-exp-bibtex by Taru Karttunen."
20507 (interactive)
20508 (let ((reftex-docstruct-symbol 'rds)
20510 rds bib)
20511 (save-excursion
20512 (save-restriction
20513 (widen)
20514 (let ((case-fold-search t)
20516 (if (not (save-excursion
20517 (or (re-search-forward re nil t)
20518 (re-search-backward re nil t))))
20519 (error "No bibliography defined in file")
20520 (setq bib (concat (match-string 1) ".bib")
20521 rds (list (list 'bib bib)))))))
20522 (call-interactively 'reftex-citation)))
20524 ;;;; Functions extending outline functionality
20526 (defun org-beginning-of-line (&optional arg)
20527 "Go to the beginning of the current line. If that is invisible, continue
20528 to a visible line beginning. This makes the function of C-a more intuitive.
20529 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20530 first attempt, and only move to after the tags when the cursor is already
20531 beyond the end of the headline."
20532 (interactive "P")
20533 (let ((pos (point))
20534 (special (if (consp org-special-ctrl-a/e)
20535 (car org-special-ctrl-a/e)
20536 org-special-ctrl-a/e))
20537 refpos)
20538 (if (org-bound-and-true-p line-move-visual)
20539 (beginning-of-visual-line 1)
20540 (beginning-of-line 1))
20541 (if (and arg (fboundp 'move-beginning-of-line))
20542 (call-interactively 'move-beginning-of-line)
20543 (if (bobp)
20544 nil
20545 (backward-char 1)
20546 (if (org-truely-invisible-p)
20547 (while (and (not (bobp)) (org-truely-invisible-p))
20548 (backward-char 1)
20549 (beginning-of-line 1))
20550 (forward-char 1))))
20551 (when special
20552 (cond
20553 ((and (looking-at org-complex-heading-regexp)
20554 (= (char-after (match-end 1)) ?\ ))
20555 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20556 (point-at-eol)))
20557 (goto-char
20558 (if (eq special t)
20559 (cond ((> pos refpos) refpos)
20560 ((= pos (point)) refpos)
20561 (t (point)))
20562 (cond ((> pos (point)) (point))
20563 ((not (eq last-command this-command)) (point))
20564 (t refpos)))))
20565 ((org-at-item-p)
20566 ;; Being at an item and not looking at an the item means point
20567 ;; was previously moved to beginning of a visual line, whiche
20568 ;; doesn't contain the item. Therefore, do nothing special,
20569 ;; just stay here.
20570 (when (looking-at org-list-full-item-re)
20571 ;; Set special position at first white space character after
20572 ;; bullet, and check-box, if any.
20573 (let ((after-bullet
20574 (let ((box (match-end 3)))
20575 (if (not box) (match-end 1)
20576 (let ((after (char-after box)))
20577 (if (and after (= after ? )) (1+ box) box))))))
20578 ;; Special case: Move point to special position when
20579 ;; currently after it or at beginning of line.
20580 (if (eq special t)
20581 (when (or (> pos after-bullet) (= (point) pos))
20582 (goto-char after-bullet))
20583 ;; Reversed case: Move point to special position when
20584 ;; point was already at beginning of line and command is
20585 ;; repeated.
20586 (when (and (= (point) pos) (eq last-command this-command))
20587 (goto-char after-bullet))))))))
20588 (org-no-warnings
20589 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20591 (defun org-end-of-line (&optional arg)
20592 "Go to the end of the line.
20593 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20594 first attempt, and only move to after the tags when the cursor is already
20595 beyond the end of the headline."
20596 (interactive "P")
20597 (let ((special (if (consp org-special-ctrl-a/e)
20598 (cdr org-special-ctrl-a/e)
20599 org-special-ctrl-a/e)))
20600 (cond
20601 ((or (not special) arg
20602 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20603 (call-interactively
20604 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20605 ((fboundp 'move-end-of-line) 'move-end-of-line)
20606 (t 'end-of-line))))
20607 ((org-at-heading-p)
20608 (let ((pos (point)))
20609 (beginning-of-line 1)
20611 (if (eq special t)
20612 (if (or (< pos (match-beginning 1))
20613 (= pos (match-end 0)))
20614 (goto-char (match-beginning 1))
20615 (goto-char (match-end 0)))
20616 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20617 (goto-char (match-end 0))
20618 (goto-char (match-beginning 1))))
20619 (call-interactively (if (fboundp 'move-end-of-line)
20620 'move-end-of-line
20621 'end-of-line)))))
20622 ((org-at-drawer-p)
20623 (move-end-of-line 1)
20624 (when (overlays-at (1- (point))) (backward-char 1)))
20625 ;; At an item: Move before any hidden text.
20626 (t (call-interactively
20627 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20628 ((fboundp 'move-end-of-line) 'move-end-of-line)
20629 (t 'end-of-line)))))
20630 (org-no-warnings
20631 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20633 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20634 (define-key org-mode-map "\C-e" 'org-end-of-line)
20636 (defun org-backward-sentence (&optional arg)
20637 "Go to beginning of sentence, or beginning of table field.
20638 This will call `backward-sentence' or `org-table-beginning-of-field',
20639 depending on context."
20640 (interactive "P")
20641 (cond
20642 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20643 (t (call-interactively 'backward-sentence))))
20645 (defun org-forward-sentence (&optional arg)
20646 "Go to end of sentence, or end of table field.
20647 This will call `forward-sentence' or `org-table-end-of-field',
20648 depending on context."
20649 (interactive "P")
20650 (cond
20651 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20652 (t (call-interactively 'forward-sentence))))
20654 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20655 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20657 (defun org-kill-line (&optional arg)
20658 "Kill line, to tags or end of line."
20659 (interactive "P")
20660 (cond
20661 ((or (not org-special-ctrl-k)
20662 (bolp)
20663 (not (org-at-heading-p)))
20664 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20665 org-ctrl-k-protect-subtree)
20666 (if (or (eq org-ctrl-k-protect-subtree 'error)
20667 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20668 (error "C-k aborted - would kill hidden subtree")))
20669 (call-interactively
20670 (if visual-line-mode 'kill-visual-line 'kill-line)))
20672 (kill-region (point) (match-beginning 1))
20673 (org-set-tags nil t))
20674 (t (kill-region (point) (point-at-eol)))))
20676 (define-key org-mode-map "\C-k" 'org-kill-line)
20678 (defun org-yank (&optional arg)
20679 "Yank. If the kill is a subtree, treat it specially.
20680 This command will look at the current kill and check if is a single
20681 subtree, or a series of subtrees[1]. If it passes the test, and if the
20682 cursor is at the beginning of a line or after the stars of a currently
20683 empty headline, then the yank is handled specially. How exactly depends
20684 on the value of the following variables, both set by default.
20686 org-yank-folded-subtrees
20687 When set, the subtree(s) will be folded after insertion, but only
20688 if doing so would now swallow text after the yanked text.
20690 org-yank-adjusted-subtrees
20691 When set, the subtree will be promoted or demoted in order to
20692 fit into the local outline tree structure, which means that the level
20693 will be adjusted so that it becomes the smaller one of the two
20694 *visible* surrounding headings.
20696 Any prefix to this command will cause `yank' to be called directly with
20698 will just
20699 plainly yank the text as it is.
20701 \[1] The test checks if the first non-white line is a heading
20702 and if there are no other headings with fewer stars."
20703 (interactive "P")
20704 (org-yank-generic 'yank arg))
20706 (defun org-yank-generic (command arg)
20707 "Perform some yank-like command.
20709 This function implements the behavior described in the `org-yank'
20710 documentation. However, it has been generalized to work for any
20711 interactive command with similar behavior."
20713 ;; pretend to be command COMMAND
20714 (setq this-command command)
20716 (if arg
20717 (call-interactively command)
20719 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20720 (and (org-kill-is-subtree-p)
20721 (or (bolp)
20723 (string-match
20725 (buffer-substring (point-at-bol) (point)))))))
20726 swallowp)
20727 (cond
20728 ((and subtreep org-yank-folded-subtrees)
20729 (let ((beg (point))
20730 end)
20731 (if (and subtreep org-yank-adjusted-subtrees)
20732 (org-paste-subtree nil nil 'for-yank)
20733 (call-interactively command))
20735 (setq end (point))
20736 (goto-char beg)
20737 (when (and (bolp) subtreep
20738 (not (setq swallowp
20739 (org-yank-folding-would-swallow-text beg end))))
20740 (org-with-limited-levels
20741 (or (looking-at org-outline-regexp)
20742 (re-search-forward org-outline-regexp-bol end t))
20743 (while (and (< (point) end) (looking-at org-outline-regexp))
20744 (hide-subtree)
20745 (org-cycle-show-empty-lines 'folded)
20746 (condition-case nil
20747 (outline-forward-same-level 1)
20748 (error (goto-char end))))))
20749 (when swallowp
20750 (message
20751 "Inserted text not folded because that would swallow text"))
20753 (goto-char end)
20755 (beginning-of-line 1)
20756 (push-mark beg 'nomsg)))
20757 ((and subtreep org-yank-adjusted-subtrees)
20758 (let ((beg (point-at-bol)))
20759 (org-paste-subtree nil nil 'for-yank)
20760 (push-mark beg 'nomsg)))
20761 (t
20762 (call-interactively command))))))
20764 (defun org-yank-folding-would-swallow-text (beg end)
20765 "Would hide-subtree at BEG swallow any text after END?"
20766 (let (level)
20767 (org-with-limited-levels
20768 (save-excursion
20769 (goto-char beg)
20770 (when (or (looking-at org-outline-regexp)
20771 (re-search-forward org-outline-regexp-bol end t))
20772 (setq level (org-outline-level)))
20773 (goto-char end)
20775 (if (or (eobp)
20776 (and (bolp) (looking-at org-outline-regexp)
20777 (<= (org-outline-level) level)))
20778 nil ; Nothing would be swallowed
20779 t))))) ; something would swallow
20781 (define-key org-mode-map "\C-y" 'org-yank)
20783 (defun org-truely-invisible-p ()
20784 "Check if point is at a character currently not visible.
20785 This version does not only check the character property, but also
20786 `visible-mode'."
20787 ;; Early versions of noutline don't have `outline-invisible-p'.
20788 (if (org-bound-and-true-p visible-mode)
20789 nil
20790 (outline-invisible-p)))
20792 (defun org-invisible-p2 ()
20793 "Check if point is at a character currently not visible."
20794 (save-excursion
20795 (if (and (eolp) (not (bobp))) (backward-char 1))
20796 ;; Early versions of noutline don't have `outline-invisible-p'.
20797 (outline-invisible-p)))
20799 (defun org-back-to-heading (&optional invisible-ok)
20800 "Call `outline-back-to-heading', but provide a better error message."
20801 (condition-case nil
20802 (outline-back-to-heading invisible-ok)
20803 (error (error "Before first headline at position %d in buffer %s"
20804 (point) (current-buffer)))))
20806 (defun org-beginning-of-defun ()
20807 "Go to the beginning of the subtree, i.e. back to the heading."
20808 (org-back-to-heading))
20809 (defun org-end-of-defun ()
20810 "Go to the end of the subtree."
20811 (org-end-of-subtree nil t))
20813 (defun org-before-first-heading-p ()
20814 "Before first heading?"
20815 (save-excursion
20816 (end-of-line)
20817 (null (re-search-backward org-outline-regexp-bol nil t))))
20819 (defun org-at-heading-p (&optional ignored)
20820 (outline-on-heading-p t))
20821 ;; Compatibility alias with Org versions < 7.8.03
20822 (defalias 'org-on-heading-p 'org-at-heading-p)
20824 (defun org-at-drawer-p nil
20825 "Is cursor at a drawer keyword?"
20826 (save-excursion
20827 (move-beginning-of-line 1)
20828 (looking-at org-drawer-regexp)))
20830 (defun org-at-block-p nil
20831 "Is cursor at a block keyword?"
20832 (save-excursion
20833 (move-beginning-of-line 1)
20834 (looking-at org-block-regexp)))
20836 (defun org-point-at-end-of-empty-headline ()
20837 "If point is at the end of an empty headline, return t, else nil.
20838 If the heading only contains a TODO keyword, it is still still considered
20839 empty."
20841 (save-excursion
20842 (beginning-of-line 1)
20843 (let ((case-fold-search nil))
20844 (looking-at org-todo-line-regexp)))
20845 (string= (match-string 3) "")))
20847 (defun org-at-heading-or-item-p ()
20848 (or (org-at-heading-p) (org-at-item-p)))
20850 (defun org-at-target-p ()
20851 (or (org-in-regexp org-radio-target-regexp)
20852 (org-in-regexp org-target-regexp)))
20853 ;; Compatibility alias with Org versions < 7.8.03
20854 (defalias 'org-on-target-p 'org-at-target-p)
20856 (defun org-up-heading-all (arg)
20857 "Move to the heading line of which the present line is a subheading.
20858 This function considers both visible and invisible heading lines.
20859 With argument, move up ARG levels."
20860 (if (fboundp 'outline-up-heading-all)
20861 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20862 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20864 (defun org-up-heading-safe ()
20865 "Move to the heading line of which the present line is a subheading.
20866 This version will not throw an error. It will return the level of the
20867 headline found, or nil if no higher level is found.
20869 Also, this function will be a lot faster than `outline-up-heading',
20870 because it relies on stars being the outline starters. This can really
20871 make a significant difference in outlines with very many siblings."
20872 (let (start-level re)
20873 (org-back-to-heading t)
20874 (setq start-level (funcall outline-level))
20875 (if (equal start-level 1)
20876 nil
20878 (if (re-search-backward re nil t)
20879 (funcall outline-level)))))
20881 (defun org-first-sibling-p ()
20882 "Is this heading the first child of its parents?"
20883 (interactive)
20884 (let ((re org-outline-regexp-bol)
20885 level l)
20886 (unless (org-at-heading-p t)
20887 (error "Not at a heading"))
20888 (setq level (funcall outline-level))
20889 (save-excursion
20890 (if (not (re-search-backward re nil t))
20891 t
20892 (setq l (funcall outline-level))
20893 (< l level)))))
20895 (defun org-goto-sibling (&optional previous)
20896 "Goto the next sibling, even if it is invisible.
20897 When PREVIOUS is set, go to the previous sibling instead. Returns t
20898 when a sibling was found. When none is found, return nil and don't
20899 move point."
20900 (let ((fun (if previous 're-search-backward 're-search-forward))
20901 (pos (point))
20902 (re org-outline-regexp-bol)
20903 level l)
20904 (when (condition-case nil (org-back-to-heading t) (error nil))
20905 (setq level (funcall outline-level))
20906 (catch 'exit
20907 (or previous (forward-char 1))
20908 (while (funcall fun re nil t)
20909 (setq l (funcall outline-level))
20910 (when (< l level) (goto-char pos) (throw 'exit nil))
20911 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20912 (goto-char pos)
20913 nil))))
20915 (defun org-show-siblings ()
20916 "Show all siblings of the current headline."
20917 (save-excursion
20918 (while (org-goto-sibling) (org-flag-heading nil)))
20919 (save-excursion
20920 (while (org-goto-sibling 'previous)
20921 (org-flag-heading nil))))
20923 (defun org-goto-first-child ()
20924 "Goto the first child, even if it is invisible.
20925 Return t when a child was found. Otherwise don't move point and
20926 return nil."
20927 (let (level (pos (point)) (re org-outline-regexp-bol))
20928 (when (condition-case nil (org-back-to-heading t) (error nil))
20929 (setq level (outline-level))
20930 (forward-char 1)
20931 (if (and (re-search-forward re nil t) (> (outline-level) level))
20932 (progn (goto-char (match-beginning 0)) t)
20933 (goto-char pos) nil))))
20935 (defun org-show-hidden-entry ()
20936 "Show an entry where even the heading is hidden."
20937 (save-excursion
20938 (org-show-entry)))
20940 (defun org-flag-heading (flag &optional entry)
20941 "Flag the current heading. FLAG non-nil means make invisible.
20942 When ENTRY is non-nil, show the entire entry."
20943 (save-excursion
20944 (org-back-to-heading t)
20945 ;; Check if we should show the entire entry
20946 (if entry
20947 (progn
20948 (org-show-entry)
20949 (save-excursion
20950 (and (outline-next-heading)
20951 (org-flag-heading nil))))
20952 (outline-flag-region (max (point-min) (1- (point)))
20953 (save-excursion (outline-end-of-heading) (point))
20954 flag))))
20956 (defun org-get-next-sibling ()
20957 "Move to next heading of the same level, and return point.
20958 If there is no such heading, return nil.
20959 This is like outline-next-sibling, but invisible headings are ok."
20960 (let ((level (funcall outline-level)))
20961 (outline-next-heading)
20962 (while (and (not (eobp)) (> (funcall outline-level) level))
20963 (outline-next-heading))
20964 (if (or (eobp) (< (funcall outline-level) level))
20965 nil
20966 (point))))
20968 (defun org-get-last-sibling ()
20969 "Move to previous heading of the same level, and return point.
20970 If there is no such heading, return nil."
20971 (let ((opoint (point))
20972 (level (funcall outline-level)))
20973 (outline-previous-heading)
20974 (when (and (/= (point) opoint) (outline-on-heading-p t))
20975 (while (and (> (funcall outline-level) level)
20976 (not (bobp)))
20977 (outline-previous-heading))
20978 (if (< (funcall outline-level) level)
20979 nil
20980 (point)))))
20982 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20983 ;; This contains an exact copy of the original function, but it uses
20984 ;; `org-back-to-heading', to make it work also in invisible
20985 ;; trees. And is uses an invisible-OK argument.
20986 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20987 ;; Furthermore, when used inside Org, finding the end of a large subtree
20988 ;; with many children and grandchildren etc, this can be much faster
20989 ;; than the outline version.
20990 (org-back-to-heading invisible-OK)
20991 (let ((first t)
20992 (level (funcall outline-level)))
20993 (if (and (eq major-mode 'org-mode) (< level 1000))
20994 ;; A true heading (not a plain list item), in Org-mode
20995 ;; This means we can easily find the end by looking
20996 ;; only for the right number of stars. Using a regexp to do
20997 ;; this is so much faster than using a Lisp loop.
20999 (forward-char 1)
21000 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
21001 ;; something else, do it the slow way
21002 (while (and (not (eobp))
21003 (or first (> (funcall outline-level) level)))
21004 (setq first nil)
21005 (outline-next-heading)))
21006 (unless to-heading
21008 (progn
21009 ;; Go to end of line before heading
21010 (forward-char -1)
21012 ;; leave blank line before heading
21013 (forward-char -1))))))
21014 (point))
21016 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
21017 "Use Org version in org-mode, for dramatic speed-up."
21018 (if (eq major-mode 'org-mode)
21019 (progn
21020 (org-end-of-subtree nil t)
21021 (unless (eobp) (backward-char 1)))
21022 ad-do-it))
21024 (defun org-end-of-meta-data-and-drawers ()
21025 "Jump to the first text after meta data and drawers in the current entry.
21026 This will move over empty lines, lines with planning time stamps,
21027 clocking lines, and drawers."
21028 (org-back-to-heading t)
21029 (let ((end (save-excursion (outline-next-heading) (point)))
21032 (forward-line 1)
21033 (while (re-search-forward re end t)
21034 (if (not (match-end 1))
21035 ;; empty or planning line
21036 (forward-line 1)
21037 ;; a drawer, find the end
21039 (forward-line 1)))
21041 (point)))
21043 (defun org-forward-same-level (arg &optional invisible-ok)
21044 "Move forward to the arg'th subheading at same level as this one.
21045 Stop at the first and last subheadings of a superior heading.
21046 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
21047 it wil also look at invisible ones."
21048 (interactive "p")
21049 (org-back-to-heading invisible-ok)
21050 (org-at-heading-p)
21051 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21053 l)
21054 (forward-char 1)
21055 (while (> arg 0)
21056 (while (and (re-search-forward re nil 'move)
21057 (setq l (- (match-end 0) (match-beginning 0) 1))
21058 (= l level)
21059 (not invisible-ok)
21060 (progn (backward-char 1) (outline-invisible-p)))
21061 (if (< l level) (setq arg 1)))
21062 (setq arg (1- arg)))
21063 (beginning-of-line 1)))
21065 (defun org-backward-same-level (arg &optional invisible-ok)
21066 "Move backward to the arg'th subheading at same level as this one.
21067 Stop at the first and last subheadings of a superior heading."
21068 (interactive "p")
21069 (org-back-to-heading)
21070 (org-at-heading-p)
21071 (let* ((level (- (match-end 0) (match-beginning 0) 1))
21073 l)
21074 (while (> arg 0)
21075 (while (and (re-search-backward re nil 'move)
21076 (setq l (- (match-end 0) (match-beginning 0) 1))
21077 (= l level)
21078 (not invisible-ok)
21079 (outline-invisible-p))
21080 (if (< l level) (setq arg 1)))
21081 (setq arg (1- arg)))))
21083 (defun org-show-subtree ()
21084 "Show everything after this heading at deeper levels."
21085 (outline-flag-region
21086 (point)
21087 (save-excursion
21088 (org-end-of-subtree t t))
21089 nil))
21091 (defun org-show-entry ()
21092 "Show the body directly following this heading.
21093 Show the heading too, if it is currently invisible."
21094 (interactive)
21095 (save-excursion
21096 (condition-case nil
21097 (progn
21098 (org-back-to-heading t)
21099 (outline-flag-region
21100 (max (point-min) (1- (point)))
21101 (save-excursion
21102 (if (re-search-forward
21104 (match-beginning 1)
21105 (point-max)))
21106 nil)
21107 (org-cycle-hide-drawers 'children))
21108 (error nil))))
21110 (defun org-make-options-regexp (kwds &optional extra)
21111 "Make a regular expression for keyword lines."
21112 (concat
21113 "^"
21120 ;; Make isearch reveal the necessary context
21121 (defun org-isearch-end ()
21122 "Reveal context after isearch exits."
21123 (when isearch-success ; only if search was successful
21124 (if (featurep 'xemacs)
21125 ;; Under XEmacs, the hook is run in the correct place,
21126 ;; we directly show the context.
21127 (org-show-context 'isearch)
21128 ;; In Emacs the hook runs *before* restoring the overlays.
21129 ;; So we have to use a one-time post-command-hook to do this.
21130 ;; (Emacs 22 has a special variable, see function `org-mode')
21131 (unless (and (boundp 'isearch-mode-end-hook-quit)
21132 isearch-mode-end-hook-quit)
21133 ;; Only when the isearch was not quitted.
21134 (org-add-hook 'post-command-hook 'org-isearch-post-command
21135 'append 'local)))))
21137 (defun org-isearch-post-command ()
21138 "Remove self from hook, and show context."
21139 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21140 (org-show-context 'isearch))
21143 ;;;; Integration with and fixes for other packages
21145 ;;; Imenu support
21147 (defvar org-imenu-markers nil
21148 "All markers currently used by Imenu.")
21149 (make-variable-buffer-local 'org-imenu-markers)
21151 (defun org-imenu-new-marker (&optional pos)
21152 "Return a new marker for use by Imenu, and remember the marker."
21153 (let ((m (make-marker)))
21154 (move-marker m (or pos (point)))
21155 (push m org-imenu-markers)
21156 m))
21158 (defun org-imenu-get-tree ()
21159 "Produce the index for Imenu."
21160 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21161 (setq org-imenu-markers nil)
21162 (let* ((n org-imenu-depth)
21163 (re (concat "^" (org-get-limited-outline-regexp)))
21164 (subs (make-vector (1+ n) nil))
21165 (last-level 0)
21166 m level head)
21167 (save-excursion
21168 (save-restriction
21169 (widen)
21170 (goto-char (point-max))
21171 (while (re-search-backward re nil t)
21172 (setq level (org-reduced-level (funcall outline-level)))
21173 (when (<= level n)
21174 (looking-at org-complex-heading-regexp)
21175 (setq head (org-link-display-format
21176 (org-match-string-no-properties 4))
21177 m (org-imenu-new-marker))
21178 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21179 (if (>= level last-level)
21180 (push (cons head m) (aref subs level))
21181 (push (cons head (aref subs (1+ level))) (aref subs level))
21182 (loop for i from (1+ level) to n do (aset subs i nil)))
21183 (setq last-level level)))))
21184 (aref subs 1)))
21186 (eval-after-load "imenu"
21187 '(progn
21188 (add-hook 'imenu-after-jump-hook
21189 (lambda ()
21190 (if (eq major-mode 'org-mode)
21191 (org-show-context 'org-goto))))))
21193 (defun org-link-display-format (link)
21194 "Replace a link with either the description, or the link target
21195 if no description is present"
21196 (save-match-data
21197 (if (string-match org-bracket-link-analytic-regexp link)
21198 (replace-match (if (match-end 5)
21199 (match-string 5 link)
21200 (concat (match-string 1 link)
21201 (match-string 3 link)))
21202 nil t link)
21203 link)))
21205 (defun org-toggle-link-display ()
21206 "Toggle the literal or descriptive display of links."
21207 (interactive)
21208 (if org-descriptive-links
21209 (progn (org-remove-from-invisibility-spec '(org-link))
21210 (org-restart-font-lock)
21211 (setq org-descriptive-links nil))
21212 (progn (add-to-invisibility-spec '(org-link))
21213 (org-restart-font-lock)
21214 (setq org-descriptive-links t))))
21216 ;; Speedbar support
21218 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21219 "Overlay marking the agenda restriction line in speedbar.")
21220 (overlay-put org-speedbar-restriction-lock-overlay
21221 'face 'org-agenda-restriction-lock)
21222 (overlay-put org-speedbar-restriction-lock-overlay
21223 'help-echo "Agendas are currently limited to this item.")
21224 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21226 (defun org-speedbar-set-agenda-restriction ()
21227 "Restrict future agenda commands to the location at point in speedbar.
21229 (interactive)
21230 (require 'org-agenda)
21231 (let (p m tp np dir txt)
21232 (cond
21233 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21234 'org-imenu t))
21235 (setq m (get-text-property p 'org-imenu-marker))
21236 (with-current-buffer (marker-buffer m)
21237 (goto-char m)
21238 (org-agenda-set-restriction-lock 'subtree)))
21239 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21240 'speedbar-function 'speedbar-find-file))
21241 (setq tp (previous-single-property-change
21242 (1+ p) 'speedbar-function)
21243 np (next-single-property-change
21244 tp 'speedbar-function)
21245 dir (speedbar-line-directory)
21246 txt (buffer-substring-no-properties (or tp (point-min))
21247 (or np (point-max))))
21248 (with-current-buffer (find-file-noselect
21249 (let ((default-directory dir))
21250 (expand-file-name txt)))
21251 (unless (eq major-mode 'org-mode)
21252 (error "Cannot restrict to non-Org-mode file"))
21253 (org-agenda-set-restriction-lock 'file)))
21254 (t (error "Don't know how to restrict Org-mode's agenda")))
21255 (move-overlay org-speedbar-restriction-lock-overlay
21256 (point-at-bol) (point-at-eol))
21257 (setq current-prefix-arg nil)
21258 (org-agenda-maybe-redo)))
21260 (eval-after-load "speedbar"
21261 '(progn
21262 (speedbar-add-supported-extension ".org")
21263 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21264 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21265 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21266 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21267 (add-hook 'speedbar-visiting-tag-hook
21268 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21270 ;;; Fixes and Hacks for problems with other packages
21272 ;; Make flyspell not check words in links, to not mess up our keymap
21273 (defun org-mode-flyspell-verify ()
21274 "Don't let flyspell put overlays at active buttons, or on
21275 {todo,all-time,additional-option-like}-keywords."
21276 (let ((pos (max (1- (point)) (point-min)))
21277 (word (thing-at-point 'word)))
21278 (and (not (get-text-property pos 'keymap))
21279 (not (get-text-property pos 'org-no-flyspell))
21280 (not (member word org-todo-keywords-1))
21281 (not (member word org-all-time-keywords))
21282 (not (member word org-additional-option-like-keywords)))))
21284 (defun org-remove-flyspell-overlays-in (beg end)
21285 "Remove flyspell overlays in region."
21286 (and (org-bound-and-true-p flyspell-mode)
21287 (fboundp 'flyspell-delete-region-overlays)
21288 (flyspell-delete-region-overlays beg end))
21289 (add-text-properties beg end '(org-no-flyspell t)))
21291 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21292 (eval-after-load "bookmark"
21293 '(if (boundp 'bookmark-after-jump-hook)
21294 ;; We can use the hook
21295 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21296 ;; Hook not available, use advice
21297 (defadvice bookmark-jump (after org-make-visible activate)
21298 "Make the position visible."
21299 (org-bookmark-jump-unhide))))
21301 ;; Make sure saveplace shows the location if it was hidden
21302 (eval-after-load "saveplace"
21303 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21304 "Make the position visible."
21305 (org-bookmark-jump-unhide)))
21307 ;; Make sure ecb shows the location if it was hidden
21308 (eval-after-load "ecb"
21309 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21310 "Make hierarchy visible when jumping into location from ECB tree buffer."
21311 (if (eq major-mode 'org-mode)
21312 (org-show-context))))
21314 (defun org-bookmark-jump-unhide ()
21315 "Unhide the current position, to show the bookmark location."
21316 (and (eq major-mode 'org-mode)
21317 (or (outline-invisible-p)
21318 (save-excursion (goto-char (max (point-min) (1- (point))))
21319 (outline-invisible-p)))
21320 (org-show-context 'bookmark-jump)))
21322 ;; Make session.el ignore our circular variable
21323 (eval-after-load "session"
21324 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21326 ;;;; Experimental code
21328 (defun org-closed-in-range ()
21329 "Sparse tree of items closed in a certain time range.
21330 Still experimental, may disappear in the future."
21331 (interactive)
21332 ;; Get the time interval from the user.
21333 (let* ((time1 (org-float-time
21334 (org-read-date nil 'to-time nil "Starting date: ")))
21335 (time2 (org-float-time
21336 (org-read-date nil 'to-time nil "End date:")))
21337 ;; callback function
21338 (callback (lambda ()
21339 (let ((time
21340 (org-float-time
21341 (apply 'encode-time
21342 (org-parse-time-string
21343 (match-string 1))))))
21344 ;; check if time in interval
21345 (and (>= time time1) (<= time time2))))))
21346 ;; make tree, check each match with the callback
21349 ;;;; Finish up
21351 (provide 'org)
21353 (run-hooks 'org-load-hook)
21355 ;;; org.el ends here