| blob | 18e7fc5f6eef5296c189e0466e4f1f2442ba60ca |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.3
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
78 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
90 ;; Other stuff we need.
104 ;; babel
113 ;; load languages based on value of `org-babel-load-languages'
115 ;;;###autoload
117 "Load the languages defined in `org-babel-load-languages'."
129 org-babel-load-languages))
132 "Languages which can be evaluated in Org-mode buffers.
133 This list can be used to load support for any of the languages
134 below, note that each language will depend on a different set of
135 system executables and/or Emacs modes. When a language is
137 with `org-babel-execute-src-block' bound by default to C-c
138 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
139 be set to remove code block evaluation from the C-c C-c
140 keybinding. By default only Emacs Lisp (which has no
141 requirements) is loaded."
145 :key-type
178 ;;;; Customization variables
180 "Remove ID property of clones of a subtree.
181 When non-nil, clones of a subtree don't inherit the ID property.
182 Otherwise they inherit the ID property with a new unique
183 identifier."
187 ;;; Version
193 "Show the org-mode version in the echo area.
194 With prefix arg HERE, insert it at point."
220 ;;; Compatibility constants
222 ;;; The custom variables
225 "Outline-based notes management and organizer."
231 "Mode hook for Org-mode, run after the mode was turned on."
236 "Hook that is run after org.el has been loaded."
245 "Load all extensions listed in `org-modules'."
250 org-modules)
254 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
263 (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)
264 "Modules that should always be loaded together with org.el.
265 If a description starts with <C>, the file is not part of Emacs
266 and loading it will require that you have downloaded and properly installed
267 the org-mode distribution.
269 You can also use this system to load external packages (i.e. neither Org
270 core modules, nor modules from the CONTRIB directory). Just add symbols
271 to the end of the list. If the package is called org-xyz.el, then you need
272 to add the symbol `xyz', and the package must have a call to
274 (provide 'org-xyz)"
277 :type
307 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
314 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
322 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
339 "Non-nil means make shift-cursor commands select text when possible.
341 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
342 selecting a region, or enlarge regions started in this way.
343 In Org-mode, in special contexts, these same keys are used for other
344 purposes, important enough to compete with shift selection. Org tries
345 to balance these needs by supporting `shift-select-mode' outside these
346 special contexts, under control of this variable.
348 The default of this variable is nil, to avoid confusing behavior. Shifted
349 cursor keys will then execute Org commands in the following contexts:
350 - on a headline, changing TODO state (left/right) and priority (up/down)
351 - on a time stamp, changing the time
352 - in a plain list item, changing the bullet type
353 - in a property definition line, switching between allowed values
354 - in the BEGIN line of a clock table (changing the time block).
355 Outside these contexts, the commands will throw an error.
357 When this variable is t and the cursor is not in a special context,
358 Org-mode will support shift-selection for making and enlarging regions.
359 To make this more effective, the bullet cycling will no longer happen
360 anywhere in an item line, but only if the cursor is exactly on the bullet.
362 If you set this variable to the symbol `always', then the keys
363 will not be special in headlines, property lines, and item lines, to make
364 shift selection work there as well. If this is what you want, you can
365 use the following alternative commands: `C-c C-t' and `C-c ,' to
366 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
367 TODO sets, `C-c -' to cycle item bullet types, and properties can be
368 edited by hand or in column view.
370 However, when the cursor is on a timestamp, shift-cursor commands
371 will still edit the time stamp - this is just too good to give up.
373 XEmacs user should have this variable set to nil, because shift-select-mode
374 is Emacs 23 only."
382 "Options concerning startup of Org-mode."
387 "Non-nil means entering Org-mode will switch to OVERVIEW.
388 This can also be configured on a per-file basis by adding one of
389 the following lines anywhere in the buffer:
391 #+STARTUP: fold (or `overview', this is equivalent)
392 #+STARTUP: nofold (or `showall', this is equivalent)
393 #+STARTUP: content
394 #+STARTUP: showeverything"
403 "Non-nil means entering Org-mode will set `truncate-lines'.
404 This is useful since some lines containing links can be very long and
405 uninteresting. Also tables look terrible when wrapped."
410 "Non-nil means turn on `org-indent-mode' on startup.
411 This can also be configured on a per-file basis by adding one of
412 the following lines anywhere in the buffer:
414 #+STARTUP: indent
415 #+STARTUP: noindent"
423 When this option is turned on, you can use TeX-like syntax for sub- and
425 considered as a single item - so grouping with {} is normally not
426 needed. For example, the following things will be parsed as single
427 sub- or superscripts.
429 10^24 or 10^tau several digits will be considered 1 item.
430 10^-12 or 10^-tau a leading sign with digits or a word
431 x^2-y^3 will be read as x^2 - y^3, because items are
432 terminated by almost any nonword/nondigit char.
433 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
435 Still, ambiguity is possible - so when in doubt use {} to enclose the
436 sub/superscript. If you set this variable to the symbol `{}',
437 the braces are *required* in order to trigger interpretations as
439 frequently in plain text.
441 Not all export backends support this, but HTML does.
456 "Non-nil means turn on `org-beamer-mode' on startup.
457 This can also be configured on a per-file basis by adding one of
458 the following lines anywhere in the buffer:
460 #+STARTUP: beamer"
465 "Non-nil means align all tables when visiting a file.
466 This is useful when the column width in tables is forced with <N> cookies
467 in table fields. Such tables will look correct only after the first re-align.
468 This can also be configured on a per-file basis by adding one of
469 the following lines anywhere in the buffer:
470 #+STARTUP: align
471 #+STARTUP: noalign"
476 "Non-nil means show inline images when loading a new Org file.
477 This can also be configured on a per-file basis by adding one of
478 the following lines anywhere in the buffer:
479 #+STARTUP: inlineimages
480 #+STARTUP: noinlineimages"
485 "Non-nil means insert the first line setting Org-mode in empty files.
486 When the function `org-mode' is called interactively in an empty file, this
487 normally means that the file name does not automatically trigger Org-mode.
488 To ensure that the file will always be in Org-mode in the future, a
489 line enforcing Org-mode will be inserted into the buffer, if this option
490 has been set."
495 "Non-nil means use alternative key bindings for some keys.
496 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
497 These keys are also used by other packages like shift-selection-mode'
498 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
499 If you want to use Org-mode together with one of these other modes,
500 or more generally if you would like to move some Org-mode commands to
501 other keys, set this variable and configure the keys with the variable
502 `org-disputed-keys'.
504 This option is only relevant at load-time of Org-mode, and must be set
505 *before* org.el is loaded. Changing it requires a restart of Emacs to
506 become effective."
511 "Non-nil means use extra key sequence definitions for certain commands.
512 This happens automatically if you run XEmacs or if `window-system'
513 is nil. This variable lets you do the same manually. You must
514 set it before loading org.
516 Example: on Carbon Emacs 22 running graphically, with an external
517 keyboard on a Powerbook, the default way of setting M-left might
518 not work for either Alt or ESC. Setting this variable will make
519 it work for ESC."
533 "Keys for which Org-mode and other modes compete.
534 This is an alist, cars are the default keys, second element specifies
535 the alternative to use when `org-replace-disputed-keys' is t.
537 Keys can be specified in any syntax supported by `define-key'.
538 The value of this option takes effect only at Org-mode's startup,
539 therefore you'll have to restart Emacs to apply it after changing."
544 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
545 Or return the original if not disputed.
546 Also apply the translations defined in `org-xemacs-key-equivalents'."
551 org-disputed-keys)))
555 key)
565 "Define a key, possibly translated, as returned by `org-key'."
569 "The ellipsis to use in the Org-mode outline.
570 When nil, just use the standard three dots. When a string, use that instead,
571 When a face, use the standard 3 dots, but with the specified face.
572 The change affects only Org-mode (which will then use its own display table).
573 Changing this requires executing `M-x org-mode' in a buffer to become
574 effective."
584 "Keywords in Org-mode."
589 "String to mark deadline entries.
590 A deadline is this string, followed by a time stamp. Should be a word,
591 terminated by a colon. You can insert a schedule keyword and
593 Changes become only effective after restarting Emacs."
598 "String to mark scheduled TODO entries.
599 A schedule is this string, followed by a time stamp. Should be a word,
600 terminated by a colon. You can insert a schedule keyword and
602 Changes become only effective after restarting Emacs."
607 "String used as the prefix for timestamps logging closing a TODO entry."
612 "String used as prefix for timestamps clocking work hours on an item."
617 "Entries starting with this keyword will never be exported.
618 An entry can be toggled between COMMENT and normal with
620 Changes become only effective after restarting Emacs."
625 "Entries starting with this keyword will be exported in fixed-width font.
626 Quoting applies only to the text in the entry following the headline, and does
627 not extend beyond the next headline, even if that is lower level.
628 An entry can be toggled between QUOTE and normal with
635 "Regular expression for specifying repeated events.
639 "Options concerning the general structure of Org-mode files."
644 "Options about how to make context of a location visible."
668 "Non-nil means show full hierarchy when revealing a location.
669 Org-mode often shows locations in an org-mode file which might have
670 been invisible before. When this is set, the hierarchy of headings
671 above the exposed location is shown.
672 Turning this off for example for sparse trees makes them very compact.
673 Instead of t, this can also be an alist specifying this option for different
674 contexts. Valid contexts are
675 agenda when exposing an entry from the agenda
676 org-goto when using the command `org-goto' on key C-c C-j
677 occur-tree when using the command `org-occur' on key C-c /
678 tags-tree when constructing a sparse tree based on tags matches
679 link-search when exposing search matches associated with a link
680 mark-goto when exposing the jump goal of a mark
681 bookmark-jump when exposing a bookmark location
682 isearch when exiting from an incremental search
683 default default for all contexts not set explicitly"
688 "Non-nil means show following heading when revealing a location.
689 Org-mode often shows locations in an org-mode file which might have
690 been invisible before. When this is set, the heading following the
691 match is shown.
692 Turning this off for example for sparse trees makes them very compact,
693 but makes it harder to edit the location of the match. In such a case,
695 Instead of t, this can also be an alist specifying this option for different
696 contexts. See `org-show-hierarchy-above' for valid contexts."
701 "Non-nil means show all sibling heading when revealing a location.
702 Org-mode often shows locations in an org-mode file which might have
703 been invisible before. When this is set, the sibling of the current entry
704 heading are all made visible. If `org-show-hierarchy-above' is t,
705 the same happens on each level of the hierarchy above the current entry.
707 By default this is on for the isearch context, off for all other contexts.
708 Turning this off for example for sparse trees makes them very compact,
709 but makes it harder to edit the location of the match. In such a case,
711 Instead of t, this can also be an alist specifying this option for different
712 contexts. See `org-show-hierarchy-above' for valid contexts."
717 "Non-nil means show the entry below a headline when revealing a location.
718 Org-mode often shows locations in an org-mode file which might have
719 been invisible before. When this is set, the text below the headline that is
720 exposed is also shown.
722 By default this is off for all contexts.
723 Instead of t, this can also be an alist specifying this option for different
724 contexts. See `org-show-hierarchy-above' for valid contexts."
729 "How should indirect tree buffers be displayed?
730 This applies to indirect buffers created with the commands
732 Valid values are:
733 current-window Display in the current window
734 other-window Just display in another window.
735 dedicated-frame Create one new frame, and re-use it each time.
736 new-frame Make a new frame each time. Note that in this case
737 previously-made indirect buffers are kept, and you need to
738 kill these buffers yourself."
748 "Non-nil means activate single letter commands at beginning of a headline.
749 This may also be a function to test for appropriate locations where speed
750 commands should be active."
758 "Alist of additional speed commands.
759 This list will be checked before `org-speed-commands-default'
760 when the variable `org-use-speed-commands' is non-nil
761 and when the cursor is at the beginning of a headline.
762 The car if each entry is a string with a single letter, which must
763 be assigned to `self-insert-command' in the global map.
764 The cdr is either a command to be called interactively, a function
765 to be called, or a form to be evaluated.
766 An entry that is just a list with a single string will be interpreted
767 as a descriptive headline that will be added when listing the speed
768 commands in the Help buffer using the `?' speed command."
780 "Options concerning visibility cycling in Org-mode."
785 "Non-nil means skip CHILDREN state in entries that don't have any."
790 "Maximum level which should still be subject to visibility cycling.
791 Levels higher than this will, for cycling, be treated as text, not a headline.
792 When `org-odd-levels-only' is set, a value of N in this variable actually
793 means 2N-1 stars as the limiting headline.
794 When nil, cycle all levels.
795 Note that the limiting level of cycling is also influenced by
796 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
797 `org-inlinetask-min-level' is, cycling will be limited to levels one less
798 than its value."
805 "Names of drawers. Drawers are not opened by cycling on the headline above.
806 Drawers only open with a TAB on the drawer line itself. A drawer looks like
807 this:
808 :DRAWERNAME:
809 .....
810 :END:
812 the property API.
814 Drawers can be defined on the per-file basis with a line like:
816 #+DRAWERS: HIDDEN STATE PROPERTIES"
822 "Non-nil means entering Org-mode will fold all blocks.
823 This can also be set in on a per-file basis with
825 #+STARTUP: hideblocks
826 #+STARTUP: showblocks"
832 "Cycle globally if cursor is at beginning of buffer and not at a headline.
833 This makes it possible to do global cycling without having to use S-TAB or
835 of the buffer
836 must not be a headline - it may be empty or some other text. When used in
837 this way, `org-cycle-hook' is disables temporarily, to make sure the
838 cursor stays at the beginning of the buffer.
839 When this option is nil, don't do anything special at the beginning
840 of the buffer."
845 "Non-nil means cycle entry level or item indentation in new empty entries.
847 When the cursor is at the end of an empty headline, i.e with only stars
848 and maybe a TODO keyword, TAB will then switch the entry to become a child,
849 and then all possible ancestor states, before returning to the original state.
850 This makes data entry extremely fast: M-RET to create a new headline,
851 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
853 When the cursor is at the end of an empty plain list item, one TAB will
854 make it a subitem, two or more tabs will back up to make this an item
855 higher up in the item hierarchy."
860 "Where should `org-cycle' emulate TAB.
861 nil Never
862 white Only in completely white lines
863 whitestart Only at the beginning of lines, before the first non-white char
864 t Everywhere except in headlines
865 exc-hl-bol Everywhere except at the start of a headline
866 If TAB is used in a place where it does not emulate TAB, the current subtree
867 visibility is cycled."
874 ))
877 "Number of empty lines needed to keep an empty line between collapsed trees.
878 If you leave an empty line between the end of a subtree and the following
879 headline, this empty line is hidden when the subtree is folded.
880 Org-mode will leave (exactly) one empty line visible if the number of
881 empty lines is equal or larger to the number given in this variable.
882 So the default 2 means at least 2 empty lines after the end of a subtree
883 are needed to produce free space between a collapsed subtree and the
884 following headline.
886 If the number is negative, and the number of empty lines is at least -N,
887 all empty lines are shown.
889 Special case: when 0, never leave empty lines in collapsed view."
895 "Hook that is run before visibility cycling is happening.
896 The function(s) in this hook must accept a single argument which indicates
897 the new state that will be set right after running this hook. The
898 argument is a symbol. Before a global state change, it can have the values
899 `overview', `content', or `all'. Before a local state change, it can have
900 the values `folded', `children', or `subtree'."
905 org-cycle-hide-drawers
906 org-cycle-show-empty-lines
907 org-optimize-window-after-visibility-change)
908 "Hook that is run after `org-cycle' has changed the buffer visibility.
909 The function(s) in this hook must accept a single argument which indicates
910 the new state that was set by the most recent `org-cycle' command. The
911 argument is a symbol. After a global state change, it can have the values
912 `overview', `content', or `all'. After a local state change, it can have
913 the values `folded', `children', or `subtree'."
918 "Options concerning structure editing in Org-mode."
923 "Non-nil means skip even levels and only use odd levels for the outline.
924 This has the effect that two stars are being added/taken away in
925 promotion/demotion commands. It also influences how levels are
926 handled by the exporters.
927 Changing it requires restart of `font-lock-mode' to become effective
928 for fontification also in regions already fontified.
929 You may also set this on a per-file basis by adding one of the following
930 lines to the buffer:
932 #+STARTUP: odd
933 #+STARTUP: oddeven"
939 "Non-nil means adapt indentation to outline node level.
941 When this variable is set, Org assumes that you write outlines by
942 indenting text in each node to align with the headline (after the stars).
943 The following issues are influenced by this variable:
945 - When this is set and the *entire* text in an entry is indented, the
946 indentation is increased by one space in a demotion command, and
947 decreased by one in a promotion command. If any line in the entry
948 body starts with text at column 0, indentation is not changed at all.
950 - Property drawers and planning information is inserted indented when
951 this variable s set. When nil, they will not be indented.
953 - TAB indents a line relative to context. The lines below a headline
954 will be indented when this variable is set.
956 Note that this is all about true indentation, by adding and removing
957 space characters. See also `org-indent.el' which does level-dependent
958 indentation in a virtual way, i.e. at display time in Emacs."
963 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
965 When t, `C-a' will bring back the cursor to the beginning of the
966 headline text, i.e. after the stars and after a possible TODO keyword.
967 In an item, this will be the position after the bullet.
968 When the cursor is already at that position, another `C-a' will bring
969 it to the beginning of the line.
971 `C-e' will jump to the end of the headline, ignoring the presence of tags
972 in the headline. A second `C-e' will then jump to the true end of the
973 line, after any tags. This also means that, when this variable is
974 non-nil, `C-e' also will never jump beyond the end of the heading of a
975 folded section, i.e. not after the ellipses.
977 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
978 going to the true line boundary first. Only a directly following, identical
979 keypress will bring the cursor to the special positions.
981 This may also be a cons cell where the behavior for `C-a' and `C-e' is
982 set separately."
1001 "Non-nil means `C-k' will behave specially in headlines.
1002 When nil, `C-k' will call the default `kill-line' command.
1003 When t, the following will happen while the cursor is in the headline:
1005 - When the cursor is at the beginning of a headline, kill the entire
1006 line and possible the folded subtree below the line.
1007 - When in the middle of the headline text, kill the headline up to the tags.
1008 - When after the headline text, kill the tags."
1013 "Non-nil means, do not delete a hidden subtree with C-k.
1014 When set to the symbol `error', simply throw an error when C-k is
1015 used to kill (part-of) a headline that has hidden text behind it.
1016 Any other non-nil value will result in a query to the user, if it is
1017 OK to kill that hidden subtree. When nil, kill without remorse."
1025 "Non-nil means when yanking subtrees, fold them.
1026 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1027 it starts with a heading and all other headings in it are either children
1028 or siblings, then fold all the subtrees. However, do this only if no
1029 text after the yank would be swallowed into a folded tree by this action."
1034 "Non-nil means when yanking subtrees, adjust the level.
1035 With this setting, `org-paste-subtree' is used to insert the subtree, see
1036 this function for details."
1041 "Non-nil means M-RET will split the line at the cursor position.
1042 When nil, it will go to the end of the line before making a
1043 new line.
1044 You may also set this option in a different way for different
1045 contexts. Valid contexts are:
1047 headline when creating a new headline
1048 item when creating a new item
1049 table in a table field
1050 default the value to be used for all contexts not explicitly
1051 customized"
1068 "Non-nil means insert new headings after the current subtree.
1069 When nil, the new heading is created directly after the current line.
1072 for the duration of the command."
1078 "Should `org-insert-heading' leave a blank line before new heading/item?
1079 The value is an alist, with `heading' and `plain-list-item' as car,
1080 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1081 Org will look at the surrounding headings/items and try to make an
1082 intelligent decision wether to insert a blank line or not.
1084 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1085 set, the setting here is ignored and no empty line is inserted, to avoid
1086 breaking the list structure."
1099 "Hook being run after inserting a new heading."
1105 This currently only means they are never auto-wrapped.
1106 When nil, such lines will be treated like ordinary lines.
1107 See also the QUOTE keyword."
1112 "Non-nil means typing characters in `org-goto' starts incremental search."
1117 "Options concerning sparse trees in Org-mode."
1122 "Non-nil means highlight all matches that define a sparse tree.
1123 The highlights will automatically disappear the next time the buffer is
1124 changed by an edit command."
1129 "Non-nil means any change to the buffer will remove temporary highlights.
1130 Such highlights are created by `org-occur' and `org-clock-display'.
1131 When nil, `C-c C-c needs to be used to get rid of the highlights.
1132 The highlights created by `org-preview-latex-fragment' always need
1133 `C-c C-c' to be removed."
1140 "Hook that is run after `org-occur' has constructed a sparse tree.
1141 This can be used to recenter the window to show as much of the structure
1142 as possible."
1147 "Options concerning imenu and speedbar in Org-mode."
1152 "The maximum level for Imenu access to Org-mode headlines.
1153 This also applied for speedbar access."
1158 "Options concerning tables in Org-mode."
1164 When nil, such lines will be treated like ordinary lines.
1166 When equal to the symbol `optimized', the table editor will be optimized to
1167 do the following:
1168 - Automatic overwrite mode in front of whitespace in table fields.
1169 This makes the structure of the table stay in tact as long as the edited
1170 field does not exceed the column width.
1171 - Minimize the number of realigns. Normally, the table is aligned each time
1172 TAB or RET are pressed to move to another field. With optimization this
1173 happens only if changes to a field might have changed the column width.
1174 Optimization requires replacing the functions `self-insert-command',
1175 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1176 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1177 very good at guessing when a re-align will be necessary, but you can always
1180 If you would like to use the optimized version in Org-mode, but the
1181 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1183 This variable can be used to turn on and off the table editor during a session,
1184 but in order to toggle optimization, a restart is required.
1186 See also the variable `org-table-auto-blank-field'."
1194 "Non-nil means cluster self-insert commands for undo when possible.
1195 If this is set, then, like in the Emacs command loop, 20 consecutive
1196 characters will be undone together.
1197 This is configurable, because there is some impact on typing performance."
1202 "Non-nil means TAB will automatically notice a table.el table.
1203 When it sees such a table, it moves point into it and - if necessary -
1204 calls `table-recognize-table'."
1209 "Options concerning links in Org-mode."
1214 "Buffer-local version of `org-link-abbrev-alist', which see.
1219 "Alist of link abbreviations.
1220 The car of each element is a string, to be replaced at the start of a link.
1222 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1224 [[linkkey:tag][description]]
1226 The 'linkkey' must be a word word, starting with a letter, followed
1227 by letters, numbers, '-' or '_'.
1229 If REPLACE is a string, the tag will simply be appended to create the link.
1232 be inserted at that point (see the function `url-hexify-string').
1234 REPLACE may also be a function that will be called with the tag as the
1235 only argument to create the link, which should be returned as a string.
1237 See the manual for examples."
1247 "Non-nil means hide link part and only show description of bracket links.
1248 Bracket links are like [[link][description]]. This variable sets the initial
1249 state in new org-mode buffers. The setting can then be toggled on a
1250 per-buffer basis from the Org->Hyperlinks menu."
1255 "How the path name in file links should be stored.
1256 Valid values are:
1258 relative Relative to the current directory, i.e. the directory of the file
1259 into which the link is being inserted.
1260 absolute Absolute path, if possible with ~ for home directory.
1261 noabbrev Absolute path, no abbreviation of home directory.
1262 adaptive Use relative path for files in the current directory and sub-
1263 directories of it. For other files, use an absolute path."
1272 "Types of links that should be activated in Org-mode files.
1273 This is a list of symbols, each leading to the activation of a certain link
1274 type. In principle, it does not hurt to turn on most link types - there may
1275 be a small gain when turning off unused link types. The types are:
1277 bracket The recommended [[link][description]] or [[link]] links with hiding.
1278 angle Links in angular brackets that may contain whitespace like
1279 <bbdb:Carsten Dominik>.
1280 plain Plain links in normal text, no whitespace, like http://google.com.
1281 radio Text that is matched by a radio target, see manual for details.
1282 tag Tag settings in a headline (link to tag search).
1283 date Time stamps (link to calendar).
1284 footnote Footnote labels.
1286 Changing this variable requires a restart of Emacs to become effective."
1298 "Function to use to generate link descriptions from links.
1299 If nil the link location will be used. This function must take
1300 two parameters; the first is the link and the second the
1301 description `org-insert-link' has generated, and should return the
1302 description to use."
1307 "Options concerning storing links in Org-mode."
1312 "Format of the description part of a link to an email or usenet message.
1313 The following %-escapes will be replaced by corresponding information:
1321 %s subject
1322 %m message-id.
1324 You may use normal field width specification between the % and the letter.
1325 This is for example useful to limit the length of the subject.
1339 It should match if the message is from the user him/herself."
1344 "Non-nil means storing a link to an Org file will use entry IDs.
1346 Note that before this variable is even considered, org-id must be loaded,
1347 so please customize `org-modules' and turn it on.
1349 The variable can have the following values:
1351 t Create an ID if needed to make a link to the current entry.
1353 create-if-interactive
1354 If `org-store-link' is called directly (interactively, as a user
1355 command), do create an ID to support the link. But when doing the
1356 job for remember, only use the ID if it already exists. The
1357 purpose of this setting is to avoid proliferation of unwanted
1358 IDs, just because you happen to be in an Org file when you
1359 call `org-remember' that automatically and preemptively
1360 creates a link. If you do want to get an ID link in a remember
1361 template to an entry not having an ID, create it first by
1362 explicitly creating a link to it, using `C-c C-l' first.
1364 create-if-interactive-and-no-custom-id
1365 Like create-if-interactive, but do not create an ID if there is
1366 a CUSTOM_ID property defined in the entry. This is the default.
1368 use-existing
1369 Use existing ID, do not create one.
1371 nil Never use an ID to make a link, instead link using a text search for
1372 the headline text."
1377 create-if-interactive)
1379 create-if-interactive-and-no-custom-id)
1384 "Non-nil means file links from `org-store-link' contain context.
1385 A search string will be added to the file name with :: as separator and
1386 used to find the context when the link is activated by the command
1387 `org-open-at-point'.
1389 negates this setting for the duration of the command."
1394 "Non-nil means keep link in list for entire session.
1396 The command `org-store-link' adds a link pointing to the current
1397 location to an internal list. These links accumulate during a session.
1398 The command `org-insert-link' can be used to insert links into any
1399 Org-mode file (offering completion for all stored links). When this
1401 will be removed from the list, to make completing the unused links
1402 more efficient."
1407 "Options concerning following links in Org-mode."
1412 "Function to translate links with different syntax to Org syntax.
1413 This can be used to translate links created for example by the Planner
1414 or emacs-wiki packages to Org syntax.
1415 The function must accept two parameters, a TYPE containing the link
1417 which is everything after the link protocol. It should return a cons
1418 with possibly modified values of type and path.
1419 Org contains a function for this, so if you set this variable to
1420 `org-translate-link-from-planner', you should be able follow many
1421 links created by planner."
1426 "Hook that is run after a link has been followed."
1431 "Non-nil means on links TAB will follow the link.
1432 Needs to be set before org.el is loaded.
1433 This really should not be used, it does not make sense, and the
1434 implementation is bad."
1439 "Non-nil means on links RET will follow the link."
1445 "Non-nil means mouse-1 on a link will follow the link.
1446 A longer mouse click will still set point. Does not work on XEmacs.
1447 Needs to be set before org.el is loaded."
1452 "Number of different positions to be recorded in the ring.
1453 Changing this requires a restart of Emacs to work correctly."
1458 "Non-nil means internal links in Org files must exactly match a headline.
1459 When nil, the link search tries to match a phrase will all words
1460 in the search text."
1466 query-to-create)))
1473 "Setup the frame configuration for following links.
1474 When following a link with Emacs, it may often be useful to display
1475 this link in another window or frame. This variable can be used to
1476 set this up for the different types of links.
1477 For VM, use any of
1478 `vm-visit-folder'
1479 `vm-visit-folder-other-frame'
1480 For Gnus, use any of
1481 `gnus'
1482 `gnus-other-frame'
1483 `org-gnus-no-new-news'
1484 For FILE, use any of
1485 `find-file'
1486 `find-file-other-window'
1487 `find-file-other-frame'
1488 For Wanderlust use any of
1489 `wl'
1490 `wl-other-frame'
1491 For the calendar, use the variable `calendar-setup'.
1492 For BBDB, it is currently only possible to display the matches in
1493 another window."
1517 "Non-nil means use indirect buffer to display infile links.
1518 Activating internal links (from one location in a file to another location
1519 in the same file) normally just jumps to the location. When the link is
1521 is displayed in
1522 another window. When this option is set, the other window actually displays
1523 an indirect buffer clone of the current buffer, to avoid any visibility
1524 changes to the current buffer."
1529 "Non-nil means `org-open-file' will open non-existing files.
1530 When nil, an error will be generated.
1531 This variable applies only to external applications because they
1532 might choke on non-existing files. If the link is to a file that
1533 will be opened in Emacs, the variable is ignored."
1538 "Non-nil means a link to a directory really means to index.org.
1539 When nil, following a directory link will run dired or open a finder/explorer
1540 window on that directory."
1545 "Function and arguments to call for following mailto links.
1546 This is a list with the first element being a Lisp function, and the
1547 remaining elements being arguments to the function. In string arguments,
1548 %a will be replaced by the address, and %s will be replaced by the subject
1549 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1558 "Non-nil means ask for confirmation before executing shell links.
1559 Shell links can be dangerous: just think about a link
1561 [[shell:rm -rf ~/*][Google Search]]
1564 but really it would remove your entire home directory.
1565 Therefore we advise against setting this variable to nil.
1566 Just change it to `y-or-n-p' if you want to confirm with a
1574 'safe-local-variable
1578 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1579 Elisp links can be dangerous: just think about a link
1584 but really it would remove your entire home directory.
1585 Therefore we advise against setting this variable to nil.
1586 Just change it to `y-or-n-p' if you want to confirm with a
1594 'safe-local-variable
1601 "Default file applications on a UNIX or GNU/Linux system.
1612 "Default file applications on a MacOS X system.
1614 for some files for which the OS does not have a good default.
1622 'mswindows-shell-execute
1627 'mswindows-shell-execute
1630 "Default file applications on a Windows NT system.
1635 '(
1640 )
1641 "External applications for opening `file:path' items in a document.
1642 Org-mode uses system defaults for different file types, but
1643 you can use this variable to set the application for a given file
1644 extension. The entries in this list are cons cells where the car identifies
1645 files and the cdr the corresponding command. Possible values for the
1646 file identifier are
1648 ways, depending on its contents:
1650 - Alphanumeric characters only:
1651 Match links with this file extension.
1653 to open PDFs with evince.
1655 - Regular expression: Match links where the
1656 filename matches the regexp. If you want to
1657 use groups here, use shy groups.
1661 to open *.html and *.xhtml with firefox.
1663 - Regular expression which contains (non-shy) groups:
1665 anything after that, matches the regexp.
1666 In a custom command string, %1, %2, etc. are replaced with
1667 the parts of the link that were matched by the groups.
1668 For backwards compatibility, if a command string is given
1669 that does not use any of the group matches, this case is
1670 handled identically to the second one (i.e. match against
1671 file name only).
1672 In a custom lisp form, you can access the group matches with
1673 (match-string n link).
1676 to open [[file:document.pdf::5]] with evince at page 5.
1678 `directory' Matches a directory
1679 `remote' Matches a remote file, accessible through tramp or efs.
1680 Remote files most likely should be visited through Emacs
1681 because external applications cannot handle such paths.
1682 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1683 so all files Emacs knows how to handle. Using this with
1684 command `emacs' will open most files in Emacs. Beware that this
1685 will also open html files inside Emacs, unless you add
1687 t Default for files not matched by any of the other options.
1688 `system' The system command to open files, like `open' on Windows
1689 and Mac OS X, and mailcap under GNU/Linux. This is the command
1690 that will be selected if you call `C-c C-o' with a double
1693 Possible values for the command are:
1694 `emacs' The file will be visited by the current Emacs process.
1695 `default' Use the default application for this file type, which is the
1696 association for t in the list, most likely in the system-specific
1697 part.
1698 This can be used to overrule an unwanted setting in the
1699 system-specific variable.
1701 This command is specified by the entry whose car is `system'.
1702 Most likely, the system-specific version of this variable
1703 does define this command, but you can overrule/replace it
1704 here.
1705 string A command to be executed by a shell; %s will be replaced
1706 by the path to the file.
1707 sexp A Lisp form which will be evaluated. The file path will
1708 be available in the Lisp variable `file'.
1709 For more examples, see the system specific constants
1710 `org-file-apps-defaults-macosx'
1711 `org-file-apps-defaults-windowsnt'
1712 `org-file-apps-defaults-gnu'."
1722 auto-mode))
1733 "Options concerning refiling entries in Org-mode."
1738 "Directory with org files.
1739 This is just a default location to look for Org files. There is no need
1740 at all to put your files into this directory. It is only used in the
1741 following situations:
1743 1. When a remember template specifies a target file that is not an
1744 absolute path. The path will then be interpreted relative to
1745 `org-directory'
1746 2. When a remember note is filed away in an interactive way (when exiting the
1747 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1748 with `org-directory' as the default path."
1754 "Default target for storing notes.
1755 Used as a fall back file for org-remember.el and org-capture.el, for
1756 templates that do not specify a target file."
1761 file))
1764 "The default interface to be used for `org-goto'.
1765 Allowed values are:
1766 outline The interface shows an outline of the relevant file
1767 and the correct heading is found by moving through
1768 the outline or by searching with incremental search.
1769 outline-path-completion Headlines in the current buffer are offered via
1770 completion. This is the interface also used by
1771 the refile command."
1778 "Maximum target level when running `org-goto' with refile interface."
1783 "Non-nil means store new notes at the beginning of a file or entry.
1784 When nil, new notes will be filed to the end of a file or entry.
1785 This can also be a list with cons cells of regular expressions that
1786 are matched against file names, and values."
1796 "Information to record when a task is refiled.
1798 Possible values are:
1800 nil Don't add anything
1801 time Add a time stamp to the task
1802 note Prompt for a note and add it with template `org-log-note-headings'
1804 This option can also be set with on a per-file-basis with
1806 #+STARTUP: nologrefile
1807 #+STARTUP: logrefile
1808 #+STARTUP: lognoterefile
1810 You can have local logging settings for a subtree by setting the LOGGING
1811 property to one or more of these keywords.
1813 When bulk-refiling from the agenda, the value `note' is forbidden and
1814 will temporarily be changed to `time'."
1824 This is list of cons cells. Each cell contains:
1825 - a specification of the files to be considered, either a list of files,
1826 or a symbol whose function or variable value will be used to retrieve
1827 a file name or a list of file names. If you use `org-agenda-files' for
1828 that, all agenda files will be scanned for targets. Nil means consider
1829 headings in the current buffer.
1830 - A specification of how to find candidate refile targets. This may be
1831 any of:
1833 This tag has to be present in all target headlines, inheritance will
1834 not be considered.
1836 todo keyword.
1838 headlines that are refiling targets.
1839 - a cons cell (:level . N). Any headline of level N is considered a target.
1840 Note that, when `org-odd-levels-only' is set, level corresponds to
1841 order in hierarchy, not to the number of stars.
1842 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1843 Note that, when `org-odd-levels-only' is set, level corresponds to
1844 order in hierarchy, not to the number of stars.
1846 You can set the variable `org-refile-target-verify-function' to a function
1847 to verify each headline found by the simple criteria above.
1849 When this variable is nil, all top-level headlines in the current buffer
1850 are used, equivalent to the value `((nil . (:level . 1))'."
1866 "Function to verify if the headline at point should be a refile target.
1867 The function will be called without arguments, with point at the
1868 beginning of the headline. It should return t and leave point
1869 where it is if the headline is a valid target for refiling.
1871 If the target should not be selected, the function must return nil.
1872 In addition to this, it may move point to a place from where the search
1873 should be continued. For example, the function may decide that the entire
1874 subtree of the current entry should be excluded and move point to the end
1875 of the subtree."
1880 "Non-nil means cache refile targets to speed up the process.
1881 The cache for a particular file will be updated automatically when
1882 the buffer has been killed, or when any of the marker used for flagging
1883 refile targets no longer points at a live buffer.
1884 If you have added new entries to a buffer that might themselves be targets,
1885 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1886 find that easier, `C-u C-u C-u C-c C-w'."
1891 "Non-nil means provide refile targets as paths.
1892 So a level 3 headline will be available as level1/level2/level3.
1894 When the value is `file', also include the file name (without directory)
1895 into the path. In this case, you can also stop the completion after
1896 the file name, to get entries inserted as top level in the file.
1898 When `full-file-path', include the full file path."
1907 "Non-nil means complete the outline path in hierarchical steps.
1908 When Org-mode uses the refile interface to select an outline path
1909 \(see variable `org-refile-use-outline-path'), the completion of
1910 the path can be done is a single go, or if can be done in steps down
1911 the headline hierarchy. Going in steps is probably the best if you
1912 do not use a special completion package like `ido' or `icicles'.
1913 However, when using these packages, going in one step can be very
1914 fast, while still showing the whole path to the entry."
1919 "Non-nil means allow to create new nodes as refile targets.
1921 of an existing node. When the value of this variable is `confirm',
1922 new node creation must be confirmed by the user (recommended)
1923 When nil, the completion must match an existing entry.
1925 Note that, if the new heading is not seen by the criteria
1926 listed in `org-refile-targets', multiple instances of the same
1927 heading would be created by trying again to file under the new
1928 heading."
1936 "Options concerning TODO items in Org-mode."
1941 "Options concerning Progress logging in Org-mode."
1946 '(
1949 "The available interpretation symbols for customizing `org-todo-keywords'.
1953 "List of TODO entry keyword sequences and their interpretation.
1956 Each sequence starts with a symbol, either `sequence' or `type',
1957 indicating if the keywords should be interpreted as a sequence of
1958 action steps, or as different types of TODO items. The first
1959 keywords are states requiring action - these states will select a headline
1960 for inclusion into the global TODO list Org-mode produces. If one of
1963 the last keyword is treated as the only DONE state of the sequence.
1966 additional state where no keyword is present. For details about this
1967 cycling, see the manual.
1969 TODO keywords and interpretation can also be set on a per-file basis with
1970 the special #+SEQ_TODO and #+TYP_TODO lines.
1972 Each keyword can optionally specify a character for fast state selection
1973 \(in combination with the variable `org-use-fast-todo-selection')
1974 and specifiers for state change logging, using the same syntax
1977 indicates to record a time stamp each time this state is selected.
1979 Each keyword may also specify if a timestamp or a note should be
1980 recorded when entering or leaving the state, by adding additional
1981 characters in the parenthesis after the keyword. This looks like this:
1983 record only the time of the state change. With X and Y being either
1985 Y when leaving the state if and only if the *target* state does not
1986 define X. You may omit any of the fast-selection key or X or /Y,
1987 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1989 For backward compatibility, this variable may also be just a list
1990 of keywords - in this case the interpretation (sequence or type) will be
1991 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2001 ;;Quick and dirty way to see
2002 ;;`org-todo-interpretations'. This takes the
2003 ;;place of item arguments
2004 :convert-widget
2011 org-todo-interpretation-widgets))
2012 widget))
2043 "Controls how TODO keywords are interpreted.
2044 This variable is in principle obsolete and is only used for
2045 backward compatibility, if the interpretation of todo keywords is
2046 not given already in `org-todo-keywords'. See that variable for
2047 more information."
2054 "Non-nil means use the fast todo selection scheme with C-c C-t.
2055 This variable describes if and under what circumstances the cycling
2056 mechanism for TODO keywords will be replaced by a single-key, direct
2057 selection scheme.
2059 When nil, fast selection is never used.
2061 When the symbol `prefix', it will be used when `org-todo' is called with
2062 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2063 in an agenda buffer.
2065 When t, fast selection is used by default. In this case, the prefix
2066 argument forces cycling instead.
2068 In all cases, the special interface is only used if access keys have actually
2069 been assigned by the user, i.e. if keywords in the configuration are followed
2070 by a letter in parenthesis, like TODO(t)."
2078 "Non-nil means update todo statistics after insert and toggle.
2079 ALL-HEADLINES means update todo statistics by including headlines
2080 with no TODO keyword as well, counting them as not done.
2081 A list of TODO keywords means the same, but skip keywords that are
2082 not in this list.
2084 When this is set, todo statistics is updated in the parent of the
2085 current entry each time a todo state is changed."
2095 "Non-nil means TODO statistics covers just direct children.
2096 When nil, all entries in the subtree are considered.
2097 This has only an effect if `org-provide-todo-statistics' is set.
2098 To set this to nil for only a single subtree, use a COOKIE_DATA
2104 "Hook which is run after the state of a TODO item was changed.
2105 The new state (a string with a TODO keyword, or nil) is available in the
2106 Lisp variable `state'."
2111 "Hook for functions that are allowed to block a state change.
2113 Each function gets as its single argument a property list, see
2114 `org-trigger-hook' for more information about this list.
2116 If any of the functions in this hook returns nil, the state change
2120 "Hook for functions that are triggered by a state change.
2122 Each function gets as its single argument a property list with at least
2123 the following elements:
2125 (:type type-of-change :position pos-at-entry-start
2126 :from old-state :to new-state)
2128 Depending on the type, more properties may be present.
2130 This mechanism is currently implemented for:
2132 TODO state changes
2133 ------------------
2134 :type todo-state-change
2135 :from previous state (keyword as a string), or nil, or a symbol
2136 'todo' or 'done', to indicate the general type of state.
2140 "Non-nil means undone TODO entries will block switching the parent to DONE.
2141 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2142 be blocked if any prior sibling is not yet done.
2143 Finally, if the parent is blocked because of ordered siblings of its own,
2144 the child will also be blocked.
2145 This variable needs to be set before org.el is loaded, and you need to
2146 restart Emacs after a change to make the change effective. The only way
2147 to change is while Emacs is running is through the customize interface."
2159 "Non-nil means unchecked boxes will block switching the parent to DONE.
2160 When this is nil, checkboxes have no influence on switching TODO states.
2161 When non-nil, you first need to check off all check boxes before the TODO
2162 entry can be switched to DONE.
2163 This variable needs to be set before org.el is loaded, and you need to
2164 restart Emacs after a change to make the change effective. The only way
2165 to change is while Emacs is running is through the customize interface."
2177 "Non-nil means inserting a TODO heading is treated as state change.
2179 logging will apply if appropriate. When nil, the new TODO item will
2180 be inserted directly, and no logging will take place."
2185 "Non-nil means switching TODO states with S-cursor counts as state change.
2186 This is the default behavior. However, setting this to nil allows a
2187 convenient way to select a TODO state and bypass any logging associated
2188 with that."
2193 "Tag changes that should be triggered by TODO state changes.
2194 This is a list. Each entry is
2196 (state-change (tag . flag) .......)
2198 State-change can be a string with a state, and empty string to indicate the
2199 state that has no TODO keyword, or it can be one of the symbols `todo'
2200 or `done', meaning any not-done or done state, respectively."
2214 "Information to record when a task moves to the DONE state.
2216 Possible values are:
2218 nil Don't add anything, just change the keyword
2219 time Add a time stamp to the task
2220 note Prompt for a note and add it with template `org-log-note-headings'
2222 This option can also be set with on a per-file-basis with
2224 #+STARTUP: nologdone
2225 #+STARTUP: logdone
2226 #+STARTUP: lognotedone
2228 You can have local logging settings for a subtree by setting the LOGGING
2229 property to one or more of these keywords."
2237 ;; Normalize old uses of org-log-done.
2244 "Information to record when the scheduling date of a tasks is modified.
2246 Possible values are:
2248 nil Don't add anything, just change the date
2249 time Add a time stamp to the task
2250 note Prompt for a note and add it with template `org-log-note-headings'
2252 This option can also be set with on a per-file-basis with
2254 #+STARTUP: nologreschedule
2255 #+STARTUP: logreschedule
2256 #+STARTUP: lognotereschedule"
2265 "Information to record when the deadline date of a tasks is modified.
2267 Possible values are:
2269 nil Don't add anything, just change the date
2270 time Add a time stamp to the task
2271 note Prompt for a note and add it with template `org-log-note-headings'
2273 This option can also be set with on a per-file-basis with
2275 #+STARTUP: nologredeadline
2276 #+STARTUP: logredeadline
2277 #+STARTUP: lognoteredeadline
2279 You can have local logging settings for a subtree by setting the LOGGING
2280 property to one or more of these keywords."
2289 "Non-nil means record a note when clocking out of an item.
2290 This can also be configured on a per-file basis by adding one of
2291 the following lines anywhere in the buffer:
2293 #+STARTUP: lognoteclock-out
2294 #+STARTUP: nolognoteclock-out"
2300 "Non-nil means the CLOSED time stamp will contain date and time.
2301 When nil, only the date will be recorded."
2315 "Headings for notes added to entries.
2316 The value is an alist, with the car being a symbol indicating the note
2317 context, and the cdr is the heading to be used. The heading may also be the
2318 empty string.
2319 %t in the heading will be replaced by a time stamp.
2320 %T will be an active time stamp instead the default inactive one
2321 %s will be replaced by the new TODO state, in double quotes.
2322 %S will be replaced by the old TODO state, in double quotes.
2323 %u will be replaced by the user name.
2324 %U will be replaced by the full user name.
2326 In fact, it is not a good idea to change the `state' entry, because
2327 agenda log mode depends on the format of these entries."
2333 "Heading when changing todo state (todo sequence only)"
2347 "Non-nil means insert state change notes and time stamps into a drawer.
2348 When nil, state changes notes will be inserted after the headline and
2349 any scheduling and clock lines, but not inside a drawer.
2351 The value of this variable should be the name of the drawer to use.
2352 LOGBOOK is proposed at the default drawer for this purpose, you can
2353 also set this to a string to define the drawer of your choice.
2357 If this variable is set, `org-log-state-notes-insert-after-drawers'
2358 will be ignored.
2360 You can set the property LOG_INTO_DRAWER to overrule this setting for
2361 a subtree."
2373 "Return the value of `org-log-into-drawer', but let properties overrule.
2374 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2375 used instead of the default value."
2383 "Non-nil means insert state change notes after any drawers in entry.
2384 Only the drawers that *immediately* follow the headline and the
2385 deadline/scheduled line are skipped.
2386 When nil, insert notes right after the heading and perhaps the line
2387 with deadline/scheduling if present.
2389 This variable will have no effect if `org-log-into-drawer' is
2390 set."
2396 "Non-nil means the latest state note will be directly after heading.
2397 When nil, the state change notes will be ordered according to time."
2403 "The TODO state to which a repeater should return the repeating task.
2404 By default this is the first task in a TODO sequence, or the previous state
2405 in a TODO_TYP set. But you can specify another task here.
2406 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2412 "Non-nil means record moving through the DONE state when triggering repeat.
2413 An auto-repeating task is immediately switched back to TODO when
2416 record a closing note, there will be no record of the task moving
2417 through DONE. This variable forces taking a note anyway.
2419 nil Don't force a record
2420 time Record a time stamp
2421 note Record a note
2423 This option can also be set with on a per-file-basis with
2425 #+STARTUP: logrepeat
2426 #+STARTUP: lognoterepeat
2427 #+STARTUP: nologrepeat
2429 You can have local logging settings for a subtree by setting the LOGGING
2430 property to one or more of these keywords."
2440 "Priorities in Org-mode."
2445 "Non-nil means priority commands are active.
2446 When nil, these commands will be disabled, so that you never accidentally
2447 set a priority."
2452 "The highest priority of TODO items. A character like ?A, ?B etc.
2453 Must have a smaller ASCII number than `org-lowest-priority'."
2458 "The lowest priority of TODO items. A character like ?A, ?B etc.
2459 Must have a larger ASCII number than `org-highest-priority'."
2464 "The default priority of TODO items.
2465 This is the priority an item get if no explicit priority is given."
2470 "Non-nil means start with default priority when starting to cycle.
2471 When this is nil, the first step in the cycle will be (depending on the
2472 command used) one higher or lower that the default priority."
2477 "Options concerning time stamps and deadlines in Org-mode."
2482 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2483 When nil, these labeled time stamps are forces into the second line of an
2484 entry, just after the headline. When scheduling from the global TODO list,
2485 the time stamp will always be forced into the second line."
2490 "Formats for `format-time-string' which are used for time stamps.
2494 "Number of minutes to round time stamps to.
2495 These are two values, the first applies when first creating a time stamp.
2496 The second applies when changing it with the commands `S-up' and `S-down'.
2497 When changing the time stamp, this means that it will change in steps
2498 of N minutes, as given by the second value.
2500 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2501 numbers should be factors of 60, so for example 5, 10, 15.
2503 When this is larger than 1, you can still force an exact time stamp by using
2504 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2505 and by using a prefix arg to `S-up/down' to specify the exact number
2506 of minutes to shift."
2516 ;; Normalize old customizations of this variable.
2520 org-time-stamp-rounding-minutes)))
2523 "Non-nil means overlay custom formats over all time stamps.
2524 The formats are defined through the variable `org-time-stamp-custom-formats'.
2525 To turn this on on a per-file basis, insert anywhere in the file:
2526 #+STARTUP: customtime"
2534 "Custom formats for time stamps. See `format-time-string' for the syntax.
2535 These are overlayed over the default ISO format if the variable
2536 `org-display-custom-times' is set. Time like %H:%M should be at the
2537 end of the second format. The custom formats are also honored by export
2538 commands, if custom time display is turned on at the time of export."
2543 "Get the right format for a time string."
2548 f)))
2551 "The format string used when creating CLOCKSUM lines.
2552 This is also used when org-mode generates a time duration."
2558 org-mode generates a time duration."
2563 "The format string used when creating CLOCKSUM lines, or when
2564 org-mode generates a time duration."
2569 "No. of days before expiration during which a deadline becomes active.
2570 This variable governs the display in sparse trees and in the agenda.
2571 When 0 or negative, it means use this number (the absolute value of it)
2572 even if a deadline has a different individual lead time specified.
2574 Custom commands can set this variable in the options section."
2580 "Non-nil means assume future for incomplete date input from user.
2581 This affects the following situations:
2582 1. The user gives a month but not a year.
2585 2. The user gives a day, but no month.
2588 it will be considered as *this* month.
2590 If you set this variable to the symbol `time', then also the following
2591 will work:
2593 3. If the user gives a time, but no day. If the time is before now,
2594 to will be interpreted as tomorrow.
2596 Currently none of this works for ISO week specifications.
2598 When this option is nil, the current day, month and year will always be
2599 used as defaults.
2601 See also `org-agenda-jump-prefer-future'."
2609 "Should the agenda jump command prefer the future for incomplete dates?
2610 The default is to do the same as configured in `org-read-date-prefer-future'.
2611 But you can alse set a deviating value here.
2612 This may t or nil, or the symbol `org-read-date-prefer-future'."
2617 org-read-date-prefer-future)
2622 "Non-nil means display current interpretation of date prompt live.
2623 This display will be in an overlay, in the minibuffer."
2628 "Non-nil means pop up a calendar when prompting for a date.
2629 In the calendar, the date can be selected with mouse-1. However, the
2630 minibuffer will also be active, and you can simply enter the date as well.
2631 When nil, only the minibuffer will be available."
2639 "Hook to be used to set up keys for the date/time interface.
2640 Add key definitions to `minibuffer-local-map', which will be a temporary
2641 copy."
2646 "The hour when your day really ends. Must be an integer.
2647 This has influence for the following applications:
2649 the time given here, the day recognized as TODAY is actually yesterday.
2650 - When a date is read from the user and it is still before the time given
2651 here, the current date and time will be assumed to be yesterday, 23:59.
2652 Also, timestamps inserted in remember templates follow this rule.
2654 IMPORTANT: This is a feature whose implementation is and likely will
2655 remain incomplete. Really, it is only here because past midnight seems to
2656 be the favorite working time of John Wiegley :-)"
2661 "Non-nil means S-down will increase the time in a time stamp.
2662 When nil, S-up will increase."
2667 "Non-nil means make the calendar window follow timestamp changes.
2668 When a timestamp is modified and the calendar window is visible, it will be
2669 moved to the new date."
2674 "Options concerning tags in Org-mode."
2679 "List of tags allowed in Org-mode files.
2680 When this list is nil, Org-mode will base TAG input on what is already in the
2681 buffer.
2682 The value of this variable is an alist, the car of each entry must be a
2683 keyword as a string, the cdr may be a character that is used to select
2684 that tag through the fast-tag-selection interface.
2685 See the manual for details."
2700 "List of tags that will always appear in all Org-mode files.
2701 This is in addition to any in buffer settings or customizations
2702 of `org-tag-alist'.
2703 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2704 The value of this variable is an alist, the car of each entry must be a
2705 keyword as a string, the cdr may be a character that is used to select
2706 that tag through the fast-tag-selection interface.
2707 See the manual for details.
2708 To disable these tags on a per-file basis, insert anywhere in the file:
2709 #+STARTUP: noptag"
2720 "If non-nil, always offer completion for all tags of all agenda files.
2721 Instead of customizing this variable directly, you might want to
2722 set it locally for remember buffers, because there no list of
2723 tags in that file can be created dynamically (there are none).
2725 (add-hook 'org-remember-mode-hook
2726 (lambda ()
2727 (set (make-local-variable
2728 'org-complete-tags-always-offer-all-agenda-tags)
2729 t)))"
2734 "List of tags that can be inherited by all entries in the file.
2735 The tags will be inherited if the variable `org-use-tag-inheritance'
2736 says they should be.
2740 "Non-nil means use fast tag selection scheme.
2741 This is a special interface to select and deselect tags with single keys.
2742 When nil, fast selection is never used.
2743 When the symbol `auto', fast selection is used if and only if selection
2744 characters for tags have been configured, either through the variable
2745 `org-tag-alist' or through a #+TAGS line in the buffer.
2746 When t, fast selection is always used and selection keys are assigned
2747 automatically if necessary."
2755 "Non-nil means fast tag selection exits after first change.
2756 When nil, you have to press RET to exit it.
2757 During fast tag selection, you can toggle this flag with `C-c'.
2758 This variable can also have the value `expert'. In this case, the window
2759 displaying the tags menu is not even shown, until you press C-c again."
2767 "Non-nil means fast tags selection interface will also offer TODO states.
2771 "The column to which tags should be indented in a headline.
2772 If this number is positive, it specifies the column. If it is negative,
2773 it means that the tags should be flushright to that column. For example,
2774 -80 works well for a normal 80 character screen."
2779 "Non-nil means realign tags after pro/demotion of TODO state change.
2780 These operations change the length of a headline and therefore shift
2781 the tags around. With this options turned on, after each such operation
2782 the tags are again aligned to `org-tags-column'."
2787 "Non-nil means tags in levels apply also for sublevels.
2788 When nil, only the tags directly given in a specific line apply there.
2789 This may also be a list of tags that should be inherited, or a regexp that
2790 matches tags that should be inherited. Additional control is possible
2791 with the variable `org-tags-exclude-from-inheritance' which gives an
2792 explicit list of tags to be excluded from inheritance., even if the value of
2793 `org-use-tag-inheritance' would select it for inheritance.
2795 If this option is t, a match early-on in a tree can lead to a large
2796 number of matches in the subtree when constructing the agenda or creating
2797 a sparse tree. If you only want to see the first match in a tree during
2798 a search, check out the variable `org-tags-match-list-sublevels'."
2807 "List of tags that should never be inherited.
2808 This is a way to exclude a few tags from inheritance. For way to do
2809 the opposite, to actively allow inheritance for selected tags,
2810 see the variable `org-use-tag-inheritance'."
2815 "Check if TAG is one that should be inherited."
2827 "Non-nil means list also sublevels of headlines matching a search.
2828 This variable applies to tags/property searches, and also to stuck
2829 projects because this search is based on a tags match as well.
2831 When set to the symbol `indented', sublevels are indented with
2832 leading dots.
2834 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2835 the sublevels of a headline matching a tag search often also match
2836 the same search. Listing all of them can create very long lists.
2837 Setting this variable to nil causes subtrees of a match to be skipped.
2839 This variable is semi-obsolete and probably should always be true. It
2840 is better to limit inheritance to certain tags using the variables
2841 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2849 "When set, tags are sorted using this function as a comparator."
2865 "Options concerning properties in Org-mode."
2870 "How property key/value pairs should be formatted by `indent-line'.
2871 When `indent-line' hits a property definition, it will format the line
2872 according to this format, mainly to make sure that the values are
2873 lined-up with respect to each other."
2878 "Non-nil means properties apply also for sublevels.
2880 This setting is chiefly used during property searches. Turning it on can
2881 cause significant overhead when doing a search, which is why it is not
2882 on by default.
2884 When nil, only the properties directly given in the current entry count.
2885 When t, every property is inherited. The value may also be a list of
2886 properties that should have inheritance, or a regular expression matching
2887 properties that should be inherited.
2889 However, note that some special properties use inheritance under special
2890 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2892 for valid values of a property.
2894 Note for programmers:
2895 When querying an entry with `org-entry-get', you can control if inheritance
2896 should be used. By default, `org-entry-get' looks only at the local
2897 properties. You can request inheritance by setting the inherit argument
2898 to t (to force inheritance) or to `selective' (to respect the setting
2899 in this variable)."
2908 "Check if PROPERTY is one that should be inherited."
2919 "The default column format, if no other format has been defined.
2920 This variable can be set on the per-file basis by inserting a line
2922 #+COLUMNS: %25ITEM ....."
2927 "The ellipses to be used when a field in column view is truncated.
2928 When this is the empty string, as many characters as possible are shown,
2929 but then there will be no visual indication that the field has been truncated.
2930 When this is a string of length N, the last N characters of a truncated
2931 field are replaced by this string. If the column is narrower than the
2932 ellipses string, only part of the ellipses string will be shown."
2937 "Function that modifies values for display in column view.
2938 For example, it can be used to cut out a certain part from a time stamp.
2939 The function must take 2 arguments:
2941 column-title The title of the column (*not* the property name)
2942 value The value that should be modified.
2944 The function should return the value that should be displayed,
2945 or nil if the normal value should be used."
2950 "The property that is being used to keep track of effort estimates.
2951 Effort estimates given in this property need to have the format H:MM."
2959 "List of property/value pairs that can be inherited by any entry.
2961 These are fixed values, for the preset properties. The user variable
2962 that can be used to add to this list is `org-global-properties'.
2964 The entries in this list are cons cells where the car is a property
2965 name and cdr is a string with the value. If the value represents
2970 "List of property/value pairs that can be inherited by any entry.
2972 This list will be combined with the constant `org-global-properties-fixed'.
2974 The entries in this list are cons cells where the car is a property
2975 name and cdr is a string with the value.
2977 You can set buffer-local values for the same purpose in the variable
2978 `org-file-properties' this by adding lines like
2980 #+PROPERTY: NAME VALUE"
2987 "List of property/value pairs that can be inherited by any entry.
2988 Valid for the current buffer.
2993 "Options concerning agenda views in Org-mode."
2998 "Variable used by org files to set a category for agenda display.
2999 Such files should use a file variable to set it, for example
3003 or contain a special line
3005 #+CATEGORY: ELisp
3007 If the file does not specify a category, then file's base name
3013 "The files to be used for agenda display.
3017 If an entry is a directory, all files in that directory that are matched by
3018 `org-agenda-file-regexp' will be part of the file list.
3020 If the value of the variable is not a list but a single file name, then
3021 the list of agenda files is actually stored and maintained in that file, one
3022 agenda file per line. In this file paths can be given relative to
3023 `org-directory'. Tilde expansion and environment variable substitution
3024 are also made."
3031 "Regular expression to match files for `org-agenda-files'.
3032 If any element in the list in that variable contains a directory instead
3033 of a normal file, all files in that directory that are matched by this
3034 regular expression will be included."
3039 "List of extra files to be searched by text search commands.
3040 These files will be search in addition to the agenda files by the
3041 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3042 Note that these files will only be searched for text search commands,
3043 not for the other agenda views like todo lists, tag searches or the weekly
3044 agenda. This variable is intended to list notes and possibly archive files
3045 that should also be searched by these two commands.
3046 In fact, if the first element in the list is the symbol `agenda-archives',
3047 than all archive files of all agenda files will be added to the search
3048 scope."
3059 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3060 A nil value means to remove them, after a query, from the list."
3065 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3066 The command `org-calendar-goto-agenda' will be bound to this key. The
3067 default is the character `c' because then `c' can be used to switch back and
3068 forth between agenda and calendar."
3073 "The key to be installed in `calendar-mode-map' for agenda-action.
3074 The command `org-agenda-action' will be bound to this key. The
3075 default is the character `k' because we use the same key in the agenda."
3080 "The key to be installed in `calendar-mode-map' for adding diary entries.
3081 This option is irrelevant until `org-agenda-diary-file' has been configured
3082 to point to an Org-mode file. When that is the case, the command
3083 `org-agenda-diary-entry' will be bound to the key given here, by default
3084 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3085 if you want to continue doing this, you need to change this to a different
3086 key."
3091 "File to which to add new entries with the `i' key in agenda and calendar.
3092 When this is the symbol `diary-file', the functionality in the Emacs
3093 calendar will be used to add entries to the `diary-file'. But when this
3094 points to a file, `org-agenda-diary-entry' will be used instead."
3110 org-calendar-insert-diary-entry-key
3114 "Options for embedding LaTeX code into Org-mode."
3122 "Options for creating images from LaTeX fragments.
3123 This is a property list with the following properties:
3125 `default' means use the foreground of the default face.
3127 `default' means use the background of the default face.
3128 :scale a scaling factor for the size of the images, to get more pixels
3129 :html-foreground, :html-background, :html-scale
3130 the same numbers for HTML export.
3131 :matchers a list indicating which matchers should be used to
3132 find LaTeX fragments. Valid members of this list are:
3143 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3144 When nil, just push out a message."
3153 \[PACKAGES]
3154 \[DEFAULT-PACKAGES]
3155 % The settings below are copied from fullpage.sty
3168 "The document header used for processing LaTeX fragments.
3169 It is imperative that this header make sure that no page number
3170 appears on the page. The package defined in the variables
3171 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3173 will be appended."
3180 "Set the packages alist and make sure it has 3 elements per entry."
3184 x))
3185 val)))
3189 "Get the packages alist and make sure it has 3 elements per entry."
3193 x))
3196 ;; The following variables are defined here because is it also used
3197 ;; when formatting latex fragments. Originally it was part of the
3198 ;; LaTeX exporter, which is why the name includes "export".
3215 )
3216 "Alist of default packages to be inserted in the header.
3217 Change this only if one of the packages here causes an incompatibility
3218 with another package you are using.
3219 The packages in this list are needed by one part or another of Org-mode
3220 to function properly.
3222 - inputenc, fontenc: for basic font and character selection
3223 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3224 for interpreting the entities in `org-entities'. You can skip some of these
3225 packages if you don't use any of the symbols in it.
3226 - graphicx: for including images
3227 - float, wrapfig: for figure placement
3228 - longtable: for long tables
3229 - hyperref: for cross references
3231 Therefore you should not modify this variable unless you know what you
3232 are doing. The one reason to change it anyway is that you might be loading
3233 some other package that conflicts with one of the default packages.
3235 If SNIPPET-FLAG is t, the package also needs to be included when
3236 compiling LaTeX snippets into images for inclusion into HTML."
3249 "Alist of packages to be inserted in every LaTeX header.
3250 These will be inserted after `org-export-latex-default-packages-alist'.
3252 SNIPPET-FLAG, when t, indicates that this package is also needed when
3253 turning LaTeX snippets into images for inclusion into HTML.
3254 Make sure that you only list packages here which:
3255 - you want in every file
3256 - do not conflict with the default packages in
3257 `org-export-latex-default-packages-alist'
3258 - do not conflict with the setup in `org-format-latex-header'."
3272 "Settings for Org-mode appearance."
3277 "Non-nil means fontify only the stars in each headline.
3278 When nil, the entire headline is fontified.
3279 Changing it requires restart of `font-lock-mode' to become effective
3280 also in regions already fontified."
3285 "Non-nil means hide the first N-1 stars in a headline.
3286 This works by using the face `org-hide' for these stars. This
3287 face is white for a light background, and black for a dark
3288 background. You may have to customize the face `org-hide' to
3289 make this work.
3290 Changing it requires restart of `font-lock-mode' to become effective
3291 also in regions already fontified.
3292 You may also set this on a per-file basis by adding one of the following
3293 lines to the buffer:
3295 #+STARTUP: hidestars
3296 #+STARTUP: showstars"
3301 "List of keywords that should be hidden when typed in the org buffer.
3302 For example, add #+TITLE to this list in order to make the
3303 document title appear in the buffer without the initial #+TITLE:
3304 keyword."
3312 "Non-nil means change the face of a headline if it is marked DONE.
3313 Normally, only the TODO/DONE keyword indicates the state of a headline.
3314 When this is non-nil, the headline after the keyword is set to the
3315 `org-headline-done' as an additional indication."
3320 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3321 Changing this variable requires a restart of Emacs to take effect."
3326 "Non-nil means fontify the whole line for headings.
3327 This is useful when setting a background color for the
3328 org-level-* faces."
3333 "Non-nil means fontify what is treated specially by the exporters."
3338 "Non-nil mean font-lock should hide the emphasis marker characters."
3343 "Non-nil means show entities as UTF8 characters.
3349 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3354 "Regular expression for matching emphasis.
3355 After a match, the match groups contain these elements:
3356 0 The match of the full regular expression, including the characters
3357 before and after the proper match
3358 1 The character before the proper match, or empty at beginning of line
3359 2 The proper match, including the leading and trailing markers
3360 3 The leading marker like * or /, indicating the type of highlighting
3361 4 The text between the emphasis markers, not including the markers
3368 "Set variable and compute the emphasis regular expression."
3372 org-emphasis-alist org-emphasis-regexp-components)
3384 ;; make sure special characters appear at the right position in the class
3396 ;; Make the regexp
3404 body1
3416 body1
3424 "Components used to build the regular expression for emphasis.
3425 This is a list with 6 entries. Terminology: In an emphasis string
3429 specify what is allowed/forbidden in each part:
3431 pre Chars allowed as prematch. Beginning of line will be allowed too.
3432 post Chars allowed as postmatch. End of line will be allowed too.
3433 border The chars *forbidden* as border characters.
3435 non-shy groups here, and don't allow newline here.
3436 newline The maximum number of newlines allowed in an emphasis exp.
3438 Use customize to modify this, or restart Emacs after changing it."
3457 )
3458 "Special syntax for emphasized text.
3459 Text starting and ending with a special character will be emphasized, for
3460 example *bold*, _underlined_ and /italic/. This variable sets the marker
3461 characters, the face to be used by font-lock for highlighting in Org-mode
3462 Emacs buffers, and the HTML tags to be used for this.
3463 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3464 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3465 Use customize to modify this, or restart Emacs after changing it."
3480 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3483 ;;; Miscellaneous options
3486 "Completion in Org-mode."
3491 "Non-nil means use ido completion wherever possible.
3492 Note that `ido-mode' must be active for this variable to be relevant.
3493 If you decide to turn this variable on, you might well want to turn off
3494 `org-outline-path-complete-in-steps'.
3495 See also `org-completion-use-iswitchb'."
3500 "Non-nil means use iswitchb completion wherever possible.
3501 Note that `iswitchb-mode' must be active for this variable to be relevant.
3502 If you decide to turn this variable on, you might well want to turn off
3503 `org-outline-path-complete-in-steps'.
3504 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3510 Normal means no org-mode-specific context."
3514 ;;; Functions and variables from their packages
3515 ;; Declared here to avoid compiler warnings
3517 ;; XEmacs only
3523 ;; Emacs only
3526 ;; Various packages
3544 org-format-agenda-item "org-agenda"
3572 ;;; Autoload and prepare some org modules
3574 ;; Some table stuff that needs to be defined here, because it is used
3575 ;; by the functions setting up org-mode or checking for table context.
3588 "Detect the first line outside a table when searching from within it.
3591 ;; Autoload the functions in org-table.el that are needed by functions here.
3596 org-table-convert org-table-convert-region org-table-copy-down
3597 org-table-copy-region org-table-create
3598 org-table-create-or-convert-from-region
3599 org-table-create-with-table.el org-table-current-dline
3600 org-table-cut-region org-table-delete-column org-table-edit-field
3601 org-table-edit-formulas org-table-end org-table-eval-formula
3602 org-table-export org-table-field-info
3603 org-table-get-stored-formulas org-table-goto-column
3604 org-table-hline-and-move org-table-import org-table-insert-column
3605 org-table-insert-hline org-table-insert-row org-table-iterate
3606 org-table-justify-field-maybe org-table-kill-row
3607 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3608 org-table-move-column org-table-move-column-left
3609 org-table-move-column-right org-table-move-row
3610 org-table-move-row-down org-table-move-row-up
3611 org-table-next-field org-table-next-row org-table-paste-rectangle
3612 org-table-previous-field org-table-recalculate
3613 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3614 org-table-toggle-coordinate-overlays
3615 org-table-toggle-formula-debugger org-table-wrap-region
3616 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3617 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3618 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3621 "Return t if the cursor is inside an org-type table.
3622 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3627 org-table-line-regexp)))
3628 nil))
3632 "Return t if and only if we are at a table.el table."
3638 "If there is a table.el table nearby, recognize it and move into it."
3644 nil
3654 t
3659 t)
3660 nil)
3661 nil))
3664 "Return t if the cursor is inside a hline in a table."
3669 nil))
3674 "Apply FUNCTION to the start of all tables in the buffer."
3690 ;; Declare and autoload functions from org-exp.el & Co
3698 org-insert-export-options-template
3699 org-table-clean-before-export))
3702 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3703 org-export-region-as-ascii))
3706 org-replace-region-by-latex org-export-region-as-latex
3707 org-export-as-latex org-export-as-pdf
3708 org-export-as-pdf-and-open))
3711 org-export-as-html-batch org-export-as-html-to-buffer
3712 org-replace-region-by-html org-export-region-as-html
3713 org-export-as-html))
3716 org-replace-region-by-docbook org-export-region-as-docbook
3717 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3718 org-export-as-docbook))
3721 org-export-icalendar-all-agenda-files
3722 org-export-icalendar-combine-agenda-files))
3726 ;; Declare and autoload functions from org-agenda.el
3731 org-todo-list org-tags-view org-agenda-list-stuck-projects
3732 org-diary org-agenda-to-appt
3733 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3735 ;; Autoload org-remember
3740 org-remember-apply-template org-remember org-remember-handler)))
3745 org-capture-import-remember-templates)))
3747 ;; Autoload org-clock.el
3762 "Return non-nil if clock is currently running.
3763 The return value is actually the clock marker."
3768 "org-clock"
3770 org-clock-goto org-clock-sum org-clock-display
3771 org-clock-remove-overlays org-clock-report
3772 org-clocktable-shift org-dblock-write:clocktable
3773 org-get-clocktable org-resolve-clocks)))
3776 "If this is a CLOCK line, update it and return t.
3777 Otherwise, return nil."
3786 ts te h m s neg)
3789 nil)
3794 ;; The clock is running here
3815 t))))))
3818 "Check if the current buffer contains the running clock.
3819 If yes, offer to stop it and to save the buffer with the changes."
3828 "Check if this line starts a clock table, if yes, shift the time block."
3832 ;; Autoload org-timer.el
3836 "org-timer"
3838 org-timer-change-times-in-region
3839 org-timer-set-timer
3840 org-timer-reset-timers
3841 org-timer-show-remaining-time)))
3843 ;; Autoload org-feed.el
3847 "org-feed"
3851 ;; Autoload org-indent.el
3853 ;; Define the variable already here, to make sure we have it.
3855 "Non-nil if Org-Indent mode is enabled.
3860 "org-indent"
3863 ;; Autoload org-mobile.el
3867 "org-mobile"
3870 ;; Autoload archiving code
3871 ;; The stuff that is needed for cycling and tags has to be defined here.
3874 "Options concerning archiving in Org-mode."
3879 "The location where subtrees should be archived.
3881 The value of this variable is a string, consisting of two parts,
3882 separated by a double-colon. The first part is a filename and
3883 the second part is a headline.
3885 When the filename is omitted, archiving happens in the same file.
3886 %s in the filename will be replaced by the current file
3887 name (without the directory part). Archiving to a different file
3888 is useful to keep archived entries from contributing to the
3889 Org-mode Agenda.
3891 The archived entries will be filed as subtrees of the specified
3892 headline. When the headline is omitted, the subtrees are simply
3893 filed away at the end of the file, as top-level entries. Also in
3894 the heading you can use %s to represent the file name, this can be
3895 useful when using the same archive for a number of different files.
3897 Here are a few examples:
3899 If the current file is Projects.org, archive in file
3900 Projects.org_archive, as top-level trees. This is the default.
3903 Archive in the current file, under the top-level headline
3907 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3910 Archive in file ~/org/archive.org (absolute path), under headlines
3914 Archive in file ./basement (relative path), as level 3 trees
3917 You may set this option on a per-file basis by adding to the buffer a
3918 line like
3920 #+ARCHIVE: basement::** Finished Tasks
3922 You may also define it locally for a subtree by setting an ARCHIVE property
3923 in the entry. If such a property is found in an entry, or anywhere up
3924 the hierarchy, it will be used."
3929 "The tag that marks a subtree as archived.
3930 An archived subtree does not open during visibility cycling, and does
3931 not contribute to the agenda listings.
3932 After changing this, font-lock must be restarted in the relevant buffers to
3933 get the proper fontification."
3939 "Non-nil means the agenda will skip any items located in archived trees.
3940 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3941 variable is no longer recommended, you should leave it at the value t.
3942 Instead, use the key `v' to cycle the archives-mode in the agenda."
3948 "Non-nil means ignore archived trees when creating column view."
3954 "Non-nil means `org-cycle' will open archived trees.
3955 An archived tree is a tree marked with the tag ARCHIVE.
3956 When nil, archived trees will stay folded. You can still open them with
3957 normal outline commands like `show-all', but not with the cycling commands."
3963 "Non-nil means sparse tree construction shows matches in archived trees.
3964 When nil, matches in these trees are highlighted, but the trees are kept in
3965 collapsed state."
3971 "Re-hide all archived subtrees after a visibility state change."
3982 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3985 "Cycle subtree even if it is archived."
3992 "Re-hide all archived subtrees after a visibility state change."
4007 flag)))
4014 org-archive-to-archive-sibling org-toggle-archive-tag
4015 org-archive-subtree-default
4016 org-archive-subtree-default-with-confirmation)))
4018 ;; Autoload Column View Code
4026 org-columns-compute org-agenda-columns org-columns-remove-overlays
4029 ;; Autoload ID code
4037 org-id-get-with-outline-path-completion
4038 org-id-get-with-outline-drilling org-id-store-link
4039 org-id-goto org-id-find org-id-store-link))
4041 ;; Autoload Plotting Code
4046 ;;; Variables for pre-computed regular expressions, all buffer local
4064 "Matches a headline and puts everything into groups:
4065 group 1: the stars
4066 group 2: The todo keyword, maybe
4067 group 3: Priority cookie
4068 group 4: True headline
4072 "Printf format to make regexp to match an exact headline.
4073 This regexp will match the headline of any node which hase the exact
4074 headline text that is put into the format, but may have any TODO state,
4078 "Matches a headline and puts TODO state into group 2 if present.
4133 "Regular expression to match a plain time or time range.
4134 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4135 groups carry important information:
4136 0 the full match
4137 1 the first time, range or not
4145 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4146 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4147 groups carry important information:
4148 0 the full match
4149 7 hours of duration
4158 "Regular expression to match a timestamp time or time range.
4159 After a match, the following groups carry important information:
4160 0 the full match
4161 1 date plus weekday, for back referencing to make sure both times are on the same day
4162 2 the first time, range or not
4217 "Variable associated with STARTUP options for org-mode.
4218 Each element is a list of three items: The startup options as written
4219 in the #+STARTUP line, the corresponding variable, and the value to
4220 set this variable to if the option is found. An optional forth element PUSH
4224 "Precompute regular expressions for current buffer."
4244 kwds kws0 kwsa key log value cat arch tags const links hw dws
4245 tail sep kws1 prio props ftags drawers beamer-p
4267 ;; general TODO-like setup
4279 links)))
4285 props)))
4290 ftags
4300 l var val)
4330 ))))
4347 ;; Process the TODO keywords
4349 ;; Use the global values as if they had been given locally.
4361 kws)))
4364 kwsa nil
4367 ;; 1 2
4375 kw)
4377 kws0)
4394 ;; Process the constants
4402 ;; Process the tags.
4413 tgs))
4421 ;; Compute the regular expressions and other local variables
4429 org-drawer-regexp
4433 org-not-done-keywords
4435 org-todo-regexp
4438 org-not-done-regexp
4442 org-not-done-heading-regexp
4446 org-todo-line-regexp
4450 org-complex-heading-regexp
4455 org-complex-heading-regexp-format
4464 org-nl-done-regexp
4468 org-todo-line-tags-regexp
4473 org-looking-at-done-regexp
4478 org-deadline-time-regexp
4480 org-deadline-line-regexp
4482 org-scheduled-regexp
4484 org-scheduled-time-regexp
4486 org-closed-time-regexp
4488 org-keyword-time-regexp
4494 org-keyword-time-not-clock-regexp
4500 org-maybe-keyword-time-regexp
4506 org-planning-or-clock-line-re
4511 org-all-time-keywords
4514 org-clock-string org-closed-string))
4515 )
4520 "Return the contents of FILE, as a string."
4534 "Extract the log state setting from a TODO keyword string.
4548 "Remove a pair of parenthesis at the end of each string in LIST."
4552 x))
4553 list))
4556 "Assign fast keys to a keyword-key alist.
4557 Respect keys that are already there."
4575 ;;; Some variables used in various places
4582 "Function to be called when `C-c C-c' is used.
4586 ;; FIXME: Occasionally check by commenting these, to make sure
4587 ;; no other functions uses these, forgetting to let-bind them.
4592 ;; Defined somewhere in this file, but used before definition.
4598 ;;;; Define the Org-mode
4601 (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"))
4604 ;; We use a before-change function to check if a table might need
4605 ;; an update.
4607 "Indicates that a table might need an update.
4608 This variable is set by `org-before-change-function'.
4611 "Every change indicates that a table might need an update."
4622 ;;;###autoload
4624 "Outline-based notes management and organizer, alias
4627 Org-mode develops organizational tasks around a NOTES file which
4628 contains information about projects as plain text. Org-mode is
4629 implemented on top of outline-mode, which is ideal to keep the content
4630 of large files well structured. It supports ToDo items, deadlines and
4631 time stamps, which magically appear in the diary listing of the Emacs
4632 calendar. Tables are easily created with a built-in table editor.
4633 Plain text URL-like links connect to websites, emails (VM), Usenet
4634 messages (Gnus), BBDB entries, and any files related to the project.
4635 For printing and sharing of notes, an Org-mode file (or a part of it)
4636 can be exported as a structured ASCII or HTML file.
4638 The following commands are available:
4642 ;; Get rid of Outline menus, they are not needed
4643 ;; Need to do this here because define-derived-mode sets up
4644 ;; the keymap so late. Still, it is a waste to call this each time
4645 ;; we switch another buffer into org-mode.
4648 ;; Assume this is Greg's port, it uses easymenu
4673 org-display-table 4
4676 org-ellipsis)))
4681 ;; tag faces set outside customize.... force initialization.
4683 ;; Calc embedded
4689 ;; Activate before-change-function
4693 ;; Check for running clock before killing a buffer
4695 ;; Paragraphs and auto-filling
4699 ;; Beginning/end of defun
4702 ;; Make sure dependence stuff works reliably, even for users who set it
4703 ;; too late :-(
4715 ;; Comment characters
4719 ;; Align options lines
4721 'align-mode-rules-list
4726 ;; Imenu
4730 ;; Make isearch reveal context
4733 ;; Emacs 21 and XEmacs make use of the hook
4735 ;; Emacs 22 deals with this through a special variable
4739 ;; Turn on org-beamer-mode?
4742 ;; If empty file that did not turn on org-mode automatically, make it to.
4767 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4776 ;;;; Font-Lock stuff, including the activators
4807 "Regular expression used to analyze links.
4808 Here is what the match groups contain after a match:
4809 1: http:
4810 2: http
4811 3: path
4812 4: [desc]
4820 "Number of stacked braces for sub/superscript matching.
4821 This has to be set before loading org.el to be effective."
4826 "Create a regular expression which will match a balanced sexp.
4827 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4828 as single character strings.
4829 The regexp returned will match the entire expression including the
4830 delimiters. It will also define a single group which contains the
4831 match except for the outermost delimiters. The maximum depth of
4832 stacked delimiters is N. Escaping delimiters is not possible."
4861 "Update the link regular expressions.
4862 This should be called after the variable `org-link-types' has changed."
4866 org-link-re-with-space
4872 org-link-re-with-space2
4878 org-link-re-with-space3
4883 org-angle-link-re
4889 org-plain-link-re
4893 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4894 org-bracket-link-regexp
4896 org-bracket-link-analytic-regexp
4904 org-bracket-link-analytic-regexp++
4912 org-any-link-re
4923 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4924 "Regular expression matching time strings for analysis.
4925 This one does not require the space after the date, so it can be used
4927 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4943 "Regular expression matching a time stamp or time stamp range.
4949 "Run through the buffer and add overlays to links."
4958 'face
4971 rtn))
4974 "Insert or change an emphasis, i.e. a font like bold or italic.
4975 If there is an active region, change that region to a new emphasis.
4976 If there is no region, just insert the marker characters and position
4977 the cursor between them.
4978 CHAR should be either the marker character, or the first character of the
4979 HTML tag associated with that emphasis. If CHAR is a space, the means
4980 to remove the emphasis of the selected region.
4981 If char is not given (for example in an interactive call) it
4982 will be prompted for."
5033 "Run through the buffer and add overlays to links."
5042 nil
5048 t)))))
5056 t)))
5059 "When non-nil, fontify code in code blocks."
5065 "Fontify #+ lines and blocks, in the correct ways."
5068 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5069 limit t)
5077 end end1 quoting block-type)
5080 ;; a single line of backend-specific content
5088 ; for backend-specific code
5089 t)
5091 ;; Truly a block
5103 beg end
5107 ; for end_src
5113 org-block)))
5114 ; end of source block
5120 t))
5133 ;; just any other in-buffer setting, but not indented
5137 t)
5145 t)
5153 "Run through the buffer and add overlays to links."
5161 t)))
5164 "Run through the buffer and add overlays to links."
5166 limit t)
5171 'keymap org-mouse-map
5172 'help-echo
5174 "Footnote definition"
5176 ))
5178 t)))
5181 "Run through the buffer and add overlays to bracketed links."
5185 ;; FIXME: above we should remove the escapes.
5186 ;; but that requires another match, protecting match data,
5187 ;; a lot of overhead for font-lock.
5194 ;; We need to remove the invisible property here. Table narrowing
5195 ;; may have made some of this invisible.
5213 t)))
5216 "Run through the buffer and add overlays to dates."
5228 t)))
5237 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5241 "Run through the buffer and add overlays to target matches."
5249 'keymap org-mouse-map
5253 t)))))
5256 "Find all radio targets in this file and update the regular expression."
5271 t)))
5278 ;; This should be with the exporter code, but we also use if for font-locking
5288 "Compute regular expression for stuff treated specially by exporters."
5295 org-latex-regexps)))
5323 org-entities)))
5327 org-latex-entities)
5328 nil))
5330 ))
5331 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5334 org-export-html-special-string-regexps)))
5339 ))))
5341 'org-latex-and-specials-regexp
5346 "Run through the buffer and add overlays to links."
5350 limit t))
5364 rtn)))
5367 "Restart `font-lock-mode', to force refontification."
5373 "Return a list of all targets in this file.
5374 With optional argument RADIO, only find radio targets."
5376 rtn)
5381 rtn)))
5384 "Make regular expression matching all strings in TARGETS.
5385 The regular expression finds the targets also if there is a line break
5386 between words."
5394 x)
5395 targets
5407 t)))
5410 "Compute the outline level of the heading at point.
5411 This function assumes that the cursor is at the beginning of a line matched
5412 by `outline-regexp'. Otherwise it returns garbage.
5413 If this is called at a normal headline, the level is the number of stars.
5414 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5415 For plain list items, if they are matched by `outline-regexp', this returns
5416 1000 plus the line indentation."
5425 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5432 "Functions that can manipulate `org-font-lock-extra-keywords'.
5433 This is calles after `org-font-lock-extra-keywords' is defined, but before
5434 it is installed to be used by font lock. This can be useful if something
5445 ;; Call the hook
5447 ;; Headlines
5454 ;; Table lines
5457 ;; Table internals
5462 ;; Drawers
5465 ;; Properties
5469 ;; Links
5480 ;; TODO lines
5483 ;; DONE
5489 nil)
5490 ;; Priorities
5492 ;; Tags
5494 ;; Special keywords
5499 ;; Emphasis
5504 ;; Checkboxes
5505 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5510 ;; Description list items
5513 ;; ARCHIVEd headings
5516 ;; Specials
5520 ;; Code
5522 ;; COMMENT
5527 ;; Blocks and meta lines
5529 )))
5532 ;; Now set the full font-lock-keywords
5539 "Toggle the composition display of entities as UTF8 characters."
5551 "Find an entity to fontify."
5557 limit t)
5569 nil))))
5572 "Fontify string S like in Org-mode."
5584 "Get the right face for match N in font-lock matching of headlines."
5594 "Get the right face for a TODO keyword KWD.
5595 If KWD is a number, get the corresponding match group."
5603 "Create a face list that inherits INHERIT, but sets the foreground color.
5604 When FACE-OR-COLOR is not a string, just return it."
5608 face-or-color)
5609 face-or-color))
5612 "Add the special tag faces."
5621 "Add the special priority faces."
5628 org-priority-faces)))
5633 "Get the right face for a TODO keyword KWD.
5634 If KWD is a number, get the corresponding match group."
5641 "Remove fontification and activation overlays from links."
5646 deactivate-mark buffer-file-name buffer-file-truename)
5649 beg end
5651 ;; also remove line-prefix and wrap-prefix properties
5653 invisible t intangible t
5654 line-prefix t wrap-prefix t
5655 org-no-flyspell t org-emphasis t)
5657 invisible t intangible t
5658 org-no-flyspell t org-emphasis t)))
5668 "Remove specific display properties that have been added by font lock.
5669 The will remove the raise properties that are used to show superscripts
5670 and subscripts."
5680 "Add raise properties to sub/superscripts."
5684 org-match-substring-regexp
5685 org-match-substring-with-braces-regexp)
5686 limit t)
5696 ;; FIXME: Should we go back one character here, for a_b^c
5697 ;; (goto-char (1- pos)) ;????????????????????
5699 t
5701 'display
5717 t)))))
5719 ;;;; Visibility cycling, including org-goto and indirect buffer
5721 ;;; Cycling
5728 ;;;###autoload
5733 "TAB-action and visibility cycling for Org-mode.
5735 This is the command invoked in Org-mode by the TAB key. Its main purpose
5736 is outline visibility cycling, but it also invokes other actions
5737 in special contexts.
5739 - When this function is called with a prefix argument, rotate the entire
5740 buffer through 3 states (global cycling)
5741 1. OVERVIEW: Show only top-level headlines.
5742 2. CONTENTS: Show all headlines of all levels, but no body text.
5743 3. SHOW ALL: Show everything.
5744 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5745 determined by the variable `org-startup-folded', and by any VISIBILITY
5746 properties in the buffer.
5747 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5748 including any drawers.
5750 - When inside a table, re-align the table and move to the next field.
5752 - When point is at the beginning of a headline, rotate the subtree started
5753 by this line through 3 different states (local cycling)
5754 1. FOLDED: Only the main headline is shown.
5755 2. CHILDREN: The main headline and the direct children are shown.
5756 From this state, you can move to one of the children
5757 and zoom in further.
5758 3. SUBTREE: Show the entire subtree, including body text.
5759 If there is no subtree, switch directly from CHILDREN to FOLDED.
5761 - When point is at the beginning of an empty headline and the variable
5762 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5763 of the headline by demoting and promoting it to likely levels. This
5764 speeds up creation document structure by pressing TAB once or several
5765 times right after creating a new headline.
5767 - When there is a numeric prefix, go up to a heading with level ARG, do
5768 a `show-subtree' and return to the previous cursor position. If ARG
5769 is negative, go up that many levels.
5771 - When point is not at the beginning of a headline, execute the global
5772 binding for TAB, which is re-indenting the line. See the option
5773 `org-cycle-emulate-tab' for details.
5775 - Special case: if point is at the beginning of the buffer and there is
5776 no headline in line 1, this function will act as if called with prefix arg
5777 (C-u TAB, same as S-TAB) also when called without prefix arg.
5778 But only if also the variable `org-cycle-global-at-bob' is t."
5788 org-inlinetask-min-level
5793 limit-level)))
5809 org-cycle-hook))
5813 ;; special case: use global cycling
5828 ;; Enter the table or move to the next field in the table
5845 ;; Toggle block visibility
5850 ;; Show-subtree, ARG levels up from here.
5862 ;; TAB emulation and template completion
5886 t
5895 "Do the global cycling action."
5899 ;; We just created the overview - now do table of contents
5900 ;; This can be slow in very large buffers, so indicate action
5910 ;; We just showed the table of contents - now show everything
5918 ;; Default action: go to overview
5926 "Do the local cycling action."
5928 ;; First, some boundaries
5935 ; XEmacs does not have `next-single-char-property-change'
5936 ; I'm not sure about Emacs 21.
5950 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5959 ;; Find out what to do next and set `this-command'
5962 ;; Nothing is hidden behind this heading
5974 org-cycle-skip-children-state-if-no-children))))
5975 ;; Entire subtree is hidden in one line: children view
5989 ;; We just showed the children, or no children are there,
5990 ;; now show everything.
5997 ;; Default action: hide the subtree.
6004 ;;;###autoload
6006 "Cycle the global visibility. For details see `org-cycle'.
6008 With a numeric prefix, show all headlines up to that level."
6024 "Set the visibility required by startup options and properties."
6039 "Switch subtree visibilities according to :VISIBILITY: property."
6046 nil t)
6071 "Switch to overview mode, showing only top-level headlines.
6072 Really, this shows all headlines with level equal or greater than the level
6073 of the first headline in the buffer. This is important, because if the
6074 first headline is not level one, then (hide-sublevels 1) gives confusing
6075 results."
6086 "Show all headlines in the buffer, like a table of contents.
6087 With numerical argument N, show content up to level N."
6090 ;; Visit all headings and show their offspring
6097 t)
6106 "Adjust the window after a change in outline visibility.
6107 This function is the default value of the hook `org-cycle-hook'."
6117 "Remove outline overlays that do not contain non-white stuff."
6127 "Fix visibility issues after moving a subtree."
6128 ;; First, find a reasonable region to look at:
6129 ;; Start two siblings above, end three below
6147 ;; Properly fold already folded siblings
6158 "Show empty lines above all visible headlines.
6159 The region to be covered depends on STATE when called through
6160 `org-cycle-hook'. Lisp program can use t for STATE to get the
6161 entire buffer covered. Note that an empty line is only shown if there
6162 are at least `org-cycle-separator-lines' empty lines before the headline."
6172 beg end b e)
6196 ;; Never hide empty lines at the end of the file.
6206 "Move to the parent and re-show empty lines before visible headlines."
6212 "Return `org-agenda-files' list, plus all open org-mode files.
6213 This is useful for operations that need to scan all of a user's
6214 open and agenda-wise Org files."
6222 files))
6225 "Return the beginning position of the current entry."
6229 "Return the end position of the current entry."
6233 "Re-hide all drawers after a visibility state change."
6260 "Is the end of the current subtree visible?"
6265 "Move cursor to the first headline and recenter the headline.
6266 Optional argument N means put the headline into the Nth line of the window."
6272 ;;; Saving and restoring visibility
6275 "Return a list of the locations of all outline overlays.
6276 These are overlays with the `invisible' property value `outline'.
6277 The return value is a list of cons cells, with start and stop
6278 positions for each overlay.
6279 If USE-MARKERS is set, return the positions as markers."
6297 "Create visibility overlays for all positions in DATA.
6298 DATA should have been made by `org-outline-overlay-data'."
6307 data)))))
6309 ;;; Folding of blocks
6321 "Call FUNCTION at the head of all source blocks in the current buffer.
6322 Optional arguments START and END can be used to limit the range."
6334 "Toggle the visibility of all blocks in the current buffer."
6338 "Fold all blocks in the current buffer."
6344 "Unfold all blocks in the current buffer."
6350 "Toggle visibility of block at point."
6361 "Toggle the visibility of the current block."
6368 ov)
6384 ;; make the block accessible to isearch
6386 ov 'isearch-open-invisible
6397 ;; org-tab-after-check-for-cycling-hook
6399 ;; Remove overlays when changing major mode
6404 ;;; Org-goto
6410 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6426 nil)
6427 (org-defkey map "q" 'org-goto-quit)
6428 (org-defkey map "n" 'outline-next-visible-heading)
6429 (org-defkey map "p" 'outline-previous-visible-heading)
6430 (org-defkey map "f" 'outline-forward-same-level)
6431 (org-defkey map "b" 'outline-backward-same-level)
6432 (org-defkey map "u" 'outline-up-heading))
6433 (org-defkey map "/" 'org-occur)
6434 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6435 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6436 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6437 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6438 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6439 map))
6441 (defconst org-goto-help
6442 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6443 RET=jump to location [Q]uit and return to previous location
6444 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6446 (defvar org-goto-start-pos) ; dynamically scoped parameter
6448 ;; FIXME: Docstring does not mention both interfaces
6449 (defun org-goto (&optional alternative-interface)
6450 "Look up a different location in the current file, keeping current visibility.
6452 When you want look-up or go to a different location in a document, the
6453 fastest way is often to fold the entire buffer and then dive into the tree.
6454 This method has the disadvantage, that the previous location will be folded,
6455 which may not be what you want.
6457 This command works around this by showing a copy of the current buffer
6458 in an indirect buffer, in overview mode. You can dive into the tree in
6459 that copy, use org-occur and incremental search to find a location.
6460 When pressing RET or `Q', the command returns to the original buffer in
6461 which the visibility is still unchanged. After RET is will also jump to
6462 the location selected in the indirect buffer and expose the
6463 the headline hierarchy above."
6464 (interactive "P")
6465 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6466 (org-refile-use-outline-path t)
6467 (org-refile-target-verify-function nil)
6468 (interface
6469 (if (not alternative-interface)
6470 org-goto-interface
6471 (if (eq org-goto-interface 'outline)
6472 'outline-path-completion
6473 'outline)))
6474 (org-goto-start-pos (point))
6475 (selected-point
6476 (if (eq interface 'outline)
6477 (car (org-get-location (current-buffer) org-goto-help))
6478 (let ((pa (org-refile-get-location "Goto: ")))
6479 (org-refile-check-position pa)
6480 (nth 3 pa)))))
6481 (if selected-point
6482 (progn
6483 (org-mark-ring-push org-goto-start-pos)
6484 (goto-char selected-point)
6485 (if (or (org-invisible-p) (org-invisible-p2))
6486 (org-show-context 'org-goto)))
6487 (message "Quit"))))
6489 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6490 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6491 (defvar org-goto-local-auto-isearch-map) ; defined below
6493 (defun org-get-location (buf help)
6494 "Let the user select a location in the Org-mode buffer BUF.
6495 This function uses a recursive edit. It returns the selected position
6496 or nil."
6497 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6498 (isearch-hide-immediately nil)
6499 (isearch-search-fun-function
6500 (lambda () 'org-goto-local-search-headings))
6501 (org-goto-selected-point org-goto-exit-command)
6502 (pop-up-frames nil)
6503 (special-display-buffer-names nil)
6504 (special-display-regexps nil)
6505 (special-display-function nil))
6506 (save-excursion
6507 (save-window-excursion
6508 (delete-other-windows)
6509 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6510 (switch-to-buffer
6511 (condition-case nil
6512 (make-indirect-buffer (current-buffer) "*org-goto*")
6513 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6514 (with-output-to-temp-buffer "*Help*"
6515 (princ help))
6516 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6517 (setq buffer-read-only nil)
6518 (let ((org-startup-truncated t)
6519 (org-startup-folded nil)
6520 (org-startup-align-all-tables nil))
6521 (org-mode)
6522 (org-overview))
6523 (setq buffer-read-only t)
6524 (if (and (boundp 'org-goto-start-pos)
6525 (integer-or-marker-p org-goto-start-pos))
6526 (let ((org-show-hierarchy-above t)
6527 (org-show-siblings t)
6528 (org-show-following-heading t))
6529 (goto-char org-goto-start-pos)
6530 (and (org-invisible-p) (org-show-context)))
6531 (goto-char (point-min)))
6532 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6533 (message "Select location and press RET")
6534 (use-local-map org-goto-map)
6535 (recursive-edit)
6536 ))
6537 (kill-buffer "*org-goto*")
6538 (cons org-goto-selected-point org-goto-exit-command)))
6540 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6541 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6542 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6543 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6545 (defun org-goto-local-search-headings (string bound noerror)
6546 "Search and make sure that any matches are in headlines."
6547 (catch 'return
6548 (while (if isearch-forward
6549 (search-forward string bound noerror)
6550 (search-backward string bound noerror))
6551 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6552 (and (member :headline context)
6553 (not (member :tags context))))
6554 (throw 'return (point))))))
6556 (defun org-goto-local-auto-isearch ()
6557 "Start isearch."
6558 (interactive)
6559 (goto-char (point-min))
6560 (let ((keys (this-command-keys)))
6561 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6562 (isearch-mode t)
6563 (isearch-process-search-char (string-to-char keys)))))
6565 (defun org-goto-ret (&optional arg)
6566 "Finish `org-goto' by going to the new location."
6567 (interactive "P")
6568 (setq org-goto-selected-point (point)
6569 org-goto-exit-command 'return)
6570 (throw 'exit nil))
6572 (defun org-goto-left ()
6573 "Finish `org-goto' by going to the new location."
6574 (interactive)
6575 (if (org-on-heading-p)
6576 (progn
6577 (beginning-of-line 1)
6578 (setq org-goto-selected-point (point)
6579 org-goto-exit-command 'left)
6580 (throw 'exit nil))
6581 (error "Not on a heading")))
6583 (defun org-goto-right ()
6584 "Finish `org-goto' by going to the new location."
6585 (interactive)
6586 (if (org-on-heading-p)
6587 (progn
6588 (setq org-goto-selected-point (point)
6589 org-goto-exit-command 'right)
6590 (throw 'exit nil))
6591 (error "Not on a heading")))
6593 (defun org-goto-quit ()
6594 "Finish `org-goto' without cursor motion."
6595 (interactive)
6596 (setq org-goto-selected-point nil)
6597 (setq org-goto-exit-command 'quit)
6598 (throw 'exit nil))
6600 ;;; Indirect buffer display of subtrees
6602 (defvar org-indirect-dedicated-frame nil
6603 "This is the frame being used for indirect tree display.")
6604 (defvar org-last-indirect-buffer nil)
6606 (defun org-tree-to-indirect-buffer (&optional arg)
6607 "Create indirect buffer and narrow it to current subtree.
6608 With numerical prefix ARG, go up to this level and then take that tree.
6609 If ARG is negative, go up that many levels.
6610 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6611 indirect buffer previously made with this command, to avoid proliferation of
6612 indirect buffers. However, when you call the command with a \
6614 when `org-indirect-buffer-display' is `new-frame', the last buffer
6615 is kept so that you can work with several indirect buffers at the same time.
6616 If `org-indirect-buffer-display' is `dedicated-frame', the \
6618 requests that a new frame be made for the new buffer, so that the dedicated
6619 frame is not changed."
6620 (interactive "P")
6621 (let ((cbuf (current-buffer))
6622 (cwin (selected-window))
6623 (pos (point))
6624 beg end level heading ibuf)
6625 (save-excursion
6626 (org-back-to-heading t)
6627 (when (numberp arg)
6628 (setq level (org-outline-level))
6629 (if (< arg 0) (setq arg (+ level arg)))
6630 (while (> (setq level (org-outline-level)) arg)
6631 (outline-up-heading 1 t)))
6632 (setq beg (point)
6633 heading (org-get-heading))
6634 (org-end-of-subtree t t)
6635 (if (org-on-heading-p) (backward-char 1))
6636 (setq end (point)))
6637 (if (and (buffer-live-p org-last-indirect-buffer)
6638 (not (eq org-indirect-buffer-display 'new-frame))
6639 (not arg))
6640 (kill-buffer org-last-indirect-buffer))
6641 (setq ibuf (org-get-indirect-buffer cbuf)
6642 org-last-indirect-buffer ibuf)
6643 (cond
6644 ((or (eq org-indirect-buffer-display 'new-frame)
6645 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6646 (select-frame (make-frame))
6647 (delete-other-windows)
6648 (switch-to-buffer ibuf)
6649 (org-set-frame-title heading))
6650 ((eq org-indirect-buffer-display 'dedicated-frame)
6651 (raise-frame
6652 (select-frame (or (and org-indirect-dedicated-frame
6653 (frame-live-p org-indirect-dedicated-frame)
6654 org-indirect-dedicated-frame)
6655 (setq org-indirect-dedicated-frame (make-frame)))))
6656 (delete-other-windows)
6657 (switch-to-buffer ibuf)
6658 (org-set-frame-title (concat "Indirect: " heading)))
6659 ((eq org-indirect-buffer-display 'current-window)
6660 (switch-to-buffer ibuf))
6661 ((eq org-indirect-buffer-display 'other-window)
6662 (pop-to-buffer ibuf))
6663 (t (error "Invalid value")))
6664 (if (featurep 'xemacs)
6665 (save-excursion (org-mode) (turn-on-font-lock)))
6666 (narrow-to-region beg end)
6667 (show-all)
6668 (goto-char pos)
6669 (and (window-live-p cwin) (select-window cwin))))
6671 (defun org-get-indirect-buffer (&optional buffer)
6672 (setq buffer (or buffer (current-buffer)))
6673 (let ((n 1) (base (buffer-name buffer)) bname)
6674 (while (buffer-live-p
6675 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6676 (setq n (1+ n)))
6677 (condition-case nil
6678 (make-indirect-buffer buffer bname 'clone)
6679 (error (make-indirect-buffer buffer bname)))))
6681 (defun org-set-frame-title (title)
6682 "Set the title of the current frame to the string TITLE."
6683 ;; FIXME: how to name a single frame in XEmacs???
6684 (unless (featurep 'xemacs)
6685 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6687 ;;;; Structure editing
6689 ;;; Inserting headlines
6691 (defun org-previous-line-empty-p ()
6692 (save-excursion
6693 (and (not (bobp))
6694 (or (beginning-of-line 0) t)
6695 (save-match-data
6698 (defun org-insert-heading (&optional force-heading invisible-ok)
6699 "Insert a new heading or item with same depth at point.
6700 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6701 If point is at the beginning of a headline, insert a sibling before the
6702 current headline. If point is not at the beginning, split the line,
6703 create the new headline with the text in the current line after point
6704 \(but see also the variable `org-M-RET-may-split-line').
6706 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6707 This is important for non-interactive uses of the command."
6708 (interactive "P")
6709 (if (or (= (buffer-size) 0)
6710 (and (not (save-excursion
6711 (and (ignore-errors (org-back-to-heading invisible-ok))
6712 (org-on-heading-p))))
6713 (not (org-in-item-p))))
6714 (progn
6716 (run-hooks 'org-insert-heading-hook))
6717 (when (or force-heading (not (org-insert-item)))
6718 (let* ((empty-line-p nil)
6719 (level nil)
6720 (on-heading (org-on-heading-p))
6721 (head (save-excursion
6722 (condition-case nil
6723 (progn
6724 (org-back-to-heading invisible-ok)
6725 (when (and (not on-heading)
6726 (featurep 'org-inlinetask)
6727 (integerp org-inlinetask-min-level)
6728 (>= (length (match-string 0))
6729 org-inlinetask-min-level))
6730 ;; Find a heading level before the inline task
6731 (while (and (setq level (org-up-heading-safe))
6732 (>= level org-inlinetask-min-level)))
6733 (if (org-on-heading-p)
6734 (org-back-to-heading invisible-ok)
6735 (error "This should not happen")))
6736 (setq empty-line-p (org-previous-line-empty-p))
6737 (match-string 0))
6738 (error "*"))))
6739 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6740 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6741 pos hide-previous previous-pos)
6742 (cond
6743 ((and (org-on-heading-p) (bolp)
6744 (or (bobp)
6745 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6746 ;; insert before the current line
6747 (open-line (if blank 2 1)))
6748 ((and (bolp)
6749 (not org-insert-heading-respect-content)
6750 (or (bobp)
6751 (save-excursion
6752 (backward-char 1) (not (org-invisible-p)))))
6753 ;; insert right here
6754 nil)
6755 (t
6756 ;; somewhere in the line
6757 (save-excursion
6758 (setq previous-pos (point-at-bol))
6759 (end-of-line)
6760 (setq hide-previous (org-invisible-p)))
6761 (and org-insert-heading-respect-content (org-show-subtree))
6762 (let ((split
6763 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6764 (save-excursion
6765 (let ((p (point)))
6766 (goto-char (point-at-bol))
6767 (and (looking-at org-complex-heading-regexp)
6768 (> p (match-beginning 4)))))))
6769 tags pos)
6770 (cond
6771 (org-insert-heading-respect-content
6772 (org-end-of-subtree nil t)
6773 (when (featurep 'org-inlinetask)
6774 (while (and (not (eobp))
6776 (>= (length (match-string 1))
6777 org-inlinetask-min-level))
6778 (org-end-of-subtree nil t)))
6779 (or (bolp) (newline))
6780 (or (org-previous-line-empty-p)
6781 (and blank (newline)))
6782 (open-line 1))
6783 ((org-on-heading-p)
6784 (when hide-previous
6785 (show-children)
6786 (org-show-entry))
6788 (setq tags (and (match-end 2) (match-string 2)))
6789 (and (match-end 1)
6790 (delete-region (match-beginning 1) (match-end 1)))
6791 (setq pos (point-at-bol))
6792 (or split (end-of-line 1))
6793 (delete-horizontal-space)
6795 (buffer-substring (point-at-bol) (point)))
6796 (insert " "))
6797 (newline (if blank 2 1))
6798 (when tags
6799 (save-excursion
6800 (goto-char pos)
6801 (end-of-line 1)
6802 (insert " " tags)
6803 (org-set-tags nil 'align))))
6804 (t
6805 (or split (end-of-line 1))
6806 (newline (if blank 2 1)))))))
6807 (insert head) (just-one-space)
6808 (setq pos (point))
6809 (end-of-line 1)
6810 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6811 (when (and org-insert-heading-respect-content hide-previous)
6812 (save-excursion
6813 (goto-char previous-pos)
6814 (hide-subtree)))
6815 (run-hooks 'org-insert-heading-hook)))))
6817 (defun org-get-heading (&optional no-tags)
6818 "Return the heading of the current entry, without the stars."
6819 (save-excursion
6820 (org-back-to-heading t)
6821 (if (looking-at
6822 (if no-tags
6825 (match-string 1) "")))
6827 (defun org-heading-components ()
6828 "Return the components of the current heading.
6829 This is a list with the following elements:
6830 - the level as an integer
6831 - the reduced level, different if `org-odd-levels-only' is set.
6832 - the TODO keyword, or nil
6833 - the priority character, like ?A, or nil if no priority is given
6834 - the headline text itself, or the tags string if no headline text
6835 - the tags string, or nil."
6836 (save-excursion
6837 (org-back-to-heading t)
6838 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6839 (list (length (match-string 1))
6840 (org-reduced-level (length (match-string 1)))
6841 (org-match-string-no-properties 2)
6842 (and (match-end 3) (aref (match-string 3) 2))
6843 (org-match-string-no-properties 4)
6844 (org-match-string-no-properties 5)))))
6846 (defun org-get-entry ()
6847 "Get the entry text, after heading, entire subtree."
6848 (save-excursion
6849 (org-back-to-heading t)
6850 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6852 (defun org-insert-heading-after-current ()
6853 "Insert a new heading with same level as current, after current subtree."
6854 (interactive)
6855 (org-back-to-heading)
6856 (org-insert-heading)
6857 (org-move-subtree-down)
6858 (end-of-line 1))
6860 (defun org-insert-heading-respect-content ()
6861 (interactive)
6862 (let ((org-insert-heading-respect-content t))
6863 (org-insert-heading t)))
6865 (defun org-insert-todo-heading-respect-content (&optional force-state)
6866 (interactive "P")
6867 (let ((org-insert-heading-respect-content t))
6868 (org-insert-todo-heading force-state t)))
6870 (defun org-insert-todo-heading (arg &optional force-heading)
6871 "Insert a new heading with the same level and TODO state as current heading.
6872 If the heading has no TODO state, or if the state is DONE, use the first
6873 state (TODO by default). Also with prefix arg, force first state."
6874 (interactive "P")
6875 (when (or force-heading (not (org-insert-item 'checkbox)))
6876 (org-insert-heading force-heading)
6877 (save-excursion
6878 (org-back-to-heading)
6879 (outline-previous-heading)
6880 (looking-at org-todo-line-regexp))
6881 (let*
6882 ((new-mark-x
6883 (if (or arg
6884 (not (match-beginning 2))
6885 (member (match-string 2) org-done-keywords))
6886 (car org-todo-keywords-1)
6887 (match-string 2)))
6888 (new-mark
6889 (or
6890 (run-hook-with-args-until-success
6891 'org-todo-get-default-hook new-mark-x nil)
6892 new-mark-x)))
6893 (beginning-of-line 1)
6895 (if org-treat-insert-todo-heading-as-state-change
6896 (org-todo new-mark)
6897 (insert new-mark " "))))
6898 (when org-provide-todo-statistics
6899 (org-update-parent-todo-statistics))))
6901 (defun org-insert-subheading (arg)
6902 "Insert a new subheading and demote it.
6903 Works for outline headings and for plain lists alike."
6904 (interactive "P")
6905 (org-insert-heading arg)
6906 (cond
6907 ((org-on-heading-p) (org-do-demote))
6908 ((org-at-item-p) (org-indent-item))))
6910 (defun org-insert-todo-subheading (arg)
6911 "Insert a new subheading with TODO keyword or checkbox and demote it.
6912 Works for outline headings and for plain lists alike."
6913 (interactive "P")
6914 (org-insert-todo-heading arg)
6915 (cond
6916 ((org-on-heading-p) (org-do-demote))
6917 ((org-at-item-p) (org-indent-item))))
6919 ;;; Promotion and Demotion
6921 (defvar org-after-demote-entry-hook nil
6922 "Hook run after an entry has been demoted.
6923 The cursor will be at the beginning of the entry.
6924 When a subtree is being demoted, the hook will be called for each node.")
6926 (defvar org-after-promote-entry-hook nil
6927 "Hook run after an entry has been promoted.
6928 The cursor will be at the beginning of the entry.
6929 When a subtree is being promoted, the hook will be called for each node.")
6931 (defun org-promote-subtree ()
6932 "Promote the entire subtree.
6933 See also `org-promote'."
6934 (interactive)
6935 (save-excursion
6936 (org-map-tree 'org-promote))
6937 (org-fix-position-after-promote))
6939 (defun org-demote-subtree ()
6940 "Demote the entire subtree. See `org-demote'.
6941 See also `org-promote'."
6942 (interactive)
6943 (save-excursion
6944 (org-map-tree 'org-demote))
6945 (org-fix-position-after-promote))
6948 (defun org-do-promote ()
6949 "Promote the current heading higher up the tree.
6950 If the region is active in `transient-mark-mode', promote all headings
6951 in the region."
6952 (interactive)
6953 (save-excursion
6954 (if (org-region-active-p)
6955 (org-map-region 'org-promote (region-beginning) (region-end))
6956 (org-promote)))
6957 (org-fix-position-after-promote))
6959 (defun org-do-demote ()
6960 "Demote the current heading lower down the tree.
6961 If the region is active in `transient-mark-mode', demote all headings
6962 in the region."
6963 (interactive)
6964 (save-excursion
6965 (if (org-region-active-p)
6966 (org-map-region 'org-demote (region-beginning) (region-end))
6967 (org-demote)))
6968 (org-fix-position-after-promote))
6970 (defun org-fix-position-after-promote ()
6971 "Make sure that after pro/demotion cursor position is right."
6972 (let ((pos (point)))
6973 (when (save-excursion
6974 (beginning-of-line 1)
6975 (looking-at org-todo-line-regexp)
6976 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6977 (cond ((eobp) (insert " "))
6978 ((eolp) (insert " "))
6979 ((equal (char-after) ?\ ) (forward-char 1))))))
6981 (defun org-current-level ()
6982 "Return the level of the current entry, or nil if before the first headline.
6983 The level is the number of stars at the beginning of the headline."
6984 (save-excursion
6985 (condition-case nil
6986 (progn
6987 (org-back-to-heading t)
6988 (funcall outline-level))
6989 (error nil))))
6991 (defun org-get-previous-line-level ()
6992 "Return the outline depth of the last headline before the current line.
6993 Returns 0 for the first headline in the buffer, and nil if before the
6994 first headline."
6995 (let ((current-level (org-current-level))
6996 (prev-level (when (> (line-number-at-pos) 1)
6997 (save-excursion
6998 (beginning-of-line 0)
6999 (org-current-level)))))
7000 (cond ((null current-level) nil) ; Before first headline
7001 ((null prev-level) 0) ; At first headline
7002 (prev-level))))
7004 (defun org-reduced-level (l)
7005 "Compute the effective level of a heading.
7006 This takes into account the setting of `org-odd-levels-only'."
7007 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7009 (defun org-level-increment ()
7010 "Return the number of stars that will be added or removed at a
7011 time to headlines when structure editing, based on the value of
7012 `org-odd-levels-only'."
7013 (if org-odd-levels-only 2 1))
7015 (defun org-get-valid-level (level &optional change)
7016 "Rectify a level change under the influence of `org-odd-levels-only'
7017 LEVEL is a current level, CHANGE is by how much the level should be
7018 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7019 even level numbers will become the next higher odd number."
7020 (if org-odd-levels-only
7021 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7022 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7023 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7024 (max 1 (+ level (or change 0)))))
7026 (if (boundp 'define-obsolete-function-alias)
7027 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7028 (define-obsolete-function-alias 'org-get-legal-level
7029 'org-get-valid-level)
7030 (define-obsolete-function-alias 'org-get-legal-level
7031 'org-get-valid-level "23.1")))
7033 (defun org-promote ()
7034 "Promote the current heading higher up the tree.
7035 If the region is active in `transient-mark-mode', promote all headings
7036 in the region."
7037 (org-back-to-heading t)
7038 (let* ((level (save-match-data (funcall outline-level)))
7039 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7040 (diff (abs (- level (length up-head) -1))))
7041 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7042 (replace-match up-head nil t)
7043 ;; Fixup tag positioning
7044 (and org-auto-align-tags (org-set-tags nil t))
7045 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7046 (run-hooks 'org-after-promote-entry-hook)))
7048 (defun org-demote ()
7049 "Demote the current heading lower down the tree.
7050 If the region is active in `transient-mark-mode', demote all headings
7051 in the region."
7052 (org-back-to-heading t)
7053 (let* ((level (save-match-data (funcall outline-level)))
7054 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7055 (diff (abs (- level (length down-head) -1))))
7056 (replace-match down-head nil t)
7057 ;; Fixup tag positioning
7058 (and org-auto-align-tags (org-set-tags nil t))
7059 (if org-adapt-indentation (org-fixup-indentation diff))
7060 (run-hooks 'org-after-demote-entry-hook)))
7062 (defun org-cycle-level ()
7063 "Cycle the level of an empty headline through possible states.
7064 This goes first to child, then to parent, level, then up the hierarchy.
7065 After top level, it switches back to sibling level."
7066 (interactive)
7067 (let ((org-adapt-indentation nil))
7068 (when (org-point-at-end-of-empty-headline)
7069 (setq this-command 'org-cycle-level) ; Only needed for caching
7070 (let ((cur-level (org-current-level))
7071 (prev-level (org-get-previous-line-level)))
7072 (cond
7073 ;; If first headline in file, promote to top-level.
7074 ((= prev-level 0)
7075 (loop repeat (/ (- cur-level 1) (org-level-increment))
7076 do (org-do-promote)))
7077 ;; If same level as prev, demote one.
7078 ((= prev-level cur-level)
7079 (org-do-demote))
7080 ;; If parent is top-level, promote to top level if not already.
7081 ((= prev-level 1)
7082 (loop repeat (/ (- cur-level 1) (org-level-increment))
7083 do (org-do-promote)))
7084 ;; If top-level, return to prev-level.
7085 ((= cur-level 1)
7086 (loop repeat (/ (- prev-level 1) (org-level-increment))
7087 do (org-do-demote)))
7088 ;; If less than prev-level, promote one.
7089 ((< cur-level prev-level)
7090 (org-do-promote))
7091 ;; If deeper than prev-level, promote until higher than
7092 ;; prev-level.
7093 ((> cur-level prev-level)
7094 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7095 do (org-do-promote))))
7096 t))))
7098 (defun org-map-tree (fun)
7099 "Call FUN for every heading underneath the current one."
7100 (org-back-to-heading)
7101 (let ((level (funcall outline-level)))
7102 (save-excursion
7103 (funcall fun)
7104 (while (and (progn
7105 (outline-next-heading)
7106 (> (funcall outline-level) level))
7107 (not (eobp)))
7108 (funcall fun)))))
7110 (defun org-map-region (fun beg end)
7111 "Call FUN for every heading between BEG and END."
7112 (let ((org-ignore-region t))
7113 (save-excursion
7114 (setq end (copy-marker end))
7115 (goto-char beg)
7116 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7117 (< (point) end))
7118 (funcall fun))
7119 (while (and (progn
7120 (outline-next-heading)
7121 (< (point) end))
7122 (not (eobp)))
7123 (funcall fun)))))
7125 (defun org-fixup-indentation (diff)
7126 "Change the indentation in the current entry by DIFF.
7127 However, if any line in the current entry has no indentation, or if it
7128 would end up with no indentation after the change, nothing at all is done."
7129 (save-excursion
7130 (let ((end (save-excursion (outline-next-heading)
7131 (point-marker)))
7132 (prohibit (if (> diff 0)
7135 col)
7136 (unless (save-excursion (end-of-line 1)
7137 (re-search-forward prohibit end t))
7138 (while (and (< (point) end)
7140 (goto-char (match-end 0))
7141 (setq col (current-column))
7142 (if (< diff 0) (replace-match ""))
7143 (org-indent-to-column (+ diff col))))
7144 (move-marker end nil))))
7146 (defun org-convert-to-odd-levels ()
7147 "Convert an org-mode file with all levels allowed to one with odd levels.
7148 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7149 level 5 etc."
7150 (interactive)
7151 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7152 (let ((outline-regexp org-outline-regexp)
7153 (outline-level 'org-outline-level)
7154 (org-odd-levels-only nil) n)
7155 (save-excursion
7156 (goto-char (point-min))
7158 (setq n (- (length (match-string 0)) 2))
7159 (while (>= (setq n (1- n)) 0)
7160 (org-demote))
7161 (end-of-line 1))))))
7163 (defun org-convert-to-oddeven-levels ()
7164 "Convert an org-mode file with only odd levels to one with odd/even levels.
7165 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7166 file contains a section with an even level, conversion would
7167 destroy the structure of the file. An error is signaled in this
7168 case."
7169 (interactive)
7170 (goto-char (point-min))
7171 ;; First check if there are no even levels
7173 (org-show-context t)
7174 (error "Not all levels are odd in this file. Conversion not possible"))
7175 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7176 (let ((outline-regexp org-outline-regexp)
7177 (outline-level 'org-outline-level)
7178 (org-odd-levels-only nil) n)
7179 (save-excursion
7180 (goto-char (point-min))
7182 (setq n (/ (1- (length (match-string 0))) 2))
7183 (while (>= (setq n (1- n)) 0)
7184 (org-promote))
7185 (end-of-line 1))))))
7187 (defun org-tr-level (n)
7188 "Make N odd if required."
7189 (if org-odd-levels-only (1+ (/ n 2)) n))
7191 ;;; Vertical tree motion, cutting and pasting of subtrees
7193 (defun org-move-subtree-up (&optional arg)
7194 "Move the current subtree up past ARG headlines of the same level."
7195 (interactive "p")
7196 (org-move-subtree-down (- (prefix-numeric-value arg))))
7198 (defun org-move-subtree-down (&optional arg)
7199 "Move the current subtree down past ARG headlines of the same level."
7200 (interactive "p")
7201 (setq arg (prefix-numeric-value arg))
7202 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7203 'org-get-last-sibling))
7204 (ins-point (make-marker))
7205 (cnt (abs arg))
7206 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7207 ;; Select the tree
7208 (org-back-to-heading)
7209 (setq beg0 (point))
7210 (save-excursion
7211 (setq ne-beg (org-back-over-empty-lines))
7212 (setq beg (point)))
7213 (save-match-data
7214 (save-excursion (outline-end-of-heading)
7215 (setq folded (org-invisible-p)))
7216 (outline-end-of-subtree))
7217 (outline-next-heading)
7218 (setq ne-end (org-back-over-empty-lines))
7219 (setq end (point))
7220 (goto-char beg0)
7221 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7222 ;; include less whitespace
7223 (save-excursion
7224 (goto-char beg)
7225 (forward-line (- ne-beg ne-end))
7226 (setq beg (point))))
7227 ;; Find insertion point, with error handling
7228 (while (> cnt 0)
7229 (or (and (funcall movfunc) (looking-at outline-regexp))
7230 (progn (goto-char beg0)
7231 (error "Cannot move past superior level or buffer limit")))
7232 (setq cnt (1- cnt)))
7233 (if (> arg 0)
7234 ;; Moving forward - still need to move over subtree
7235 (progn (org-end-of-subtree t t)
7236 (save-excursion
7237 (org-back-over-empty-lines)
7238 (or (bolp) (newline)))))
7239 (setq ne-ins (org-back-over-empty-lines))
7240 (move-marker ins-point (point))
7241 (setq txt (buffer-substring beg end))
7242 (org-save-markers-in-region beg end)
7243 (delete-region beg end)
7244 (org-remove-empty-overlays-at beg)
7245 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7246 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7248 (let ((bbb (point)))
7249 (insert-before-markers txt)
7250 (org-reinstall-markers-in-region bbb)
7251 (move-marker ins-point bbb))
7253 (setq ins-end (point))
7254 (goto-char ins-point)
7255 (org-skip-whitespace)
7256 (when (and (< arg 0)
7257 (org-first-sibling-p)
7258 (> ne-ins ne-beg))
7259 ;; Move whitespace back to beginning
7260 (save-excursion
7261 (goto-char ins-end)
7262 (let ((kill-whole-line t))
7263 (kill-line (- ne-ins ne-beg)) (point)))
7265 (move-marker ins-point nil)
7266 (if folded
7267 (hide-subtree)
7268 (org-show-entry)
7269 (show-children)
7270 (org-cycle-hide-drawers 'children))
7271 (org-clean-visibility-after-subtree-move)))
7273 (defvar org-subtree-clip ""
7274 "Clipboard for cut and paste of subtrees.
7275 This is actually only a copy of the kill, because we use the normal kill
7276 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7278 (defvar org-subtree-clip-folded nil
7279 "Was the last copied subtree folded?
7280 This is used to fold the tree back after pasting.")
7282 (defun org-cut-subtree (&optional n)
7283 "Cut the current subtree into the clipboard.
7284 With prefix arg N, cut this many sequential subtrees.
7285 This is a short-hand for marking the subtree and then cutting it."
7286 (interactive "p")
7287 (org-copy-subtree n 'cut))
7289 (defun org-copy-subtree (&optional n cut force-store-markers)
7290 "Cut the current subtree into the clipboard.
7291 With prefix arg N, cut this many sequential subtrees.
7292 This is a short-hand for marking the subtree and then copying it.
7293 If CUT is non-nil, actually cut the subtree.
7294 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7295 of some markers in the region, even if CUT is non-nil. This is
7296 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7297 (interactive "p")
7298 (let (beg end folded (beg0 (point)))
7299 (if (interactive-p)
7300 (org-back-to-heading nil) ; take what looks like a subtree
7301 (org-back-to-heading t)) ; take what is really there
7302 (org-back-over-empty-lines)
7303 (setq beg (point))
7305 (save-match-data
7306 (save-excursion (outline-end-of-heading)
7307 (setq folded (org-invisible-p)))
7308 (condition-case nil
7309 (org-forward-same-level (1- n) t)
7310 (error nil))
7311 (org-end-of-subtree t t))
7312 (org-back-over-empty-lines)
7313 (setq end (point))
7314 (goto-char beg0)
7315 (when (> end beg)
7316 (setq org-subtree-clip-folded folded)
7317 (when (or cut force-store-markers)
7318 (org-save-markers-in-region beg end))
7319 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7320 (setq org-subtree-clip (current-kill 0))
7321 (message "%s: Subtree(s) with %d characters"
7322 (if cut "Cut" "Copied")
7323 (length org-subtree-clip)))))
7325 (defun org-paste-subtree (&optional level tree for-yank)
7326 "Paste the clipboard as a subtree, with modification of headline level.
7327 The entire subtree is promoted or demoted in order to match a new headline
7328 level.
7330 If the cursor is at the beginning of a headline, the same level as
7331 that headline is used to paste the tree
7333 If not, the new level is derived from the *visible* headings
7334 before and after the insertion point, and taken to be the inferior headline
7335 level of the two. So if the previous visible heading is level 3 and the
7336 next is level 4 (or vice versa), level 4 will be used for insertion.
7337 This makes sure that the subtree remains an independent subtree and does
7338 not swallow low level entries.
7340 You can also force a different level, either by using a numeric prefix
7341 argument, or by inserting the heading marker by hand. For example, if the
7344 If optional TREE is given, use this text instead of the kill ring.
7346 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7347 move back over whitespace before inserting, and move point to the end of
7348 the inserted text when done."
7349 (interactive "P")
7350 (setq tree (or tree (and kill-ring (current-kill 0))))
7351 (unless (org-kill-is-subtree-p tree)
7352 (error "%s"
7353 (substitute-command-keys
7355 (let* ((visp (not (org-invisible-p)))
7356 (txt tree)
7361 (old-level (if (string-match ^re txt)
7362 (- (match-end 0) (match-beginning 0) 1)
7363 -1))
7364 (force-level (cond (level (prefix-numeric-value level))
7366 (string-match
7367 ^re_ (buffer-substring
7368 (point-at-bol) (point))))
7369 (- (match-end 1) (match-beginning 1)))
7370 ((and (bolp)
7371 (looking-at org-outline-regexp))
7372 (- (match-end 0) (point) 1))
7373 (t nil)))
7374 (previous-level (save-excursion
7375 (condition-case nil
7376 (progn
7377 (outline-previous-visible-heading 1)
7378 (if (looking-at re)
7379 (- (match-end 0) (match-beginning 0) 1)
7380 1))
7381 (error 1))))
7382 (next-level (save-excursion
7383 (condition-case nil
7384 (progn
7385 (or (looking-at outline-regexp)
7386 (outline-next-visible-heading 1))
7387 (if (looking-at re)
7388 (- (match-end 0) (match-beginning 0) 1)
7389 1))
7390 (error 1))))
7391 (new-level (or force-level (max previous-level next-level)))
7392 (shift (if (or (= old-level -1)
7393 (= new-level -1)
7394 (= old-level new-level))
7395 0
7396 (- new-level old-level)))
7397 (delta (if (> shift 0) -1 1))
7398 (func (if (> shift 0) 'org-demote 'org-promote))
7399 (org-odd-levels-only nil)
7400 beg end newend)
7401 ;; Remove the forced level indicator
7402 (if force-level
7403 (delete-region (point-at-bol) (point)))
7404 ;; Paste
7405 (beginning-of-line 1)
7406 (unless for-yank (org-back-over-empty-lines))
7407 (setq beg (point))
7408 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7409 (insert-before-markers txt)
7411 (setq newend (point))
7412 (org-reinstall-markers-in-region beg)
7413 (setq end (point))
7414 (goto-char beg)
7416 (setq beg (point))
7417 (if (and (org-invisible-p) visp)
7418 (save-excursion (outline-show-heading)))
7419 ;; Shift if necessary
7420 (unless (= shift 0)
7421 (save-restriction
7422 (narrow-to-region beg end)
7423 (while (not (= shift 0))
7424 (org-map-region func (point-min) (point-max))
7425 (setq shift (+ delta shift)))
7426 (goto-char (point-min))
7427 (setq newend (point-max))))
7428 (when (or (interactive-p) for-yank)
7429 (message "Clipboard pasted as level %d subtree" new-level))
7430 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7431 kill-ring
7432 (eq org-subtree-clip (current-kill 0))
7433 org-subtree-clip-folded)
7434 ;; The tree was folded before it was killed/copied
7435 (hide-subtree))
7436 (and for-yank (goto-char newend))))
7438 (defun org-kill-is-subtree-p (&optional txt)
7439 "Check if the current kill is an outline subtree, or a set of trees.
7440 Returns nil if kill does not start with a headline, or if the first
7441 headline level is not the largest headline level in the tree.
7442 So this will actually accept several entries of equal levels as well,
7443 which is OK for `org-paste-subtree'.
7444 If optional TXT is given, check this string instead of the current kill."
7445 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7446 (start-level (and kill
7449 kill)
7450 (- (match-end 2) (match-beginning 2) 1)))
7451 (re (concat "^" org-outline-regexp))
7452 (start (1+ (or (match-beginning 2) -1))))
7453 (if (not start-level)
7454 (progn
7455 nil) ;; does not even start with a heading
7456 (catch 'exit
7457 (while (setq start (string-match re kill (1+ start)))
7458 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7459 (throw 'exit nil)))
7460 t))))
7462 (defvar org-markers-to-move nil
7463 "Markers that should be moved with a cut-and-paste operation.
7464 Those markers are stored together with their positions relative to
7465 the start of the region.")
7467 (defun org-save-markers-in-region (beg end)
7468 "Check markers in region.
7469 If these markers are between BEG and END, record their position relative
7470 to BEG, so that after moving the block of text, we can put the markers back
7471 into place.
7472 This function gets called just before an entry or tree gets cut from the
7473 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7474 called immediately, to move the markers with the entries."
7475 (setq org-markers-to-move nil)
7476 (when (featurep 'org-clock)
7477 (org-clock-save-markers-for-cut-and-paste beg end))
7478 (when (featurep 'org-agenda)
7479 (org-agenda-save-markers-for-cut-and-paste beg end)))
7481 (defun org-check-and-save-marker (marker beg end)
7482 "Check if MARKER is between BEG and END.
7483 If yes, remember the marker and the distance to BEG."
7484 (when (and (marker-buffer marker)
7485 (equal (marker-buffer marker) (current-buffer)))
7486 (if (and (>= marker beg) (< marker end))
7487 (push (cons marker (- marker beg)) org-markers-to-move))))
7489 (defun org-reinstall-markers-in-region (beg)
7490 "Move all remembered markers to their position relative to BEG."
7491 (mapc (lambda (x)
7492 (move-marker (car x) (+ beg (cdr x))))
7493 org-markers-to-move)
7494 (setq org-markers-to-move nil))
7496 (defun org-narrow-to-subtree ()
7497 "Narrow buffer to the current subtree."
7498 (interactive)
7499 (save-excursion
7500 (save-match-data
7501 (narrow-to-region
7502 (progn (org-back-to-heading t) (point))
7503 (progn (org-end-of-subtree t t)
7504 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7505 (point))))))
7507 (eval-when-compile
7508 (defvar org-property-drawer-re))
7510 (defun org-clone-subtree-with-time-shift (n &optional shift)
7511 "Clone the task (subtree) at point N times.
7512 The clones will be inserted as siblings.
7514 In interactive use, the user will be prompted for the number of
7515 clones to be produced, and for a time SHIFT, which may be a
7516 repeater as used in time stamps, for example `+3d'.
7518 When a valid repeater is given and the entry contains any time
7519 stamps, the clones will become a sequence in time, with time
7520 stamps in the subtree shifted for each clone produced. If SHIFT
7521 is nil or the empty string, time stamps will be left alone. The
7522 ID property of the original subtree is removed.
7524 If the original subtree did contain time stamps with a repeater,
7525 the following will happen:
7526 - the repeater will be removed in each clone
7527 - an additional clone will be produced, with the current, unshifted
7528 date(s) in the entry.
7529 - the original entry will be placed *after* all the clones, with
7530 repeater intact.
7531 - the start days in the repeater in the original entry will be shifted
7532 to past the last clone.
7533 I this way you can spell out a number of instances of a repeating task,
7534 and still retain the repeater to cover future instances of the task."
7535 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7536 (let (beg end template task idprop
7537 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7538 (if (not (and (integerp n) (> n 0)))
7539 (error "Invalid number of replications %s" n))
7542 shift)))
7543 (error "Invalid shift specification %s" shift))
7544 (when doshift
7545 (setq shift-n (string-to-number (match-string 1 shift))
7546 shift-what (cdr (assoc (match-string 2 shift)
7547 '(("d" . day) ("w" . week)
7548 ("m" . month) ("y" . year))))))
7549 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7550 (setq nmin 1 nmax n)
7551 (org-back-to-heading t)
7552 (setq beg (point))
7553 (setq idprop (org-entry-get nil "ID"))
7554 (org-end-of-subtree t t)
7556 (setq end (point))
7557 (setq template (buffer-substring beg end))
7558 (when (and doshift
7560 (delete-region beg end)
7561 (setq end beg)
7562 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7563 (goto-char end)
7564 (loop for n from nmin to nmax do
7565 ;; prepare clone
7566 (with-temp-buffer
7567 (insert template)
7568 (org-mode)
7569 (goto-char (point-min))
7570 (and idprop (if org-clone-delete-id
7571 (org-entry-delete nil "ID")
7572 (org-id-get-create t)))
7573 (while (re-search-forward org-property-drawer-re nil t)
7574 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7575 (goto-char (point-min))
7576 (when doshift
7577 (while (re-search-forward org-ts-regexp-both nil t)
7578 (org-timestamp-change (* n shift-n) shift-what))
7579 (unless (= n n-no-remove)
7580 (goto-char (point-min))
7581 (while (re-search-forward org-ts-regexp nil t)
7582 (save-excursion
7583 (goto-char (match-beginning 0))
7585 (delete-region (match-beginning 1) (match-end 1)))))))
7586 (setq task (buffer-string)))
7587 (insert task))
7588 (goto-char beg)))
7590 ;;; Outline Sorting
7592 (defun org-sort (with-case)
7593 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7594 Optional argument WITH-CASE means sort case-sensitively.
7595 With a double prefix argument, also remove duplicate entries."
7596 (interactive "P")
7597 (cond
7598 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7599 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7600 (t
7601 (org-call-with-arg 'org-sort-entries with-case))))
7603 (defun org-sort-remove-invisible (s)
7604 (remove-text-properties 0 (length s) org-rm-props s)
7605 (while (string-match org-bracket-link-regexp s)
7606 (setq s (replace-match (if (match-end 2)
7607 (match-string 3 s)
7608 (match-string 1 s)) t t s)))
7609 s)
7611 (defvar org-priority-regexp) ; defined later in the file
7613 (defvar org-after-sorting-entries-or-items-hook nil
7614 "Hook that is run after a bunch of entries or items have been sorted.
7615 When children are sorted, the cursor is in the parent line when this
7616 hook gets called. When a region or a plain list is sorted, the cursor
7617 will be in the first entry of the sorted region/list.")
7619 (defun org-sort-entries
7620 (&optional with-case sorting-type getkey-func compare-func property)
7621 "Sort entries on a certain level of an outline tree.
7622 If there is an active region, the entries in the region are sorted.
7623 Else, if the cursor is before the first entry, sort the top-level items.
7624 Else, the children of the entry at point are sorted.
7626 Sorting can be alphabetically, numerically, by date/time as given by
7627 a time stamp, by a property or by priority.
7629 The command prompts for the sorting type unless it has been given to the
7630 function through the SORTING-TYPE argument, which needs to be a character,
7631 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7632 precise meaning of each character:
7634 n Numerically, by converting the beginning of the entry/item to a number.
7635 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7636 t By date/time, either the first active time stamp in the entry, or, if
7637 none exist, by the first inactive one.
7638 s By the scheduled date/time.
7639 d By deadline date/time.
7640 c By creation time, which is assumed to be the first inactive time stamp
7641 at the beginning of a line.
7642 p By priority according to the cookie.
7643 r By the value of a property.
7645 Capital letters will reverse the sort order.
7647 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7648 called with point at the beginning of the record. It must return either
7649 a string or a number that should serve as the sorting key for that record.
7651 Comparing entries ignores case by default. However, with an optional argument
7652 WITH-CASE, the sorting considers case as well."
7653 (interactive "P")
7654 (let ((case-func (if with-case 'identity 'downcase))
7655 start beg end stars re re2
7656 txt what tmp)
7657 ;; Find beginning and end of region to sort
7658 (cond
7659 ((org-region-active-p)
7660 ;; we will sort the region
7661 (setq end (region-end)
7662 what "region")
7663 (goto-char (region-beginning))
7664 (if (not (org-on-heading-p)) (outline-next-heading))
7665 (setq start (point)))
7666 ((or (org-on-heading-p)
7667 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7668 ;; we will sort the children of the current headline
7669 (org-back-to-heading)
7670 (setq start (point)
7671 end (progn (org-end-of-subtree t t)
7673 (org-back-over-empty-lines)
7674 (point))
7675 what "children")
7676 (goto-char start)
7677 (show-subtree)
7678 (outline-next-heading))
7679 (t
7680 ;; we will sort the top-level entries in this file
7681 (goto-char (point-min))
7682 (or (org-on-heading-p) (outline-next-heading))
7683 (setq start (point))
7684 (goto-char (point-max))
7685 (beginning-of-line 1)
7687 ;; File ends in a non-white line
7688 (end-of-line 1)
7690 (setq end (point-max))
7691 (setq what "top-level")
7692 (goto-char start)
7693 (show-all)))
7695 (setq beg (point))
7696 (if (>= beg end) (error "Nothing to sort"))
7699 (setq stars (match-string 1)
7700 re (concat "^" (regexp-quote stars) " +")
7701 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7702 txt (buffer-substring beg end))
7704 (if (and (not (equal stars "*")) (string-match re2 txt))
7705 (error "Region to sort contains a level above the first entry"))
7707 (unless sorting-type
7708 (message
7709 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7711 A/N/T/S/D/C/P/O/F means reversed:"
7712 what)
7713 (setq sorting-type (read-char-exclusive))
7715 (and (= (downcase sorting-type) ?f)
7716 (setq getkey-func
7717 (org-icompleting-read "Sort using function: "
7718 obarray 'fboundp t nil nil))
7719 (setq getkey-func (intern getkey-func)))
7721 (and (= (downcase sorting-type) ?r)
7722 (setq property
7723 (org-icompleting-read "Property: "
7724 (mapcar 'list (org-buffer-property-keys t))
7725 nil t))))
7727 (message "Sorting entries...")
7729 (save-restriction
7730 (narrow-to-region start end)
7731 (let ((dcst (downcase sorting-type))
7732 (case-fold-search nil)
7733 (now (current-time)))
7734 (sort-subr
7735 (/= dcst sorting-type)
7736 ;; This function moves to the beginning character of the "record" to
7737 ;; be sorted.
7738 (lambda nil
7739 (if (re-search-forward re nil t)
7740 (goto-char (match-beginning 0))
7741 (goto-char (point-max))))
7742 ;; This function moves to the last character of the "record" being
7743 ;; sorted.
7744 (lambda nil
7745 (save-match-data
7746 (condition-case nil
7747 (outline-forward-same-level 1)
7748 (error
7749 (goto-char (point-max))))))
7750 ;; This function returns the value that gets sorted against.
7751 (lambda nil
7752 (cond
7753 ((= dcst ?n)
7754 (if (looking-at org-complex-heading-regexp)
7755 (string-to-number (match-string 4))
7756 nil))
7757 ((= dcst ?a)
7758 (if (looking-at org-complex-heading-regexp)
7759 (funcall case-func (match-string 4))
7760 nil))
7761 ((= dcst ?t)
7762 (let ((end (save-excursion (outline-next-heading) (point))))
7763 (if (or (re-search-forward org-ts-regexp end t)
7764 (re-search-forward org-ts-regexp-both end t))
7765 (org-time-string-to-seconds (match-string 0))
7766 (org-float-time now))))
7767 ((= dcst ?c)
7768 (let ((end (save-excursion (outline-next-heading) (point))))
7769 (if (re-search-forward
7771 end t)
7772 (org-time-string-to-seconds (match-string 0))
7773 (org-float-time now))))
7774 ((= dcst ?s)
7775 (let ((end (save-excursion (outline-next-heading) (point))))
7776 (if (re-search-forward org-scheduled-time-regexp end t)
7777 (org-time-string-to-seconds (match-string 1))
7778 (org-float-time now))))
7779 ((= dcst ?d)
7780 (let ((end (save-excursion (outline-next-heading) (point))))
7781 (if (re-search-forward org-deadline-time-regexp end t)
7782 (org-time-string-to-seconds (match-string 1))
7783 (org-float-time now))))
7784 ((= dcst ?p)
7785 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7786 (string-to-char (match-string 2))
7787 org-default-priority))
7788 ((= dcst ?r)
7789 (or (org-entry-get nil property) ""))
7790 ((= dcst ?o)
7791 (if (looking-at org-complex-heading-regexp)
7792 (- 9999 (length (member (match-string 2)
7793 org-todo-keywords-1)))))
7794 ((= dcst ?f)
7795 (if getkey-func
7796 (progn
7797 (setq tmp (funcall getkey-func))
7798 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7799 tmp)
7800 (error "Invalid key function `%s'" getkey-func)))
7801 (t (error "Invalid sorting type `%c'" sorting-type))))
7802 nil
7803 (cond
7804 ((= dcst ?a) 'string<)
7805 ((= dcst ?f) compare-func)
7806 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7807 (t nil)))))
7808 (run-hooks 'org-after-sorting-entries-or-items-hook)
7809 (message "Sorting entries...done")))
7811 (defun org-do-sort (table what &optional with-case sorting-type)
7812 "Sort TABLE of WHAT according to SORTING-TYPE.
7813 The user will be prompted for the SORTING-TYPE if the call to this
7814 function does not specify it. WHAT is only for the prompt, to indicate
7815 what is being sorted. The sorting key will be extracted from
7816 the car of the elements of the table.
7817 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7818 (unless sorting-type
7819 (message
7820 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7821 what)
7822 (setq sorting-type (read-char-exclusive)))
7823 (let ((dcst (downcase sorting-type))
7824 extractfun comparefun)
7825 ;; Define the appropriate functions
7826 (cond
7827 ((= dcst ?n)
7828 (setq extractfun 'string-to-number
7829 comparefun (if (= dcst sorting-type) '< '>)))
7830 ((= dcst ?a)
7831 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7832 (lambda(x) (downcase (org-sort-remove-invisible x))))
7833 comparefun (if (= dcst sorting-type)
7834 'string<
7835 (lambda (a b) (and (not (string< a b))
7836 (not (string= a b)))))))
7837 ((= dcst ?t)
7838 (setq extractfun
7839 (lambda (x)
7840 (if (or (string-match org-ts-regexp x)
7841 (string-match org-ts-regexp-both x))
7842 (org-float-time
7843 (org-time-string-to-time (match-string 0 x)))
7844 0))
7845 comparefun (if (= dcst sorting-type) '< '>)))
7846 (t (error "Invalid sorting type `%c'" sorting-type)))
7848 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7849 table)
7850 (lambda (a b) (funcall comparefun (car a) (car b))))))
7853 ;;; The orgstruct minor mode
7855 ;; Define a minor mode which can be used in other modes in order to
7856 ;; integrate the org-mode structure editing commands.
7858 ;; This is really a hack, because the org-mode structure commands use
7859 ;; keys which normally belong to the major mode. Here is how it
7860 ;; works: The minor mode defines all the keys necessary to operate the
7861 ;; structure commands, but wraps the commands into a function which
7862 ;; tests if the cursor is currently at a headline or a plain list
7863 ;; item. If that is the case, the structure command is used,
7864 ;; temporarily setting many Org-mode variables like regular
7865 ;; expressions for filling etc. However, when any of those keys is
7866 ;; used at a different location, function uses `key-binding' to look
7867 ;; up if the key has an associated command in another currently active
7868 ;; keymap (minor modes, major mode, global), and executes that
7869 ;; command. There might be problems if any of the keys is otherwise
7870 ;; used as a prefix key.
7872 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7873 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7874 ;; addresses this by checking explicitly for both bindings.
7876 (defvar orgstruct-mode-map (make-sparse-keymap)
7877 "Keymap for the minor `orgstruct-mode'.")
7879 (defvar org-local-vars nil
7880 "List of local variables, for use by `orgstruct-mode'.")
7882 ;;;###autoload
7883 (define-minor-mode orgstruct-mode
7884 "Toggle the minor mode `orgstruct-mode'.
7885 This mode is for using Org-mode structure commands in other
7886 modes. The following keys behave as if Org-mode were active, if
7887 the cursor is on a headline, or on a plain list item (both as
7888 defined by Org-mode).
7890 M-up Move entry/item up
7891 M-down Move entry/item down
7892 M-left Promote
7893 M-right Demote
7894 M-S-up Move entry/item up
7895 M-S-down Move entry/item down
7896 M-S-left Promote subtree
7897 M-S-right Demote subtree
7898 M-q Fill paragraph and items like in Org-mode
7899 C-c ^ Sort entries
7900 C-c - Cycle list bullet
7901 TAB Cycle item visibility
7902 M-RET Insert new heading/item
7903 S-M-RET Insert new TODO heading / Checkbox item
7904 C-c C-c Set tags / toggle checkbox"
7905 nil " OrgStruct" nil
7906 (org-load-modules-maybe)
7907 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7909 ;;;###autoload
7910 (defun turn-on-orgstruct ()
7911 "Unconditionally turn on `orgstruct-mode'."
7912 (orgstruct-mode 1))
7914 (defun orgstruct++-mode (&optional arg)
7915 "Toggle `orgstruct-mode', the enhanced version of it.
7916 In addition to setting orgstruct-mode, this also exports all indentation
7917 and autofilling variables from org-mode into the buffer. It will also
7918 recognize item context in multiline items.
7919 Note that turning off orgstruct-mode will *not* remove the
7920 indentation/paragraph settings. This can only be done by refreshing the
7922 (interactive "P")
7923 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7924 (if (< arg 1)
7925 (orgstruct-mode -1)
7926 (orgstruct-mode 1)
7927 (let (var val)
7928 (mapc
7929 (lambda (x)
7930 (when (string-match
7932 (symbol-name (car x)))
7933 (setq var (car x) val (nth 1 x))
7934 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7935 org-local-vars)
7936 (org-set-local 'orgstruct-is-++ t))))
7938 (defvar orgstruct-is-++ nil
7939 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7940 (make-variable-buffer-local 'orgstruct-is-++)
7942 ;;;###autoload
7943 (defun turn-on-orgstruct++ ()
7944 "Unconditionally turn on `orgstruct++-mode'."
7945 (orgstruct++-mode 1))
7947 (defun orgstruct-error ()
7948 "Error when there is no default binding for a structure key."
7949 (interactive)
7950 (error "This key has no function outside structure elements"))
7952 (defun orgstruct-setup ()
7953 "Setup orgstruct keymaps."
7954 (let ((nfunc 0)
7955 (bindings
7956 (list
7957 '([(meta up)] org-metaup)
7958 '([(meta down)] org-metadown)
7959 '([(meta left)] org-metaleft)
7960 '([(meta right)] org-metaright)
7961 '([(meta shift up)] org-shiftmetaup)
7962 '([(meta shift down)] org-shiftmetadown)
7963 '([(meta shift left)] org-shiftmetaleft)
7964 '([(meta shift right)] org-shiftmetaright)
7965 '([?\e (up)] org-metaup)
7966 '([?\e (down)] org-metadown)
7967 '([?\e (left)] org-metaleft)
7968 '([?\e (right)] org-metaright)
7969 '([?\e (shift up)] org-shiftmetaup)
7970 '([?\e (shift down)] org-shiftmetadown)
7971 '([?\e (shift left)] org-shiftmetaleft)
7972 '([?\e (shift right)] org-shiftmetaright)
7973 '([(shift up)] org-shiftup)
7974 '([(shift down)] org-shiftdown)
7975 '([(shift left)] org-shiftleft)
7976 '([(shift right)] org-shiftright)
7977 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7978 '("\M-q" fill-paragraph)
7979 '("\C-c^" org-sort)
7980 '("\C-c-" org-cycle-list-bullet)))
7981 elt key fun cmd)
7982 (while (setq elt (pop bindings))
7983 (setq nfunc (1+ nfunc))
7984 (setq key (org-key (car elt))
7985 fun (nth 1 elt)
7986 cmd (orgstruct-make-binding fun nfunc key))
7987 (org-defkey orgstruct-mode-map key cmd))
7989 ;; Special treatment needed for TAB and RET
7990 (org-defkey orgstruct-mode-map [(tab)]
7991 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7992 (org-defkey orgstruct-mode-map "\C-i"
7993 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7995 (org-defkey orgstruct-mode-map "\M-\C-m"
7996 (orgstruct-make-binding 'org-insert-heading 105
7997 "\M-\C-m" [(meta return)]))
7998 (org-defkey orgstruct-mode-map [(meta return)]
7999 (orgstruct-make-binding 'org-insert-heading 106
8000 [(meta return)] "\M-\C-m"))
8002 (org-defkey orgstruct-mode-map [(shift meta return)]
8003 (orgstruct-make-binding 'org-insert-todo-heading 107
8004 [(meta return)] "\M-\C-m"))
8006 (org-defkey orgstruct-mode-map "\e\C-m"
8007 (orgstruct-make-binding 'org-insert-heading 108
8008 "\e\C-m" [?\e (return)]))
8009 (org-defkey orgstruct-mode-map [?\e (return)]
8010 (orgstruct-make-binding 'org-insert-heading 109
8011 [?\e (return)] "\e\C-m"))
8012 (org-defkey orgstruct-mode-map [?\e (shift return)]
8013 (orgstruct-make-binding 'org-insert-todo-heading 110
8014 [?\e (return)] "\e\C-m"))
8016 (unless org-local-vars
8017 (setq org-local-vars (org-get-local-variables)))
8019 t))
8021 (defun orgstruct-make-binding (fun n &rest keys)
8022 "Create a function for binding in the structure minor mode.
8023 FUN is the command to call inside a table. N is used to create a unique
8024 command name. KEYS are keys that should be checked in for a command
8025 to execute outside of tables."
8026 (eval
8027 (list 'defun
8028 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8029 '(arg)
8031 "Outside of structure, run the binding of `"
8032 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8033 "'.")
8034 '(interactive "p")
8035 (list 'if
8036 `(org-context-p 'headline 'item
8037 (and orgstruct-is-++
8038 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8039 'item-body))
8040 (list 'org-run-like-in-org-mode (list 'quote fun))
8041 (list 'let '(orgstruct-mode)
8042 (list 'call-interactively
8043 (append '(or)
8044 (mapcar (lambda (k)
8045 (list 'key-binding k))
8046 keys)
8047 '('orgstruct-error))))))))
8049 (defun org-context-p (&rest contexts)
8050 "Check if local context is any of CONTEXTS.
8051 Possible values in the list of contexts are `table', `headline', and `item'."
8052 (let ((pos (point)))
8053 (goto-char (point-at-bol))
8054 (prog1 (or (and (memq 'table contexts)
8056 (and (memq 'headline contexts)
8058 (looking-at outline-regexp))
8059 (and (memq 'item contexts)
8061 (and (memq 'item-body contexts)
8062 (org-in-item-p)))
8063 (goto-char pos))))
8065 (defun org-get-local-variables ()
8066 "Return a list of all local variables in an org-mode buffer."
8067 (let (varlist)
8068 (with-current-buffer (get-buffer-create "*Org tmp*")
8069 (erase-buffer)
8070 (org-mode)
8071 (setq varlist (buffer-local-variables)))
8072 (kill-buffer "*Org tmp*")
8073 (delq nil
8074 (mapcar
8075 (lambda (x)
8076 (setq x
8077 (if (symbolp x)
8078 (list x)
8079 (list (car x) (list 'quote (cdr x)))))
8080 (if (string-match
8081 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8082 (symbol-name (car x)))
8083 x nil))
8084 varlist))))
8086 ;;;###autoload
8087 (defun org-run-like-in-org-mode (cmd)
8088 "Run a command, pretending that the current buffer is in Org-mode.
8089 This will temporarily bind local variables that are typically bound in
8090 Org-mode to the values they have in Org-mode, and then interactively
8091 call CMD."
8092 (org-load-modules-maybe)
8093 (unless org-local-vars
8094 (setq org-local-vars (org-get-local-variables)))
8095 (eval (list 'let org-local-vars
8096 (list 'call-interactively (list 'quote cmd)))))
8098 ;;;; Archiving
8100 (defun org-get-category (&optional pos)
8101 "Get the category applying to position POS."
8102 (get-text-property (or pos (point)) 'org-category))
8104 (defun org-refresh-category-properties ()
8105 "Refresh category text properties in the buffer."
8106 (let ((def-cat (cond
8107 ((null org-category)
8108 (if buffer-file-name
8109 (file-name-sans-extension
8110 (file-name-nondirectory buffer-file-name))
8111 "???"))
8112 ((symbolp org-category) (symbol-name org-category))
8113 (t org-category)))
8114 beg end cat pos optionp)
8115 (org-unmodified
8116 (save-excursion
8117 (save-restriction
8118 (widen)
8119 (goto-char (point-min))
8120 (put-text-property (point) (point-max) 'org-category def-cat)
8121 (while (re-search-forward
8123 (setq pos (match-end 0)
8124 optionp (equal (char-after (match-beginning 0)) ?#)
8125 cat (org-trim (match-string 2)))
8126 (if optionp
8127 (setq beg (point-at-bol) end (point-max))
8128 (org-back-to-heading t)
8129 (setq beg (point) end (org-end-of-subtree t t)))
8130 (put-text-property beg end 'org-category cat)
8131 (goto-char pos)))))))
8134 ;;;; Link Stuff
8136 ;;; Link abbreviations
8138 (defun org-link-expand-abbrev (link)
8139 "Apply replacements as defined in `org-link-abbrev-alist."
8141 (let* ((key (match-string 1 link))
8142 (as (or (assoc key org-link-abbrev-alist-local)
8143 (assoc key org-link-abbrev-alist)))
8144 (tag (and (match-end 2) (match-string 3 link)))
8145 rpl)
8146 (if (not as)
8147 link
8148 (setq rpl (cdr as))
8149 (cond
8150 ((symbolp rpl) (funcall rpl tag))
8151 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8152 ((string-match "%h" rpl)
8153 (replace-match (url-hexify-string (or tag "")) t t rpl))
8154 (t (concat rpl tag)))))
8155 link))
8157 ;;; Storing and inserting links
8159 (defvar org-insert-link-history nil
8160 "Minibuffer history for links inserted with `org-insert-link'.")
8162 (defvar org-stored-links nil
8163 "Contains the links stored with `org-store-link'.")
8165 (defvar org-store-link-plist nil
8166 "Plist with info about the most recently link created with `org-store-link'.")
8168 (defvar org-link-protocols nil
8169 "Link protocols added to Org-mode using `org-add-link-type'.")
8171 (defvar org-store-link-functions nil
8172 "List of functions that are called to create and store a link.
8173 Each function will be called in turn until one returns a non-nil
8174 value. Each function should check if it is responsible for creating
8175 this link (for example by looking at the major mode).
8176 If not, it must exit and return nil.
8177 If yes, it should return a non-nil value after a calling
8178 `org-store-link-props' with a list of properties and values.
8179 Special properties are:
8183 This is obligatory as well.
8184 :description Optional default description for the second pair
8185 of brackets in an Org-mode link. The user can still change
8186 this when inserting this link into an Org-mode buffer.
8188 In addition to these, any additional properties can be specified
8189 and then used in remember templates.")
8191 (defun org-add-link-type (type &optional follow export)
8192 "Add TYPE to the list of `org-link-types'.
8193 Re-compute all regular expressions depending on `org-link-types'
8195 FOLLOW and EXPORT are two functions.
8197 FOLLOW should take the link path as the single argument and do whatever
8198 is necessary to follow the link, for example find a file or display
8199 a mail message.
8201 EXPORT should format the link path for export to one of the export formats.
8202 It should be a function accepting three arguments:
8205 desc the description of the link, if any, nil if there was no description
8206 format the export format, a symbol like `html' or `latex' or `ascii'..
8208 The function may use the FORMAT information to return different values
8209 depending on the format. The return value will be put literally into
8210 the exported file. If the return value is nil, this means Org should
8211 do what it normally does with links which do not have EXPORT defined.
8213 Org-mode has a built-in default for exporting links. If you are happy with
8214 this default, there is no need to define an export function for the link
8215 type. For a simple example of an export function, see `org-bbdb.el'."
8216 (add-to-list 'org-link-types type t)
8217 (org-make-link-regexps)
8218 (if (assoc type org-link-protocols)
8219 (setcdr (assoc type org-link-protocols) (list follow export))
8220 (push (list type follow export) org-link-protocols)))
8222 (defvar org-agenda-buffer-name)
8224 ;;;###autoload
8225 (defun org-store-link (arg)
8227 This link is added to `org-stored-links' and can later be inserted
8230 For some link types, a prefix arg is interpreted:
8231 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8232 For file links, arg negates `org-context-in-file-links'."
8233 (interactive "P")
8234 (org-load-modules-maybe)
8235 (setq org-store-link-plist nil) ; reset
8236 (let ((outline-regexp (org-get-limited-outline-regexp))
8237 link cpltxt desc description search txt custom-id agenda-link)
8238 (cond
8240 ((run-hook-with-args-until-success 'org-store-link-functions)
8241 (setq link (plist-get org-store-link-plist :link)
8242 desc (or (plist-get org-store-link-plist :description) link)))
8244 ((equal (buffer-name) "*Org Edit Src Example*")
8245 (let (label gc)
8246 (while (or (not label)
8247 (save-excursion
8248 (save-restriction
8249 (widen)
8250 (goto-char (point-min))
8251 (re-search-forward
8252 (regexp-quote (format org-coderef-label-format label))
8253 nil t))))
8254 (when label (message "Label exists already") (sit-for 2))
8255 (setq label (read-string "Code line label: " label)))
8256 (end-of-line 1)
8257 (setq link (format org-coderef-label-format label))
8258 (setq gc (- 79 (length link)))
8259 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8260 (insert link)
8261 (setq link (concat "(" label ")") desc nil)))
8263 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8264 ;; We are in the agenda, link to referenced location
8265 (let ((m (or (get-text-property (point) 'org-hd-marker)
8266 (get-text-property (point) 'org-marker))))
8267 (when m
8268 (org-with-point-at m
8269 (setq agenda-link
8270 (if (interactive-p)
8271 (call-interactively 'org-store-link)
8272 (org-store-link nil)))))))
8274 ((eq major-mode 'calendar-mode)
8275 (let ((cd (calendar-cursor-to-date)))
8276 (setq link
8277 (format-time-string
8278 (car org-time-stamp-formats)
8279 (apply 'encode-time
8280 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8281 nil nil nil))))
8282 (org-store-link-props :type "calendar" :date cd)))
8284 ((eq major-mode 'w3-mode)
8285 (setq cpltxt (if (and (buffer-name)
8286 (not (string-match "Untitled" (buffer-name))))
8287 (buffer-name)
8288 (url-view-url t))
8289 link (org-make-link (url-view-url t)))
8290 (org-store-link-props :type "w3" :url (url-view-url t)))
8292 ((eq major-mode 'w3m-mode)
8293 (setq cpltxt (or w3m-current-title w3m-current-url)
8294 link (org-make-link w3m-current-url))
8295 (org-store-link-props :type "w3m" :url (url-view-url t)))
8297 ((setq search (run-hook-with-args-until-success
8298 'org-create-file-search-functions))
8299 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8300 "::" search))
8301 (setq cpltxt (or description link)))
8303 ((eq major-mode 'image-mode)
8304 (setq cpltxt (concat "file:"
8305 (abbreviate-file-name buffer-file-name))
8306 link (org-make-link cpltxt))
8307 (org-store-link-props :type "image" :file buffer-file-name))
8309 ((eq major-mode 'dired-mode)
8310 ;; link to the file in the current line
8311 (let ((file (dired-get-filename nil t)))
8312 (setq file (if file
8313 (abbreviate-file-name
8314 (expand-file-name (dired-get-filename nil t)))
8315 ;; otherwise, no file so use current directory.
8316 default-directory))
8317 (setq cpltxt (concat "file:" file)
8318 link (org-make-link cpltxt))))
8320 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8321 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8322 (cond
8324 (setq cpltxt
8325 (concat "file:"
8326 (abbreviate-file-name
8327 (buffer-file-name (buffer-base-buffer)))
8328 "::" (match-string 1))
8329 link (org-make-link cpltxt)))
8330 ((and (featurep 'org-id)
8331 (or (eq org-link-to-org-use-id t)
8332 (and (eq org-link-to-org-use-id 'create-if-interactive)
8333 (interactive-p))
8334 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8335 (interactive-p)
8336 (not custom-id))
8337 (and org-link-to-org-use-id
8338 (condition-case nil
8339 (org-entry-get nil "ID")
8340 (error nil)))))
8341 ;; We can make a link using the ID.
8342 (setq link (condition-case nil
8343 (prog1 (org-id-store-link)
8344 (setq desc (plist-get org-store-link-plist
8345 :description)))
8346 (error
8347 ;; probably before first headline, link to file only
8348 (concat "file:"
8349 (abbreviate-file-name
8350 (buffer-file-name (buffer-base-buffer))))))))
8351 (t
8352 ;; Just link to current headline
8353 (setq cpltxt (concat "file:"
8354 (abbreviate-file-name
8355 (buffer-file-name (buffer-base-buffer)))))
8356 ;; Add a context search string
8357 (when (org-xor org-context-in-file-links arg)
8358 (setq txt (cond
8359 ((org-on-heading-p) nil)
8360 ((org-region-active-p)
8361 (buffer-substring (region-beginning) (region-end)))
8362 (t nil)))
8364 (setq cpltxt
8365 (concat cpltxt "::"
8366 (condition-case nil
8367 (org-make-org-heading-search-string txt)
8368 (error "")))
8369 desc (or (nth 4 (ignore-errors
8370 (org-heading-components))) "NONE"))))
8372 (setq cpltxt (substring cpltxt 0 -2)))
8373 (setq link (org-make-link cpltxt)))))
8375 ((buffer-file-name (buffer-base-buffer))
8376 ;; Just link to this file here.
8377 (setq cpltxt (concat "file:"
8378 (abbreviate-file-name
8379 (buffer-file-name (buffer-base-buffer)))))
8380 ;; Add a context string
8381 (when (org-xor org-context-in-file-links arg)
8382 (setq txt (if (org-region-active-p)
8383 (buffer-substring (region-beginning) (region-end))
8384 (buffer-substring (point-at-bol) (point-at-eol))))
8385 ;; Only use search option if there is some text.
8387 (setq cpltxt
8388 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8389 desc "NONE")))
8390 (setq link (org-make-link cpltxt)))
8392 ((interactive-p)
8393 (error "Cannot link to a buffer which is not visiting a file"))
8395 (t (setq link nil)))
8397 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8398 (setq link (or link cpltxt)
8399 desc (or desc cpltxt))
8400 (if (equal desc "NONE") (setq desc nil))
8402 (if (and (or (interactive-p) executing-kbd-macro) link)
8403 (progn
8404 (setq org-stored-links
8405 (cons (list link desc) org-stored-links))
8406 (message "Stored: %s" (or desc link))
8407 (when custom-id
8408 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8409 "::#" custom-id))
8410 (setq org-stored-links
8411 (cons (list link desc) org-stored-links))))
8412 (or agenda-link (and link (org-make-link-string link desc))))))
8414 (defun org-store-link-props (&rest plist)
8415 "Store link properties, extract names and addresses."
8416 (let (x adr)
8417 (when (setq x (plist-get plist :from))
8418 (setq adr (mail-extract-address-components x))
8419 (setq plist (plist-put plist :fromname (car adr)))
8420 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8421 (when (setq x (plist-get plist :to))
8422 (setq adr (mail-extract-address-components x))
8423 (setq plist (plist-put plist :toname (car adr)))
8424 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8425 (let ((from (plist-get plist :from))
8426 (to (plist-get plist :to)))
8427 (when (and from to org-from-is-user-regexp)
8428 (setq plist
8429 (plist-put plist :fromto
8430 (if (string-match org-from-is-user-regexp from)
8431 (concat "to %t")
8432 (concat "from %f"))))))
8433 (setq org-store-link-plist plist))
8435 (defun org-add-link-props (&rest plist)
8436 "Add these properties to the link property list."
8437 (let (key value)
8438 (while plist
8439 (setq key (pop plist) value (pop plist))
8440 (setq org-store-link-plist
8441 (plist-put org-store-link-plist key value)))))
8443 (defun org-email-link-description (&optional fmt)
8444 "Return the description part of an email link.
8445 This takes information from `org-store-link-plist' and formats it
8446 according to FMT (default from `org-email-link-description-format')."
8447 (setq fmt (or fmt org-email-link-description-format))
8448 (let* ((p org-store-link-plist)
8449 (to (plist-get p :toaddress))
8450 (from (plist-get p :fromaddress))
8451 (table
8452 (list
8453 (cons "%c" (plist-get p :fromto))
8454 (cons "%F" (plist-get p :from))
8455 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8456 (cons "%T" (plist-get p :to))
8457 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8458 (cons "%s" (plist-get p :subject))
8459 (cons "%m" (plist-get p :message-id)))))
8460 (when (string-match "%c" fmt)
8461 ;; Check if the user wrote this message
8462 (if (and org-from-is-user-regexp from to
8463 (save-match-data (string-match org-from-is-user-regexp from)))
8464 (setq fmt (replace-match "to %t" t t fmt))
8465 (setq fmt (replace-match "from %f" t t fmt))))
8466 (org-replace-escapes fmt table)))
8468 (defun org-make-org-heading-search-string (&optional string heading)
8469 "Make search string for STRING or current headline."
8470 (interactive)
8471 (let ((s (or string (org-get-heading))))
8472 (unless (and string (not heading))
8473 ;; We are using a headline, clean up garbage in there.
8474 (if (string-match org-todo-regexp s)
8475 (setq s (replace-match "" t t s)))
8477 (setq s (replace-match "" t t s)))
8478 (setq s (org-trim s))
8481 (setq s (replace-match "" t t s)))
8482 (while (string-match org-ts-regexp s)
8483 (setq s (replace-match "" t t s))))
8484 (or string (setq s (concat "*" s))) ; Add * for headlines
8487 (defun org-make-link (&rest strings)
8488 "Concatenate STRINGS."
8489 (apply 'concat strings))
8491 (defun org-make-link-string (link &optional description)
8492 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8494 (error "Empty link"))
8495 (when (and description
8496 (stringp description)
8498 (setq description nil))
8499 (when (stringp description)
8500 ;; Remove brackets from the description, they are fatal.
8502 (setq description (replace-match "{" t t description)))
8504 (setq description (replace-match "}" t t description))))
8505 (when (equal (org-link-escape link) description)
8506 ;; No description needed, it is identical
8507 (setq description nil))
8508 (when (and (not description)
8509 (not (equal link (org-link-escape link))))
8510 (setq description (org-extract-attributes link)))
8511 (setq link (if (string-match org-link-types-re link)
8512 (concat (match-string 1 link)
8513 (org-link-escape (substring link (match-end 1))))
8514 (org-link-escape link)))
8515 (concat "[[" link "]"
8516 (if description (concat "[" description "]") "")
8517 "]"))
8519 (defconst org-link-escape-chars
8520 '((?\ . "%20")
8521 (?\[ . "%5B")
8522 (?\] . "%5D")
8533 (?\; . "%3B")
8534 ;; (?? . "%3F")
8535 (?= . "%3D")
8536 (?+ . "%2B")
8537 )
8538 "Association list of escapes for some characters problematic in links.
8539 This is the list that is used for internal purposes.")
8541 (defvar org-url-encoding-use-url-hexify nil)
8543 (defconst org-link-escape-chars-browser
8544 '((?\ . "%20")) ; 32 for the SPC char
8545 "Association list of escapes for some characters problematic in links.
8546 This is the list that is used before handing over to the browser.")
8548 (defun org-link-escape (text &optional table)
8549 "Escape characters in TEXT that are problematic for links."
8550 (if (and org-url-encoding-use-url-hexify (not table))
8551 (url-hexify-string text)
8552 (setq table (or table org-link-escape-chars))
8553 (when text
8554 (let ((re (mapconcat (lambda (x) (regexp-quote
8555 (char-to-string (car x))))
8557 (while (string-match re text)
8558 (setq text
8559 (replace-match
8560 (cdr (assoc (string-to-char (match-string 0 text))
8561 table))
8562 t t text)))
8563 text))))
8565 (defun org-link-unescape (text &optional table)
8566 "Reverse the action of `org-link-escape'."
8567 (if (and org-url-encoding-use-url-hexify (not table))
8568 (url-unhex-string text)
8569 (setq table (or table org-link-escape-chars))
8570 (when text
8571 (let ((case-fold-search t)
8572 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8574 (while (string-match re text)
8575 (setq text
8576 (replace-match
8577 (char-to-string (car (rassoc (upcase (match-string 0 text))
8578 table)))
8579 t t text)))
8580 text))))
8582 (defun org-xor (a b)
8583 "Exclusive or."
8584 (if a (not b) b))
8586 (defun org-fixup-message-id-for-http (s)
8587 "Replace special characters in a message id, so it can be used in an http query."
8588 (when (string-match "%" s)
8589 (setq s (mapconcat (lambda (c)
8590 (if (eq c ?%)
8591 "%25"
8592 (char-to-string c)))
8593 s "")))
8594 (while (string-match "<" s)
8595 (setq s (replace-match "%3C" t t s)))
8596 (while (string-match ">" s)
8597 (setq s (replace-match "%3E" t t s)))
8598 (while (string-match "@" s)
8599 (setq s (replace-match "%40" t t s)))
8600 s)
8602 ;;;###autoload
8603 (defun org-insert-link-global ()
8604 "Insert a link like Org-mode does.
8605 This command can be called in any mode to insert a link in Org-mode syntax."
8606 (interactive)
8607 (org-load-modules-maybe)
8608 (org-run-like-in-org-mode 'org-insert-link))
8610 (defun org-insert-link (&optional complete-file link-location)
8611 "Insert a link. At the prompt, enter the link.
8613 Completion can be used to insert any of the link protocol prefixes like
8614 http or ftp in use.
8616 The history can be used to select a link previously stored with
8617 `org-store-link'. When the empty string is entered (i.e. if you just
8618 press RET at the prompt), the link defaults to the most recently
8619 stored link. As SPC triggers completion in the minibuffer, you need to
8620 use M-SPC or C-q SPC to force the insertion of a space character.
8622 You will also be prompted for a description, and if one is given, it will
8623 be displayed in the buffer instead of the link.
8625 If there is already a link at point, this command will allow you to edit link
8626 and description parts.
8629 be selected using completion. The path to the file will be relative to the
8630 current directory if the file is in the current directory or a subdirectory.
8631 Otherwise, the link will be the absolute path as completed in the minibuffer
8632 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8633 option `org-link-file-path-type'.
8636 the current directory or below.
8639 `org-keep-stored-link-after-insertion'.
8641 If `org-make-link-description-function' is non-nil, this function will be
8642 called with the link target, and the result will be the default
8643 link description.
8645 If the LINK-LOCATION parameter is non-nil, this value will be
8646 used as the link location instead of reading one interactively."
8647 (interactive "P")
8648 (let* ((wcf (current-window-configuration))
8649 (region (if (org-region-active-p)
8650 (buffer-substring (region-beginning) (region-end))))
8651 (remove (and region (list (region-beginning) (region-end))))
8652 (desc region)
8653 tmphist ; byte-compile incorrectly complains about this
8654 (link link-location)
8655 entry file all-prefixes)
8656 (cond
8657 (link-location) ; specified by arg, just use it.
8658 ((org-in-regexp org-bracket-link-regexp 1)
8659 ;; We do have a link at point, and we are going to edit it.
8660 (setq remove (list (match-beginning 0) (match-end 0)))
8661 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8662 (setq link (read-string "Link: "
8663 (org-link-unescape
8664 (org-match-string-no-properties 1)))))
8665 ((or (org-in-regexp org-angle-link-re)
8666 (org-in-regexp org-plain-link-re))
8667 ;; Convert to bracket link
8668 (setq remove (list (match-beginning 0) (match-end 0))
8669 link (read-string "Link: "
8670 (org-remove-angle-brackets (match-string 0)))))
8671 ((member complete-file '((4) (16)))
8672 ;; Completing read for file names.
8673 (setq link (org-file-complete-link complete-file)))
8674 (t
8675 ;; Read link, with completion for stored links.
8676 (with-output-to-temp-buffer "*Org Links*"
8677 (princ "Insert a link.
8679 (when org-stored-links
8681 (princ (mapconcat
8682 (lambda (x)
8683 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8685 (let ((cw (selected-window)))
8686 (select-window (get-buffer-window "*Org Links*" 'visible))
8687 (setq truncate-lines t)
8688 (unless (pos-visible-in-window-p (point-max))
8689 (org-fit-window-to-buffer))
8690 (and (window-live-p cw) (select-window cw)))
8691 ;; Fake a link history, containing the stored links.
8692 (setq tmphist (append (mapcar 'car org-stored-links)
8693 org-insert-link-history))
8694 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8695 (mapcar 'car org-link-abbrev-alist)
8696 org-link-types))
8697 (unwind-protect
8698 (progn
8699 (setq link
8700 (let ((org-completion-use-ido nil)
8701 (org-completion-use-iswitchb nil))
8702 (org-completing-read
8703 "Link: "
8704 (append
8705 (mapcar (lambda (x) (list (concat x ":")))
8706 all-prefixes)
8707 (mapcar 'car org-stored-links))
8708 nil nil nil
8709 'tmphist
8710 (car (car org-stored-links)))))
8712 (error "No link selected"))
8713 (if (or (member link all-prefixes)
8714 (and (equal ":" (substring link -1))
8715 (member (substring link 0 -1) all-prefixes)
8716 (setq link (substring link 0 -1))))
8717 (setq link (org-link-try-special-completion link))))
8718 (set-window-configuration wcf)
8719 (kill-buffer "*Org Links*"))
8720 (setq entry (assoc link org-stored-links))
8721 (or entry (push link org-insert-link-history))
8722 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8723 (not org-keep-stored-link-after-insertion))
8724 (setq org-stored-links (delq (assoc link org-stored-links)
8725 org-stored-links)))
8726 (setq desc (or desc (nth 1 entry)))))
8728 (if (string-match org-plain-link-re link)
8729 ;; URL-like link, normalize the use of angular brackets.
8730 (setq link (org-make-link (org-remove-angle-brackets link))))
8732 ;; Check if we are linking to the current file with a search option
8733 ;; If yes, simplify the link by using only the search option.
8734 (when (and buffer-file-name
8736 (let* ((path (match-string 1 link))
8737 (case-fold-search nil)
8738 (search (match-string 2 link)))
8739 (save-match-data
8740 (if (equal (file-truename buffer-file-name) (file-truename path))
8741 ;; We are linking to this same file, with a search option
8742 (setq link search)))))
8744 ;; Check if we can/should use a relative path. If yes, simplify the link
8746 (let* ((type (match-string 1 link))
8747 (path (match-string 2 link))
8748 (origpath path)
8749 (case-fold-search nil))
8750 (cond
8751 ((or (eq org-link-file-path-type 'absolute)
8752 (equal complete-file '(16)))
8753 (setq path (abbreviate-file-name (expand-file-name path))))
8754 ((eq org-link-file-path-type 'noabbrev)
8755 (setq path (expand-file-name path)))
8756 ((eq org-link-file-path-type 'relative)
8757 (setq path (file-relative-name path)))
8758 (t
8759 (save-match-data
8760 (if (string-match (concat "^" (regexp-quote
8761 (expand-file-name
8762 (file-name-as-directory
8763 default-directory))))
8764 (expand-file-name path))
8765 ;; We are linking a file with relative path name.
8766 (setq path (substring (expand-file-name path)
8767 (match-end 0)))
8768 (setq path (abbreviate-file-name (expand-file-name path)))))))
8769 (setq link (concat type path))
8770 (if (equal desc origpath)
8771 (setq desc path))))
8773 (if org-make-link-description-function
8774 (setq desc (funcall org-make-link-description-function link desc)))
8776 (setq desc (read-string "Description: " desc))
8778 (if remove (apply 'delete-region remove))
8779 (insert (org-make-link-string link desc))))
8781 (defun org-link-try-special-completion (type)
8782 "If there is completion support for link type TYPE, offer it."
8783 (let ((fun (intern (concat "org-" type "-complete-link"))))
8784 (if (functionp fun)
8785 (funcall fun)
8786 (read-string "Link (no completion support): " (concat type ":")))))
8788 (defun org-file-complete-link (&optional arg)
8789 "Create a file link using completion."
8790 (let (file link)
8791 (setq file (read-file-name "File: "))
8792 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8793 (pwd1 (file-name-as-directory (abbreviate-file-name
8794 (expand-file-name ".")))))
8795 (cond
8796 ((equal arg '(16))
8797 (setq link (org-make-link
8798 "file:"
8799 (abbreviate-file-name (expand-file-name file)))))
8801 (setq link (org-make-link "file:" (match-string 1 file))))
8803 (expand-file-name file))
8804 (setq link (org-make-link
8805 "file:" (match-string 1 (expand-file-name file)))))
8806 (t (setq link (org-make-link "file:" file)))))
8807 link))
8809 (defun org-completing-read (&rest args)
8810 "Completing-read with SPACE being a normal character."
8811 (let ((minibuffer-local-completion-map
8812 (copy-keymap minibuffer-local-completion-map)))
8813 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8814 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8815 (apply 'org-icompleting-read args)))
8817 (defun org-completing-read-no-i (&rest args)
8818 (let (org-completion-use-ido org-completion-use-iswitchb)
8819 (apply 'org-completing-read args)))
8821 (defun org-iswitchb-completing-read (prompt choices &rest args)
8822 "Use iswitch as a completing-read replacement to choose from choices.
8823 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8824 from."
8825 (let* ((iswitchb-use-virtual-buffers nil)
8826 (iswitchb-make-buflist-hook
8827 (lambda ()
8828 (setq iswitchb-temp-buflist choices))))
8829 (iswitchb-read-buffer prompt)))
8831 (defun org-icompleting-read (&rest args)
8832 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8833 (org-without-partial-completion
8834 (if (and org-completion-use-ido
8835 (fboundp 'ido-completing-read)
8836 (boundp 'ido-mode) ido-mode
8837 (listp (second args)))
8838 (let ((ido-enter-matching-directory nil))
8839 (apply 'ido-completing-read (concat (car args))
8840 (if (consp (car (nth 1 args)))
8841 (mapcar (lambda (x) (car x)) (nth 1 args))
8842 (nth 1 args))
8843 (cddr args)))
8844 (if (and org-completion-use-iswitchb
8845 (boundp 'iswitchb-mode) iswitchb-mode
8846 (listp (second args)))
8847 (apply 'org-iswitchb-completing-read (concat (car args))
8848 (if (consp (car (nth 1 args)))
8849 (mapcar (lambda (x) (car x)) (nth 1 args))
8850 (nth 1 args))
8851 (cddr args))
8852 (apply 'completing-read args)))))
8854 (defun org-extract-attributes (s)
8855 "Extract the attributes cookie from a string and set as text property."
8856 (let (a attr (start 0) key value)
8857 (save-match-data
8859 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8861 (setq key (match-string 1 a) value (match-string 2 a)
8862 start (match-end 0)
8863 attr (plist-put attr (intern key) value))))
8864 (org-add-props s nil 'org-attr attr))
8865 s))
8867 (defun org-extract-attributes-from-string (tag)
8868 (let (key value attr)
8870 (setq key (match-string 1 tag) value (match-string 2 tag)
8871 tag (replace-match "" t t tag)
8872 attr (plist-put attr (intern key) value)))
8873 (cons tag attr)))
8875 (defun org-attributes-to-string (plist)
8876 "Format a property list into an HTML attribute list."
8877 (let ((s "") key value)
8878 (while plist
8879 (setq key (pop plist) value (pop plist))
8880 (and value
8882 s))
8884 ;;; Opening/following a link
8886 (defvar org-link-search-failed nil)
8888 (defvar org-open-link-functions nil
8889 "Hook for functions finding a plain text link.
8890 These functions must take a single argument, the link content.
8891 They will be called for links that look like [[link text][description]]
8895 These functions will be called *before* Org attempts to resolve the
8896 link by doing text searches in the current buffer - so if you want a
8898 handle this as a special case.
8900 When the function does handle the link, it must return a non-nil value.
8901 If it decides that it is not responsible for this link, it must return
8902 nil to indicate that that Org-mode can continue with other options
8903 like exact and fuzzy text search.")
8905 (defun org-next-link ()
8906 "Move forward to the next link.
8907 If the link is in hidden text, expose it."
8908 (interactive)
8909 (when (and org-link-search-failed (eq this-command last-command))
8910 (goto-char (point-min))
8911 (message "Link search wrapped back to beginning of buffer"))
8912 (setq org-link-search-failed nil)
8913 (let* ((pos (point))
8914 (ct (org-context))
8915 (a (assoc :link ct)))
8916 (if a (goto-char (nth 2 a)))
8917 (if (re-search-forward org-any-link-re nil t)
8918 (progn
8919 (goto-char (match-beginning 0))
8920 (if (org-invisible-p) (org-show-context)))
8921 (goto-char pos)
8922 (setq org-link-search-failed t)
8923 (error "No further link found"))))
8925 (defun org-previous-link ()
8926 "Move backward to the previous link.
8927 If the link is in hidden text, expose it."
8928 (interactive)
8929 (when (and org-link-search-failed (eq this-command last-command))
8930 (goto-char (point-max))
8931 (message "Link search wrapped back to end of buffer"))
8932 (setq org-link-search-failed nil)
8933 (let* ((pos (point))
8934 (ct (org-context))
8935 (a (assoc :link ct)))
8936 (if a (goto-char (nth 1 a)))
8937 (if (re-search-backward org-any-link-re nil t)
8938 (progn
8939 (goto-char (match-beginning 0))
8940 (if (org-invisible-p) (org-show-context)))
8941 (goto-char pos)
8942 (setq org-link-search-failed t)
8943 (error "No further link found"))))
8945 (defun org-translate-link (s)
8946 "Translate a link string if a translation function has been defined."
8947 (if (and org-link-translation-function
8948 (fboundp org-link-translation-function)
8950 (progn
8951 (setq s (funcall org-link-translation-function
8952 (match-string 1) (match-string 2)))
8953 (concat (car s) ":" (cdr s)))
8954 s))
8956 (defun org-translate-link-from-planner (type path)
8957 "Translate a link from Emacs Planner syntax so that Org can follow it.
8958 This is still an experimental function, your mileage may vary."
8959 (cond
8960 ((member type '("http" "https" "news" "ftp"))
8961 ;; standard Internet links are the same.
8962 nil)
8963 ((and (equal type "irc") (string-match "^//" path))
8964 ;; Planner has two / at the beginning of an irc link, we have 1.
8965 ;; We should have zero, actually....
8966 (setq path (substring path 1)))
8967 ((and (equal type "lisp") (string-match "^/" path))
8968 ;; Planner has a slash, we do not.
8969 (setq type "elisp" path (substring path 1)))
8971 ;; A typical message link. Planner has the id after the final slash,
8972 ;; we separate it with a hash mark
8973 (setq path (concat (match-string 1 path) "#"
8974 (org-remove-angle-brackets (match-string 2 path)))))
8975 )
8976 (cons type path))
8978 (defun org-find-file-at-mouse (ev)
8979 "Open file link or URL at mouse."
8980 (interactive "e")
8981 (mouse-set-point ev)
8982 (org-open-at-point 'in-emacs))
8984 (defun org-open-at-mouse (ev)
8985 "Open file link or URL at mouse."
8986 (interactive "e")
8987 (mouse-set-point ev)
8988 (if (eq major-mode 'org-agenda-mode)
8989 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8990 (org-open-at-point))
8992 (defvar org-window-config-before-follow-link nil
8993 "The window configuration before following a link.
8994 This is saved in case the need arises to restore it.")
8996 (defvar org-open-link-marker (make-marker)
8997 "Marker pointing to the location where `org-open-at-point; was called.")
8999 ;;;###autoload
9000 (defun org-open-at-point-global ()
9001 "Follow a link like Org-mode does.
9002 This command can be called in any mode to follow a link that has
9003 Org-mode syntax."
9004 (interactive)
9005 (org-run-like-in-org-mode 'org-open-at-point))
9007 ;;;###autoload
9008 (defun org-open-link-from-string (s &optional arg reference-buffer)
9009 "Open a link in the string S, as if it was in Org-mode."
9011 (let ((reference-buffer (or reference-buffer (current-buffer))))
9012 (with-temp-buffer
9013 (let ((org-inhibit-startup t))
9014 (org-mode)
9015 (insert s)
9016 (goto-char (point-min))
9017 (when reference-buffer
9018 (setq org-link-abbrev-alist-local
9019 (with-current-buffer reference-buffer
9020 org-link-abbrev-alist-local)))
9021 (org-open-at-point arg reference-buffer)))))
9023 (defvar org-open-at-point-functions nil
9024 "Hook that is run when following a link at point.
9026 Functions in this hook must return t if they identify and follow
9027 a link at point. If they don't find anything interesting at point,
9028 they must return nil.")
9030 (defun org-open-at-point (&optional in-emacs reference-buffer)
9031 "Open link at or after point.
9032 If there is no link at point, this function will search forward up to
9033 the end of the current line.
9034 Normally, files will be opened by an appropriate application. If the
9035 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9036 With a double prefix argument, try to open outside of Emacs, in the
9037 application the system uses for this file type."
9038 (interactive "P")
9039 ;; if in a code block, then open the block's results
9040 (unless (call-interactively #'org-babel-open-src-block-result)
9041 (org-load-modules-maybe)
9042 (move-marker org-open-link-marker (point))
9043 (setq org-window-config-before-follow-link (current-window-configuration))
9044 (org-remove-occur-highlights nil nil t)
9045 (cond
9046 ((and (org-on-heading-p)
9047 (not (org-in-regexp
9052 (not (get-text-property (point) 'org-linked-text)))
9053 (or (org-offer-links-in-entry in-emacs)
9054 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9055 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9056 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9057 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9058 (org-footnote-action))
9059 (t
9060 (let (type path link line search (pos (point)))
9061 (catch 'match
9062 (save-excursion
9064 (when (org-in-regexp org-bracket-link-regexp 1)
9065 (setq link (org-extract-attributes
9066 (org-link-unescape (org-match-string-no-properties 1))))
9068 (setq link (replace-match " " t t link)))
9069 (setq link (org-link-expand-abbrev link))
9070 (cond
9071 ((or (file-name-absolute-p link)
9073 (setq type "file" path link))
9074 ((string-match org-link-re-with-space3 link)
9075 (setq type (match-string 1 link) path (match-string 2 link)))
9076 (t (setq type "thisfile" path link)))
9077 (throw 'match t)))
9079 (when (get-text-property (point) 'org-linked-text)
9080 (setq type "thisfile"
9081 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9082 (1+ (point)) (point))
9083 path (buffer-substring
9084 (previous-single-property-change pos 'org-linked-text)
9085 (next-single-property-change pos 'org-linked-text)))
9086 (throw 'match t))
9088 (save-excursion
9089 (when (or (org-in-regexp org-angle-link-re)
9090 (org-in-regexp org-plain-link-re))
9091 (setq type (match-string 1) path (match-string 2))
9092 (throw 'match t)))
9093 (save-excursion
9095 (setq type "tags"
9096 path (match-string 1))
9097 (while (string-match ":" path)
9098 (setq path (replace-match "+" t t path)))
9099 (throw 'match t)))
9101 (setq type "tree-match"
9102 path (match-string 1))
9103 (throw 'match t)))
9104 (unless path
9105 (error "No link found"))
9107 ;; switch back to reference buffer
9108 ;; needed when if called in a temporary buffer through
9109 ;; org-open-link-from-string
9110 (with-current-buffer (or reference-buffer (current-buffer))
9112 ;; Remove any trailing spaces in path
9114 (setq path (replace-match "" t t path)))
9115 (if (and org-link-translation-function
9116 (fboundp org-link-translation-function))
9117 ;; Check if we need to translate the link
9118 (let ((tmp (funcall org-link-translation-function type path)))
9119 (setq type (car tmp) path (cdr tmp))))
9121 (cond
9123 ((assoc type org-link-protocols)
9124 (funcall (nth 1 (assoc type org-link-protocols)) path))
9126 ((equal type "mailto")
9127 (let ((cmd (car org-link-mailto-program))
9128 (args (cdr org-link-mailto-program)) args1
9129 (address path) (subject "") a)
9131 (setq address (match-string 1 path)
9132 subject (org-link-escape (match-string 2 path))))
9133 (while args
9134 (cond
9135 ((not (stringp (car args))) (push (pop args) args1))
9136 (t (setq a (pop args))
9137 (if (string-match "%a" a)
9138 (setq a (replace-match address t t a)))
9139 (if (string-match "%s" a)
9140 (setq a (replace-match subject t t a)))
9141 (push a args1))))
9142 (apply cmd (nreverse args1))))
9144 ((member type '("http" "https" "ftp" "news"))
9145 (browse-url (concat type ":" (org-link-escape
9146 path org-link-escape-chars-browser))))
9148 ((string= type "doi")
9149 (browse-url (concat "http://dx.doi.org/"
9150 (org-link-escape
9151 path org-link-escape-chars-browser))))
9153 ((member type '("message"))
9154 (browse-url (concat type ":" path)))
9156 ((string= type "tags")
9157 (org-tags-view in-emacs path))
9159 ((string= type "tree-match")
9162 ((string= type "file")
9164 (setq line (string-to-number (match-string 1 path))
9165 path (substring path 0 (match-beginning 0)))
9167 (setq search (match-string 1 path)
9168 path (substring path 0 (match-beginning 0)))))
9169 (if (string-match "[*?{]" (file-name-nondirectory path))
9170 (dired path)
9171 (org-open-file path in-emacs line search)))
9173 ((string= type "shell")
9174 (let ((cmd path))
9175 (if (or (not org-confirm-shell-link-function)
9176 (funcall org-confirm-shell-link-function
9178 (org-add-props cmd nil
9179 'face 'org-warning))))
9180 (progn
9181 (message "Executing %s" cmd)
9182 (shell-command cmd))
9183 (error "Abort"))))
9185 ((string= type "elisp")
9186 (let ((cmd path))
9187 (if (or (not org-confirm-elisp-link-function)
9188 (funcall org-confirm-elisp-link-function
9190 (org-add-props cmd nil
9191 'face 'org-warning))))
9192 (message "%s => %s" cmd
9193 (if (equal (string-to-char cmd) ?\()
9194 (eval (read cmd))
9195 (call-interactively (read cmd))))
9196 (error "Abort"))))
9198 ((and (string= type "thisfile")
9199 (run-hook-with-args-until-success
9200 'org-open-link-functions path)))
9202 ((string= type "thisfile")
9203 (if in-emacs
9204 (switch-to-buffer-other-window
9205 (org-get-buffer-for-internal-link (current-buffer)))
9206 (org-mark-ring-push))
9207 (let ((cmd `(org-link-search
9208 ,path
9209 ,(cond ((equal in-emacs '(4)) 'occur)
9210 ((equal in-emacs '(16)) 'org-occur)
9211 (t nil))
9212 ,pos)))
9213 (condition-case nil (eval cmd)
9214 (error (progn (widen) (eval cmd))))))
9216 (t
9217 (browse-url-at-point)))))))
9218 (move-marker org-open-link-marker nil)
9219 (run-hook-with-args 'org-follow-link-hook)))
9221 (defun org-offer-links-in-entry (&optional nth zero)
9222 "Offer links in the current entry and follow the selected link.
9223 If there is only one link, follow it immediately as well.
9224 If NTH is an integer, immediately pick the NTH link found.
9225 If ZERO is a string, check also this string for a link, and if
9226 there is one, offer it as link number zero."
9230 (cnt ?0)
9231 (in-emacs (if (integerp nth) nil nth))
9232 have-zero end links link c)
9233 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9234 (push (match-string 0 zero) links)
9235 (setq cnt (1- cnt) have-zero t))
9236 (save-excursion
9237 (org-back-to-heading t)
9238 (setq end (save-excursion (outline-next-heading) (point)))
9239 (while (re-search-forward re end t)
9240 (push (match-string 0) links))
9241 (setq links (org-uniquify (reverse links))))
9243 (cond
9244 ((null links)
9245 (message "No links"))
9246 ((equal (length links) 1)
9247 (setq link (list (car links))))
9248 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9249 (setq link (nth (if have-zero nth (1- nth)) links)))
9250 (t ; we have to select a link
9251 (save-excursion
9252 (save-window-excursion
9253 (delete-other-windows)
9254 (with-output-to-temp-buffer "*Select Link*"
9255 (mapc (lambda (l)
9256 (if (not (string-match org-bracket-link-regexp l))
9258 (org-remove-angle-brackets l)))
9259 (if (match-end 3)
9261 (match-string 3 l) (match-string 1 l)))
9263 (match-string 1 l))))))
9264 links))
9265 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9266 (message "Select link to open, RET to open all:")
9267 (setq c (read-char-exclusive))
9268 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9269 (when (equal c ?q) (error "Abort"))
9270 (if (equal c ?\C-m)
9271 (setq link links)
9272 (setq nth (- c ?0))
9273 (if have-zero (setq nth (1+ nth)))
9274 (unless (and (integerp nth) (>= (length links) nth))
9275 (error "Invalid link selection"))
9276 (setq link (list (nth (1- nth) links))))))
9277 (if link
9278 (let ((buf (current-buffer)))
9279 (dolist (l link)
9280 (org-open-link-from-string l in-emacs buf))
9281 t)
9282 nil)))
9284 ;; Add special file links that specify the way of opening
9286 (org-add-link-type "file+sys" 'org-open-file-with-system)
9287 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9288 (defun org-open-file-with-system (path)
9289 "Open file at PATH using the system way of opening it."
9290 (org-open-file path 'system))
9291 (defun org-open-file-with-emacs (path)
9292 "Open file at PATH in Emacs."
9293 (org-open-file path 'emacs))
9294 (defun org-remove-file-link-modifiers ()
9295 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9296 (goto-char (point-min))
9298 (org-if-unprotected
9299 (replace-match "file:" t t))))
9300 (eval-after-load "org-exp"
9301 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9302 'org-remove-file-link-modifiers))
9304 ;;;; Time estimates
9306 (defun org-get-effort (&optional pom)
9307 "Get the effort estimate for the current entry."
9308 (org-entry-get pom org-effort-property))
9310 ;;; File search
9312 (defvar org-create-file-search-functions nil
9313 "List of functions to construct the right search string for a file link.
9314 These functions are called in turn with point at the location to
9315 which the link should point.
9317 A function in the hook should first test if it would like to
9318 handle this file type, for example by checking the `major-mode'
9319 or the file extension. If it decides not to handle this file, it
9320 should just return nil to give other functions a chance. If it
9321 does handle the file, it must return the search string to be used
9322 when following the link. The search string will be part of the
9323 file link, given after a double colon, and `org-open-at-point'
9324 will automatically search for it. If special measures must be
9325 taken to make the search successful, another function should be
9326 added to the companion hook `org-execute-file-search-functions',
9327 which see.
9329 A function in this hook may also use `setq' to set the variable
9330 `description' to provide a suggestion for the descriptive text to
9331 be used for this link when it gets inserted into an Org-mode
9334 (defvar org-execute-file-search-functions nil
9335 "List of functions to execute a file search triggered by a link.
9337 Functions added to this hook must accept a single argument, the
9338 search string that was part of the file link, the part after the
9339 double colon. The function must first check if it would like to
9340 handle this search, for example by checking the `major-mode' or
9341 the file extension. If it decides not to handle this search, it
9342 should just return nil to give other functions a chance. If it
9343 does handle the search, it must return a non-nil value to keep
9344 other functions from trying.
9346 Each function can access the current prefix argument through the
9347 variable `current-prefix-argument'. Note that a single prefix is
9348 used to force opening a link in Emacs, so it may be good to only
9349 use a numeric or double prefix to guide the search function.
9351 In case this is needed, a function in this hook can also restore
9352 the window configuration before `org-open-at-point' was called using:
9354 (set-window-configuration org-window-config-before-follow-link)")
9356 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9357 (defun org-link-search (s &optional type avoid-pos)
9358 "Search for a link search option.
9359 If S is surrounded by forward slashes, it is interpreted as a
9360 regular expression. In org-mode files, this will create an `org-occur'
9361 sparse tree. In ordinary files, `occur' will be used to list matches.
9362 If the current buffer is in `dired-mode', grep will be used to search
9363 in all files. If AVOID-POS is given, ignore matches near that position."
9364 (let ((case-fold-search t)
9368 org-emphasis-alist)
9370 (pos (point))
9371 (pre nil) (post nil)
9372 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9373 (cond
9374 ;; First check if there are any special search functions
9375 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9376 ;; Now try the builtin stuff
9377 ((and (equal (string-to-char s0) ?#)
9378 (> (length s0) 1)
9379 (save-excursion
9380 (goto-char (point-min))
9381 (and
9382 (re-search-forward
9384 (setq type 'dedicated
9385 pos (match-beginning 0))))
9386 ;; There is an exact target for this
9387 (goto-char pos)
9388 (org-back-to-heading t)))
9389 ((save-excursion
9390 (goto-char (point-min))
9391 (and
9392 (re-search-forward
9393 (concat "<<" (regexp-quote s0) ">>") nil t)
9394 (setq type 'dedicated
9395 pos (match-beginning 0))))
9396 ;; There is an exact target for this
9397 (goto-char pos))
9399 (save-excursion
9400 (goto-char (point-min))
9401 (and
9402 (re-search-forward
9403 (concat "[^[]" (regexp-quote
9404 (format org-coderef-label-format
9405 (match-string 1 s0))))
9406 nil t)
9407 (setq type 'dedicated
9408 pos (1+ (match-beginning 0))))))
9409 ;; There is a coderef target for this
9410 (goto-char pos))
9412 ;; A regular expression
9413 (cond
9414 ((org-mode-p)
9415 (org-occur (match-string 1 s)))
9416 ;;((eq major-mode 'dired-mode)
9417 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9418 (t (org-do-occur (match-string 1 s)))))
9419 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9420 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9421 (goto-char (point-min))
9422 (cond
9423 ((let (case-fold-search)
9424 (re-search-forward (format org-complex-heading-regexp-format
9425 (regexp-quote s))
9426 nil t))
9427 ;; OK, found a match
9428 (setq type 'dedicated)
9429 (goto-char (match-beginning 0)))
9430 ((and (not org-link-search-inhibit-query)
9431 (eq org-link-search-must-match-exact-headline 'query-to-create)
9432 (y-or-n-p "No match - create this as a new heading? "))
9433 (goto-char (point-max))
9434 (or (bolp) (newline))
9436 (beginning-of-line 0))
9437 (t
9438 (goto-char pos)
9439 (error "No match"))))
9440 (t
9441 ;; A normal search string
9442 (when (equal (string-to-char s) ?*)
9443 ;; Anchor on headlines, post may include tags.
9446 s (substring s 1)))
9447 (remove-text-properties
9448 0 (length s)
9449 '(face nil mouse-face nil keymap nil fontified nil) s)
9450 ;; Make a series of regular expressions to find a match
9459 re4 (concat "[^a-zA-Z_]" re4_)
9461 re1 (concat pre re2 post)
9462 re3 (concat pre (if pre re4_ re4) post)
9463 re5 (concat pre ".*" re4)
9464 re2 (concat pre re2)
9465 re2a (concat pre (if pre re2a_ re2a))
9466 re4 (concat pre (if pre re4_ re4))
9470 ))
9471 (cond
9472 ((eq type 'org-occur) (org-occur reall))
9473 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9474 (t (goto-char (point-min))
9475 (setq type 'fuzzy)
9476 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9477 (org-search-not-self 1 re1 nil t)
9478 (org-search-not-self 1 re2 nil t)
9479 (org-search-not-self 1 re2a nil t)
9480 (org-search-not-self 1 re3 nil t)
9481 (org-search-not-self 1 re4 nil t)
9482 (org-search-not-self 1 re5 nil t)
9483 )
9484 (goto-char (match-beginning 1))
9485 (goto-char pos)
9486 (error "No match"))))))
9487 (and (org-mode-p) (org-show-context 'link-search))
9488 type))
9490 (defun org-search-not-self (group &rest args)
9491 "Execute `re-search-forward', but only accept matches that do not
9492 enclose the position of `org-open-link-marker'."
9493 (let ((m org-open-link-marker))
9494 (catch 'exit
9495 (while (apply 're-search-forward args)
9496 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9497 (goto-char (match-end group))
9498 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9499 (> (match-beginning 0) (marker-position m))
9500 (< (match-end 0) (marker-position m)))
9501 (save-match-data
9502 (or (not (org-in-regexp
9503 org-bracket-link-analytic-regexp 1))
9504 (not (match-end 4)) ; no description
9505 (and (<= (match-beginning 4) (point))
9506 (>= (match-end 4) (point))))))
9507 (throw 'exit (point))))))))
9509 (defun org-get-buffer-for-internal-link (buffer)
9510 "Return a buffer to be used for displaying the link target of internal links."
9511 (cond
9512 ((not org-display-internal-link-with-indirect-buffer)
9513 buffer)
9514 ((string-match "(Clone)$" (buffer-name buffer))
9515 (message "Buffer is already a clone, not making another one")
9516 ;; we also do not modify visibility in this case
9517 buffer)
9518 (t ; make a new indirect buffer for displaying the link
9519 (let* ((bn (buffer-name buffer))
9520 (ibn (concat bn "(Clone)"))
9521 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9522 (with-current-buffer ib (org-overview))
9523 ib))))
9525 (defun org-do-occur (regexp &optional cleanup)
9526 "Call the Emacs command `occur'.
9527 If CLEANUP is non-nil, remove the printout of the regular expression
9528 in the *Occur* buffer. This is useful if the regex is long and not useful
9529 to read."
9530 (occur regexp)
9531 (when cleanup
9532 (let ((cwin (selected-window)) win beg end)
9533 (when (setq win (get-buffer-window "*Occur*"))
9534 (select-window win))
9535 (goto-char (point-min))
9536 (when (re-search-forward "match[a-z]+" nil t)
9537 (setq beg (match-end 0))
9539 (setq end (1- (match-beginning 0)))))
9540 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9541 (goto-char (point-min))
9542 (select-window cwin))))
9544 ;;; The mark ring for links jumps
9546 (defvar org-mark-ring nil
9547 "Mark ring for positions before jumps in Org-mode.")
9548 (defvar org-mark-ring-last-goto nil
9549 "Last position in the mark ring used to go back.")
9550 ;; Fill and close the ring
9551 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9552 (loop for i from 1 to org-mark-ring-length do
9553 (push (make-marker) org-mark-ring))
9554 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9555 org-mark-ring)
9557 (defun org-mark-ring-push (&optional pos buffer)
9558 "Put the current position or POS into the mark ring and rotate it."
9559 (interactive)
9560 (setq pos (or pos (point)))
9561 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9562 (move-marker (car org-mark-ring)
9563 (or pos (point))
9564 (or buffer (current-buffer)))
9565 (message "%s"
9566 (substitute-command-keys
9569 (defun org-mark-ring-goto (&optional n)
9570 "Jump to the previous position in the mark ring.
9571 With prefix arg N, jump back that many stored positions. When
9572 called several times in succession, walk through the entire ring.
9573 Org-mode commands jumping to a different position in the current file,
9574 or to another Org-mode file, automatically push the old position
9575 onto the ring."
9576 (interactive "p")
9577 (let (p m)
9578 (if (eq last-command this-command)
9579 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9580 (setq p org-mark-ring))
9581 (setq org-mark-ring-last-goto p)
9582 (setq m (car p))
9583 (switch-to-buffer (marker-buffer m))
9584 (goto-char m)
9585 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9587 (defun org-remove-angle-brackets (s)
9588 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9589 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9590 s)
9591 (defun org-add-angle-brackets (s)
9592 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9593 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9594 s)
9595 (defun org-remove-double-quotes (s)
9598 s)
9600 ;;; Following specific links
9602 (defun org-follow-timestamp-link ()
9603 (cond
9604 ((org-at-date-range-p t)
9605 (let ((org-agenda-start-on-weekday)
9606 (t1 (match-string 1))
9607 (t2 (match-string 2)))
9608 (setq t1 (time-to-days (org-time-string-to-time t1))
9609 t2 (time-to-days (org-time-string-to-time t2)))
9610 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9611 ((org-at-timestamp-p t)
9612 (org-agenda-list nil (time-to-days (org-time-string-to-time
9613 (substring (match-string 1) 0 10)))
9614 1))
9615 (t (error "This should not happen"))))
9618 ;;; Following file links
9619 (defvar org-wait nil)
9620 (defun org-open-file (path &optional in-emacs line search)
9621 "Open the file at PATH.
9622 First, this expands any special file name abbreviations. Then the
9623 configuration variable `org-file-apps' is checked if it contains an
9624 entry for this file type, and if yes, the corresponding command is launched.
9626 If no application is found, Emacs simply visits the file.
9628 With optional prefix argument IN-EMACS, Emacs will visit the file.
9630 prefix arg, Org tries to avoid opening in Emacs
9631 and to use an external application to visit the file.
9633 Optional LINE specifies a line to go to, optional SEARCH a string
9634 to search for. If LINE or SEARCH is given, the file will be
9635 opened in Emacs, unless an entry from org-file-apps that makes
9636 use of groups in a regexp matches.
9637 If the file does not exist, an error is thrown."
9638 (let* ((file (if (equal path "")
9639 buffer-file-name
9640 (substitute-in-file-name (expand-file-name path))))
9641 (file-apps (append org-file-apps (org-default-apps)))
9642 (apps (org-remove-if
9643 'org-file-apps-entry-match-against-dlink-p file-apps))
9644 (apps-dlink (org-remove-if-not
9645 'org-file-apps-entry-match-against-dlink-p file-apps))
9646 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9647 (dirp (if remp nil (file-directory-p file)))
9648 (file (if (and dirp org-open-directory-means-index-dot-org)
9649 (concat (file-name-as-directory file) "index.org")
9650 file))
9651 (a-m-a-p (assq 'auto-mode apps))
9652 (dfile (downcase file))
9653 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9654 (link (cond ((and (eq line nil)
9655 (eq search nil))
9656 file)
9657 (line
9658 (concat file "::" (number-to-string line)))
9659 (search
9660 (concat file "::" search))))
9661 (dlink (downcase link))
9662 (old-buffer (current-buffer))
9663 (old-pos (point))
9664 (old-mode major-mode)
9665 ext cmd link-match-data)
9667 (setq ext (match-string 1 dfile))
9669 (setq ext (match-string 1 dfile))))
9670 (cond
9671 ((member in-emacs '((16) system))
9672 (setq cmd (cdr (assoc 'system apps))))
9673 (in-emacs (setq cmd 'emacs))
9674 (t
9675 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9676 (and dirp (cdr (assoc 'directory apps)))
9677 ; first, try matching against apps-dlink
9678 ; if we get a match here, store the match data for later
9679 (let ((match (assoc-default dlink apps-dlink
9680 'string-match)))
9681 (if match
9682 (progn (setq link-match-data (match-data))
9683 match)
9684 (progn (setq in-emacs (or in-emacs line search))
9685 nil))) ; if we have no match in apps-dlink,
9686 ; always open the file in emacs if line or search
9687 ; is given (for backwards compatibility)
9688 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9689 'string-match)
9690 (cdr (assoc ext apps))
9691 (cdr (assoc t apps))))))
9692 (when (eq cmd 'system)
9693 (setq cmd (cdr (assoc 'system apps))))
9694 (when (eq cmd 'default)
9695 (setq cmd (cdr (assoc t apps))))
9696 (when (eq cmd 'mailcap)
9697 (require 'mailcap)
9698 (mailcap-parse-mailcaps)
9699 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9700 (command (mailcap-mime-info mime-type)))
9701 (if (stringp command)
9702 (setq cmd command)
9703 (setq cmd 'emacs))))
9704 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9705 (not (file-exists-p file))
9706 (not org-open-non-existing-files))
9707 (error "No such file: %s" file))
9708 (cond
9710 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9712 (setq cmd (replace-match "%s" t t cmd)))
9713 (while (string-match "%s" cmd)
9714 (setq cmd (replace-match
9715 (save-match-data
9716 (shell-quote-argument
9717 (convert-standard-filename file)))
9718 t t cmd)))
9720 ;; Replace "%1", "%2" etc. in command with group matches from regex
9721 (save-match-data
9722 (let ((match-index 1)
9723 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9724 (set-match-data link-match-data)
9725 (while (<= match-index number-of-groups)
9726 (let ((regex (concat "%" (number-to-string match-index)))
9727 (replace-with (match-string match-index dlink)))
9728 (while (string-match regex cmd)
9729 (setq cmd (replace-match replace-with t t cmd))))
9730 (setq match-index (+ match-index 1)))))
9732 (save-window-excursion
9733 (start-process-shell-command cmd nil cmd)
9734 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9735 ))
9736 ((or (stringp cmd)
9737 (eq cmd 'emacs))
9738 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9739 (widen)
9740 (if line (org-goto-line line)
9741 (if search (org-link-search search))))
9742 ((consp cmd)
9743 (let ((file (convert-standard-filename file)))
9744 (save-match-data
9745 (set-match-data link-match-data)
9746 (eval cmd))))
9747 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9748 (and (org-mode-p) (eq old-mode 'org-mode)
9749 (or (not (equal old-buffer (current-buffer)))
9750 (not (equal old-pos (point))))
9751 (org-mark-ring-push old-pos old-buffer))))
9753 (defun org-file-apps-entry-match-against-dlink-p (entry)
9754 "This function returns non-nil if `entry' uses a regular
9755 expression which should be matched against the whole link by
9756 org-open-file.
9758 It assumes that is the case when the entry uses a regular
9759 expression which has at least one grouping construct and the
9760 action is either a lisp form or a command string containing
9761 '%1', i.e. using at least one subexpression match as a
9762 parameter."
9763 (let ((selector (car entry))
9764 (action (cdr entry)))
9765 (if (stringp selector)
9766 (and (> (regexp-opt-depth selector) 0)
9767 (or (and (stringp action)
9768 (string-match "%[0-9]" action))
9769 (consp action)))
9770 nil)))
9772 (defun org-default-apps ()
9773 "Return the default applications for this operating system."
9774 (cond
9775 ((eq system-type 'darwin)
9776 org-file-apps-defaults-macosx)
9777 ((eq system-type 'windows-nt)
9778 org-file-apps-defaults-windowsnt)
9779 (t org-file-apps-defaults-gnu)))
9781 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9782 "Convert extensions to regular expressions in the cars of LIST.
9783 Also, weed out any non-string entries, because the return value is used
9784 only for regexp matching.
9785 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9786 point to the symbol `emacs', indicating that the file should
9787 be opened in Emacs."
9788 (append
9789 (delq nil
9790 (mapcar (lambda (x)
9791 (if (not (stringp (car x)))
9792 nil
9794 x
9796 list))
9797 (if add-auto-mode
9798 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9800 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9801 (defun org-file-remote-p (file)
9802 "Test whether FILE specifies a location on a remote system.
9803 Return non-nil if the location is indeed remote.
9807 (cond ((fboundp 'file-remote-p)
9808 (file-remote-p file))
9809 ((fboundp 'tramp-handle-file-remote-p)
9810 (tramp-handle-file-remote-p file))
9811 ((and (boundp 'ange-ftp-name-format)
9812 (string-match (car ange-ftp-name-format) file))
9813 t)
9814 (t nil)))
9817 ;;;; Refiling
9819 (defun org-get-org-file ()
9820 "Read a filename, with default directory `org-directory'."
9821 (let ((default (or org-default-notes-file remember-data-file)))
9822 (read-file-name (format "File name [%s]: " default)
9823 (file-name-as-directory org-directory)
9824 default)))
9826 (defun org-notes-order-reversed-p ()
9827 "Check if the current file should receive notes in reversed order."
9828 (cond
9829 ((not org-reverse-note-order) nil)
9830 ((eq t org-reverse-note-order) t)
9831 ((not (listp org-reverse-note-order)) nil)
9832 (t (catch 'exit
9833 (let ((all org-reverse-note-order)
9834 entry)
9835 (while (setq entry (pop all))
9836 (if (string-match (car entry) buffer-file-name)
9837 (throw 'exit (cdr entry))))
9838 nil)))))
9840 (defvar org-refile-target-table nil
9841 "The list of refile targets, created by `org-refile'.")
9843 (defvar org-agenda-new-buffers nil
9844 "Buffers created to visit agenda files.")
9846 (defvar org-refile-cache nil
9847 "Cache for refile targets.")
9850 (defvar org-refile-markers nil
9851 "All the markers used for caching refile locations.")
9853 (defun org-refile-marker (pos)
9854 "Get a new refile marker, but only if caching is in use."
9855 (if (not org-refile-use-cache)
9856 pos
9857 (let ((m (make-marker)))
9858 (move-marker m pos)
9859 (push m org-refile-markers)
9860 m)))
9862 (defun org-refile-cache-clear ()
9863 "Clear the refile cache and disable all the markers."
9864 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9865 (setq org-refile-markers nil)
9866 (setq org-refile-cache nil)
9867 (message "Refile cache has been cleared"))
9869 (defun org-refile-cache-check-set (set)
9870 "Check if all the markers in the cache still have live buffers."
9871 (let (marker)
9872 (catch 'exit
9873 (while (and set (setq marker (nth 3 (pop set))))
9874 ;; if org-refile-use-outline-path is 'file, marker may be nil
9875 (when (and marker (null (marker-buffer marker)))
9876 (message "not found") (sit-for 3)
9877 (throw 'exit nil)))
9878 t)))
9880 (defun org-refile-cache-put (set &rest identifiers)
9881 "Push the refile targets SET into the cache, under IDENTIFIERS."
9882 (let* ((key (sha1 (prin1-to-string identifiers)))
9883 (entry (assoc key org-refile-cache)))
9884 (if entry
9885 (setcdr entry set)
9886 (push (cons key set) org-refile-cache))))
9888 (defun org-refile-cache-get (&rest identifiers)
9889 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9890 (cond
9891 ((not org-refile-cache) nil)
9892 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9893 (t
9894 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9895 org-refile-cache))))
9896 (and set (org-refile-cache-check-set set) set)))))
9898 (defun org-get-refile-targets (&optional default-buffer)
9899 "Produce a table with refile targets."
9900 (let ((case-fold-search nil)
9901 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9902 (entries (or org-refile-targets '((nil . (:level . 1)))))
9903 targets tgs txt re files f desc descre fast-path-p level pos0)
9904 (message "Getting targets...")
9905 (with-current-buffer (or default-buffer (current-buffer))
9906 (while (setq entry (pop entries))
9907 (setq files (car entry) desc (cdr entry))
9908 (setq fast-path-p nil)
9909 (cond
9910 ((null files) (setq files (list (current-buffer))))
9911 ((eq files 'org-agenda-files)
9912 (setq files (org-agenda-files 'unrestricted)))
9913 ((and (symbolp files) (fboundp files))
9914 (setq files (funcall files)))
9915 ((and (symbolp files) (boundp files))
9916 (setq files (symbol-value files))))
9917 (if (stringp files) (setq files (list files)))
9918 (cond
9919 ((eq (car desc) :tag)
9921 ((eq (car desc) :todo)
9923 ((eq (car desc) :regexp)
9924 (setq descre (cdr desc)))
9925 ((eq (car desc) :level)
9927 (if org-odd-levels-only
9928 (1- (* 2 (cdr desc)))
9929 (cdr desc)))
9931 ((eq (car desc) :maxlevel)
9932 (setq fast-path-p t)
9934 (if org-odd-levels-only
9935 (1- (* 2 (cdr desc)))
9936 (cdr desc)))
9938 (t (error "Bad refiling target description %s" desc)))
9939 (while (setq f (pop files))
9940 (with-current-buffer
9941 (if (bufferp f) f (org-get-agenda-file-buffer f))
9942 (or
9943 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9944 (progn
9945 (if (bufferp f) (setq f (buffer-file-name
9946 (buffer-base-buffer f))))
9947 (setq f (and f (expand-file-name f)))
9948 (if (eq org-refile-use-outline-path 'file)
9949 (push (list (file-name-nondirectory f) f nil nil) tgs))
9950 (save-excursion
9951 (save-restriction
9952 (widen)
9953 (goto-char (point-min))
9954 (while (re-search-forward descre nil t)
9955 (goto-char (setq pos0 (point-at-bol)))
9956 (catch 'next
9957 (when org-refile-target-verify-function
9958 (save-match-data
9959 (or (funcall org-refile-target-verify-function)
9960 (throw 'next t))))
9961 (when (looking-at org-complex-heading-regexp)
9962 (setq level (org-reduced-level
9963 (- (match-end 1) (match-beginning 1)))
9964 txt (org-link-display-format (match-string 4))
9966 re (format org-complex-heading-regexp-format
9967 (regexp-quote (match-string 4))))
9968 (when org-refile-use-outline-path
9969 (setq txt (mapconcat
9970 'org-protect-slash
9971 (append
9972 (if (eq org-refile-use-outline-path
9973 'file)
9974 (list (file-name-nondirectory
9975 (buffer-file-name
9976 (buffer-base-buffer))))
9977 (if (eq org-refile-use-outline-path
9978 'full-file-path)
9979 (list (buffer-file-name
9980 (buffer-base-buffer)))))
9981 (org-get-outline-path fast-path-p
9982 level txt)
9983 (list txt))
9984 "/")))
9985 (push (list txt f re (org-refile-marker (point)))
9986 tgs)))
9987 (when (= (point) pos0)
9988 ;; verification function has not moved point
9989 (goto-char (point-at-eol))))))))
9990 (when org-refile-use-cache
9991 (org-refile-cache-put tgs (buffer-file-name) descre))
9992 (setq targets (append tgs targets))
9993 ))))
9994 (message "Getting targets...done")
9995 (nreverse targets)))
9997 (defun org-protect-slash (s)
9998 (while (string-match "/" s)
10000 s)
10002 (defvar org-olpa (make-vector 20 nil))
10004 (defun org-get-outline-path (&optional fastp level heading)
10005 "Return the outline path to the current entry, as a list.
10007 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10008 routine which makes outline path derivations for an entire file,
10009 avoiding backtracing. Refile target collection makes use of that."
10010 (if fastp
10011 (progn
10012 (if (> level 19)
10013 (error "Outline path failure, more than 19 levels"))
10014 (loop for i from level upto 19 do
10015 (aset org-olpa i nil))
10016 (prog1
10017 (delq nil (append org-olpa nil))
10018 (aset org-olpa level heading)))
10019 (let (rtn case-fold-search)
10020 (save-excursion
10021 (save-restriction
10022 (widen)
10023 (while (org-up-heading-safe)
10024 (when (looking-at org-complex-heading-regexp)
10025 (push (org-match-string-no-properties 4) rtn)))
10026 rtn)))))
10028 (defun org-format-outline-path (path &optional width prefix)
10029 "Format the outline path PATH for display.
10030 Width is the maximum number of characters that is available.
10031 Prefix is a prefix to be included in the returned string,
10032 such as the file name."
10033 (setq width (or width 79))
10034 (if prefix (setq width (- width (length prefix))))
10035 (if (not path)
10036 (or prefix "")
10037 (let* ((nsteps (length path))
10038 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10039 (maxwidth (if (<= total-width width)
10040 10000 ;; everything fits
10041 ;; we need to shorten the level headings
10042 (/ (- width nsteps) nsteps)))
10043 (org-odd-levels-only nil)
10044 (n 0)
10045 (total (1+ (length prefix))))
10046 (setq maxwidth (max maxwidth 10))
10047 (concat prefix
10048 (mapconcat
10049 (lambda (h)
10050 (setq n (1+ n))
10051 (if (and (= n nsteps) (< maxwidth 10000))
10052 (setq maxwidth (- total-width total)))
10053 (if (< (length h) maxwidth)
10054 (progn (setq total (+ total (length h) 1)) h)
10055 (setq h (substring h 0 (- maxwidth 2))
10056 total (+ total maxwidth 1))
10058 (setq h (substring h 0 (match-beginning 0))))
10059 (setq h (concat h "..")))
10060 (org-add-props h nil 'face
10061 (nth (% (1- n) org-n-level-faces)
10062 org-level-faces))
10063 h)
10064 path "/")))))
10066 (defun org-display-outline-path (&optional file current)
10067 "Display the current outline path in the echo area."
10068 (interactive "P")
10069 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10070 (case-fold-search nil)
10071 (path (and (org-mode-p) (org-get-outline-path))))
10072 (if current (setq path (append path
10073 (save-excursion
10074 (org-back-to-heading t)
10075 (if (looking-at org-complex-heading-regexp)
10076 (list (match-string 4)))))))
10077 (message "%s"
10078 (org-format-outline-path
10079 path
10080 (1- (frame-width))
10081 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10083 (defvar org-refile-history nil
10084 "History for refiling operations.")
10086 (defvar org-after-refile-insert-hook nil
10087 "Hook run after `org-refile' has inserted its stuff at the new location.
10088 Note that this is still *before* the stuff will be removed from
10089 the *old* location.")
10091 (defvar org-capture-last-stored-marker)
10092 (defun org-refile (&optional goto default-buffer rfloc)
10093 "Move the entry at point to another heading.
10094 The list of target headings is compiled using the information in
10095 `org-refile-targets', which see. This list is created before each use
10096 and will therefore always be up-to-date.
10098 At the target location, the entry is filed as a subitem of the target heading.
10099 Depending on `org-reverse-note-order', the new subitem will either be the
10100 first or the last subitem.
10102 If there is an active region, all entries in that region will be moved.
10103 However, the region must fulfill the requirement that the first heading
10104 is the first one sets the top-level of the moved text - at most siblings
10105 below it are allowed.
10107 With prefix arg GOTO, the command will only visit the target location,
10108 not actually move anything.
10110 go to the location where the last refiling
10111 operation has put the subtree.
10112 With a prefix argument of `2', refile to the running clock.
10114 RFLOC can be a refile location obtained in a different way.
10116 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10118 If you are using target caching (see `org-refile-use-cache'),
10119 You have to clear the target cache in order to find new targets.
10120 This can be done with a 0 prefix: `C-0 C-c C-w'"
10121 (interactive "P")
10122 (if (member goto '(0 (64)))
10123 (org-refile-cache-clear)
10124 (let* ((cbuf (current-buffer))
10125 (regionp (org-region-active-p))
10126 (region-start (and regionp (region-beginning)))
10127 (region-end (and regionp (region-end)))
10128 (region-length (and regionp (- region-end region-start)))
10129 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10130 pos it nbuf file re level reversed)
10131 (setq last-command nil)
10132 (when regionp
10133 (goto-char region-start)
10134 (or (bolp) (goto-char (point-at-bol)))
10135 (setq region-start (point))
10136 (unless (org-kill-is-subtree-p
10137 (buffer-substring region-start region-end))
10138 (error "The region is not a (sequence of) subtree(s)")))
10139 (if (equal goto '(16))
10140 (org-refile-goto-last-stored)
10141 (when (or
10142 (and (equal goto 2)
10143 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10144 (prog1
10145 (setq it (list (or org-clock-heading "running clock")
10146 (buffer-file-name
10147 (marker-buffer org-clock-hd-marker))
10148 ""
10149 (marker-position org-clock-hd-marker)))
10150 (setq goto nil)))
10151 (setq it (or rfloc
10152 (save-excursion
10153 (org-refile-get-location
10154 (if goto "Goto: " "Refile to: ") default-buffer
10155 org-refile-allow-creating-parent-nodes)))))
10156 (setq file (nth 1 it)
10157 re (nth 2 it)
10158 pos (nth 3 it))
10159 (if (and (not goto)
10160 pos
10161 (equal (buffer-file-name) file)
10162 (if regionp
10163 (and (>= pos region-start)
10164 (<= pos region-end))
10165 (and (>= pos (point))
10166 (< pos (save-excursion
10167 (org-end-of-subtree t t))))))
10168 (error "Cannot refile to position inside the tree or region"))
10170 (setq nbuf (or (find-buffer-visiting file)
10171 (find-file-noselect file)))
10172 (if goto
10173 (progn
10174 (switch-to-buffer nbuf)
10175 (goto-char pos)
10176 (org-show-context 'org-goto))
10177 (if regionp
10178 (progn
10179 (org-kill-new (buffer-substring region-start region-end))
10180 (org-save-markers-in-region region-start region-end))
10181 (org-copy-subtree 1 nil t))
10182 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10183 (find-file-noselect file)))
10184 (setq reversed (org-notes-order-reversed-p))
10185 (save-excursion
10186 (save-restriction
10187 (widen)
10188 (if pos
10189 (progn
10190 (goto-char pos)
10191 (looking-at outline-regexp)
10192 (setq level (org-get-valid-level (funcall outline-level) 1))
10193 (goto-char
10194 (if reversed
10195 (or (outline-next-heading) (point-max))
10196 (or (save-excursion (org-get-next-sibling))
10197 (org-end-of-subtree t t)
10198 (point-max)))))
10199 (setq level 1)
10200 (if (not reversed)
10201 (goto-char (point-max))
10202 (goto-char (point-min))
10203 (or (outline-next-heading) (goto-char (point-max)))))
10204 (if (not (bolp)) (newline))
10205 (org-paste-subtree level)
10206 (when org-log-refile
10207 (org-add-log-setup 'refile nil nil 'findpos
10208 org-log-refile)
10209 (unless (eq org-log-refile 'note)
10210 (save-excursion (org-add-log-note))))
10211 (and org-auto-align-tags (org-set-tags nil t))
10212 (bookmark-set "org-refile-last-stored")
10213 ;; If we are refiling for capture, make sure that the
10214 ;; last-capture pointers point here
10215 (when (org-bound-and-true-p org-refile-for-capture)
10216 (bookmark-set "org-capture-last-stored-marker")
10217 (move-marker org-capture-last-stored-marker (point)))
10218 (if (fboundp 'deactivate-mark) (deactivate-mark))
10219 (run-hooks 'org-after-refile-insert-hook))))
10220 (if regionp
10221 (delete-region (point) (+ (point) region-length))
10222 (org-cut-subtree))
10223 (when (featurep 'org-inlinetask)
10224 (org-inlinetask-remove-END-maybe))
10225 (setq org-markers-to-move nil)
10228 (defun org-refile-goto-last-stored ()
10229 "Go to the location where the last refile was stored."
10230 (interactive)
10231 (bookmark-jump "org-refile-last-stored")
10232 (message "This is the location of the last refile"))
10234 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10235 "Prompt the user for a refile location, using PROMPT."
10236 (let ((org-refile-targets org-refile-targets)
10237 (org-refile-use-outline-path org-refile-use-outline-path))
10238 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10239 (unless org-refile-target-table
10240 (error "No refile targets"))
10241 (let* ((cbuf (current-buffer))
10242 (partial-completion-mode nil)
10243 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10244 (cfunc (if (and org-refile-use-outline-path
10245 org-outline-path-complete-in-steps)
10246 'org-olpath-completing-read
10247 'org-icompleting-read))
10248 (extra (if org-refile-use-outline-path "/" ""))
10249 (filename (and cfn (expand-file-name cfn)))
10250 (tbl (mapcar
10251 (lambda (x)
10252 (if (and (not (member org-refile-use-outline-path
10253 '(file full-file-path)))
10254 (not (equal filename (nth 1 x))))
10255 (cons (concat (car x) extra " ("
10256 (file-name-nondirectory (nth 1 x)) ")")
10257 (cdr x))
10258 (cons (concat (car x) extra) (cdr x))))
10259 org-refile-target-table))
10260 (completion-ignore-case t)
10261 pa answ parent-target child parent old-hist)
10262 (setq old-hist org-refile-history)
10263 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10264 nil 'org-refile-history))
10265 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10266 (org-refile-check-position pa)
10267 (if pa
10268 (progn
10269 (when (or (not org-refile-history)
10270 (not (eq old-hist org-refile-history))
10271 (not (equal (car pa) (car org-refile-history))))
10272 (setq org-refile-history
10273 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10274 org-refile-history
10275 (cdr org-refile-history))))
10276 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10277 (pop org-refile-history)))
10278 pa)
10280 (progn
10281 (setq parent (match-string 1 answ)
10282 child (match-string 2 answ))
10283 (setq parent-target (or (assoc parent tbl)
10284 (assoc (concat parent "/") tbl)))
10285 (when (and parent-target
10286 (or (eq new-nodes t)
10287 (and (eq new-nodes 'confirm)
10289 child)))))
10290 (org-refile-new-child parent-target child)))
10291 (error "Invalid target location")))))
10293 (defun org-refile-check-position (refile-pointer)
10294 "Check if the refile pointer matches the readline to which it points."
10295 (let* ((file (nth 1 refile-pointer))
10296 (re (nth 2 refile-pointer))
10297 (pos (nth 3 refile-pointer))
10298 buffer)
10299 (when (org-string-nw-p re)
10300 (setq buffer (if (markerp pos)
10301 (marker-buffer pos)
10302 (or (find-buffer-visiting file)
10303 (find-file-noselect file))))
10304 (with-current-buffer buffer
10305 (save-excursion
10306 (save-restriction
10307 (widen)
10308 (goto-char pos)
10309 (beginning-of-line 1)
10310 (unless (org-looking-at-p re)
10311 (error "Invalid refile position, please rebuild the cache"))))))))
10313 (defun org-refile-new-child (parent-target child)
10314 "Use refile target PARENT-TARGET to add new CHILD below it."
10315 (unless parent-target
10316 (error "Cannot find parent for new node"))
10317 (let ((file (nth 1 parent-target))
10318 (pos (nth 3 parent-target))
10319 level)
10320 (with-current-buffer (or (find-buffer-visiting file)
10321 (find-file-noselect file))
10322 (save-excursion
10323 (save-restriction
10324 (widen)
10325 (if pos
10326 (goto-char pos)
10327 (goto-char (point-max))
10328 (if (not (bolp)) (newline)))
10329 (when (looking-at outline-regexp)
10330 (setq level (funcall outline-level))
10331 (org-end-of-subtree t t))
10332 (org-back-over-empty-lines)
10334 (if pos (org-get-valid-level level 1) 1) ?*)
10336 (beginning-of-line 0)
10337 (list (concat (car parent-target) "/" child) file "" (point)))))))
10339 (defun org-olpath-completing-read (prompt collection &rest args)
10340 "Read an outline path like a file name."
10341 (let ((thetable collection)
10342 (org-completion-use-ido nil) ; does not work with ido.
10343 (org-completion-use-iswitchb nil)) ; or iswitchb
10344 (apply
10345 'org-icompleting-read prompt
10346 (lambda (string predicate &optional flag)
10347 (let (rtn r f (l (length string)))
10348 (cond
10349 ((eq flag nil)
10350 ;; try completion
10351 (try-completion string thetable))
10352 ((eq flag t)
10353 ;; all-completions
10354 (setq rtn (all-completions string thetable predicate))
10355 (mapcar
10356 (lambda (x)
10357 (setq r (substring x l))
10358 (if (string-match " ([^)]*)$" x)
10359 (setq f (match-string 0 x))
10360 (setq f ""))
10361 (if (string-match "/" r)
10362 (concat string (substring r 0 (match-end 0)) f)
10363 x))
10364 rtn))
10365 ((eq flag 'lambda)
10366 ;; exact match?
10367 (assoc string thetable)))
10368 ))
10369 args)))
10371 ;;;; Dynamic blocks
10373 (defun org-find-dblock (name)
10374 "Find the first dynamic block with name NAME in the buffer.
10375 If not found, stay at current position and return nil."
10376 (let (pos)
10377 (save-excursion
10378 (goto-char (point-min))
10380 nil t)
10381 (match-beginning 0))))
10382 (if pos (goto-char pos))
10383 pos))
10385 (defconst org-dblock-start-re
10387 "Matches the start line of a dynamic block, with parameters.")
10390 "Matches the end of a dynamic block.")
10392 (defun org-create-dblock (plist)
10393 "Create a dynamic block section, with parameters taken from PLIST.
10394 PLIST must contain a :name entry which is used as name of the block."
10396 (end-of-line 1)
10397 (newline))
10398 (let ((col (current-column))
10399 (name (plist-get plist :name)))
10400 (insert "#+BEGIN: " name)
10401 (while plist
10402 (if (eq (car plist) :name)
10403 (setq plist (cddr plist))
10404 (insert " " (prin1-to-string (pop plist)))))
10406 (beginning-of-line -2)))
10408 (defun org-prepare-dblock ()
10409 "Prepare dynamic block for refresh.
10410 This empties the block, puts the cursor at the insert position and returns
10411 the property list including an extra property :name with the block name."
10412 (unless (looking-at org-dblock-start-re)
10413 (error "Not at a dynamic block"))
10414 (let* ((begdel (1+ (match-end 0)))
10415 (name (org-no-properties (match-string 1)))
10416 (params (append (list :name name)
10417 (read (concat "(" (match-string 3) ")")))))
10418 (save-excursion
10419 (beginning-of-line 1)
10421 (setq params (plist-put params :indentation-column (current-column))))
10422 (unless (re-search-forward org-dblock-end-re nil t)
10423 (error "Dynamic block not terminated"))
10424 (setq params
10425 (append params
10426 (list :content (buffer-substring
10427 begdel (match-beginning 0)))))
10428 (delete-region begdel (match-beginning 0))
10429 (goto-char begdel)
10430 (open-line 1)
10431 params))
10433 (defun org-map-dblocks (&optional command)
10434 "Apply COMMAND to all dynamic blocks in the current buffer.
10435 If COMMAND is not given, use `org-update-dblock'."
10436 (let ((cmd (or command 'org-update-dblock)))
10437 (save-excursion
10438 (goto-char (point-min))
10439 (while (re-search-forward org-dblock-start-re nil t)
10440 (goto-char (match-beginning 0))
10441 (save-excursion
10442 (condition-case nil
10443 (funcall cmd)
10444 (error (message "Error during update of dynamic block"))))
10445 (unless (re-search-forward org-dblock-end-re nil t)
10446 (error "Dynamic block not terminated"))))))
10448 (defun org-dblock-update (&optional arg)
10449 "User command for updating dynamic blocks.
10450 Update the dynamic block at point. With prefix ARG, update all dynamic
10451 blocks in the buffer."
10452 (interactive "P")
10453 (if arg
10454 (org-update-all-dblocks)
10455 (or (looking-at org-dblock-start-re)
10456 (org-beginning-of-dblock))
10457 (org-update-dblock)))
10459 (defun org-update-dblock ()
10460 "Update the dynamic block at point.
10461 This means to empty the block, parse for parameters and then call
10462 the correct writing function."
10463 (save-window-excursion
10464 (let* ((pos (point))
10465 (line (org-current-line))
10466 (params (org-prepare-dblock))
10467 (name (plist-get params :name))
10468 (indent (plist-get params :indentation-column))
10469 (cmd (intern (concat "org-dblock-write:" name))))
10470 (message "Updating dynamic block `%s' at line %d..." name line)
10471 (funcall cmd params)
10472 (message "Updating dynamic block `%s' at line %d...done" name line)
10473 (goto-char pos)
10474 (when (and indent (> indent 0))
10475 (setq indent (make-string indent ?\ ))
10476 (save-excursion
10477 (org-beginning-of-dblock)
10478 (forward-line 1)
10479 (while (not (looking-at org-dblock-end-re))
10480 (insert indent)
10481 (beginning-of-line 2))
10482 (when (looking-at org-dblock-end-re)
10484 (replace-match ""))
10485 (insert indent)))))))
10487 (defun org-beginning-of-dblock ()
10488 "Find the beginning of the dynamic block at point.
10489 Error if there is no such block at point."
10490 (let ((pos (point))
10491 beg)
10492 (end-of-line 1)
10493 (if (and (re-search-backward org-dblock-start-re nil t)
10494 (setq beg (match-beginning 0))
10495 (re-search-forward org-dblock-end-re nil t)
10496 (> (match-end 0) pos))
10497 (goto-char beg)
10498 (goto-char pos)
10499 (error "Not in a dynamic block"))))
10501 (defun org-update-all-dblocks ()
10502 "Update all dynamic blocks in the buffer.
10503 This function can be used in a hook."
10504 (when (org-mode-p)
10505 (org-map-dblocks 'org-update-dblock)))
10508 ;;;; Completion
10510 (defconst org-additional-option-like-keywords
10511 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10512 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10513 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10514 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10515 "BEGIN:" "END:"
10516 "ORGTBL" "TBLFM:" "TBLNAME:"
10517 "BEGIN_EXAMPLE" "END_EXAMPLE"
10518 "BEGIN_QUOTE" "END_QUOTE"
10519 "BEGIN_VERSE" "END_VERSE"
10520 "BEGIN_CENTER" "END_CENTER"
10521 "BEGIN_SRC" "END_SRC"
10522 "CATEGORY" "COLUMNS" "PROPERTY"
10523 "CAPTION" "LABEL"
10524 "SETUPFILE"
10525 "BIND"
10526 "MACRO"))
10528 (defcustom org-structure-template-alist
10529 '(
10542 ("L" "#+latex: "
10546 ("H" "#+html: "
10549 ("A" "#+ascii: ")
10550 ("i" "#+include %file ?"
10552 )
10553 "Structure completion elements.
10554 This is a list of abbreviation keys and values. The value gets inserted
10555 if you type `<' followed by the key and then press the completion key,
10556 usually `M-TAB'. %file will be replaced by a file name after prompting
10557 for the file using completion.
10558 There are two templates for each key, the first uses the original Org syntax,
10559 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10560 the default when the /org-mtags.el/ module has been loaded. See also the
10561 variable `org-mtags-prefer-muse-templates'.
10562 This is an experimental feature, it is undecided if it is going to stay in."
10563 :group 'org-completion
10564 :type '(repeat
10565 (string :tag "Key")
10566 (string :tag "Template")
10567 (string :tag "Muse Template")))
10569 (defun org-try-structure-completion ()
10570 "Try to complete a structure template before point.
10572 expands them."
10573 (let ((l (buffer-substring (point-at-bol) (point)))
10574 a)
10577 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10578 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10579 (match-beginning 1)) a)
10580 t)))
10582 (defun org-complete-expand-structure-template (start cell)
10583 "Expand a structure template."
10584 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10585 (rpl (nth (if musep 2 1) cell))
10586 (ind ""))
10587 (delete-region start (point))
10589 (cond
10590 ((bolp))
10592 (setq ind (buffer-substring (point-at-bol) (point))))
10593 (t (newline))))
10594 (setq start (point))
10595 (if (string-match "%file" rpl)
10596 (setq rpl (replace-match
10597 (concat
10599 (save-match-data
10600 (abbreviate-file-name (read-file-name "Include file: ")))
10602 t t rpl)))
10605 (insert rpl)
10609 (defun org-complete (&optional arg)
10610 "Perform completion on word at point.
10611 At the beginning of a headline, this completes TODO keywords as given in
10612 `org-todo-keywords'.
10613 If the current word is preceded by a backslash, completes the TeX symbols
10614 that are supported for HTML support.
10616 setting file options.
10618 At all other locations, this simply calls the value of
10619 `org-completion-fallback-command'."
10620 (interactive "P")
10621 (org-without-partial-completion
10622 (catch 'exit
10623 (let* ((a nil)
10624 (end (point))
10625 (beg1 (save-excursion
10626 (skip-chars-backward (org-re "[:alnum:]_@#%"))
10627 (point)))
10628 (beg (save-excursion
10629 (skip-chars-backward "a-zA-Z0-9_:$")
10630 (point)))
10631 (confirm (lambda (x) (stringp (car x))))
10632 (searchhead (equal (char-before beg) ?*))
10633 (struct
10634 (when (and (member (char-before beg1) '(?. ?<))
10635 (setq a (assoc (buffer-substring beg1 (point))
10636 org-structure-template-alist)))
10637 (org-complete-expand-structure-template (1- beg1) a)
10638 (throw 'exit t)))
10639 (tag (and (equal (char-before beg1) ?:)
10640 (equal (char-after (point-at-bol)) ?*)))
10641 (prop (or (and (equal (char-before beg1) ?:)
10642 (not (equal (char-after (point-at-bol)) ?*)))
10644 (buffer-substring (point-at-bol) (point)))))
10646 (link (equal (char-before beg) ?\[))
10647 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10648 beg)
10649 "#+"))
10651 (buffer-substring (point-at-bol) (point))))
10652 (completion-ignore-case opt)
10653 (type nil)
10654 (tbl nil)
10655 (table (cond
10656 (opt
10657 (setq type :opt)
10658 (require 'org-exp)
10659 (append
10660 (delq nil
10661 (mapcar
10662 (lambda (x)
10663 (if (string-match
10665 (cons (match-string 2 x)
10666 (match-string 1 x))))
10668 (mapcar 'list org-additional-option-like-keywords)))
10669 (startup
10670 (setq type :startup)
10671 org-startup-options)
10672 (link (append org-link-abbrev-alist-local
10673 org-link-abbrev-alist))
10674 (texp
10675 (setq type :tex)
10676 (append org-entities-user org-entities))
10678 (buffer-substring (point-at-bol) beg))
10679 (setq type :todo)
10680 (mapcar 'list org-todo-keywords-1))
10681 (searchhead
10682 (setq type :searchhead)
10683 (save-excursion
10684 (goto-char (point-min))
10685 (while (re-search-forward org-todo-line-regexp nil t)
10686 (push (list
10687 (org-make-org-heading-search-string
10688 (match-string 3) t))
10689 tbl)))
10690 tbl)
10691 (tag (setq type :tag beg beg1)
10692 (or org-tag-alist (org-get-buffer-tags)))
10693 (prop (setq type :prop beg beg1)
10694 (mapcar 'list (org-buffer-property-keys nil t t)))
10695 (t (progn
10696 (call-interactively org-completion-fallback-command)
10697 (throw 'exit nil)))))
10698 (pattern (buffer-substring-no-properties beg end))
10699 (completion (try-completion pattern table confirm)))
10700 (cond ((eq completion t)
10701 (if (not (assoc (upcase pattern) table))
10702 (message "Already complete")
10703 (if (and (equal type :opt)
10704 (not (member (car (assoc (upcase pattern) table))
10705 org-additional-option-like-keywords)))
10706 (insert (substring (cdr (assoc (upcase pattern) table))
10707 (length pattern)))
10708 (if (memq type '(:tag :prop)) (insert ":")))))
10709 ((null completion)
10711 (ding))
10712 ((not (string= pattern completion))
10713 (delete-region beg end)
10714 (if (string-match " +$" completion)
10715 (setq completion (replace-match "" t t completion)))
10716 (insert completion)
10717 (if (get-buffer-window "*Completions*")
10718 (delete-window (get-buffer-window "*Completions*")))
10719 (if (assoc completion table)
10720 (if (eq type :todo) (insert " ")
10721 (if (and (memq type '(:tag :prop))
10723 (org-current-line-string t))))
10724 (insert ":"))))
10725 (if (and (equal type :opt) (assoc completion table))
10726 (message "%s" (substitute-command-keys
10728 (t
10729 (message "Making completion list...")
10730 (let ((list (sort (all-completions pattern table confirm)
10731 'string<)))
10732 (with-output-to-temp-buffer "*Completions*"
10733 (condition-case nil
10734 ;; Protection needed for XEmacs and emacs 21
10735 (display-completion-list list pattern)
10736 (error (display-completion-list list)))))
10737 (message "Making completion list...%s" "done")))))))
10739 ;;;; TODO, DEADLINE, Comments
10741 (defun org-toggle-comment ()
10742 "Change the COMMENT state of an entry."
10743 (interactive)
10744 (save-excursion
10745 (org-back-to-heading)
10746 (let (case-fold-search)
10747 (if (looking-at (concat outline-regexp
10749 (replace-match "" t t nil 1)
10750 (if (looking-at outline-regexp)
10751 (progn
10752 (goto-char (match-end 0))
10753 (insert org-comment-string " ")))))))
10755 (defvar org-last-todo-state-is-todo nil
10756 "This is non-nil when the last TODO state change led to a TODO state.
10757 If the last change removed the TODO tag or switched to DONE, then
10758 this is nil.")
10760 (defvar org-setting-tags nil) ; dynamically skipped
10762 (defvar org-todo-setup-filter-hook nil
10763 "Hook for functions that pre-filter todo specs.
10764 Each function takes a todo spec and returns either nil or the spec
10765 transformed into canonical form." )
10767 (defvar org-todo-get-default-hook nil
10768 "Hook for functions that get a default item for todo.
10769 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10770 nil or a string to be used for the todo mark." )
10772 (defvar org-agenda-headline-snapshot-before-repeat)
10774 (defun org-todo (&optional arg)
10775 "Change the TODO state of an item.
10776 The state of an item is given by a keyword at the start of the heading,
10777 like
10778 *** TODO Write paper
10779 *** DONE Call mom
10781 The different keywords are specified in the variable `org-todo-keywords'.
10783 So for this example: when the item starts with TODO, it is changed to DONE.
10784 When it starts with DONE, the DONE is removed. And when neither TODO nor
10785 DONE are present, add TODO at the beginning of the heading.
10788 state.
10789 With numeric prefix arg, switch to that state.
10791 keywords (nextset).
10794 For calling through lisp, arg is also interpreted in the following way:
10795 'none -> empty state
10797 'done -> switch to DONE
10798 'nextset -> switch to the next set of keywords
10799 'previousset -> switch to the previous set of keywords
10801 really is a member of `org-todo-keywords'."
10802 (interactive "P")
10803 (if (equal arg '(16)) (setq arg 'nextset))
10804 (let ((org-blocker-hook org-blocker-hook)
10805 (case-fold-search nil))
10806 (when (equal arg '(64))
10807 (setq arg nil org-blocker-hook nil))
10808 (when (and org-blocker-hook
10809 (or org-inhibit-blocking
10810 (org-entry-get nil "NOBLOCKING")))
10811 (setq org-blocker-hook nil))
10812 (save-excursion
10813 (catch 'exit
10814 (org-back-to-heading t)
10815 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10817 (looking-at " *"))
10818 (let* ((match-data (match-data))
10819 (startpos (point-at-bol))
10820 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10821 (org-log-done org-log-done)
10822 (org-log-repeat org-log-repeat)
10823 (org-todo-log-states org-todo-log-states)
10824 (this (match-string 1))
10825 (hl-pos (match-beginning 0))
10826 (head (org-get-todo-sequence-head this))
10827 (ass (assoc head org-todo-kwd-alist))
10828 (interpret (nth 1 ass))
10829 (done-word (nth 3 ass))
10830 (final-done-word (nth 4 ass))
10831 (last-state (or this ""))
10832 (completion-ignore-case t)
10833 (member (member this org-todo-keywords-1))
10834 (tail (cdr member))
10835 (state (cond
10836 ((and org-todo-key-trigger
10837 (or (and (equal arg '(4))
10838 (eq org-use-fast-todo-selection 'prefix))
10839 (and (not arg) org-use-fast-todo-selection
10840 (not (eq org-use-fast-todo-selection
10841 'prefix)))))
10842 ;; Use fast selection
10843 (org-fast-todo-selection))
10844 ((and (equal arg '(4))
10845 (or (not org-use-fast-todo-selection)
10846 (not org-todo-key-trigger)))
10847 ;; Read a state with completion
10848 (org-icompleting-read
10849 "State: " (mapcar (lambda(x) (list x))
10850 org-todo-keywords-1)
10851 nil t))
10852 ((eq arg 'right)
10853 (if this
10854 (if tail (car tail) nil)
10855 (car org-todo-keywords-1)))
10856 ((eq arg 'left)
10857 (if (equal member org-todo-keywords-1)
10858 nil
10859 (if this
10860 (nth (- (length org-todo-keywords-1)
10861 (length tail) 2)
10862 org-todo-keywords-1)
10863 (org-last org-todo-keywords-1))))
10864 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10865 (setq arg nil))) ; hack to fall back to cycling
10866 (arg
10867 ;; user or caller requests a specific state
10868 (cond
10869 ((equal arg "") nil)
10870 ((eq arg 'none) nil)
10871 ((eq arg 'done) (or done-word (car org-done-keywords)))
10872 ((eq arg 'nextset)
10873 (or (car (cdr (member head org-todo-heads)))
10874 (car org-todo-heads)))
10875 ((eq arg 'previousset)
10876 (let ((org-todo-heads (reverse org-todo-heads)))
10877 (or (car (cdr (member head org-todo-heads)))
10878 (car org-todo-heads))))
10879 ((car (member arg org-todo-keywords-1)))
10880 ((stringp arg)
10881 (error "State `%s' not valid in this file" arg))
10882 ((nth (1- (prefix-numeric-value arg))
10883 org-todo-keywords-1))))
10884 ((null member) (or head (car org-todo-keywords-1)))
10885 ((equal this final-done-word) nil) ;; -> make empty
10886 ((null tail) nil) ;; -> first entry
10887 ((memq interpret '(type priority))
10888 (if (eq this-command last-command)
10889 (car tail)
10890 (if (> (length tail) 0)
10891 (or done-word (car org-done-keywords))
10892 nil)))
10893 (t
10894 (car tail))))
10895 (state (or
10896 (run-hook-with-args-until-success
10897 'org-todo-get-default-hook state last-state)
10898 state))
10899 (next (if state (concat " " state " ") " "))
10900 (change-plist (list :type 'todo-state-change :from this :to state
10901 :position startpos))
10902 dolog now-done-p)
10903 (when org-blocker-hook
10904 (setq org-last-todo-state-is-todo
10905 (not (member this org-done-keywords)))
10906 (unless (save-excursion
10907 (save-match-data
10908 (run-hook-with-args-until-failure
10909 'org-blocker-hook change-plist)))
10910 (if (interactive-p)
10911 (error "TODO state change from %s to %s blocked" this state)
10912 ;; fail silently
10913 (message "TODO state change from %s to %s blocked" this state)
10914 (throw 'exit nil))))
10915 (store-match-data match-data)
10916 (replace-match next t t)
10917 (unless (pos-visible-in-window-p hl-pos)
10918 (message "TODO state changed to %s" (org-trim next)))
10919 (unless head
10920 (setq head (org-get-todo-sequence-head state)
10921 ass (assoc head org-todo-kwd-alist)
10922 interpret (nth 1 ass)
10923 done-word (nth 3 ass)
10924 final-done-word (nth 4 ass)))
10925 (when (memq arg '(nextset previousset))
10926 (message "Keyword-Set %d/%d: %s"
10927 (- (length org-todo-sets) -1
10928 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10929 (length org-todo-sets)
10930 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10931 (setq org-last-todo-state-is-todo
10932 (not (member state org-done-keywords)))
10933 (setq now-done-p (and (member state org-done-keywords)
10934 (not (member this org-done-keywords))))
10935 (and logging (org-local-logging logging))
10936 (when (and (or org-todo-log-states org-log-done)
10937 (not (eq org-inhibit-logging t))
10938 (not (memq arg '(nextset previousset))))
10939 ;; we need to look at recording a time and note
10940 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10941 (nth 2 (assoc this org-todo-log-states))))
10942 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10943 (setq dolog 'time))
10944 (when (and state
10945 (member state org-not-done-keywords)
10946 (not (member this org-not-done-keywords)))
10947 ;; This is now a todo state and was not one before
10948 ;; If there was a CLOSED time stamp, get rid of it.
10949 (org-add-planning-info nil nil 'closed))
10950 (when (and now-done-p org-log-done)
10951 ;; It is now done, and it was not done before
10952 (org-add-planning-info 'closed (org-current-time))
10953 (if (and (not dolog) (eq 'note org-log-done))
10954 (org-add-log-setup 'done state this 'findpos 'note)))
10955 (when (and state dolog)
10956 ;; This is a non-nil state, and we need to log it
10957 (org-add-log-setup 'state state this 'findpos dolog)))
10958 ;; Fixup tag positioning
10959 (org-todo-trigger-tag-changes state)
10960 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10961 (when org-provide-todo-statistics
10962 (org-update-parent-todo-statistics))
10963 (run-hooks 'org-after-todo-state-change-hook)
10964 (if (and arg (not (member state org-done-keywords)))
10965 (setq head (org-get-todo-sequence-head state)))
10966 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10967 ;; Do we need to trigger a repeat?
10968 (when now-done-p
10969 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10970 ;; This is for the agenda, take a snapshot of the headline.
10971 (save-match-data
10972 (setq org-agenda-headline-snapshot-before-repeat
10973 (org-get-heading))))
10974 (org-auto-repeat-maybe state))
10975 ;; Fixup cursor location if close to the keyword
10976 (if (and (outline-on-heading-p)
10977 (not (bolp))
10978 (save-excursion (beginning-of-line 1)
10979 (looking-at org-todo-line-regexp))
10980 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10981 (progn
10982 (goto-char (or (match-end 2) (match-end 1)))
10983 (and (looking-at " ") (just-one-space))))
10984 (when org-trigger-hook
10985 (save-excursion
10986 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10988 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10989 "Block turning an entry into a TODO, using the hierarchy.
10990 This checks whether the current task should be blocked from state
10991 changes. Such blocking occurs when:
10993 1. The task has children which are not all in a completed state.
10995 2. A task has a parent with the property :ORDERED:, and there
10996 are siblings prior to the current task with incomplete
10997 status.
10999 3. The parent of the task is blocked because it has siblings that should
11000 be done first, or is child of a block grandparent TODO entry."
11002 (if (not org-enforce-todo-dependencies)
11003 t ; if locally turned off don't block
11004 (catch 'dont-block
11005 ;; If this is not a todo state change, or if this entry is already DONE,
11006 ;; do not block
11007 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11008 (member (plist-get change-plist :from)
11009 (cons 'done org-done-keywords))
11010 (member (plist-get change-plist :to)
11011 (cons 'todo org-not-done-keywords))
11012 (not (plist-get change-plist :to)))
11013 (throw 'dont-block t))
11014 ;; If this task has children, and any are undone, it's blocked
11015 (save-excursion
11016 (org-back-to-heading t)
11017 (let ((this-level (funcall outline-level)))
11018 (outline-next-heading)
11019 (let ((child-level (funcall outline-level)))
11020 (while (and (not (eobp))
11021 (> child-level this-level))
11022 ;; this todo has children, check whether they are all
11023 ;; completed
11024 (if (and (not (org-entry-is-done-p))
11025 (org-entry-is-todo-p))
11026 (throw 'dont-block nil))
11027 (outline-next-heading)
11028 (setq child-level (funcall outline-level))))))
11029 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11030 ;; any previous siblings are undone, it's blocked
11031 (save-excursion
11032 (org-back-to-heading t)
11033 (let* ((pos (point))
11034 (parent-pos (and (org-up-heading-safe) (point))))
11035 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11036 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11037 (forward-line 1)
11038 (re-search-forward org-not-done-heading-regexp pos t))
11039 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11040 ;; Search further up the hierarchy, to see if an anchestor is blocked
11041 (while t
11042 (goto-char parent-pos)
11043 (if (not (looking-at org-not-done-heading-regexp))
11044 (throw 'dont-block t)) ; do not block, parent is not a TODO
11045 (setq pos (point))
11046 (setq parent-pos (and (org-up-heading-safe) (point)))
11047 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11048 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11049 (forward-line 1)
11050 (re-search-forward org-not-done-heading-regexp pos t))
11051 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11053 (defcustom org-track-ordered-property-with-tag nil
11054 "Should the ORDERED property also be shown as a tag?
11055 The ORDERED property decides if an entry should require subtasks to be
11056 completed in sequence. Since a property is not very visible, setting
11057 this option means that toggling the ORDERED property with the command
11058 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11059 not relevant for the behavior, but it makes things more visible.
11061 Note that toggling the tag with tags commands will not change the property
11062 and therefore not influence behavior!
11064 This can be t, meaning the tag ORDERED should be used, It can also be a
11065 string to select a different tag for this task."
11066 :group 'org-todo
11067 :type '(choice
11068 (const :tag "No tracking" nil)
11069 (const :tag "Track with ORDERED tag" t)
11070 (string :tag "Use other tag")))
11072 (defun org-toggle-ordered-property ()
11073 "Toggle the ORDERED property of the current entry.
11074 For better visibility, you can track the value of this property with a tag.
11075 See variable `org-track-ordered-property-with-tag'."
11076 (interactive)
11077 (let* ((t1 org-track-ordered-property-with-tag)
11078 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11079 (save-excursion
11080 (org-back-to-heading)
11081 (if (org-entry-get nil "ORDERED")
11082 (progn
11083 (org-delete-property "ORDERED")
11084 (and tag (org-toggle-tag tag 'off))
11085 (message "Subtasks can be completed in arbitrary order"))
11086 (org-entry-put nil "ORDERED" "t")
11087 (and tag (org-toggle-tag tag 'on))
11088 (message "Subtasks must be completed in sequence")))))
11090 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11091 (defun org-block-todo-from-checkboxes (change-plist)
11092 "Block turning an entry into a TODO, using checkboxes.
11093 This checks whether the current task should be blocked from state
11094 changes because there are unchecked boxes in this entry."
11095 (if (not org-enforce-todo-checkbox-dependencies)
11096 t ; if locally turned off don't block
11097 (catch 'dont-block
11098 ;; If this is not a todo state change, or if this entry is already DONE,
11099 ;; do not block
11100 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11101 (member (plist-get change-plist :from)
11102 (cons 'done org-done-keywords))
11103 (member (plist-get change-plist :to)
11104 (cons 'todo org-not-done-keywords))
11105 (not (plist-get change-plist :to)))
11106 (throw 'dont-block t))
11107 ;; If this task has checkboxes that are not checked, it's blocked
11108 (save-excursion
11109 (org-back-to-heading t)
11110 (let ((beg (point)) end)
11111 (outline-next-heading)
11112 (setq end (point))
11113 (goto-char beg)
11115 end t)
11116 (progn
11117 (if (boundp 'org-blocked-by-checkboxes)
11118 (setq org-blocked-by-checkboxes t))
11119 (throw 'dont-block nil)))))
11120 t))) ; do not block
11122 (defun org-entry-blocked-p ()
11123 "Is the current entry blocked?"
11124 (if (org-entry-get nil "NOBLOCKING")
11125 nil ;; Never block this entry
11126 (not
11127 (run-hook-with-args-until-failure
11128 'org-blocker-hook
11129 (list :type 'todo-state-change
11130 :position (point)
11131 :from 'todo
11132 :to 'done)))))
11134 (defun org-update-statistics-cookies (all)
11135 "Update the statistics cookie, either from TODO or from checkboxes.
11136 This should be called with the cursor in a line with a statistics cookie."
11137 (interactive "P")
11138 (if all
11139 (progn
11140 (org-update-checkbox-count 'all)
11141 (org-map-entries 'org-update-parent-todo-statistics))
11142 (if (not (org-on-heading-p))
11143 (org-update-checkbox-count)
11144 (let ((pos (move-marker (make-marker) (point)))
11145 end l1 l2)
11146 (ignore-errors (org-back-to-heading t))
11147 (if (not (org-on-heading-p))
11148 (org-update-checkbox-count)
11149 (setq l1 (org-outline-level))
11150 (setq end (save-excursion
11151 (outline-next-heading)
11152 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11153 (point)))
11154 (if (and (save-excursion
11155 (re-search-forward
11157 (not (save-excursion (re-search-forward
11159 (org-update-checkbox-count)
11160 (if (and l2 (> l2 l1))
11161 (progn
11162 (goto-char end)
11163 (org-update-parent-todo-statistics))
11164 (goto-char pos)
11165 (beginning-of-line 1)
11166 (while (re-search-forward
11168 (point-at-eol) t)
11169 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11170 (goto-char pos)
11171 (move-marker pos nil)))))
11173 (defvar org-entry-property-inherited-from) ;; defined below
11174 (defun org-update-parent-todo-statistics ()
11175 "Update any statistics cookie in the parent of the current headline.
11176 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11177 the entire subtree and this will travel up the hierarchy and update
11178 statistics everywhere."
11179 (interactive)
11180 (let* ((lim 0) prop
11181 (recursive (or (not org-hierarchical-todo-statistics)
11182 (string-match
11184 (or (setq prop (org-entry-get
11185 nil "COOKIE_DATA" 'inherit)) ""))))
11186 (lim (or (and prop (marker-position
11187 org-entry-property-inherited-from))
11188 lim))
11189 (first t)
11191 level ltoggle l1 new ndel
11192 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11193 (catch 'exit
11194 (save-excursion
11195 (beginning-of-line 1)
11196 (if (org-at-heading-p)
11197 (setq ltoggle (funcall outline-level))
11198 (error "This should not happen"))
11199 (while (and (setq level (org-up-heading-safe))
11200 (or recursive first)
11201 (>= (point) lim))
11202 (setq first nil cookie-present nil)
11203 (unless (and level
11204 (not (string-match
11206 (downcase
11207 (or (org-entry-get
11208 nil "COOKIE_DATA")
11209 "")))))
11210 (throw 'exit nil))
11211 (while (re-search-forward box-re (point-at-eol) t)
11212 (setq cnt-all 0 cnt-done 0 cookie-present t)
11213 (setq is-percent (match-end 2))
11214 (save-match-data
11215 (unless (outline-next-heading) (throw 'exit nil))
11216 (while (and (looking-at org-complex-heading-regexp)
11217 (> (setq l1 (length (match-string 1))) level))
11218 (setq kwd (and (or recursive (= l1 ltoggle))
11219 (match-string 2)))
11220 (if (or (eq org-provide-todo-statistics 'all-headlines)
11221 (and (listp org-provide-todo-statistics)
11222 (or (member kwd org-provide-todo-statistics)
11223 (member kwd org-done-keywords))))
11224 (setq cnt-all (1+ cnt-all))
11225 (if (eq org-provide-todo-statistics t)
11226 (and kwd (setq cnt-all (1+ cnt-all)))))
11227 (and (member kwd org-done-keywords)
11228 (setq cnt-done (1+ cnt-done)))
11229 (outline-next-heading)))
11230 (setq new
11231 (if is-percent
11232 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11233 (format "[%d/%d]" cnt-done cnt-all))
11234 ndel (- (match-end 0) (match-beginning 0)))
11235 (goto-char (match-beginning 0))
11236 (insert new)
11237 (delete-region (point) (+ (point) ndel)))
11238 (when cookie-present
11239 (run-hook-with-args 'org-after-todo-statistics-hook
11240 cnt-done (- cnt-all cnt-done))))))
11241 (run-hooks 'org-todo-statistics-hook)))
11243 (defvar org-after-todo-statistics-hook nil
11244 "Hook that is called after a TODO statistics cookie has been updated.
11245 Each function is called with two arguments: the number of not-done entries
11246 and the number of done entries.
11248 For example, the following function, when added to this hook, will switch
11249 an entry to DONE when all children are done, and back to TODO when new
11250 entries are set to a TODO status. Note that this hook is only called
11251 when there is a statistics cookie in the headline!
11253 (defun org-summary-todo (n-done n-not-done)
11255 (let (org-log-done org-log-states) ; turn off logging
11257 ")
11259 (defvar org-todo-statistics-hook nil
11260 "Hook that is run whenever Org thinks TODO statistics should be updated.
11261 This hook runs even if there is no statistics cookie present, in which case
11262 `org-after-todo-statistics-hook' would not run.")
11264 (defun org-todo-trigger-tag-changes (state)
11265 "Apply the changes defined in `org-todo-state-tags-triggers'."
11266 (let ((l org-todo-state-tags-triggers)
11267 changes)
11268 (when (or (not state) (equal state ""))
11269 (setq changes (append changes (cdr (assoc "" l)))))
11270 (when (and (stringp state) (> (length state) 0))
11271 (setq changes (append changes (cdr (assoc state l)))))
11272 (when (member state org-not-done-keywords)
11273 (setq changes (append changes (cdr (assoc 'todo l)))))
11274 (when (member state org-done-keywords)
11275 (setq changes (append changes (cdr (assoc 'done l)))))
11276 (dolist (c changes)
11277 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11279 (defun org-local-logging (value)
11280 "Get logging settings from a property VALUE."
11281 (let* (words w a)
11282 ;; directly set the variables, they are already local.
11283 (setq org-log-done nil
11284 org-log-repeat nil
11285 org-todo-log-states nil)
11286 (setq words (org-split-string value))
11287 (while (setq w (pop words))
11288 (cond
11289 ((setq a (assoc w org-startup-options))
11290 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11291 (set (nth 1 a) (nth 2 a))))
11292 ((setq a (org-extract-log-state-settings w))
11293 (and (member (car a) org-todo-keywords-1)
11294 (push a org-todo-log-states)))))))
11296 (defun org-get-todo-sequence-head (kwd)
11297 "Return the head of the TODO sequence to which KWD belongs.
11298 If KWD is not set, check if there is a text property remembering the
11299 right sequence."
11300 (let (p)
11301 (cond
11302 ((not kwd)
11303 (or (get-text-property (point-at-bol) 'org-todo-head)
11304 (progn
11305 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11306 nil (point-at-eol)))
11307 (get-text-property p 'org-todo-head))))
11308 ((not (member kwd org-todo-keywords-1))
11309 (car org-todo-keywords-1))
11310 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11312 (defun org-fast-todo-selection ()
11313 "Fast TODO keyword selection with single keys.
11314 Returns the new TODO keyword, or nil if no state change should occur."
11315 (let* ((fulltable org-todo-key-alist)
11316 (done-keywords org-done-keywords) ;; needed for the faces.
11317 (maxlen (apply 'max (mapcar
11318 (lambda (x)
11319 (if (stringp (car x)) (string-width (car x)) 0))
11320 fulltable)))
11321 (expert nil)
11322 (fwidth (+ maxlen 3 1 3))
11323 (ncol (/ (- (window-width) 4) fwidth))
11324 tg cnt e c tbl
11325 groups ingroup)
11326 (save-excursion
11327 (save-window-excursion
11328 (if expert
11329 (set-buffer (get-buffer-create " *Org todo*"))
11330 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11331 (erase-buffer)
11332 (org-set-local 'org-done-keywords done-keywords)
11333 (setq tbl fulltable cnt 0)
11334 (while (setq e (pop tbl))
11335 (cond
11336 ((equal e '(:startgroup))
11337 (push '() groups) (setq ingroup t)
11338 (when (not (= cnt 0))
11339 (setq cnt 0)
11341 (insert "{ "))
11342 ((equal e '(:endgroup))
11343 (setq ingroup nil cnt 0)
11345 ((equal e '(:newline))
11346 (when (not (= cnt 0))
11347 (setq cnt 0)
11349 (setq e (car tbl))
11350 (while (equal (car tbl) '(:newline))
11352 (setq tbl (cdr tbl)))))
11353 (t
11354 (setq tg (car e) c (cdr e))
11355 (if ingroup (push tg (car groups)))
11356 (setq tg (org-add-props tg nil 'face
11357 (org-get-todo-face tg)))
11358 (if (and (= cnt 0) (not ingroup)) (insert " "))
11359 (insert "[" c "] " tg (make-string
11360 (- fwidth 4 (length tg)) ?\ ))
11361 (when (= (setq cnt (1+ cnt)) ncol)
11363 (if ingroup (insert " "))
11364 (setq cnt 0)))))
11366 (goto-char (point-min))
11367 (if (not expert) (org-fit-window-to-buffer))
11368 (message "[a-z..]:Set [SPC]:clear")
11369 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11370 (cond
11371 ((or (= c ?\C-g)
11372 (and (= c ?q) (not (rassoc c fulltable))))
11373 (setq quit-flag t))
11374 ((= c ?\ ) nil)
11375 ((setq e (rassoc c fulltable) tg (car e))
11376 tg)
11377 (t (setq quit-flag t)))))))
11379 (defun org-entry-is-todo-p ()
11380 (member (org-get-todo-state) org-not-done-keywords))
11382 (defun org-entry-is-done-p ()
11383 (member (org-get-todo-state) org-done-keywords))
11385 (defun org-get-todo-state ()
11386 (save-excursion
11387 (org-back-to-heading t)
11388 (and (looking-at org-todo-line-regexp)
11389 (match-end 2)
11390 (match-string 2))))
11392 (defun org-at-date-range-p (&optional inactive-ok)
11393 "Is the cursor inside a date range?"
11394 (interactive)
11395 (save-excursion
11396 (catch 'exit
11397 (let ((pos (point)))
11399 (skip-chars-backward "<[")
11400 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11401 (>= (match-end 0) pos)
11402 (throw 'exit t))
11404 (skip-chars-backward "<[")
11405 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11406 (>= (match-end 0) pos)
11407 (throw 'exit t)))
11408 nil)))
11410 (defun org-get-repeat (&optional tagline)
11411 "Check if there is a deadline/schedule with repeater in this entry."
11412 (save-match-data
11413 (save-excursion
11414 (org-back-to-heading t)
11415 (and (re-search-forward (if tagline
11417 org-repeat-re)
11418 (org-entry-end-position) t)
11419 (match-string-no-properties 1)))))
11421 (defvar org-last-changed-timestamp)
11422 (defvar org-last-inserted-timestamp)
11423 (defvar org-log-post-message)
11424 (defvar org-log-note-purpose)
11425 (defvar org-log-note-how)
11426 (defvar org-log-note-extra)
11427 (defun org-auto-repeat-maybe (done-word)
11428 "Check if the current headline contains a repeated deadline/schedule.
11429 If yes, set TODO state back to what it was and change the base date
11430 of repeating deadline/scheduled time stamps to new date.
11431 This function is run automatically after each state change to a DONE state."
11432 ;; last-state is dynamically scoped into this function
11433 (let* ((repeat (org-get-repeat))
11434 (aa (assoc last-state org-todo-kwd-alist))
11435 (interpret (nth 1 aa))
11436 (head (nth 2 aa))
11437 (whata '(("d" . day) ("m" . month) ("y" . year)))
11438 (msg "Entry repeats: ")
11439 (org-log-done nil)
11440 (org-todo-log-states nil)
11441 re type n what ts time to-state)
11442 (when repeat
11443 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11444 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11445 org-todo-repeat-to-state))
11446 (unless (and to-state (member to-state org-todo-keywords-1))
11447 (setq to-state (if (eq interpret 'type) last-state head)))
11448 (org-todo to-state)
11449 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11450 (org-entry-put nil "LAST_REPEAT" (format-time-string
11451 (org-time-stamp-format t t))))
11452 (when org-log-repeat
11453 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11454 (memq 'org-add-log-note post-command-hook))
11455 ;; OK, we are already setup for some record
11456 (if (eq org-log-repeat 'note)
11457 ;; make sure we take a note, not only a time stamp
11458 (setq org-log-note-how 'note))
11459 ;; Set up for taking a record
11460 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11461 last-state
11462 'findpos org-log-repeat)))
11463 (org-back-to-heading t)
11464 (org-add-planning-info nil nil 'closed)
11468 (while (re-search-forward
11469 re (save-excursion (outline-next-heading) (point)) t)
11470 (setq type (if (match-end 1) org-scheduled-string
11471 (if (match-end 3) org-deadline-string "Plain:"))
11472 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11474 (setq n (string-to-number (match-string 2 ts))
11475 what (match-string 3 ts))
11476 (if (equal what "w") (setq n (* n 7) what "d"))
11477 ;; Preparation, see if we need to modify the start date for the change
11478 (when (match-end 1)
11479 (setq time (save-match-data (org-time-string-to-time ts)))
11480 (cond
11481 ((equal (match-string 1 ts) ".")
11482 ;; Shift starting date to today
11483 (org-timestamp-change
11484 (- (time-to-days (current-time)) (time-to-days time))
11485 'day))
11486 ((equal (match-string 1 ts) "+")
11487 (let ((nshiftmax 10) (nshift 0))
11488 (while (or (= nshift 0)
11489 (<= (time-to-days time)
11490 (time-to-days (current-time))))
11491 (when (= (incf nshift) nshiftmax)
11492 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11493 (error "Abort")))
11494 (org-timestamp-change n (cdr (assoc what whata)))
11495 (org-at-timestamp-p t)
11496 (setq ts (match-string 1))
11497 (setq time (save-match-data (org-time-string-to-time ts)))))
11498 (org-timestamp-change (- n) (cdr (assoc what whata)))
11499 ;; rematch, so that we have everything in place for the real shift
11500 (org-at-timestamp-p t)
11501 (setq ts (match-string 1))
11503 (org-timestamp-change n (cdr (assoc what whata)))
11504 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11505 (setq org-log-post-message msg)
11506 (message "%s" msg))))
11508 (defun org-show-todo-tree (arg)
11509 "Make a compact tree which shows all headlines marked with TODO.
11510 The tree will show the lines where the regexp matches, and all higher
11511 headlines above the match.
11513 With a numeric prefix N, construct a sparse tree for the Nth element
11514 of `org-todo-keywords-1'."
11515 (interactive "P")
11516 (let ((case-fold-search nil)
11517 (kwd-re
11518 (cond ((null arg) org-not-done-regexp)
11519 ((equal arg '(4))
11520 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11521 (mapcar 'list org-todo-keywords-1))))
11525 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11526 (regexp-quote (nth (1- (prefix-numeric-value arg))
11527 org-todo-keywords-1)))
11528 (t (error "Invalid prefix argument: %s" arg)))))
11529 (message "%d TODO entries found"
11530 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11532 (defun org-deadline (&optional remove time)
11534 With argument REMOVE, remove any deadline from the item.
11535 When TIME is set, it should be an internal time specification, and the
11536 scheduling will use the corresponding date."
11537 (interactive "P")
11538 (let* ((old-date (org-entry-get nil "DEADLINE"))
11539 (repeater (and old-date
11541 (match-string 1 old-date))))
11542 (if remove
11543 (progn
11544 (when (and old-date org-log-redeadline)
11545 (org-add-log-setup 'deldeadline nil old-date 'findpos
11546 org-log-redeadline))
11547 (org-remove-timestamp-with-keyword org-deadline-string)
11548 (message "Item no longer has a deadline."))
11549 (org-add-planning-info 'deadline time 'closed)
11550 (when (and old-date org-log-redeadline
11551 (not (equal old-date
11552 (substring org-last-inserted-timestamp 1 -1))))
11553 (org-add-log-setup 'redeadline nil old-date 'findpos
11554 org-log-redeadline))
11555 (when repeater
11556 (save-excursion
11557 (org-back-to-heading t)
11558 (when (re-search-forward (concat org-deadline-string " "
11559 org-last-inserted-timestamp)
11560 (save-excursion
11561 (outline-next-heading) (point)) t)
11562 (goto-char (1- (match-end 0)))
11563 (insert " " repeater)
11564 (setq org-last-inserted-timestamp
11565 (concat (substring org-last-inserted-timestamp 0 -1)
11566 " " repeater
11567 (substring org-last-inserted-timestamp -1))))))
11568 (message "Deadline on %s" org-last-inserted-timestamp))))
11570 (defun org-schedule (&optional remove time)
11571 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11572 With argument REMOVE, remove any scheduling date from the item.
11573 When TIME is set, it should be an internal time specification, and the
11574 scheduling will use the corresponding date."
11575 (interactive "P")
11576 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11577 (repeater (and old-date
11579 (match-string 1 old-date))))
11580 (if remove
11581 (progn
11582 (when (and old-date org-log-reschedule)
11583 (org-add-log-setup 'delschedule nil old-date 'findpos
11584 org-log-reschedule))
11585 (org-remove-timestamp-with-keyword org-scheduled-string)
11586 (message "Item is no longer scheduled."))
11587 (org-add-planning-info 'scheduled time 'closed)
11588 (when (and old-date org-log-reschedule
11589 (not (equal old-date
11590 (substring org-last-inserted-timestamp 1 -1))))
11591 (org-add-log-setup 'reschedule nil old-date 'findpos
11592 org-log-reschedule))
11593 (when repeater
11594 (save-excursion
11595 (org-back-to-heading t)
11596 (when (re-search-forward (concat org-scheduled-string " "
11597 org-last-inserted-timestamp)
11598 (save-excursion
11599 (outline-next-heading) (point)) t)
11600 (goto-char (1- (match-end 0)))
11601 (insert " " repeater)
11602 (setq org-last-inserted-timestamp
11603 (concat (substring org-last-inserted-timestamp 0 -1)
11604 " " repeater
11605 (substring org-last-inserted-timestamp -1))))))
11606 (message "Scheduled to %s" org-last-inserted-timestamp))))
11608 (defun org-get-scheduled-time (pom &optional inherit)
11609 "Get the scheduled time as a time tuple, of a format suitable
11610 for calling org-schedule with, or if there is no scheduling,
11611 returns nil."
11612 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11613 (when time
11614 (apply 'encode-time (org-parse-time-string time)))))
11616 (defun org-get-deadline-time (pom &optional inherit)
11617 "Get the deadline as a time tuple, of a format suitable for
11618 calling org-deadline with, or if there is no scheduling, returns
11619 nil."
11620 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11621 (when time
11622 (apply 'encode-time (org-parse-time-string time)))))
11624 (defun org-remove-timestamp-with-keyword (keyword)
11625 "Remove all time stamps with KEYWORD in the current entry."
11627 beg)
11628 (save-excursion
11629 (org-back-to-heading t)
11630 (setq beg (point))
11631 (outline-next-heading)
11632 (while (re-search-backward re beg t)
11633 (replace-match "")
11635 (equal (char-before) ?\ ))
11636 (backward-delete-char 1)
11638 (point-at-bol) (point-at-eol)))
11639 (delete-region (point-at-bol)
11640 (min (point-max) (1+ (point-at-eol))))))))))
11642 (defun org-add-planning-info (what &optional time &rest remove)
11643 "Insert new timestamp with keyword in the line directly after the headline.
11644 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11645 If non is given, the user is prompted for a date.
11646 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11647 be removed."
11648 (interactive)
11649 (let (org-time-was-given org-end-time-was-given ts
11650 end default-time default-input)
11652 (catch 'exit
11653 (when (and (not time) (memq what '(scheduled deadline)))
11654 ;; Try to get a default date/time from existing timestamp
11655 (save-excursion
11656 (org-back-to-heading t)
11657 (setq end (save-excursion (outline-next-heading) (point)))
11658 (when (re-search-forward (if (eq what 'scheduled)
11659 org-scheduled-time-regexp
11660 org-deadline-time-regexp)
11661 end t)
11662 (setq ts (match-string 1)
11663 default-time
11664 (apply 'encode-time (org-parse-time-string ts))
11665 default-input (and ts (org-get-compact-tod ts))))))
11666 (when what
11667 ;; If necessary, get the time from the user
11668 (setq time (or time (org-read-date nil 'to-time nil nil
11669 default-time default-input))))
11671 (when (and org-insert-labeled-timestamps-at-point
11672 (member what '(scheduled deadline)))
11673 (insert
11674 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11675 (org-insert-time-stamp time org-time-was-given
11676 nil nil nil (list org-end-time-was-given))
11677 (setq what nil))
11678 (save-excursion
11679 (save-restriction
11680 (let (col list elt ts buffer-invisibility-spec)
11681 (org-back-to-heading t)
11683 (goto-char (match-end 1))
11684 (setq col (current-column))
11685 (goto-char (match-end 0))
11687 (when (and (not what)
11688 (not (looking-at
11690 org-keyword-time-not-clock-regexp))))
11691 ;; Nothing to add, nothing to remove...... :-)
11692 (throw 'exit nil))
11693 (if (and (not (looking-at outline-regexp))
11696 (not (equal (match-string 1) org-clock-string)))
11697 (narrow-to-region (match-beginning 0) (match-end 0))
11699 (backward-char 1)
11700 (narrow-to-region (point) (point))
11701 (and org-adapt-indentation (org-indent-to-column col)))
11702 ;; Check if we have to remove something.
11703 (setq list (cons what remove))
11704 (while list
11705 (setq elt (pop list))
11706 (goto-char (point-min))
11707 (when (or (and (eq elt 'scheduled)
11708 (re-search-forward org-scheduled-time-regexp nil t))
11709 (and (eq elt 'deadline)
11710 (re-search-forward org-deadline-time-regexp nil t))
11711 (and (eq elt 'closed)
11712 (re-search-forward org-closed-time-regexp nil t)))
11713 (replace-match "")
11714 (if (looking-at "--+<[^>]+>") (replace-match ""))
11715 (skip-chars-backward " ")
11716 (if (looking-at " +") (replace-match ""))))
11717 (goto-char (point-max))
11718 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11719 (when what
11720 (insert
11721 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11722 (cond ((eq what 'scheduled) org-scheduled-string)
11723 ((eq what 'deadline) org-deadline-string)
11724 ((eq what 'closed) org-closed-string))
11725 " ")
11726 (setq ts (org-insert-time-stamp
11727 time
11728 (or org-time-was-given
11729 (and (eq what 'closed) org-log-done-with-time))
11730 (eq what 'closed)
11731 nil nil (list org-end-time-was-given)))
11732 (end-of-line 1))
11733 (goto-char (point-min))
11734 (widen)
11737 (delete-region (1- (point)) (point-at-eol)))
11738 ts))))))
11740 (defvar org-log-note-marker (make-marker))
11741 (defvar org-log-note-purpose nil)
11742 (defvar org-log-note-state nil)
11743 (defvar org-log-note-previous-state nil)
11744 (defvar org-log-note-how nil)
11745 (defvar org-log-note-extra nil)
11746 (defvar org-log-note-window-configuration nil)
11747 (defvar org-log-note-return-to (make-marker))
11748 (defvar org-log-post-message nil
11749 "Message to be displayed after a log note has been stored.
11750 The auto-repeater uses this.")
11752 (defun org-add-note ()
11753 "Add a note to the current entry.
11754 This is done in the same way as adding a state change note."
11755 (interactive)
11756 (org-add-log-setup 'note nil nil 'findpos nil))
11758 (defvar org-property-end-re)
11759 (defun org-add-log-setup (&optional purpose state prev-state
11760 findpos how extra)
11761 "Set up the post command hook to take a note.
11762 If this is about to TODO state change, the new state is expected in STATE.
11763 When FINDPOS is non-nil, find the correct position for the note in
11764 the current entry. If not, assume that it can be inserted at point.
11765 HOW is an indicator what kind of note should be created.
11766 EXTRA is additional text that will be inserted into the notes buffer."
11767 (let* ((org-log-into-drawer (org-log-into-drawer))
11768 (drawer (cond ((stringp org-log-into-drawer)
11769 org-log-into-drawer)
11770 (org-log-into-drawer "LOGBOOK")
11771 (t nil))))
11772 (save-restriction
11773 (save-excursion
11774 (when findpos
11775 (org-back-to-heading t)
11776 (narrow-to-region (point) (save-excursion
11777 (outline-next-heading) (point)))
11781 (goto-char (match-end 0))
11782 (cond
11783 (drawer
11785 nil t)
11786 (progn
11787 (goto-char (match-end 0))
11788 (or org-log-states-order-reversed
11789 (and (re-search-forward org-property-end-re nil t)
11790 (goto-char (1- (match-beginning 0))))))
11792 (beginning-of-line 0)
11793 (org-indent-line-function)
11794 (beginning-of-line 2)
11795 (org-indent-line-function)
11796 (end-of-line 0)))
11797 ((and org-log-state-notes-insert-after-drawers
11798 (save-excursion
11799 (forward-line) (looking-at org-drawer-regexp)))
11800 (forward-line)
11801 (while (looking-at org-drawer-regexp)
11802 (goto-char (match-end 0))
11803 (re-search-forward org-property-end-re (point-max) t)
11804 (forward-line))
11805 (forward-line -1)))
11806 (unless org-log-states-order-reversed
11808 (org-skip-over-state-notes)
11810 (move-marker org-log-note-marker (point))
11811 (setq org-log-note-purpose purpose
11812 org-log-note-state state
11813 org-log-note-previous-state prev-state
11814 org-log-note-how how
11815 org-log-note-extra extra)
11816 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11818 (defun org-skip-over-state-notes ()
11819 "Skip past the list of State notes in an entry."
11821 (when (org-in-item-p)
11822 (let ((limit (org-list-bottom-point)))
11824 (goto-char (or (org-get-next-item (point) limit)
11825 (org-get-end-of-item limit)))))))
11827 (defun org-add-log-note (&optional purpose)
11828 "Pop up a window for taking a note, and add this note later at point."
11829 (remove-hook 'post-command-hook 'org-add-log-note)
11830 (setq org-log-note-window-configuration (current-window-configuration))
11831 (delete-other-windows)
11832 (move-marker org-log-note-return-to (point))
11833 (switch-to-buffer (marker-buffer org-log-note-marker))
11834 (goto-char org-log-note-marker)
11835 (org-switch-to-buffer-other-window "*Org Note*")
11836 (erase-buffer)
11837 (if (memq org-log-note-how '(time state))
11838 (let (current-prefix-arg) (org-store-log-note))
11839 (let ((org-inhibit-startup t)) (org-mode))
11840 (insert (format "# Insert note for %s.
11842 (cond
11843 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11844 ((eq org-log-note-purpose 'done) "closed todo item")
11845 ((eq org-log-note-purpose 'state)
11847 (or org-log-note-previous-state "")
11848 (or org-log-note-state "")))
11849 ((eq org-log-note-purpose 'reschedule)
11850 "rescheduling")
11851 ((eq org-log-note-purpose 'delschedule)
11852 "no longer scheduled")
11853 ((eq org-log-note-purpose 'redeadline)
11854 "changing deadline")
11855 ((eq org-log-note-purpose 'deldeadline)
11856 "removing deadline")
11857 ((eq org-log-note-purpose 'refile)
11858 "refiling")
11859 ((eq org-log-note-purpose 'note)
11860 "this entry")
11861 (t (error "This should not happen")))))
11862 (if org-log-note-extra (insert org-log-note-extra))
11863 (org-set-local 'org-finish-function 'org-store-log-note)))
11865 (defvar org-note-abort nil) ; dynamically scoped
11866 (defun org-store-log-note ()
11867 "Finish taking a log note, and insert it to where it belongs."
11868 (let ((txt (buffer-string))
11869 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11870 lines ind bul)
11871 (kill-buffer (current-buffer))
11873 (setq txt (replace-match "" t t txt)))
11875 (setq txt (replace-match "" t t txt)))
11878 (setq note
11879 (org-replace-escapes
11880 note
11881 (list (cons "%u" (user-login-name))
11882 (cons "%U" user-full-name)
11883 (cons "%t" (format-time-string
11884 (org-time-stamp-format 'long 'inactive)
11885 (current-time)))
11886 (cons "%T" (format-time-string
11887 (org-time-stamp-format 'long nil)
11888 (current-time)))
11889 (cons "%s" (if org-log-note-state
11891 ""))
11892 (cons "%S" (if org-log-note-previous-state
11896 (push note lines))
11897 (when (or current-prefix-arg org-note-abort)
11898 (when org-log-into-drawer
11899 (org-remove-empty-drawer-at
11900 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11901 org-log-note-marker))
11902 (setq lines nil))
11903 (when lines
11904 (with-current-buffer (marker-buffer org-log-note-marker)
11905 (save-excursion
11906 (goto-char org-log-note-marker)
11907 (move-marker org-log-note-marker nil)
11908 (end-of-line 1)
11910 (setq ind (save-excursion
11911 (if (org-in-item-p)
11912 (progn
11913 (goto-char (org-list-top-point))
11914 (org-get-indentation))
11916 (cond
11917 ((and (org-at-heading-p)
11918 org-adapt-indentation)
11919 (1+ (org-current-level)))
11920 ((org-at-heading-p) 0)
11921 (t (org-get-indentation))))))
11922 (setq bul (org-list-bullet-string "-"))
11923 (org-indent-line-to ind)
11924 (insert bul (pop lines))
11925 (let ((ind-body (+ (length bul) ind)))
11926 (while lines
11928 (org-indent-line-to ind-body)
11929 (insert (pop lines))))
11930 (message "Note stored")
11931 (org-back-to-heading t)
11932 (org-cycle-hide-drawers 'children)))))
11933 (set-window-configuration org-log-note-window-configuration)
11934 (with-current-buffer (marker-buffer org-log-note-return-to)
11935 (goto-char org-log-note-return-to))
11936 (move-marker org-log-note-return-to nil)
11937 (and org-log-post-message (message "%s" org-log-post-message)))
11939 (defun org-remove-empty-drawer-at (drawer pos)
11940 "Remove an empty drawer DRAWER at position POS.
11941 POS may also be a marker."
11942 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11943 (save-excursion
11944 (save-restriction
11945 (widen)
11946 (goto-char pos)
11947 (if (org-in-regexp
11949 (replace-match ""))))))
11951 (defun org-sparse-tree (&optional arg)
11952 "Create a sparse tree, prompt for the details.
11953 This command can create sparse trees. You first need to select the type
11954 of match used to create the tree:
11956 t Show all TODO entries.
11957 T Show entries with a specific TODO keyword.
11958 m Show entries selected by a tags/property match.
11959 p Enter a property name and its value (both with completion on existing
11960 names/values) and show entries with that property.
11961 r Show entries matching a regular expression (`/' can be used as well)
11962 d Show deadlines due within `org-deadline-warning-days'.
11963 b Show deadlines and scheduled items before a date.
11964 a Show deadlines and scheduled items after a date."
11965 (interactive "P")
11966 (let (ans kwd value)
11967 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11968 (setq ans (read-char-exclusive))
11969 (cond
11970 ((equal ans ?d)
11971 (call-interactively 'org-check-deadlines))
11972 ((equal ans ?b)
11973 (call-interactively 'org-check-before-date))
11974 ((equal ans ?a)
11975 (call-interactively 'org-check-after-date))
11976 ((equal ans ?t)
11977 (org-show-todo-tree nil))
11978 ((equal ans ?T)
11979 (org-show-todo-tree '(4)))
11980 ((member ans '(?T ?m))
11981 (call-interactively 'org-match-sparse-tree))
11982 ((member ans '(?p ?P))
11983 (setq kwd (org-icompleting-read "Property: "
11984 (mapcar 'list (org-buffer-property-keys))))
11985 (setq value (org-icompleting-read "Value: "
11986 (mapcar 'list (org-property-values kwd))))
11989 (org-match-sparse-tree arg (concat kwd "=" value)))
11990 ((member ans '(?r ?R ?/))
11991 (call-interactively 'org-occur))
11994 (defvar org-occur-highlights nil
11995 "List of overlays used for occur matches.")
11996 (make-variable-buffer-local 'org-occur-highlights)
11997 (defvar org-occur-parameters nil
11998 "Parameters of the active org-occur calls.
11999 This is a list, each call to org-occur pushes as cons cell,
12000 containing the regular expression and the callback, onto the list.
12001 The list can contain several entries if `org-occur' has been called
12002 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12003 will only contain one set of parameters. When the highlights are
12004 removed (for example with `C-c C-c', or with the next edit (depending
12005 on `org-remove-highlights-with-change'), this variable is emptied
12006 as well.")
12007 (make-variable-buffer-local 'org-occur-parameters)
12009 (defun org-occur (regexp &optional keep-previous callback)
12010 "Make a compact tree which shows all matches of REGEXP.
12011 The tree will show the lines where the regexp matches, and all higher
12012 headlines above the match. It will also show the heading after the match,
12013 to make sure editing the matching entry is easy.
12014 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12015 call to `org-occur' will be kept, to allow stacking of calls to this
12016 command.
12017 If CALLBACK is non-nil, it is a function which is called to confirm
12018 that the match should indeed be shown."
12020 (when (equal regexp "")
12021 (error "Regexp cannot be empty"))
12022 (unless keep-previous
12023 (org-remove-occur-highlights nil nil t))
12024 (push (cons regexp callback) org-occur-parameters)
12025 (let ((cnt 0))
12026 (save-excursion
12027 (goto-char (point-min))
12028 (if (or (not keep-previous) ; do not want to keep
12029 (not org-occur-highlights)) ; no previous matches
12030 ;; hide everything
12031 (org-overview))
12032 (while (re-search-forward regexp nil t)
12033 (when (or (not callback)
12034 (save-match-data (funcall callback)))
12035 (setq cnt (1+ cnt))
12036 (when org-highlight-sparse-tree-matches
12037 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12038 (org-show-context 'occur-tree))))
12039 (when org-remove-highlights-with-change
12040 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12041 nil 'local))
12042 (unless org-sparse-tree-open-archived-trees
12043 (org-hide-archived-subtrees (point-min) (point-max)))
12044 (run-hooks 'org-occur-hook)
12045 (if (interactive-p)
12046 (message "%d match(es) for regexp %s" cnt regexp))
12047 cnt))
12049 (defun org-show-context (&optional key)
12050 "Make sure point and context are visible.
12051 How much context is shown depends upon the variables
12052 `org-show-hierarchy-above', `org-show-following-heading'. and
12053 `org-show-siblings'."
12054 (let ((heading-p (org-on-heading-p t))
12055 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12056 (following-p (org-get-alist-option org-show-following-heading key))
12057 (entry-p (org-get-alist-option org-show-entry-below key))
12058 (siblings-p (org-get-alist-option org-show-siblings key)))
12059 (catch 'exit
12060 ;; Show heading or entry text
12061 (if (and heading-p (not entry-p))
12062 (org-flag-heading nil) ; only show the heading
12063 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12064 (org-show-hidden-entry))) ; show entire entry
12065 (when following-p
12066 ;; Show next sibling, or heading below text
12067 (save-excursion
12068 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12069 (org-flag-heading nil))))
12070 (when siblings-p (org-show-siblings))
12071 (when hierarchy-p
12072 ;; show all higher headings, possibly with siblings
12073 (save-excursion
12074 (while (and (condition-case nil
12075 (progn (org-up-heading-all 1) t)
12076 (error nil))
12077 (not (bobp)))
12078 (org-flag-heading nil)
12079 (when siblings-p (org-show-siblings))))))))
12081 (defvar org-reveal-start-hook nil
12082 "Hook run before revealing a location.")
12084 (defun org-reveal (&optional siblings)
12085 "Show current entry, hierarchy above it, and the following headline.
12086 This can be used to show a consistent set of context around locations
12087 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12088 not t for the search context.
12090 With optional argument SIBLINGS, on each level of the hierarchy all
12091 siblings are shown. This repairs the tree structure to what it would
12092 look like when opened with hierarchical calls to `org-cycle'.
12094 go to the parent and show the
12095 entire tree."
12096 (interactive "P")
12097 (run-hooks 'org-reveal-start-hook)
12098 (let ((org-show-hierarchy-above t)
12099 (org-show-following-heading t)
12100 (org-show-siblings (if siblings t org-show-siblings)))
12101 (org-show-context nil))
12102 (when (equal siblings '(16))
12103 (save-excursion
12104 (when (org-up-heading-safe)
12105 (org-show-subtree)
12106 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12108 (defun org-highlight-new-match (beg end)
12109 "Highlight from BEG to END and mark the highlight is an occur headline."
12110 (let ((ov (make-overlay beg end)))
12111 (overlay-put ov 'face 'secondary-selection)
12112 (push ov org-occur-highlights)))
12114 (defun org-remove-occur-highlights (&optional beg end noremove)
12115 "Remove the occur highlights from the buffer.
12116 BEG and END are ignored. If NOREMOVE is nil, remove this function
12117 from the `before-change-functions' in the current buffer."
12118 (interactive)
12119 (unless org-inhibit-highlight-removal
12120 (mapc 'delete-overlay org-occur-highlights)
12121 (setq org-occur-highlights nil)
12122 (setq org-occur-parameters nil)
12123 (unless noremove
12124 (remove-hook 'before-change-functions
12125 'org-remove-occur-highlights 'local))))
12127 ;;;; Priorities
12130 "Regular expression matching the priority indicator.")
12132 (defvar org-remove-priority-next-time nil)
12134 (defun org-priority-up ()
12135 "Increase the priority of the current item."
12136 (interactive)
12137 (org-priority 'up))
12139 (defun org-priority-down ()
12140 "Decrease the priority of the current item."
12141 (interactive)
12142 (org-priority 'down))
12144 (defun org-priority (&optional action)
12145 "Change the priority of an item by ARG.
12146 ACTION can be `set', `up', `down', or a character."
12147 (interactive)
12148 (unless org-enable-priority-commands
12149 (error "Priority commands are disabled"))
12150 (setq action (or action 'set))
12151 (let (current new news have remove)
12152 (save-excursion
12153 (org-back-to-heading t)
12154 (if (looking-at org-priority-regexp)
12155 (setq current (string-to-char (match-string 2))
12156 have t)
12157 (setq current org-default-priority))
12158 (cond
12159 ((eq action 'remove)
12160 (setq remove t new ?\ ))
12161 ((or (eq action 'set)
12162 (if (featurep 'xemacs) (characterp action) (integerp action)))
12163 (if (not (eq action 'set))
12164 (setq new action)
12165 (message "Priority %c-%c, SPC to remove: "
12166 org-highest-priority org-lowest-priority)
12167 (save-match-data
12168 (setq new (read-char-exclusive))))
12169 (if (and (= (upcase org-highest-priority) org-highest-priority)
12170 (= (upcase org-lowest-priority) org-lowest-priority))
12171 (setq new (upcase new)))
12172 (cond ((equal new ?\ ) (setq remove t))
12173 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12174 (error "Priority must be between `%c' and `%c'"
12175 org-highest-priority org-lowest-priority))))
12176 ((eq action 'up)
12177 (if (and (not have) (eq last-command this-command))
12178 (setq new org-lowest-priority)
12179 (setq new (if (and org-priority-start-cycle-with-default (not have))
12180 org-default-priority (1- current)))))
12181 ((eq action 'down)
12182 (if (and (not have) (eq last-command this-command))
12183 (setq new org-highest-priority)
12184 (setq new (if (and org-priority-start-cycle-with-default (not have))
12185 org-default-priority (1+ current)))))
12186 (t (error "Invalid action")))
12187 (if (or (< (upcase new) org-highest-priority)
12188 (> (upcase new) org-lowest-priority))
12189 (setq remove t))
12190 (setq news (format "%c" new))
12191 (if have
12192 (if remove
12193 (replace-match "" t t nil 1)
12194 (replace-match news t t nil 2))
12195 (if remove
12196 (error "No priority cookie found in line")
12197 (let ((case-fold-search nil))
12198 (looking-at org-todo-line-regexp))
12199 (if (match-end 2)
12200 (progn
12201 (goto-char (match-end 2))
12202 (insert " [#" news "]"))
12203 (goto-char (match-beginning 3))
12204 (insert "[#" news "] "))))
12205 (org-preserve-lc (org-set-tags nil 'align)))
12206 (if remove
12207 (message "Priority removed")
12208 (message "Priority of current item set to %s" news))))
12210 (defun org-get-priority (s)
12211 "Find priority cookie and return priority."
12212 (save-match-data
12213 (if (not (string-match org-priority-regexp s))
12214 (* 1000 (- org-lowest-priority org-default-priority))
12215 (* 1000 (- org-lowest-priority
12216 (string-to-char (match-string 2 s)))))))
12218 ;;;; Tags
12220 (defvar org-agenda-archives-mode)
12221 (defvar org-map-continue-from nil
12222 "Position from where mapping should continue.
12223 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12225 (defvar org-scanner-tags nil
12226 "The current tag list while the tags scanner is running.")
12227 (defvar org-trust-scanner-tags nil
12228 "Should `org-get-tags-at' use the tags fro the scanner.
12229 This is for internal dynamical scoping only.
12230 When this is non-nil, the function `org-get-tags-at' will return the value
12231 of `org-scanner-tags' instead of building the list by itself. This
12232 can lead to large speed-ups when the tags scanner is used in a file with
12233 many entries, and when the list of tags is retrieved, for example to
12234 obtain a list of properties. Building the tags list for each entry in such
12235 a file becomes an N^2 operation - but with this variable set, it scales
12236 as N.")
12238 (defun org-scan-tags (action matcher &optional todo-only)
12239 "Scan headline tags with inheritance and produce output ACTION.
12241 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12242 or `agenda' to produce an entry list for an agenda view. It can also be
12243 a Lisp form or a function that should be called at each matched headline, in
12244 this case the return value is a list of all return values from these calls.
12246 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12247 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12248 only lines with a TODO keyword are included in the output."
12249 (require 'org-agenda)
12252 (org-re
12254 (props (list 'face 'default
12255 'done-face 'org-agenda-done
12256 'undone-face 'default
12257 'mouse-face 'highlight
12258 'org-not-done-regexp org-not-done-regexp
12259 'org-todo-regexp org-todo-regexp
12260 'help-echo
12261 (format "mouse-2 or RET jump to org file %s"
12262 (abbreviate-file-name
12263 (or (buffer-file-name (buffer-base-buffer))
12264 (buffer-name (buffer-base-buffer)))))))
12265 (case-fold-search nil)
12266 (org-map-continue-from nil)
12267 lspos tags tags-list
12268 (tags-alist (list (cons 0 org-file-tags)))
12269 (llast 0) rtn rtn1 level category i txt
12270 todo marker entry priority)
12271 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12272 (setq action (list 'lambda nil action)))
12273 (save-excursion
12274 (goto-char (point-min))
12275 (when (eq action 'sparse-tree)
12276 (org-overview)
12277 (org-remove-occur-highlights))
12278 (while (re-search-forward re nil t)
12279 (catch :skip
12280 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12281 tags (if (match-end 4) (org-match-string-no-properties 4)))
12282 (goto-char (setq lspos (match-beginning 0)))
12283 (setq level (org-reduced-level (funcall outline-level))
12284 category (org-get-category))
12285 (setq i llast llast level)
12286 ;; remove tag lists from same and sublevels
12287 (while (>= i level)
12288 (when (setq entry (assoc i tags-alist))
12289 (setq tags-alist (delete entry tags-alist)))
12290 (setq i (1- i)))
12291 ;; add the next tags
12292 (when tags
12293 (setq tags (org-split-string tags ":")
12294 tags-alist
12295 (cons (cons level tags) tags-alist)))
12296 ;; compile tags for current headline
12297 (setq tags-list
12298 (if org-use-tag-inheritance
12299 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12300 tags)
12301 org-scanner-tags tags-list)
12302 (when org-use-tag-inheritance
12303 (setcdr (car tags-alist)
12304 (mapcar (lambda (x)
12305 (setq x (copy-sequence x))
12306 (org-add-prop-inherited x))
12307 (cdar tags-alist))))
12308 (when (and tags org-use-tag-inheritance
12309 (or (not (eq t org-use-tag-inheritance))
12310 org-tags-exclude-from-inheritance))
12311 ;; selective inheritance, remove uninherited ones
12312 (setcdr (car tags-alist)
12313 (org-remove-uniherited-tags (cdar tags-alist))))
12314 (when (and (or (not todo-only)
12315 (and (member todo org-not-done-keywords)
12316 (or (not org-agenda-tags-todo-honor-ignore-options)
12317 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12318 (let ((case-fold-search t)) (eval matcher))
12319 (or
12320 (not (member org-archive-tag tags-list))
12321 ;; we have an archive tag, should we use this anyway?
12322 (or (not org-agenda-skip-archived-trees)
12323 (and (eq action 'agenda) org-agenda-archives-mode))))
12324 (unless (eq action 'sparse-tree) (org-agenda-skip))
12326 ;; select this headline
12328 (cond
12329 ((eq action 'sparse-tree)
12330 (and org-highlight-sparse-tree-matches
12331 (org-get-heading) (match-end 0)
12332 (org-highlight-new-match
12333 (match-beginning 0) (match-beginning 1)))
12334 (org-show-context 'tags-tree))
12335 ((eq action 'agenda)
12336 (setq txt (org-format-agenda-item
12337 ""
12338 (concat
12339 (if (eq org-tags-match-list-sublevels 'indented)
12340 (make-string (1- level) ?.) "")
12341 (org-get-heading))
12342 category
12343 tags-list
12344 )
12345 priority (org-get-priority txt))
12346 (goto-char lspos)
12347 (setq marker (org-agenda-new-marker))
12348 (org-add-props txt props
12349 'org-marker marker 'org-hd-marker marker 'org-category category
12350 'todo-state todo
12351 'priority priority 'type "tagsmatch")
12352 (push txt rtn))
12353 ((functionp action)
12354 (setq org-map-continue-from nil)
12355 (save-excursion
12356 (setq rtn1 (funcall action))
12357 (push rtn1 rtn)))
12358 (t (error "Invalid action")))
12360 ;; if we are to skip sublevels, jump to end of subtree
12361 (unless org-tags-match-list-sublevels
12362 (org-end-of-subtree t)
12363 (backward-char 1))))
12364 ;; Get the correct position from where to continue
12365 (if org-map-continue-from
12366 (goto-char org-map-continue-from)
12367 (and (= (point) lspos) (end-of-line 1)))))
12368 (when (and (eq action 'sparse-tree)
12369 (not org-sparse-tree-open-archived-trees))
12370 (org-hide-archived-subtrees (point-min) (point-max)))
12371 (nreverse rtn)))
12373 (defun org-remove-uniherited-tags (tags)
12374 "Remove all tags that are not inherited from the list TAGS."
12375 (cond
12376 ((eq org-use-tag-inheritance t)
12377 (if org-tags-exclude-from-inheritance
12378 (org-delete-all org-tags-exclude-from-inheritance tags)
12379 tags))
12380 ((not org-use-tag-inheritance) nil)
12381 ((stringp org-use-tag-inheritance)
12382 (delq nil (mapcar
12383 (lambda (x)
12384 (if (and (string-match org-use-tag-inheritance x)
12385 (not (member x org-tags-exclude-from-inheritance)))
12386 x nil))
12387 tags)))
12388 ((listp org-use-tag-inheritance)
12389 (delq nil (mapcar
12390 (lambda (x)
12391 (if (member x org-use-tag-inheritance) x nil))
12392 tags)))))
12394 (defvar todo-only) ;; dynamically scoped
12396 (defun org-match-sparse-tree (&optional todo-only match)
12397 "Create a sparse tree according to tags string MATCH.
12398 MATCH can contain positive and negative selection of tags, like
12400 If optional argument TODO-ONLY is non-nil, only select lines that are
12401 also TODO lines."
12402 (interactive "P")
12403 (org-prepare-agenda-buffers (list (current-buffer)))
12404 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12406 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12408 (defvar org-cached-props nil)
12409 (defun org-cached-entry-get (pom property)
12410 (if (or (eq t org-use-property-inheritance)
12411 (and (stringp org-use-property-inheritance)
12412 (string-match org-use-property-inheritance property))
12413 (and (listp org-use-property-inheritance)
12414 (member property org-use-property-inheritance)))
12415 ;; Caching is not possible, check it directly
12416 (org-entry-get pom property 'inherit)
12417 ;; Get all properties, so that we can do complicated checks easily
12418 (cdr (assoc property (or org-cached-props
12419 (setq org-cached-props
12420 (org-entry-properties pom)))))))
12422 (defun org-global-tags-completion-table (&optional files)
12423 "Return the list of all tags in all agenda buffer/files."
12424 (save-excursion
12425 (org-uniquify
12426 (delq nil
12427 (apply 'append
12428 (mapcar
12429 (lambda (file)
12430 (set-buffer (find-file-noselect file))
12431 (append (org-get-buffer-tags)
12432 (mapcar (lambda (x) (if (stringp (car-safe x))
12433 (list (car-safe x)) nil))
12434 org-tag-alist)))
12435 (if (and files (car files))
12436 files
12437 (org-agenda-files))))))))
12439 (defun org-make-tags-matcher (match)
12440 "Create the TAGS//TODO matcher form for the selection string MATCH."
12441 ;; todo-only is scoped dynamically into this function, and the function
12442 ;; may change it if the matcher asks for it.
12443 (unless match
12444 ;; Get a new match request, with completion
12445 (let ((org-last-tags-completion-table
12446 (org-global-tags-completion-table)))
12447 (setq match (org-completing-read-no-i
12448 "Match: " 'org-tags-completion-function nil nil nil
12449 'org-tags-history))))
12451 ;; Parse the string and create a lisp form
12452 (let ((match0 match)
12453 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12454 minus tag mm
12455 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12456 orterms term orlist re-p str-p level-p level-op time-p
12457 prop-p pn pv po cat-p gv rest)
12458 (if (string-match "/+" match)
12459 ;; match contains also a todo-matching request
12460 (progn
12461 (setq tagsmatch (substring match 0 (match-beginning 0))
12462 todomatch (substring match (match-end 0)))
12463 (if (string-match "^!" todomatch)
12464 (setq todo-only t todomatch (substring todomatch 1)))
12466 (setq todomatch nil)))
12467 ;; only matching tags
12468 (setq tagsmatch match todomatch nil))
12470 ;; Make the tags matcher
12472 (setq tagsmatcher t)
12473 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12474 (while (setq term (pop orterms))
12476 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12477 (while (string-match re term)
12478 (setq rest (substring term (match-end 0))
12479 minus (and (match-end 1)
12480 (equal (match-string 1 term) "-"))
12481 tag (save-match-data (replace-regexp-in-string
12483 (match-string 2 term)))
12484 re-p (equal (string-to-char tag) ?{)
12485 level-p (match-end 4)
12486 prop-p (match-end 5)
12487 mm (cond
12488 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12489 (level-p
12490 (setq level-op (org-op-to-function (match-string 3 term)))
12491 `(,level-op level ,(string-to-number
12492 (match-string 4 term))))
12493 (prop-p
12494 (setq pn (match-string 5 term)
12495 po (match-string 6 term)
12496 pv (match-string 7 term)
12497 cat-p (equal pn "CATEGORY")
12498 re-p (equal (string-to-char pv) ?{)
12500 time-p (save-match-data
12502 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12503 (if time-p (setq pv (org-matcher-time pv)))
12504 (setq po (org-op-to-function po (if time-p 'time str-p)))
12505 (cond
12506 ((equal pn "CATEGORY")
12507 (setq gv '(get-text-property (point) 'org-category)))
12508 ((equal pn "TODO")
12509 (setq gv 'todo))
12510 (t
12511 (setq gv `(org-cached-entry-get nil ,pn))))
12512 (if re-p
12513 (if (eq po 'org<>)
12514 `(not (string-match ,pv (or ,gv "")))
12515 `(string-match ,pv (or ,gv "")))
12516 (if str-p
12517 `(,po (or ,gv "") ,pv)
12518 `(,po (string-to-number (or ,gv ""))
12519 ,(string-to-number pv) ))))
12520 (t `(member ,tag tags-list)))
12521 mm (if minus (list 'not mm) mm)
12522 term rest)
12523 (push mm tagsmatcher))
12524 (push (if (> (length tagsmatcher) 1)
12525 (cons 'and tagsmatcher)
12526 (car tagsmatcher))
12527 orlist)
12528 (setq tagsmatcher nil))
12529 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12530 (setq tagsmatcher
12531 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12532 ;; Make the todo matcher
12534 (setq todomatcher t)
12535 (setq orterms (org-split-string todomatch "|") orlist nil)
12536 (while (setq term (pop orterms))
12537 (while (string-match re term)
12538 (setq minus (and (match-end 1)
12539 (equal (match-string 1 term) "-"))
12540 kwd (match-string 2 term)
12541 re-p (equal (string-to-char kwd) ?{)
12542 term (substring term (match-end 0))
12543 mm (if re-p
12544 `(string-match ,(substring kwd 1 -1) todo)
12545 (list 'equal 'todo kwd))
12546 mm (if minus (list 'not mm) mm))
12547 (push mm todomatcher))
12548 (push (if (> (length todomatcher) 1)
12549 (cons 'and todomatcher)
12550 (car todomatcher))
12551 orlist)
12552 (setq todomatcher nil))
12553 (setq todomatcher (if (> (length orlist) 1)
12554 (cons 'or orlist) (car orlist))))
12556 ;; Return the string and lisp forms of the matcher
12557 (setq matcher (if todomatcher
12558 (list 'and tagsmatcher todomatcher)
12559 tagsmatcher))
12560 (cons match0 matcher)))
12562 (defun org-op-to-function (op &optional stringp)
12563 "Turn an operator into the appropriate function."
12564 (setq op
12565 (cond
12566 ((equal op "<" ) '(< string< org-time<))
12567 ((equal op ">" ) '(> org-string> org-time>))
12568 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12569 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12570 ((member op '("=" "==")) '(= string= org-time=))
12571 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12572 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12574 (defun org<> (a b) (not (= a b)))
12575 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12576 (defun org-string>= (a b) (not (string< a b)))
12577 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12578 (defun org-string<> (a b) (not (string= a b)))
12579 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12580 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12581 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12582 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12583 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12584 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12585 (defun org-2ft (s)
12586 "Convert S to a floating point time.
12587 If S is already a number, just return it. If it is a string, parse
12588 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12589 (cond
12590 ((numberp s) s)
12591 ((stringp s)
12592 (condition-case nil
12593 (float-time (apply 'encode-time (org-parse-time-string s)))
12594 (error 0.)))
12595 (t 0.)))
12597 (defun org-time-today ()
12598 "Time in seconds today at 0:00.
12599 Returns the float number of seconds since the beginning of the
12600 epoch to the beginning of today (00:00)."
12601 (float-time (apply 'encode-time
12602 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12604 (defun org-matcher-time (s)
12605 "Interpret a time comparison value."
12606 (save-match-data
12607 (cond
12608 ((string= s "<now>") (float-time))
12609 ((string= s "<today>") (org-time-today))
12610 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12611 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12613 (+ (org-time-today)
12614 (* (string-to-number (match-string 1 s))
12615 (cdr (assoc (match-string 2 s)
12616 '(("d" . 86400.0) ("w" . 604800.0)
12617 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12618 (t (org-2ft s)))))
12620 (defun org-match-any-p (re list)
12621 "Does re match any element of list?"
12622 (setq list (mapcar (lambda (x) (string-match re x)) list))
12623 (delq nil list))
12625 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12626 (defvar org-tags-overlay (make-overlay 1 1))
12627 (org-detach-overlay org-tags-overlay)
12629 (defun org-get-local-tags-at (&optional pos)
12630 "Get a list of tags defined in the current headline."
12631 (org-get-tags-at pos 'local))
12633 (defun org-get-local-tags ()
12634 "Get a list of tags defined in the current headline."
12635 (org-get-tags-at nil 'local))
12637 (defun org-get-tags-at (&optional pos local)
12638 "Get a list of all headline tags applicable at POS.
12639 POS defaults to point. If tags are inherited, the list contains
12640 the targets in the same sequence as the headlines appear, i.e.
12641 the tags of the current headline come last.
12642 When LOCAL is non-nil, only return tags from the current headline,
12643 ignore inherited ones."
12644 (interactive)
12645 (if (and org-trust-scanner-tags
12646 (or (not pos) (equal pos (point)))
12647 (not local))
12648 org-scanner-tags
12649 (let (tags ltags lastpos parent)
12650 (save-excursion
12651 (save-restriction
12652 (widen)
12653 (goto-char (or pos (point)))
12654 (save-match-data
12655 (catch 'done
12656 (condition-case nil
12657 (progn
12658 (org-back-to-heading t)
12659 (while (not (equal lastpos (point)))
12660 (setq lastpos (point))
12661 (when (looking-at
12663 (setq ltags (org-split-string
12664 (org-match-string-no-properties 1) ":"))
12665 (when parent
12666 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12667 (setq tags (append
12668 (if parent
12669 (org-remove-uniherited-tags ltags)
12670 ltags)
12671 tags)))
12672 (or org-use-tag-inheritance (throw 'done t))
12673 (if local (throw 'done t))
12674 (or (org-up-heading-safe) (error nil))
12675 (setq parent t)))
12676 (error nil)))))
12677 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12679 (defun org-add-prop-inherited (s)
12680 (add-text-properties 0 (length s) '(inherited t) s)
12681 s)
12683 (defun org-toggle-tag (tag &optional onoff)
12684 "Toggle the tag TAG for the current line.
12685 If ONOFF is `on' or `off', don't toggle but set to this state."
12686 (let (res current)
12687 (save-excursion
12688 (org-back-to-heading t)
12690 (point-at-eol) t)
12691 (progn
12692 (setq current (match-string 1))
12693 (replace-match ""))
12694 (setq current ""))
12695 (setq current (nreverse (org-split-string current ":")))
12696 (cond
12697 ((eq onoff 'on)
12698 (setq res t)
12699 (or (member tag current) (push tag current)))
12700 ((eq onoff 'off)
12701 (or (not (member tag current)) (setq current (delete tag current))))
12702 (t (if (member tag current)
12703 (setq current (delete tag current))
12704 (setq res t)
12705 (push tag current))))
12706 (end-of-line 1)
12707 (if current
12708 (progn
12709 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12710 (org-set-tags nil t))
12711 (delete-horizontal-space))
12712 (run-hooks 'org-after-tags-change-hook))
12713 res))
12715 (defun org-align-tags-here (to-col)
12716 ;; Assumes that this is a headline
12717 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12718 (beginning-of-line 1)
12720 (< pos (match-beginning 2)))
12721 (progn
12722 (setq tags-l (- (match-end 2) (match-beginning 2)))
12723 (goto-char (match-beginning 1))
12724 (insert " ")
12725 (delete-region (point) (1+ (match-beginning 2)))
12726 (setq ncol (max (1+ (current-column))
12727 (1+ col)
12728 (if (> to-col 0)
12729 to-col
12730 (- (abs to-col) tags-l))))
12731 (setq p (point))
12732 (insert (make-string (- ncol (current-column)) ?\ ))
12733 (setq ncol (current-column))
12734 (when indent-tabs-mode (tabify p (point-at-eol)))
12735 (org-move-to-column (min ncol col) t))
12736 (goto-char pos))))
12738 (defun org-set-tags-command (&optional arg just-align)
12739 "Call the set-tags command for the current entry."
12740 (interactive "P")
12741 (if (org-on-heading-p)
12742 (org-set-tags arg just-align)
12743 (save-excursion
12744 (org-back-to-heading t)
12745 (org-set-tags arg just-align))))
12747 (defun org-set-tags-to (data)
12748 "Set the tags of the current entry to DATA, replacing the current tags.
12749 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12750 If DATA is nil or the empty string, any tags will be removed."
12751 (interactive "sTags: ")
12752 (setq data
12753 (cond
12754 ((eq data nil) "")
12755 ((equal data "") "")
12756 ((stringp data)
12757 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12758 ":"))
12759 ((listp data)
12760 (concat ":" (mapconcat 'identity data ":") ":"))
12761 (t nil)))
12762 (when data
12763 (save-excursion
12764 (org-back-to-heading t)
12765 (when (looking-at org-complex-heading-regexp)
12766 (if (match-end 5)
12767 (progn
12768 (goto-char (match-beginning 5))
12769 (insert data)
12770 (delete-region (point) (point-at-eol))
12771 (org-set-tags nil 'align))
12772 (goto-char (point-at-eol))
12773 (insert " " data)
12774 (org-set-tags nil 'align)))
12775 (beginning-of-line 1)
12777 (delete-region (match-beginning 1) (match-end 1))))))
12779 (defun org-align-all-tags ()
12780 "Align the tags i all headings."
12781 (interactive)
12782 (save-excursion
12783 (or (ignore-errors (org-back-to-heading t))
12784 (outline-next-heading))
12785 (if (org-on-heading-p)
12786 (org-set-tags t)
12787 (message "No headings"))))
12789 (defvar org-indent-indentation-per-level)
12790 (defun org-set-tags (&optional arg just-align)
12791 "Set the tags for the current headline.
12792 With prefix ARG, realign all tags in headings in the current buffer."
12793 (interactive "P")
12794 (let* ((re (concat "^" outline-regexp))
12795 (current (org-get-tags-string))
12796 (col (current-column))
12797 (org-setting-tags t)
12798 table current-tags inherited-tags ; computed below when needed
12799 tags p0 c0 c1 rpl di tc level)
12800 (if arg
12801 (save-excursion
12802 (goto-char (point-min))
12803 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12804 (while (re-search-forward re nil t)
12805 (org-set-tags nil t)
12806 (end-of-line 1)))
12807 (message "All tags realigned to column %d" org-tags-column))
12808 (if just-align
12809 (setq tags current)
12810 ;; Get a new set of tags from the user
12811 (save-excursion
12812 (setq table (append org-tag-persistent-alist
12813 (or org-tag-alist (org-get-buffer-tags))
12814 (and
12815 org-complete-tags-always-offer-all-agenda-tags
12816 (org-global-tags-completion-table
12817 (org-agenda-files))))
12818 org-last-tags-completion-table table
12819 current-tags (org-split-string current ":")
12820 inherited-tags (nreverse
12821 (nthcdr (length current-tags)
12822 (nreverse (org-get-tags-at))))
12823 tags
12824 (if (or (eq t org-use-fast-tag-selection)
12825 (and org-use-fast-tag-selection
12826 (delq nil (mapcar 'cdr table))))
12827 (org-fast-tag-selection
12828 current-tags inherited-tags table
12829 (if org-fast-tag-selection-include-todo
12830 org-todo-key-alist))
12831 (let ((org-add-colon-after-tag-completion t))
12832 (org-trim
12833 (org-without-partial-completion
12834 (org-icompleting-read "Tags: "
12835 'org-tags-completion-function
12836 nil nil current 'org-tags-history)))))))
12837 (while (string-match "[-+&]+" tags)
12838 ;; No boolean logic, just a list
12839 (setq tags (replace-match ":" t t tags))))
12841 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12843 (if org-tags-sort-function
12844 (setq tags (mapconcat 'identity
12845 (sort (org-split-string
12846 tags (org-re "[^[:alnum:]_@#%]+"))
12847 org-tags-sort-function) ":")))
12850 (setq tags "")
12851 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12852 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12854 ;; Insert new tags at the correct column
12855 (beginning-of-line 1)
12856 (setq level (or (and (looking-at org-outline-regexp)
12857 (- (match-end 0) (point) 1))
12858 1))
12859 (cond
12860 ((and (equal current "") (equal tags "")))
12861 ((re-search-forward
12863 (point-at-eol) t)
12864 (if (equal tags "")
12865 (setq rpl "")
12866 (goto-char (match-beginning 0))
12867 (setq c0 (current-column)
12868 ;; compute offset for the case of org-indent-mode active
12869 di (if org-indent-mode
12870 (* (1- org-indent-indentation-per-level) (1- level))
12871 0)
12872 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12873 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12874 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12875 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12876 (replace-match rpl t t)
12877 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12878 tags)
12879 (t (error "Tags alignment failed")))
12880 (org-move-to-column col)
12881 (unless just-align
12882 (run-hooks 'org-after-tags-change-hook)))))
12884 (defun org-change-tag-in-region (beg end tag off)
12885 "Add or remove TAG for each entry in the region.
12886 This works in the agenda, and also in an org-mode buffer."
12887 (interactive
12888 (list (region-beginning) (region-end)
12889 (let ((org-last-tags-completion-table
12890 (if (org-mode-p)
12891 (org-get-buffer-tags)
12892 (org-global-tags-completion-table))))
12893 (org-icompleting-read
12894 "Tag: " 'org-tags-completion-function nil nil nil
12895 'org-tags-history))
12896 (progn
12898 (equal (read-char-exclusive) ?r))))
12899 (if (fboundp 'deactivate-mark) (deactivate-mark))
12900 (let ((agendap (equal major-mode 'org-agenda-mode))
12901 l1 l2 m buf pos newhead (cnt 0))
12902 (goto-char end)
12903 (setq l2 (1- (org-current-line)))
12904 (goto-char beg)
12905 (setq l1 (org-current-line))
12906 (loop for l from l1 to l2 do
12907 (org-goto-line l)
12908 (setq m (get-text-property (point) 'org-hd-marker))
12909 (when (or (and (org-mode-p) (org-on-heading-p))
12910 (and agendap m))
12911 (setq buf (if agendap (marker-buffer m) (current-buffer))
12912 pos (if agendap m (point)))
12913 (with-current-buffer buf
12914 (save-excursion
12915 (save-restriction
12916 (goto-char pos)
12917 (setq cnt (1+ cnt))
12918 (org-toggle-tag tag (if off 'off 'on))
12919 (setq newhead (org-get-heading)))))
12920 (and agendap (org-agenda-change-all-lines newhead m))))
12921 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12923 (defun org-tags-completion-function (string predicate &optional flag)
12924 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12925 (confirm (lambda (x) (stringp (car x)))))
12927 (setq s1 (match-string 1 string)
12928 s2 (match-string 2 string))
12929 (setq s1 "" s2 string))
12930 (cond
12931 ((eq flag nil)
12932 ;; try completion
12933 (setq rtn (try-completion s2 ctable confirm))
12934 (if (stringp rtn)
12935 (setq rtn
12936 (concat s1 s2 (substring rtn (length s2))
12937 (if (and org-add-colon-after-tag-completion
12938 (assoc rtn ctable))
12939 ":" ""))))
12940 rtn)
12941 ((eq flag t)
12942 ;; all-completions
12943 (all-completions s2 ctable confirm)
12944 )
12945 ((eq flag 'lambda)
12946 ;; exact match?
12947 (assoc s2 ctable)))
12948 ))
12950 (defun org-fast-tag-insert (kwd tags face &optional end)
12951 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12952 (insert (format "%-12s" (concat kwd ":"))
12953 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12954 (or end "")))
12956 (defun org-fast-tag-show-exit (flag)
12957 (save-excursion
12958 (org-goto-line 3)
12960 (replace-match ""))
12961 (when flag
12962 (end-of-line 1)
12963 (org-move-to-column (- (window-width) 19) t)
12964 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12966 (defun org-set-current-tags-overlay (current prefix)
12967 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12968 (if (featurep 'xemacs)
12969 (org-overlay-display org-tags-overlay (concat prefix s)
12970 'secondary-selection)
12971 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12972 (org-overlay-display org-tags-overlay (concat prefix s)))))
12974 (defvar org-last-tag-selection-key nil)
12975 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12976 "Fast tag selection with single keys.
12977 CURRENT is the current list of tags in the headline, INHERITED is the
12978 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12979 possibly with grouping information. TODO-TABLE is a similar table with
12980 TODO keywords, should these have keys assigned to them.
12981 If the keys are nil, a-z are automatically assigned.
12982 Returns the new tags string, or nil to not change the current settings."
12983 (let* ((fulltable (append table todo-table))
12984 (maxlen (apply 'max (mapcar
12985 (lambda (x)
12986 (if (stringp (car x)) (string-width (car x)) 0))
12987 fulltable)))
12988 (buf (current-buffer))
12989 (expert (eq org-fast-tag-selection-single-key 'expert))
12990 (buffer-tags nil)
12991 (fwidth (+ maxlen 3 1 3))
12992 (ncol (/ (- (window-width) 4) fwidth))
12993 (i-face 'org-done)
12994 (c-face 'org-todo)
12995 tg cnt e c char c1 c2 ntable tbl rtn
12996 ov-start ov-end ov-prefix
12997 (exit-after-next org-fast-tag-selection-single-key)
12998 (done-keywords org-done-keywords)
12999 groups ingroup)
13000 (save-excursion
13001 (beginning-of-line 1)
13002 (if (looking-at
13004 (setq ov-start (match-beginning 1)
13005 ov-end (match-end 1)
13006 ov-prefix "")
13007 (setq ov-start (1- (point-at-eol))
13008 ov-end (1+ ov-start))
13010 (setq ov-prefix
13011 (concat
13012 (buffer-substring (1- (point)) (point))
13013 (if (> (current-column) org-tags-column)
13014 " "
13015 (make-string (- org-tags-column (current-column)) ?\ ))))))
13016 (move-overlay org-tags-overlay ov-start ov-end)
13017 (save-window-excursion
13018 (if expert
13019 (set-buffer (get-buffer-create " *Org tags*"))
13020 (delete-other-windows)
13021 (split-window-vertically)
13022 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13023 (erase-buffer)
13024 (org-set-local 'org-done-keywords done-keywords)
13027 (org-fast-tag-show-exit exit-after-next)
13028 (org-set-current-tags-overlay current ov-prefix)
13029 (setq tbl fulltable char ?a cnt 0)
13030 (while (setq e (pop tbl))
13031 (cond
13032 ((equal (car e) :startgroup)
13033 (push '() groups) (setq ingroup t)
13034 (when (not (= cnt 0))
13035 (setq cnt 0)
13037 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13038 ((equal (car e) :endgroup)
13039 (setq ingroup nil cnt 0)
13041 ((equal e '(:newline))
13042 (when (not (= cnt 0))
13043 (setq cnt 0)
13045 (setq e (car tbl))
13046 (while (equal (car tbl) '(:newline))
13048 (setq tbl (cdr tbl)))))
13049 (t
13050 (setq tg (copy-sequence (car e)) c2 nil)
13051 (if (cdr e)
13052 (setq c (cdr e))
13053 ;; automatically assign a character.
13054 (setq c1 (string-to-char
13055 (downcase (substring
13056 tg (if (= (string-to-char tg) ?@) 1 0)))))
13057 (if (or (rassoc c1 ntable) (rassoc c1 table))
13058 (while (or (rassoc char ntable) (rassoc char table))
13059 (setq char (1+ char)))
13060 (setq c2 c1))
13061 (setq c (or c2 char)))
13062 (if ingroup (push tg (car groups)))
13063 (setq tg (org-add-props tg nil 'face
13064 (cond
13065 ((not (assoc tg table))
13066 (org-get-todo-face tg))
13067 ((member tg current) c-face)
13068 ((member tg inherited) i-face)
13069 (t nil))))
13070 (if (and (= cnt 0) (not ingroup)) (insert " "))
13071 (insert "[" c "] " tg (make-string
13072 (- fwidth 4 (length tg)) ?\ ))
13073 (push (cons tg c) ntable)
13074 (when (= (setq cnt (1+ cnt)) ncol)
13076 (if ingroup (insert " "))
13077 (setq cnt 0)))))
13078 (setq ntable (nreverse ntable))
13080 (goto-char (point-min))
13081 (if (not expert) (org-fit-window-to-buffer))
13082 (setq rtn
13083 (catch 'exit
13084 (while t
13085 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13086 (if (not groups) "no " "")
13087 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13088 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13089 (setq org-last-tag-selection-key c)
13090 (cond
13092 ((= c ?!)
13093 (setq groups (not groups))
13094 (goto-char (point-min))
13095 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13096 ((= c ?\C-c)
13097 (if (not expert)
13098 (org-fast-tag-show-exit
13099 (setq exit-after-next (not exit-after-next)))
13100 (setq expert nil)
13101 (delete-other-windows)
13102 (split-window-vertically)
13103 (org-switch-to-buffer-other-window " *Org tags*")
13104 (org-fit-window-to-buffer)))
13105 ((or (= c ?\C-g)
13106 (and (= c ?q) (not (rassoc c ntable))))
13107 (org-detach-overlay org-tags-overlay)
13108 (setq quit-flag t))
13109 ((= c ?\ )
13110 (setq current nil)
13111 (if exit-after-next (setq exit-after-next 'now)))
13113 (condition-case nil
13114 (setq tg (org-icompleting-read
13115 "Tag: "
13116 (or buffer-tags
13117 (with-current-buffer buf
13118 (org-get-buffer-tags)))))
13119 (quit (setq tg "")))
13121 (add-to-list 'buffer-tags (list tg))
13122 (if (member tg current)
13123 (setq current (delete tg current))
13124 (push tg current)))
13125 (if exit-after-next (setq exit-after-next 'now)))
13126 ((setq e (rassoc c todo-table) tg (car e))
13127 (with-current-buffer buf
13128 (save-excursion (org-todo tg)))
13129 (if exit-after-next (setq exit-after-next 'now)))
13130 ((setq e (rassoc c ntable) tg (car e))
13131 (if (member tg current)
13132 (setq current (delete tg current))
13133 (loop for g in groups do
13134 (if (member tg g)
13135 (mapc (lambda (x)
13136 (setq current (delete x current)))
13137 g)))
13138 (push tg current))
13139 (if exit-after-next (setq exit-after-next 'now))))
13141 ;; Create a sorted list
13142 (setq current
13143 (sort current
13144 (lambda (a b)
13145 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13146 (if (eq exit-after-next 'now) (throw 'exit t))
13147 (goto-char (point-min))
13148 (beginning-of-line 2)
13149 (delete-region (point) (point-at-eol))
13150 (org-fast-tag-insert "Current" current c-face)
13151 (org-set-current-tags-overlay current ov-prefix)
13152 (while (re-search-forward
13154 (setq tg (match-string 1))
13155 (add-text-properties
13156 (match-beginning 1) (match-end 1)
13157 (list 'face
13158 (cond
13159 ((member tg current) c-face)
13160 ((member tg inherited) i-face)
13161 (t (get-text-property (match-beginning 1) 'face))))))
13162 (goto-char (point-min)))))
13163 (org-detach-overlay org-tags-overlay)
13164 (if rtn
13165 (mapconcat 'identity current ":")
13166 nil))))
13168 (defun org-get-tags-string ()
13169 "Get the TAGS string in the current headline."
13170 (unless (org-on-heading-p t)
13171 (error "Not on a heading"))
13172 (save-excursion
13173 (beginning-of-line 1)
13175 (org-match-string-no-properties 1)
13176 "")))
13178 (defun org-get-tags ()
13179 "Get the list of tags specified in the current headline."
13180 (org-split-string (org-get-tags-string) ":"))
13182 (defun org-get-buffer-tags ()
13183 "Get a table of all tags used in the buffer, for completion."
13184 (let (tags)
13185 (save-excursion
13186 (goto-char (point-min))
13187 (while (re-search-forward
13189 (when (equal (char-after (point-at-bol 0)) ?*)
13190 (mapc (lambda (x) (add-to-list 'tags x))
13191 (org-split-string (org-match-string-no-properties 1) ":")))))
13192 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13193 (mapcar 'list tags)))
13195 ;;;; The mapping API
13197 ;;;###autoload
13198 (defun org-map-entries (func &optional match scope &rest skip)
13199 "Call FUNC at each headline selected by MATCH in SCOPE.
13201 FUNC is a function or a lisp form. The function will be called without
13202 arguments, with the cursor positioned at the beginning of the headline.
13203 The return values of all calls to the function will be collected and
13204 returned as a list.
13206 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13207 does not need to preserve point. After evaluation, the cursor will be
13208 moved to the end of the line (presumably of the headline of the
13209 processed entry) and search continues from there. Under some
13210 circumstances, this may not produce the wanted results. For example,
13211 if you have removed (e.g. archived) the current (sub)tree it could
13212 mean that the next entry will be skipped entirely. In such cases, you
13213 can specify the position from where search should continue by making
13214 FUNC set the variable `org-map-continue-from' to the desired buffer
13215 position.
13217 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13218 Only headlines that are matched by this query will be considered during
13219 the iteration. When MATCH is nil or t, all headlines will be
13220 visited by the iteration.
13222 SCOPE determines the scope of this command. It can be any of:
13224 nil The current buffer, respecting the restriction if any
13225 tree The subtree started with the entry at point
13226 file The current buffer, without restriction
13227 file-with-archives
13228 The current buffer, and any archives associated with it
13229 agenda All agenda files
13230 agenda-with-archives
13231 All agenda files with any archive files associated with them
13232 \(file1 file2 ...)
13233 If this is a list, all files in the list will be scanned
13235 The remaining args are treated as settings for the skipping facilities of
13236 the scanner. The following items can be given here:
13238 archive skip trees with the archive tag.
13239 comment skip trees with the COMMENT keyword
13240 function or Emacs Lisp form:
13241 will be used as value for `org-agenda-skip-function', so whenever
13242 the function returns t, FUNC will not be called for that
13243 entry and search will continue from the point where the
13244 function leaves it.
13246 If your function needs to retrieve the tags including inherited tags
13247 at the *current* entry, you can use the value of the variable
13248 `org-scanner-tags' which will be much faster than getting the value
13249 with `org-get-tags-at'. If your function gets properties with
13250 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13251 to t around the call to `org-entry-properties' to get the same speedup.
13252 Note that if your function moves around to retrieve tags and properties at
13253 a *different* entry, you cannot use these techniques."
13254 (let* ((org-agenda-archives-mode nil) ; just to make sure
13255 (org-agenda-skip-archived-trees (memq 'archive skip))
13256 (org-agenda-skip-comment-trees (memq 'comment skip))
13257 (org-agenda-skip-function
13258 (car (org-delete-all '(comment archive) skip)))
13259 (org-tags-match-list-sublevels t)
13260 matcher file res
13261 org-todo-keywords-for-agenda
13262 org-done-keywords-for-agenda
13263 org-todo-keyword-alist-for-agenda
13264 org-drawers-for-agenda
13265 org-tag-alist-for-agenda)
13267 (cond
13268 ((eq match t) (setq matcher t))
13269 ((eq match nil) (setq matcher t))
13270 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13272 (save-excursion
13273 (save-restriction
13274 (when (eq scope 'tree)
13275 (org-back-to-heading t)
13276 (org-narrow-to-subtree)
13277 (setq scope nil))
13279 (if (not scope)
13280 (progn
13281 (org-prepare-agenda-buffers
13282 (list (buffer-file-name (current-buffer))))
13283 (setq res (org-scan-tags func matcher)))
13284 ;; Get the right scope
13285 (cond
13286 ((and scope (listp scope) (symbolp (car scope)))
13287 (setq scope (eval scope)))
13288 ((eq scope 'agenda)
13289 (setq scope (org-agenda-files t)))
13290 ((eq scope 'agenda-with-archives)
13291 (setq scope (org-agenda-files t))
13292 (setq scope (org-add-archive-files scope)))
13293 ((eq scope 'file)
13294 (setq scope (list (buffer-file-name))))
13295 ((eq scope 'file-with-archives)
13296 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13297 (org-prepare-agenda-buffers scope)
13298 (while (setq file (pop scope))
13299 (with-current-buffer (org-find-base-buffer-visiting file)
13300 (save-excursion
13301 (save-restriction
13302 (widen)
13303 (goto-char (point-min))
13304 (setq res (append res (org-scan-tags func matcher))))))))))
13305 res))
13307 ;;;; Properties
13309 ;;; Setting and retrieving properties
13311 (defconst org-special-properties
13312 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13313 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13314 "The special properties valid in Org-mode.
13316 These are properties that are not defined in the property drawer,
13317 but in some other way.")
13319 (defconst org-default-properties
13320 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13321 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13322 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13323 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13324 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13325 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13326 "Some properties that are used by Org-mode for various purposes.
13327 Being in this list makes sure that they are offered for completion.")
13330 "Regular expression matching the first line of a property drawer.")
13333 "Regular expression matching the last line of a property drawer.")
13336 "Regular expression matching the first line of a property drawer.")
13339 "Regular expression matching the first line of a property drawer.")
13341 (defconst org-property-drawer-re
13344 "Matches an entire property drawer.")
13346 (defconst org-clock-drawer-re
13349 "Matches an entire clock drawer.")
13351 (defun org-property-action ()
13352 "Do an action on properties."
13353 (interactive)
13354 (let (c)
13355 (org-at-property-p)
13356 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13357 (setq c (read-char-exclusive))
13358 (cond
13359 ((equal c ?s)
13360 (call-interactively 'org-set-property))
13361 ((equal c ?d)
13362 (call-interactively 'org-delete-property))
13363 ((equal c ?D)
13364 (call-interactively 'org-delete-property-globally))
13365 ((equal c ?c)
13366 (call-interactively 'org-compute-property-at-point))
13367 (t (error "No such property action %c" c)))))
13369 (defun org-set-effort (&optional value)
13370 "Set the effort property of the current entry.
13371 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13372 allowed value."
13373 (interactive "P")
13374 (if (equal value 0) (setq value 10))
13375 (let* ((completion-ignore-case t)
13376 (prop org-effort-property)
13377 (cur (org-entry-get nil prop))
13378 (allowed (org-property-get-allowed-values nil prop 'table))
13379 (existing (mapcar 'list (org-property-values prop)))
13380 rpl
13381 (val (cond
13382 ((stringp value) value)
13383 ((and allowed (integerp value))
13384 (or (car (nth (1- value) allowed))
13385 (car (org-last allowed))))
13386 (allowed
13387 (message "Select 1-9,0, [RET%s]: %s"
13388 (if cur (concat "=" cur) "")
13389 (mapconcat 'car allowed " "))
13390 (setq rpl (read-char-exclusive))
13392 cur
13393 (setq rpl (- rpl ?0))
13394 (if (equal rpl 0) (setq rpl 10))
13395 (if (and (> rpl 0) (<= rpl (length allowed)))
13396 (car (nth (1- rpl) allowed))
13397 (org-completing-read "Effort: " allowed nil))))
13398 (t
13399 (let (org-completion-use-ido org-completion-use-iswitchb)
13400 (org-completing-read
13402 (concat "[" cur "]") "")
13403 ": ")
13404 existing nil nil "" nil cur))))))
13405 (unless (equal (org-entry-get nil prop) val)
13406 (org-entry-put nil prop val))
13407 (message "%s is now %s" prop val)))
13409 (defun org-at-property-p ()
13410 "Is cursor inside a property drawer?"
13411 (save-excursion
13412 (beginning-of-line 1)
13414 (save-match-data ;; Used by calling procedures
13415 (let ((p (point))
13416 (range (unless (org-before-first-heading-p)
13417 (org-get-property-block))))
13418 (and range (<= (car range) p) (< p (cdr range))))))))
13420 (defun org-get-property-block (&optional beg end force)
13421 "Return the (beg . end) range of the body of the property drawer.
13422 BEG and END can be beginning and end of subtree, if not given
13423 they will be found.
13424 If the drawer does not exist and FORCE is non-nil, create the drawer."
13425 (catch 'exit
13426 (save-excursion
13427 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13428 (end (or end (progn (outline-next-heading) (point)))))
13429 (goto-char beg)
13430 (if (re-search-forward org-property-start-re end t)
13431 (setq beg (1+ (match-end 0)))
13432 (if force
13433 (save-excursion
13434 (org-insert-property-drawer)
13435 (setq end (progn (outline-next-heading) (point))))
13436 (throw 'exit nil))
13437 (goto-char beg)
13438 (if (re-search-forward org-property-start-re end t)
13439 (setq beg (1+ (match-end 0)))))
13440 (if (re-search-forward org-property-end-re end t)
13441 (setq end (match-beginning 0))
13442 (or force (throw 'exit nil))
13443 (goto-char beg)
13444 (setq end beg)
13445 (org-indent-line-function)
13447 (cons beg end)))))
13449 (defun org-entry-properties (&optional pom which specific)
13450 "Get all properties of the entry at point-or-marker POM.
13451 This includes the TODO keyword, the tags, time strings for deadline,
13452 scheduled, and clocking, and any additional properties defined in the
13453 entry. The return value is an alist, keys may occur multiple times
13454 if the property key was used several times.
13455 POM may also be nil, in which case the current entry is used.
13456 If WHICH is nil or `all', get all properties. If WHICH is
13457 `special' or `standard', only get that subclass. If WHICH
13458 is a string only get exactly this property. Specific can be a string, the
13459 specific property we are interested in. Specifying it can speed
13460 things up because then unnecessary parsing is avoided."
13461 (setq which (or which 'all))
13462 (org-with-point-at pom
13463 (let ((clockstr (substring org-clock-string 0 -1))
13464 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13465 (case-fold-search nil)
13466 beg end range props sum-props key key1 value string clocksum)
13467 (save-excursion
13468 (when (condition-case nil
13469 (and (org-mode-p) (org-back-to-heading t))
13470 (error nil))
13471 (setq beg (point))
13472 (setq sum-props (get-text-property (point) 'org-summaries))
13473 (setq clocksum (get-text-property (point) :org-clock-minutes))
13474 (outline-next-heading)
13475 (setq end (point))
13476 (when (memq which '(all special))
13477 ;; Get the special properties, like TODO and tags
13478 (goto-char beg)
13479 (when (and (or (not specific) (string= specific "TODO"))
13480 (looking-at org-todo-line-regexp) (match-end 2))
13481 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13482 (when (and (or (not specific) (string= specific "PRIORITY"))
13483 (looking-at org-priority-regexp))
13484 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13485 (when (and (or (not specific) (string= specific "TAGS"))
13486 (setq value (org-get-tags-string))
13488 (push (cons "TAGS" value) props))
13489 (when (and (or (not specific) (string= specific "ALLTAGS"))
13490 (setq value (org-get-tags-at)))
13491 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13492 ":"))
13493 props))
13494 (when (or (not specific) (string= specific "BLOCKED"))
13495 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13496 (when (or (not specific)
13497 (member specific
13498 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13499 "TIMESTAMP" "TIMESTAMP_IA")))
13500 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13501 (setq key (if (match-end 1)
13502 (substring (org-match-string-no-properties 1)
13503 0 -1))
13504 string (if (equal key clockstr)
13505 (org-no-properties
13506 (org-trim
13507 (buffer-substring
13508 (match-beginning 3) (goto-char
13509 (point-at-eol)))))
13510 (substring (org-match-string-no-properties 3)
13511 1 -1)))
13512 ;; Get the correct property name from the key. This is
13513 ;; necessary if the user has configured time keywords.
13514 (setq key1 (concat key ":"))
13515 (cond
13516 ((not key)
13517 (setq key
13518 (if (= (char-after (match-beginning 3)) ?\[)
13519 "TIMESTAMP_IA" "TIMESTAMP")))
13520 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13521 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13522 ((equal key1 org-closed-string) (setq key "CLOSED"))
13523 ((equal key1 org-clock-string) (setq key "CLOCK")))
13524 (when (or (equal key "CLOCK") (not (assoc key props)))
13525 (push (cons key string) props))))
13526 )
13528 (when (memq which '(all standard))
13529 ;; Get the standard properties, like :PROP: ...
13530 (setq range (org-get-property-block beg end))
13531 (when range
13532 (goto-char (car range))
13533 (while (re-search-forward
13535 (cdr range) t)
13536 (setq key (org-match-string-no-properties 1)
13537 value (org-trim (or (org-match-string-no-properties 2) "")))
13538 (unless (member key excluded)
13539 (push (cons key (or value "")) props)))))
13540 (if clocksum
13541 (push (cons "CLOCKSUM"
13542 (org-columns-number-to-string (/ (float clocksum) 60.)
13543 'add_times))
13544 props))
13545 (unless (assoc "CATEGORY" props)
13546 (setq value (or (org-get-category)
13547 (progn (org-refresh-category-properties)
13548 (org-get-category))))
13549 (push (cons "CATEGORY" value) props))
13550 (append sum-props (nreverse props)))))))
13552 (defun org-entry-get (pom property &optional inherit literal-nil)
13553 "Get value of PROPERTY for entry at point-or-marker POM.
13554 If INHERIT is non-nil and the entry does not have the property,
13555 then also check higher levels of the hierarchy.
13556 If INHERIT is the symbol `selective', use inheritance only if the setting
13557 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13558 If the property is present but empty, the return value is the empty string.
13559 If the property is not present at all, nil is returned.
13562 do not interpret it as the list atom nil. This is used for inheritance
13564 (org-with-point-at pom
13565 (if (and inherit (if (eq inherit 'selective)
13566 (org-property-inherit-p property)
13567 t))
13568 (org-entry-get-with-inheritance property literal-nil)
13569 (if (member property org-special-properties)
13570 ;; We need a special property. Use `org-entry-properties' to
13571 ;; retrieve it, but specify the wanted property
13572 (cdr (assoc property (org-entry-properties nil 'special property)))
13573 (let ((range (org-get-property-block)))
13574 (if (and range
13575 (goto-char (car range))
13576 (re-search-forward
13578 (cdr range) t))
13579 ;; Found the property, return it.
13580 (if (match-end 1)
13581 (if literal-nil
13582 (org-match-string-no-properties 1)
13583 (org-not-nil (org-match-string-no-properties 1)))
13584 "")))))))
13586 (defun org-property-or-variable-value (var &optional inherit)
13587 "Check if there is a property fixing the value of VAR.
13588 If yes, return this value. If not, return the current value of the variable."
13589 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13591 (read prop)
13592 (symbol-value var))))
13594 (defun org-entry-delete (pom property)
13595 "Delete the property PROPERTY from entry at point-or-marker POM."
13596 (org-with-point-at pom
13597 (if (member property org-special-properties)
13598 nil ; cannot delete these properties.
13599 (let ((range (org-get-property-block)))
13600 (if (and range
13601 (goto-char (car range))
13602 (re-search-forward
13604 (cdr range) t))
13605 (progn
13606 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13607 t)
13608 nil)))))
13610 ;; Multi-values properties are properties that contain multiple values
13611 ;; These values are assumed to be single words, separated by whitespace.
13612 (defun org-entry-add-to-multivalued-property (pom property value)
13613 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13614 (let* ((old (org-entry-get pom property))
13616 (setq value (org-entry-protect-space value))
13617 (unless (member value values)
13618 (setq values (cons value values))
13619 (org-entry-put pom property
13620 (mapconcat 'identity values " ")))))
13622 (defun org-entry-remove-from-multivalued-property (pom property value)
13623 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13624 (let* ((old (org-entry-get pom property))
13626 (setq value (org-entry-protect-space value))
13627 (when (member value values)
13628 (setq values (delete value values))
13629 (org-entry-put pom property
13630 (mapconcat 'identity values " ")))))
13632 (defun org-entry-member-in-multivalued-property (pom property value)
13633 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13634 (let* ((old (org-entry-get pom property))
13636 (setq value (org-entry-protect-space value))
13637 (member value values)))
13639 (defun org-entry-get-multivalued-property (pom property)
13640 "Return a list of values in a multivalued property."
13641 (let* ((value (org-entry-get pom property))
13643 (mapcar 'org-entry-restore-space values)))
13645 (defun org-entry-put-multivalued-property (pom property &rest values)
13646 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13647 VALUES should be a list of strings. Spaces will be protected."
13648 (org-entry-put pom property
13649 (mapconcat 'org-entry-protect-space values " "))
13650 (let* ((value (org-entry-get pom property))
13652 (mapcar 'org-entry-restore-space values)))
13654 (defun org-entry-protect-space (s)
13655 "Protect spaces and newline in string S."
13656 (while (string-match " " s)
13657 (setq s (replace-match "%20" t t s)))
13659 (setq s (replace-match "%0A" t t s)))
13660 s)
13662 (defun org-entry-restore-space (s)
13663 "Restore spaces and newline in string S."
13664 (while (string-match "%20" s)
13665 (setq s (replace-match " " t t s)))
13666 (while (string-match "%0A" s)
13668 s)
13670 (defvar org-entry-property-inherited-from (make-marker)
13671 "Marker pointing to the entry from where a property was inherited.
13672 Each call to `org-entry-get-with-inheritance' will set this marker to the
13673 location of the entry where the inheritance search matched. If there was
13674 no match, the marker will point nowhere.
13675 Note that also `org-entry-get' calls this function, if the INHERIT flag
13676 is set.")
13678 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13679 "Get entry property, and search higher levels if not present.
13680 The search will stop at the first ancestor which has the property defined.
13682 should be considered as undefined (this is the meaning of nil here).
13684 (move-marker org-entry-property-inherited-from nil)
13685 (let (tmp)
13686 (save-excursion
13687 (save-restriction
13688 (widen)
13689 (catch 'ex
13690 (while t
13691 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13692 (org-back-to-heading t)
13693 (move-marker org-entry-property-inherited-from (point))
13694 (throw 'ex tmp))
13695 (or (org-up-heading-safe) (throw 'ex nil)))))
13696 (setq tmp (or tmp
13697 (cdr (assoc property org-file-properties))
13698 (cdr (assoc property org-global-properties))
13699 (cdr (assoc property org-global-properties-fixed))))
13700 (if literal-nil tmp (org-not-nil tmp)))))
13702 (defvar org-property-changed-functions nil
13703 "Hook called when the value of a property has changed.
13704 Each hook function should accept two arguments, the name of the property
13705 and the new value.")
13707 (defun org-entry-put (pom property value)
13708 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13709 (org-with-point-at pom
13710 (org-back-to-heading t)
13711 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13712 range)
13713 (cond
13714 ((equal property "TODO")
13716 (not (member value org-todo-keywords-1)))
13718 (if (or (not value)
13720 (setq value 'none))
13721 (org-todo value)
13722 (org-set-tags nil 'align))
13723 ((equal property "PRIORITY")
13725 (string-to-char value) ?\ ))
13726 (org-set-tags nil 'align))
13727 ((equal property "SCHEDULED")
13728 (if (re-search-forward org-scheduled-time-regexp end t)
13729 (cond
13730 ((eq value 'earlier) (org-timestamp-change -1 'day))
13731 ((eq value 'later) (org-timestamp-change 1 'day))
13732 (t (call-interactively 'org-schedule)))
13733 (call-interactively 'org-schedule)))
13734 ((equal property "DEADLINE")
13735 (if (re-search-forward org-deadline-time-regexp end t)
13736 (cond
13737 ((eq value 'earlier) (org-timestamp-change -1 'day))
13738 ((eq value 'later) (org-timestamp-change 1 'day))
13739 (t (call-interactively 'org-deadline)))
13740 (call-interactively 'org-deadline)))
13741 ((member property org-special-properties)
13742 (error "The %s property can not yet be set with `org-entry-put'"
13743 property))
13744 (t ; a non-special property
13745 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13746 (setq range (org-get-property-block beg end 'force))
13747 (goto-char (car range))
13748 (if (re-search-forward
13750 (progn
13751 (delete-region (match-beginning 1) (match-end 1))
13752 (goto-char (match-beginning 1)))
13753 (goto-char (cdr range))
13755 (backward-char 1)
13756 (org-indent-line-function)
13757 (insert ":" property ":"))
13758 (and value (insert " " value))
13759 (org-indent-line-function)))))
13760 (run-hook-with-args 'org-property-changed-functions property value)))
13762 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13763 "Get all property keys in the current buffer.
13764 With INCLUDE-SPECIALS, also list the special properties that reflect things
13765 like tags and TODO state.
13766 With INCLUDE-DEFAULTS, also include properties that has special meaning
13767 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13768 With INCLUDE-COLUMNS, also include property names given in COLUMN
13769 formats in the current buffer."
13770 (let (rtn range cfmt s p)
13771 (save-excursion
13772 (save-restriction
13773 (widen)
13774 (goto-char (point-min))
13775 (while (re-search-forward org-property-start-re nil t)
13776 (setq range (org-get-property-block))
13777 (goto-char (car range))
13778 (while (re-search-forward
13780 (cdr range) t)
13781 (add-to-list 'rtn (org-match-string-no-properties 1)))
13782 (outline-next-heading))))
13784 (when include-specials
13785 (setq rtn (append org-special-properties rtn)))
13787 (when include-defaults
13788 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13789 (add-to-list 'rtn org-effort-property))
13791 (when include-columns
13792 (save-excursion
13793 (save-restriction
13794 (widen)
13795 (goto-char (point-min))
13796 (while (re-search-forward
13798 nil t)
13799 (setq cfmt (match-string 2) s 0)
13801 cfmt s)
13802 (setq s (match-end 0)
13803 p (match-string 1 cfmt))
13804 (unless (or (equal p "ITEM")
13805 (member p org-special-properties))
13806 (add-to-list 'rtn (match-string 1 cfmt))))))))
13808 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13810 (defun org-property-values (key)
13811 "Return a list of all values of property KEY."
13812 (save-excursion
13813 (save-restriction
13814 (widen)
13815 (goto-char (point-min))
13817 values)
13818 (while (re-search-forward re nil t)
13819 (add-to-list 'values (org-trim (match-string 1))))
13820 (delete "" values)))))
13822 (defun org-insert-property-drawer ()
13823 "Insert a property drawer into the current entry."
13824 (interactive)
13825 (org-back-to-heading t)
13826 (looking-at outline-regexp)
13827 (let ((indent (if org-adapt-indentation
13828 (- (match-end 0)(match-beginning 0))
13829 0))
13830 (beg (point))
13832 end hiddenp)
13833 (outline-next-heading)
13834 (setq end (point))
13835 (goto-char beg)
13836 (while (re-search-forward re end t))
13837 (setq hiddenp (org-invisible-p))
13838 (end-of-line 1)
13841 (if (member (match-string 1) '("CLOCK:" ":END:"))
13842 ;; just skip this line
13843 (beginning-of-line 2)
13844 ;; Drawer start, find the end
13846 (beginning-of-line 1)))
13847 (org-skip-over-state-notes)
13849 (if (eq (char-before) ?*) (forward-char 1))
13851 (beginning-of-line 0)
13852 (org-indent-to-column indent)
13853 (beginning-of-line 2)
13854 (org-indent-to-column indent)
13855 (beginning-of-line 0)
13856 (if hiddenp
13857 (save-excursion
13858 (org-back-to-heading t)
13859 (hide-entry))
13860 (org-flag-drawer t))))
13862 (defun org-set-property (property value)
13863 "In the current entry, set PROPERTY to VALUE.
13864 When called interactively, this will prompt for a property name, offering
13865 completion on existing and default properties. And then it will prompt
13866 for a value, offering completion either on allowed values (via an inherited
13867 xxx_ALL property) or on existing values in other instances of this property
13868 in the current file."
13869 (interactive
13870 (let* ((completion-ignore-case t)
13871 (keys (org-buffer-property-keys nil t t))
13872 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13873 (prop (if (member prop0 keys)
13874 prop0
13875 (or (cdr (assoc (downcase prop0)
13876 (mapcar (lambda (x) (cons (downcase x) x))
13877 keys)))
13878 prop0)))
13879 (cur (org-entry-get nil prop))
13880 (prompt (concat prop " value"
13882 (concat " [" cur "]") "") ": "))
13883 (allowed (org-property-get-allowed-values nil prop 'table))
13884 (existing (mapcar 'list (org-property-values prop)))
13885 (val (if allowed
13886 (org-completing-read prompt allowed nil
13887 (not (get-text-property 0 'org-unrestricted
13888 (caar allowed))))
13889 (let (org-completion-use-ido org-completion-use-iswitchb)
13890 (org-completing-read prompt existing nil nil "" nil cur)))))
13891 (list prop (if (equal val "") cur val))))
13892 (unless (equal (org-entry-get nil property) value)
13893 (org-entry-put nil property value)))
13895 (defun org-delete-property (property)
13896 "In the current entry, delete PROPERTY."
13897 (interactive
13898 (let* ((completion-ignore-case t)
13899 (prop (org-icompleting-read "Property: "
13900 (org-entry-properties nil 'standard))))
13901 (list prop)))
13902 (message "Property %s %s" property
13903 (if (org-entry-delete nil property)
13904 "deleted"
13905 "was not present in the entry")))
13907 (defun org-delete-property-globally (property)
13908 "Remove PROPERTY globally, from all entries."
13909 (interactive
13910 (let* ((completion-ignore-case t)
13911 (prop (org-icompleting-read
13912 "Globally remove property: "
13913 (mapcar 'list (org-buffer-property-keys)))))
13914 (list prop)))
13915 (save-excursion
13916 (save-restriction
13917 (widen)
13918 (goto-char (point-min))
13919 (let ((cnt 0))
13920 (while (re-search-forward
13922 nil t)
13923 (setq cnt (1+ cnt))
13924 (replace-match ""))
13927 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13929 (defun org-compute-property-at-point ()
13930 "Compute the property at point.
13931 This looks for an enclosing column format, extracts the operator and
13932 then applies it to the property in the column format's scope."
13933 (interactive)
13934 (unless (org-at-property-p)
13935 (error "Not at a property"))
13936 (let ((prop (org-match-string-no-properties 2)))
13937 (org-columns-get-format-and-top-level)
13938 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13939 (error "No operator defined for property %s" prop))
13940 (org-columns-compute prop)))
13942 (defvar org-property-allowed-value-functions nil
13943 "Hook for functions supplying allowed values for a specific property.
13944 The functions must take a single argument, the name of the property, and
13946 the values, this means that these values are intended as defaults for
13947 completion, but that other values should be allowed too.
13948 The functions must return nil if they are not responsible for this
13949 property.")
13951 (defun org-property-get-allowed-values (pom property &optional table)
13952 "Get allowed values for the property PROPERTY.
13953 When TABLE is non-nil, return an alist that can directly be used for
13954 completion."
13955 (let (vals)
13956 (cond
13957 ((equal property "TODO")
13958 (setq vals (org-with-point-at pom
13959 (append org-todo-keywords-1 '("")))))
13960 ((equal property "PRIORITY")
13961 (let ((n org-lowest-priority))
13962 (while (>= n org-highest-priority)
13963 (push (char-to-string n) vals)
13964 (setq n (1- n)))))
13965 ((member property org-special-properties))
13966 ((setq vals (run-hook-with-args-until-success
13967 'org-property-allowed-value-functions property)))
13968 (t
13969 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13971 (setq vals (car (read-from-string (concat "(" vals ")"))))
13972 (setq vals (mapcar (lambda (x)
13973 (cond ((stringp x) x)
13974 ((numberp x) (number-to-string x))
13975 ((symbolp x) (symbol-name x))
13976 (t "???")))
13977 vals)))))
13978 (when (member ":ETC" vals)
13979 (setq vals (remove ":ETC" vals))
13980 (org-add-props (car vals) '(org-unrestricted t)))
13981 (if table (mapcar 'list vals) vals)))
13983 (defun org-property-previous-allowed-value (&optional previous)
13984 "Switch to the next allowed value for this property."
13985 (interactive)
13986 (org-property-next-allowed-value t))
13988 (defun org-property-next-allowed-value (&optional previous)
13989 "Switch to the next allowed value for this property."
13990 (interactive)
13991 (unless (org-at-property-p)
13992 (error "Not at a property"))
13993 (let* ((key (match-string 2))
13994 (value (match-string 3))
13995 (allowed (or (org-property-get-allowed-values (point) key)
13996 (and (member value '("[ ]" "[-]" "[X]"))
13997 '("[ ]" "[X]"))))
13998 nval)
13999 (unless allowed
14000 (error "Allowed values for this property have not been defined"))
14001 (if previous (setq allowed (reverse allowed)))
14002 (if (member value allowed)
14003 (setq nval (car (cdr (member value allowed)))))
14004 (setq nval (or nval (car allowed)))
14005 (if (equal nval value)
14006 (error "Only one allowed value for this property"))
14007 (org-at-property-p)
14008 (replace-match (concat " :" key ": " nval) t t)
14009 (org-indent-line-function)
14010 (beginning-of-line 1)
14012 (run-hook-with-args 'org-property-changed-functions key nval)))
14014 (defun org-find-olp (path &optional this-buffer)
14015 "Return a marker pointing to the entry at outline path OLP.
14016 If anything goes wrong, throw an error.
14017 You can wrap this call to catch the error like this:
14019 (condition-case msg
14020 (org-mobile-locate-entry (match-string 4))
14021 (error (nth 1 msg)))
14023 The return value will then be either a string with the error message,
14024 or a marker if everything is OK.
14026 If THIS-BUFFER is set, the outline path does not contain a file,
14027 only headings."
14028 (let* ((file (if this-buffer buffer-file-name (pop path)))
14029 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14030 (level 1)
14031 (lmin 1)
14032 (lmax 1)
14033 limit re end found pos heading cnt)
14034 (unless buffer (error "File not found :%s" file))
14035 (with-current-buffer buffer
14036 (save-excursion
14037 (save-restriction
14038 (widen)
14039 (setq limit (point-max))
14040 (goto-char (point-min))
14041 (while (setq heading (pop path))
14042 (setq re (format org-complex-heading-regexp-format
14043 (regexp-quote heading)))
14044 (setq cnt 0 pos (point))
14045 (while (re-search-forward re end t)
14046 (setq level (- (match-end 1) (match-beginning 1)))
14047 (if (and (>= level lmin) (<= level lmax))
14048 (setq found (match-beginning 0) cnt (1+ cnt))))
14049 (when (= cnt 0) (error "Heading not found on level %d: %s"
14050 lmax heading))
14051 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14052 lmax heading))
14053 (goto-char found)
14054 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14055 (setq end (save-excursion (org-end-of-subtree t t))))
14056 (when (org-on-heading-p)
14057 (move-marker (make-marker) (point))))))))
14059 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14060 "Find node HEADING in BUFFER.
14061 Return a marker to the heading if it was found, or nil if not.
14062 If POS-ONLY is set, return just the position instead of a marker.
14064 The heading text must match exact, but it may have a TODO keyword,
14065 a priority cookie and tags in the standard locations."
14066 (with-current-buffer (or buffer (current-buffer))
14067 (save-excursion
14068 (save-restriction
14069 (widen)
14070 (goto-char (point-min))
14071 (let (case-fold-search)
14072 (if (re-search-forward
14073 (format org-complex-heading-regexp-format
14074 (regexp-quote heading)) nil t)
14075 (if pos-only
14076 (match-beginning 0)
14077 (move-marker (make-marker) (match-beginning 0)))))))))
14079 (defun org-find-exact-heading-in-directory (heading &optional dir)
14080 "Find Org node headline HEADING in all .org files in directory DIR.
14081 When the target headline is found, return a marker to this location."
14082 (let ((files (directory-files (or dir default-directory)
14084 file visiting m buffer)
14085 (catch 'found
14086 (while (setq file (pop files))
14087 (message "trying %s" file)
14088 (setq visiting (org-find-base-buffer-visiting file))
14089 (setq buffer (or visiting (find-file-noselect file)))
14090 (setq m (org-find-exact-headline-in-buffer
14091 heading buffer))
14092 (when (and (not m) (not visiting)) (kill-buffer buffer))
14093 (and m (throw 'found m))))))
14095 (defun org-find-entry-with-id (ident)
14096 "Locate the entry that contains the ID property with exact value IDENT.
14097 IDENT can be a string, a symbol or a number, this function will search for
14098 the string representation of it.
14099 Return the position where this entry starts, or nil if there is no such entry."
14100 (interactive "sID: ")
14101 (let ((id (cond
14102 ((stringp ident) ident)
14103 ((symbol-name ident) (symbol-name ident))
14104 ((numberp ident) (number-to-string ident))
14105 (t (error "IDENT %s must be a string, symbol or number" ident))))
14106 (case-fold-search nil))
14107 (save-excursion
14108 (save-restriction
14109 (widen)
14110 (goto-char (point-min))
14111 (when (re-search-forward
14113 nil t)
14114 (org-back-to-heading t)
14115 (point))))))
14117 ;;;; Timestamps
14119 (defvar org-last-changed-timestamp nil)
14120 (defvar org-last-inserted-timestamp nil
14121 "The last time stamp inserted with `org-insert-time-stamp'.")
14122 (defvar org-time-was-given) ; dynamically scoped parameter
14123 (defvar org-end-time-was-given) ; dynamically scoped parameter
14124 (defvar org-ts-what) ; dynamically scoped parameter
14126 (defun org-time-stamp (arg &optional inactive)
14127 "Prompt for a date/time and insert a time stamp.
14128 If the user specifies a time like HH:MM, or if this command is called
14129 with a prefix argument, the time stamp will contain date and time.
14130 Otherwise, only the date will be included. All parts of a date not
14131 specified by the user will be filled in from the current date/time.
14132 So if you press just return without typing anything, the time stamp
14133 will represent the current date/time. If there is already a timestamp
14134 at the cursor, it will be modified."
14135 (interactive "P")
14136 (let* ((ts nil)
14137 (default-time
14138 ;; Default time is either today, or, when entering a range,
14139 ;; the range start.
14140 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14141 (save-excursion
14142 (re-search-backward
14144 (- (point) 20) t)))
14145 (apply 'encode-time (org-parse-time-string (match-string 1)))
14146 (current-time)))
14147 (default-input (and ts (org-get-compact-tod ts)))
14148 org-time-was-given org-end-time-was-given time)
14149 (cond
14150 ((and (org-at-timestamp-p t)
14151 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14152 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14153 (insert "--")
14154 (setq time (let ((this-command this-command))
14155 (org-read-date arg 'totime nil nil
14156 default-time default-input)))
14157 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14158 ((org-at-timestamp-p t)
14159 (setq time (let ((this-command this-command))
14160 (org-read-date arg 'totime nil nil default-time default-input)))
14161 (when (org-at-timestamp-p t) ; just to get the match data
14162 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14163 (replace-match "")
14164 (setq org-last-changed-timestamp
14165 (org-insert-time-stamp
14166 time (or org-time-was-given arg)
14167 inactive nil nil (list org-end-time-was-given))))
14168 (message "Timestamp updated"))
14169 (t
14170 (setq time (let ((this-command this-command))
14171 (org-read-date arg 'totime nil nil default-time default-input)))
14172 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14173 nil nil (list org-end-time-was-given))))))
14175 ;; FIXME: can we use this for something else, like computing time differences?
14176 (defun org-get-compact-tod (s)
14177 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14178 (let* ((t1 (match-string 1 s))
14179 (h1 (string-to-number (match-string 2 s)))
14180 (m1 (string-to-number (match-string 3 s)))
14181 (t2 (and (match-end 4) (match-string 5 s)))
14182 (h2 (and t2 (string-to-number (match-string 6 s))))
14183 (m2 (and t2 (string-to-number (match-string 7 s))))
14184 dh dm)
14185 (if (not t2)
14186 t1
14187 (setq dh (- h2 h1) dm (- m2 m1))
14188 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14189 (concat t1 "+" (number-to-string dh)
14190 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14192 (defun org-time-stamp-inactive (&optional arg)
14193 "Insert an inactive time stamp.
14194 An inactive time stamp is enclosed in square brackets instead of angle
14195 brackets. It is inactive in the sense that it does not trigger agenda entries,
14196 does not link to the calendar and cannot be changed with the S-cursor keys.
14197 So these are more for recording a certain time/date."
14198 (interactive "P")
14199 (org-time-stamp arg 'inactive))
14201 (defvar org-date-ovl (make-overlay 1 1))
14202 (overlay-put org-date-ovl 'face 'org-warning)
14203 (org-detach-overlay org-date-ovl)
14205 (defvar org-ans1) ; dynamically scoped parameter
14206 (defvar org-ans2) ; dynamically scoped parameter
14208 (defvar org-plain-time-of-day-regexp) ; defined below
14210 (defvar org-overriding-default-time nil) ; dynamically scoped
14211 (defvar org-read-date-overlay nil)
14212 (defvar org-dcst nil) ; dynamically scoped
14213 (defvar org-read-date-history nil)
14214 (defvar org-read-date-final-answer nil)
14216 (defun org-read-date (&optional with-time to-time from-string prompt
14217 default-time default-input)
14218 "Read a date, possibly a time, and make things smooth for the user.
14219 The prompt will suggest to enter an ISO date, but you can also enter anything
14220 which will at least partially be understood by `parse-time-string'.
14221 Unrecognized parts of the date will default to the current day, month, year,
14222 hour and minute. If this command is called to replace a timestamp at point,
14223 of to enter the second timestamp of a range, the default time is taken
14224 from the existing stamp. Furthermore, the command prefers the future,
14225 so if you are giving a date where the year is not given, and the day-month
14226 combination is already past in the current year, it will assume you
14227 mean next year. For details, see the manual. A few examples:
14229 3-2-5 --> 2003-02-05
14230 feb 15 --> currentyear-02-15
14231 2/15 --> currentyear-02-15
14232 sep 12 9 --> 2009-09-12
14233 12:45 --> today 12:45
14234 22 sept 0:34 --> currentyear-09-22 0:34
14235 12 --> currentyear-currentmonth-12
14236 Fri --> nearest Friday (today or later)
14237 etc.
14239 Furthermore you can specify a relative date by giving, as the *first* thing
14240 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14241 change in days weeks, months, years.
14242 With a single plus or minus, the date is relative to today. With a double
14243 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14244 +4d --> four days from today
14245 +4 --> same as above
14246 +2w --> two weeks from today
14247 ++5 --> five days from default date
14249 The function understands only English month and weekday abbreviations,
14250 but this can be configured with the variables `parse-time-months' and
14251 `parse-time-weekdays'.
14253 While prompting, a calendar is popped up - you can also select the
14254 date with the mouse (button 1). The calendar shows a period of three
14255 months. To scroll it to other months, use the keys `>' and `<'.
14256 If you don't like the calendar, turn it off with
14257 \(setq org-read-date-popup-calendar nil)
14259 With optional argument TO-TIME, the date will immediately be converted
14260 to an internal time.
14261 With an optional argument WITH-TIME, the prompt will suggest to also
14262 insert a time. Note that when WITH-TIME is not set, you can still
14263 enter a time, and this function will inform the calling routine about
14264 this change. The calling routine may then choose to change the format
14265 used to insert the time stamp into the buffer to include the time.
14266 With optional argument FROM-STRING, read from this string instead from
14267 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14268 the time/date that is used for everything that is not specified by the
14269 user."
14270 (require 'parse-time)
14271 (let* ((org-time-stamp-rounding-minutes
14272 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14273 (org-dcst org-display-custom-times)
14274 (ct (org-current-time))
14275 (def (or org-overriding-default-time default-time ct))
14276 (defdecode (decode-time def))
14277 (dummy (progn
14278 (when (< (nth 2 defdecode) org-extend-today-until)
14279 (setcar (nthcdr 2 defdecode) -1)
14280 (setcar (nthcdr 1 defdecode) 59)
14281 (setq def (apply 'encode-time defdecode)
14282 defdecode (decode-time def)))))
14283 (calendar-frame-setup nil)
14284 (calendar-setup nil)
14285 (calendar-move-hook nil)
14286 (calendar-view-diary-initially-flag nil)
14287 (calendar-view-holidays-initially-flag nil)
14288 (timestr (format-time-string
14289 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14290 (prompt (concat (if prompt (concat prompt " ") "")
14291 (format "Date+time [%s]: " timestr)))
14292 ans (org-ans0 "") org-ans1 org-ans2 final)
14294 (cond
14295 (from-string (setq ans from-string))
14296 (org-read-date-popup-calendar
14297 (save-excursion
14298 (save-window-excursion
14299 (calendar)
14300 (calendar-forward-day (- (time-to-days def)
14301 (calendar-absolute-from-gregorian
14302 (calendar-current-date))))
14303 (org-eval-in-calendar nil t)
14304 (let* ((old-map (current-local-map))
14305 (map (copy-keymap calendar-mode-map))
14306 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14307 (org-defkey map (kbd "RET") 'org-calendar-select)
14308 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14309 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14310 (org-defkey minibuffer-local-map [(meta shift left)]
14311 (lambda () (interactive)
14312 (org-eval-in-calendar '(calendar-backward-month 1))))
14313 (org-defkey minibuffer-local-map [(meta shift right)]
14314 (lambda () (interactive)
14315 (org-eval-in-calendar '(calendar-forward-month 1))))
14316 (org-defkey minibuffer-local-map [(meta shift up)]
14317 (lambda () (interactive)
14318 (org-eval-in-calendar '(calendar-backward-year 1))))
14319 (org-defkey minibuffer-local-map [(meta shift down)]
14320 (lambda () (interactive)
14321 (org-eval-in-calendar '(calendar-forward-year 1))))
14322 (org-defkey minibuffer-local-map [?\e (shift left)]
14323 (lambda () (interactive)
14324 (org-eval-in-calendar '(calendar-backward-month 1))))
14325 (org-defkey minibuffer-local-map [?\e (shift right)]
14326 (lambda () (interactive)
14327 (org-eval-in-calendar '(calendar-forward-month 1))))
14328 (org-defkey minibuffer-local-map [?\e (shift up)]
14329 (lambda () (interactive)
14330 (org-eval-in-calendar '(calendar-backward-year 1))))
14331 (org-defkey minibuffer-local-map [?\e (shift down)]
14332 (lambda () (interactive)
14333 (org-eval-in-calendar '(calendar-forward-year 1))))
14334 (org-defkey minibuffer-local-map [(shift up)]
14335 (lambda () (interactive)
14336 (org-eval-in-calendar '(calendar-backward-week 1))))
14337 (org-defkey minibuffer-local-map [(shift down)]
14338 (lambda () (interactive)
14339 (org-eval-in-calendar '(calendar-forward-week 1))))
14340 (org-defkey minibuffer-local-map [(shift left)]
14341 (lambda () (interactive)
14342 (org-eval-in-calendar '(calendar-backward-day 1))))
14343 (org-defkey minibuffer-local-map [(shift right)]
14344 (lambda () (interactive)
14345 (org-eval-in-calendar '(calendar-forward-day 1))))
14346 (org-defkey minibuffer-local-map ">"
14347 (lambda () (interactive)
14348 (org-eval-in-calendar '(scroll-calendar-left 1))))
14349 (org-defkey minibuffer-local-map "<"
14350 (lambda () (interactive)
14351 (org-eval-in-calendar '(scroll-calendar-right 1))))
14352 (org-defkey minibuffer-local-map "\C-v"
14353 (lambda () (interactive)
14354 (org-eval-in-calendar
14355 '(calendar-scroll-left-three-months 1))))
14356 (org-defkey minibuffer-local-map "\M-v"
14357 (lambda () (interactive)
14358 (org-eval-in-calendar
14359 '(calendar-scroll-right-three-months 1))))
14360 (run-hooks 'org-read-date-minibuffer-setup-hook)
14361 (unwind-protect
14362 (progn
14363 (use-local-map map)
14364 (add-hook 'post-command-hook 'org-read-date-display)
14365 (setq org-ans0 (read-string prompt default-input
14366 'org-read-date-history nil))
14367 ;; org-ans0: from prompt
14368 ;; org-ans1: from mouse click
14369 ;; org-ans2: from calendar motion
14370 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14371 (remove-hook 'post-command-hook 'org-read-date-display)
14372 (use-local-map old-map)
14373 (when org-read-date-overlay
14374 (delete-overlay org-read-date-overlay)
14375 (setq org-read-date-overlay nil)))))))
14377 (t ; Naked prompt only
14378 (unwind-protect
14379 (setq ans (read-string prompt default-input
14380 'org-read-date-history timestr))
14381 (when org-read-date-overlay
14382 (delete-overlay org-read-date-overlay)
14383 (setq org-read-date-overlay nil)))))
14385 (setq final (org-read-date-analyze ans def defdecode))
14387 ;; One round trip to get rid of 34th of August and stuff like that....
14388 (setq final (decode-time (apply 'encode-time final)))
14390 (setq org-read-date-final-answer ans)
14392 (if to-time
14393 (apply 'encode-time final)
14394 (if (and (boundp 'org-time-was-given) org-time-was-given)
14395 (format "%04d-%02d-%02d %02d:%02d"
14396 (nth 5 final) (nth 4 final) (nth 3 final)
14397 (nth 2 final) (nth 1 final))
14398 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14400 (defvar def)
14401 (defvar defdecode)
14402 (defvar with-time)
14403 (defvar org-read-date-analyze-futurep nil)
14404 (defun org-read-date-display ()
14405 "Display the current date prompt interpretation in the minibuffer."
14406 (when org-read-date-display-live
14407 (when org-read-date-overlay
14408 (delete-overlay org-read-date-overlay))
14409 (let ((p (point)))
14410 (end-of-line 1)
14411 (while (not (equal (buffer-substring
14412 (max (point-min) (- (point) 4)) (point))
14413 " "))
14414 (insert " "))
14415 (goto-char p))
14416 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14417 " " (or org-ans1 org-ans2)))
14418 (org-end-time-was-given nil)
14419 (f (org-read-date-analyze ans def defdecode))
14420 (fmts (if org-dcst
14421 org-time-stamp-custom-formats
14422 org-time-stamp-formats))
14423 (fmt (if (or with-time
14424 (and (boundp 'org-time-was-given) org-time-was-given))
14425 (cdr fmts)
14426 (car fmts)))
14427 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14428 (when (and org-end-time-was-given
14429 (string-match org-plain-time-of-day-regexp txt))
14430 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14431 org-end-time-was-given
14432 (substring txt (match-end 0)))))
14433 (when org-read-date-analyze-futurep
14434 (setq txt (concat txt " (=>F)")))
14435 (setq org-read-date-overlay
14436 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14437 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14439 (defun org-read-date-analyze (ans def defdecode)
14440 "Analyze the combined answer of the date prompt."
14441 ;; FIXME: cleanup and comment
14442 (let ((nowdecode (decode-time (current-time)))
14443 delta deltan deltaw deltadef year month day
14444 hour minute second wday pm h2 m2 tl wday1
14445 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14446 (setq org-read-date-analyze-futurep nil)
14448 (setq ans "+0"))
14450 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14451 (setq ans (replace-match "" t t ans)
14452 deltan (car delta)
14453 deltaw (nth 1 delta)
14454 deltadef (nth 2 delta)))
14456 ;; Check if there is an iso week date in there
14457 ;; If yes, store the info and postpone interpreting it until the rest
14458 ;; of the parsing is done
14459 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14460 (setq iso-year (if (match-end 1)
14461 (org-small-year-to-year
14462 (string-to-number (match-string 1 ans))))
14463 iso-weekday (if (match-end 3)
14464 (string-to-number (match-string 3 ans)))
14465 iso-week (string-to-number (match-string 2 ans)))
14466 (setq ans (replace-match "" t t ans)))
14468 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14469 (when (string-match
14471 (setq year (if (match-end 2)
14472 (string-to-number (match-string 2 ans))
14473 (progn (setq kill-year t)
14474 (string-to-number (format-time-string "%Y"))))
14475 month (string-to-number (match-string 3 ans))
14476 day (string-to-number (match-string 4 ans)))
14477 (if (< year 100) (setq year (+ 2000 year)))
14479 t nil ans)))
14480 ;; Help matching american dates, like 5/30 or 5/30/7
14481 (when (string-match
14482 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14483 (setq year (if (match-end 4)
14484 (string-to-number (match-string 4 ans))
14485 (progn (setq kill-year t)
14486 (string-to-number (format-time-string "%Y"))))
14487 month (string-to-number (match-string 1 ans))
14488 day (string-to-number (match-string 2 ans)))
14489 (if (< year 100) (setq year (+ 2000 year)))
14491 t nil ans)))
14492 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14493 ;; If there is a time with am/pm, and *no* time without it, we convert
14494 ;; so that matching will be successful.
14495 (loop for i from 1 to 2 do ; twice, for end time as well
14498 (setq hour (string-to-number (match-string 1 ans))
14499 minute (if (match-end 3)
14500 (string-to-number (match-string 3 ans))
14501 0)
14502 pm (equal ?p
14503 (string-to-char (downcase (match-string 4 ans)))))
14504 (if (and (= hour 12) (not pm))
14505 (setq hour 0)
14506 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14507 (setq ans (replace-match (format "%02d:%02d" hour minute)
14508 t t ans))))
14510 ;; Check if a time range is given as a duration
14511 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14512 (setq hour (string-to-number (match-string 1 ans))
14513 h2 (+ hour (string-to-number (match-string 3 ans)))
14514 minute (string-to-number (match-string 2 ans))
14515 m2 (+ minute (if (match-end 5) (string-to-number
14516 (match-string 5 ans))0)))
14517 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14518 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14519 t t ans)))
14521 ;; Check if there is a time range
14522 (when (boundp 'org-end-time-was-given)
14523 (setq org-time-was-given nil)
14524 (when (and (string-match org-plain-time-of-day-regexp ans)
14525 (match-end 8))
14526 (setq org-end-time-was-given (match-string 8 ans))
14527 (setq ans (concat (substring ans 0 (match-beginning 7))
14528 (substring ans (match-end 7))))))
14530 (setq tl (parse-time-string ans)
14531 day (or (nth 3 tl) (nth 3 defdecode))
14532 month (or (nth 4 tl)
14533 (if (and org-read-date-prefer-future
14534 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14535 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14536 (nth 4 defdecode)))
14537 year (or (and (not kill-year) (nth 5 tl))
14538 (if (and org-read-date-prefer-future
14539 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14540 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14541 (nth 5 defdecode)))
14542 hour (or (nth 2 tl) (nth 2 defdecode))
14543 minute (or (nth 1 tl) (nth 1 defdecode))
14544 second (or (nth 0 tl) 0)
14545 wday (nth 6 tl))
14547 (when (and (eq org-read-date-prefer-future 'time)
14548 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14549 (equal day (nth 3 nowdecode))
14550 (equal month (nth 4 nowdecode))
14551 (equal year (nth 5 nowdecode))
14552 (nth 2 tl)
14553 (or (< (nth 2 tl) (nth 2 nowdecode))
14554 (and (= (nth 2 tl) (nth 2 nowdecode))
14555 (nth 1 tl)
14556 (< (nth 1 tl) (nth 1 nowdecode)))))
14557 (setq day (1+ day)
14558 futurep t))
14560 ;; Special date definitions below
14561 (cond
14562 (iso-week
14563 ;; There was an iso week
14564 (require 'cal-iso)
14565 (setq futurep nil)
14566 (setq year (or iso-year year)
14567 day (or iso-weekday wday 1)
14568 wday nil ; to make sure that the trigger below does not match
14569 iso-date (calendar-gregorian-from-absolute
14570 (calendar-absolute-from-iso
14571 (list iso-week day year))))
14572 ; FIXME: Should we also push ISO weeks into the future?
14573 ; (when (and org-read-date-prefer-future
14574 ; (not iso-year)
14575 ; (< (calendar-absolute-from-gregorian iso-date)
14576 ; (time-to-days (current-time))))
14577 ; (setq year (1+ year)
14578 ; iso-date (calendar-gregorian-from-absolute
14579 ; (calendar-absolute-from-iso
14580 ; (list iso-week day year)))))
14581 (setq month (car iso-date)
14582 year (nth 2 iso-date)
14583 day (nth 1 iso-date)))
14584 (deltan
14585 (setq futurep nil)
14586 (unless deltadef
14587 (let ((now (decode-time (current-time))))
14588 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14589 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14590 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14591 ((equal deltaw "m") (setq month (+ month deltan)))
14592 ((equal deltaw "y") (setq year (+ year deltan)))))
14593 ((and wday (not (nth 3 tl)))
14594 (setq futurep nil)
14595 ;; Weekday was given, but no day, so pick that day in the week
14596 ;; on or after the derived date.
14597 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14598 (unless (equal wday wday1)
14599 (setq day (+ day (% (- wday wday1 -7) 7))))))
14600 (if (and (boundp 'org-time-was-given)
14601 (nth 2 tl))
14602 (setq org-time-was-given t))
14603 (if (< year 100) (setq year (+ 2000 year)))
14604 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14605 (setq org-read-date-analyze-futurep futurep)
14606 (list second minute hour day month year)))
14608 (defvar parse-time-weekdays)
14610 (defun org-read-date-get-relative (s today default)
14611 "Check string S for special relative date string.
14612 TODAY and DEFAULT are internal times, for today and for a default.
14613 Return shift list (N what def-flag)
14615 N is the number of WHATs to shift.
14616 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14617 the DEFAULT date rather than TODAY."
14618 (when (and
14619 (string-match
14620 (concat
14625 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14626 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14627 (string-to-char (substring (match-string 1 s) -1))
14628 ?+))
14629 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14630 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14631 (what (if (match-end 3) (match-string 3 s) "d"))
14632 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14633 (date (if rel default today))
14634 (wday (nth 6 (decode-time date)))
14635 delta)
14636 (if wday1
14637 (progn
14638 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14639 (if (= dir ?-) (setq delta (- delta 7)))
14640 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14641 (list delta "d" rel))
14642 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14644 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14645 "Turn a user-specified date into the internal representation.
14646 The internal representation needed by the calendar is (month day year).
14647 This is a wrapper to handle the brain-dead convention in calendar that
14648 user function argument order change dependent on argument order."
14649 (if (boundp 'calendar-date-style)
14650 (cond
14651 ((eq calendar-date-style 'american)
14652 (list arg1 arg2 arg3))
14653 ((eq calendar-date-style 'european)
14654 (list arg2 arg1 arg3))
14655 ((eq calendar-date-style 'iso)
14656 (list arg2 arg3 arg1)))
14657 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14658 (if (org-bound-and-true-p european-calendar-style)
14659 (list arg2 arg1 arg3)
14660 (list arg1 arg2 arg3)))))
14662 (defun org-eval-in-calendar (form &optional keepdate)
14663 "Eval FORM in the calendar window and return to current window.
14664 Also, store the cursor date in variable org-ans2."
14665 (let ((sf (selected-frame))
14666 (sw (selected-window)))
14667 (select-window (get-buffer-window "*Calendar*" t))
14668 (eval form)
14669 (when (and (not keepdate) (calendar-cursor-to-date))
14670 (let* ((date (calendar-cursor-to-date))
14671 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14672 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14673 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14674 (select-window sw)
14675 (org-select-frame-set-input-focus sf)))
14677 (defun org-calendar-select ()
14678 "Return to `org-read-date' with the date currently selected.
14679 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14680 (interactive)
14681 (when (calendar-cursor-to-date)
14682 (let* ((date (calendar-cursor-to-date))
14683 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14684 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14685 (if (active-minibuffer-window) (exit-minibuffer))))
14687 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14688 "Insert a date stamp for the date given by the internal TIME.
14689 WITH-HM means use the stamp format that includes the time of the day.
14690 INACTIVE means use square brackets instead of angular ones, so that the
14691 stamp will not contribute to the agenda.
14692 PRE and POST are optional strings to be inserted before and after the
14693 stamp.
14694 The command returns the inserted time stamp."
14695 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14696 stamp)
14697 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14698 (insert-before-markers (or pre ""))
14699 (when (listp extra)
14700 (setq extra (car extra))
14701 (if (and (stringp extra)
14703 (setq extra (format "-%02d:%02d"
14704 (string-to-number (match-string 1 extra))
14705 (string-to-number (match-string 2 extra))))
14706 (setq extra nil)))
14707 (when extra
14708 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14709 (insert-before-markers (setq stamp (format-time-string fmt time)))
14710 (insert-before-markers (or post ""))
14711 (setq org-last-inserted-timestamp stamp)))
14713 (defun org-toggle-time-stamp-overlays ()
14714 "Toggle the use of custom time stamp formats."
14715 (interactive)
14716 (setq org-display-custom-times (not org-display-custom-times))
14717 (unless org-display-custom-times
14718 (let ((p (point-min)) (bmp (buffer-modified-p)))
14719 (while (setq p (next-single-property-change p 'display))
14720 (if (and (get-text-property p 'display)
14721 (eq (get-text-property p 'face) 'org-date))
14722 (remove-text-properties
14723 p (setq p (next-single-property-change p 'display))
14724 '(display t))))
14725 (set-buffer-modified-p bmp)))
14726 (if (featurep 'xemacs)
14727 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14728 (org-restart-font-lock)
14729 (setq org-table-may-need-update t)
14730 (if org-display-custom-times
14731 (message "Time stamps are overlayed with custom format")
14732 (message "Time stamp overlays removed")))
14734 (defun org-display-custom-time (beg end)
14735 "Overlay modified time stamp format over timestamp between BEG and END."
14736 (let* ((ts (buffer-substring beg end))
14737 t1 w1 with-hm tf time str w2 (off 0))
14738 (save-match-data
14739 (setq t1 (org-parse-time-string ts t))
14740 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14741 (setq off (- (match-end 0) (match-beginning 0)))))
14742 (setq end (- end off))
14743 (setq w1 (- end beg)
14744 with-hm (and (nth 1 t1) (nth 2 t1))
14745 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14746 time (org-fix-decoded-time t1)
14747 str (org-add-props
14748 (format-time-string
14749 (substring tf 1 -1) (apply 'encode-time time))
14750 nil 'mouse-face 'highlight)
14751 w2 (length str))
14752 (if (not (= w2 w1))
14753 (add-text-properties (1+ beg) (+ 2 beg)
14754 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14755 (if (featurep 'xemacs)
14756 (progn
14757 (put-text-property beg end 'invisible t)
14758 (put-text-property beg end 'end-glyph (make-glyph str)))
14759 (put-text-property beg end 'display str))))
14761 (defun org-translate-time (string)
14762 "Translate all timestamps in STRING to custom format.
14763 But do this only if the variable `org-display-custom-times' is set."
14764 (when org-display-custom-times
14765 (save-match-data
14766 (let* ((start 0)
14767 (re org-ts-regexp-both)
14768 t1 with-hm inactive tf time str beg end)
14769 (while (setq start (string-match re string start))
14770 (setq beg (match-beginning 0)
14771 end (match-end 0)
14772 t1 (save-match-data
14773 (org-parse-time-string (substring string beg end) t))
14774 with-hm (and (nth 1 t1) (nth 2 t1))
14775 inactive (equal (substring string beg (1+ beg)) "[")
14776 tf (funcall (if with-hm 'cdr 'car)
14777 org-time-stamp-custom-formats)
14778 time (org-fix-decoded-time t1)
14779 str (format-time-string
14780 (concat
14781 (if inactive "[" "<") (substring tf 1 -1)
14782 (if inactive "]" ">"))
14783 (apply 'encode-time time))
14784 string (replace-match str t t string)
14785 start (+ start (length str)))))))
14786 string)
14788 (defun org-fix-decoded-time (time)
14789 "Set 0 instead of nil for the first 6 elements of time.
14790 Don't touch the rest."
14791 (let ((n 0))
14792 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14794 (defun org-days-to-time (timestamp-string)
14795 "Difference between TIMESTAMP-STRING and now in days."
14796 (- (time-to-days (org-time-string-to-time timestamp-string))
14797 (time-to-days (current-time))))
14799 (defun org-deadline-close (timestamp-string &optional ndays)
14800 "Is the time in TIMESTAMP-STRING close to the current date?"
14801 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14802 (and (< (org-days-to-time timestamp-string) ndays)
14803 (not (org-entry-is-done-p))))
14805 (defun org-get-wdays (ts)
14806 "Get the deadline lead time appropriate for timestring TS."
14807 (cond
14808 ((<= org-deadline-warning-days 0)
14809 ;; 0 or negative, enforce this value no matter what
14810 (- org-deadline-warning-days))
14812 ;; lead time is specified.
14813 (floor (* (string-to-number (match-string 1 ts))
14814 (cdr (assoc (match-string 2 ts)
14815 '(("d" . 1) ("w" . 7)
14816 ("m" . 30.4) ("y" . 365.25)))))))
14817 ;; go for the default.
14818 (t org-deadline-warning-days)))
14820 (defun org-calendar-select-mouse (ev)
14821 "Return to `org-read-date' with the date currently selected.
14822 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14823 (interactive "e")
14824 (mouse-set-point ev)
14825 (when (calendar-cursor-to-date)
14826 (let* ((date (calendar-cursor-to-date))
14827 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14828 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14829 (if (active-minibuffer-window) (exit-minibuffer))))
14831 (defun org-check-deadlines (ndays)
14832 "Check if there are any deadlines due or past due.
14833 A deadline is considered due if it happens within `org-deadline-warning-days'
14834 days from today's date. If the deadline appears in an entry marked DONE,
14835 it is not shown. The prefix arg NDAYS can be used to test that many
14837 (interactive "P")
14838 (let* ((org-warn-days
14839 (cond
14840 ((equal ndays '(4)) 100000)
14841 (ndays (prefix-numeric-value ndays))
14842 (t (abs org-deadline-warning-days))))
14843 (case-fold-search nil)
14845 (callback
14846 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14848 (message "%d deadlines past-due or due within %d days"
14849 (org-occur regexp nil callback)
14850 org-warn-days)))
14852 (defun org-check-before-date (date)
14853 "Check if there are deadlines or scheduled entries before DATE."
14854 (interactive (list (org-read-date)))
14855 (let ((case-fold-search nil)
14859 (callback
14860 (lambda () (time-less-p
14861 (org-time-string-to-time (match-string 2))
14862 (org-time-string-to-time date)))))
14863 (message "%d entries before %s"
14864 (org-occur regexp nil callback) date)))
14866 (defun org-check-after-date (date)
14867 "Check if there are deadlines or scheduled entries after DATE."
14868 (interactive (list (org-read-date)))
14869 (let ((case-fold-search nil)
14873 (callback
14874 (lambda () (not
14875 (time-less-p
14876 (org-time-string-to-time (match-string 2))
14877 (org-time-string-to-time date))))))
14878 (message "%d entries after %s"
14879 (org-occur regexp nil callback) date)))
14881 (defun org-evaluate-time-range (&optional to-buffer)
14882 "Evaluate a time range by computing the difference between start and end.
14883 Normally the result is just printed in the echo area, but with prefix arg
14884 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14885 If the time range is actually in a table, the result is inserted into the
14886 next column.
14887 For time difference computation, a year is assumed to be exactly 365
14888 days in order to avoid rounding problems."
14889 (interactive "P")
14890 (or
14891 (org-clock-update-time-maybe)
14892 (save-excursion
14893 (unless (org-at-date-range-p t)
14894 (goto-char (point-at-bol))
14895 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14896 (if (not (org-at-date-range-p t))
14897 (error "Not at a time-stamp range, and none found in current line")))
14898 (let* ((ts1 (match-string 1))
14899 (ts2 (match-string 2))
14900 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14901 (match-end (match-end 0))
14902 (time1 (org-time-string-to-time ts1))
14903 (time2 (org-time-string-to-time ts2))
14904 (t1 (org-float-time time1))
14905 (t2 (org-float-time time2))
14906 (diff (abs (- t2 t1)))
14907 (negative (< (- t2 t1) 0))
14908 ;; (ys (floor (* 365 24 60 60)))
14909 (ds (* 24 60 60))
14910 (hs (* 60 60))
14911 (fy "%dy %dd %02d:%02d")
14912 (fy1 "%dy %dd")
14913 (fd "%dd %02d:%02d")
14914 (fd1 "%dd")
14915 (fh "%02d:%02d")
14916 y d h m align)
14917 (if havetime
14918 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14919 y 0
14920 d (floor (/ diff ds)) diff (mod diff ds)
14921 h (floor (/ diff hs)) diff (mod diff hs)
14922 m (floor (/ diff 60)))
14923 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14924 y 0
14925 d (floor (+ (/ diff ds) 0.5))
14926 h 0 m 0))
14927 (if (not to-buffer)
14928 (message "%s" (org-make-tdiff-string y d h m))
14929 (if (org-at-table-p)
14930 (progn
14931 (goto-char match-end)
14932 (setq align t)
14933 (and (looking-at " *|") (goto-char (match-end 0))))
14934 (goto-char match-end))
14935 (if (looking-at
14937 (replace-match ""))
14938 (if negative (insert " -"))
14939 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14940 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14941 (insert " " (format fh h m))))
14942 (if align (org-table-align))
14943 (message "Time difference inserted")))))
14945 (defun org-make-tdiff-string (y d h m)
14946 (let ((fmt "")
14947 (l nil))
14948 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14949 l (push y l)))
14950 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14951 l (push d l)))
14952 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14953 l (push h l)))
14954 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14955 l (push m l)))
14956 (apply 'format fmt (nreverse l))))
14958 (defun org-time-string-to-time (s)
14959 (apply 'encode-time (org-parse-time-string s)))
14960 (defun org-time-string-to-seconds (s)
14961 (org-float-time (org-time-string-to-time s)))
14963 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14964 "Convert a time stamp to an absolute day number.
14965 If there is a specifier for a cyclic time stamp, get the closest date to
14966 DAYNR.
14967 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14968 the variable date is bound by the calendar when this is called."
14969 (cond
14971 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14972 daynr
14973 (+ daynr 1000)))
14975 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14976 (time-to-days (current-time))) (match-string 0 s)
14977 prefer show-all))
14978 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14980 (defun org-days-to-iso-week (days)
14981 "Return the iso week number."
14982 (require 'cal-iso)
14983 (car (calendar-iso-from-absolute days)))
14985 (defun org-small-year-to-year (year)
14986 "Convert 2-digit years into 4-digit years.
14987 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14988 The year 2000 cannot be abbreviated. Any year larger than 99
14989 is returned unchanged."
14990 (if (< year 38)
14991 (setq year (+ 2000 year))
14992 (if (< year 100)
14993 (setq year (+ 1900 year))))
14994 year)
14996 (defun org-time-from-absolute (d)
14997 "Return the time corresponding to date D.
14998 D may be an absolute day number, or a calendar-type list (month day year)."
14999 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15000 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15002 (defun org-calendar-holiday ()
15003 "List of holidays, for Diary display in Org-mode."
15004 (require 'holidays)
15005 (let ((hl (funcall
15006 (if (fboundp 'calendar-check-holidays)
15007 'calendar-check-holidays 'check-calendar-holidays) date)))
15008 (if hl (mapconcat 'identity hl "; "))))
15010 (defun org-diary-sexp-entry (sexp entry date)
15011 "Process a SEXP diary ENTRY for DATE."
15012 (require 'diary-lib)
15013 (let ((result (if calendar-debug-sexp
15014 (let ((stack-trace-on-error t))
15015 (eval (car (read-from-string sexp))))
15016 (condition-case nil
15017 (eval (car (read-from-string sexp)))
15018 (error
15019 (beep)
15020 (message "Bad sexp at line %d in %s: %s"
15021 (org-current-line)
15022 (buffer-file-name) sexp)
15023 (sleep-for 2))))))
15024 (cond ((stringp result) (split-string result "; "))
15025 ((and (consp result)
15026 (not (consp (cdr result)))
15027 (stringp (cdr result))) (cdr result))
15028 ((and (consp result)
15029 (stringp (car result))) result)
15030 (result entry)
15031 (t nil))))
15033 (defun org-diary-to-ical-string (frombuf)
15034 "Get iCalendar entries from diary entries in buffer FROMBUF.
15035 This uses the icalendar.el library."
15036 (let* ((tmpdir (if (featurep 'xemacs)
15037 (temp-directory)
15038 temporary-file-directory))
15039 (tmpfile (make-temp-name
15040 (expand-file-name "orgics" tmpdir)))
15041 buf rtn b e)
15042 (with-current-buffer frombuf
15043 (icalendar-export-region (point-min) (point-max) tmpfile)
15044 (setq buf (find-buffer-visiting tmpfile))
15045 (set-buffer buf)
15046 (goto-char (point-min))
15047 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15048 (setq b (match-beginning 0)))
15049 (goto-char (point-max))
15050 (if (re-search-backward "^END:VEVENT" nil t)
15051 (setq e (match-end 0)))
15053 (kill-buffer buf)
15054 (delete-file tmpfile)
15055 rtn))
15057 (defun org-closest-date (start current change prefer show-all)
15058 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15059 When PREFER is `past' return a date that is either CURRENT or past.
15060 When PREFER is `future', return a date that is either CURRENT or future.
15061 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15062 ;; Make the proper lists from the dates
15063 (catch 'exit
15064 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15065 dn dw sday cday n1 n2 n0
15066 d m y y1 y2 date1 date2 nmonths nm ny m2)
15068 (setq start (org-date-to-gregorian start)
15069 current (org-date-to-gregorian
15070 (if show-all
15071 current
15072 (time-to-days (current-time))))
15073 sday (calendar-absolute-from-gregorian start)
15074 cday (calendar-absolute-from-gregorian current))
15076 (if (<= cday sday) (throw 'exit sday))
15079 (setq dn (string-to-number (match-string 1 change))
15080 dw (cdr (assoc (match-string 2 change) a1)))
15081 (error "Invalid change specifier: %s" change))
15082 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15083 (cond
15084 ((eq dw 'day)
15085 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15086 n2 (+ n1 dn)))
15087 ((eq dw 'year)
15088 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15089 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15090 (setq date1 (list m d y1)
15091 n1 (calendar-absolute-from-gregorian date1)
15092 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15093 n2 (calendar-absolute-from-gregorian date2)))
15094 ((eq dw 'month)
15095 ;; approx number of month between the two dates
15096 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15097 ;; How often does dn fit in there?
15098 (setq d (nth 1 start) m (car start) y (nth 2 start)
15099 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15100 m (+ m nm)
15101 ny (floor (/ m 12))
15102 y (+ y ny)
15103 m (- m (* ny 12)))
15104 (while (> m 12) (setq m (- m 12) y (1+ y)))
15105 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15106 (setq m2 (+ m dn) y2 y)
15107 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15108 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15109 (while (<= n2 cday)
15110 (setq n1 n2 m m2 y y2)
15111 (setq m2 (+ m dn) y2 y)
15112 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15113 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15114 ;; Make sure n1 is the earlier date
15115 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15116 (if show-all
15117 (cond
15118 ((eq prefer 'past) (if (= cday n2) n2 n1))
15119 ((eq prefer 'future) (if (= cday n1) n1 n2))
15120 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15121 (cond
15122 ((eq prefer 'past) (if (= cday n2) n2 n1))
15123 ((eq prefer 'future) (if (= cday n1) n1 n2))
15124 (t (if (= cday n1) n1 n2)))))))
15126 (defun org-date-to-gregorian (date)
15127 "Turn any specification of DATE into a Gregorian date for the calendar."
15128 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15129 ((and (listp date) (= (length date) 3)) date)
15130 ((stringp date)
15131 (setq date (org-parse-time-string date))
15132 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15133 ((listp date)
15134 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15136 (defun org-parse-time-string (s &optional nodefault)
15137 "Parse the standard Org-mode time string.
15138 This should be a lot faster than the normal `parse-time-string'.
15139 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15140 hour and minute fields will be nil if not given."
15141 (if (string-match org-ts-regexp0 s)
15142 (list 0
15143 (if (or (match-beginning 8) (not nodefault))
15144 (string-to-number (or (match-string 8 s) "0")))
15145 (if (or (match-beginning 7) (not nodefault))
15146 (string-to-number (or (match-string 7 s) "0")))
15147 (string-to-number (match-string 4 s))
15148 (string-to-number (match-string 3 s))
15149 (string-to-number (match-string 2 s))
15150 nil nil nil)
15151 (error "Not a standard Org-mode time string: %s" s)))
15153 (defun org-timestamp-up (&optional arg)
15154 "Increase the date item at the cursor by one.
15155 If the cursor is on the year, change the year. If it is on the month or
15156 the day, change that.
15157 With prefix ARG, change by that many units."
15158 (interactive "p")
15159 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15161 (defun org-timestamp-down (&optional arg)
15162 "Decrease the date item at the cursor by one.
15163 If the cursor is on the year, change the year. If it is on the month or
15164 the day, change that.
15165 With prefix ARG, change by that many units."
15166 (interactive "p")
15167 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15169 (defun org-timestamp-up-day (&optional arg)
15170 "Increase the date in the time stamp by one day.
15171 With prefix ARG, change that many days."
15172 (interactive "p")
15173 (if (and (not (org-at-timestamp-p t))
15174 (org-on-heading-p))
15175 (org-todo 'up)
15176 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15178 (defun org-timestamp-down-day (&optional arg)
15179 "Decrease the date in the time stamp by one day.
15180 With prefix ARG, change that many days."
15181 (interactive "p")
15182 (if (and (not (org-at-timestamp-p t))
15183 (org-on-heading-p))
15184 (org-todo 'down)
15185 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15187 (defun org-at-timestamp-p (&optional inactive-ok)
15188 "Determine if the cursor is in or at a timestamp."
15189 (interactive)
15190 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15191 (pos (point))
15192 (ans (or (looking-at tsr)
15193 (save-excursion
15195 (if (> (point) (point-min)) (backward-char 1))
15196 (and (looking-at tsr)
15197 (> (- (match-end 0) pos) -1))))))
15198 (and ans
15199 (boundp 'org-ts-what)
15200 (setq org-ts-what
15201 (cond
15202 ((= pos (match-beginning 0)) 'bracket)
15203 ((= pos (1- (match-end 0))) 'bracket)
15204 ((org-pos-in-match-range pos 2) 'year)
15205 ((org-pos-in-match-range pos 3) 'month)
15206 ((org-pos-in-match-range pos 7) 'hour)
15207 ((org-pos-in-match-range pos 8) 'minute)
15208 ((or (org-pos-in-match-range pos 4)
15209 (org-pos-in-match-range pos 5)) 'day)
15210 ((and (> pos (or (match-end 8) (match-end 5)))
15211 (< pos (match-end 0)))
15212 (- pos (or (match-end 8) (match-end 5))))
15213 (t 'day))))
15214 ans))
15216 (defun org-toggle-timestamp-type ()
15217 "Toggle the type (<active> or [inactive]) of a time stamp."
15218 (interactive)
15219 (when (org-at-timestamp-p t)
15220 (let ((beg (match-beginning 0)) (end (match-end 0))
15221 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15222 (save-excursion
15223 (goto-char beg)
15224 (while (re-search-forward "[][<>]" end t)
15225 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15226 t t)))
15227 (message "Timestamp is now %sactive"
15228 (if (equal (char-after beg) ?<) "" "in")))))
15230 (defun org-timestamp-change (n &optional what updown)
15231 "Change the date in the time stamp at point.
15232 The date will be changed by N times WHAT. WHAT can be `day', `month',
15233 `year', `minute', `second'. If WHAT is not given, the cursor position
15234 in the timestamp determines what will be changed."
15235 (let ((pos (point))
15236 with-hm inactive
15237 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15238 org-ts-what
15239 extra rem
15240 ts time time0)
15241 (if (not (org-at-timestamp-p t))
15242 (error "Not at a timestamp"))
15243 (if (and (not what) (eq org-ts-what 'bracket))
15244 (org-toggle-timestamp-type)
15245 (if (and (not what) (not (eq org-ts-what 'day))
15246 org-display-custom-times
15247 (get-text-property (point) 'display)
15248 (not (get-text-property (1- (point)) 'display)))
15249 (setq org-ts-what 'day))
15250 (setq org-ts-what (or what org-ts-what)
15251 inactive (= (char-after (match-beginning 0)) ?\[)
15252 ts (match-string 0))
15253 (replace-match "")
15254 (if (string-match
15256 ts)
15257 (setq extra (match-string 1 ts)))
15259 (setq with-hm t))
15260 (setq time0 (org-parse-time-string ts))
15261 (when (and updown
15262 (eq org-ts-what 'minute)
15263 (not current-prefix-arg))
15264 ;; This looks like s-up and s-down. Change by one rounding step.
15265 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15266 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15267 (setcar (cdr time0) (+ (nth 1 time0)
15268 (if (> n 0) (- rem) (- dm rem))))))
15269 (setq time
15270 (encode-time (or (car time0) 0)
15271 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15272 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15273 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15274 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15275 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15276 (nthcdr 6 time0)))
15277 (when (and (member org-ts-what '(hour minute))
15278 extra
15280 (setq extra (org-modify-ts-extra
15281 extra
15282 (if (eq org-ts-what 'hour) 2 5)
15283 n dm)))
15284 (when (integerp org-ts-what)
15285 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15286 (if (eq what 'calendar)
15287 (let ((cal-date (org-get-date-from-calendar)))
15288 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15289 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15290 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15291 (setcar time0 (or (car time0) 0))
15292 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15293 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15294 (setq time (apply 'encode-time time0))))
15295 (setq org-last-changed-timestamp
15296 (org-insert-time-stamp time with-hm inactive nil nil extra))
15297 (org-clock-update-time-maybe)
15298 (goto-char pos)
15299 ;; Try to recenter the calendar window, if any
15300 (if (and org-calendar-follow-timestamp-change
15301 (get-buffer-window "*Calendar*" t)
15302 (memq org-ts-what '(day month year)))
15303 (org-recenter-calendar (time-to-days time))))))
15305 (defun org-modify-ts-extra (s pos n dm)
15306 "Change the different parts of the lead-time and repeat fields in timestamp."
15307 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15308 ng h m new rem)
15309 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15310 (cond
15311 ((or (org-pos-in-match-range pos 2)
15312 (org-pos-in-match-range pos 3))
15313 (setq m (string-to-number (match-string 3 s))
15314 h (string-to-number (match-string 2 s)))
15315 (if (org-pos-in-match-range pos 2)
15316 (setq h (+ h n))
15317 (setq n (* dm (org-no-warnings (signum n))))
15318 (when (not (= 0 (setq rem (% m dm))))
15319 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15320 (setq m (+ m n)))
15321 (if (< m 0) (setq m (+ m 60) h (1- h)))
15322 (if (> m 59) (setq m (- m 60) h (1+ h)))
15323 (setq h (min 24 (max 0 h)))
15324 (setq ng 1 new (format "-%02d:%02d" h m)))
15325 ((org-pos-in-match-range pos 6)
15326 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15327 ((org-pos-in-match-range pos 5)
15328 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15330 ((org-pos-in-match-range pos 9)
15331 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15332 ((org-pos-in-match-range pos 8)
15333 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15335 (when ng
15336 (setq s (concat
15337 (substring s 0 (match-beginning ng))
15338 new
15339 (substring s (match-end ng))))))
15340 s))
15342 (defun org-recenter-calendar (date)
15343 "If the calendar is visible, recenter it to DATE."
15344 (let* ((win (selected-window))
15345 (cwin (get-buffer-window "*Calendar*" t))
15346 (calendar-move-hook nil))
15347 (when cwin
15348 (select-window cwin)
15349 (calendar-goto-date (if (listp date) date
15350 (calendar-gregorian-from-absolute date)))
15351 (select-window win))))
15353 (defun org-goto-calendar (&optional arg)
15354 "Go to the Emacs calendar at the current date.
15355 If there is a time stamp in the current line, go to that date.
15356 A prefix ARG can be used to force the current date."
15357 (interactive "P")
15358 (let ((tsr org-ts-regexp) diff
15359 (calendar-move-hook nil)
15360 (calendar-view-holidays-initially-flag nil)
15361 (calendar-view-diary-initially-flag nil))
15362 (if (or (org-at-timestamp-p)
15363 (save-excursion
15364 (beginning-of-line 1)
15365 (looking-at (concat ".*" tsr))))
15366 (let ((d1 (time-to-days (current-time)))
15367 (d2 (time-to-days
15368 (org-time-string-to-time (match-string 1)))))
15369 (setq diff (- d2 d1))))
15370 (calendar)
15371 (calendar-goto-today)
15372 (if (and diff (not arg)) (calendar-forward-day diff))))
15374 (defun org-get-date-from-calendar ()
15375 "Return a list (month day year) of date at point in calendar."
15376 (with-current-buffer "*Calendar*"
15377 (save-match-data
15378 (calendar-cursor-to-date))))
15380 (defun org-date-from-calendar ()
15381 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15382 If there is already a time stamp at the cursor position, update it."
15383 (interactive)
15384 (if (org-at-timestamp-p t)
15385 (org-timestamp-change 0 'calendar)
15386 (let ((cal-date (org-get-date-from-calendar)))
15387 (org-insert-time-stamp
15388 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15390 (defun org-minutes-to-hh:mm-string (m)
15391 "Compute H:MM from a number of minutes."
15392 (let ((h (/ m 60)))
15393 (setq m (- m (* 60 h)))
15394 (format org-time-clocksum-format h m)))
15396 (defun org-hh:mm-string-to-minutes (s)
15397 "Convert a string H:MM to a number of minutes.
15398 If the string is just a number, interpret it as minutes.
15399 In fact, the first hh:mm or number in the string will be taken,
15400 there can be extra stuff in the string.
15401 If no number is found, the return value is 0."
15402 (cond
15404 (+ (* (string-to-number (match-string 1 s)) 60)
15405 (string-to-number (match-string 2 s))))
15407 (string-to-number (match-string 1 s)))
15408 (t 0)))
15410 ;;;; Files
15412 (defun org-save-all-org-buffers ()
15413 "Save all Org-mode buffers without user confirmation."
15414 (interactive)
15415 (message "Saving all Org-mode buffers...")
15416 (save-some-buffers t 'org-mode-p)
15417 (when (featurep 'org-id) (org-id-locations-save))
15418 (message "Saving all Org-mode buffers... done"))
15420 (defun org-revert-all-org-buffers ()
15421 "Revert all Org-mode buffers.
15422 Prompt for confirmation when there are unsaved changes.
15423 Be sure you know what you are doing before letting this function
15424 overwrite your changes.
15426 This function is useful in a setup where one tracks org files
15427 with a version control system, to revert on one machine after pulling
15428 changes from another. I believe the procedure must be like this:
15430 1. M-x org-save-all-org-buffers
15431 2. Pull changes from the other machine, resolve conflicts
15432 3. M-x org-revert-all-org-buffers"
15433 (interactive)
15434 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15435 (error "Abort"))
15436 (save-excursion
15437 (save-window-excursion
15438 (mapc
15439 (lambda (b)
15440 (when (and (with-current-buffer b (org-mode-p))
15441 (with-current-buffer b buffer-file-name))
15442 (switch-to-buffer b)
15443 (revert-buffer t 'no-confirm)))
15444 (buffer-list))
15445 (when (and (featurep 'org-id) org-id-track-globally)
15446 (org-id-locations-load)))))
15448 ;;;; Agenda files
15450 ;;;###autoload
15451 (defun org-switchb (&optional arg)
15452 "Switch between Org buffers.
15453 With a prefix argument, restrict available to files.
15454 With two prefix arguments, restrict available buffers to agenda files.
15456 Defaults to `iswitchb' for buffer name completion.
15457 Set `org-completion-use-ido' to make it use ido instead."
15458 (interactive "P")
15459 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15460 ((equal arg '(16)) (org-buffer-list 'agenda))
15461 (t (org-buffer-list))))
15462 (org-completion-use-iswitchb org-completion-use-iswitchb)
15463 (org-completion-use-ido org-completion-use-ido))
15464 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15465 (setq org-completion-use-iswitchb t))
15466 (switch-to-buffer
15467 (org-icompleting-read "Org buffer: "
15468 (mapcar 'list (mapcar 'buffer-name blist))
15469 nil t))))
15471 ;;; Define some older names previously used for this functionality
15472 ;;;###autoload
15473 (defalias 'org-ido-switchb 'org-switchb)
15474 ;;;###autoload
15475 (defalias 'org-iswitchb 'org-switchb)
15477 (defun org-buffer-list (&optional predicate exclude-tmp)
15478 "Return a list of Org buffers.
15479 PREDICATE can be `export', `files' or `agenda'.
15481 export restrict the list to Export buffers.
15482 files restrict the list to buffers visiting Org files.
15483 agenda restrict the list to buffers visiting agenda files.
15485 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15486 (let* ((bfn nil)
15487 (agenda-files (and (eq predicate 'agenda)
15488 (mapcar 'file-truename (org-agenda-files t))))
15489 (filter
15490 (cond
15491 ((eq predicate 'files)
15492 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15493 ((eq predicate 'export)
15494 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15495 ((eq predicate 'agenda)
15496 (lambda (b)
15497 (with-current-buffer b
15498 (and (eq major-mode 'org-mode)
15499 (setq bfn (buffer-file-name b))
15500 (member (file-truename bfn) agenda-files)))))
15501 (t (lambda (b) (with-current-buffer b
15502 (or (eq major-mode 'org-mode)
15503 (string-match "\*Org .*Export"
15504 (buffer-name b)))))))))
15505 (delq nil
15506 (mapcar
15507 (lambda(b)
15508 (if (and (funcall filter b)
15509 (or (not exclude-tmp)
15510 (not (string-match "tmp" (buffer-name b)))))
15511 b
15512 nil))
15513 (buffer-list)))))
15515 (defun org-agenda-files (&optional unrestricted archives)
15516 "Get the list of agenda files.
15517 Optional UNRESTRICTED means return the full list even if a restriction
15518 is currently in place.
15519 When ARCHIVES is t, include all archive files that are really being
15520 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15521 `org-agenda-archives-mode' is t."
15522 (let ((files
15523 (cond
15524 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15525 ((stringp org-agenda-files) (org-read-agenda-file-list))
15526 ((listp org-agenda-files) org-agenda-files)
15527 (t (error "Invalid value of `org-agenda-files'")))))
15528 (setq files (apply 'append
15529 (mapcar (lambda (f)
15530 (if (file-directory-p f)
15531 (directory-files
15532 f t org-agenda-file-regexp)
15533 (list f)))
15534 files)))
15535 (when org-agenda-skip-unavailable-files
15536 (setq files (delq nil
15537 (mapcar (function
15538 (lambda (file)
15539 (and (file-readable-p file) file)))
15540 files))))
15541 (when (or (eq archives t)
15542 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15543 (setq files (org-add-archive-files files)))
15544 files))
15546 (defun org-agenda-file-p (&optional file)
15547 "Return non-nil, if FILE is an agenda file.
15548 If FILE is omitted, use the file associated with the current
15549 buffer."
15550 (member (or file (buffer-file-name))
15551 (org-agenda-files t)))
15553 (defun org-edit-agenda-file-list ()
15554 "Edit the list of agenda files.
15555 Depending on setup, this either uses customize to edit the variable
15556 `org-agenda-files', or it visits the file that is holding the list. In the
15557 latter case, the buffer is set up in a way that saving it automatically kills
15558 the buffer and restores the previous window configuration."
15559 (interactive)
15560 (if (stringp org-agenda-files)
15561 (let ((cw (current-window-configuration)))
15562 (find-file org-agenda-files)
15563 (org-set-local 'org-window-configuration cw)
15564 (org-add-hook 'after-save-hook
15565 (lambda ()
15566 (set-window-configuration
15567 (prog1 org-window-configuration
15568 (kill-buffer (current-buffer))))
15569 (org-install-agenda-files-menu)
15570 (message "New agenda file list installed"))
15571 nil 'local)
15572 (message "%s" (substitute-command-keys
15574 (customize-variable 'org-agenda-files)))
15576 (defun org-store-new-agenda-file-list (list)
15577 "Set new value for the agenda file list and save it correctly."
15578 (if (stringp org-agenda-files)
15579 (let ((fe (org-read-agenda-file-list t)) b u)
15580 (while (setq b (find-buffer-visiting org-agenda-files))
15581 (kill-buffer b))
15582 (with-temp-file org-agenda-files
15583 (insert
15584 (mapconcat
15585 (lambda (f) ;; Keep un-expanded entries.
15586 (if (setq u (assoc f fe))
15587 (cdr u)
15588 f))
15591 (let ((org-mode-hook nil) (org-inhibit-startup t)
15592 (org-insert-mode-line-in-empty-file nil))
15593 (setq org-agenda-files list)
15594 (customize-save-variable 'org-agenda-files org-agenda-files))))
15596 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15597 "Read the list of agenda files from a file.
15598 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15599 filenames, used by `org-store-new-agenda-file-list' to write back
15600 un-expanded file names."
15601 (when (file-directory-p org-agenda-files)
15602 (error "`org-agenda-files' cannot be a single directory"))
15603 (when (stringp org-agenda-files)
15604 (with-temp-buffer
15605 (insert-file-contents org-agenda-files)
15606 (mapcar
15607 (lambda (f)
15608 (let ((e (expand-file-name (substitute-in-file-name f)
15609 org-directory)))
15610 (if pair-with-expansion
15611 (cons e f)
15612 e)))
15615 ;;;###autoload
15616 (defun org-cycle-agenda-files ()
15617 "Cycle through the files in `org-agenda-files'.
15618 If the current buffer visits an agenda file, find the next one in the list.
15619 If the current buffer does not, find the first agenda file."
15620 (interactive)
15621 (let* ((fs (org-agenda-files t))
15622 (files (append fs (list (car fs))))
15623 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15624 file)
15625 (unless files (error "No agenda files"))
15626 (catch 'exit
15627 (while (setq file (pop files))
15628 (if (equal (file-truename file) tcf)
15629 (when (car files)
15630 (find-file (car files))
15631 (throw 'exit t))))
15632 (find-file (car fs)))
15633 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15635 (defun org-agenda-file-to-front (&optional to-end)
15636 "Move/add the current file to the top of the agenda file list.
15637 If the file is not present in the list, it is added to the front. If it is
15638 present, it is moved there. With optional argument TO-END, add/move to the
15639 end of the list."
15640 (interactive "P")
15641 (let ((org-agenda-skip-unavailable-files nil)
15642 (file-alist (mapcar (lambda (x)
15643 (cons (file-truename x) x))
15644 (org-agenda-files t)))
15645 (ctf (file-truename buffer-file-name))
15646 x had)
15647 (setq x (assoc ctf file-alist) had x)
15649 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15650 (if to-end
15651 (setq file-alist (append (delq x file-alist) (list x)))
15652 (setq file-alist (cons x (delq x file-alist))))
15653 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15654 (org-install-agenda-files-menu)
15655 (message "File %s to %s of agenda file list"
15656 (if had "moved" "added") (if to-end "end" "front"))))
15658 (defun org-remove-file (&optional file)
15659 "Remove current file from the list of files in variable `org-agenda-files'.
15660 These are the files which are being checked for agenda entries.
15661 Optional argument FILE means use this file instead of the current."
15662 (interactive)
15663 (let* ((org-agenda-skip-unavailable-files nil)
15664 (file (or file buffer-file-name))
15665 (true-file (file-truename file))
15666 (afile (abbreviate-file-name file))
15667 (files (delq nil (mapcar
15668 (lambda (x)
15669 (if (equal true-file
15670 (file-truename x))
15671 nil x))
15672 (org-agenda-files t)))))
15673 (if (not (= (length files) (length (org-agenda-files t))))
15674 (progn
15675 (org-store-new-agenda-file-list files)
15676 (org-install-agenda-files-menu)
15677 (message "Removed file: %s" afile))
15678 (message "File was not in list: %s (not removed)" afile))))
15680 (defun org-file-menu-entry (file)
15681 (vector file (list 'find-file file) t))
15683 (defun org-check-agenda-file (file)
15684 "Make sure FILE exists. If not, ask user what to do."
15685 (when (not (file-exists-p file))
15686 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15687 (abbreviate-file-name file))
15688 (let ((r (downcase (read-char-exclusive))))
15689 (cond
15690 ((equal r ?r)
15691 (org-remove-file file)
15692 (throw 'nextfile t))
15693 (t (error "Abort"))))))
15695 (defun org-get-agenda-file-buffer (file)
15696 "Get a buffer visiting FILE. If the buffer needs to be created, add
15697 it to the list of buffers which might be released later."
15698 (let ((buf (org-find-base-buffer-visiting file)))
15699 (if buf
15700 buf ; just return it
15701 ;; Make a new buffer and remember it
15702 (setq buf (find-file-noselect file))
15703 (if buf (push buf org-agenda-new-buffers))
15704 buf)))
15706 (defun org-release-buffers (blist)
15707 "Release all buffers in list, asking the user for confirmation when needed.
15708 When a buffer is unmodified, it is just killed. When modified, it is saved
15709 \(if the user agrees) and then killed."
15710 (let (buf file)
15711 (while (setq buf (pop blist))
15712 (setq file (buffer-file-name buf))
15713 (when (and (buffer-modified-p buf)
15714 file
15715 (y-or-n-p (format "Save file %s? " file)))
15716 (with-current-buffer buf (save-buffer)))
15717 (kill-buffer buf))))
15719 (defun org-prepare-agenda-buffers (files)
15720 "Create buffers for all agenda files, protect archived trees and comments."
15721 (interactive)
15722 (let ((pa '(:org-archived t))
15723 (pc '(:org-comment t))
15724 (pall '(:org-archived t :org-comment t))
15725 (inhibit-read-only t)
15726 (rea (concat ":" org-archive-tag ":"))
15727 bmp file re)
15728 (save-excursion
15729 (save-restriction
15730 (while (setq file (pop files))
15731 (catch 'nextfile
15732 (if (bufferp file)
15733 (set-buffer file)
15734 (org-check-agenda-file file)
15735 (set-buffer (org-get-agenda-file-buffer file)))
15736 (widen)
15737 (setq bmp (buffer-modified-p))
15738 (org-refresh-category-properties)
15739 (setq org-todo-keywords-for-agenda
15740 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15741 (setq org-done-keywords-for-agenda
15742 (append org-done-keywords-for-agenda org-done-keywords))
15743 (setq org-todo-keyword-alist-for-agenda
15744 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15745 (setq org-drawers-for-agenda
15746 (append org-drawers-for-agenda org-drawers))
15747 (setq org-tag-alist-for-agenda
15748 (append org-tag-alist-for-agenda org-tag-alist))
15750 (save-excursion
15751 (remove-text-properties (point-min) (point-max) pall)
15752 (when org-agenda-skip-archived-trees
15753 (goto-char (point-min))
15754 (while (re-search-forward rea nil t)
15755 (if (org-on-heading-p t)
15756 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15757 (goto-char (point-min))
15759 (while (re-search-forward re nil t)
15760 (add-text-properties
15761 (match-beginning 0) (org-end-of-subtree t) pc)))
15762 (set-buffer-modified-p bmp)))))
15763 (setq org-todo-keywords-for-agenda
15764 (org-uniquify org-todo-keywords-for-agenda))
15765 (setq org-todo-keyword-alist-for-agenda
15766 (org-uniquify org-todo-keyword-alist-for-agenda)
15767 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15769 ;;;; Embedded LaTeX
15771 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15772 "Keymap for the minor `org-cdlatex-mode'.")
15774 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15775 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15776 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15777 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15778 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15780 (defvar org-cdlatex-texmathp-advice-is-done nil
15781 "Flag remembering if we have applied the advice to texmathp already.")
15783 (define-minor-mode org-cdlatex-mode
15784 "Toggle the minor `org-cdlatex-mode'.
15785 This mode supports entering LaTeX environment and math in LaTeX fragments
15786 in Org-mode.
15788 nil " OCDL" nil
15789 (when org-cdlatex-mode (require 'cdlatex))
15790 (unless org-cdlatex-texmathp-advice-is-done
15791 (setq org-cdlatex-texmathp-advice-is-done t)
15792 (defadvice texmathp (around org-math-always-on activate)
15793 "Always return t in org-mode buffers.
15794 This is because we want to insert math symbols without dollars even outside
15795 the LaTeX math segments. If Orgmode thinks that point is actually inside
15796 an embedded LaTeX fragment, let texmathp do its job.
15798 (interactive)
15799 (let (p)
15800 (cond
15801 ((not (org-mode-p)) ad-do-it)
15802 ((eq this-command 'cdlatex-math-symbol)
15803 (setq ad-return-value t
15804 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15805 (t
15806 (let ((p (org-inside-LaTeX-fragment-p)))
15807 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15808 (setq ad-return-value t
15809 texmathp-why '("Org-mode embedded math" . 0))
15810 (if p ad-do-it)))))))))
15812 (defun turn-on-org-cdlatex ()
15813 "Unconditionally turn on `org-cdlatex-mode'."
15814 (org-cdlatex-mode 1))
15816 (defun org-inside-LaTeX-fragment-p ()
15817 "Test if point is inside a LaTeX fragment.
15819 sequence appearing also before point.
15820 Even though the matchers for math are configurable, this function assumes
15822 delimiters are skipped when they have been removed by customization.
15823 The return value is nil, or a cons cell with the delimiter and
15824 and the position of this delimiter.
15826 This function does a reasonably good job, but can locally be fooled by
15827 for example currency specifications. For example it will assume being in
15829 fragments that are properly closed, but during editing, we have to live
15830 with the uncertainty caused by missing closing delimiters. This function
15831 looks only before point, not after."
15832 (catch 'exit
15833 (let ((pos (point))
15834 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15835 (lim (progn
15837 (point)))
15838 dd-on str (start 0) m re)
15839 (goto-char pos)
15840 (when dodollar
15842 re (nth 1 (assoc "$" org-latex-regexps)))
15843 (while (string-match re str start)
15844 (cond
15845 ((= (match-end 0) (length str))
15846 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15847 ((= (match-end 0) (- (length str) 5))
15848 (throw 'exit nil))
15849 (t (setq start (match-end 0))))))
15850 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15851 (goto-char pos)
15852 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15853 (and (match-beginning 2) (throw 'exit nil))
15854 ;; count $$
15856 (setq dd-on (not dd-on)))
15857 (goto-char pos)
15858 (if dd-on (cons "$$" m))))))
15860 (defun org-inside-latex-macro-p ()
15861 "Is point inside a LaTeX macro or its arguments?"
15862 (save-match-data
15863 (org-in-regexp
15866 (defun org-try-cdlatex-tab ()
15867 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15868 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15869 - inside a LaTeX fragment, or
15870 - after the first word in a line, where an abbreviation expansion could
15871 insert a LaTeX environment."
15872 (when org-cdlatex-mode
15873 (cond
15874 ((save-excursion
15875 (skip-chars-backward "a-zA-Z0-9*")
15877 (bolp))
15878 (cdlatex-tab) t)
15879 ((org-inside-LaTeX-fragment-p)
15880 (cdlatex-tab) t)
15881 (t nil))))
15883 (defun org-cdlatex-underscore-caret (&optional arg)
15884 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15885 Revert to the normal definition outside of these fragments."
15886 (interactive "P")
15887 (if (org-inside-LaTeX-fragment-p)
15888 (call-interactively 'cdlatex-sub-superscript)
15889 (let (org-cdlatex-mode)
15890 (call-interactively (key-binding (vector last-input-event))))))
15892 (defun org-cdlatex-math-modify (&optional arg)
15893 "Execute `cdlatex-math-modify' in LaTeX fragments.
15894 Revert to the normal definition outside of these fragments."
15895 (interactive "P")
15896 (if (org-inside-LaTeX-fragment-p)
15897 (call-interactively 'cdlatex-math-modify)
15898 (let (org-cdlatex-mode)
15899 (call-interactively (key-binding (vector last-input-event))))))
15901 (defvar org-latex-fragment-image-overlays nil
15902 "List of overlays carrying the images of latex fragments.")
15903 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15905 (defun org-remove-latex-fragment-image-overlays ()
15906 "Remove all overlays with LaTeX fragment images in current buffer."
15907 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15908 (setq org-latex-fragment-image-overlays nil))
15910 (defun org-preview-latex-fragment (&optional subtree)
15911 "Preview the LaTeX fragment at point, or all locally or globally.
15912 If the cursor is in a LaTeX fragment, create the image and overlay
15913 it over the source code. If there is no fragment at point, display
15914 all fragments in the current text, from one headline to the next. With
15915 prefix SUBTREE, display all fragments in the current subtree. With a
15917 the cursor is before the first headline,
15918 display all fragments in the buffer.
15920 (interactive "P")
15921 (org-remove-latex-fragment-image-overlays)
15922 (save-excursion
15923 (save-restriction
15924 (let (beg end at msg)
15925 (cond
15926 ((or (equal subtree '(16))
15927 (not (save-excursion
15928 (re-search-backward (concat "^" outline-regexp) nil t))))
15929 (setq beg (point-min) end (point-max)
15930 msg "Creating images for buffer...%s"))
15931 ((equal subtree '(4))
15932 (org-back-to-heading)
15933 (setq beg (point) end (org-end-of-subtree t)
15934 msg "Creating images for subtree...%s"))
15935 (t
15936 (if (setq at (org-inside-LaTeX-fragment-p))
15937 (goto-char (max (point-min) (- (cdr at) 2)))
15938 (org-back-to-heading))
15939 (setq beg (point) end (progn (outline-next-heading) (point))
15940 msg (if at "Creating image...%s"
15941 "Creating images for entry...%s"))))
15942 (message msg "")
15943 (narrow-to-region beg end)
15944 (goto-char beg)
15945 (org-format-latex
15946 (concat "ltxpng/" (file-name-sans-extension
15947 (file-name-nondirectory
15948 buffer-file-name)))
15949 default-directory 'overlays msg at 'forbuffer 'dvipng)
15950 (message msg "done. Use `C-c C-c' to remove images.")))))
15952 (defvar org-latex-regexps
15954 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15957 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15961 "Regular expressions for matching embedded LaTeX.")
15963 (defvar org-export-have-math nil) ;; dynamic scoping
15964 (defun org-format-latex (prefix &optional dir overlays msg at
15965 forbuffer processing-type)
15966 "Replace LaTeX fragments with links to an image, and produce images.
15967 Some of the options can be changed using the variable
15968 `org-format-latex-options'."
15969 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15970 (let* ((prefixnodir (file-name-nondirectory prefix))
15971 (absprefix (expand-file-name prefix dir))
15972 (todir (file-name-directory absprefix))
15973 (opt org-format-latex-options)
15974 (matchers (plist-get opt :matchers))
15975 (re-list org-latex-regexps)
15976 (org-format-latex-header-extra
15977 (plist-get (org-infile-export-plist) :latex-header-extra))
15978 (cnt 0) txt hash link beg end re e checkdir
15979 executables-checked string
15980 m n block linkfile movefile ov)
15981 ;; Check the different regular expressions
15982 (while (setq e (pop re-list))
15983 (setq m (car e) re (nth 1 e) n (nth 2 e)
15985 (when (member m matchers)
15986 (goto-char (point-min))
15987 (while (re-search-forward re nil t)
15988 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15989 (not (get-text-property (match-beginning n)
15990 'org-protected))
15991 (or (not overlays)
15992 (not (eq (get-char-property (match-beginning n)
15993 'org-overlay-type)
15994 'org-latex-overlay))))
15995 (setq org-export-have-math t)
15996 (cond
15997 ((eq processing-type 'verbatim)
15998 ;; Leave the text verbatim, just protect it
15999 (add-text-properties (match-beginning n) (match-end n)
16000 '(org-protected t)))
16001 ((eq processing-type 'mathjax)
16002 ;; Prepare for MathJax processing
16003 (setq string (match-string n))
16004 (if (member m '("$" "$1"))
16005 (save-excursion
16006 (delete-region (match-beginning n) (match-end n))
16007 (goto-char (match-beginning n))
16010 '(org-protected t))))
16011 (add-text-properties (match-beginning n) (match-end n)
16012 '(org-protected t))))
16013 ((or (eq processing-type 'dvipng) t)
16014 ;; Process to an image
16015 (setq txt (match-string n)
16016 beg (match-beginning n) end (match-end n)
16017 cnt (1+ cnt))
16018 (let (print-length print-level) ; make sure full list is printed
16019 (setq hash (sha1 (prin1-to-string
16020 (list org-format-latex-header
16021 org-format-latex-header-extra
16022 org-export-latex-default-packages-alist
16023 org-export-latex-packages-alist
16024 org-format-latex-options
16025 forbuffer txt)))
16026 linkfile (format "%s_%s.png" prefix hash)
16027 movefile (format "%s_%s.png" absprefix hash)))
16028 (setq link (concat block "[[file:" linkfile "]]" block))
16029 (if msg (message msg cnt))
16030 (goto-char beg)
16031 (unless checkdir ; make sure the directory exists
16032 (setq checkdir t)
16033 (or (file-directory-p todir) (make-directory todir t)))
16035 (unless executables-checked
16036 (org-check-external-command
16037 "latex" "needed to convert LaTeX fragments to images")
16038 (org-check-external-command
16039 "dvipng" "needed to convert LaTeX fragments to images")
16040 (setq executables-checked t))
16042 (unless (file-exists-p movefile)
16043 (org-create-formula-image
16044 txt movefile opt forbuffer))
16045 (if overlays
16046 (progn
16047 (mapc (lambda (o)
16048 (if (eq (overlay-get o 'org-overlay-type)
16049 'org-latex-overlay)
16050 (delete-overlay o)))
16051 (overlays-in beg end))
16052 (setq ov (make-overlay beg end))
16053 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16054 (if (featurep 'xemacs)
16055 (progn
16056 (overlay-put ov 'invisible t)
16057 (overlay-put
16058 ov 'end-glyph
16059 (make-glyph (vector 'png :file movefile))))
16060 (overlay-put
16061 ov 'display
16062 (list 'image :type 'png :file movefile :ascent 'center)))
16063 (push ov org-latex-fragment-image-overlays)
16064 (goto-char end))
16065 (delete-region beg end)
16066 (insert (org-add-props link
16067 (list 'org-latex-src
16068 (replace-regexp-in-string
16071 ;; This function borrows from Ganesh Swami's latex2png.el
16072 (defun org-create-formula-image (string tofile options buffer)
16073 "This calls dvipng."
16074 (require 'org-latex)
16075 (let* ((tmpdir (if (featurep 'xemacs)
16076 (temp-directory)
16077 temporary-file-directory))
16078 (texfilebase (make-temp-name
16079 (expand-file-name "orgtex" tmpdir)))
16080 (texfile (concat texfilebase ".tex"))
16081 (dvifile (concat texfilebase ".dvi"))
16082 (pngfile (concat texfilebase ".png"))
16083 (fnh (if (featurep 'xemacs)
16084 (font-height (get-face-font 'default))
16085 (face-attribute 'default :height nil)))
16086 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16087 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16088 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16089 "Black"))
16090 (bg (or (plist-get options (if buffer :background :html-background))
16091 "Transparent")))
16092 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16093 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16094 (with-temp-file texfile
16095 (insert (org-splice-latex-header
16096 org-format-latex-header
16097 org-export-latex-default-packages-alist
16098 org-export-latex-packages-alist t
16099 org-format-latex-header-extra))
16101 (require 'org-latex)
16102 (org-export-latex-fix-inputenc))
16103 (let ((dir default-directory))
16104 (condition-case nil
16105 (progn
16106 (cd tmpdir)
16107 (call-process "latex" nil nil nil texfile))
16108 (error nil))
16109 (cd dir))
16110 (if (not (file-exists-p dvifile))
16111 (progn (message "Failed to create dvi file from %s" texfile) nil)
16112 (condition-case nil
16113 (call-process "dvipng" nil nil nil
16114 "-fg" fg "-bg" bg
16115 "-D" dpi
16116 ;;"-x" scale "-y" scale
16117 "-T" "tight"
16118 "-o" pngfile
16119 dvifile)
16120 (error nil))
16121 (if (not (file-exists-p pngfile))
16122 (if org-format-latex-signal-error
16123 (error "Failed to create png file from %s" texfile)
16124 (message "Failed to create png file from %s" texfile)
16125 nil)
16126 ;; Use the requested file name and clean up
16127 (copy-file pngfile tofile 'replace)
16128 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16129 (delete-file (concat texfilebase e)))
16130 pngfile))))
16132 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16133 "Fill a LaTeX header template TPL.
16134 In the template, the following place holders will be recognized:
16137 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16139 [NO-PACKAGES] do not include PKG
16140 [EXTRA] the string EXTRA
16141 [NO-EXTRA] do not include EXTRA
16143 For backward compatibility, if both the positive and the negative place
16145 assumed to be present at the end of the template.
16146 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16147 EXTRA is a string.
16148 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16149 (let (rpl (end ""))
16151 (setq rpl (if (or (match-end 1) (not def-pkg))
16152 "" (org-latex-packages-to-string def-pkg snippets-p t))
16153 tpl (replace-match rpl t t tpl))
16154 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16157 (setq rpl (if (or (match-end 1) (not pkg))
16158 "" (org-latex-packages-to-string pkg snippets-p t))
16159 tpl (replace-match rpl t t tpl))
16160 (if pkg (setq end
16162 (org-latex-packages-to-string pkg snippets-p)))))
16165 (setq rpl (if (or (match-end 1) (not extra))
16167 tpl (replace-match rpl t t tpl))
16173 tpl)))
16175 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16177 (setq pkg (mapconcat (lambda(p)
16178 (cond
16179 ((stringp p) p)
16180 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16181 (format "%% Package %s omitted" (cadr p)))
16182 ((equal "" (car p))
16184 (t
16186 (car p) (cadr p)))))
16187 pkg
16191 (defun org-dvipng-color (attr)
16192 "Return an rgb color specification for dvipng."
16193 (apply 'format "rgb %s %s %s"
16194 (mapcar 'org-normalize-color
16195 (color-values (face-attribute 'default attr nil)))))
16197 (defun org-normalize-color (value)
16198 "Return string to be used as color value for an RGB component."
16199 (format "%g" (/ value 65535.0)))
16201 ;; Image display
16204 (defvar org-inline-image-overlays nil)
16205 (make-variable-buffer-local 'org-inline-image-overlays)
16207 (defun org-toggle-inline-images (&optional include-linked)
16208 "Toggle the display of inline images.
16209 INCLUDE-LINKED is passed to `org-display-inline-images'."
16210 (interactive "P")
16211 (if org-inline-image-overlays
16212 (progn
16213 (org-remove-inline-images)
16214 (message "Inline image display turned off"))
16215 (org-display-inline-images include-linked)
16216 (if org-inline-image-overlays
16217 (message "%d images displayed inline"
16218 (length org-inline-image-overlays))
16219 (message "No images to display inline"))))
16221 (defun org-display-inline-images (&optional include-linked refresh beg end)
16222 "Display inline images.
16223 Normally only links without a description part are inlined, because this
16224 is how it will work for export. When INCLUDE-LINKED is set, also links
16225 with a description part will be inlined. This can be nice for a quick
16226 look at those images, but it does not reflect what exported files will look
16227 like.
16228 When REFRESH is set, refresh existing images between BEG and END.
16229 This will create new image displays only if necessary.
16230 BEG and END default to the buffer boundaries."
16231 (interactive "P")
16232 (unless refresh
16233 (org-remove-inline-images)
16234 (clear-image-cache))
16235 (save-excursion
16236 (save-restriction
16237 (widen)
16238 (setq beg (or beg (point-min)) end (or end (point-max)))
16239 (goto-char (point-min))
16241 (substring (org-image-file-name-regexp) 0 -2)
16243 old file ov img)
16244 (while (re-search-forward re end t)
16245 (setq old (get-char-property-and-overlay (match-beginning 1)
16246 'org-image-overlay))
16247 (setq file (expand-file-name
16248 (concat (or (match-string 3) "") (match-string 4))))
16249 (when (file-exists-p file)
16250 (if (and (car-safe old) refresh)
16251 (image-refresh (overlay-get (cdr old) 'display))
16252 (setq img (save-match-data (create-image file)))
16253 (when img
16254 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16255 (overlay-put ov 'display img)
16256 (overlay-put ov 'face 'default)
16257 (overlay-put ov 'org-image-overlay t)
16258 (overlay-put ov 'modification-hooks
16259 (list 'org-display-inline-modification-hook))
16260 (push ov org-inline-image-overlays)))))))))
16262 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16263 "Remove inline-display overlay if a corresponding region is modified."
16264 (let ((inhibit-modification-hooks t))
16265 (when (and ov after)
16266 (delete ov org-inline-image-overlays)
16267 (delete-overlay ov))))
16269 (defun org-remove-inline-images ()
16270 "Remove inline display of images."
16271 (interactive)
16272 (mapc 'delete-overlay org-inline-image-overlays)
16273 (setq org-inline-image-overlays nil))
16275 ;;;; Key bindings
16277 ;; Make `C-c C-x' a prefix key
16278 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16280 ;; TAB key with modifiers
16281 (org-defkey org-mode-map "\C-i" 'org-cycle)
16282 (org-defkey org-mode-map [(tab)] 'org-cycle)
16283 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16284 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16286 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16287 ;; The following line is necessary under Suse GNU/Linux
16288 (unless (featurep 'xemacs)
16289 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16290 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16291 (define-key org-mode-map [backtab] 'org-shifttab)
16293 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16294 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16295 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16297 ;; Cursor keys with modifiers
16298 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16299 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16300 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16301 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16303 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16304 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16305 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16306 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16308 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16309 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16310 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16311 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16313 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16314 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16316 ;; Babel keys
16317 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16318 (mapc (lambda (pair)
16319 (define-key org-babel-map (car pair) (cdr pair)))
16320 org-babel-key-bindings)
16322 ;;; Extra keys for tty access.
16323 ;; We only set them when really needed because otherwise the
16324 ;; menus don't show the simple keys
16326 (when (or org-use-extra-keys
16327 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16328 (not window-system))
16329 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16330 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16331 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16332 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16333 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16334 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16335 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16336 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16337 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16338 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16339 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16340 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16341 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16342 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16343 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16344 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16345 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16346 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16347 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16348 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16349 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16350 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16351 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16352 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16353 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16354 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16355 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16356 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16358 ;; All the other keys
16360 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16361 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16362 (if (boundp 'narrow-map)
16363 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16364 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16365 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16366 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16367 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16368 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16369 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16370 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16371 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16372 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16373 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16374 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16375 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16376 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16377 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16378 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16379 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16380 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16382 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16383 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16384 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16385 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16386 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16387 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16388 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16389 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16390 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16391 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16392 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16393 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16394 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16395 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16396 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16397 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16398 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16399 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16400 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16402 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16403 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16404 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16405 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16406 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16407 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16408 (org-defkey org-mode-map "\C-c^" 'org-sort)
16409 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16410 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16411 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16412 (org-defkey org-mode-map "\C-m" 'org-return)
16413 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16414 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16415 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16416 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16417 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16418 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16419 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16420 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16421 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16422 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16423 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16424 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16425 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16426 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16427 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16428 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16429 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16430 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16431 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16432 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16433 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16435 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16436 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16437 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16438 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16440 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16441 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16442 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16443 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16444 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16445 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16446 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16447 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16448 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16449 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16451 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16452 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16453 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16454 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16455 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16456 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16457 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16459 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16460 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16461 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16462 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16463 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16465 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16467 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16469 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16470 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16472 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16475 (when (featurep 'xemacs)
16476 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16479 (defconst org-speed-commands-default
16480 '(
16481 ("Outline Navigation")
16482 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16483 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16484 ("f" . (org-speed-move-safe 'org-forward-same-level))
16485 ("b" . (org-speed-move-safe 'org-backward-same-level))
16486 ("u" . (org-speed-move-safe 'outline-up-heading))
16487 ("j" . org-goto)
16488 ("g" . (org-refile t))
16489 ("Outline Visibility")
16490 ("c" . org-cycle)
16491 ("C" . org-shifttab)
16492 (" " . org-display-outline-path)
16493 ("Outline Structure Editing")
16494 ("U" . org-shiftmetaup)
16495 ("D" . org-shiftmetadown)
16496 ("r" . org-metaright)
16497 ("l" . org-metaleft)
16498 ("R" . org-shiftmetaright)
16499 ("L" . org-shiftmetaleft)
16500 ("i" . (progn (forward-char 1) (call-interactively
16501 'org-insert-heading-respect-content)))
16502 ("^" . org-sort)
16503 ("w" . org-refile)
16504 ("a" . org-archive-subtree-default-with-confirmation)
16505 ("." . outline-mark-subtree)
16506 ("Clock Commands")
16507 ("I" . org-clock-in)
16508 ("O" . org-clock-out)
16509 ("Meta Data Editing")
16510 ("t" . org-todo)
16511 ("0" . (org-priority ?\ ))
16512 ("1" . (org-priority ?A))
16513 ("2" . (org-priority ?B))
16514 ("3" . (org-priority ?C))
16515 (";" . org-set-tags-command)
16516 ("e" . org-set-effort)
16517 ("Agenda Views etc")
16518 ("v" . org-agenda)
16519 ("/" . org-sparse-tree)
16520 ("Misc")
16521 ("o" . org-open-at-point)
16522 ("?" . org-speed-command-help)
16523 ("<" . (org-agenda-set-restriction-lock 'subtree))
16524 (">" . (org-agenda-remove-restriction-lock))
16525 )
16526 "The default speed commands.")
16528 (defun org-print-speed-command (e)
16529 (if (> (length (car e)) 1)
16530 (progn
16532 (princ (car e))
16534 (princ (make-string (length (car e)) ?-))
16536 (princ (car e))
16537 (princ " ")
16538 (if (symbolp (cdr e))
16539 (princ (symbol-name (cdr e)))
16540 (prin1 (cdr e)))
16543 (defun org-speed-command-help ()
16544 "Show the available speed commands."
16545 (interactive)
16546 (if (not org-use-speed-commands)
16547 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16548 (with-output-to-temp-buffer "*Help*"
16550 (mapc 'org-print-speed-command org-speed-commands-user)
16553 (mapc 'org-print-speed-command org-speed-commands-default))
16554 (with-current-buffer "*Help*"
16555 (setq truncate-lines t))))
16557 (defun org-speed-move-safe (cmd)
16558 "Execute CMD, but make sure that the cursor always ends up in a headline.
16559 If not, return to the original position and throw an error."
16560 (interactive)
16561 (let ((pos (point)))
16562 (call-interactively cmd)
16563 (unless (and (bolp) (org-on-heading-p))
16564 (goto-char pos)
16565 (error "Boundary reached while executing %s" cmd))))
16567 (defvar org-self-insert-command-undo-counter 0)
16569 (defvar org-table-auto-blank-field) ; defined in org-table.el
16570 (defvar org-speed-command nil)
16572 (defun org-speed-command-default-hook (keys)
16573 "Hook for activating single-letter speed commands.
16574 `org-speed-commands-default' specifies a minimal command set. Use
16575 `org-speed-commands-user' for further customization."
16576 (when (or (and (bolp) (looking-at outline-regexp))
16577 (and (functionp org-use-speed-commands)
16578 (funcall org-use-speed-commands)))
16579 (cdr (assoc keys (append org-speed-commands-user
16580 org-speed-commands-default)))))
16582 (defun org-babel-speed-command-hook (keys)
16583 "Hook for activating single-letter code block commands."
16584 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16585 (cdr (assoc keys org-babel-key-bindings))))
16587 (defcustom org-speed-command-hook
16588 '(org-speed-command-default-hook org-babel-speed-command-hook)
16589 "Hook for activating speed commands at strategic locations.
16590 Hook functions are called in sequence until a valid handler is
16591 found.
16593 Each hook takes a single argument, a user-pressed command key
16594 which is also a `self-insert-command' from the global map.
16596 Within the hook, examine the cursor position and the command key
16597 and return nil or a valid handler as appropriate. Handler could
16598 be one of an interactive command, a function, or a form.
16600 Set `org-use-speed-commands' to non-nil value to enable this
16601 hook. The default setting is `org-speed-command-default-hook'."
16602 :group 'org-structure
16603 :type 'hook)
16605 (defun org-self-insert-command (N)
16606 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16607 If the cursor is in a table looking at whitespace, the whitespace is
16608 overwritten, and the table is not marked as requiring realignment."
16609 (interactive "p")
16610 (cond
16611 ((and org-use-speed-commands
16612 (setq org-speed-command
16613 (run-hook-with-args-until-success
16614 'org-speed-command-hook (this-command-keys))))
16615 (cond
16616 ((commandp org-speed-command)
16617 (setq this-command org-speed-command)
16618 (call-interactively org-speed-command))
16619 ((functionp org-speed-command)
16620 (funcall org-speed-command))
16621 ((and org-speed-command (listp org-speed-command))
16622 (eval org-speed-command))
16623 (t (let (org-use-speed-commands)
16624 (call-interactively 'org-self-insert-command)))))
16625 ((and
16626 (org-table-p)
16627 (progn
16628 ;; check if we blank the field, and if that triggers align
16629 (and (featurep 'org-table) org-table-auto-blank-field
16630 (member last-command
16631 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16633 ;; got extra space, this field does not determine column width
16634 (let (org-table-may-need-update) (org-table-blank-field))
16635 ;; no extra space, this field may determine column width
16636 (org-table-blank-field)))
16637 t)
16638 (eq N 1)
16640 (let (org-table-may-need-update)
16641 (goto-char (1- (match-end 0)))
16642 (delete-backward-char 1)
16643 (goto-char (match-beginning 0))
16644 (self-insert-command N)))
16645 (t
16646 (setq org-table-may-need-update t)
16647 (self-insert-command N)
16648 (org-fix-tags-on-the-fly)
16649 (if org-self-insert-cluster-for-undo
16650 (if (not (eq last-command 'org-self-insert-command))
16651 (setq org-self-insert-command-undo-counter 1)
16652 (if (>= org-self-insert-command-undo-counter 20)
16653 (setq org-self-insert-command-undo-counter 1)
16654 (and (> org-self-insert-command-undo-counter 0)
16655 buffer-undo-list
16656 (not (cadr buffer-undo-list)) ; remove nil entry
16657 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16658 (setq org-self-insert-command-undo-counter
16659 (1+ org-self-insert-command-undo-counter))))))))
16661 (defun org-fix-tags-on-the-fly ()
16662 (when (and (equal (char-after (point-at-bol)) ?*)
16663 (org-on-heading-p))
16664 (org-align-tags-here org-tags-column)))
16666 (defun org-delete-backward-char (N)
16667 "Like `delete-backward-char', insert whitespace at field end in tables.
16668 When deleting backwards, in tables this function will insert whitespace in
16670 still be marked for re-alignment if the field did fill the entire column,
16671 because, in this case the deletion might narrow the column."
16672 (interactive "p")
16673 (if (and (org-table-p)
16674 (eq N 1)
16675 (string-match "|" (buffer-substring (point-at-bol) (point)))
16676 (looking-at ".*?|"))
16677 (let ((pos (point))
16679 (c org-table-may-need-update))
16680 (backward-delete-char N)
16681 (if (not overwrite-mode)
16682 (progn
16683 (skip-chars-forward "^|")
16684 (insert " ")
16685 (goto-char (1- pos))))
16686 ;; noalign: if there were two spaces at the end, this field
16687 ;; does not determine the width of the column.
16688 (if noalign (setq org-table-may-need-update c)))
16689 (backward-delete-char N)
16690 (org-fix-tags-on-the-fly)))
16692 (defun org-delete-char (N)
16693 "Like `delete-char', but insert whitespace at field end in tables.
16694 When deleting characters, in tables this function will insert whitespace in
16696 still be marked for re-alignment if the field did fill the entire column,
16697 because, in this case the deletion might narrow the column."
16698 (interactive "p")
16699 (if (and (org-table-p)
16700 (not (bolp))
16701 (not (= (char-after) ?|))
16702 (eq N 1))
16703 (if (looking-at ".*?|")
16704 (let ((pos (point))
16706 (c org-table-may-need-update))
16707 (replace-match (concat
16708 (substring (match-string 0) 1 -1)
16709 " |"))
16710 (goto-char pos)
16711 ;; noalign: if there were two spaces at the end, this field
16712 ;; does not determine the width of the column.
16713 (if noalign (setq org-table-may-need-update c)))
16714 (delete-char N))
16715 (delete-char N)
16716 (org-fix-tags-on-the-fly)))
16718 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16719 (put 'org-self-insert-command 'delete-selection t)
16720 (put 'orgtbl-self-insert-command 'delete-selection t)
16721 (put 'org-delete-char 'delete-selection 'supersede)
16722 (put 'org-delete-backward-char 'delete-selection 'supersede)
16723 (put 'org-yank 'delete-selection 'yank)
16725 ;; Make `flyspell-mode' delay after some commands
16726 (put 'org-self-insert-command 'flyspell-delayed t)
16727 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16728 (put 'org-delete-char 'flyspell-delayed t)
16729 (put 'org-delete-backward-char 'flyspell-delayed t)
16731 ;; Make pabbrev-mode expand after org-mode commands
16732 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16733 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16735 ;; How to do this: Measure non-white length of current string
16736 ;; If equal to column width, we should realign.
16738 (defun org-remap (map &rest commands)
16739 "In MAP, remap the functions given in COMMANDS.
16740 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16741 (let (new old)
16742 (while commands
16743 (setq old (pop commands) new (pop commands))
16744 (if (fboundp 'command-remapping)
16745 (org-defkey map (vector 'remap old) new)
16746 (substitute-key-definition old new map global-map)))))
16748 (when (eq org-enable-table-editor 'optimized)
16749 ;; If the user wants maximum table support, we need to hijack
16750 ;; some standard editing functions
16751 (org-remap org-mode-map
16752 'self-insert-command 'org-self-insert-command
16753 'delete-char 'org-delete-char
16754 'delete-backward-char 'org-delete-backward-char)
16755 (org-defkey org-mode-map "|" 'org-force-self-insert))
16757 (defvar org-ctrl-c-ctrl-c-hook nil
16758 "Hook for functions attaching themselves to `C-c C-c'.
16759 This can be used to add additional functionality to the C-c C-c key which
16760 executes context-dependent commands.
16761 Each function will be called with no arguments. The function must check
16762 if the context is appropriate for it to act. If yes, it should do its
16763 thing and then return a non-nil value. If the context is wrong,
16764 just do nothing and return nil.")
16766 (defvar org-tab-first-hook nil
16767 "Hook for functions to attach themselves to TAB.
16768 See `org-ctrl-c-ctrl-c-hook' for more information.
16769 This hook runs as the first action when TAB is pressed, even before
16770 `org-cycle' messes around with the `outline-regexp' to cater for
16771 inline tasks and plain list item folding.
16772 If any function in this hook returns t, any other actions that
16773 would have been caused by TAB (such as table field motion or visibility
16774 cycling) will not occur.")
16776 (defvar org-tab-after-check-for-table-hook nil
16777 "Hook for functions to attach themselves to TAB.
16778 See `org-ctrl-c-ctrl-c-hook' for more information.
16779 This hook runs after it has been established that the cursor is not in a
16780 table, but before checking if the cursor is in a headline or if global cycling
16781 should be done.
16782 If any function in this hook returns t, not other actions like visibility
16783 cycling will be done.")
16785 (defvar org-tab-after-check-for-cycling-hook nil
16786 "Hook for functions to attach themselves to TAB.
16787 See `org-ctrl-c-ctrl-c-hook' for more information.
16788 This hook runs after it has been established that not table field motion and
16789 not visibility should be done because of current context. This is probably
16790 the place where a package like yasnippets can hook in.")
16792 (defvar org-tab-before-tab-emulation-hook nil
16793 "Hook for functions to attach themselves to TAB.
16794 See `org-ctrl-c-ctrl-c-hook' for more information.
16795 This hook runs after every other options for TAB have been exhausted, but
16798 (defvar org-metaleft-hook nil
16799 "Hook for functions attaching themselves to `M-left'.
16800 See `org-ctrl-c-ctrl-c-hook' for more information.")
16801 (defvar org-metaright-hook nil
16802 "Hook for functions attaching themselves to `M-right'.
16803 See `org-ctrl-c-ctrl-c-hook' for more information.")
16804 (defvar org-metaup-hook nil
16805 "Hook for functions attaching themselves to `M-up'.
16806 See `org-ctrl-c-ctrl-c-hook' for more information.")
16807 (defvar org-metadown-hook nil
16808 "Hook for functions attaching themselves to `M-down'.
16809 See `org-ctrl-c-ctrl-c-hook' for more information.")
16810 (defvar org-shiftmetaleft-hook nil
16811 "Hook for functions attaching themselves to `M-S-left'.
16812 See `org-ctrl-c-ctrl-c-hook' for more information.")
16813 (defvar org-shiftmetaright-hook nil
16814 "Hook for functions attaching themselves to `M-S-right'.
16815 See `org-ctrl-c-ctrl-c-hook' for more information.")
16816 (defvar org-shiftmetaup-hook nil
16817 "Hook for functions attaching themselves to `M-S-up'.
16818 See `org-ctrl-c-ctrl-c-hook' for more information.")
16819 (defvar org-shiftmetadown-hook nil
16820 "Hook for functions attaching themselves to `M-S-down'.
16821 See `org-ctrl-c-ctrl-c-hook' for more information.")
16822 (defvar org-metareturn-hook nil
16823 "Hook for functions attaching themselves to `M-RET'.
16824 See `org-ctrl-c-ctrl-c-hook' for more information.")
16825 (defvar org-shiftup-hook nil
16826 "Hook for functions attaching themselves to `S-up'.
16827 See `org-ctrl-c-ctrl-c-hook' for more information.")
16828 (defvar org-shiftup-final-hook nil
16829 "Hook for functions attaching themselves to `S-up'.
16830 This one runs after all other options except shift-select have been excluded.
16831 See `org-ctrl-c-ctrl-c-hook' for more information.")
16832 (defvar org-shiftdown-hook nil
16833 "Hook for functions attaching themselves to `S-down'.
16834 See `org-ctrl-c-ctrl-c-hook' for more information.")
16835 (defvar org-shiftdown-final-hook nil
16836 "Hook for functions attaching themselves to `S-down'.
16837 This one runs after all other options except shift-select have been excluded.
16838 See `org-ctrl-c-ctrl-c-hook' for more information.")
16839 (defvar org-shiftleft-hook nil
16840 "Hook for functions attaching themselves to `S-left'.
16841 See `org-ctrl-c-ctrl-c-hook' for more information.")
16842 (defvar org-shiftleft-final-hook nil
16843 "Hook for functions attaching themselves to `S-left'.
16844 This one runs after all other options except shift-select have been excluded.
16845 See `org-ctrl-c-ctrl-c-hook' for more information.")
16846 (defvar org-shiftright-hook nil
16847 "Hook for functions attaching themselves to `S-right'.
16848 See `org-ctrl-c-ctrl-c-hook' for more information.")
16849 (defvar org-shiftright-final-hook nil
16850 "Hook for functions attaching themselves to `S-right'.
16851 This one runs after all other options except shift-select have been excluded.
16852 See `org-ctrl-c-ctrl-c-hook' for more information.")
16854 (defun org-modifier-cursor-error ()
16855 "Throw an error, a modified cursor command was applied in wrong context."
16856 (error "This command is active in special context like tables, headlines or items"))
16858 (defun org-shiftselect-error ()
16859 "Throw an error because Shift-Cursor command was applied in wrong context."
16860 (if (and (boundp 'shift-select-mode) shift-select-mode)
16861 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16862 (error "This command works only in special context like headlines or timestamps")))
16864 (defun org-call-for-shift-select (cmd)
16865 (let ((this-command-keys-shift-translated t))
16866 (call-interactively cmd)))
16868 (defun org-shifttab (&optional arg)
16869 "Global visibility cycling or move to previous table field.
16870 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16871 on context.
16872 See the individual commands for more information."
16873 (interactive "P")
16874 (cond
16875 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16876 ((integerp arg)
16877 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16878 (message "Content view to level: %d" arg)
16879 (org-content (prefix-numeric-value arg2))
16880 (setq org-cycle-global-status 'overview)))
16881 (t (call-interactively 'org-global-cycle))))
16883 (defun org-shiftmetaleft ()
16884 "Promote subtree or delete table column.
16885 Calls `org-promote-subtree', `org-outdent-item',
16886 or `org-table-delete-column', depending on context.
16887 See the individual commands for more information."
16888 (interactive)
16889 (cond
16890 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16891 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16892 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16893 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16894 (t (org-modifier-cursor-error))))
16896 (defun org-shiftmetaright ()
16897 "Demote subtree or insert table column.
16898 Calls `org-demote-subtree', `org-indent-item',
16899 or `org-table-insert-column', depending on context.
16900 See the individual commands for more information."
16901 (interactive)
16902 (cond
16903 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16904 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16905 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16906 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16907 (t (org-modifier-cursor-error))))
16909 (defun org-shiftmetaup (&optional arg)
16910 "Move subtree up or kill table row.
16911 Calls `org-move-subtree-up' or `org-table-kill-row' or
16912 `org-move-item-up' depending on context. See the individual commands
16913 for more information."
16914 (interactive "P")
16915 (cond
16916 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16917 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16918 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16919 ((org-at-item-p) (call-interactively 'org-move-item-up))
16920 (t (org-modifier-cursor-error))))
16922 (defun org-shiftmetadown (&optional arg)
16923 "Move subtree down or insert table row.
16924 Calls `org-move-subtree-down' or `org-table-insert-row' or
16925 `org-move-item-down', depending on context. See the individual
16926 commands for more information."
16927 (interactive "P")
16928 (cond
16929 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16930 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16931 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16932 ((org-at-item-p) (call-interactively 'org-move-item-down))
16933 (t (org-modifier-cursor-error))))
16935 (defsubst org-hidden-tree-error ()
16936 (error
16937 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16939 (defun org-metaleft (&optional arg)
16940 "Promote heading or move table column to left.
16941 Calls `org-do-promote' or `org-table-move-column', depending on context.
16942 With no specific context, calls the Emacs default `backward-word'.
16943 See the individual commands for more information."
16944 (interactive "P")
16945 (cond
16946 ((run-hook-with-args-until-success 'org-metaleft-hook))
16947 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16948 ((or (org-on-heading-p)
16949 (and (org-region-active-p)
16950 (save-excursion
16951 (goto-char (region-beginning))
16952 (org-on-heading-p))))
16953 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16954 (call-interactively 'org-do-promote))
16955 ((or (org-at-item-p)
16956 (and (org-region-active-p)
16957 (save-excursion
16958 (goto-char (region-beginning))
16959 (org-at-item-p))))
16960 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16961 (call-interactively 'org-outdent-item))
16962 (t (call-interactively 'backward-word))))
16964 (defun org-metaright (&optional arg)
16965 "Demote subtree or move table column to right.
16966 Calls `org-do-demote' or `org-table-move-column', depending on context.
16967 With no specific context, calls the Emacs default `forward-word'.
16968 See the individual commands for more information."
16969 (interactive "P")
16970 (cond
16971 ((run-hook-with-args-until-success 'org-metaright-hook))
16972 ((org-at-table-p) (call-interactively 'org-table-move-column))
16973 ((or (org-on-heading-p)
16974 (and (org-region-active-p)
16975 (save-excursion
16976 (goto-char (region-beginning))
16977 (org-on-heading-p))))
16978 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16979 (call-interactively 'org-do-demote))
16980 ((or (org-at-item-p)
16981 (and (org-region-active-p)
16982 (save-excursion
16983 (goto-char (region-beginning))
16984 (org-at-item-p))))
16985 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16986 (call-interactively 'org-indent-item))
16987 (t (call-interactively 'forward-word))))
16989 (defun org-check-for-hidden (what)
16990 "Check if there are hidden headlines/items in the current visual line.
16991 WHAT can be either `headlines' or `items'. If the current line is
16992 an outline or item heading and it has a folded subtree below it,
16993 this function returns t, nil otherwise."
16994 (let ((re (cond
16995 ((eq what 'headlines) (concat "^" org-outline-regexp))
16996 ((eq what 'items) (concat "^" (org-item-re t)))
16997 (t (error "This should not happen"))))
16998 beg end)
16999 (save-excursion
17000 (catch 'exit
17001 (unless (org-region-active-p)
17002 (setq beg (point-at-bol))
17003 (beginning-of-line 2)
17004 (while (and (not (eobp)) ;; this is like `next-line'
17005 (get-char-property (1- (point)) 'invisible))
17006 (beginning-of-line 2))
17007 (setq end (point))
17008 (goto-char beg)
17009 (goto-char (point-at-eol))
17010 (setq end (max end (point)))
17011 (while (re-search-forward re end t)
17012 (if (get-char-property (match-beginning 0) 'invisible)
17013 (throw 'exit t))))
17014 nil))))
17016 (defun org-metaup (&optional arg)
17017 "Move subtree up or move table row up.
17018 Calls `org-move-subtree-up' or `org-table-move-row' or
17019 `org-move-item-up', depending on context. See the individual commands
17020 for more information."
17021 (interactive "P")
17022 (cond
17023 ((run-hook-with-args-until-success 'org-metaup-hook))
17024 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17025 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17026 ((org-at-item-p) (call-interactively 'org-move-item-up))
17027 (t (transpose-lines 1) (beginning-of-line -1))))
17029 (defun org-metadown (&optional arg)
17030 "Move subtree down or move table row down.
17031 Calls `org-move-subtree-down' or `org-table-move-row' or
17032 `org-move-item-down', depending on context. See the individual
17033 commands for more information."
17034 (interactive "P")
17035 (cond
17036 ((run-hook-with-args-until-success 'org-metadown-hook))
17037 ((org-at-table-p) (call-interactively 'org-table-move-row))
17038 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17039 ((org-at-item-p) (call-interactively 'org-move-item-down))
17040 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17042 (defun org-shiftup (&optional arg)
17043 "Increase item in timestamp or increase priority of current headline.
17044 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17045 depending on context. See the individual commands for more information."
17046 (interactive "P")
17047 (cond
17048 ((run-hook-with-args-until-success 'org-shiftup-hook))
17049 ((and org-support-shift-select (org-region-active-p))
17050 (org-call-for-shift-select 'previous-line))
17051 ((org-at-timestamp-p t)
17052 (call-interactively (if org-edit-timestamp-down-means-later
17053 'org-timestamp-down 'org-timestamp-up)))
17054 ((and (not (eq org-support-shift-select 'always))
17055 org-enable-priority-commands
17056 (org-on-heading-p))
17057 (call-interactively 'org-priority-up))
17058 ((and (not org-support-shift-select) (org-at-item-p))
17059 (call-interactively 'org-previous-item))
17060 ((org-clocktable-try-shift 'up arg))
17061 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17062 (org-support-shift-select
17063 (org-call-for-shift-select 'previous-line))
17064 (t (org-shiftselect-error))))
17066 (defun org-shiftdown (&optional arg)
17067 "Decrease item in timestamp or decrease priority of current headline.
17068 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17069 depending on context. See the individual commands for more information."
17070 (interactive "P")
17071 (cond
17072 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17073 ((and org-support-shift-select (org-region-active-p))
17074 (org-call-for-shift-select 'next-line))
17075 ((org-at-timestamp-p t)
17076 (call-interactively (if org-edit-timestamp-down-means-later
17077 'org-timestamp-up 'org-timestamp-down)))
17078 ((and (not (eq org-support-shift-select 'always))
17079 org-enable-priority-commands
17080 (org-on-heading-p))
17081 (call-interactively 'org-priority-down))
17082 ((and (not org-support-shift-select) (org-at-item-p))
17083 (call-interactively 'org-next-item))
17084 ((org-clocktable-try-shift 'down arg))
17085 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17086 (org-support-shift-select
17087 (org-call-for-shift-select 'next-line))
17088 (t (org-shiftselect-error))))
17090 (defun org-shiftright (&optional arg)
17091 "Cycle the thing at point or in the current line, depending on context.
17092 Depending on context, this does one of the following:
17094 - switch a timestamp at point one day into the future
17095 - on a headline, switch to the next TODO keyword.
17096 - on an item, switch entire list to the next bullet type
17097 - on a property line, switch to the next allowed value
17098 - on a clocktable definition line, move time block into the future"
17099 (interactive "P")
17100 (cond
17101 ((run-hook-with-args-until-success 'org-shiftright-hook))
17102 ((and org-support-shift-select (org-region-active-p))
17103 (org-call-for-shift-select 'forward-char))
17104 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17105 ((and (not (eq org-support-shift-select 'always))
17106 (org-on-heading-p))
17107 (let ((org-inhibit-logging
17108 (not org-treat-S-cursor-todo-selection-as-state-change))
17109 (org-inhibit-blocking
17110 (not org-treat-S-cursor-todo-selection-as-state-change)))
17111 (org-call-with-arg 'org-todo 'right)))
17112 ((or (and org-support-shift-select
17113 (not (eq org-support-shift-select 'always))
17114 (org-at-item-bullet-p))
17115 (and (not org-support-shift-select) (org-at-item-p)))
17116 (org-call-with-arg 'org-cycle-list-bullet nil))
17117 ((and (not (eq org-support-shift-select 'always))
17118 (org-at-property-p))
17119 (call-interactively 'org-property-next-allowed-value))
17120 ((org-clocktable-try-shift 'right arg))
17121 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17122 (org-support-shift-select
17123 (org-call-for-shift-select 'forward-char))
17124 (t (org-shiftselect-error))))
17126 (defun org-shiftleft (&optional arg)
17127 "Cycle the thing at point or in the current line, depending on context.
17128 Depending on context, this does one of the following:
17130 - switch a timestamp at point one day into the past
17131 - on a headline, switch to the previous TODO keyword.
17132 - on an item, switch entire list to the previous bullet type
17133 - on a property line, switch to the previous allowed value
17134 - on a clocktable definition line, move time block into the past"
17135 (interactive "P")
17136 (cond
17137 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17138 ((and org-support-shift-select (org-region-active-p))
17139 (org-call-for-shift-select 'backward-char))
17140 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17141 ((and (not (eq org-support-shift-select 'always))
17142 (org-on-heading-p))
17143 (let ((org-inhibit-logging
17144 (not org-treat-S-cursor-todo-selection-as-state-change))
17145 (org-inhibit-blocking
17146 (not org-treat-S-cursor-todo-selection-as-state-change)))
17147 (org-call-with-arg 'org-todo 'left)))
17148 ((or (and org-support-shift-select
17149 (not (eq org-support-shift-select 'always))
17150 (org-at-item-bullet-p))
17151 (and (not org-support-shift-select) (org-at-item-p)))
17152 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17153 ((and (not (eq org-support-shift-select 'always))
17154 (org-at-property-p))
17155 (call-interactively 'org-property-previous-allowed-value))
17156 ((org-clocktable-try-shift 'left arg))
17157 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17158 (org-support-shift-select
17159 (org-call-for-shift-select 'backward-char))
17160 (t (org-shiftselect-error))))
17162 (defun org-shiftcontrolright ()
17163 "Switch to next TODO set."
17164 (interactive)
17165 (cond
17166 ((and org-support-shift-select (org-region-active-p))
17167 (org-call-for-shift-select 'forward-word))
17168 ((and (not (eq org-support-shift-select 'always))
17169 (org-on-heading-p))
17170 (org-call-with-arg 'org-todo 'nextset))
17171 (org-support-shift-select
17172 (org-call-for-shift-select 'forward-word))
17173 (t (org-shiftselect-error))))
17175 (defun org-shiftcontrolleft ()
17176 "Switch to previous TODO set."
17177 (interactive)
17178 (cond
17179 ((and org-support-shift-select (org-region-active-p))
17180 (org-call-for-shift-select 'backward-word))
17181 ((and (not (eq org-support-shift-select 'always))
17182 (org-on-heading-p))
17183 (org-call-with-arg 'org-todo 'previousset))
17184 (org-support-shift-select
17185 (org-call-for-shift-select 'backward-word))
17186 (t (org-shiftselect-error))))
17188 (defun org-ctrl-c-ret ()
17189 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17190 (interactive)
17191 (cond
17192 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17193 (t (call-interactively 'org-insert-heading))))
17195 (defun org-copy-special ()
17196 "Copy region in table or copy current subtree.
17197 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17198 See the individual commands for more information."
17199 (interactive)
17200 (call-interactively
17201 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17203 (defun org-cut-special ()
17204 "Cut region in table or cut current subtree.
17205 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17206 See the individual commands for more information."
17207 (interactive)
17208 (call-interactively
17209 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17211 (defun org-paste-special (arg)
17212 "Paste rectangular region into table, or past subtree relative to level.
17213 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17214 See the individual commands for more information."
17215 (interactive "P")
17216 (if (org-at-table-p)
17217 (org-table-paste-rectangle)
17218 (org-paste-subtree arg)))
17220 (defun org-edit-special (&optional arg)
17221 "Call a special editor for the stuff at point.
17222 When at a table, call the formula editor with `org-table-edit-formulas'.
17223 When at the first line of an src example, call `org-edit-src-code'.
17224 When in an #+include line, visit the include file. Otherwise call
17225 `ffap' to visit the file at point."
17226 (interactive)
17227 ;; possibly prep session before editing source
17228 (when arg
17229 (let* ((info (org-babel-get-src-block-info))
17230 (lang (nth 0 info))
17231 (params (nth 2 info))
17232 (session (cdr (assoc :session params))))
17233 (when (and info session) ;; we are in a source-code block with a session
17234 (funcall
17235 (intern (concat "org-babel-prep-session:" lang)) session params))))
17236 (cond ;; proceed with `org-edit-special'
17237 ((save-excursion
17238 (beginning-of-line 1)
17239 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17240 (find-file (org-trim (match-string 1))))
17241 ((org-edit-src-code))
17242 ((org-edit-fixed-width-region))
17243 ((org-at-table.el-p)
17244 (org-edit-src-code))
17245 ((org-at-table-p)
17246 (call-interactively 'org-table-edit-formulas))
17247 (t (call-interactively 'ffap))))
17250 (defun org-ctrl-c-ctrl-c (&optional arg)
17251 "Set tags in headline, or update according to changed information at point.
17253 This command does many different things, depending on context:
17255 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17256 this is what we do.
17258 - If the cursor is on a statistics cookie, update it.
17260 - If the cursor is in a headline, prompt for tags and insert them
17261 into the current line, aligned to `org-tags-column'. When called
17262 with prefix arg, realign all tags in the current buffer.
17264 - If the cursor is in one of the special #+KEYWORD lines, this
17265 triggers scanning the buffer for these lines and updating the
17266 information.
17268 - If the cursor is inside a table, realign the table. This command
17269 works even if the automatic table editor has been turned off.
17271 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17272 the entire table.
17274 - If the cursor is at a footnote reference or definition, jump to
17275 the corresponding definition or references, respectively.
17277 - If the cursor is a the beginning of a dynamic block, update it.
17279 - If the current buffer is a capture buffer, close note and file it.
17281 - If the cursor is on a <<<target>>>, update radio targets and
17282 corresponding links in this buffer.
17284 - If the cursor is on a numbered item in a plain list, renumber the
17285 ordered list.
17287 - If the cursor is on a checkbox, toggle it.
17289 - If the cursor is on a code block, evaluate it. The variable
17290 `org-confirm-babel-evaluate' can be used to control prompting
17291 before code block evaluation, by default every code block
17292 evaluation requires confirmation. Code block evaluation can be
17293 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17294 (interactive "P")
17295 (let ((org-enable-table-editor t))
17296 (cond
17297 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17298 org-occur-highlights
17299 org-latex-fragment-image-overlays)
17300 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17301 (org-remove-occur-highlights)
17302 (org-remove-latex-fragment-image-overlays)
17303 (message "Temporary highlights/overlays removed from current buffer"))
17304 ((and (local-variable-p 'org-finish-function (current-buffer))
17305 (fboundp org-finish-function))
17306 (funcall org-finish-function))
17307 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17308 ((or (looking-at org-property-start-re)
17309 (org-at-property-p))
17310 (call-interactively 'org-property-action))
17311 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17313 (or (org-on-heading-p) (org-at-item-p)))
17314 (call-interactively 'org-update-statistics-cookies))
17315 ((org-on-heading-p) (call-interactively 'org-set-tags))
17316 ((org-at-table.el-p)
17317 (message "Use C-c ' to edit table.el tables"))
17318 ((org-at-table-p)
17319 (org-table-maybe-eval-formula)
17320 (if arg
17321 (call-interactively 'org-table-recalculate)
17322 (org-table-maybe-recalculate-line))
17323 (call-interactively 'org-table-align))
17324 ((or (org-footnote-at-reference-p)
17325 (org-footnote-at-definition-p))
17326 (call-interactively 'org-footnote-action))
17327 ((org-at-item-checkbox-p)
17328 (call-interactively 'org-list-repair)
17329 (call-interactively 'org-toggle-checkbox)
17330 (org-list-send-list 'maybe))
17331 ((org-at-item-p)
17332 (call-interactively 'org-list-repair)
17333 (when arg (call-interactively 'org-toggle-checkbox))
17334 (org-list-send-list 'maybe))
17335 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17336 ;; Dynamic block
17337 (beginning-of-line 1)
17338 (save-excursion (org-update-dblock)))
17339 ((save-excursion
17340 (beginning-of-line 1)
17342 (cond
17343 ((equal (match-string 1) "TBLFM")
17344 ;; Recalculate the table before this line
17345 (save-excursion
17346 (beginning-of-line 1)
17348 (if (org-at-table-p)
17349 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17350 (t
17351 (let ((org-inhibit-startup-visibility-stuff t)
17352 (org-startup-align-all-tables nil))
17353 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17354 (message "Local setup has been refreshed"))))
17355 ((org-clock-update-time-maybe))
17356 (t (error "C-c C-c can do nothing useful at this location")))))
17358 (defun org-mode-restart ()
17359 "Restart Org-mode, to scan again for special lines.
17360 Also updates the keyword regular expressions."
17361 (interactive)
17362 (org-mode)
17363 (message "Org-mode restarted"))
17365 (defun org-kill-note-or-show-branches ()
17366 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17367 (interactive)
17368 (if (not org-finish-function)
17369 (progn
17370 (hide-subtree)
17371 (call-interactively 'show-branches))
17372 (let ((org-note-abort t))
17373 (funcall org-finish-function))))
17375 (defun org-return (&optional indent)
17376 "Goto next table row or insert a newline.
17377 Calls `org-table-next-row' or `newline', depending on context.
17378 See the individual commands for more information."
17379 (interactive)
17380 (cond
17381 ((bobp) (if indent (newline-and-indent) (newline)))
17382 ((org-at-table-p)
17383 (org-table-justify-field-maybe)
17384 (call-interactively 'org-table-next-row))
17385 ((and org-return-follows-link
17386 (eq (get-text-property (point) 'face) 'org-link))
17387 (call-interactively 'org-open-at-point))
17388 ((and (org-at-heading-p)
17389 (looking-at
17391 (org-show-entry)
17392 (end-of-line 1)
17393 (newline))
17394 (t (if indent (newline-and-indent) (newline)))))
17396 (defun org-return-indent ()
17397 "Goto next table row or insert a newline and indent.
17398 Calls `org-table-next-row' or `newline-and-indent', depending on
17399 context. See the individual commands for more information."
17400 (interactive)
17401 (org-return t))
17403 (defun org-ctrl-c-star ()
17404 "Compute table, or change heading status of lines.
17405 Calls `org-table-recalculate' or `org-toggle-heading',
17406 depending on context."
17407 (interactive)
17408 (cond
17409 ((org-at-table-p)
17410 (call-interactively 'org-table-recalculate))
17411 (t
17412 ;; Convert all lines in region to list items
17413 (call-interactively 'org-toggle-heading))))
17415 (defun org-ctrl-c-minus ()
17416 "Insert separator line in table or modify bullet status of line.
17417 Also turns a plain line or a region of lines into list items.
17418 Calls `org-table-insert-hline', `org-toggle-item', or
17419 `org-cycle-list-bullet', depending on context."
17420 (interactive)
17421 (cond
17422 ((org-at-table-p)
17423 (call-interactively 'org-table-insert-hline))
17424 ((org-region-active-p)
17425 (call-interactively 'org-toggle-item))
17426 ((org-in-item-p)
17427 (call-interactively 'org-cycle-list-bullet))
17428 (t
17429 (call-interactively 'org-toggle-item))))
17431 (defun org-toggle-item ()
17432 "Convert headings or normal lines to items, items to normal lines.
17433 If there is no active region, only the current line is considered.
17435 If the first line in the region is a headline, convert all headlines to items.
17437 If the first line in the region is an item, convert all items to normal lines.
17439 If the first line is normal text, add an item bullet to each line."
17440 (interactive)
17441 (let (l2 l beg end)
17442 (if (org-region-active-p)
17443 (setq beg (region-beginning) end (region-end))
17444 (setq beg (point-at-bol)
17445 end (min (1+ (point-at-eol)) (point-max))))
17446 (save-excursion
17447 (goto-char end)
17448 (setq l2 (org-current-line))
17449 (goto-char beg)
17450 (beginning-of-line 1)
17451 (setq l (1- (org-current-line)))
17452 (if (org-at-item-p)
17453 ;; We already have items, de-itemize
17454 (while (< (setq l (1+ l)) l2)
17455 (when (org-at-item-p)
17457 (delete-region (point) (match-end 0)))
17458 (beginning-of-line 2))
17459 (if (org-on-heading-p)
17460 ;; Headings, convert to items
17461 (while (< (setq l (1+ l)) l2)
17462 (if (looking-at org-outline-regexp)
17463 (replace-match (org-list-bullet-string "-") t t))
17464 (beginning-of-line 2))
17465 ;; normal lines, turn them into items
17466 (while (< (setq l (1+ l)) l2)
17467 (unless (org-at-item-p)
17469 (replace-match
17471 (beginning-of-line 2)))))))
17473 (defun org-toggle-heading (&optional nstars)
17474 "Convert headings to normal text, or items or text to headings.
17475 If there is no active region, only the current line is considered.
17477 If the first line is a heading, remove the stars from all headlines
17478 in the region.
17480 If the first line is a plain list item, turn all plain list items
17481 into headings.
17483 If the first line is a normal line, turn each and every line in the
17484 region into a heading.
17486 When converting a line into a heading, the number of stars is chosen
17487 such that the lines become children of the current entry. However,
17488 when a prefix argument is given, its value determines the number of
17489 stars to add."
17490 (interactive "P")
17491 (let (l2 l itemp beg end)
17492 (if (org-region-active-p)
17493 (setq beg (region-beginning) end (region-end))
17494 (setq beg (point-at-bol)
17495 end (min (1+ (point-at-eol)) (point-max))))
17496 (save-excursion
17497 (goto-char end)
17498 (setq l2 (org-current-line))
17499 (goto-char beg)
17500 (beginning-of-line 1)
17501 (setq l (1- (org-current-line)))
17502 (if (org-on-heading-p)
17503 ;; We already have headlines, de-star them
17504 (while (< (setq l (1+ l)) l2)
17505 (when (org-on-heading-p t)
17506 (and (looking-at outline-regexp) (replace-match "")))
17507 (beginning-of-line 2))
17508 (setq itemp (org-at-item-p))
17509 (let* ((stars
17510 (if nstars
17511 (make-string (prefix-numeric-value current-prefix-arg)
17512 ?*)
17513 (save-excursion
17514 (if (re-search-backward org-complex-heading-regexp nil t)
17515 (match-string 1) ""))))
17516 (add-stars (cond (nstars "")
17517 ((equal stars "") "*")
17518 (org-odd-levels-only "**")
17519 (t "*")))
17520 (rpl (concat stars add-stars " ")))
17521 (while (< (setq l (1+ l)) l2)
17522 (if itemp
17523 (and (org-at-item-p) (replace-match rpl t t))
17524 (unless (org-on-heading-p)
17526 (replace-match (concat rpl (match-string 2))))))
17527 (beginning-of-line 2)))))))
17529 (defun org-meta-return (&optional arg)
17530 "Insert a new heading or wrap a region in a table.
17531 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17532 See the individual commands for more information."
17533 (interactive "P")
17534 (cond
17535 ((run-hook-with-args-until-success 'org-metareturn-hook))
17536 ((org-at-table-p)
17537 (call-interactively 'org-table-wrap-region))
17538 (t (call-interactively 'org-insert-heading))))
17540 ;;; Menu entries
17542 ;; Define the Org-mode menus
17543 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17544 '("Tbl"
17545 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17546 ["Next Field" org-cycle (org-at-table-p)]
17547 ["Previous Field" org-shifttab (org-at-table-p)]
17548 ["Next Row" org-return (org-at-table-p)]
17549 "--"
17550 ["Blank Field" org-table-blank-field (org-at-table-p)]
17551 ["Edit Field" org-table-edit-field (org-at-table-p)]
17552 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17553 "--"
17554 ("Column"
17555 ["Move Column Left" org-metaleft (org-at-table-p)]
17556 ["Move Column Right" org-metaright (org-at-table-p)]
17557 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17558 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17559 ("Row"
17560 ["Move Row Up" org-metaup (org-at-table-p)]
17561 ["Move Row Down" org-metadown (org-at-table-p)]
17562 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17563 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17564 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17565 "--"
17566 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17567 ("Rectangle"
17568 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17569 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17570 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17571 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17572 "--"
17573 ("Calculate"
17574 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17575 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17576 ["Edit Formulas" org-edit-special (org-at-table-p)]
17577 "--"
17578 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17579 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17580 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17581 "--"
17582 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17583 "--"
17584 ["Sum Column/Rectangle" org-table-sum
17585 (or (org-at-table-p) (org-region-active-p))]
17586 ["Which Column?" org-table-current-column (org-at-table-p)])
17587 ["Debug Formulas"
17588 org-table-toggle-formula-debugger
17589 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17590 ["Show Col/Row Numbers"
17591 org-table-toggle-coordinate-overlays
17592 :style toggle
17593 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17594 "--"
17595 ["Create" org-table-create (and (not (org-at-table-p))
17596 org-enable-table-editor)]
17597 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17598 ["Import from File" org-table-import (not (org-at-table-p))]
17599 ["Export to File" org-table-export (org-at-table-p)]
17600 "--"
17601 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17603 (easy-menu-define org-org-menu org-mode-map "Org menu"
17604 '("Org"
17605 ("Show/Hide"
17606 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17607 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17608 ["Sparse Tree..." org-sparse-tree t]
17609 ["Reveal Context" org-reveal t]
17610 ["Show All" show-all t]
17611 "--"
17612 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17613 "--"
17614 ["New Heading" org-insert-heading t]
17615 ("Navigate Headings"
17616 ["Up" outline-up-heading t]
17617 ["Next" outline-next-visible-heading t]
17618 ["Previous" outline-previous-visible-heading t]
17619 ["Next Same Level" outline-forward-same-level t]
17620 ["Previous Same Level" outline-backward-same-level t]
17621 "--"
17622 ["Jump" org-goto t])
17623 ("Edit Structure"
17624 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17625 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17626 "--"
17627 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17628 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17629 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17630 "--"
17631 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17632 "--"
17633 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17634 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17635 ["Demote Heading" org-metaright (not (org-at-table-p))]
17636 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17637 "--"
17638 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17639 "--"
17640 ["Convert to odd levels" org-convert-to-odd-levels t]
17641 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17642 ("Editing"
17643 ["Emphasis..." org-emphasize t]
17644 ["Edit Source Example" org-edit-special t]
17645 "--"
17646 ["Footnote new/jump" org-footnote-action t]
17647 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17648 ("Archive"
17649 ["Archive (default method)" org-archive-subtree-default t]
17650 "--"
17651 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17652 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17653 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17654 )
17655 "--"
17656 ("Hyperlinks"
17657 ["Store Link (Global)" org-store-link t]
17658 ["Find existing link to here" org-occur-link-in-agenda-files t]
17659 ["Insert Link" org-insert-link t]
17660 ["Follow Link" org-open-at-point t]
17661 "--"
17662 ["Next link" org-next-link t]
17663 ["Previous link" org-previous-link t]
17664 "--"
17665 ["Descriptive Links"
17666 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17667 :style radio
17668 :selected (member '(org-link) buffer-invisibility-spec)]
17669 ["Literal Links"
17670 (progn
17671 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17672 :style radio
17673 :selected (not (member '(org-link) buffer-invisibility-spec))])
17674 "--"
17675 ("TODO Lists"
17676 ["TODO/DONE/-" org-todo t]
17677 ("Select keyword"
17678 ["Next keyword" org-shiftright (org-on-heading-p)]
17679 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17680 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17681 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17682 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17683 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17684 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17685 "--"
17686 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17687 :selected org-enforce-todo-dependencies :style toggle :active t]
17688 "Settings for tree at point"
17689 ["Do Children sequentially" org-toggle-ordered-property :style radio
17690 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17691 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17692 ["Do Children parallel" org-toggle-ordered-property :style radio
17693 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17694 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17695 "--"
17696 ["Set Priority" org-priority t]
17697 ["Priority Up" org-shiftup t]
17698 ["Priority Down" org-shiftdown t]
17699 "--"
17700 ["Get news from all feeds" org-feed-update-all t]
17701 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17702 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17703 ("TAGS and Properties"
17704 ["Set Tags" org-set-tags-command t]
17705 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17706 "--"
17707 ["Set property" org-set-property t]
17708 ["Column view of properties" org-columns t]
17709 ["Insert Column View DBlock" org-insert-columns-dblock t])
17710 ("Dates and Scheduling"
17711 ["Timestamp" org-time-stamp t]
17712 ["Timestamp (inactive)" org-time-stamp-inactive t]
17713 ("Change Date"
17714 ["1 Day Later" org-shiftright t]
17715 ["1 Day Earlier" org-shiftleft t]
17716 ["1 ... Later" org-shiftup t]
17717 ["1 ... Earlier" org-shiftdown t])
17718 ["Compute Time Range" org-evaluate-time-range t]
17719 ["Schedule Item" org-schedule t]
17720 ["Deadline" org-deadline t]
17721 "--"
17722 ["Custom time format" org-toggle-time-stamp-overlays
17723 :style radio :selected org-display-custom-times]
17724 "--"
17725 ["Goto Calendar" org-goto-calendar t]
17726 ["Date from Calendar" org-date-from-calendar t]
17727 "--"
17728 ["Start/Restart Timer" org-timer-start t]
17729 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17730 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17731 ["Insert Timer String" org-timer t]
17732 ["Insert Timer Item" org-timer-item t])
17733 ("Logging work"
17734 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17735 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17736 ["Clock out" org-clock-out t]
17737 ["Clock cancel" org-clock-cancel t]
17738 "--"
17739 ["Mark as default task" org-clock-mark-default-task t]
17740 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17741 ["Goto running clock" org-clock-goto t]
17742 "--"
17743 ["Display times" org-clock-display t]
17744 ["Create clock table" org-clock-report t]
17745 "--"
17746 ["Record DONE time"
17747 (progn (setq org-log-done (not org-log-done))
17748 (message "Switching to %s will %s record a timestamp"
17749 (car org-done-keywords)
17750 (if org-log-done "automatically" "not")))
17751 :style toggle :selected org-log-done])
17752 "--"
17753 ["Agenda Command..." org-agenda t]
17754 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17755 ("File List for Agenda")
17756 ("Special views current file"
17757 ["TODO Tree" org-show-todo-tree t]
17758 ["Check Deadlines" org-check-deadlines t]
17759 ["Timeline" org-timeline t]
17760 ["Tags/Property tree" org-match-sparse-tree t])
17761 "--"
17762 ["Export/Publish..." org-export t]
17763 ("LaTeX"
17764 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17765 :selected org-cdlatex-mode]
17766 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17767 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17768 ["Modify math symbol" org-cdlatex-math-modify
17769 (org-inside-LaTeX-fragment-p)]
17770 ["Insert citation" org-reftex-citation t]
17771 "--"
17772 ["Template for BEAMER" org-insert-beamer-options-template t])
17773 "--"
17774 ("MobileOrg"
17775 ["Push Files and Views" org-mobile-push t]
17776 ["Get Captured and Flagged" org-mobile-pull t]
17777 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17778 "--"
17779 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17780 "--"
17781 ("Documentation"
17782 ["Show Version" org-version t]
17783 ["Info Documentation" org-info t])
17784 ("Customize"
17785 ["Browse Org Group" org-customize t]
17786 "--"
17787 ["Expand This Menu" org-create-customize-menu
17788 (fboundp 'customize-menu-create)])
17789 ["Send bug report" org-submit-bug-report t]
17790 "--"
17791 ("Refresh/Reload"
17792 ["Refresh setup current buffer" org-mode-restart t]
17793 ["Reload Org (after update)" org-reload t]
17794 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17795 ))
17797 (defun org-info (&optional node)
17798 "Read documentation for Org-mode in the info system.
17799 With optional NODE, go directly to that node."
17800 (interactive)
17801 (info (format "(org)%s" (or node ""))))
17803 ;;;###autoload
17804 (defun org-submit-bug-report ()
17805 "Submit a bug report on Org-mode via mail.
17807 Don't hesitate to report any problems or inaccurate documentation.
17809 If you don't have setup sending mail from (X)Emacs, please copy the
17810 output buffer into your mail program, as it gives us important
17811 information about your Org-mode version and configuration."
17812 (interactive)
17813 (require 'reporter)
17814 (org-load-modules-maybe)
17815 (org-require-autoloaded-modules)
17816 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17817 (reporter-submit-bug-report
17818 "emacs-orgmode@gnu.org"
17819 (org-version)
17820 (let (list)
17821 (save-window-excursion
17822 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17823 (delete-other-windows)
17824 (erase-buffer)
17825 (insert "You are about to submit a bug report to the Org-mode mailing list.
17827 We would like to add your full Org-mode and Outline configuration to the
17828 bug report. This greatly simplifies the work of the maintainer and
17829 other experts on the mailing list.
17831 HOWEVER, some variables you have customized may contain private
17832 information. The names of customers, colleagues, or friends, might
17833 appear in the form of file names, tags, todo states, or search strings.
17834 If you answer yes to the prompt, you might want to check and remove
17835 such private information before sending the email.")
17836 (add-text-properties (point-min) (point-max) '(face org-warning))
17837 (when (yes-or-no-p "Include your Org-mode configuration ")
17838 (mapatoms
17839 (lambda (v)
17840 (and (boundp v)
17842 (or (and (symbol-value v)
17844 (and
17845 (get v 'custom-type) (get v 'standard-value)
17846 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17847 (push v list)))))
17848 (kill-buffer (get-buffer "*Warn about privacy*"))
17849 list))
17850 nil nil
17851 "Remember to cover the basics, that is, what you expected to happen and
17852 what in fact did happen. You don't know how to make a good report? See
17854 http://orgmode.org/manual/Feedback.html#Feedback
17856 Your bug report will be posted to the Org-mode mailing list.
17857 ------------------------------------------------------------------------")
17858 (save-excursion
17863 (defun org-install-agenda-files-menu ()
17864 (let ((bl (buffer-list)))
17865 (save-excursion
17866 (while bl
17867 (set-buffer (pop bl))
17868 (if (org-mode-p) (setq bl nil)))
17869 (when (org-mode-p)
17870 (easy-menu-change
17871 '("Org") "File List for Agenda"
17872 (append
17873 (list
17874 ["Edit File List" (org-edit-agenda-file-list) t]
17875 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17876 ["Remove Current File from List" org-remove-file t]
17877 ["Cycle through agenda files" org-cycle-agenda-files t]
17878 ["Occur in all agenda files" org-occur-in-agenda-files t]
17879 "--")
17880 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17882 ;;;; Documentation
17884 ;;;###autoload
17885 (defun org-require-autoloaded-modules ()
17886 (interactive)
17887 (mapc 'require
17888 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17889 org-docbook org-exp org-html org-icalendar
17890 org-id org-latex
17891 org-publish org-remember org-table
17892 org-timer org-xoxo)))
17894 ;;;###autoload
17895 (defun org-reload (&optional uncompiled)
17896 "Reload all org lisp files.
17897 With prefix arg UNCOMPILED, load the uncompiled versions."
17898 (interactive "P")
17899 (require 'find-func)
17901 (dir-org (file-name-directory (org-find-library-name "org")))
17902 (dir-org-contrib (ignore-errors
17903 (file-name-directory
17904 (org-find-library-name "org-contribdir"))))
17905 (babel-files
17906 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17907 (append (list nil "comint" "eval" "exp" "keys"
17908 "lob" "ref" "table" "tangle")
17909 (delq nil
17910 (mapcar
17911 (lambda (lang)
17912 (when (cdr lang) (symbol-name (car lang))))
17913 org-babel-load-languages)))))
17914 (files
17915 (append (directory-files dir-org t file-re)
17916 babel-files
17917 (and dir-org-contrib
17918 (directory-files dir-org-contrib t file-re))))
17919 (remove-re (concat (if (featurep 'xemacs)
17920 "org-colview" "org-colview-xemacs")
17922 (setq files (mapcar 'file-name-sans-extension files))
17923 (setq files (mapcar
17924 (lambda (x) (if (string-match remove-re x) nil x))
17925 files))
17926 (setq files (delq nil files))
17927 (mapc
17928 (lambda (f)
17929 (when (featurep (intern (file-name-nondirectory f)))
17930 (if (and (not uncompiled)
17931 (file-exists-p (concat f ".elc")))
17932 (load (concat f ".elc") nil nil t)
17933 (load (concat f ".el") nil nil t))))
17934 files))
17935 (org-version))
17937 ;;;###autoload
17938 (defun org-customize ()
17939 "Call the customize function with org as argument."
17940 (interactive)
17941 (org-load-modules-maybe)
17942 (org-require-autoloaded-modules)
17943 (customize-browse 'org))
17945 (defun org-create-customize-menu ()
17946 "Create a full customization menu for Org-mode, insert it into the menu."
17947 (interactive)
17948 (org-load-modules-maybe)
17949 (org-require-autoloaded-modules)
17950 (if (fboundp 'customize-menu-create)
17951 (progn
17952 (easy-menu-change
17953 '("Org") "Customize"
17954 `(["Browse Org group" org-customize t]
17955 "--"
17956 ,(customize-menu-create 'org)
17957 ["Set" Custom-set t]
17958 ["Save" Custom-save t]
17959 ["Reset to Current" Custom-reset-current t]
17960 ["Reset to Saved" Custom-reset-saved t]
17961 ["Reset to Standard Settings" Custom-reset-standard t]))
17963 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17965 ;;;; Miscellaneous stuff
17967 ;;; Generally useful functions
17969 (defun org-get-at-bol (property)
17970 "Get text property PROPERTY at beginning of line."
17971 (get-text-property (point-at-bol) property))
17973 (defun org-find-text-property-in-string (prop s)
17974 "Return the first non-nil value of property PROP in string S."
17975 (or (get-text-property 0 prop s)
17976 (get-text-property (or (next-single-property-change 0 prop s) 0)
17977 prop s)))
17979 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17980 "Display the given MESSAGE as a warning."
17981 (if (fboundp 'display-warning)
17982 (display-warning 'org message
17983 (if (featurep 'xemacs) 'warning :warning))
17984 (let ((buf (get-buffer-create "*Org warnings*")))
17985 (with-current-buffer buf
17986 (goto-char (point-max))
17987 (insert "Warning (Org): " message)
17988 (unless (bolp)
17989 (newline)))
17990 (display-buffer buf)
17991 (sit-for 0))))
17993 (defun org-in-commented-line ()
17994 "Is point in a line starting with `#'?"
17995 (equal (char-after (point-at-bol)) ?#))
17997 (defun org-in-indented-comment-line ()
17998 "Is point in a line starting with `#' after some white space?"
17999 (save-excursion
18000 (save-match-data
18001 (goto-char (point-at-bol))
18004 (defun org-in-verbatim-emphasis ()
18005 (save-match-data
18006 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18008 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18009 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18010 (if (and marker (marker-buffer marker)
18011 (buffer-live-p (marker-buffer marker)))
18012 (progn
18013 (switch-to-buffer (marker-buffer marker))
18014 (if (or (> marker (point-max)) (< marker (point-min)))
18015 (widen))
18016 (goto-char marker)
18017 (org-show-context 'org-goto))
18018 (if bookmark
18019 (bookmark-jump bookmark)
18020 (error "Cannot find location"))))
18022 (defun org-quote-csv-field (s)
18023 "Quote field for inclusion in CSV material."
18026 s))
18028 (defun org-plist-delete (plist property)
18029 "Delete PROPERTY from PLIST.
18030 This is in contrast to merely setting it to 0."
18031 (let (p)
18032 (while plist
18033 (if (not (eq property (car plist)))
18034 (setq p (plist-put p (car plist) (nth 1 plist))))
18035 (setq plist (cddr plist)))
18036 p))
18038 (defun org-force-self-insert (N)
18039 "Needed to enforce self-insert under remapping."
18040 (interactive "p")
18041 (self-insert-command N))
18043 (defun org-string-width (s)
18044 "Compute width of string, ignoring invisible characters.
18045 This ignores character with invisibility property `org-link', and also
18046 characters with property `org-cwidth', because these will become invisible
18047 upon the next fontification round."
18048 (let (b l)
18049 (when (or (eq t buffer-invisibility-spec)
18050 (assq 'org-link buffer-invisibility-spec))
18051 (while (setq b (text-property-any 0 (length s)
18052 'invisible 'org-link s))
18053 (setq s (concat (substring s 0 b)
18054 (substring s (or (next-single-property-change
18055 b 'invisible s) (length s)))))))
18056 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18057 (setq s (concat (substring s 0 b)
18058 (substring s (or (next-single-property-change
18059 b 'org-cwidth s) (length s))))))
18060 (setq l (string-width s) b -1)
18061 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18062 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18063 l))
18065 (defun org-shorten-string (s maxlength)
18066 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18067 If the string is shorter or has length MAXLENGTH, just return the
18068 original string. If it is longer, the functions finds a space in the
18069 string, breaks this string off at that locations and adds three dots
18070 as ellipsis. Including the ellipsis, the string will not be longer
18071 than MAXLENGTH. If finding a good breaking point in the string does
18072 not work, the string is just chopped off in the middle of a word
18073 if necessary."
18074 (if (<= (length s) maxlength)
18075 s
18076 (let* ((n (max (- maxlength 4) 1))
18078 (if (string-match re s)
18079 (concat (match-string 1 s) "...")
18080 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18082 (defun org-get-indentation (&optional line)
18083 "Get the indentation of the current line, interpreting tabs.
18084 When LINE is given, assume it represents a line and compute its indentation."
18085 (if line
18086 (if (string-match "^ *" (org-remove-tabs line))
18087 (match-end 0))
18088 (save-excursion
18089 (beginning-of-line 1)
18091 (current-column))))
18093 (defun org-remove-tabs (s &optional width)
18094 "Replace tabulators in S with spaces.
18095 Assumes that s is a single line, starting in column 0."
18096 (setq width (or width tab-width))
18098 (setq s (replace-match
18099 (make-string
18100 (- (* width (/ (+ (match-beginning 0) width) width))
18101 (match-beginning 0)) ?\ )
18102 t t s)))
18103 s)
18105 (defun org-fix-indentation (line ind)
18106 "Fix indentation in LINE.
18107 IND is a cons cell with target and minimum indentation.
18108 If the current indentation in LINE is smaller than the minimum,
18109 leave it alone. If it is larger than ind, set it to the target."
18110 (let* ((l (org-remove-tabs line))
18111 (i (org-get-indentation l))
18112 (i1 (car ind)) (i2 (cdr ind)))
18113 (if (>= i i2) (setq l (substring line i2)))
18114 (if (> i1 0)
18115 (concat (make-string i1 ?\ ) l)
18116 l)))
18118 (defun org-remove-indentation (code &optional n)
18119 "Remove the maximum common indentation from the lines in CODE.
18120 N may optionally be the number of spaces to remove."
18121 (with-temp-buffer
18122 (insert code)
18123 (org-do-remove-indentation n)
18124 (buffer-string)))
18126 (defun org-do-remove-indentation (&optional n)
18127 "Remove the maximum common indentation from the buffer."
18128 (untabify (point-min) (point-max))
18129 (let ((min 10000) re)
18130 (if n
18131 (setq min n)
18132 (goto-char (point-min))
18134 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18135 (unless (or (= min 0) (= min 10000))
18137 (goto-char (point-min))
18138 (while (re-search-forward re nil t)
18139 (replace-match "")
18140 (end-of-line 1))
18141 min)))
18143 (defun org-fill-template (template alist)
18144 "Find each %key of ALIST in TEMPLATE and replace it."
18145 (let ((case-fold-search nil)
18146 entry key value)
18147 (setq alist (sort (copy-sequence alist)
18148 (lambda (a b) (< (length (car a)) (length (car b))))))
18149 (while (setq entry (pop alist))
18150 (setq template
18151 (replace-regexp-in-string
18152 (concat "%" (regexp-quote (car entry)))
18153 (cdr entry) template t t)))
18154 template))
18156 (defun org-base-buffer (buffer)
18157 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18158 (if (not buffer)
18159 buffer
18160 (or (buffer-base-buffer buffer)
18161 buffer)))
18163 (defun org-trim (s)
18164 "Remove whitespace at beginning and end of string."
18167 s)
18169 (defun org-wrap (string &optional width lines)
18170 "Wrap string to either a number of lines, or a width in characters.
18171 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18172 that costs. If there is a word longer than WIDTH, the text is actually
18173 wrapped to the length of that word.
18174 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18175 many lines, whatever width that takes.
18176 The return value is a list of lines, without newlines at the end."
18178 (maxword (apply 'max (mapcar 'org-string-width words)))
18179 w ll)
18180 (cond (width
18181 (org-do-wrap words (max maxword width)))
18182 (lines
18183 (setq w maxword)
18184 (setq ll (org-do-wrap words maxword))
18185 (if (<= (length ll) lines)
18186 ll
18187 (setq ll words)
18188 (while (> (length ll) lines)
18189 (setq w (1+ w))
18190 (setq ll (org-do-wrap words w)))
18191 ll))
18192 (t (error "Cannot wrap this")))))
18194 (defun org-do-wrap (words width)
18195 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18196 (let (lines line)
18197 (while words
18198 (setq line (pop words))
18199 (while (and words (< (+ (length line) (length (car words))) width))
18200 (setq line (concat line " " (pop words))))
18201 (setq lines (push line lines)))
18202 (nreverse lines)))
18204 (defun org-split-string (string &optional separators)
18205 "Splits STRING into substrings at SEPARATORS.
18206 No empty strings are returned if there are matches at the beginning
18207 and end of string."
18209 (start 0)
18210 notfirst
18211 (list nil))
18212 (while (and (string-match rexp string
18213 (if (and notfirst
18214 (= start (match-beginning 0))
18215 (< start (length string)))
18216 (1+ start) start))
18217 (< (match-beginning 0) (length string)))
18218 (setq notfirst t)
18219 (or (eq (match-beginning 0) 0)
18220 (and (eq (match-beginning 0) (match-end 0))
18221 (eq (match-beginning 0) start))
18222 (setq list
18223 (cons (substring string start (match-beginning 0))
18224 list)))
18225 (setq start (match-end 0)))
18226 (or (eq start (length string))
18227 (setq list
18228 (cons (substring string start)
18229 list)))
18230 (nreverse list)))
18232 (defun org-quote-vert (s)
18234 (while (string-match "|" s)
18236 s)
18238 (defun org-uuidgen-p (s)
18239 "Is S an ID created by UUIDGEN?"
18240 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18242 (defun org-context ()
18243 "Return a list of contexts of the current cursor position.
18244 If several contexts apply, all are returned.
18245 Each context entry is a list with a symbol naming the context, and
18246 two positions indicating start and end of the context. Possible
18247 contexts are:
18249 :headline anywhere in a headline
18250 :headline-stars on the leading stars in a headline
18251 :todo-keyword on a TODO keyword (including DONE) in a headline
18252 :tags on the TAGS in a headline
18253 :priority on the priority cookie in a headline
18254 :item on the first line of a plain list item
18255 :item-bullet on the bullet/number of a plain list item
18256 :checkbox on the checkbox in a plain list item
18257 :table in an org-mode table
18258 :table-special on a special filed in a table
18259 :table-table in a table.el table
18260 :link on a hyperlink
18261 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18262 :target on a <<target>>
18263 :radio-target on a <<<radio-target>>>
18264 :latex-fragment on a LaTeX fragment
18265 :latex-preview on a LaTeX fragment with overlayed preview image
18267 This function expects the position to be visible because it uses font-lock
18268 faces as a help to recognize the following contexts: :table-special, :link,
18269 and :keyword."
18270 (let* ((f (get-text-property (point) 'face))
18271 (faces (if (listp f) f (list f)))
18272 (p (point)) clist o)
18273 ;; First the large context
18274 (cond
18275 ((org-on-heading-p t)
18276 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18277 (when (progn
18278 (beginning-of-line 1)
18279 (looking-at org-todo-line-tags-regexp))
18280 (push (org-point-in-group p 1 :headline-stars) clist)
18281 (push (org-point-in-group p 2 :todo-keyword) clist)
18282 (push (org-point-in-group p 4 :tags) clist))
18283 (goto-char p)
18286 (push (org-point-in-group p 0 :priority) clist)))
18288 ((org-at-item-p)
18289 (push (org-point-in-group p 2 :item-bullet) clist)
18290 (push (list :item (point-at-bol)
18291 (save-excursion (org-end-of-item) (point)))
18292 clist)
18293 (and (org-at-item-checkbox-p)
18294 (push (org-point-in-group p 0 :checkbox) clist)))
18296 ((org-at-table-p)
18297 (push (list :table (org-table-begin) (org-table-end)) clist)
18298 (if (memq 'org-formula faces)
18299 (push (list :table-special
18300 (previous-single-property-change p 'face)
18301 (next-single-property-change p 'face)) clist)))
18302 ((org-at-table-p 'any)
18303 (push (list :table-table) clist)))
18304 (goto-char p)
18306 ;; Now the small context
18307 (cond
18308 ((org-at-timestamp-p)
18309 (push (org-point-in-group p 0 :timestamp) clist))
18310 ((memq 'org-link faces)
18311 (push (list :link
18312 (previous-single-property-change p 'face)
18313 (next-single-property-change p 'face)) clist))
18314 ((memq 'org-special-keyword faces)
18315 (push (list :keyword
18316 (previous-single-property-change p 'face)
18317 (next-single-property-change p 'face)) clist))
18318 ((org-on-target-p)
18319 (push (org-point-in-group p 0 :target) clist)
18320 (goto-char (1- (match-beginning 0)))
18321 (if (looking-at org-radio-target-regexp)
18322 (push (org-point-in-group p 0 :radio-target) clist))
18323 (goto-char p))
18324 ((setq o (car (delq nil
18325 (mapcar
18326 (lambda (x)
18327 (if (memq x org-latex-fragment-image-overlays) x))
18328 (overlays-at (point))))))
18329 (push (list :latex-fragment
18330 (overlay-start o) (overlay-end o)) clist)
18331 (push (list :latex-preview
18332 (overlay-start o) (overlay-end o)) clist))
18333 ((org-inside-LaTeX-fragment-p)
18334 ;; FIXME: positions wrong.
18335 (push (list :latex-fragment (point) (point)) clist)))
18337 (setq clist (nreverse (delq nil clist)))
18338 clist))
18340 ;; FIXME: Compare with at-regexp-p Do we need both?
18341 (defun org-in-regexp (re &optional nlines visually)
18342 "Check if point is inside a match of regexp.
18343 Normally only the current line is checked, but you can include NLINES extra
18344 lines both before and after point into the search.
18345 If VISUALLY is set, require that the cursor is not after the match but
18346 really on, so that the block visually is on the match."
18347 (catch 'exit
18348 (let ((pos (point))
18349 (eol (point-at-eol (+ 1 (or nlines 0))))
18350 (inc (if visually 1 0)))
18351 (save-excursion
18352 (beginning-of-line (- 1 (or nlines 0)))
18353 (while (re-search-forward re eol t)
18354 (if (and (<= (match-beginning 0) pos)
18355 (>= (+ inc (match-end 0)) pos))
18356 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18358 (defun org-at-regexp-p (regexp)
18359 "Is point inside a match of REGEXP in the current line?"
18360 (catch 'exit
18361 (save-excursion
18362 (let ((pos (point)) (end (point-at-eol)))
18363 (beginning-of-line 1)
18364 (while (re-search-forward regexp end t)
18365 (if (and (<= (match-beginning 0) pos)
18366 (>= (match-end 0) pos))
18367 (throw 'exit t)))
18368 nil))))
18370 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18371 "Return t if the current point is between matches of START-RE and END-RE.
18372 This will also return t if point is on one of the two matches or
18373 in an unfinished block. END-RE can be a string or a form
18374 returning a string.
18376 An optional third argument bounds the search for START-RE. It
18377 defaults to previous heading or `point-min'."
18378 (let ((pos (point))
18379 (limit (or bound (save-excursion (outline-previous-heading)))))
18380 (save-excursion
18381 ;; we're on a block when point is on start-re...
18382 (or (org-at-regexp-p start-re)
18383 ;; ... or start-re can be found above...
18384 (and (re-search-backward start-re limit t)
18385 ;; ... but no end-re between start-re and point.
18386 (not (re-search-forward (eval end-re) pos t)))))))
18388 (defun org-occur-in-agenda-files (regexp &optional nlines)
18389 "Call `multi-occur' with buffers for all agenda files."
18391 (let* ((files (org-agenda-files))
18392 (tnames (mapcar 'file-truename files))
18393 (extra org-agenda-text-search-extra-files)
18394 f)
18395 (when (eq (car extra) 'agenda-archives)
18396 (setq extra (cdr extra))
18397 (setq files (org-add-archive-files files)))
18398 (while (setq f (pop extra))
18399 (unless (member (file-truename f) tnames)
18400 (add-to-list 'files f 'append)
18401 (add-to-list 'tnames (file-truename f) 'append)))
18402 (multi-occur
18403 (mapcar (lambda (x)
18404 (with-current-buffer
18405 (or (get-file-buffer x) (find-file-noselect x))
18406 (widen)
18407 (current-buffer)))
18408 files)
18409 regexp)))
18411 (if (boundp 'occur-mode-find-occurrence-hook)
18412 ;; Emacs 23
18413 (add-hook 'occur-mode-find-occurrence-hook
18414 (lambda ()
18415 (when (org-mode-p)
18416 (org-reveal))))
18417 ;; Emacs 22
18418 (defadvice occur-mode-goto-occurrence
18419 (after org-occur-reveal activate)
18420 (and (org-mode-p) (org-reveal)))
18421 (defadvice occur-mode-goto-occurrence-other-window
18422 (after org-occur-reveal activate)
18423 (and (org-mode-p) (org-reveal)))
18424 (defadvice occur-mode-display-occurrence
18425 (after org-occur-reveal activate)
18426 (when (org-mode-p)
18427 (let ((pos (occur-mode-find-occurrence)))
18428 (with-current-buffer (marker-buffer pos)
18429 (save-excursion
18430 (goto-char pos)
18431 (org-reveal)))))))
18433 (defun org-occur-link-in-agenda-files ()
18434 "Create a link and search for it in the agendas.
18435 The link is not stored in `org-stored-links', it is just created
18436 for the search purpose."
18437 (interactive)
18438 (let ((link (condition-case nil
18439 (org-store-link nil)
18440 (error "Unable to create a link to here"))))
18441 (org-occur-in-agenda-files (regexp-quote link))))
18443 (defun org-uniquify (list)
18444 "Remove duplicate elements from LIST."
18445 (let (res)
18446 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18447 res))
18449 (defun org-delete-all (elts list)
18450 "Remove all elements in ELTS from LIST."
18451 (while elts
18452 (setq list (delete (pop elts) list)))
18453 list)
18455 (defun org-count (cl-item cl-seq)
18456 "Count the number of occurrences of ITEM in SEQ.
18457 Taken from `count' in cl-seq.el with all keyword arguments removed."
18458 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18459 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18460 (while (< cl-start cl-end)
18461 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18462 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18463 (setq cl-start (1+ cl-start)))
18464 cl-count))
18466 (defun org-remove-if (predicate seq)
18467 "Remove everything from SEQ that fulfills PREDICATE."
18468 (let (res e)
18469 (while seq
18470 (setq e (pop seq))
18471 (if (not (funcall predicate e)) (push e res)))
18472 (nreverse res)))
18474 (defun org-remove-if-not (predicate seq)
18475 "Remove everything from SEQ that does not fulfill PREDICATE."
18476 (let (res e)
18477 (while seq
18478 (setq e (pop seq))
18479 (if (funcall predicate e) (push e res)))
18480 (nreverse res)))
18482 (defun org-back-over-empty-lines ()
18483 "Move backwards over whitespace, to the beginning of the first empty line.
18484 Returns the number of empty lines passed."
18485 (let ((pos (point)))
18487 (beginning-of-line 2)
18488 (goto-char (min (point) pos))
18489 (count-lines (point) pos)))
18491 (defun org-skip-whitespace ()
18494 (defun org-point-in-group (point group &optional context)
18495 "Check if POINT is in match-group GROUP.
18496 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18497 match. If the match group does not exist or point is not inside it,
18498 return nil."
18499 (and (match-beginning group)
18500 (>= point (match-beginning group))
18501 (<= point (match-end group))
18502 (if context
18503 (list context (match-beginning group) (match-end group))
18504 t)))
18506 (defun org-switch-to-buffer-other-window (&rest args)
18507 "Switch to buffer in a second window on the current frame.
18508 In particular, do not allow pop-up frames.
18509 Returns the newly created buffer."
18510 (let (pop-up-frames special-display-buffer-names special-display-regexps
18511 special-display-function)
18512 (apply 'switch-to-buffer-other-window args)))
18514 (defun org-combine-plists (&rest plists)
18515 "Create a single property list from all plists in PLISTS.
18516 The process starts by copying the first list, and then setting properties
18517 from the other lists. Settings in the last list are the most significant
18518 ones and overrule settings in the other lists."
18519 (let ((rtn (copy-sequence (pop plists)))
18520 p v ls)
18521 (while plists
18522 (setq ls (pop plists))
18523 (while ls
18524 (setq p (pop ls) v (pop ls))
18525 (setq rtn (plist-put rtn p v))))
18526 rtn))
18528 (defun org-move-line-down (arg)
18529 "Move the current line down. With prefix argument, move it past ARG lines."
18530 (interactive "p")
18531 (let ((col (current-column))
18532 beg end pos)
18533 (beginning-of-line 1) (setq beg (point))
18534 (beginning-of-line 2) (setq end (point))
18535 (beginning-of-line (+ 1 arg))
18536 (setq pos (move-marker (make-marker) (point)))
18537 (insert (delete-and-extract-region beg end))
18538 (goto-char pos)
18539 (org-move-to-column col)))
18541 (defun org-move-line-up (arg)
18542 "Move the current line up. With prefix argument, move it past ARG lines."
18543 (interactive "p")
18544 (let ((col (current-column))
18545 beg end pos)
18546 (beginning-of-line 1) (setq beg (point))
18547 (beginning-of-line 2) (setq end (point))
18548 (beginning-of-line (- arg))
18549 (setq pos (move-marker (make-marker) (point)))
18550 (insert (delete-and-extract-region beg end))
18551 (goto-char pos)
18552 (org-move-to-column col)))
18554 (defun org-replace-escapes (string table)
18555 "Replace %-escapes in STRING with values in TABLE.
18557 The sequences in STRING may contain normal field width and padding information,
18559 so values can contain further %-escapes if they are define later in TABLE."
18560 (let ((tbl (copy-alist table))
18561 (case-fold-search nil)
18562 (pchg 0)
18563 e re rpl)
18564 (while (setq e (pop tbl))
18565 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18566 (when (and (cdr e) (string-match re (cdr e)))
18567 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18568 (safe "SREF"))
18569 (add-text-properties 0 3 (list 'sref sref) safe)
18570 (setcdr e (replace-match safe t t (cdr e)))))
18571 (while (string-match re string)
18572 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18573 (cdr e)))
18574 (setq string (replace-match rpl t t string))))
18575 (while (setq pchg (next-property-change pchg string))
18576 (let ((sref (get-text-property pchg 'sref string)))
18577 (when (and sref (string-match "SREF" string pchg))
18578 (setq string (replace-match sref t t string)))))
18579 string))
18581 (defun org-sublist (list start end)
18582 "Return a section of LIST, from START to END.
18583 Counting starts at 1."
18584 (let (rtn (c start))
18585 (setq list (nthcdr (1- start) list))
18586 (while (and list (<= c end))
18587 (push (pop list) rtn)
18588 (setq c (1+ c)))
18589 (nreverse rtn)))
18591 (defun org-find-base-buffer-visiting (file)
18592 "Like `find-buffer-visiting' but always return the base buffer and
18593 not an indirect buffer."
18594 (let ((buf (or (get-file-buffer file)
18595 (find-buffer-visiting file))))
18596 (if buf
18597 (or (buffer-base-buffer buf) buf)
18598 nil)))
18600 (defun org-image-file-name-regexp (&optional extensions)
18601 "Return regexp matching the file names of images.
18602 If EXTENSIONS is given, only match these."
18603 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18604 (image-file-name-regexp)
18605 (let ((image-file-name-extensions
18606 (or extensions
18607 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18608 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18610 (regexp-opt (nconc (mapcar 'upcase
18611 image-file-name-extensions)
18612 image-file-name-extensions)
18613 t)
18616 (defun org-file-image-p (file &optional extensions)
18617 "Return non-nil if FILE is an image."
18618 (save-match-data
18619 (string-match (org-image-file-name-regexp extensions) file)))
18621 (defun org-get-cursor-date ()
18622 "Return the date at cursor in as a time.
18623 This works in the calendar and in the agenda, anywhere else it just
18624 returns the current time."
18625 (let (date day defd)
18626 (cond
18627 ((eq major-mode 'calendar-mode)
18628 (setq date (calendar-cursor-to-date)
18629 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18630 ((eq major-mode 'org-agenda-mode)
18631 (setq day (get-text-property (point) 'day))
18632 (if day
18633 (setq date (calendar-gregorian-from-absolute day)
18634 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18635 (nth 2 date))))))
18636 (or defd (current-time))))
18638 (defvar org-agenda-action-marker (make-marker)
18639 "Marker pointing to the entry for the next agenda action.")
18641 (defun org-mark-entry-for-agenda-action ()
18642 "Mark the current entry as target of an agenda action.
18643 Agenda actions are actions executed from the agenda with the key `k',
18644 which make use of the date at the cursor."
18645 (interactive)
18646 (move-marker org-agenda-action-marker
18647 (save-excursion (org-back-to-heading t) (point))
18648 (current-buffer))
18649 (message
18650 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18652 ;;; Paragraph filling stuff.
18653 ;; We want this to be just right, so use the full arsenal.
18655 (defun org-indent-line-function ()
18656 "Indent line like previous, but further if previous was headline or item."
18657 (interactive)
18658 (let* ((pos (point))
18659 (itemp (org-at-item-p))
18660 (case-fold-search t)
18662 (inline-task-p (and (featurep 'org-inlinetask)
18663 (org-inlinetask-in-task-p)))
18664 column bpos bcol tpos tcol)
18665 ;; Find the previous relevant line
18666 (beginning-of-line 1)
18667 (cond
18668 ;; Comments
18669 ((looking-at "#") (setq column 0))
18670 ;; Headings
18672 ;; Drawers
18674 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18675 (save-excursion
18676 (goto-char (1- (match-beginning 1)))
18677 (setq column (current-column))))
18678 ;; Special blocks
18680 (save-excursion
18681 (re-search-backward
18683 (setq column (org-get-indentation (match-string 0))))
18686 (save-excursion
18688 (setq column
18689 (if (equal (downcase (match-string 1)) "src")
18690 ;; src blocks: let `org-edit-src-exit' handle them
18691 (org-get-indentation)
18692 (org-get-indentation (match-string 0)))))
18693 ;; Lists
18694 ((org-in-item-p)
18695 (org-beginning-of-item)
18696 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18697 (setq bpos (match-beginning 1) tpos (match-end 0)
18698 bcol (progn (goto-char bpos) (current-column))
18699 tcol (progn (goto-char tpos) (current-column)))
18700 (if (> tcol (+ bcol org-description-max-indent))
18701 (setq tcol (+ bcol 5)))
18702 (goto-char pos)
18703 (setq column (if itemp (org-get-indentation) tcol)))
18704 ;; This line has nothing special, look upside to get a clue about
18705 ;; what to do.
18706 (t
18707 (beginning-of-line 0)
18708 (while (and (not (bobp))
18709 ;; skip comments, verbatim, empty lines, tables,
18710 ;; inline tasks
18712 (and (org-in-item-p) (goto-char (org-list-top-point)))
18713 (and (not inline-task-p)
18714 (featurep 'org-inlinetask)
18715 (org-inlinetask-in-task-p)))
18717 (not (looking-at org-drawer-regexp)))
18718 (beginning-of-line 0))
18719 (cond
18720 ;; There was an heading above.
18722 (if (not org-adapt-indentation)
18723 (setq column 0)
18724 (goto-char (match-end 0))
18725 (setq column (current-column))))
18726 ;; A drawer had started and is unfinished: indent consequently.
18727 ((looking-at org-drawer-regexp)
18728 (goto-char (1- (match-beginning 1)))
18729 (setq column (current-column)))
18730 ;; The drawer had ended: indent like its :END: line.
18732 (goto-char (match-end 1))
18733 (setq column (current-column)))
18734 ;; Else, nothing noticeable found: get indentation and go on.
18735 (t (setq column (org-get-indentation))))))
18736 (goto-char pos)
18737 (if (<= (current-column) (current-indentation))
18738 (org-indent-line-to column)
18739 (save-excursion (org-indent-line-to column)))
18740 (setq column (current-column))
18741 (beginning-of-line 1)
18742 (if (looking-at
18744 (replace-match (concat (match-string 1)
18745 (format org-property-format
18746 (match-string 2) (match-string 3)))
18747 t t))
18748 (org-move-to-column column)))
18750 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18751 "Variable to store copy of `adaptive-fill-regexp'.
18752 Since `adaptive-fill-regexp' is set to never match, we need to
18753 store a backup of its value before entering `org-mode' so that
18754 the functionality can be provided as a fall-back.")
18756 (defun org-set-autofill-regexps ()
18757 (interactive)
18758 ;; In the paragraph separator we include headlines, because filling
18759 ;; text in a line directly attached to a headline would otherwise
18760 ;; fill the headline as well.
18763 ;; The paragraph starter includes hand-formatted lists.
18764 (org-set-local
18765 'paragraph-start
18766 (concat
18775 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18776 ;; But only if the user has not turned off tables or fixed-width regions
18777 (org-set-local
18778 'auto-fill-inhibit-regexp
18781 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18782 (concat
18784 (if org-enable-table-editor "|" "")
18785 (if org-enable-fixed-width-editor ":" "")
18786 "]"))))
18787 ;; We use our own fill-paragraph function, to make sure that tables
18788 ;; and fixed-width regions are not wrapped. That function will pass
18789 ;; through to `fill-paragraph' when appropriate.
18790 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18791 ;; Adaptive filling: To get full control, first make sure that
18792 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18793 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18794 (org-set-local 'org-adaptive-fill-regexp-backup
18795 adaptive-fill-regexp))
18797 (org-set-local 'adaptive-fill-function
18798 'org-adaptive-fill-function)
18799 (org-set-local
18800 'align-mode-rules-list
18801 '((org-in-buffer-settings
18803 (modes . '(org-mode))))))
18805 (defun org-fill-paragraph (&optional justify)
18806 "Re-align a table, pass through to fill-paragraph if no table."
18807 (let ((table-p (org-at-table-p))
18808 (table.el-p (org-at-table.el-p)))
18809 (cond ((and (equal (char-after (point-at-bol)) ?*)
18810 (save-excursion (goto-char (point-at-bol))
18811 (looking-at outline-regexp)))
18812 t) ; skip headlines
18813 (table.el-p t) ; skip table.el tables
18814 (table-p (org-table-align) t) ; align org-mode tables
18815 (t nil)))) ; call paragraph-fill
18817 ;; For reference, this is the default value of adaptive-fill-regexp
18820 (defun org-adaptive-fill-function ()
18821 "Return a fill prefix for org-mode files.
18822 In particular, this makes sure hanging paragraphs for hand-formatted lists
18823 work correctly."
18824 (cond
18825 ;; Comment line
18827 (match-string-no-properties 0))
18828 ;; Description list
18830 (save-excursion
18831 (if (> (match-end 1) (+ (match-beginning 1)
18832 org-description-max-indent))
18833 (goto-char (+ (match-beginning 1) 5))
18834 (goto-char (match-end 0)))
18835 (make-string (current-column) ?\ )))
18836 ;; Ordered or unordered list
18838 (save-excursion
18839 (goto-char (match-end 0))
18840 (make-string (current-column) ?\ )))
18841 ;; Other text
18842 ((looking-at org-adaptive-fill-regexp-backup)
18843 (match-string-no-properties 0))))
18845 ;;; Other stuff.
18847 (defun org-toggle-fixed-width-section (arg)
18848 "Toggle the fixed-width export.
18849 If there is no active region, the QUOTE keyword at the current headline is
18850 inserted or removed. When present, it causes the text between this headline
18851 and the next to be exported as fixed-width text, and unmodified.
18852 If there is an active region, this command adds or removes a colon as the
18853 first character of this line. If the first character of a line is a colon,
18854 this line is also exported in fixed-width font."
18855 (interactive "P")
18856 (let* ((cc 0)
18857 (regionp (org-region-active-p))
18858 (beg (if regionp (region-beginning) (point)))
18859 (end (if regionp (region-end)))
18860 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18861 (case-fold-search nil)
18863 off)
18864 (if regionp
18865 (save-excursion
18866 (goto-char beg)
18867 (setq cc (current-column))
18868 (beginning-of-line 1)
18869 (setq off (looking-at re))
18870 (while (> nlines 0)
18871 (setq nlines (1- nlines))
18872 (beginning-of-line 1)
18873 (cond
18874 (arg
18875 (org-move-to-column cc t)
18877 (forward-line -1))
18878 ((and off (looking-at re))
18879 (replace-match "" t t nil 1))
18880 ((not off) (org-move-to-column cc t) (insert ": ")))
18881 (forward-line 1)))
18882 (save-excursion
18883 (org-back-to-heading)
18884 (if (looking-at (concat outline-regexp
18886 (replace-match "" t t nil 1)
18887 (if (looking-at outline-regexp)
18888 (progn
18889 (goto-char (match-end 0))
18890 (insert org-quote-string " "))))))))
18892 (defun org-reftex-citation ()
18893 "Use reftex-citation to insert a citation into the buffer.
18894 This looks for a line like
18896 #+BIBLIOGRAPHY: foo plain option:-d
18898 and derives from it that foo.bib is the bibliography file relevant
18899 for this document. It then installs the necessary environment for RefTeX
18900 to work in this buffer and calls `reftex-citation' to insert a citation
18901 into the buffer.
18903 Export of such citations to both LaTeX and HTML is handled by the contributed
18904 package org-exp-bibtex by Taru Karttunen."
18905 (interactive)
18906 (let ((reftex-docstruct-symbol 'rds)
18908 rds bib)
18909 (save-excursion
18910 (save-restriction
18911 (widen)
18912 (let ((case-fold-search t)
18914 (if (not (save-excursion
18915 (or (re-search-forward re nil t)
18916 (re-search-backward re nil t))))
18917 (error "No bibliography defined in file")
18918 (setq bib (concat (match-string 1) ".bib")
18919 rds (list (list 'bib bib)))))))
18920 (call-interactively 'reftex-citation)))
18922 ;;;; Functions extending outline functionality
18924 (defun org-beginning-of-line (&optional arg)
18925 "Go to the beginning of the current line. If that is invisible, continue
18926 to a visible line beginning. This makes the function of C-a more intuitive.
18927 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18928 first attempt, and only move to after the tags when the cursor is already
18929 beyond the end of the headline."
18930 (interactive "P")
18931 (let ((pos (point))
18932 (special (if (consp org-special-ctrl-a/e)
18933 (car org-special-ctrl-a/e)
18934 org-special-ctrl-a/e))
18935 refpos)
18936 (if (org-bound-and-true-p line-move-visual)
18937 (beginning-of-visual-line 1)
18938 (beginning-of-line 1))
18939 (if (and arg (fboundp 'move-beginning-of-line))
18940 (call-interactively 'move-beginning-of-line)
18941 (if (bobp)
18942 nil
18943 (backward-char 1)
18944 (if (org-truely-invisible-p)
18945 (while (and (not (bobp)) (org-truely-invisible-p))
18946 (backward-char 1)
18947 (beginning-of-line 1))
18948 (forward-char 1))))
18949 (when special
18950 (cond
18951 ((and (looking-at org-complex-heading-regexp)
18952 (= (char-after (match-end 1)) ?\ ))
18953 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18954 (point-at-eol)))
18955 (goto-char
18956 (if (eq special t)
18957 (cond ((> pos refpos) refpos)
18958 ((= pos (point)) refpos)
18959 (t (point)))
18960 (cond ((> pos (point)) (point))
18961 ((not (eq last-command this-command)) (point))
18962 (t refpos)))))
18963 ((org-at-item-p)
18964 (goto-char
18965 (if (eq special t)
18966 (cond ((> pos (match-end 4)) (match-end 4))
18967 ((= pos (point)) (match-end 4))
18968 (t (point)))
18969 (cond ((> pos (point)) (point))
18970 ((not (eq last-command this-command)) (point))
18971 (t (match-end 4))))))))
18972 (org-no-warnings
18973 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18975 (defun org-end-of-line (&optional arg)
18976 "Go to the end of the line.
18977 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18978 first attempt, and only move to after the tags when the cursor is already
18979 beyond the end of the headline."
18980 (interactive "P")
18981 (let ((special (if (consp org-special-ctrl-a/e)
18982 (cdr org-special-ctrl-a/e)
18983 org-special-ctrl-a/e)))
18984 (if (or (not special)
18985 (not (org-on-heading-p))
18986 arg)
18987 (call-interactively
18988 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18989 ((fboundp 'move-end-of-line) 'move-end-of-line)
18990 (t 'end-of-line)))
18991 (let ((pos (point)))
18992 (beginning-of-line 1)
18994 (if (eq special t)
18995 (if (or (< pos (match-beginning 1))
18996 (= pos (match-end 0)))
18997 (goto-char (match-beginning 1))
18998 (goto-char (match-end 0)))
18999 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19000 (goto-char (match-end 0))
19001 (goto-char (match-beginning 1))))
19002 (call-interactively (if (fboundp 'move-end-of-line)
19003 'move-end-of-line
19004 'end-of-line)))))
19005 (org-no-warnings
19006 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19008 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19009 (define-key org-mode-map "\C-e" 'org-end-of-line)
19010 (define-key org-mode-map [home] 'org-beginning-of-line)
19011 (define-key org-mode-map [end] 'org-end-of-line)
19013 (defun org-backward-sentence (&optional arg)
19014 "Go to beginning of sentence, or beginning of table field.
19015 This will call `backward-sentence' or `org-table-beginning-of-field',
19016 depending on context."
19017 (interactive "P")
19018 (cond
19019 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19020 (t (call-interactively 'backward-sentence))))
19022 (defun org-forward-sentence (&optional arg)
19023 "Go to end of sentence, or end of table field.
19024 This will call `forward-sentence' or `org-table-end-of-field',
19025 depending on context."
19026 (interactive "P")
19027 (cond
19028 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19029 (t (call-interactively 'forward-sentence))))
19031 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19032 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19034 (defun org-kill-line (&optional arg)
19035 "Kill line, to tags or end of line."
19036 (interactive "P")
19037 (cond
19038 ((or (not org-special-ctrl-k)
19039 (bolp)
19040 (not (org-on-heading-p)))
19041 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19042 org-ctrl-k-protect-subtree)
19043 (if (or (eq org-ctrl-k-protect-subtree 'error)
19044 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19045 (error "C-k aborted - would kill hidden subtree")))
19046 (call-interactively 'kill-line))
19048 (kill-region (point) (match-beginning 1))
19049 (org-set-tags nil t))
19050 (t (kill-region (point) (point-at-eol)))))
19052 (define-key org-mode-map "\C-k" 'org-kill-line)
19054 (defun org-yank (&optional arg)
19055 "Yank. If the kill is a subtree, treat it specially.
19056 This command will look at the current kill and check if is a single
19057 subtree, or a series of subtrees[1]. If it passes the test, and if the
19058 cursor is at the beginning of a line or after the stars of a currently
19059 empty headline, then the yank is handled specially. How exactly depends
19060 on the value of the following variables, both set by default.
19062 org-yank-folded-subtrees
19063 When set, the subtree(s) will be folded after insertion, but only
19064 if doing so would now swallow text after the yanked text.
19066 org-yank-adjusted-subtrees
19067 When set, the subtree will be promoted or demoted in order to
19068 fit into the local outline tree structure, which means that the level
19069 will be adjusted so that it becomes the smaller one of the two
19070 *visible* surrounding headings.
19072 Any prefix to this command will cause `yank' to be called directly with
19074 will just
19075 plainly yank the text as it is.
19077 \[1] The test checks if the first non-white line is a heading
19078 and if there are no other headings with fewer stars."
19079 (interactive "P")
19080 (org-yank-generic 'yank arg))
19082 (defun org-yank-generic (command arg)
19083 "Perform some yank-like command.
19085 This function implements the behavior described in the `org-yank'
19086 documentation. However, it has been generalized to work for any
19087 interactive command with similar behavior."
19089 ;; pretend to be command COMMAND
19090 (setq this-command command)
19092 (if arg
19093 (call-interactively command)
19095 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19096 (and (org-kill-is-subtree-p)
19097 (or (bolp)
19099 (string-match
19101 (buffer-substring (point-at-bol) (point)))))))
19102 swallowp)
19103 (cond
19104 ((and subtreep org-yank-folded-subtrees)
19105 (let ((beg (point))
19106 end)
19107 (if (and subtreep org-yank-adjusted-subtrees)
19108 (org-paste-subtree nil nil 'for-yank)
19109 (call-interactively command))
19111 (setq end (point))
19112 (goto-char beg)
19113 (when (and (bolp) subtreep
19114 (not (setq swallowp
19115 (org-yank-folding-would-swallow-text beg end))))
19116 (or (looking-at outline-regexp)
19117 (re-search-forward (concat "^" outline-regexp) end t))
19118 (while (and (< (point) end) (looking-at outline-regexp))
19119 (hide-subtree)
19120 (org-cycle-show-empty-lines 'folded)
19121 (condition-case nil
19122 (outline-forward-same-level 1)
19123 (error (goto-char end)))))
19124 (when swallowp
19125 (message
19126 "Inserted text not folded because that would swallow text"))
19128 (goto-char end)
19130 (beginning-of-line 1)
19131 (push-mark beg 'nomsg)))
19132 ((and subtreep org-yank-adjusted-subtrees)
19133 (let ((beg (point-at-bol)))
19134 (org-paste-subtree nil nil 'for-yank)
19135 (push-mark beg 'nomsg)))
19136 (t
19137 (call-interactively command))))))
19139 (defun org-yank-folding-would-swallow-text (beg end)
19140 "Would hide-subtree at BEG swallow any text after END?"
19141 (let (level)
19142 (save-excursion
19143 (goto-char beg)
19144 (when (or (looking-at outline-regexp)
19145 (re-search-forward (concat "^" outline-regexp) end t))
19146 (setq level (org-outline-level)))
19147 (goto-char end)
19149 (if (or (eobp)
19150 (and (bolp) (looking-at org-outline-regexp)
19151 (<= (org-outline-level) level)))
19152 nil ; Nothing would be swallowed
19153 t)))) ; something would swallow
19155 (define-key org-mode-map "\C-y" 'org-yank)
19157 (defun org-invisible-p ()
19158 "Check if point is at a character currently not visible."
19159 ;; Early versions of noutline don't have `outline-invisible-p'.
19160 (if (fboundp 'outline-invisible-p)
19161 (outline-invisible-p)
19162 (get-char-property (point) 'invisible)))
19164 (defun org-truely-invisible-p ()
19165 "Check if point is at a character currently not visible.
19166 This version does not only check the character property, but also
19167 `visible-mode'."
19168 ;; Early versions of noutline don't have `outline-invisible-p'.
19169 (if (org-bound-and-true-p visible-mode)
19170 nil
19171 (if (fboundp 'outline-invisible-p)
19172 (outline-invisible-p)
19173 (get-char-property (point) 'invisible))))
19175 (defun org-invisible-p2 ()
19176 "Check if point is at a character currently not visible."
19177 (save-excursion
19178 (if (and (eolp) (not (bobp))) (backward-char 1))
19179 ;; Early versions of noutline don't have `outline-invisible-p'.
19180 (if (fboundp 'outline-invisible-p)
19181 (outline-invisible-p)
19182 (get-char-property (point) 'invisible))))
19184 (defun org-back-to-heading (&optional invisible-ok)
19185 "Call `outline-back-to-heading', but provide a better error message."
19186 (condition-case nil
19187 (outline-back-to-heading invisible-ok)
19188 (error (error "Before first headline at position %d in buffer %s"
19189 (point) (current-buffer)))))
19191 (defun org-beginning-of-defun ()
19192 "Go to the beginning of the subtree, i.e. back to the heading."
19193 (org-back-to-heading))
19194 (defun org-end-of-defun ()
19195 "Go to the end of the subtree."
19196 (org-end-of-subtree nil t))
19198 (defun org-before-first-heading-p ()
19199 "Before first heading?"
19200 (save-excursion
19203 (defun org-on-heading-p (&optional ignored)
19204 (outline-on-heading-p t))
19205 (defun org-at-heading-p (&optional ignored)
19206 (outline-on-heading-p t))
19208 (defun org-point-at-end-of-empty-headline ()
19209 "If point is at the end of an empty headline, return t, else nil.
19210 If the heading only contains a TODO keyword, it is still still considered
19211 empty."
19213 (save-excursion
19214 (beginning-of-line 1)
19217 (defun org-at-heading-or-item-p ()
19218 (or (org-on-heading-p) (org-at-item-p)))
19220 (defun org-on-target-p ()
19221 (or (org-in-regexp org-radio-target-regexp)
19222 (org-in-regexp org-target-regexp)))
19224 (defun org-up-heading-all (arg)
19225 "Move to the heading line of which the present line is a subheading.
19226 This function considers both visible and invisible heading lines.
19227 With argument, move up ARG levels."
19228 (if (fboundp 'outline-up-heading-all)
19229 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19230 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19232 (defun org-up-heading-safe ()
19233 "Move to the heading line of which the present line is a subheading.
19234 This version will not throw an error. It will return the level of the
19235 headline found, or nil if no higher level is found.
19237 Also, this function will be a lot faster than `outline-up-heading',
19238 because it relies on stars being the outline starters. This can really
19239 make a significant difference in outlines with very many siblings."
19240 (let (start-level re)
19241 (org-back-to-heading t)
19242 (setq start-level (funcall outline-level))
19243 (if (equal start-level 1)
19244 nil
19246 (if (re-search-backward re nil t)
19247 (funcall outline-level)))))
19249 (defun org-first-sibling-p ()
19250 "Is this heading the first child of its parents?"
19251 (interactive)
19252 (let ((re (concat "^" outline-regexp))
19253 level l)
19254 (unless (org-at-heading-p t)
19255 (error "Not at a heading"))
19256 (setq level (funcall outline-level))
19257 (save-excursion
19258 (if (not (re-search-backward re nil t))
19259 t
19260 (setq l (funcall outline-level))
19261 (< l level)))))
19263 (defun org-goto-sibling (&optional previous)
19264 "Goto the next sibling, even if it is invisible.
19265 When PREVIOUS is set, go to the previous sibling instead. Returns t
19266 when a sibling was found. When none is found, return nil and don't
19267 move point."
19268 (let ((fun (if previous 're-search-backward 're-search-forward))
19269 (pos (point))
19270 (re (concat "^" outline-regexp))
19271 level l)
19272 (when (condition-case nil (org-back-to-heading t) (error nil))
19273 (setq level (funcall outline-level))
19274 (catch 'exit
19275 (or previous (forward-char 1))
19276 (while (funcall fun re nil t)
19277 (setq l (funcall outline-level))
19278 (when (< l level) (goto-char pos) (throw 'exit nil))
19279 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19280 (goto-char pos)
19281 nil))))
19283 (defun org-show-siblings ()
19284 "Show all siblings of the current headline."
19285 (save-excursion
19286 (while (org-goto-sibling) (org-flag-heading nil)))
19287 (save-excursion
19288 (while (org-goto-sibling 'previous)
19289 (org-flag-heading nil))))
19291 (defun org-goto-first-child ()
19292 "Goto the first child, even if it is invisible.
19293 Return t when a child was found. Otherwise don't move point and
19294 return nil."
19295 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19296 (when (condition-case nil (org-back-to-heading t) (error nil))
19297 (setq level (outline-level))
19298 (forward-char 1)
19299 (if (and (re-search-forward re nil t) (> (outline-level) level))
19300 (progn (goto-char (match-beginning 0)) t)
19301 (goto-char pos) nil))))
19303 (defun org-show-hidden-entry ()
19304 "Show an entry where even the heading is hidden."
19305 (save-excursion
19306 (org-show-entry)))
19308 (defun org-flag-heading (flag &optional entry)
19309 "Flag the current heading. FLAG non-nil means make invisible.
19310 When ENTRY is non-nil, show the entire entry."
19311 (save-excursion
19312 (org-back-to-heading t)
19313 ;; Check if we should show the entire entry
19314 (if entry
19315 (progn
19316 (org-show-entry)
19317 (save-excursion
19318 (and (outline-next-heading)
19319 (org-flag-heading nil))))
19320 (outline-flag-region (max (point-min) (1- (point)))
19321 (save-excursion (outline-end-of-heading) (point))
19322 flag))))
19324 (defun org-get-next-sibling ()
19325 "Move to next heading of the same level, and return point.
19326 If there is no such heading, return nil.
19327 This is like outline-next-sibling, but invisible headings are ok."
19328 (let ((level (funcall outline-level)))
19329 (outline-next-heading)
19330 (while (and (not (eobp)) (> (funcall outline-level) level))
19331 (outline-next-heading))
19332 (if (or (eobp) (< (funcall outline-level) level))
19333 nil
19334 (point))))
19336 (defun org-get-last-sibling ()
19337 "Move to previous heading of the same level, and return point.
19338 If there is no such heading, return nil."
19339 (let ((opoint (point))
19340 (level (funcall outline-level)))
19341 (outline-previous-heading)
19342 (when (and (/= (point) opoint) (outline-on-heading-p t))
19343 (while (and (> (funcall outline-level) level)
19344 (not (bobp)))
19345 (outline-previous-heading))
19346 (if (< (funcall outline-level) level)
19347 nil
19348 (point)))))
19350 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19351 ;; This contains an exact copy of the original function, but it uses
19352 ;; `org-back-to-heading', to make it work also in invisible
19353 ;; trees. And is uses an invisible-OK argument.
19354 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19355 ;; Furthermore, when used inside Org, finding the end of a large subtree
19356 ;; with many children and grandchildren etc, this can be much faster
19357 ;; than the outline version.
19358 (org-back-to-heading invisible-OK)
19359 (let ((first t)
19360 (level (funcall outline-level)))
19361 (if (and (org-mode-p) (< level 1000))
19362 ;; A true heading (not a plain list item), in Org-mode
19363 ;; This means we can easily find the end by looking
19364 ;; only for the right number of stars. Using a regexp to do
19365 ;; this is so much faster than using a Lisp loop.
19367 (forward-char 1)
19368 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19369 ;; something else, do it the slow way
19370 (while (and (not (eobp))
19371 (or first (> (funcall outline-level) level)))
19372 (setq first nil)
19373 (outline-next-heading)))
19374 (unless to-heading
19376 (progn
19377 ;; Go to end of line before heading
19378 (forward-char -1)
19380 ;; leave blank line before heading
19381 (forward-char -1))))))
19382 (point))
19384 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19385 "Use Org version in org-mode, for dramatic speed-up."
19386 (if (eq major-mode 'org-mode)
19387 (progn
19388 (org-end-of-subtree nil t)
19389 (unless (eobp) (backward-char 1)))
19390 ad-do-it))
19392 (defun org-forward-same-level (arg &optional invisible-ok)
19393 "Move forward to the arg'th subheading at same level as this one.
19394 Stop at the first and last subheadings of a superior heading.
19395 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19396 it wil also look at invisible ones."
19397 (interactive "p")
19398 (org-back-to-heading invisible-ok)
19399 (org-on-heading-p)
19400 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19402 l)
19403 (forward-char 1)
19404 (while (> arg 0)
19405 (while (and (re-search-forward re nil 'move)
19406 (setq l (- (match-end 0) (match-beginning 0) 1))
19407 (= l level)
19408 (not invisible-ok)
19409 (progn (backward-char 1) (org-invisible-p)))
19410 (if (< l level) (setq arg 1)))
19411 (setq arg (1- arg)))
19412 (beginning-of-line 1)))
19414 (defun org-backward-same-level (arg &optional invisible-ok)
19415 "Move backward to the arg'th subheading at same level as this one.
19416 Stop at the first and last subheadings of a superior heading."
19417 (interactive "p")
19418 (org-back-to-heading)
19419 (org-on-heading-p)
19420 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19422 l)
19423 (while (> arg 0)
19424 (while (and (re-search-backward re nil 'move)
19425 (setq l (- (match-end 0) (match-beginning 0) 1))
19426 (= l level)
19427 (not invisible-ok)
19428 (org-invisible-p))
19429 (if (< l level) (setq arg 1)))
19430 (setq arg (1- arg)))))
19432 (defun org-show-subtree ()
19433 "Show everything after this heading at deeper levels."
19434 (outline-flag-region
19435 (point)
19436 (save-excursion
19437 (org-end-of-subtree t t))
19438 nil))
19440 (defun org-show-entry ()
19441 "Show the body directly following this heading.
19442 Show the heading too, if it is currently invisible."
19443 (interactive)
19444 (save-excursion
19445 (condition-case nil
19446 (progn
19447 (org-back-to-heading t)
19448 (outline-flag-region
19449 (max (point-min) (1- (point)))
19450 (save-excursion
19451 (if (re-search-forward
19453 (match-beginning 1)
19454 (point-max)))
19455 nil)
19456 (org-cycle-hide-drawers 'children))
19457 (error nil))))
19459 (defun org-make-options-regexp (kwds &optional extra)
19460 "Make a regular expression for keyword lines."
19461 (concat
19462 "^"
19469 ;; Make isearch reveal the necessary context
19470 (defun org-isearch-end ()
19471 "Reveal context after isearch exits."
19472 (when isearch-success ; only if search was successful
19473 (if (featurep 'xemacs)
19474 ;; Under XEmacs, the hook is run in the correct place,
19475 ;; we directly show the context.
19476 (org-show-context 'isearch)
19477 ;; In Emacs the hook runs *before* restoring the overlays.
19478 ;; So we have to use a one-time post-command-hook to do this.
19479 ;; (Emacs 22 has a special variable, see function `org-mode')
19480 (unless (and (boundp 'isearch-mode-end-hook-quit)
19481 isearch-mode-end-hook-quit)
19482 ;; Only when the isearch was not quitted.
19483 (org-add-hook 'post-command-hook 'org-isearch-post-command
19484 'append 'local)))))
19486 (defun org-isearch-post-command ()
19487 "Remove self from hook, and show context."
19488 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19489 (org-show-context 'isearch))
19492 ;;;; Integration with and fixes for other packages
19494 ;;; Imenu support
19496 (defvar org-imenu-markers nil
19497 "All markers currently used by Imenu.")
19498 (make-variable-buffer-local 'org-imenu-markers)
19500 (defun org-imenu-new-marker (&optional pos)
19501 "Return a new marker for use by Imenu, and remember the marker."
19502 (let ((m (make-marker)))
19503 (move-marker m (or pos (point)))
19504 (push m org-imenu-markers)
19505 m))
19507 (defun org-imenu-get-tree ()
19508 "Produce the index for Imenu."
19509 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19510 (setq org-imenu-markers nil)
19511 (let* ((n org-imenu-depth)
19512 (re (concat "^" outline-regexp))
19513 (subs (make-vector (1+ n) nil))
19514 (last-level 0)
19515 m level head)
19516 (save-excursion
19517 (save-restriction
19518 (widen)
19519 (goto-char (point-max))
19520 (while (re-search-backward re nil t)
19521 (setq level (org-reduced-level (funcall outline-level)))
19522 (when (<= level n)
19523 (looking-at org-complex-heading-regexp)
19524 (setq head (org-link-display-format
19525 (org-match-string-no-properties 4))
19526 m (org-imenu-new-marker))
19527 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19528 (if (>= level last-level)
19529 (push (cons head m) (aref subs level))
19530 (push (cons head (aref subs (1+ level))) (aref subs level))
19531 (loop for i from (1+ level) to n do (aset subs i nil)))
19532 (setq last-level level)))))
19533 (aref subs 1)))
19535 (eval-after-load "imenu"
19536 '(progn
19537 (add-hook 'imenu-after-jump-hook
19538 (lambda ()
19539 (if (eq major-mode 'org-mode)
19540 (org-show-context 'org-goto))))))
19542 (defun org-link-display-format (link)
19543 "Replace a link with either the description, or the link target
19544 if no description is present"
19545 (save-match-data
19546 (if (string-match org-bracket-link-analytic-regexp link)
19547 (replace-match (if (match-end 5)
19548 (match-string 5 link)
19549 (concat (match-string 1 link)
19550 (match-string 3 link)))
19551 nil t link)
19552 link)))
19554 ;; Speedbar support
19556 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19557 "Overlay marking the agenda restriction line in speedbar.")
19558 (overlay-put org-speedbar-restriction-lock-overlay
19559 'face 'org-agenda-restriction-lock)
19560 (overlay-put org-speedbar-restriction-lock-overlay
19561 'help-echo "Agendas are currently limited to this item.")
19562 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19564 (defun org-speedbar-set-agenda-restriction ()
19565 "Restrict future agenda commands to the location at point in speedbar.
19567 (interactive)
19568 (require 'org-agenda)
19569 (let (p m tp np dir txt)
19570 (cond
19571 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19572 'org-imenu t))
19573 (setq m (get-text-property p 'org-imenu-marker))
19574 (with-current-buffer (marker-buffer m)
19575 (goto-char m)
19576 (org-agenda-set-restriction-lock 'subtree)))
19577 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19578 'speedbar-function 'speedbar-find-file))
19579 (setq tp (previous-single-property-change
19580 (1+ p) 'speedbar-function)
19581 np (next-single-property-change
19582 tp 'speedbar-function)
19583 dir (speedbar-line-directory)
19584 txt (buffer-substring-no-properties (or tp (point-min))
19585 (or np (point-max))))
19586 (with-current-buffer (find-file-noselect
19587 (let ((default-directory dir))
19588 (expand-file-name txt)))
19589 (unless (org-mode-p)
19590 (error "Cannot restrict to non-Org-mode file"))
19591 (org-agenda-set-restriction-lock 'file)))
19592 (t (error "Don't know how to restrict Org-mode's agenda")))
19593 (move-overlay org-speedbar-restriction-lock-overlay
19594 (point-at-bol) (point-at-eol))
19595 (setq current-prefix-arg nil)
19596 (org-agenda-maybe-redo)))
19598 (eval-after-load "speedbar"
19599 '(progn
19600 (speedbar-add-supported-extension ".org")
19601 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19602 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19603 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19604 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19605 (add-hook 'speedbar-visiting-tag-hook
19606 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19608 ;;; Fixes and Hacks for problems with other packages
19610 ;; Make flyspell not check words in links, to not mess up our keymap
19611 (defun org-mode-flyspell-verify ()
19612 "Don't let flyspell put overlays at active buttons."
19613 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19614 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19616 (defun org-remove-flyspell-overlays-in (beg end)
19617 "Remove flyspell overlays in region."
19618 (and (org-bound-and-true-p flyspell-mode)
19619 (fboundp 'flyspell-delete-region-overlays)
19620 (flyspell-delete-region-overlays beg end))
19621 (add-text-properties beg end '(org-no-flyspell t)))
19623 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19624 (eval-after-load "bookmark"
19625 '(if (boundp 'bookmark-after-jump-hook)
19626 ;; We can use the hook
19627 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19628 ;; Hook not available, use advice
19629 (defadvice bookmark-jump (after org-make-visible activate)
19630 "Make the position visible."
19631 (org-bookmark-jump-unhide))))
19633 ;; Make sure saveplace shows the location if it was hidden
19634 (eval-after-load "saveplace"
19635 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19636 "Make the position visible."
19637 (org-bookmark-jump-unhide)))
19639 ;; Make sure ecb shows the location if it was hidden
19640 (eval-after-load "ecb"
19641 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19642 "Make hierarchy visible when jumping into location from ECB tree buffer."
19643 (if (eq major-mode 'org-mode)
19644 (org-show-context))))
19646 (defun org-bookmark-jump-unhide ()
19647 "Unhide the current position, to show the bookmark location."
19648 (and (org-mode-p)
19649 (or (org-invisible-p)
19650 (save-excursion (goto-char (max (point-min) (1- (point))))
19651 (org-invisible-p)))
19652 (org-show-context 'bookmark-jump)))
19654 ;; Make session.el ignore our circular variable
19655 (eval-after-load "session"
19656 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19658 ;;;; Experimental code
19660 (defun org-closed-in-range ()
19661 "Sparse tree of items closed in a certain time range.
19662 Still experimental, may disappear in the future."
19663 (interactive)
19664 ;; Get the time interval from the user.
19665 (let* ((time1 (org-float-time
19666 (org-read-date nil 'to-time nil "Starting date: ")))
19667 (time2 (org-float-time
19668 (org-read-date nil 'to-time nil "End date:")))
19669 ;; callback function
19670 (callback (lambda ()
19671 (let ((time
19672 (org-float-time
19673 (apply 'encode-time
19674 (org-parse-time-string
19675 (match-string 1))))))
19676 ;; check if time in interval
19677 (and (>= time time1) (<= time time2))))))
19678 ;; make tree, check each match with the callback
19681 ;;;; Finish up
19683 (provide 'org)
19685 (run-hooks 'org-load-hook)
19687 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19689 ;;; org.el ends here