| blob | f7e7c9fd2f49c6c3b3a0342352367d63fdbda834 |
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 (org-on-heading-p) (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 "news")
9174 (require 'org-gnus)
9175 (org-gnus-follow-link path))
9177 ((string= type "shell")
9178 (let ((cmd path))
9179 (if (or (not org-confirm-shell-link-function)
9180 (funcall org-confirm-shell-link-function
9182 (org-add-props cmd nil
9183 'face 'org-warning))))
9184 (progn
9185 (message "Executing %s" cmd)
9186 (shell-command cmd))
9187 (error "Abort"))))
9189 ((string= type "elisp")
9190 (let ((cmd path))
9191 (if (or (not org-confirm-elisp-link-function)
9192 (funcall org-confirm-elisp-link-function
9194 (org-add-props cmd nil
9195 'face 'org-warning))))
9196 (message "%s => %s" cmd
9197 (if (equal (string-to-char cmd) ?\()
9198 (eval (read cmd))
9199 (call-interactively (read cmd))))
9200 (error "Abort"))))
9202 ((and (string= type "thisfile")
9203 (run-hook-with-args-until-success
9204 'org-open-link-functions path)))
9206 ((string= type "thisfile")
9207 (if in-emacs
9208 (switch-to-buffer-other-window
9209 (org-get-buffer-for-internal-link (current-buffer)))
9210 (org-mark-ring-push))
9211 (let ((cmd `(org-link-search
9212 ,path
9213 ,(cond ((equal in-emacs '(4)) 'occur)
9214 ((equal in-emacs '(16)) 'org-occur)
9215 (t nil))
9216 ,pos)))
9217 (condition-case nil (eval cmd)
9218 (error (progn (widen) (eval cmd))))))
9220 (t
9221 (browse-url-at-point)))))))
9222 (move-marker org-open-link-marker nil)
9223 (run-hook-with-args 'org-follow-link-hook)))
9225 (defun org-offer-links-in-entry (&optional nth zero)
9226 "Offer links in the current entry and follow the selected link.
9227 If there is only one link, follow it immediately as well.
9228 If NTH is an integer, immediately pick the NTH link found.
9229 If ZERO is a string, check also this string for a link, and if
9230 there is one, offer it as link number zero."
9234 (cnt ?0)
9235 (in-emacs (if (integerp nth) nil nth))
9236 have-zero end links link c)
9237 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9238 (push (match-string 0 zero) links)
9239 (setq cnt (1- cnt) have-zero t))
9240 (save-excursion
9241 (org-back-to-heading t)
9242 (setq end (save-excursion (outline-next-heading) (point)))
9243 (while (re-search-forward re end t)
9244 (push (match-string 0) links))
9245 (setq links (org-uniquify (reverse links))))
9247 (cond
9248 ((null links)
9249 (message "No links"))
9250 ((equal (length links) 1)
9251 (setq link (list (car links))))
9252 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9253 (setq link (nth (if have-zero nth (1- nth)) links)))
9254 (t ; we have to select a link
9255 (save-excursion
9256 (save-window-excursion
9257 (delete-other-windows)
9258 (with-output-to-temp-buffer "*Select Link*"
9259 (mapc (lambda (l)
9260 (if (not (string-match org-bracket-link-regexp l))
9262 (org-remove-angle-brackets l)))
9263 (if (match-end 3)
9265 (match-string 3 l) (match-string 1 l)))
9267 (match-string 1 l))))))
9268 links))
9269 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9270 (message "Select link to open, RET to open all:")
9271 (setq c (read-char-exclusive))
9272 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9273 (when (equal c ?q) (error "Abort"))
9274 (if (equal c ?\C-m)
9275 (setq link links)
9276 (setq nth (- c ?0))
9277 (if have-zero (setq nth (1+ nth)))
9278 (unless (and (integerp nth) (>= (length links) nth))
9279 (error "Invalid link selection"))
9280 (setq link (list (nth (1- nth) links))))))
9281 (if link
9282 (let ((buf (current-buffer)))
9283 (dolist (l link)
9284 (org-open-link-from-string l in-emacs buf))
9285 t)
9286 nil)))
9288 ;; Add special file links that specify the way of opening
9290 (org-add-link-type "file+sys" 'org-open-file-with-system)
9291 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9292 (defun org-open-file-with-system (path)
9293 "Open file at PATH using the system way of opening it."
9294 (org-open-file path 'system))
9295 (defun org-open-file-with-emacs (path)
9296 "Open file at PATH in Emacs."
9297 (org-open-file path 'emacs))
9298 (defun org-remove-file-link-modifiers ()
9299 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9300 (goto-char (point-min))
9302 (org-if-unprotected
9303 (replace-match "file:" t t))))
9304 (eval-after-load "org-exp"
9305 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9306 'org-remove-file-link-modifiers))
9308 ;;;; Time estimates
9310 (defun org-get-effort (&optional pom)
9311 "Get the effort estimate for the current entry."
9312 (org-entry-get pom org-effort-property))
9314 ;;; File search
9316 (defvar org-create-file-search-functions nil
9317 "List of functions to construct the right search string for a file link.
9318 These functions are called in turn with point at the location to
9319 which the link should point.
9321 A function in the hook should first test if it would like to
9322 handle this file type, for example by checking the `major-mode'
9323 or the file extension. If it decides not to handle this file, it
9324 should just return nil to give other functions a chance. If it
9325 does handle the file, it must return the search string to be used
9326 when following the link. The search string will be part of the
9327 file link, given after a double colon, and `org-open-at-point'
9328 will automatically search for it. If special measures must be
9329 taken to make the search successful, another function should be
9330 added to the companion hook `org-execute-file-search-functions',
9331 which see.
9333 A function in this hook may also use `setq' to set the variable
9334 `description' to provide a suggestion for the descriptive text to
9335 be used for this link when it gets inserted into an Org-mode
9338 (defvar org-execute-file-search-functions nil
9339 "List of functions to execute a file search triggered by a link.
9341 Functions added to this hook must accept a single argument, the
9342 search string that was part of the file link, the part after the
9343 double colon. The function must first check if it would like to
9344 handle this search, for example by checking the `major-mode' or
9345 the file extension. If it decides not to handle this search, it
9346 should just return nil to give other functions a chance. If it
9347 does handle the search, it must return a non-nil value to keep
9348 other functions from trying.
9350 Each function can access the current prefix argument through the
9351 variable `current-prefix-argument'. Note that a single prefix is
9352 used to force opening a link in Emacs, so it may be good to only
9353 use a numeric or double prefix to guide the search function.
9355 In case this is needed, a function in this hook can also restore
9356 the window configuration before `org-open-at-point' was called using:
9358 (set-window-configuration org-window-config-before-follow-link)")
9360 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9361 (defun org-link-search (s &optional type avoid-pos)
9362 "Search for a link search option.
9363 If S is surrounded by forward slashes, it is interpreted as a
9364 regular expression. In org-mode files, this will create an `org-occur'
9365 sparse tree. In ordinary files, `occur' will be used to list matches.
9366 If the current buffer is in `dired-mode', grep will be used to search
9367 in all files. If AVOID-POS is given, ignore matches near that position."
9368 (let ((case-fold-search t)
9372 org-emphasis-alist)
9374 (pos (point))
9375 (pre nil) (post nil)
9376 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9377 (cond
9378 ;; First check if there are any special search functions
9379 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9380 ;; Now try the builtin stuff
9381 ((and (equal (string-to-char s0) ?#)
9382 (> (length s0) 1)
9383 (save-excursion
9384 (goto-char (point-min))
9385 (and
9386 (re-search-forward
9388 (setq type 'dedicated
9389 pos (match-beginning 0))))
9390 ;; There is an exact target for this
9391 (goto-char pos)
9392 (org-back-to-heading t)))
9393 ((save-excursion
9394 (goto-char (point-min))
9395 (and
9396 (re-search-forward
9397 (concat "<<" (regexp-quote s0) ">>") nil t)
9398 (setq type 'dedicated
9399 pos (match-beginning 0))))
9400 ;; There is an exact target for this
9401 (goto-char pos))
9403 (save-excursion
9404 (goto-char (point-min))
9405 (and
9406 (re-search-forward
9407 (concat "[^[]" (regexp-quote
9408 (format org-coderef-label-format
9409 (match-string 1 s0))))
9410 nil t)
9411 (setq type 'dedicated
9412 pos (1+ (match-beginning 0))))))
9413 ;; There is a coderef target for this
9414 (goto-char pos))
9416 ;; A regular expression
9417 (cond
9418 ((org-mode-p)
9419 (org-occur (match-string 1 s)))
9420 ;;((eq major-mode 'dired-mode)
9421 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9422 (t (org-do-occur (match-string 1 s)))))
9423 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9424 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9425 (goto-char (point-min))
9426 (cond
9427 ((let (case-fold-search)
9428 (re-search-forward (format org-complex-heading-regexp-format
9429 (regexp-quote s))
9430 nil t))
9431 ;; OK, found a match
9432 (setq type 'dedicated)
9433 (goto-char (match-beginning 0)))
9434 ((and (not org-link-search-inhibit-query)
9435 (eq org-link-search-must-match-exact-headline 'query-to-create)
9436 (y-or-n-p "No match - create this as a new heading? "))
9437 (goto-char (point-max))
9438 (or (bolp) (newline))
9440 (beginning-of-line 0))
9441 (t
9442 (goto-char pos)
9443 (error "No match"))))
9444 (t
9445 ;; A normal search string
9446 (when (equal (string-to-char s) ?*)
9447 ;; Anchor on headlines, post may include tags.
9450 s (substring s 1)))
9451 (remove-text-properties
9452 0 (length s)
9453 '(face nil mouse-face nil keymap nil fontified nil) s)
9454 ;; Make a series of regular expressions to find a match
9463 re4 (concat "[^a-zA-Z_]" re4_)
9465 re1 (concat pre re2 post)
9466 re3 (concat pre (if pre re4_ re4) post)
9467 re5 (concat pre ".*" re4)
9468 re2 (concat pre re2)
9469 re2a (concat pre (if pre re2a_ re2a))
9470 re4 (concat pre (if pre re4_ re4))
9474 ))
9475 (cond
9476 ((eq type 'org-occur) (org-occur reall))
9477 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9478 (t (goto-char (point-min))
9479 (setq type 'fuzzy)
9480 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9481 (org-search-not-self 1 re1 nil t)
9482 (org-search-not-self 1 re2 nil t)
9483 (org-search-not-self 1 re2a nil t)
9484 (org-search-not-self 1 re3 nil t)
9485 (org-search-not-self 1 re4 nil t)
9486 (org-search-not-self 1 re5 nil t)
9487 )
9488 (goto-char (match-beginning 1))
9489 (goto-char pos)
9490 (error "No match"))))))
9491 (and (org-mode-p) (org-show-context 'link-search))
9492 type))
9494 (defun org-search-not-self (group &rest args)
9495 "Execute `re-search-forward', but only accept matches that do not
9496 enclose the position of `org-open-link-marker'."
9497 (let ((m org-open-link-marker))
9498 (catch 'exit
9499 (while (apply 're-search-forward args)
9500 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9501 (goto-char (match-end group))
9502 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9503 (> (match-beginning 0) (marker-position m))
9504 (< (match-end 0) (marker-position m)))
9505 (save-match-data
9506 (or (not (org-in-regexp
9507 org-bracket-link-analytic-regexp 1))
9508 (not (match-end 4)) ; no description
9509 (and (<= (match-beginning 4) (point))
9510 (>= (match-end 4) (point))))))
9511 (throw 'exit (point))))))))
9513 (defun org-get-buffer-for-internal-link (buffer)
9514 "Return a buffer to be used for displaying the link target of internal links."
9515 (cond
9516 ((not org-display-internal-link-with-indirect-buffer)
9517 buffer)
9518 ((string-match "(Clone)$" (buffer-name buffer))
9519 (message "Buffer is already a clone, not making another one")
9520 ;; we also do not modify visibility in this case
9521 buffer)
9522 (t ; make a new indirect buffer for displaying the link
9523 (let* ((bn (buffer-name buffer))
9524 (ibn (concat bn "(Clone)"))
9525 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9526 (with-current-buffer ib (org-overview))
9527 ib))))
9529 (defun org-do-occur (regexp &optional cleanup)
9530 "Call the Emacs command `occur'.
9531 If CLEANUP is non-nil, remove the printout of the regular expression
9532 in the *Occur* buffer. This is useful if the regex is long and not useful
9533 to read."
9534 (occur regexp)
9535 (when cleanup
9536 (let ((cwin (selected-window)) win beg end)
9537 (when (setq win (get-buffer-window "*Occur*"))
9538 (select-window win))
9539 (goto-char (point-min))
9540 (when (re-search-forward "match[a-z]+" nil t)
9541 (setq beg (match-end 0))
9543 (setq end (1- (match-beginning 0)))))
9544 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9545 (goto-char (point-min))
9546 (select-window cwin))))
9548 ;;; The mark ring for links jumps
9550 (defvar org-mark-ring nil
9551 "Mark ring for positions before jumps in Org-mode.")
9552 (defvar org-mark-ring-last-goto nil
9553 "Last position in the mark ring used to go back.")
9554 ;; Fill and close the ring
9555 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9556 (loop for i from 1 to org-mark-ring-length do
9557 (push (make-marker) org-mark-ring))
9558 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9559 org-mark-ring)
9561 (defun org-mark-ring-push (&optional pos buffer)
9562 "Put the current position or POS into the mark ring and rotate it."
9563 (interactive)
9564 (setq pos (or pos (point)))
9565 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9566 (move-marker (car org-mark-ring)
9567 (or pos (point))
9568 (or buffer (current-buffer)))
9569 (message "%s"
9570 (substitute-command-keys
9573 (defun org-mark-ring-goto (&optional n)
9574 "Jump to the previous position in the mark ring.
9575 With prefix arg N, jump back that many stored positions. When
9576 called several times in succession, walk through the entire ring.
9577 Org-mode commands jumping to a different position in the current file,
9578 or to another Org-mode file, automatically push the old position
9579 onto the ring."
9580 (interactive "p")
9581 (let (p m)
9582 (if (eq last-command this-command)
9583 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9584 (setq p org-mark-ring))
9585 (setq org-mark-ring-last-goto p)
9586 (setq m (car p))
9587 (switch-to-buffer (marker-buffer m))
9588 (goto-char m)
9589 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9591 (defun org-remove-angle-brackets (s)
9592 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9593 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9594 s)
9595 (defun org-add-angle-brackets (s)
9596 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9597 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9598 s)
9599 (defun org-remove-double-quotes (s)
9602 s)
9604 ;;; Following specific links
9606 (defun org-follow-timestamp-link ()
9607 (cond
9608 ((org-at-date-range-p t)
9609 (let ((org-agenda-start-on-weekday)
9610 (t1 (match-string 1))
9611 (t2 (match-string 2)))
9612 (setq t1 (time-to-days (org-time-string-to-time t1))
9613 t2 (time-to-days (org-time-string-to-time t2)))
9614 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9615 ((org-at-timestamp-p t)
9616 (org-agenda-list nil (time-to-days (org-time-string-to-time
9617 (substring (match-string 1) 0 10)))
9618 1))
9619 (t (error "This should not happen"))))
9622 ;;; Following file links
9623 (defvar org-wait nil)
9624 (defun org-open-file (path &optional in-emacs line search)
9625 "Open the file at PATH.
9626 First, this expands any special file name abbreviations. Then the
9627 configuration variable `org-file-apps' is checked if it contains an
9628 entry for this file type, and if yes, the corresponding command is launched.
9630 If no application is found, Emacs simply visits the file.
9632 With optional prefix argument IN-EMACS, Emacs will visit the file.
9634 prefix arg, Org tries to avoid opening in Emacs
9635 and to use an external application to visit the file.
9637 Optional LINE specifies a line to go to, optional SEARCH a string
9638 to search for. If LINE or SEARCH is given, the file will be
9639 opened in Emacs, unless an entry from org-file-apps that makes
9640 use of groups in a regexp matches.
9641 If the file does not exist, an error is thrown."
9642 (let* ((file (if (equal path "")
9643 buffer-file-name
9644 (substitute-in-file-name (expand-file-name path))))
9645 (file-apps (append org-file-apps (org-default-apps)))
9646 (apps (org-remove-if
9647 'org-file-apps-entry-match-against-dlink-p file-apps))
9648 (apps-dlink (org-remove-if-not
9649 'org-file-apps-entry-match-against-dlink-p file-apps))
9650 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9651 (dirp (if remp nil (file-directory-p file)))
9652 (file (if (and dirp org-open-directory-means-index-dot-org)
9653 (concat (file-name-as-directory file) "index.org")
9654 file))
9655 (a-m-a-p (assq 'auto-mode apps))
9656 (dfile (downcase file))
9657 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9658 (link (cond ((and (eq line nil)
9659 (eq search nil))
9660 file)
9661 (line
9662 (concat file "::" (number-to-string line)))
9663 (search
9664 (concat file "::" search))))
9665 (dlink (downcase link))
9666 (old-buffer (current-buffer))
9667 (old-pos (point))
9668 (old-mode major-mode)
9669 ext cmd link-match-data)
9671 (setq ext (match-string 1 dfile))
9673 (setq ext (match-string 1 dfile))))
9674 (cond
9675 ((member in-emacs '((16) system))
9676 (setq cmd (cdr (assoc 'system apps))))
9677 (in-emacs (setq cmd 'emacs))
9678 (t
9679 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9680 (and dirp (cdr (assoc 'directory apps)))
9681 ; first, try matching against apps-dlink
9682 ; if we get a match here, store the match data for later
9683 (let ((match (assoc-default dlink apps-dlink
9684 'string-match)))
9685 (if match
9686 (progn (setq link-match-data (match-data))
9687 match)
9688 (progn (setq in-emacs (or in-emacs line search))
9689 nil))) ; if we have no match in apps-dlink,
9690 ; always open the file in emacs if line or search
9691 ; is given (for backwards compatibility)
9692 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9693 'string-match)
9694 (cdr (assoc ext apps))
9695 (cdr (assoc t apps))))))
9696 (when (eq cmd 'system)
9697 (setq cmd (cdr (assoc 'system apps))))
9698 (when (eq cmd 'default)
9699 (setq cmd (cdr (assoc t apps))))
9700 (when (eq cmd 'mailcap)
9701 (require 'mailcap)
9702 (mailcap-parse-mailcaps)
9703 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9704 (command (mailcap-mime-info mime-type)))
9705 (if (stringp command)
9706 (setq cmd command)
9707 (setq cmd 'emacs))))
9708 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9709 (not (file-exists-p file))
9710 (not org-open-non-existing-files))
9711 (error "No such file: %s" file))
9712 (cond
9714 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9716 (setq cmd (replace-match "%s" t t cmd)))
9717 (while (string-match "%s" cmd)
9718 (setq cmd (replace-match
9719 (save-match-data
9720 (shell-quote-argument
9721 (convert-standard-filename file)))
9722 t t cmd)))
9724 ;; Replace "%1", "%2" etc. in command with group matches from regex
9725 (save-match-data
9726 (let ((match-index 1)
9727 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9728 (set-match-data link-match-data)
9729 (while (<= match-index number-of-groups)
9730 (let ((regex (concat "%" (number-to-string match-index)))
9731 (replace-with (match-string match-index dlink)))
9732 (while (string-match regex cmd)
9733 (setq cmd (replace-match replace-with t t cmd))))
9734 (setq match-index (+ match-index 1)))))
9736 (save-window-excursion
9737 (start-process-shell-command cmd nil cmd)
9738 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9739 ))
9740 ((or (stringp cmd)
9741 (eq cmd 'emacs))
9742 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9743 (widen)
9744 (if line (org-goto-line line)
9745 (if search (org-link-search search))))
9746 ((consp cmd)
9747 (let ((file (convert-standard-filename file)))
9748 (save-match-data
9749 (set-match-data link-match-data)
9750 (eval cmd))))
9751 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9752 (and (org-mode-p) (eq old-mode 'org-mode)
9753 (or (not (equal old-buffer (current-buffer)))
9754 (not (equal old-pos (point))))
9755 (org-mark-ring-push old-pos old-buffer))))
9757 (defun org-file-apps-entry-match-against-dlink-p (entry)
9758 "This function returns non-nil if `entry' uses a regular
9759 expression which should be matched against the whole link by
9760 org-open-file.
9762 It assumes that is the case when the entry uses a regular
9763 expression which has at least one grouping construct and the
9764 action is either a lisp form or a command string containing
9765 '%1', i.e. using at least one subexpression match as a
9766 parameter."
9767 (let ((selector (car entry))
9768 (action (cdr entry)))
9769 (if (stringp selector)
9770 (and (> (regexp-opt-depth selector) 0)
9771 (or (and (stringp action)
9772 (string-match "%[0-9]" action))
9773 (consp action)))
9774 nil)))
9776 (defun org-default-apps ()
9777 "Return the default applications for this operating system."
9778 (cond
9779 ((eq system-type 'darwin)
9780 org-file-apps-defaults-macosx)
9781 ((eq system-type 'windows-nt)
9782 org-file-apps-defaults-windowsnt)
9783 (t org-file-apps-defaults-gnu)))
9785 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9786 "Convert extensions to regular expressions in the cars of LIST.
9787 Also, weed out any non-string entries, because the return value is used
9788 only for regexp matching.
9789 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9790 point to the symbol `emacs', indicating that the file should
9791 be opened in Emacs."
9792 (append
9793 (delq nil
9794 (mapcar (lambda (x)
9795 (if (not (stringp (car x)))
9796 nil
9798 x
9800 list))
9801 (if add-auto-mode
9802 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9804 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9805 (defun org-file-remote-p (file)
9806 "Test whether FILE specifies a location on a remote system.
9807 Return non-nil if the location is indeed remote.
9811 (cond ((fboundp 'file-remote-p)
9812 (file-remote-p file))
9813 ((fboundp 'tramp-handle-file-remote-p)
9814 (tramp-handle-file-remote-p file))
9815 ((and (boundp 'ange-ftp-name-format)
9816 (string-match (car ange-ftp-name-format) file))
9817 t)
9818 (t nil)))
9821 ;;;; Refiling
9823 (defun org-get-org-file ()
9824 "Read a filename, with default directory `org-directory'."
9825 (let ((default (or org-default-notes-file remember-data-file)))
9826 (read-file-name (format "File name [%s]: " default)
9827 (file-name-as-directory org-directory)
9828 default)))
9830 (defun org-notes-order-reversed-p ()
9831 "Check if the current file should receive notes in reversed order."
9832 (cond
9833 ((not org-reverse-note-order) nil)
9834 ((eq t org-reverse-note-order) t)
9835 ((not (listp org-reverse-note-order)) nil)
9836 (t (catch 'exit
9837 (let ((all org-reverse-note-order)
9838 entry)
9839 (while (setq entry (pop all))
9840 (if (string-match (car entry) buffer-file-name)
9841 (throw 'exit (cdr entry))))
9842 nil)))))
9844 (defvar org-refile-target-table nil
9845 "The list of refile targets, created by `org-refile'.")
9847 (defvar org-agenda-new-buffers nil
9848 "Buffers created to visit agenda files.")
9850 (defvar org-refile-cache nil
9851 "Cache for refile targets.")
9854 (defvar org-refile-markers nil
9855 "All the markers used for caching refile locations.")
9857 (defun org-refile-marker (pos)
9858 "Get a new refile marker, but only if caching is in use."
9859 (if (not org-refile-use-cache)
9860 pos
9861 (let ((m (make-marker)))
9862 (move-marker m pos)
9863 (push m org-refile-markers)
9864 m)))
9866 (defun org-refile-cache-clear ()
9867 "Clear the refile cache and disable all the markers."
9868 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9869 (setq org-refile-markers nil)
9870 (setq org-refile-cache nil)
9871 (message "Refile cache has been cleared"))
9873 (defun org-refile-cache-check-set (set)
9874 "Check if all the markers in the cache still have live buffers."
9875 (let (marker)
9876 (catch 'exit
9877 (while (and set (setq marker (nth 3 (pop set))))
9878 ;; if org-refile-use-outline-path is 'file, marker may be nil
9879 (when (and marker (null (marker-buffer marker)))
9880 (message "not found") (sit-for 3)
9881 (throw 'exit nil)))
9882 t)))
9884 (defun org-refile-cache-put (set &rest identifiers)
9885 "Push the refile targets SET into the cache, under IDENTIFIERS."
9886 (let* ((key (sha1 (prin1-to-string identifiers)))
9887 (entry (assoc key org-refile-cache)))
9888 (if entry
9889 (setcdr entry set)
9890 (push (cons key set) org-refile-cache))))
9892 (defun org-refile-cache-get (&rest identifiers)
9893 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9894 (cond
9895 ((not org-refile-cache) nil)
9896 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9897 (t
9898 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9899 org-refile-cache))))
9900 (and set (org-refile-cache-check-set set) set)))))
9902 (defun org-get-refile-targets (&optional default-buffer)
9903 "Produce a table with refile targets."
9904 (let ((case-fold-search nil)
9905 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9906 (entries (or org-refile-targets '((nil . (:level . 1)))))
9907 targets tgs txt re files f desc descre fast-path-p level pos0)
9908 (message "Getting targets...")
9909 (with-current-buffer (or default-buffer (current-buffer))
9910 (while (setq entry (pop entries))
9911 (setq files (car entry) desc (cdr entry))
9912 (setq fast-path-p nil)
9913 (cond
9914 ((null files) (setq files (list (current-buffer))))
9915 ((eq files 'org-agenda-files)
9916 (setq files (org-agenda-files 'unrestricted)))
9917 ((and (symbolp files) (fboundp files))
9918 (setq files (funcall files)))
9919 ((and (symbolp files) (boundp files))
9920 (setq files (symbol-value files))))
9921 (if (stringp files) (setq files (list files)))
9922 (cond
9923 ((eq (car desc) :tag)
9925 ((eq (car desc) :todo)
9927 ((eq (car desc) :regexp)
9928 (setq descre (cdr desc)))
9929 ((eq (car desc) :level)
9931 (if org-odd-levels-only
9932 (1- (* 2 (cdr desc)))
9933 (cdr desc)))
9935 ((eq (car desc) :maxlevel)
9936 (setq fast-path-p t)
9938 (if org-odd-levels-only
9939 (1- (* 2 (cdr desc)))
9940 (cdr desc)))
9942 (t (error "Bad refiling target description %s" desc)))
9943 (while (setq f (pop files))
9944 (with-current-buffer
9945 (if (bufferp f) f (org-get-agenda-file-buffer f))
9946 (or
9947 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9948 (progn
9949 (if (bufferp f) (setq f (buffer-file-name
9950 (buffer-base-buffer f))))
9951 (setq f (and f (expand-file-name f)))
9952 (if (eq org-refile-use-outline-path 'file)
9953 (push (list (file-name-nondirectory f) f nil nil) tgs))
9954 (save-excursion
9955 (save-restriction
9956 (widen)
9957 (goto-char (point-min))
9958 (while (re-search-forward descre nil t)
9959 (goto-char (setq pos0 (point-at-bol)))
9960 (catch 'next
9961 (when org-refile-target-verify-function
9962 (save-match-data
9963 (or (funcall org-refile-target-verify-function)
9964 (throw 'next t))))
9965 (when (looking-at org-complex-heading-regexp)
9966 (setq level (org-reduced-level
9967 (- (match-end 1) (match-beginning 1)))
9968 txt (org-link-display-format (match-string 4))
9970 re (format org-complex-heading-regexp-format
9971 (regexp-quote (match-string 4))))
9972 (when org-refile-use-outline-path
9973 (setq txt (mapconcat
9974 'org-protect-slash
9975 (append
9976 (if (eq org-refile-use-outline-path
9977 'file)
9978 (list (file-name-nondirectory
9979 (buffer-file-name
9980 (buffer-base-buffer))))
9981 (if (eq org-refile-use-outline-path
9982 'full-file-path)
9983 (list (buffer-file-name
9984 (buffer-base-buffer)))))
9985 (org-get-outline-path fast-path-p
9986 level txt)
9987 (list txt))
9988 "/")))
9989 (push (list txt f re (org-refile-marker (point)))
9990 tgs)))
9991 (when (= (point) pos0)
9992 ;; verification function has not moved point
9993 (goto-char (point-at-eol))))))))
9994 (when org-refile-use-cache
9995 (org-refile-cache-put tgs (buffer-file-name) descre))
9996 (setq targets (append tgs targets))
9997 ))))
9998 (message "Getting targets...done")
9999 (nreverse targets)))
10001 (defun org-protect-slash (s)
10002 (while (string-match "/" s)
10004 s)
10006 (defvar org-olpa (make-vector 20 nil))
10008 (defun org-get-outline-path (&optional fastp level heading)
10009 "Return the outline path to the current entry, as a list.
10011 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10012 routine which makes outline path derivations for an entire file,
10013 avoiding backtracing. Refile target collection makes use of that."
10014 (if fastp
10015 (progn
10016 (if (> level 19)
10017 (error "Outline path failure, more than 19 levels"))
10018 (loop for i from level upto 19 do
10019 (aset org-olpa i nil))
10020 (prog1
10021 (delq nil (append org-olpa nil))
10022 (aset org-olpa level heading)))
10023 (let (rtn case-fold-search)
10024 (save-excursion
10025 (save-restriction
10026 (widen)
10027 (while (org-up-heading-safe)
10028 (when (looking-at org-complex-heading-regexp)
10029 (push (org-match-string-no-properties 4) rtn)))
10030 rtn)))))
10032 (defun org-format-outline-path (path &optional width prefix)
10033 "Format the outline path PATH for display.
10034 Width is the maximum number of characters that is available.
10035 Prefix is a prefix to be included in the returned string,
10036 such as the file name."
10037 (setq width (or width 79))
10038 (if prefix (setq width (- width (length prefix))))
10039 (if (not path)
10040 (or prefix "")
10041 (let* ((nsteps (length path))
10042 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10043 (maxwidth (if (<= total-width width)
10044 10000 ;; everything fits
10045 ;; we need to shorten the level headings
10046 (/ (- width nsteps) nsteps)))
10047 (org-odd-levels-only nil)
10048 (n 0)
10049 (total (1+ (length prefix))))
10050 (setq maxwidth (max maxwidth 10))
10051 (concat prefix
10052 (mapconcat
10053 (lambda (h)
10054 (setq n (1+ n))
10055 (if (and (= n nsteps) (< maxwidth 10000))
10056 (setq maxwidth (- total-width total)))
10057 (if (< (length h) maxwidth)
10058 (progn (setq total (+ total (length h) 1)) h)
10059 (setq h (substring h 0 (- maxwidth 2))
10060 total (+ total maxwidth 1))
10062 (setq h (substring h 0 (match-beginning 0))))
10063 (setq h (concat h "..")))
10064 (org-add-props h nil 'face
10065 (nth (% (1- n) org-n-level-faces)
10066 org-level-faces))
10067 h)
10068 path "/")))))
10070 (defun org-display-outline-path (&optional file current)
10071 "Display the current outline path in the echo area."
10072 (interactive "P")
10073 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10074 (case-fold-search nil)
10075 (path (and (org-mode-p) (org-get-outline-path))))
10076 (if current (setq path (append path
10077 (save-excursion
10078 (org-back-to-heading t)
10079 (if (looking-at org-complex-heading-regexp)
10080 (list (match-string 4)))))))
10081 (message "%s"
10082 (org-format-outline-path
10083 path
10084 (1- (frame-width))
10085 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10087 (defvar org-refile-history nil
10088 "History for refiling operations.")
10090 (defvar org-after-refile-insert-hook nil
10091 "Hook run after `org-refile' has inserted its stuff at the new location.
10092 Note that this is still *before* the stuff will be removed from
10093 the *old* location.")
10095 (defvar org-capture-last-stored-marker)
10096 (defun org-refile (&optional goto default-buffer rfloc)
10097 "Move the entry at point to another heading.
10098 The list of target headings is compiled using the information in
10099 `org-refile-targets', which see. This list is created before each use
10100 and will therefore always be up-to-date.
10102 At the target location, the entry is filed as a subitem of the target heading.
10103 Depending on `org-reverse-note-order', the new subitem will either be the
10104 first or the last subitem.
10106 If there is an active region, all entries in that region will be moved.
10107 However, the region must fulfill the requirement that the first heading
10108 is the first one sets the top-level of the moved text - at most siblings
10109 below it are allowed.
10111 With prefix arg GOTO, the command will only visit the target location,
10112 not actually move anything.
10114 go to the location where the last refiling
10115 operation has put the subtree.
10116 With a prefix argument of `2', refile to the running clock.
10118 RFLOC can be a refile location obtained in a different way.
10120 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10122 If you are using target caching (see `org-refile-use-cache'),
10123 You have to clear the target cache in order to find new targets.
10124 This can be done with a 0 prefix: `C-0 C-c C-w'"
10125 (interactive "P")
10126 (if (member goto '(0 (64)))
10127 (org-refile-cache-clear)
10128 (let* ((cbuf (current-buffer))
10129 (regionp (org-region-active-p))
10130 (region-start (and regionp (region-beginning)))
10131 (region-end (and regionp (region-end)))
10132 (region-length (and regionp (- region-end region-start)))
10133 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10134 pos it nbuf file re level reversed)
10135 (setq last-command nil)
10136 (when regionp
10137 (goto-char region-start)
10138 (or (bolp) (goto-char (point-at-bol)))
10139 (setq region-start (point))
10140 (unless (org-kill-is-subtree-p
10141 (buffer-substring region-start region-end))
10142 (error "The region is not a (sequence of) subtree(s)")))
10143 (if (equal goto '(16))
10144 (org-refile-goto-last-stored)
10145 (when (or
10146 (and (equal goto 2)
10147 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10148 (prog1
10149 (setq it (list (or org-clock-heading "running clock")
10150 (buffer-file-name
10151 (marker-buffer org-clock-hd-marker))
10152 ""
10153 (marker-position org-clock-hd-marker)))
10154 (setq goto nil)))
10155 (setq it (or rfloc
10156 (save-excursion
10157 (org-refile-get-location
10158 (if goto "Goto: " "Refile to: ") default-buffer
10159 org-refile-allow-creating-parent-nodes)))))
10160 (setq file (nth 1 it)
10161 re (nth 2 it)
10162 pos (nth 3 it))
10163 (if (and (not goto)
10164 pos
10165 (equal (buffer-file-name) file)
10166 (if regionp
10167 (and (>= pos region-start)
10168 (<= pos region-end))
10169 (and (>= pos (point))
10170 (< pos (save-excursion
10171 (org-end-of-subtree t t))))))
10172 (error "Cannot refile to position inside the tree or region"))
10174 (setq nbuf (or (find-buffer-visiting file)
10175 (find-file-noselect file)))
10176 (if goto
10177 (progn
10178 (switch-to-buffer nbuf)
10179 (goto-char pos)
10180 (org-show-context 'org-goto))
10181 (if regionp
10182 (progn
10183 (org-kill-new (buffer-substring region-start region-end))
10184 (org-save-markers-in-region region-start region-end))
10185 (org-copy-subtree 1 nil t))
10186 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10187 (find-file-noselect file)))
10188 (setq reversed (org-notes-order-reversed-p))
10189 (save-excursion
10190 (save-restriction
10191 (widen)
10192 (if pos
10193 (progn
10194 (goto-char pos)
10195 (looking-at outline-regexp)
10196 (setq level (org-get-valid-level (funcall outline-level) 1))
10197 (goto-char
10198 (if reversed
10199 (or (outline-next-heading) (point-max))
10200 (or (save-excursion (org-get-next-sibling))
10201 (org-end-of-subtree t t)
10202 (point-max)))))
10203 (setq level 1)
10204 (if (not reversed)
10205 (goto-char (point-max))
10206 (goto-char (point-min))
10207 (or (outline-next-heading) (goto-char (point-max)))))
10208 (if (not (bolp)) (newline))
10209 (org-paste-subtree level)
10210 (when org-log-refile
10211 (org-add-log-setup 'refile nil nil 'findpos
10212 org-log-refile)
10213 (unless (eq org-log-refile 'note)
10214 (save-excursion (org-add-log-note))))
10215 (and org-auto-align-tags (org-set-tags nil t))
10216 (bookmark-set "org-refile-last-stored")
10217 ;; If we are refiling for capture, make sure that the
10218 ;; last-capture pointers point here
10219 (when (org-bound-and-true-p org-refile-for-capture)
10220 (bookmark-set "org-capture-last-stored-marker")
10221 (move-marker org-capture-last-stored-marker (point)))
10222 (if (fboundp 'deactivate-mark) (deactivate-mark))
10223 (run-hooks 'org-after-refile-insert-hook))))
10224 (if regionp
10225 (delete-region (point) (+ (point) region-length))
10226 (org-cut-subtree))
10227 (when (featurep 'org-inlinetask)
10228 (org-inlinetask-remove-END-maybe))
10229 (setq org-markers-to-move nil)
10232 (defun org-refile-goto-last-stored ()
10233 "Go to the location where the last refile was stored."
10234 (interactive)
10235 (bookmark-jump "org-refile-last-stored")
10236 (message "This is the location of the last refile"))
10238 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10239 "Prompt the user for a refile location, using PROMPT."
10240 (let ((org-refile-targets org-refile-targets)
10241 (org-refile-use-outline-path org-refile-use-outline-path))
10242 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10243 (unless org-refile-target-table
10244 (error "No refile targets"))
10245 (let* ((cbuf (current-buffer))
10246 (partial-completion-mode nil)
10247 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10248 (cfunc (if (and org-refile-use-outline-path
10249 org-outline-path-complete-in-steps)
10250 'org-olpath-completing-read
10251 'org-icompleting-read))
10252 (extra (if org-refile-use-outline-path "/" ""))
10253 (filename (and cfn (expand-file-name cfn)))
10254 (tbl (mapcar
10255 (lambda (x)
10256 (if (and (not (member org-refile-use-outline-path
10257 '(file full-file-path)))
10258 (not (equal filename (nth 1 x))))
10259 (cons (concat (car x) extra " ("
10260 (file-name-nondirectory (nth 1 x)) ")")
10261 (cdr x))
10262 (cons (concat (car x) extra) (cdr x))))
10263 org-refile-target-table))
10264 (completion-ignore-case t)
10265 pa answ parent-target child parent old-hist)
10266 (setq old-hist org-refile-history)
10267 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10268 nil 'org-refile-history))
10269 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10270 (org-refile-check-position pa)
10271 (if pa
10272 (progn
10273 (when (or (not org-refile-history)
10274 (not (eq old-hist org-refile-history))
10275 (not (equal (car pa) (car org-refile-history))))
10276 (setq org-refile-history
10277 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10278 org-refile-history
10279 (cdr org-refile-history))))
10280 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10281 (pop org-refile-history)))
10282 pa)
10284 (progn
10285 (setq parent (match-string 1 answ)
10286 child (match-string 2 answ))
10287 (setq parent-target (or (assoc parent tbl)
10288 (assoc (concat parent "/") tbl)))
10289 (when (and parent-target
10290 (or (eq new-nodes t)
10291 (and (eq new-nodes 'confirm)
10293 child)))))
10294 (org-refile-new-child parent-target child)))
10295 (error "Invalid target location")))))
10297 (defun org-refile-check-position (refile-pointer)
10298 "Check if the refile pointer matches the readline to which it points."
10299 (let* ((file (nth 1 refile-pointer))
10300 (re (nth 2 refile-pointer))
10301 (pos (nth 3 refile-pointer))
10302 buffer)
10303 (when (org-string-nw-p re)
10304 (setq buffer (if (markerp pos)
10305 (marker-buffer pos)
10306 (or (find-buffer-visiting file)
10307 (find-file-noselect file))))
10308 (with-current-buffer buffer
10309 (save-excursion
10310 (save-restriction
10311 (widen)
10312 (goto-char pos)
10313 (beginning-of-line 1)
10314 (unless (org-looking-at-p re)
10315 (error "Invalid refile position, please rebuild the cache"))))))))
10317 (defun org-refile-new-child (parent-target child)
10318 "Use refile target PARENT-TARGET to add new CHILD below it."
10319 (unless parent-target
10320 (error "Cannot find parent for new node"))
10321 (let ((file (nth 1 parent-target))
10322 (pos (nth 3 parent-target))
10323 level)
10324 (with-current-buffer (or (find-buffer-visiting file)
10325 (find-file-noselect file))
10326 (save-excursion
10327 (save-restriction
10328 (widen)
10329 (if pos
10330 (goto-char pos)
10331 (goto-char (point-max))
10332 (if (not (bolp)) (newline)))
10333 (when (looking-at outline-regexp)
10334 (setq level (funcall outline-level))
10335 (org-end-of-subtree t t))
10336 (org-back-over-empty-lines)
10338 (if pos (org-get-valid-level level 1) 1) ?*)
10340 (beginning-of-line 0)
10341 (list (concat (car parent-target) "/" child) file "" (point)))))))
10343 (defun org-olpath-completing-read (prompt collection &rest args)
10344 "Read an outline path like a file name."
10345 (let ((thetable collection)
10346 (org-completion-use-ido nil) ; does not work with ido.
10347 (org-completion-use-iswitchb nil)) ; or iswitchb
10348 (apply
10349 'org-icompleting-read prompt
10350 (lambda (string predicate &optional flag)
10351 (let (rtn r f (l (length string)))
10352 (cond
10353 ((eq flag nil)
10354 ;; try completion
10355 (try-completion string thetable))
10356 ((eq flag t)
10357 ;; all-completions
10358 (setq rtn (all-completions string thetable predicate))
10359 (mapcar
10360 (lambda (x)
10361 (setq r (substring x l))
10362 (if (string-match " ([^)]*)$" x)
10363 (setq f (match-string 0 x))
10364 (setq f ""))
10365 (if (string-match "/" r)
10366 (concat string (substring r 0 (match-end 0)) f)
10367 x))
10368 rtn))
10369 ((eq flag 'lambda)
10370 ;; exact match?
10371 (assoc string thetable)))
10372 ))
10373 args)))
10375 ;;;; Dynamic blocks
10377 (defun org-find-dblock (name)
10378 "Find the first dynamic block with name NAME in the buffer.
10379 If not found, stay at current position and return nil."
10380 (let (pos)
10381 (save-excursion
10382 (goto-char (point-min))
10384 nil t)
10385 (match-beginning 0))))
10386 (if pos (goto-char pos))
10387 pos))
10389 (defconst org-dblock-start-re
10391 "Matches the start line of a dynamic block, with parameters.")
10394 "Matches the end of a dynamic block.")
10396 (defun org-create-dblock (plist)
10397 "Create a dynamic block section, with parameters taken from PLIST.
10398 PLIST must contain a :name entry which is used as name of the block."
10400 (end-of-line 1)
10401 (newline))
10402 (let ((col (current-column))
10403 (name (plist-get plist :name)))
10404 (insert "#+BEGIN: " name)
10405 (while plist
10406 (if (eq (car plist) :name)
10407 (setq plist (cddr plist))
10408 (insert " " (prin1-to-string (pop plist)))))
10410 (beginning-of-line -2)))
10412 (defun org-prepare-dblock ()
10413 "Prepare dynamic block for refresh.
10414 This empties the block, puts the cursor at the insert position and returns
10415 the property list including an extra property :name with the block name."
10416 (unless (looking-at org-dblock-start-re)
10417 (error "Not at a dynamic block"))
10418 (let* ((begdel (1+ (match-end 0)))
10419 (name (org-no-properties (match-string 1)))
10420 (params (append (list :name name)
10421 (read (concat "(" (match-string 3) ")")))))
10422 (save-excursion
10423 (beginning-of-line 1)
10425 (setq params (plist-put params :indentation-column (current-column))))
10426 (unless (re-search-forward org-dblock-end-re nil t)
10427 (error "Dynamic block not terminated"))
10428 (setq params
10429 (append params
10430 (list :content (buffer-substring
10431 begdel (match-beginning 0)))))
10432 (delete-region begdel (match-beginning 0))
10433 (goto-char begdel)
10434 (open-line 1)
10435 params))
10437 (defun org-map-dblocks (&optional command)
10438 "Apply COMMAND to all dynamic blocks in the current buffer.
10439 If COMMAND is not given, use `org-update-dblock'."
10440 (let ((cmd (or command 'org-update-dblock)))
10441 (save-excursion
10442 (goto-char (point-min))
10443 (while (re-search-forward org-dblock-start-re nil t)
10444 (goto-char (match-beginning 0))
10445 (save-excursion
10446 (condition-case nil
10447 (funcall cmd)
10448 (error (message "Error during update of dynamic block"))))
10449 (unless (re-search-forward org-dblock-end-re nil t)
10450 (error "Dynamic block not terminated"))))))
10452 (defun org-dblock-update (&optional arg)
10453 "User command for updating dynamic blocks.
10454 Update the dynamic block at point. With prefix ARG, update all dynamic
10455 blocks in the buffer."
10456 (interactive "P")
10457 (if arg
10458 (org-update-all-dblocks)
10459 (or (looking-at org-dblock-start-re)
10460 (org-beginning-of-dblock))
10461 (org-update-dblock)))
10463 (defun org-update-dblock ()
10464 "Update the dynamic block at point.
10465 This means to empty the block, parse for parameters and then call
10466 the correct writing function."
10467 (save-window-excursion
10468 (let* ((pos (point))
10469 (line (org-current-line))
10470 (params (org-prepare-dblock))
10471 (name (plist-get params :name))
10472 (indent (plist-get params :indentation-column))
10473 (cmd (intern (concat "org-dblock-write:" name))))
10474 (message "Updating dynamic block `%s' at line %d..." name line)
10475 (funcall cmd params)
10476 (message "Updating dynamic block `%s' at line %d...done" name line)
10477 (goto-char pos)
10478 (when (and indent (> indent 0))
10479 (setq indent (make-string indent ?\ ))
10480 (save-excursion
10481 (org-beginning-of-dblock)
10482 (forward-line 1)
10483 (while (not (looking-at org-dblock-end-re))
10484 (insert indent)
10485 (beginning-of-line 2))
10486 (when (looking-at org-dblock-end-re)
10488 (replace-match ""))
10489 (insert indent)))))))
10491 (defun org-beginning-of-dblock ()
10492 "Find the beginning of the dynamic block at point.
10493 Error if there is no such block at point."
10494 (let ((pos (point))
10495 beg)
10496 (end-of-line 1)
10497 (if (and (re-search-backward org-dblock-start-re nil t)
10498 (setq beg (match-beginning 0))
10499 (re-search-forward org-dblock-end-re nil t)
10500 (> (match-end 0) pos))
10501 (goto-char beg)
10502 (goto-char pos)
10503 (error "Not in a dynamic block"))))
10505 (defun org-update-all-dblocks ()
10506 "Update all dynamic blocks in the buffer.
10507 This function can be used in a hook."
10508 (when (org-mode-p)
10509 (org-map-dblocks 'org-update-dblock)))
10512 ;;;; Completion
10514 (defconst org-additional-option-like-keywords
10515 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10516 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10517 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10518 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10519 "BEGIN:" "END:"
10520 "ORGTBL" "TBLFM:" "TBLNAME:"
10521 "BEGIN_EXAMPLE" "END_EXAMPLE"
10522 "BEGIN_QUOTE" "END_QUOTE"
10523 "BEGIN_VERSE" "END_VERSE"
10524 "BEGIN_CENTER" "END_CENTER"
10525 "BEGIN_SRC" "END_SRC"
10526 "CATEGORY" "COLUMNS" "PROPERTY"
10527 "CAPTION" "LABEL"
10528 "SETUPFILE"
10529 "BIND"
10530 "MACRO"))
10532 (defcustom org-structure-template-alist
10533 '(
10546 ("L" "#+latex: "
10550 ("H" "#+html: "
10553 ("A" "#+ascii: ")
10554 ("i" "#+include %file ?"
10556 )
10557 "Structure completion elements.
10558 This is a list of abbreviation keys and values. The value gets inserted
10559 if you type `<' followed by the key and then press the completion key,
10560 usually `M-TAB'. %file will be replaced by a file name after prompting
10561 for the file using completion.
10562 There are two templates for each key, the first uses the original Org syntax,
10563 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10564 the default when the /org-mtags.el/ module has been loaded. See also the
10565 variable `org-mtags-prefer-muse-templates'.
10566 This is an experimental feature, it is undecided if it is going to stay in."
10567 :group 'org-completion
10568 :type '(repeat
10569 (string :tag "Key")
10570 (string :tag "Template")
10571 (string :tag "Muse Template")))
10573 (defun org-try-structure-completion ()
10574 "Try to complete a structure template before point.
10576 expands them."
10577 (let ((l (buffer-substring (point-at-bol) (point)))
10578 a)
10581 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10582 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10583 (match-beginning 1)) a)
10584 t)))
10586 (defun org-complete-expand-structure-template (start cell)
10587 "Expand a structure template."
10588 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10589 (rpl (nth (if musep 2 1) cell))
10590 (ind ""))
10591 (delete-region start (point))
10593 (cond
10594 ((bolp))
10596 (setq ind (buffer-substring (point-at-bol) (point))))
10597 (t (newline))))
10598 (setq start (point))
10599 (if (string-match "%file" rpl)
10600 (setq rpl (replace-match
10601 (concat
10603 (save-match-data
10604 (abbreviate-file-name (read-file-name "Include file: ")))
10606 t t rpl)))
10609 (insert rpl)
10613 (defun org-complete (&optional arg)
10614 "Perform completion on word at point.
10615 At the beginning of a headline, this completes TODO keywords as given in
10616 `org-todo-keywords'.
10617 If the current word is preceded by a backslash, completes the TeX symbols
10618 that are supported for HTML support.
10620 setting file options.
10622 At all other locations, this simply calls the value of
10623 `org-completion-fallback-command'."
10624 (interactive "P")
10625 (org-without-partial-completion
10626 (catch 'exit
10627 (let* ((a nil)
10628 (end (point))
10629 (beg1 (save-excursion
10630 (skip-chars-backward (org-re "[:alnum:]_@#%"))
10631 (point)))
10632 (beg (save-excursion
10633 (skip-chars-backward "a-zA-Z0-9_:$")
10634 (point)))
10635 (confirm (lambda (x) (stringp (car x))))
10636 (searchhead (equal (char-before beg) ?*))
10637 (struct
10638 (when (and (member (char-before beg1) '(?. ?<))
10639 (setq a (assoc (buffer-substring beg1 (point))
10640 org-structure-template-alist)))
10641 (org-complete-expand-structure-template (1- beg1) a)
10642 (throw 'exit t)))
10643 (tag (and (equal (char-before beg1) ?:)
10644 (equal (char-after (point-at-bol)) ?*)))
10645 (prop (or (and (equal (char-before beg1) ?:)
10646 (not (equal (char-after (point-at-bol)) ?*)))
10648 (buffer-substring (point-at-bol) (point)))))
10650 (link (equal (char-before beg) ?\[))
10651 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10652 beg)
10653 "#+"))
10655 (buffer-substring (point-at-bol) (point))))
10656 (completion-ignore-case opt)
10657 (type nil)
10658 (tbl nil)
10659 (table (cond
10660 (opt
10661 (setq type :opt)
10662 (require 'org-exp)
10663 (append
10664 (delq nil
10665 (mapcar
10666 (lambda (x)
10667 (if (string-match
10669 (cons (match-string 2 x)
10670 (match-string 1 x))))
10672 (mapcar 'list org-additional-option-like-keywords)))
10673 (startup
10674 (setq type :startup)
10675 org-startup-options)
10676 (link (append org-link-abbrev-alist-local
10677 org-link-abbrev-alist))
10678 (texp
10679 (setq type :tex)
10680 (append org-entities-user org-entities))
10682 (buffer-substring (point-at-bol) beg))
10683 (setq type :todo)
10684 (mapcar 'list org-todo-keywords-1))
10685 (searchhead
10686 (setq type :searchhead)
10687 (save-excursion
10688 (goto-char (point-min))
10689 (while (re-search-forward org-todo-line-regexp nil t)
10690 (push (list
10691 (org-make-org-heading-search-string
10692 (match-string 3) t))
10693 tbl)))
10694 tbl)
10695 (tag (setq type :tag beg beg1)
10696 (or org-tag-alist (org-get-buffer-tags)))
10697 (prop (setq type :prop beg beg1)
10698 (mapcar 'list (org-buffer-property-keys nil t t)))
10699 (t (progn
10700 (call-interactively org-completion-fallback-command)
10701 (throw 'exit nil)))))
10702 (pattern (buffer-substring-no-properties beg end))
10703 (completion (try-completion pattern table confirm)))
10704 (cond ((eq completion t)
10705 (if (not (assoc (upcase pattern) table))
10706 (message "Already complete")
10707 (if (and (equal type :opt)
10708 (not (member (car (assoc (upcase pattern) table))
10709 org-additional-option-like-keywords)))
10710 (insert (substring (cdr (assoc (upcase pattern) table))
10711 (length pattern)))
10712 (if (memq type '(:tag :prop)) (insert ":")))))
10713 ((null completion)
10715 (ding))
10716 ((not (string= pattern completion))
10717 (delete-region beg end)
10718 (if (string-match " +$" completion)
10719 (setq completion (replace-match "" t t completion)))
10720 (insert completion)
10721 (if (get-buffer-window "*Completions*")
10722 (delete-window (get-buffer-window "*Completions*")))
10723 (if (assoc completion table)
10724 (if (eq type :todo) (insert " ")
10725 (if (and (memq type '(:tag :prop))
10727 (org-current-line-string t))))
10728 (insert ":"))))
10729 (if (and (equal type :opt) (assoc completion table))
10730 (message "%s" (substitute-command-keys
10732 (t
10733 (message "Making completion list...")
10734 (let ((list (sort (all-completions pattern table confirm)
10735 'string<)))
10736 (with-output-to-temp-buffer "*Completions*"
10737 (condition-case nil
10738 ;; Protection needed for XEmacs and emacs 21
10739 (display-completion-list list pattern)
10740 (error (display-completion-list list)))))
10741 (message "Making completion list...%s" "done")))))))
10743 ;;;; TODO, DEADLINE, Comments
10745 (defun org-toggle-comment ()
10746 "Change the COMMENT state of an entry."
10747 (interactive)
10748 (save-excursion
10749 (org-back-to-heading)
10750 (let (case-fold-search)
10751 (if (looking-at (concat outline-regexp
10753 (replace-match "" t t nil 1)
10754 (if (looking-at outline-regexp)
10755 (progn
10756 (goto-char (match-end 0))
10757 (insert org-comment-string " ")))))))
10759 (defvar org-last-todo-state-is-todo nil
10760 "This is non-nil when the last TODO state change led to a TODO state.
10761 If the last change removed the TODO tag or switched to DONE, then
10762 this is nil.")
10764 (defvar org-setting-tags nil) ; dynamically skipped
10766 (defvar org-todo-setup-filter-hook nil
10767 "Hook for functions that pre-filter todo specs.
10768 Each function takes a todo spec and returns either nil or the spec
10769 transformed into canonical form." )
10771 (defvar org-todo-get-default-hook nil
10772 "Hook for functions that get a default item for todo.
10773 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10774 nil or a string to be used for the todo mark." )
10776 (defvar org-agenda-headline-snapshot-before-repeat)
10778 (defun org-todo (&optional arg)
10779 "Change the TODO state of an item.
10780 The state of an item is given by a keyword at the start of the heading,
10781 like
10782 *** TODO Write paper
10783 *** DONE Call mom
10785 The different keywords are specified in the variable `org-todo-keywords'.
10787 So for this example: when the item starts with TODO, it is changed to DONE.
10788 When it starts with DONE, the DONE is removed. And when neither TODO nor
10789 DONE are present, add TODO at the beginning of the heading.
10792 state.
10793 With numeric prefix arg, switch to that state.
10795 keywords (nextset).
10798 For calling through lisp, arg is also interpreted in the following way:
10799 'none -> empty state
10801 'done -> switch to DONE
10802 'nextset -> switch to the next set of keywords
10803 'previousset -> switch to the previous set of keywords
10805 really is a member of `org-todo-keywords'."
10806 (interactive "P")
10807 (if (equal arg '(16)) (setq arg 'nextset))
10808 (let ((org-blocker-hook org-blocker-hook)
10809 (case-fold-search nil))
10810 (when (equal arg '(64))
10811 (setq arg nil org-blocker-hook nil))
10812 (when (and org-blocker-hook
10813 (or org-inhibit-blocking
10814 (org-entry-get nil "NOBLOCKING")))
10815 (setq org-blocker-hook nil))
10816 (save-excursion
10817 (catch 'exit
10818 (org-back-to-heading t)
10819 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10821 (looking-at " *"))
10822 (let* ((match-data (match-data))
10823 (startpos (point-at-bol))
10824 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10825 (org-log-done org-log-done)
10826 (org-log-repeat org-log-repeat)
10827 (org-todo-log-states org-todo-log-states)
10828 (this (match-string 1))
10829 (hl-pos (match-beginning 0))
10830 (head (org-get-todo-sequence-head this))
10831 (ass (assoc head org-todo-kwd-alist))
10832 (interpret (nth 1 ass))
10833 (done-word (nth 3 ass))
10834 (final-done-word (nth 4 ass))
10835 (last-state (or this ""))
10836 (completion-ignore-case t)
10837 (member (member this org-todo-keywords-1))
10838 (tail (cdr member))
10839 (state (cond
10840 ((and org-todo-key-trigger
10841 (or (and (equal arg '(4))
10842 (eq org-use-fast-todo-selection 'prefix))
10843 (and (not arg) org-use-fast-todo-selection
10844 (not (eq org-use-fast-todo-selection
10845 'prefix)))))
10846 ;; Use fast selection
10847 (org-fast-todo-selection))
10848 ((and (equal arg '(4))
10849 (or (not org-use-fast-todo-selection)
10850 (not org-todo-key-trigger)))
10851 ;; Read a state with completion
10852 (org-icompleting-read
10853 "State: " (mapcar (lambda(x) (list x))
10854 org-todo-keywords-1)
10855 nil t))
10856 ((eq arg 'right)
10857 (if this
10858 (if tail (car tail) nil)
10859 (car org-todo-keywords-1)))
10860 ((eq arg 'left)
10861 (if (equal member org-todo-keywords-1)
10862 nil
10863 (if this
10864 (nth (- (length org-todo-keywords-1)
10865 (length tail) 2)
10866 org-todo-keywords-1)
10867 (org-last org-todo-keywords-1))))
10868 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10869 (setq arg nil))) ; hack to fall back to cycling
10870 (arg
10871 ;; user or caller requests a specific state
10872 (cond
10873 ((equal arg "") nil)
10874 ((eq arg 'none) nil)
10875 ((eq arg 'done) (or done-word (car org-done-keywords)))
10876 ((eq arg 'nextset)
10877 (or (car (cdr (member head org-todo-heads)))
10878 (car org-todo-heads)))
10879 ((eq arg 'previousset)
10880 (let ((org-todo-heads (reverse org-todo-heads)))
10881 (or (car (cdr (member head org-todo-heads)))
10882 (car org-todo-heads))))
10883 ((car (member arg org-todo-keywords-1)))
10884 ((stringp arg)
10885 (error "State `%s' not valid in this file" arg))
10886 ((nth (1- (prefix-numeric-value arg))
10887 org-todo-keywords-1))))
10888 ((null member) (or head (car org-todo-keywords-1)))
10889 ((equal this final-done-word) nil) ;; -> make empty
10890 ((null tail) nil) ;; -> first entry
10891 ((memq interpret '(type priority))
10892 (if (eq this-command last-command)
10893 (car tail)
10894 (if (> (length tail) 0)
10895 (or done-word (car org-done-keywords))
10896 nil)))
10897 (t
10898 (car tail))))
10899 (state (or
10900 (run-hook-with-args-until-success
10901 'org-todo-get-default-hook state last-state)
10902 state))
10903 (next (if state (concat " " state " ") " "))
10904 (change-plist (list :type 'todo-state-change :from this :to state
10905 :position startpos))
10906 dolog now-done-p)
10907 (when org-blocker-hook
10908 (setq org-last-todo-state-is-todo
10909 (not (member this org-done-keywords)))
10910 (unless (save-excursion
10911 (save-match-data
10912 (run-hook-with-args-until-failure
10913 'org-blocker-hook change-plist)))
10914 (if (interactive-p)
10915 (error "TODO state change from %s to %s blocked" this state)
10916 ;; fail silently
10917 (message "TODO state change from %s to %s blocked" this state)
10918 (throw 'exit nil))))
10919 (store-match-data match-data)
10920 (replace-match next t t)
10921 (unless (pos-visible-in-window-p hl-pos)
10922 (message "TODO state changed to %s" (org-trim next)))
10923 (unless head
10924 (setq head (org-get-todo-sequence-head state)
10925 ass (assoc head org-todo-kwd-alist)
10926 interpret (nth 1 ass)
10927 done-word (nth 3 ass)
10928 final-done-word (nth 4 ass)))
10929 (when (memq arg '(nextset previousset))
10930 (message "Keyword-Set %d/%d: %s"
10931 (- (length org-todo-sets) -1
10932 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10933 (length org-todo-sets)
10934 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10935 (setq org-last-todo-state-is-todo
10936 (not (member state org-done-keywords)))
10937 (setq now-done-p (and (member state org-done-keywords)
10938 (not (member this org-done-keywords))))
10939 (and logging (org-local-logging logging))
10940 (when (and (or org-todo-log-states org-log-done)
10941 (not (eq org-inhibit-logging t))
10942 (not (memq arg '(nextset previousset))))
10943 ;; we need to look at recording a time and note
10944 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10945 (nth 2 (assoc this org-todo-log-states))))
10946 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10947 (setq dolog 'time))
10948 (when (and state
10949 (member state org-not-done-keywords)
10950 (not (member this org-not-done-keywords)))
10951 ;; This is now a todo state and was not one before
10952 ;; If there was a CLOSED time stamp, get rid of it.
10953 (org-add-planning-info nil nil 'closed))
10954 (when (and now-done-p org-log-done)
10955 ;; It is now done, and it was not done before
10956 (org-add-planning-info 'closed (org-current-time))
10957 (if (and (not dolog) (eq 'note org-log-done))
10958 (org-add-log-setup 'done state this 'findpos 'note)))
10959 (when (and state dolog)
10960 ;; This is a non-nil state, and we need to log it
10961 (org-add-log-setup 'state state this 'findpos dolog)))
10962 ;; Fixup tag positioning
10963 (org-todo-trigger-tag-changes state)
10964 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10965 (when org-provide-todo-statistics
10966 (org-update-parent-todo-statistics))
10967 (run-hooks 'org-after-todo-state-change-hook)
10968 (if (and arg (not (member state org-done-keywords)))
10969 (setq head (org-get-todo-sequence-head state)))
10970 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10971 ;; Do we need to trigger a repeat?
10972 (when now-done-p
10973 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10974 ;; This is for the agenda, take a snapshot of the headline.
10975 (save-match-data
10976 (setq org-agenda-headline-snapshot-before-repeat
10977 (org-get-heading))))
10978 (org-auto-repeat-maybe state))
10979 ;; Fixup cursor location if close to the keyword
10980 (if (and (outline-on-heading-p)
10981 (not (bolp))
10982 (save-excursion (beginning-of-line 1)
10983 (looking-at org-todo-line-regexp))
10984 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10985 (progn
10986 (goto-char (or (match-end 2) (match-end 1)))
10987 (and (looking-at " ") (just-one-space))))
10988 (when org-trigger-hook
10989 (save-excursion
10990 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10992 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10993 "Block turning an entry into a TODO, using the hierarchy.
10994 This checks whether the current task should be blocked from state
10995 changes. Such blocking occurs when:
10997 1. The task has children which are not all in a completed state.
10999 2. A task has a parent with the property :ORDERED:, and there
11000 are siblings prior to the current task with incomplete
11001 status.
11003 3. The parent of the task is blocked because it has siblings that should
11004 be done first, or is child of a block grandparent TODO entry."
11006 (if (not org-enforce-todo-dependencies)
11007 t ; if locally turned off don't block
11008 (catch 'dont-block
11009 ;; If this is not a todo state change, or if this entry is already DONE,
11010 ;; do not block
11011 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11012 (member (plist-get change-plist :from)
11013 (cons 'done org-done-keywords))
11014 (member (plist-get change-plist :to)
11015 (cons 'todo org-not-done-keywords))
11016 (not (plist-get change-plist :to)))
11017 (throw 'dont-block t))
11018 ;; If this task has children, and any are undone, it's blocked
11019 (save-excursion
11020 (org-back-to-heading t)
11021 (let ((this-level (funcall outline-level)))
11022 (outline-next-heading)
11023 (let ((child-level (funcall outline-level)))
11024 (while (and (not (eobp))
11025 (> child-level this-level))
11026 ;; this todo has children, check whether they are all
11027 ;; completed
11028 (if (and (not (org-entry-is-done-p))
11029 (org-entry-is-todo-p))
11030 (throw 'dont-block nil))
11031 (outline-next-heading)
11032 (setq child-level (funcall outline-level))))))
11033 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11034 ;; any previous siblings are undone, it's blocked
11035 (save-excursion
11036 (org-back-to-heading t)
11037 (let* ((pos (point))
11038 (parent-pos (and (org-up-heading-safe) (point))))
11039 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11040 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11041 (forward-line 1)
11042 (re-search-forward org-not-done-heading-regexp pos t))
11043 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11044 ;; Search further up the hierarchy, to see if an anchestor is blocked
11045 (while t
11046 (goto-char parent-pos)
11047 (if (not (looking-at org-not-done-heading-regexp))
11048 (throw 'dont-block t)) ; do not block, parent is not a TODO
11049 (setq pos (point))
11050 (setq parent-pos (and (org-up-heading-safe) (point)))
11051 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11052 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11053 (forward-line 1)
11054 (re-search-forward org-not-done-heading-regexp pos t))
11055 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11057 (defcustom org-track-ordered-property-with-tag nil
11058 "Should the ORDERED property also be shown as a tag?
11059 The ORDERED property decides if an entry should require subtasks to be
11060 completed in sequence. Since a property is not very visible, setting
11061 this option means that toggling the ORDERED property with the command
11062 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11063 not relevant for the behavior, but it makes things more visible.
11065 Note that toggling the tag with tags commands will not change the property
11066 and therefore not influence behavior!
11068 This can be t, meaning the tag ORDERED should be used, It can also be a
11069 string to select a different tag for this task."
11070 :group 'org-todo
11071 :type '(choice
11072 (const :tag "No tracking" nil)
11073 (const :tag "Track with ORDERED tag" t)
11074 (string :tag "Use other tag")))
11076 (defun org-toggle-ordered-property ()
11077 "Toggle the ORDERED property of the current entry.
11078 For better visibility, you can track the value of this property with a tag.
11079 See variable `org-track-ordered-property-with-tag'."
11080 (interactive)
11081 (let* ((t1 org-track-ordered-property-with-tag)
11082 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11083 (save-excursion
11084 (org-back-to-heading)
11085 (if (org-entry-get nil "ORDERED")
11086 (progn
11087 (org-delete-property "ORDERED")
11088 (and tag (org-toggle-tag tag 'off))
11089 (message "Subtasks can be completed in arbitrary order"))
11090 (org-entry-put nil "ORDERED" "t")
11091 (and tag (org-toggle-tag tag 'on))
11092 (message "Subtasks must be completed in sequence")))))
11094 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11095 (defun org-block-todo-from-checkboxes (change-plist)
11096 "Block turning an entry into a TODO, using checkboxes.
11097 This checks whether the current task should be blocked from state
11098 changes because there are unchecked boxes in this entry."
11099 (if (not org-enforce-todo-checkbox-dependencies)
11100 t ; if locally turned off don't block
11101 (catch 'dont-block
11102 ;; If this is not a todo state change, or if this entry is already DONE,
11103 ;; do not block
11104 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11105 (member (plist-get change-plist :from)
11106 (cons 'done org-done-keywords))
11107 (member (plist-get change-plist :to)
11108 (cons 'todo org-not-done-keywords))
11109 (not (plist-get change-plist :to)))
11110 (throw 'dont-block t))
11111 ;; If this task has checkboxes that are not checked, it's blocked
11112 (save-excursion
11113 (org-back-to-heading t)
11114 (let ((beg (point)) end)
11115 (outline-next-heading)
11116 (setq end (point))
11117 (goto-char beg)
11119 end t)
11120 (progn
11121 (if (boundp 'org-blocked-by-checkboxes)
11122 (setq org-blocked-by-checkboxes t))
11123 (throw 'dont-block nil)))))
11124 t))) ; do not block
11126 (defun org-entry-blocked-p ()
11127 "Is the current entry blocked?"
11128 (if (org-entry-get nil "NOBLOCKING")
11129 nil ;; Never block this entry
11130 (not
11131 (run-hook-with-args-until-failure
11132 'org-blocker-hook
11133 (list :type 'todo-state-change
11134 :position (point)
11135 :from 'todo
11136 :to 'done)))))
11138 (defun org-update-statistics-cookies (all)
11139 "Update the statistics cookie, either from TODO or from checkboxes.
11140 This should be called with the cursor in a line with a statistics cookie."
11141 (interactive "P")
11142 (if all
11143 (progn
11144 (org-update-checkbox-count 'all)
11145 (org-map-entries 'org-update-parent-todo-statistics))
11146 (if (not (org-on-heading-p))
11147 (org-update-checkbox-count)
11148 (let ((pos (move-marker (make-marker) (point)))
11149 end l1 l2)
11150 (ignore-errors (org-back-to-heading t))
11151 (if (not (org-on-heading-p))
11152 (org-update-checkbox-count)
11153 (setq l1 (org-outline-level))
11154 (setq end (save-excursion
11155 (outline-next-heading)
11156 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11157 (point)))
11158 (if (and (save-excursion
11159 (re-search-forward
11161 (not (save-excursion (re-search-forward
11163 (org-update-checkbox-count)
11164 (if (and l2 (> l2 l1))
11165 (progn
11166 (goto-char end)
11167 (org-update-parent-todo-statistics))
11168 (goto-char pos)
11169 (beginning-of-line 1)
11170 (while (re-search-forward
11172 (point-at-eol) t)
11173 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11174 (goto-char pos)
11175 (move-marker pos nil)))))
11177 (defvar org-entry-property-inherited-from) ;; defined below
11178 (defun org-update-parent-todo-statistics ()
11179 "Update any statistics cookie in the parent of the current headline.
11180 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11181 the entire subtree and this will travel up the hierarchy and update
11182 statistics everywhere."
11183 (interactive)
11184 (let* ((lim 0) prop
11185 (recursive (or (not org-hierarchical-todo-statistics)
11186 (string-match
11188 (or (setq prop (org-entry-get
11189 nil "COOKIE_DATA" 'inherit)) ""))))
11190 (lim (or (and prop (marker-position
11191 org-entry-property-inherited-from))
11192 lim))
11193 (first t)
11195 level ltoggle l1 new ndel
11196 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11197 (catch 'exit
11198 (save-excursion
11199 (beginning-of-line 1)
11200 (if (org-at-heading-p)
11201 (setq ltoggle (funcall outline-level))
11202 (error "This should not happen"))
11203 (while (and (setq level (org-up-heading-safe))
11204 (or recursive first)
11205 (>= (point) lim))
11206 (setq first nil cookie-present nil)
11207 (unless (and level
11208 (not (string-match
11210 (downcase
11211 (or (org-entry-get
11212 nil "COOKIE_DATA")
11213 "")))))
11214 (throw 'exit nil))
11215 (while (re-search-forward box-re (point-at-eol) t)
11216 (setq cnt-all 0 cnt-done 0 cookie-present t)
11217 (setq is-percent (match-end 2))
11218 (save-match-data
11219 (unless (outline-next-heading) (throw 'exit nil))
11220 (while (and (looking-at org-complex-heading-regexp)
11221 (> (setq l1 (length (match-string 1))) level))
11222 (setq kwd (and (or recursive (= l1 ltoggle))
11223 (match-string 2)))
11224 (if (or (eq org-provide-todo-statistics 'all-headlines)
11225 (and (listp org-provide-todo-statistics)
11226 (or (member kwd org-provide-todo-statistics)
11227 (member kwd org-done-keywords))))
11228 (setq cnt-all (1+ cnt-all))
11229 (if (eq org-provide-todo-statistics t)
11230 (and kwd (setq cnt-all (1+ cnt-all)))))
11231 (and (member kwd org-done-keywords)
11232 (setq cnt-done (1+ cnt-done)))
11233 (outline-next-heading)))
11234 (setq new
11235 (if is-percent
11236 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11237 (format "[%d/%d]" cnt-done cnt-all))
11238 ndel (- (match-end 0) (match-beginning 0)))
11239 (goto-char (match-beginning 0))
11240 (insert new)
11241 (delete-region (point) (+ (point) ndel)))
11242 (when cookie-present
11243 (run-hook-with-args 'org-after-todo-statistics-hook
11244 cnt-done (- cnt-all cnt-done))))))
11245 (run-hooks 'org-todo-statistics-hook)))
11247 (defvar org-after-todo-statistics-hook nil
11248 "Hook that is called after a TODO statistics cookie has been updated.
11249 Each function is called with two arguments: the number of not-done entries
11250 and the number of done entries.
11252 For example, the following function, when added to this hook, will switch
11253 an entry to DONE when all children are done, and back to TODO when new
11254 entries are set to a TODO status. Note that this hook is only called
11255 when there is a statistics cookie in the headline!
11257 (defun org-summary-todo (n-done n-not-done)
11259 (let (org-log-done org-log-states) ; turn off logging
11261 ")
11263 (defvar org-todo-statistics-hook nil
11264 "Hook that is run whenever Org thinks TODO statistics should be updated.
11265 This hook runs even if there is no statistics cookie present, in which case
11266 `org-after-todo-statistics-hook' would not run.")
11268 (defun org-todo-trigger-tag-changes (state)
11269 "Apply the changes defined in `org-todo-state-tags-triggers'."
11270 (let ((l org-todo-state-tags-triggers)
11271 changes)
11272 (when (or (not state) (equal state ""))
11273 (setq changes (append changes (cdr (assoc "" l)))))
11274 (when (and (stringp state) (> (length state) 0))
11275 (setq changes (append changes (cdr (assoc state l)))))
11276 (when (member state org-not-done-keywords)
11277 (setq changes (append changes (cdr (assoc 'todo l)))))
11278 (when (member state org-done-keywords)
11279 (setq changes (append changes (cdr (assoc 'done l)))))
11280 (dolist (c changes)
11281 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11283 (defun org-local-logging (value)
11284 "Get logging settings from a property VALUE."
11285 (let* (words w a)
11286 ;; directly set the variables, they are already local.
11287 (setq org-log-done nil
11288 org-log-repeat nil
11289 org-todo-log-states nil)
11290 (setq words (org-split-string value))
11291 (while (setq w (pop words))
11292 (cond
11293 ((setq a (assoc w org-startup-options))
11294 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11295 (set (nth 1 a) (nth 2 a))))
11296 ((setq a (org-extract-log-state-settings w))
11297 (and (member (car a) org-todo-keywords-1)
11298 (push a org-todo-log-states)))))))
11300 (defun org-get-todo-sequence-head (kwd)
11301 "Return the head of the TODO sequence to which KWD belongs.
11302 If KWD is not set, check if there is a text property remembering the
11303 right sequence."
11304 (let (p)
11305 (cond
11306 ((not kwd)
11307 (or (get-text-property (point-at-bol) 'org-todo-head)
11308 (progn
11309 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11310 nil (point-at-eol)))
11311 (get-text-property p 'org-todo-head))))
11312 ((not (member kwd org-todo-keywords-1))
11313 (car org-todo-keywords-1))
11314 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11316 (defun org-fast-todo-selection ()
11317 "Fast TODO keyword selection with single keys.
11318 Returns the new TODO keyword, or nil if no state change should occur."
11319 (let* ((fulltable org-todo-key-alist)
11320 (done-keywords org-done-keywords) ;; needed for the faces.
11321 (maxlen (apply 'max (mapcar
11322 (lambda (x)
11323 (if (stringp (car x)) (string-width (car x)) 0))
11324 fulltable)))
11325 (expert nil)
11326 (fwidth (+ maxlen 3 1 3))
11327 (ncol (/ (- (window-width) 4) fwidth))
11328 tg cnt e c tbl
11329 groups ingroup)
11330 (save-excursion
11331 (save-window-excursion
11332 (if expert
11333 (set-buffer (get-buffer-create " *Org todo*"))
11334 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11335 (erase-buffer)
11336 (org-set-local 'org-done-keywords done-keywords)
11337 (setq tbl fulltable cnt 0)
11338 (while (setq e (pop tbl))
11339 (cond
11340 ((equal e '(:startgroup))
11341 (push '() groups) (setq ingroup t)
11342 (when (not (= cnt 0))
11343 (setq cnt 0)
11345 (insert "{ "))
11346 ((equal e '(:endgroup))
11347 (setq ingroup nil cnt 0)
11349 ((equal e '(:newline))
11350 (when (not (= cnt 0))
11351 (setq cnt 0)
11353 (setq e (car tbl))
11354 (while (equal (car tbl) '(:newline))
11356 (setq tbl (cdr tbl)))))
11357 (t
11358 (setq tg (car e) c (cdr e))
11359 (if ingroup (push tg (car groups)))
11360 (setq tg (org-add-props tg nil 'face
11361 (org-get-todo-face tg)))
11362 (if (and (= cnt 0) (not ingroup)) (insert " "))
11363 (insert "[" c "] " tg (make-string
11364 (- fwidth 4 (length tg)) ?\ ))
11365 (when (= (setq cnt (1+ cnt)) ncol)
11367 (if ingroup (insert " "))
11368 (setq cnt 0)))))
11370 (goto-char (point-min))
11371 (if (not expert) (org-fit-window-to-buffer))
11372 (message "[a-z..]:Set [SPC]:clear")
11373 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11374 (cond
11375 ((or (= c ?\C-g)
11376 (and (= c ?q) (not (rassoc c fulltable))))
11377 (setq quit-flag t))
11378 ((= c ?\ ) nil)
11379 ((setq e (rassoc c fulltable) tg (car e))
11380 tg)
11381 (t (setq quit-flag t)))))))
11383 (defun org-entry-is-todo-p ()
11384 (member (org-get-todo-state) org-not-done-keywords))
11386 (defun org-entry-is-done-p ()
11387 (member (org-get-todo-state) org-done-keywords))
11389 (defun org-get-todo-state ()
11390 (save-excursion
11391 (org-back-to-heading t)
11392 (and (looking-at org-todo-line-regexp)
11393 (match-end 2)
11394 (match-string 2))))
11396 (defun org-at-date-range-p (&optional inactive-ok)
11397 "Is the cursor inside a date range?"
11398 (interactive)
11399 (save-excursion
11400 (catch 'exit
11401 (let ((pos (point)))
11403 (skip-chars-backward "<[")
11404 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11405 (>= (match-end 0) pos)
11406 (throw 'exit t))
11408 (skip-chars-backward "<[")
11409 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11410 (>= (match-end 0) pos)
11411 (throw 'exit t)))
11412 nil)))
11414 (defun org-get-repeat (&optional tagline)
11415 "Check if there is a deadline/schedule with repeater in this entry."
11416 (save-match-data
11417 (save-excursion
11418 (org-back-to-heading t)
11419 (and (re-search-forward (if tagline
11421 org-repeat-re)
11422 (org-entry-end-position) t)
11423 (match-string-no-properties 1)))))
11425 (defvar org-last-changed-timestamp)
11426 (defvar org-last-inserted-timestamp)
11427 (defvar org-log-post-message)
11428 (defvar org-log-note-purpose)
11429 (defvar org-log-note-how)
11430 (defvar org-log-note-extra)
11431 (defun org-auto-repeat-maybe (done-word)
11432 "Check if the current headline contains a repeated deadline/schedule.
11433 If yes, set TODO state back to what it was and change the base date
11434 of repeating deadline/scheduled time stamps to new date.
11435 This function is run automatically after each state change to a DONE state."
11436 ;; last-state is dynamically scoped into this function
11437 (let* ((repeat (org-get-repeat))
11438 (aa (assoc last-state org-todo-kwd-alist))
11439 (interpret (nth 1 aa))
11440 (head (nth 2 aa))
11441 (whata '(("d" . day) ("m" . month) ("y" . year)))
11442 (msg "Entry repeats: ")
11443 (org-log-done nil)
11444 (org-todo-log-states nil)
11445 re type n what ts time to-state)
11446 (when repeat
11447 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11448 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11449 org-todo-repeat-to-state))
11450 (unless (and to-state (member to-state org-todo-keywords-1))
11451 (setq to-state (if (eq interpret 'type) last-state head)))
11452 (org-todo to-state)
11453 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11454 (org-entry-put nil "LAST_REPEAT" (format-time-string
11455 (org-time-stamp-format t t))))
11456 (when org-log-repeat
11457 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11458 (memq 'org-add-log-note post-command-hook))
11459 ;; OK, we are already setup for some record
11460 (if (eq org-log-repeat 'note)
11461 ;; make sure we take a note, not only a time stamp
11462 (setq org-log-note-how 'note))
11463 ;; Set up for taking a record
11464 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11465 last-state
11466 'findpos org-log-repeat)))
11467 (org-back-to-heading t)
11468 (org-add-planning-info nil nil 'closed)
11472 (while (re-search-forward
11473 re (save-excursion (outline-next-heading) (point)) t)
11474 (setq type (if (match-end 1) org-scheduled-string
11475 (if (match-end 3) org-deadline-string "Plain:"))
11476 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11478 (setq n (string-to-number (match-string 2 ts))
11479 what (match-string 3 ts))
11480 (if (equal what "w") (setq n (* n 7) what "d"))
11481 ;; Preparation, see if we need to modify the start date for the change
11482 (when (match-end 1)
11483 (setq time (save-match-data (org-time-string-to-time ts)))
11484 (cond
11485 ((equal (match-string 1 ts) ".")
11486 ;; Shift starting date to today
11487 (org-timestamp-change
11488 (- (time-to-days (current-time)) (time-to-days time))
11489 'day))
11490 ((equal (match-string 1 ts) "+")
11491 (let ((nshiftmax 10) (nshift 0))
11492 (while (or (= nshift 0)
11493 (<= (time-to-days time)
11494 (time-to-days (current-time))))
11495 (when (= (incf nshift) nshiftmax)
11496 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11497 (error "Abort")))
11498 (org-timestamp-change n (cdr (assoc what whata)))
11499 (org-at-timestamp-p t)
11500 (setq ts (match-string 1))
11501 (setq time (save-match-data (org-time-string-to-time ts)))))
11502 (org-timestamp-change (- n) (cdr (assoc what whata)))
11503 ;; rematch, so that we have everything in place for the real shift
11504 (org-at-timestamp-p t)
11505 (setq ts (match-string 1))
11507 (org-timestamp-change n (cdr (assoc what whata)))
11508 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11509 (setq org-log-post-message msg)
11510 (message "%s" msg))))
11512 (defun org-show-todo-tree (arg)
11513 "Make a compact tree which shows all headlines marked with TODO.
11514 The tree will show the lines where the regexp matches, and all higher
11515 headlines above the match.
11517 With a numeric prefix N, construct a sparse tree for the Nth element
11518 of `org-todo-keywords-1'."
11519 (interactive "P")
11520 (let ((case-fold-search nil)
11521 (kwd-re
11522 (cond ((null arg) org-not-done-regexp)
11523 ((equal arg '(4))
11524 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11525 (mapcar 'list org-todo-keywords-1))))
11529 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11530 (regexp-quote (nth (1- (prefix-numeric-value arg))
11531 org-todo-keywords-1)))
11532 (t (error "Invalid prefix argument: %s" arg)))))
11533 (message "%d TODO entries found"
11534 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11536 (defun org-deadline (&optional remove time)
11538 With argument REMOVE, remove any deadline from the item.
11539 When TIME is set, it should be an internal time specification, and the
11540 scheduling will use the corresponding date."
11541 (interactive "P")
11542 (let* ((old-date (org-entry-get nil "DEADLINE"))
11543 (repeater (and old-date
11545 (match-string 1 old-date))))
11546 (if remove
11547 (progn
11548 (when (and old-date org-log-redeadline)
11549 (org-add-log-setup 'deldeadline nil old-date 'findpos
11550 org-log-redeadline))
11551 (org-remove-timestamp-with-keyword org-deadline-string)
11552 (message "Item no longer has a deadline."))
11553 (org-add-planning-info 'deadline time 'closed)
11554 (when (and old-date org-log-redeadline
11555 (not (equal old-date
11556 (substring org-last-inserted-timestamp 1 -1))))
11557 (org-add-log-setup 'redeadline nil old-date 'findpos
11558 org-log-redeadline))
11559 (when repeater
11560 (save-excursion
11561 (org-back-to-heading t)
11562 (when (re-search-forward (concat org-deadline-string " "
11563 org-last-inserted-timestamp)
11564 (save-excursion
11565 (outline-next-heading) (point)) t)
11566 (goto-char (1- (match-end 0)))
11567 (insert " " repeater)
11568 (setq org-last-inserted-timestamp
11569 (concat (substring org-last-inserted-timestamp 0 -1)
11570 " " repeater
11571 (substring org-last-inserted-timestamp -1))))))
11572 (message "Deadline on %s" org-last-inserted-timestamp))))
11574 (defun org-schedule (&optional remove time)
11575 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11576 With argument REMOVE, remove any scheduling date from the item.
11577 When TIME is set, it should be an internal time specification, and the
11578 scheduling will use the corresponding date."
11579 (interactive "P")
11580 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11581 (repeater (and old-date
11583 (match-string 1 old-date))))
11584 (if remove
11585 (progn
11586 (when (and old-date org-log-reschedule)
11587 (org-add-log-setup 'delschedule nil old-date 'findpos
11588 org-log-reschedule))
11589 (org-remove-timestamp-with-keyword org-scheduled-string)
11590 (message "Item is no longer scheduled."))
11591 (org-add-planning-info 'scheduled time 'closed)
11592 (when (and old-date org-log-reschedule
11593 (not (equal old-date
11594 (substring org-last-inserted-timestamp 1 -1))))
11595 (org-add-log-setup 'reschedule nil old-date 'findpos
11596 org-log-reschedule))
11597 (when repeater
11598 (save-excursion
11599 (org-back-to-heading t)
11600 (when (re-search-forward (concat org-scheduled-string " "
11601 org-last-inserted-timestamp)
11602 (save-excursion
11603 (outline-next-heading) (point)) t)
11604 (goto-char (1- (match-end 0)))
11605 (insert " " repeater)
11606 (setq org-last-inserted-timestamp
11607 (concat (substring org-last-inserted-timestamp 0 -1)
11608 " " repeater
11609 (substring org-last-inserted-timestamp -1))))))
11610 (message "Scheduled to %s" org-last-inserted-timestamp))))
11612 (defun org-get-scheduled-time (pom &optional inherit)
11613 "Get the scheduled time as a time tuple, of a format suitable
11614 for calling org-schedule with, or if there is no scheduling,
11615 returns nil."
11616 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11617 (when time
11618 (apply 'encode-time (org-parse-time-string time)))))
11620 (defun org-get-deadline-time (pom &optional inherit)
11621 "Get the deadline as a time tuple, of a format suitable for
11622 calling org-deadline with, or if there is no scheduling, returns
11623 nil."
11624 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11625 (when time
11626 (apply 'encode-time (org-parse-time-string time)))))
11628 (defun org-remove-timestamp-with-keyword (keyword)
11629 "Remove all time stamps with KEYWORD in the current entry."
11631 beg)
11632 (save-excursion
11633 (org-back-to-heading t)
11634 (setq beg (point))
11635 (outline-next-heading)
11636 (while (re-search-backward re beg t)
11637 (replace-match "")
11639 (equal (char-before) ?\ ))
11640 (backward-delete-char 1)
11642 (point-at-bol) (point-at-eol)))
11643 (delete-region (point-at-bol)
11644 (min (point-max) (1+ (point-at-eol))))))))))
11646 (defun org-add-planning-info (what &optional time &rest remove)
11647 "Insert new timestamp with keyword in the line directly after the headline.
11648 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11649 If non is given, the user is prompted for a date.
11650 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11651 be removed."
11652 (interactive)
11653 (let (org-time-was-given org-end-time-was-given ts
11654 end default-time default-input)
11656 (catch 'exit
11657 (when (and (not time) (memq what '(scheduled deadline)))
11658 ;; Try to get a default date/time from existing timestamp
11659 (save-excursion
11660 (org-back-to-heading t)
11661 (setq end (save-excursion (outline-next-heading) (point)))
11662 (when (re-search-forward (if (eq what 'scheduled)
11663 org-scheduled-time-regexp
11664 org-deadline-time-regexp)
11665 end t)
11666 (setq ts (match-string 1)
11667 default-time
11668 (apply 'encode-time (org-parse-time-string ts))
11669 default-input (and ts (org-get-compact-tod ts))))))
11670 (when what
11671 ;; If necessary, get the time from the user
11672 (setq time (or time (org-read-date nil 'to-time nil nil
11673 default-time default-input))))
11675 (when (and org-insert-labeled-timestamps-at-point
11676 (member what '(scheduled deadline)))
11677 (insert
11678 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11679 (org-insert-time-stamp time org-time-was-given
11680 nil nil nil (list org-end-time-was-given))
11681 (setq what nil))
11682 (save-excursion
11683 (save-restriction
11684 (let (col list elt ts buffer-invisibility-spec)
11685 (org-back-to-heading t)
11687 (goto-char (match-end 1))
11688 (setq col (current-column))
11689 (goto-char (match-end 0))
11691 (when (and (not what)
11692 (not (looking-at
11694 org-keyword-time-not-clock-regexp))))
11695 ;; Nothing to add, nothing to remove...... :-)
11696 (throw 'exit nil))
11697 (if (and (not (looking-at outline-regexp))
11700 (not (equal (match-string 1) org-clock-string)))
11701 (narrow-to-region (match-beginning 0) (match-end 0))
11703 (backward-char 1)
11704 (narrow-to-region (point) (point))
11705 (and org-adapt-indentation (org-indent-to-column col)))
11706 ;; Check if we have to remove something.
11707 (setq list (cons what remove))
11708 (while list
11709 (setq elt (pop list))
11710 (goto-char (point-min))
11711 (when (or (and (eq elt 'scheduled)
11712 (re-search-forward org-scheduled-time-regexp nil t))
11713 (and (eq elt 'deadline)
11714 (re-search-forward org-deadline-time-regexp nil t))
11715 (and (eq elt 'closed)
11716 (re-search-forward org-closed-time-regexp nil t)))
11717 (replace-match "")
11718 (if (looking-at "--+<[^>]+>") (replace-match ""))
11719 (skip-chars-backward " ")
11720 (if (looking-at " +") (replace-match ""))))
11721 (goto-char (point-max))
11722 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11723 (when what
11724 (insert
11725 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11726 (cond ((eq what 'scheduled) org-scheduled-string)
11727 ((eq what 'deadline) org-deadline-string)
11728 ((eq what 'closed) org-closed-string))
11729 " ")
11730 (setq ts (org-insert-time-stamp
11731 time
11732 (or org-time-was-given
11733 (and (eq what 'closed) org-log-done-with-time))
11734 (eq what 'closed)
11735 nil nil (list org-end-time-was-given)))
11736 (end-of-line 1))
11737 (goto-char (point-min))
11738 (widen)
11741 (delete-region (1- (point)) (point-at-eol)))
11742 ts))))))
11744 (defvar org-log-note-marker (make-marker))
11745 (defvar org-log-note-purpose nil)
11746 (defvar org-log-note-state nil)
11747 (defvar org-log-note-previous-state nil)
11748 (defvar org-log-note-how nil)
11749 (defvar org-log-note-extra nil)
11750 (defvar org-log-note-window-configuration nil)
11751 (defvar org-log-note-return-to (make-marker))
11752 (defvar org-log-post-message nil
11753 "Message to be displayed after a log note has been stored.
11754 The auto-repeater uses this.")
11756 (defun org-add-note ()
11757 "Add a note to the current entry.
11758 This is done in the same way as adding a state change note."
11759 (interactive)
11760 (org-add-log-setup 'note nil nil 'findpos nil))
11762 (defvar org-property-end-re)
11763 (defun org-add-log-setup (&optional purpose state prev-state
11764 findpos how extra)
11765 "Set up the post command hook to take a note.
11766 If this is about to TODO state change, the new state is expected in STATE.
11767 When FINDPOS is non-nil, find the correct position for the note in
11768 the current entry. If not, assume that it can be inserted at point.
11769 HOW is an indicator what kind of note should be created.
11770 EXTRA is additional text that will be inserted into the notes buffer."
11771 (let* ((org-log-into-drawer (org-log-into-drawer))
11772 (drawer (cond ((stringp org-log-into-drawer)
11773 org-log-into-drawer)
11774 (org-log-into-drawer "LOGBOOK")
11775 (t nil))))
11776 (save-restriction
11777 (save-excursion
11778 (when findpos
11779 (org-back-to-heading t)
11780 (narrow-to-region (point) (save-excursion
11781 (outline-next-heading) (point)))
11785 (goto-char (match-end 0))
11786 (cond
11787 (drawer
11789 nil t)
11790 (progn
11791 (goto-char (match-end 0))
11792 (or org-log-states-order-reversed
11793 (and (re-search-forward org-property-end-re nil t)
11794 (goto-char (1- (match-beginning 0))))))
11796 (beginning-of-line 0)
11797 (org-indent-line-function)
11798 (beginning-of-line 2)
11799 (org-indent-line-function)
11800 (end-of-line 0)))
11801 ((and org-log-state-notes-insert-after-drawers
11802 (save-excursion
11803 (forward-line) (looking-at org-drawer-regexp)))
11804 (forward-line)
11805 (while (looking-at org-drawer-regexp)
11806 (goto-char (match-end 0))
11807 (re-search-forward org-property-end-re (point-max) t)
11808 (forward-line))
11809 (forward-line -1)))
11810 (unless org-log-states-order-reversed
11812 (org-skip-over-state-notes)
11814 (move-marker org-log-note-marker (point))
11815 (setq org-log-note-purpose purpose
11816 org-log-note-state state
11817 org-log-note-previous-state prev-state
11818 org-log-note-how how
11819 org-log-note-extra extra)
11820 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11822 (defun org-skip-over-state-notes ()
11823 "Skip past the list of State notes in an entry."
11825 (when (org-in-item-p)
11826 (let ((limit (org-list-bottom-point)))
11828 (goto-char (or (org-get-next-item (point) limit)
11829 (org-get-end-of-item limit)))))))
11831 (defun org-add-log-note (&optional purpose)
11832 "Pop up a window for taking a note, and add this note later at point."
11833 (remove-hook 'post-command-hook 'org-add-log-note)
11834 (setq org-log-note-window-configuration (current-window-configuration))
11835 (delete-other-windows)
11836 (move-marker org-log-note-return-to (point))
11837 (switch-to-buffer (marker-buffer org-log-note-marker))
11838 (goto-char org-log-note-marker)
11839 (org-switch-to-buffer-other-window "*Org Note*")
11840 (erase-buffer)
11841 (if (memq org-log-note-how '(time state))
11842 (let (current-prefix-arg) (org-store-log-note))
11843 (let ((org-inhibit-startup t)) (org-mode))
11844 (insert (format "# Insert note for %s.
11846 (cond
11847 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11848 ((eq org-log-note-purpose 'done) "closed todo item")
11849 ((eq org-log-note-purpose 'state)
11851 (or org-log-note-previous-state "")
11852 (or org-log-note-state "")))
11853 ((eq org-log-note-purpose 'reschedule)
11854 "rescheduling")
11855 ((eq org-log-note-purpose 'delschedule)
11856 "no longer scheduled")
11857 ((eq org-log-note-purpose 'redeadline)
11858 "changing deadline")
11859 ((eq org-log-note-purpose 'deldeadline)
11860 "removing deadline")
11861 ((eq org-log-note-purpose 'refile)
11862 "refiling")
11863 ((eq org-log-note-purpose 'note)
11864 "this entry")
11865 (t (error "This should not happen")))))
11866 (if org-log-note-extra (insert org-log-note-extra))
11867 (org-set-local 'org-finish-function 'org-store-log-note)))
11869 (defvar org-note-abort nil) ; dynamically scoped
11870 (defun org-store-log-note ()
11871 "Finish taking a log note, and insert it to where it belongs."
11872 (let ((txt (buffer-string))
11873 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11874 lines ind bul)
11875 (kill-buffer (current-buffer))
11877 (setq txt (replace-match "" t t txt)))
11879 (setq txt (replace-match "" t t txt)))
11882 (setq note
11883 (org-replace-escapes
11884 note
11885 (list (cons "%u" (user-login-name))
11886 (cons "%U" user-full-name)
11887 (cons "%t" (format-time-string
11888 (org-time-stamp-format 'long 'inactive)
11889 (current-time)))
11890 (cons "%T" (format-time-string
11891 (org-time-stamp-format 'long nil)
11892 (current-time)))
11893 (cons "%s" (if org-log-note-state
11895 ""))
11896 (cons "%S" (if org-log-note-previous-state
11900 (push note lines))
11901 (when (or current-prefix-arg org-note-abort)
11902 (when org-log-into-drawer
11903 (org-remove-empty-drawer-at
11904 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11905 org-log-note-marker))
11906 (setq lines nil))
11907 (when lines
11908 (with-current-buffer (marker-buffer org-log-note-marker)
11909 (save-excursion
11910 (goto-char org-log-note-marker)
11911 (move-marker org-log-note-marker nil)
11912 (end-of-line 1)
11914 (setq ind (save-excursion
11915 (if (org-in-item-p)
11916 (progn
11917 (goto-char (org-list-top-point))
11918 (org-get-indentation))
11920 (cond
11921 ((and (org-at-heading-p)
11922 org-adapt-indentation)
11923 (1+ (org-current-level)))
11924 ((org-at-heading-p) 0)
11925 (t (org-get-indentation))))))
11926 (setq bul (org-list-bullet-string "-"))
11927 (org-indent-line-to ind)
11928 (insert bul (pop lines))
11929 (let ((ind-body (+ (length bul) ind)))
11930 (while lines
11932 (org-indent-line-to ind-body)
11933 (insert (pop lines))))
11934 (message "Note stored")
11935 (org-back-to-heading t)
11936 (org-cycle-hide-drawers 'children)))))
11937 (set-window-configuration org-log-note-window-configuration)
11938 (with-current-buffer (marker-buffer org-log-note-return-to)
11939 (goto-char org-log-note-return-to))
11940 (move-marker org-log-note-return-to nil)
11941 (and org-log-post-message (message "%s" org-log-post-message)))
11943 (defun org-remove-empty-drawer-at (drawer pos)
11944 "Remove an empty drawer DRAWER at position POS.
11945 POS may also be a marker."
11946 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11947 (save-excursion
11948 (save-restriction
11949 (widen)
11950 (goto-char pos)
11951 (if (org-in-regexp
11953 (replace-match ""))))))
11955 (defun org-sparse-tree (&optional arg)
11956 "Create a sparse tree, prompt for the details.
11957 This command can create sparse trees. You first need to select the type
11958 of match used to create the tree:
11960 t Show all TODO entries.
11961 T Show entries with a specific TODO keyword.
11962 m Show entries selected by a tags/property match.
11963 p Enter a property name and its value (both with completion on existing
11964 names/values) and show entries with that property.
11965 / Show entries matching a regular expression (`r' can be used as well)
11966 d Show deadlines due within `org-deadline-warning-days'.
11967 b Show deadlines and scheduled items before a date.
11968 a Show deadlines and scheduled items after a date."
11969 (interactive "P")
11970 (let (ans kwd value)
11971 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11972 (setq ans (read-char-exclusive))
11973 (cond
11974 ((equal ans ?d)
11975 (call-interactively 'org-check-deadlines))
11976 ((equal ans ?b)
11977 (call-interactively 'org-check-before-date))
11978 ((equal ans ?a)
11979 (call-interactively 'org-check-after-date))
11980 ((equal ans ?t)
11981 (org-show-todo-tree nil))
11982 ((equal ans ?T)
11983 (org-show-todo-tree '(4)))
11984 ((member ans '(?T ?m))
11985 (call-interactively 'org-match-sparse-tree))
11986 ((member ans '(?p ?P))
11987 (setq kwd (org-icompleting-read "Property: "
11988 (mapcar 'list (org-buffer-property-keys))))
11989 (setq value (org-icompleting-read "Value: "
11990 (mapcar 'list (org-property-values kwd))))
11993 (org-match-sparse-tree arg (concat kwd "=" value)))
11994 ((member ans '(?r ?R ?/))
11995 (call-interactively 'org-occur))
11998 (defvar org-occur-highlights nil
11999 "List of overlays used for occur matches.")
12000 (make-variable-buffer-local 'org-occur-highlights)
12001 (defvar org-occur-parameters nil
12002 "Parameters of the active org-occur calls.
12003 This is a list, each call to org-occur pushes as cons cell,
12004 containing the regular expression and the callback, onto the list.
12005 The list can contain several entries if `org-occur' has been called
12006 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12007 will only contain one set of parameters. When the highlights are
12008 removed (for example with `C-c C-c', or with the next edit (depending
12009 on `org-remove-highlights-with-change'), this variable is emptied
12010 as well.")
12011 (make-variable-buffer-local 'org-occur-parameters)
12013 (defun org-occur (regexp &optional keep-previous callback)
12014 "Make a compact tree which shows all matches of REGEXP.
12015 The tree will show the lines where the regexp matches, and all higher
12016 headlines above the match. It will also show the heading after the match,
12017 to make sure editing the matching entry is easy.
12018 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12019 call to `org-occur' will be kept, to allow stacking of calls to this
12020 command.
12021 If CALLBACK is non-nil, it is a function which is called to confirm
12022 that the match should indeed be shown."
12024 (when (equal regexp "")
12025 (error "Regexp cannot be empty"))
12026 (unless keep-previous
12027 (org-remove-occur-highlights nil nil t))
12028 (push (cons regexp callback) org-occur-parameters)
12029 (let ((cnt 0))
12030 (save-excursion
12031 (goto-char (point-min))
12032 (if (or (not keep-previous) ; do not want to keep
12033 (not org-occur-highlights)) ; no previous matches
12034 ;; hide everything
12035 (org-overview))
12036 (while (re-search-forward regexp nil t)
12037 (when (or (not callback)
12038 (save-match-data (funcall callback)))
12039 (setq cnt (1+ cnt))
12040 (when org-highlight-sparse-tree-matches
12041 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12042 (org-show-context 'occur-tree))))
12043 (when org-remove-highlights-with-change
12044 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12045 nil 'local))
12046 (unless org-sparse-tree-open-archived-trees
12047 (org-hide-archived-subtrees (point-min) (point-max)))
12048 (run-hooks 'org-occur-hook)
12049 (if (interactive-p)
12050 (message "%d match(es) for regexp %s" cnt regexp))
12051 cnt))
12053 (defun org-show-context (&optional key)
12054 "Make sure point and context are visible.
12055 How much context is shown depends upon the variables
12056 `org-show-hierarchy-above', `org-show-following-heading'. and
12057 `org-show-siblings'."
12058 (let ((heading-p (org-on-heading-p t))
12059 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12060 (following-p (org-get-alist-option org-show-following-heading key))
12061 (entry-p (org-get-alist-option org-show-entry-below key))
12062 (siblings-p (org-get-alist-option org-show-siblings key)))
12063 (catch 'exit
12064 ;; Show heading or entry text
12065 (if (and heading-p (not entry-p))
12066 (org-flag-heading nil) ; only show the heading
12067 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12068 (org-show-hidden-entry))) ; show entire entry
12069 (when following-p
12070 ;; Show next sibling, or heading below text
12071 (save-excursion
12072 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12073 (org-flag-heading nil))))
12074 (when siblings-p (org-show-siblings))
12075 (when hierarchy-p
12076 ;; show all higher headings, possibly with siblings
12077 (save-excursion
12078 (while (and (condition-case nil
12079 (progn (org-up-heading-all 1) t)
12080 (error nil))
12081 (not (bobp)))
12082 (org-flag-heading nil)
12083 (when siblings-p (org-show-siblings))))))))
12085 (defvar org-reveal-start-hook nil
12086 "Hook run before revealing a location.")
12088 (defun org-reveal (&optional siblings)
12089 "Show current entry, hierarchy above it, and the following headline.
12090 This can be used to show a consistent set of context around locations
12091 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12092 not t for the search context.
12094 With optional argument SIBLINGS, on each level of the hierarchy all
12095 siblings are shown. This repairs the tree structure to what it would
12096 look like when opened with hierarchical calls to `org-cycle'.
12098 go to the parent and show the
12099 entire tree."
12100 (interactive "P")
12101 (run-hooks 'org-reveal-start-hook)
12102 (let ((org-show-hierarchy-above t)
12103 (org-show-following-heading t)
12104 (org-show-siblings (if siblings t org-show-siblings)))
12105 (org-show-context nil))
12106 (when (equal siblings '(16))
12107 (save-excursion
12108 (when (org-up-heading-safe)
12109 (org-show-subtree)
12110 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12112 (defun org-highlight-new-match (beg end)
12113 "Highlight from BEG to END and mark the highlight is an occur headline."
12114 (let ((ov (make-overlay beg end)))
12115 (overlay-put ov 'face 'secondary-selection)
12116 (push ov org-occur-highlights)))
12118 (defun org-remove-occur-highlights (&optional beg end noremove)
12119 "Remove the occur highlights from the buffer.
12120 BEG and END are ignored. If NOREMOVE is nil, remove this function
12121 from the `before-change-functions' in the current buffer."
12122 (interactive)
12123 (unless org-inhibit-highlight-removal
12124 (mapc 'delete-overlay org-occur-highlights)
12125 (setq org-occur-highlights nil)
12126 (setq org-occur-parameters nil)
12127 (unless noremove
12128 (remove-hook 'before-change-functions
12129 'org-remove-occur-highlights 'local))))
12131 ;;;; Priorities
12134 "Regular expression matching the priority indicator.")
12136 (defvar org-remove-priority-next-time nil)
12138 (defun org-priority-up ()
12139 "Increase the priority of the current item."
12140 (interactive)
12141 (org-priority 'up))
12143 (defun org-priority-down ()
12144 "Decrease the priority of the current item."
12145 (interactive)
12146 (org-priority 'down))
12148 (defun org-priority (&optional action)
12149 "Change the priority of an item by ARG.
12150 ACTION can be `set', `up', `down', or a character."
12151 (interactive)
12152 (unless org-enable-priority-commands
12153 (error "Priority commands are disabled"))
12154 (setq action (or action 'set))
12155 (let (current new news have remove)
12156 (save-excursion
12157 (org-back-to-heading t)
12158 (if (looking-at org-priority-regexp)
12159 (setq current (string-to-char (match-string 2))
12160 have t)
12161 (setq current org-default-priority))
12162 (cond
12163 ((eq action 'remove)
12164 (setq remove t new ?\ ))
12165 ((or (eq action 'set)
12166 (if (featurep 'xemacs) (characterp action) (integerp action)))
12167 (if (not (eq action 'set))
12168 (setq new action)
12169 (message "Priority %c-%c, SPC to remove: "
12170 org-highest-priority org-lowest-priority)
12171 (save-match-data
12172 (setq new (read-char-exclusive))))
12173 (if (and (= (upcase org-highest-priority) org-highest-priority)
12174 (= (upcase org-lowest-priority) org-lowest-priority))
12175 (setq new (upcase new)))
12176 (cond ((equal new ?\ ) (setq remove t))
12177 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12178 (error "Priority must be between `%c' and `%c'"
12179 org-highest-priority org-lowest-priority))))
12180 ((eq action 'up)
12181 (if (and (not have) (eq last-command this-command))
12182 (setq new org-lowest-priority)
12183 (setq new (if (and org-priority-start-cycle-with-default (not have))
12184 org-default-priority (1- current)))))
12185 ((eq action 'down)
12186 (if (and (not have) (eq last-command this-command))
12187 (setq new org-highest-priority)
12188 (setq new (if (and org-priority-start-cycle-with-default (not have))
12189 org-default-priority (1+ current)))))
12190 (t (error "Invalid action")))
12191 (if (or (< (upcase new) org-highest-priority)
12192 (> (upcase new) org-lowest-priority))
12193 (setq remove t))
12194 (setq news (format "%c" new))
12195 (if have
12196 (if remove
12197 (replace-match "" t t nil 1)
12198 (replace-match news t t nil 2))
12199 (if remove
12200 (error "No priority cookie found in line")
12201 (let ((case-fold-search nil))
12202 (looking-at org-todo-line-regexp))
12203 (if (match-end 2)
12204 (progn
12205 (goto-char (match-end 2))
12206 (insert " [#" news "]"))
12207 (goto-char (match-beginning 3))
12208 (insert "[#" news "] "))))
12209 (org-preserve-lc (org-set-tags nil 'align)))
12210 (if remove
12211 (message "Priority removed")
12212 (message "Priority of current item set to %s" news))))
12214 (defun org-get-priority (s)
12215 "Find priority cookie and return priority."
12216 (save-match-data
12217 (if (not (string-match org-priority-regexp s))
12218 (* 1000 (- org-lowest-priority org-default-priority))
12219 (* 1000 (- org-lowest-priority
12220 (string-to-char (match-string 2 s)))))))
12222 ;;;; Tags
12224 (defvar org-agenda-archives-mode)
12225 (defvar org-map-continue-from nil
12226 "Position from where mapping should continue.
12227 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12229 (defvar org-scanner-tags nil
12230 "The current tag list while the tags scanner is running.")
12231 (defvar org-trust-scanner-tags nil
12232 "Should `org-get-tags-at' use the tags fro the scanner.
12233 This is for internal dynamical scoping only.
12234 When this is non-nil, the function `org-get-tags-at' will return the value
12235 of `org-scanner-tags' instead of building the list by itself. This
12236 can lead to large speed-ups when the tags scanner is used in a file with
12237 many entries, and when the list of tags is retrieved, for example to
12238 obtain a list of properties. Building the tags list for each entry in such
12239 a file becomes an N^2 operation - but with this variable set, it scales
12240 as N.")
12242 (defun org-scan-tags (action matcher &optional todo-only)
12243 "Scan headline tags with inheritance and produce output ACTION.
12245 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12246 or `agenda' to produce an entry list for an agenda view. It can also be
12247 a Lisp form or a function that should be called at each matched headline, in
12248 this case the return value is a list of all return values from these calls.
12250 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12251 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12252 only lines with a TODO keyword are included in the output."
12253 (require 'org-agenda)
12256 (org-re
12258 (props (list 'face 'default
12259 'done-face 'org-agenda-done
12260 'undone-face 'default
12261 'mouse-face 'highlight
12262 'org-not-done-regexp org-not-done-regexp
12263 'org-todo-regexp org-todo-regexp
12264 'help-echo
12265 (format "mouse-2 or RET jump to org file %s"
12266 (abbreviate-file-name
12267 (or (buffer-file-name (buffer-base-buffer))
12268 (buffer-name (buffer-base-buffer)))))))
12269 (case-fold-search nil)
12270 (org-map-continue-from nil)
12271 lspos tags tags-list
12272 (tags-alist (list (cons 0 org-file-tags)))
12273 (llast 0) rtn rtn1 level category i txt
12274 todo marker entry priority)
12275 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12276 (setq action (list 'lambda nil action)))
12277 (save-excursion
12278 (goto-char (point-min))
12279 (when (eq action 'sparse-tree)
12280 (org-overview)
12281 (org-remove-occur-highlights))
12282 (while (re-search-forward re nil t)
12283 (catch :skip
12284 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12285 tags (if (match-end 4) (org-match-string-no-properties 4)))
12286 (goto-char (setq lspos (match-beginning 0)))
12287 (setq level (org-reduced-level (funcall outline-level))
12288 category (org-get-category))
12289 (setq i llast llast level)
12290 ;; remove tag lists from same and sublevels
12291 (while (>= i level)
12292 (when (setq entry (assoc i tags-alist))
12293 (setq tags-alist (delete entry tags-alist)))
12294 (setq i (1- i)))
12295 ;; add the next tags
12296 (when tags
12297 (setq tags (org-split-string tags ":")
12298 tags-alist
12299 (cons (cons level tags) tags-alist)))
12300 ;; compile tags for current headline
12301 (setq tags-list
12302 (if org-use-tag-inheritance
12303 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12304 tags)
12305 org-scanner-tags tags-list)
12306 (when org-use-tag-inheritance
12307 (setcdr (car tags-alist)
12308 (mapcar (lambda (x)
12309 (setq x (copy-sequence x))
12310 (org-add-prop-inherited x))
12311 (cdar tags-alist))))
12312 (when (and tags org-use-tag-inheritance
12313 (or (not (eq t org-use-tag-inheritance))
12314 org-tags-exclude-from-inheritance))
12315 ;; selective inheritance, remove uninherited ones
12316 (setcdr (car tags-alist)
12317 (org-remove-uniherited-tags (cdar tags-alist))))
12318 (when (and (or (not todo-only)
12319 (and (member todo org-not-done-keywords)
12320 (or (not org-agenda-tags-todo-honor-ignore-options)
12321 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12322 (let ((case-fold-search t)) (eval matcher))
12323 (or
12324 (not (member org-archive-tag tags-list))
12325 ;; we have an archive tag, should we use this anyway?
12326 (or (not org-agenda-skip-archived-trees)
12327 (and (eq action 'agenda) org-agenda-archives-mode))))
12328 (unless (eq action 'sparse-tree) (org-agenda-skip))
12330 ;; select this headline
12332 (cond
12333 ((eq action 'sparse-tree)
12334 (and org-highlight-sparse-tree-matches
12335 (org-get-heading) (match-end 0)
12336 (org-highlight-new-match
12337 (match-beginning 0) (match-beginning 1)))
12338 (org-show-context 'tags-tree))
12339 ((eq action 'agenda)
12340 (setq txt (org-format-agenda-item
12341 ""
12342 (concat
12343 (if (eq org-tags-match-list-sublevels 'indented)
12344 (make-string (1- level) ?.) "")
12345 (org-get-heading))
12346 category
12347 tags-list
12348 )
12349 priority (org-get-priority txt))
12350 (goto-char lspos)
12351 (setq marker (org-agenda-new-marker))
12352 (org-add-props txt props
12353 'org-marker marker 'org-hd-marker marker 'org-category category
12354 'todo-state todo
12355 'priority priority 'type "tagsmatch")
12356 (push txt rtn))
12357 ((functionp action)
12358 (setq org-map-continue-from nil)
12359 (save-excursion
12360 (setq rtn1 (funcall action))
12361 (push rtn1 rtn)))
12362 (t (error "Invalid action")))
12364 ;; if we are to skip sublevels, jump to end of subtree
12365 (unless org-tags-match-list-sublevels
12366 (org-end-of-subtree t)
12367 (backward-char 1))))
12368 ;; Get the correct position from where to continue
12369 (if org-map-continue-from
12370 (goto-char org-map-continue-from)
12371 (and (= (point) lspos) (end-of-line 1)))))
12372 (when (and (eq action 'sparse-tree)
12373 (not org-sparse-tree-open-archived-trees))
12374 (org-hide-archived-subtrees (point-min) (point-max)))
12375 (nreverse rtn)))
12377 (defun org-remove-uniherited-tags (tags)
12378 "Remove all tags that are not inherited from the list TAGS."
12379 (cond
12380 ((eq org-use-tag-inheritance t)
12381 (if org-tags-exclude-from-inheritance
12382 (org-delete-all org-tags-exclude-from-inheritance tags)
12383 tags))
12384 ((not org-use-tag-inheritance) nil)
12385 ((stringp org-use-tag-inheritance)
12386 (delq nil (mapcar
12387 (lambda (x)
12388 (if (and (string-match org-use-tag-inheritance x)
12389 (not (member x org-tags-exclude-from-inheritance)))
12390 x nil))
12391 tags)))
12392 ((listp org-use-tag-inheritance)
12393 (delq nil (mapcar
12394 (lambda (x)
12395 (if (member x org-use-tag-inheritance) x nil))
12396 tags)))))
12398 (defvar todo-only) ;; dynamically scoped
12400 (defun org-match-sparse-tree (&optional todo-only match)
12401 "Create a sparse tree according to tags string MATCH.
12402 MATCH can contain positive and negative selection of tags, like
12404 If optional argument TODO-ONLY is non-nil, only select lines that are
12405 also TODO lines."
12406 (interactive "P")
12407 (org-prepare-agenda-buffers (list (current-buffer)))
12408 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12410 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12412 (defvar org-cached-props nil)
12413 (defun org-cached-entry-get (pom property)
12414 (if (or (eq t org-use-property-inheritance)
12415 (and (stringp org-use-property-inheritance)
12416 (string-match org-use-property-inheritance property))
12417 (and (listp org-use-property-inheritance)
12418 (member property org-use-property-inheritance)))
12419 ;; Caching is not possible, check it directly
12420 (org-entry-get pom property 'inherit)
12421 ;; Get all properties, so that we can do complicated checks easily
12422 (cdr (assoc property (or org-cached-props
12423 (setq org-cached-props
12424 (org-entry-properties pom)))))))
12426 (defun org-global-tags-completion-table (&optional files)
12427 "Return the list of all tags in all agenda buffer/files."
12428 (save-excursion
12429 (org-uniquify
12430 (delq nil
12431 (apply 'append
12432 (mapcar
12433 (lambda (file)
12434 (set-buffer (find-file-noselect file))
12435 (append (org-get-buffer-tags)
12436 (mapcar (lambda (x) (if (stringp (car-safe x))
12437 (list (car-safe x)) nil))
12438 org-tag-alist)))
12439 (if (and files (car files))
12440 files
12441 (org-agenda-files))))))))
12443 (defun org-make-tags-matcher (match)
12444 "Create the TAGS//TODO matcher form for the selection string MATCH."
12445 ;; todo-only is scoped dynamically into this function, and the function
12446 ;; may change it if the matcher asks for it.
12447 (unless match
12448 ;; Get a new match request, with completion
12449 (let ((org-last-tags-completion-table
12450 (org-global-tags-completion-table)))
12451 (setq match (org-completing-read-no-i
12452 "Match: " 'org-tags-completion-function nil nil nil
12453 'org-tags-history))))
12455 ;; Parse the string and create a lisp form
12456 (let ((match0 match)
12457 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12458 minus tag mm
12459 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12460 orterms term orlist re-p str-p level-p level-op time-p
12461 prop-p pn pv po cat-p gv rest)
12462 (if (string-match "/+" match)
12463 ;; match contains also a todo-matching request
12464 (progn
12465 (setq tagsmatch (substring match 0 (match-beginning 0))
12466 todomatch (substring match (match-end 0)))
12467 (if (string-match "^!" todomatch)
12468 (setq todo-only t todomatch (substring todomatch 1)))
12470 (setq todomatch nil)))
12471 ;; only matching tags
12472 (setq tagsmatch match todomatch nil))
12474 ;; Make the tags matcher
12476 (setq tagsmatcher t)
12477 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12478 (while (setq term (pop orterms))
12480 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12481 (while (string-match re term)
12482 (setq rest (substring term (match-end 0))
12483 minus (and (match-end 1)
12484 (equal (match-string 1 term) "-"))
12485 tag (save-match-data (replace-regexp-in-string
12487 (match-string 2 term)))
12488 re-p (equal (string-to-char tag) ?{)
12489 level-p (match-end 4)
12490 prop-p (match-end 5)
12491 mm (cond
12492 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12493 (level-p
12494 (setq level-op (org-op-to-function (match-string 3 term)))
12495 `(,level-op level ,(string-to-number
12496 (match-string 4 term))))
12497 (prop-p
12498 (setq pn (match-string 5 term)
12499 po (match-string 6 term)
12500 pv (match-string 7 term)
12501 cat-p (equal pn "CATEGORY")
12502 re-p (equal (string-to-char pv) ?{)
12504 time-p (save-match-data
12506 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12507 (if time-p (setq pv (org-matcher-time pv)))
12508 (setq po (org-op-to-function po (if time-p 'time str-p)))
12509 (cond
12510 ((equal pn "CATEGORY")
12511 (setq gv '(get-text-property (point) 'org-category)))
12512 ((equal pn "TODO")
12513 (setq gv 'todo))
12514 (t
12515 (setq gv `(org-cached-entry-get nil ,pn))))
12516 (if re-p
12517 (if (eq po 'org<>)
12518 `(not (string-match ,pv (or ,gv "")))
12519 `(string-match ,pv (or ,gv "")))
12520 (if str-p
12521 `(,po (or ,gv "") ,pv)
12522 `(,po (string-to-number (or ,gv ""))
12523 ,(string-to-number pv) ))))
12524 (t `(member ,tag tags-list)))
12525 mm (if minus (list 'not mm) mm)
12526 term rest)
12527 (push mm tagsmatcher))
12528 (push (if (> (length tagsmatcher) 1)
12529 (cons 'and tagsmatcher)
12530 (car tagsmatcher))
12531 orlist)
12532 (setq tagsmatcher nil))
12533 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12534 (setq tagsmatcher
12535 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12536 ;; Make the todo matcher
12538 (setq todomatcher t)
12539 (setq orterms (org-split-string todomatch "|") orlist nil)
12540 (while (setq term (pop orterms))
12541 (while (string-match re term)
12542 (setq minus (and (match-end 1)
12543 (equal (match-string 1 term) "-"))
12544 kwd (match-string 2 term)
12545 re-p (equal (string-to-char kwd) ?{)
12546 term (substring term (match-end 0))
12547 mm (if re-p
12548 `(string-match ,(substring kwd 1 -1) todo)
12549 (list 'equal 'todo kwd))
12550 mm (if minus (list 'not mm) mm))
12551 (push mm todomatcher))
12552 (push (if (> (length todomatcher) 1)
12553 (cons 'and todomatcher)
12554 (car todomatcher))
12555 orlist)
12556 (setq todomatcher nil))
12557 (setq todomatcher (if (> (length orlist) 1)
12558 (cons 'or orlist) (car orlist))))
12560 ;; Return the string and lisp forms of the matcher
12561 (setq matcher (if todomatcher
12562 (list 'and tagsmatcher todomatcher)
12563 tagsmatcher))
12564 (cons match0 matcher)))
12566 (defun org-op-to-function (op &optional stringp)
12567 "Turn an operator into the appropriate function."
12568 (setq op
12569 (cond
12570 ((equal op "<" ) '(< string< org-time<))
12571 ((equal op ">" ) '(> org-string> org-time>))
12572 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12573 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12574 ((member op '("=" "==")) '(= string= org-time=))
12575 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12576 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12578 (defun org<> (a b) (not (= a b)))
12579 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12580 (defun org-string>= (a b) (not (string< a b)))
12581 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12582 (defun org-string<> (a b) (not (string= 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) (< a b)))
12585 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12586 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12587 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12588 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12589 (defun org-2ft (s)
12590 "Convert S to a floating point time.
12591 If S is already a number, just return it. If it is a string, parse
12592 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12593 (cond
12594 ((numberp s) s)
12595 ((stringp s)
12596 (condition-case nil
12597 (float-time (apply 'encode-time (org-parse-time-string s)))
12598 (error 0.)))
12599 (t 0.)))
12601 (defun org-time-today ()
12602 "Time in seconds today at 0:00.
12603 Returns the float number of seconds since the beginning of the
12604 epoch to the beginning of today (00:00)."
12605 (float-time (apply 'encode-time
12606 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12608 (defun org-matcher-time (s)
12609 "Interpret a time comparison value."
12610 (save-match-data
12611 (cond
12612 ((string= s "<now>") (float-time))
12613 ((string= s "<today>") (org-time-today))
12614 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12615 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12617 (+ (org-time-today)
12618 (* (string-to-number (match-string 1 s))
12619 (cdr (assoc (match-string 2 s)
12620 '(("d" . 86400.0) ("w" . 604800.0)
12621 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12622 (t (org-2ft s)))))
12624 (defun org-match-any-p (re list)
12625 "Does re match any element of list?"
12626 (setq list (mapcar (lambda (x) (string-match re x)) list))
12627 (delq nil list))
12629 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12630 (defvar org-tags-overlay (make-overlay 1 1))
12631 (org-detach-overlay org-tags-overlay)
12633 (defun org-get-local-tags-at (&optional pos)
12634 "Get a list of tags defined in the current headline."
12635 (org-get-tags-at pos 'local))
12637 (defun org-get-local-tags ()
12638 "Get a list of tags defined in the current headline."
12639 (org-get-tags-at nil 'local))
12641 (defun org-get-tags-at (&optional pos local)
12642 "Get a list of all headline tags applicable at POS.
12643 POS defaults to point. If tags are inherited, the list contains
12644 the targets in the same sequence as the headlines appear, i.e.
12645 the tags of the current headline come last.
12646 When LOCAL is non-nil, only return tags from the current headline,
12647 ignore inherited ones."
12648 (interactive)
12649 (if (and org-trust-scanner-tags
12650 (or (not pos) (equal pos (point)))
12651 (not local))
12652 org-scanner-tags
12653 (let (tags ltags lastpos parent)
12654 (save-excursion
12655 (save-restriction
12656 (widen)
12657 (goto-char (or pos (point)))
12658 (save-match-data
12659 (catch 'done
12660 (condition-case nil
12661 (progn
12662 (org-back-to-heading t)
12663 (while (not (equal lastpos (point)))
12664 (setq lastpos (point))
12665 (when (looking-at
12667 (setq ltags (org-split-string
12668 (org-match-string-no-properties 1) ":"))
12669 (when parent
12670 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12671 (setq tags (append
12672 (if parent
12673 (org-remove-uniherited-tags ltags)
12674 ltags)
12675 tags)))
12676 (or org-use-tag-inheritance (throw 'done t))
12677 (if local (throw 'done t))
12678 (or (org-up-heading-safe) (error nil))
12679 (setq parent t)))
12680 (error nil)))))
12681 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12683 (defun org-add-prop-inherited (s)
12684 (add-text-properties 0 (length s) '(inherited t) s)
12685 s)
12687 (defun org-toggle-tag (tag &optional onoff)
12688 "Toggle the tag TAG for the current line.
12689 If ONOFF is `on' or `off', don't toggle but set to this state."
12690 (let (res current)
12691 (save-excursion
12692 (org-back-to-heading t)
12694 (point-at-eol) t)
12695 (progn
12696 (setq current (match-string 1))
12697 (replace-match ""))
12698 (setq current ""))
12699 (setq current (nreverse (org-split-string current ":")))
12700 (cond
12701 ((eq onoff 'on)
12702 (setq res t)
12703 (or (member tag current) (push tag current)))
12704 ((eq onoff 'off)
12705 (or (not (member tag current)) (setq current (delete tag current))))
12706 (t (if (member tag current)
12707 (setq current (delete tag current))
12708 (setq res t)
12709 (push tag current))))
12710 (end-of-line 1)
12711 (if current
12712 (progn
12713 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12714 (org-set-tags nil t))
12715 (delete-horizontal-space))
12716 (run-hooks 'org-after-tags-change-hook))
12717 res))
12719 (defun org-align-tags-here (to-col)
12720 ;; Assumes that this is a headline
12721 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12722 (beginning-of-line 1)
12724 (< pos (match-beginning 2)))
12725 (progn
12726 (setq tags-l (- (match-end 2) (match-beginning 2)))
12727 (goto-char (match-beginning 1))
12728 (insert " ")
12729 (delete-region (point) (1+ (match-beginning 2)))
12730 (setq ncol (max (1+ (current-column))
12731 (1+ col)
12732 (if (> to-col 0)
12733 to-col
12734 (- (abs to-col) tags-l))))
12735 (setq p (point))
12736 (insert (make-string (- ncol (current-column)) ?\ ))
12737 (setq ncol (current-column))
12738 (when indent-tabs-mode (tabify p (point-at-eol)))
12739 (org-move-to-column (min ncol col) t))
12740 (goto-char pos))))
12742 (defun org-set-tags-command (&optional arg just-align)
12743 "Call the set-tags command for the current entry."
12744 (interactive "P")
12745 (if (org-on-heading-p)
12746 (org-set-tags arg just-align)
12747 (save-excursion
12748 (org-back-to-heading t)
12749 (org-set-tags arg just-align))))
12751 (defun org-set-tags-to (data)
12752 "Set the tags of the current entry to DATA, replacing the current tags.
12753 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12754 If DATA is nil or the empty string, any tags will be removed."
12755 (interactive "sTags: ")
12756 (setq data
12757 (cond
12758 ((eq data nil) "")
12759 ((equal data "") "")
12760 ((stringp data)
12761 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12762 ":"))
12763 ((listp data)
12764 (concat ":" (mapconcat 'identity data ":") ":"))
12765 (t nil)))
12766 (when data
12767 (save-excursion
12768 (org-back-to-heading t)
12769 (when (looking-at org-complex-heading-regexp)
12770 (if (match-end 5)
12771 (progn
12772 (goto-char (match-beginning 5))
12773 (insert data)
12774 (delete-region (point) (point-at-eol))
12775 (org-set-tags nil 'align))
12776 (goto-char (point-at-eol))
12777 (insert " " data)
12778 (org-set-tags nil 'align)))
12779 (beginning-of-line 1)
12781 (delete-region (match-beginning 1) (match-end 1))))))
12783 (defun org-align-all-tags ()
12784 "Align the tags i all headings."
12785 (interactive)
12786 (save-excursion
12787 (or (ignore-errors (org-back-to-heading t))
12788 (outline-next-heading))
12789 (if (org-on-heading-p)
12790 (org-set-tags t)
12791 (message "No headings"))))
12793 (defvar org-indent-indentation-per-level)
12794 (defun org-set-tags (&optional arg just-align)
12795 "Set the tags for the current headline.
12796 With prefix ARG, realign all tags in headings in the current buffer."
12797 (interactive "P")
12798 (let* ((re (concat "^" outline-regexp))
12799 (current (org-get-tags-string))
12800 (col (current-column))
12801 (org-setting-tags t)
12802 table current-tags inherited-tags ; computed below when needed
12803 tags p0 c0 c1 rpl di tc level)
12804 (if arg
12805 (save-excursion
12806 (goto-char (point-min))
12807 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12808 (while (re-search-forward re nil t)
12809 (org-set-tags nil t)
12810 (end-of-line 1)))
12811 (message "All tags realigned to column %d" org-tags-column))
12812 (if just-align
12813 (setq tags current)
12814 ;; Get a new set of tags from the user
12815 (save-excursion
12816 (setq table (append org-tag-persistent-alist
12817 (or org-tag-alist (org-get-buffer-tags))
12818 (and
12819 org-complete-tags-always-offer-all-agenda-tags
12820 (org-global-tags-completion-table
12821 (org-agenda-files))))
12822 org-last-tags-completion-table table
12823 current-tags (org-split-string current ":")
12824 inherited-tags (nreverse
12825 (nthcdr (length current-tags)
12826 (nreverse (org-get-tags-at))))
12827 tags
12828 (if (or (eq t org-use-fast-tag-selection)
12829 (and org-use-fast-tag-selection
12830 (delq nil (mapcar 'cdr table))))
12831 (org-fast-tag-selection
12832 current-tags inherited-tags table
12833 (if org-fast-tag-selection-include-todo
12834 org-todo-key-alist))
12835 (let ((org-add-colon-after-tag-completion t))
12836 (org-trim
12837 (org-without-partial-completion
12838 (org-icompleting-read "Tags: "
12839 'org-tags-completion-function
12840 nil nil current 'org-tags-history)))))))
12841 (while (string-match "[-+&]+" tags)
12842 ;; No boolean logic, just a list
12843 (setq tags (replace-match ":" t t tags))))
12845 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12847 (if org-tags-sort-function
12848 (setq tags (mapconcat 'identity
12849 (sort (org-split-string
12850 tags (org-re "[^[:alnum:]_@#%]+"))
12851 org-tags-sort-function) ":")))
12854 (setq tags "")
12855 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12856 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12858 ;; Insert new tags at the correct column
12859 (beginning-of-line 1)
12860 (setq level (or (and (looking-at org-outline-regexp)
12861 (- (match-end 0) (point) 1))
12862 1))
12863 (cond
12864 ((and (equal current "") (equal tags "")))
12865 ((re-search-forward
12867 (point-at-eol) t)
12868 (if (equal tags "")
12869 (setq rpl "")
12870 (goto-char (match-beginning 0))
12871 (setq c0 (current-column)
12872 ;; compute offset for the case of org-indent-mode active
12873 di (if org-indent-mode
12874 (* (1- org-indent-indentation-per-level) (1- level))
12875 0)
12876 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12877 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12878 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12879 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12880 (replace-match rpl t t)
12881 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12882 tags)
12883 (t (error "Tags alignment failed")))
12884 (org-move-to-column col)
12885 (unless just-align
12886 (run-hooks 'org-after-tags-change-hook)))))
12888 (defun org-change-tag-in-region (beg end tag off)
12889 "Add or remove TAG for each entry in the region.
12890 This works in the agenda, and also in an org-mode buffer."
12891 (interactive
12892 (list (region-beginning) (region-end)
12893 (let ((org-last-tags-completion-table
12894 (if (org-mode-p)
12895 (org-get-buffer-tags)
12896 (org-global-tags-completion-table))))
12897 (org-icompleting-read
12898 "Tag: " 'org-tags-completion-function nil nil nil
12899 'org-tags-history))
12900 (progn
12902 (equal (read-char-exclusive) ?r))))
12903 (if (fboundp 'deactivate-mark) (deactivate-mark))
12904 (let ((agendap (equal major-mode 'org-agenda-mode))
12905 l1 l2 m buf pos newhead (cnt 0))
12906 (goto-char end)
12907 (setq l2 (1- (org-current-line)))
12908 (goto-char beg)
12909 (setq l1 (org-current-line))
12910 (loop for l from l1 to l2 do
12911 (org-goto-line l)
12912 (setq m (get-text-property (point) 'org-hd-marker))
12913 (when (or (and (org-mode-p) (org-on-heading-p))
12914 (and agendap m))
12915 (setq buf (if agendap (marker-buffer m) (current-buffer))
12916 pos (if agendap m (point)))
12917 (with-current-buffer buf
12918 (save-excursion
12919 (save-restriction
12920 (goto-char pos)
12921 (setq cnt (1+ cnt))
12922 (org-toggle-tag tag (if off 'off 'on))
12923 (setq newhead (org-get-heading)))))
12924 (and agendap (org-agenda-change-all-lines newhead m))))
12925 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12927 (defun org-tags-completion-function (string predicate &optional flag)
12928 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12929 (confirm (lambda (x) (stringp (car x)))))
12931 (setq s1 (match-string 1 string)
12932 s2 (match-string 2 string))
12933 (setq s1 "" s2 string))
12934 (cond
12935 ((eq flag nil)
12936 ;; try completion
12937 (setq rtn (try-completion s2 ctable confirm))
12938 (if (stringp rtn)
12939 (setq rtn
12940 (concat s1 s2 (substring rtn (length s2))
12941 (if (and org-add-colon-after-tag-completion
12942 (assoc rtn ctable))
12943 ":" ""))))
12944 rtn)
12945 ((eq flag t)
12946 ;; all-completions
12947 (all-completions s2 ctable confirm)
12948 )
12949 ((eq flag 'lambda)
12950 ;; exact match?
12951 (assoc s2 ctable)))
12952 ))
12954 (defun org-fast-tag-insert (kwd tags face &optional end)
12955 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12956 (insert (format "%-12s" (concat kwd ":"))
12957 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12958 (or end "")))
12960 (defun org-fast-tag-show-exit (flag)
12961 (save-excursion
12962 (org-goto-line 3)
12964 (replace-match ""))
12965 (when flag
12966 (end-of-line 1)
12967 (org-move-to-column (- (window-width) 19) t)
12968 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12970 (defun org-set-current-tags-overlay (current prefix)
12971 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12972 (if (featurep 'xemacs)
12973 (org-overlay-display org-tags-overlay (concat prefix s)
12974 'secondary-selection)
12975 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12976 (org-overlay-display org-tags-overlay (concat prefix s)))))
12978 (defvar org-last-tag-selection-key nil)
12979 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12980 "Fast tag selection with single keys.
12981 CURRENT is the current list of tags in the headline, INHERITED is the
12982 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12983 possibly with grouping information. TODO-TABLE is a similar table with
12984 TODO keywords, should these have keys assigned to them.
12985 If the keys are nil, a-z are automatically assigned.
12986 Returns the new tags string, or nil to not change the current settings."
12987 (let* ((fulltable (append table todo-table))
12988 (maxlen (apply 'max (mapcar
12989 (lambda (x)
12990 (if (stringp (car x)) (string-width (car x)) 0))
12991 fulltable)))
12992 (buf (current-buffer))
12993 (expert (eq org-fast-tag-selection-single-key 'expert))
12994 (buffer-tags nil)
12995 (fwidth (+ maxlen 3 1 3))
12996 (ncol (/ (- (window-width) 4) fwidth))
12997 (i-face 'org-done)
12998 (c-face 'org-todo)
12999 tg cnt e c char c1 c2 ntable tbl rtn
13000 ov-start ov-end ov-prefix
13001 (exit-after-next org-fast-tag-selection-single-key)
13002 (done-keywords org-done-keywords)
13003 groups ingroup)
13004 (save-excursion
13005 (beginning-of-line 1)
13006 (if (looking-at
13008 (setq ov-start (match-beginning 1)
13009 ov-end (match-end 1)
13010 ov-prefix "")
13011 (setq ov-start (1- (point-at-eol))
13012 ov-end (1+ ov-start))
13014 (setq ov-prefix
13015 (concat
13016 (buffer-substring (1- (point)) (point))
13017 (if (> (current-column) org-tags-column)
13018 " "
13019 (make-string (- org-tags-column (current-column)) ?\ ))))))
13020 (move-overlay org-tags-overlay ov-start ov-end)
13021 (save-window-excursion
13022 (if expert
13023 (set-buffer (get-buffer-create " *Org tags*"))
13024 (delete-other-windows)
13025 (split-window-vertically)
13026 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13027 (erase-buffer)
13028 (org-set-local 'org-done-keywords done-keywords)
13031 (org-fast-tag-show-exit exit-after-next)
13032 (org-set-current-tags-overlay current ov-prefix)
13033 (setq tbl fulltable char ?a cnt 0)
13034 (while (setq e (pop tbl))
13035 (cond
13036 ((equal (car e) :startgroup)
13037 (push '() groups) (setq ingroup t)
13038 (when (not (= cnt 0))
13039 (setq cnt 0)
13041 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13042 ((equal (car e) :endgroup)
13043 (setq ingroup nil cnt 0)
13045 ((equal e '(:newline))
13046 (when (not (= cnt 0))
13047 (setq cnt 0)
13049 (setq e (car tbl))
13050 (while (equal (car tbl) '(:newline))
13052 (setq tbl (cdr tbl)))))
13053 (t
13054 (setq tg (copy-sequence (car e)) c2 nil)
13055 (if (cdr e)
13056 (setq c (cdr e))
13057 ;; automatically assign a character.
13058 (setq c1 (string-to-char
13059 (downcase (substring
13060 tg (if (= (string-to-char tg) ?@) 1 0)))))
13061 (if (or (rassoc c1 ntable) (rassoc c1 table))
13062 (while (or (rassoc char ntable) (rassoc char table))
13063 (setq char (1+ char)))
13064 (setq c2 c1))
13065 (setq c (or c2 char)))
13066 (if ingroup (push tg (car groups)))
13067 (setq tg (org-add-props tg nil 'face
13068 (cond
13069 ((not (assoc tg table))
13070 (org-get-todo-face tg))
13071 ((member tg current) c-face)
13072 ((member tg inherited) i-face)
13073 (t nil))))
13074 (if (and (= cnt 0) (not ingroup)) (insert " "))
13075 (insert "[" c "] " tg (make-string
13076 (- fwidth 4 (length tg)) ?\ ))
13077 (push (cons tg c) ntable)
13078 (when (= (setq cnt (1+ cnt)) ncol)
13080 (if ingroup (insert " "))
13081 (setq cnt 0)))))
13082 (setq ntable (nreverse ntable))
13084 (goto-char (point-min))
13085 (if (not expert) (org-fit-window-to-buffer))
13086 (setq rtn
13087 (catch 'exit
13088 (while t
13089 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13090 (if (not groups) "no " "")
13091 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13092 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13093 (setq org-last-tag-selection-key c)
13094 (cond
13096 ((= c ?!)
13097 (setq groups (not groups))
13098 (goto-char (point-min))
13099 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13100 ((= c ?\C-c)
13101 (if (not expert)
13102 (org-fast-tag-show-exit
13103 (setq exit-after-next (not exit-after-next)))
13104 (setq expert nil)
13105 (delete-other-windows)
13106 (split-window-vertically)
13107 (org-switch-to-buffer-other-window " *Org tags*")
13108 (org-fit-window-to-buffer)))
13109 ((or (= c ?\C-g)
13110 (and (= c ?q) (not (rassoc c ntable))))
13111 (org-detach-overlay org-tags-overlay)
13112 (setq quit-flag t))
13113 ((= c ?\ )
13114 (setq current nil)
13115 (if exit-after-next (setq exit-after-next 'now)))
13117 (condition-case nil
13118 (setq tg (org-icompleting-read
13119 "Tag: "
13120 (or buffer-tags
13121 (with-current-buffer buf
13122 (org-get-buffer-tags)))))
13123 (quit (setq tg "")))
13125 (add-to-list 'buffer-tags (list tg))
13126 (if (member tg current)
13127 (setq current (delete tg current))
13128 (push tg current)))
13129 (if exit-after-next (setq exit-after-next 'now)))
13130 ((setq e (rassoc c todo-table) tg (car e))
13131 (with-current-buffer buf
13132 (save-excursion (org-todo tg)))
13133 (if exit-after-next (setq exit-after-next 'now)))
13134 ((setq e (rassoc c ntable) tg (car e))
13135 (if (member tg current)
13136 (setq current (delete tg current))
13137 (loop for g in groups do
13138 (if (member tg g)
13139 (mapc (lambda (x)
13140 (setq current (delete x current)))
13141 g)))
13142 (push tg current))
13143 (if exit-after-next (setq exit-after-next 'now))))
13145 ;; Create a sorted list
13146 (setq current
13147 (sort current
13148 (lambda (a b)
13149 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13150 (if (eq exit-after-next 'now) (throw 'exit t))
13151 (goto-char (point-min))
13152 (beginning-of-line 2)
13153 (delete-region (point) (point-at-eol))
13154 (org-fast-tag-insert "Current" current c-face)
13155 (org-set-current-tags-overlay current ov-prefix)
13156 (while (re-search-forward
13158 (setq tg (match-string 1))
13159 (add-text-properties
13160 (match-beginning 1) (match-end 1)
13161 (list 'face
13162 (cond
13163 ((member tg current) c-face)
13164 ((member tg inherited) i-face)
13165 (t (get-text-property (match-beginning 1) 'face))))))
13166 (goto-char (point-min)))))
13167 (org-detach-overlay org-tags-overlay)
13168 (if rtn
13169 (mapconcat 'identity current ":")
13170 nil))))
13172 (defun org-get-tags-string ()
13173 "Get the TAGS string in the current headline."
13174 (unless (org-on-heading-p t)
13175 (error "Not on a heading"))
13176 (save-excursion
13177 (beginning-of-line 1)
13179 (org-match-string-no-properties 1)
13180 "")))
13182 (defun org-get-tags ()
13183 "Get the list of tags specified in the current headline."
13184 (org-split-string (org-get-tags-string) ":"))
13186 (defun org-get-buffer-tags ()
13187 "Get a table of all tags used in the buffer, for completion."
13188 (let (tags)
13189 (save-excursion
13190 (goto-char (point-min))
13191 (while (re-search-forward
13193 (when (equal (char-after (point-at-bol 0)) ?*)
13194 (mapc (lambda (x) (add-to-list 'tags x))
13195 (org-split-string (org-match-string-no-properties 1) ":")))))
13196 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13197 (mapcar 'list tags)))
13199 ;;;; The mapping API
13201 ;;;###autoload
13202 (defun org-map-entries (func &optional match scope &rest skip)
13203 "Call FUNC at each headline selected by MATCH in SCOPE.
13205 FUNC is a function or a lisp form. The function will be called without
13206 arguments, with the cursor positioned at the beginning of the headline.
13207 The return values of all calls to the function will be collected and
13208 returned as a list.
13210 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13211 does not need to preserve point. After evaluation, the cursor will be
13212 moved to the end of the line (presumably of the headline of the
13213 processed entry) and search continues from there. Under some
13214 circumstances, this may not produce the wanted results. For example,
13215 if you have removed (e.g. archived) the current (sub)tree it could
13216 mean that the next entry will be skipped entirely. In such cases, you
13217 can specify the position from where search should continue by making
13218 FUNC set the variable `org-map-continue-from' to the desired buffer
13219 position.
13221 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13222 Only headlines that are matched by this query will be considered during
13223 the iteration. When MATCH is nil or t, all headlines will be
13224 visited by the iteration.
13226 SCOPE determines the scope of this command. It can be any of:
13228 nil The current buffer, respecting the restriction if any
13229 tree The subtree started with the entry at point
13230 file The current buffer, without restriction
13231 file-with-archives
13232 The current buffer, and any archives associated with it
13233 agenda All agenda files
13234 agenda-with-archives
13235 All agenda files with any archive files associated with them
13236 \(file1 file2 ...)
13237 If this is a list, all files in the list will be scanned
13239 The remaining args are treated as settings for the skipping facilities of
13240 the scanner. The following items can be given here:
13242 archive skip trees with the archive tag.
13243 comment skip trees with the COMMENT keyword
13244 function or Emacs Lisp form:
13245 will be used as value for `org-agenda-skip-function', so whenever
13246 the function returns t, FUNC will not be called for that
13247 entry and search will continue from the point where the
13248 function leaves it.
13250 If your function needs to retrieve the tags including inherited tags
13251 at the *current* entry, you can use the value of the variable
13252 `org-scanner-tags' which will be much faster than getting the value
13253 with `org-get-tags-at'. If your function gets properties with
13254 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13255 to t around the call to `org-entry-properties' to get the same speedup.
13256 Note that if your function moves around to retrieve tags and properties at
13257 a *different* entry, you cannot use these techniques."
13258 (let* ((org-agenda-archives-mode nil) ; just to make sure
13259 (org-agenda-skip-archived-trees (memq 'archive skip))
13260 (org-agenda-skip-comment-trees (memq 'comment skip))
13261 (org-agenda-skip-function
13262 (car (org-delete-all '(comment archive) skip)))
13263 (org-tags-match-list-sublevels t)
13264 matcher file res
13265 org-todo-keywords-for-agenda
13266 org-done-keywords-for-agenda
13267 org-todo-keyword-alist-for-agenda
13268 org-drawers-for-agenda
13269 org-tag-alist-for-agenda)
13271 (cond
13272 ((eq match t) (setq matcher t))
13273 ((eq match nil) (setq matcher t))
13274 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13276 (save-excursion
13277 (save-restriction
13278 (when (eq scope 'tree)
13279 (org-back-to-heading t)
13280 (org-narrow-to-subtree)
13281 (setq scope nil))
13283 (if (not scope)
13284 (progn
13285 (org-prepare-agenda-buffers
13286 (list (buffer-file-name (current-buffer))))
13287 (setq res (org-scan-tags func matcher)))
13288 ;; Get the right scope
13289 (cond
13290 ((and scope (listp scope) (symbolp (car scope)))
13291 (setq scope (eval scope)))
13292 ((eq scope 'agenda)
13293 (setq scope (org-agenda-files t)))
13294 ((eq scope 'agenda-with-archives)
13295 (setq scope (org-agenda-files t))
13296 (setq scope (org-add-archive-files scope)))
13297 ((eq scope 'file)
13298 (setq scope (list (buffer-file-name))))
13299 ((eq scope 'file-with-archives)
13300 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13301 (org-prepare-agenda-buffers scope)
13302 (while (setq file (pop scope))
13303 (with-current-buffer (org-find-base-buffer-visiting file)
13304 (save-excursion
13305 (save-restriction
13306 (widen)
13307 (goto-char (point-min))
13308 (setq res (append res (org-scan-tags func matcher))))))))))
13309 res))
13311 ;;;; Properties
13313 ;;; Setting and retrieving properties
13315 (defconst org-special-properties
13316 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13317 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13318 "The special properties valid in Org-mode.
13320 These are properties that are not defined in the property drawer,
13321 but in some other way.")
13323 (defconst org-default-properties
13324 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13325 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13326 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13327 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13328 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13329 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13330 "Some properties that are used by Org-mode for various purposes.
13331 Being in this list makes sure that they are offered for completion.")
13334 "Regular expression matching the first line of a property drawer.")
13337 "Regular expression matching the last line of a property drawer.")
13340 "Regular expression matching the first line of a property drawer.")
13343 "Regular expression matching the first line of a property drawer.")
13345 (defconst org-property-drawer-re
13348 "Matches an entire property drawer.")
13350 (defconst org-clock-drawer-re
13353 "Matches an entire clock drawer.")
13355 (defun org-property-action ()
13356 "Do an action on properties."
13357 (interactive)
13358 (let (c)
13359 (org-at-property-p)
13360 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13361 (setq c (read-char-exclusive))
13362 (cond
13363 ((equal c ?s)
13364 (call-interactively 'org-set-property))
13365 ((equal c ?d)
13366 (call-interactively 'org-delete-property))
13367 ((equal c ?D)
13368 (call-interactively 'org-delete-property-globally))
13369 ((equal c ?c)
13370 (call-interactively 'org-compute-property-at-point))
13371 (t (error "No such property action %c" c)))))
13373 (defun org-set-effort (&optional value)
13374 "Set the effort property of the current entry.
13375 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13376 allowed value."
13377 (interactive "P")
13378 (if (equal value 0) (setq value 10))
13379 (let* ((completion-ignore-case t)
13380 (prop org-effort-property)
13381 (cur (org-entry-get nil prop))
13382 (allowed (org-property-get-allowed-values nil prop 'table))
13383 (existing (mapcar 'list (org-property-values prop)))
13384 rpl
13385 (val (cond
13386 ((stringp value) value)
13387 ((and allowed (integerp value))
13388 (or (car (nth (1- value) allowed))
13389 (car (org-last allowed))))
13390 (allowed
13391 (message "Select 1-9,0, [RET%s]: %s"
13392 (if cur (concat "=" cur) "")
13393 (mapconcat 'car allowed " "))
13394 (setq rpl (read-char-exclusive))
13396 cur
13397 (setq rpl (- rpl ?0))
13398 (if (equal rpl 0) (setq rpl 10))
13399 (if (and (> rpl 0) (<= rpl (length allowed)))
13400 (car (nth (1- rpl) allowed))
13401 (org-completing-read "Effort: " allowed nil))))
13402 (t
13403 (let (org-completion-use-ido org-completion-use-iswitchb)
13404 (org-completing-read
13406 (concat "[" cur "]") "")
13407 ": ")
13408 existing nil nil "" nil cur))))))
13409 (unless (equal (org-entry-get nil prop) val)
13410 (org-entry-put nil prop val))
13411 (message "%s is now %s" prop val)))
13413 (defun org-at-property-p ()
13414 "Is cursor inside a property drawer?"
13415 (save-excursion
13416 (beginning-of-line 1)
13418 (save-match-data ;; Used by calling procedures
13419 (let ((p (point))
13420 (range (unless (org-before-first-heading-p)
13421 (org-get-property-block))))
13422 (and range (<= (car range) p) (< p (cdr range))))))))
13424 (defun org-get-property-block (&optional beg end force)
13425 "Return the (beg . end) range of the body of the property drawer.
13426 BEG and END can be beginning and end of subtree, if not given
13427 they will be found.
13428 If the drawer does not exist and FORCE is non-nil, create the drawer."
13429 (catch 'exit
13430 (save-excursion
13431 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13432 (end (or end (progn (outline-next-heading) (point)))))
13433 (goto-char beg)
13434 (if (re-search-forward org-property-start-re end t)
13435 (setq beg (1+ (match-end 0)))
13436 (if force
13437 (save-excursion
13438 (org-insert-property-drawer)
13439 (setq end (progn (outline-next-heading) (point))))
13440 (throw 'exit nil))
13441 (goto-char beg)
13442 (if (re-search-forward org-property-start-re end t)
13443 (setq beg (1+ (match-end 0)))))
13444 (if (re-search-forward org-property-end-re end t)
13445 (setq end (match-beginning 0))
13446 (or force (throw 'exit nil))
13447 (goto-char beg)
13448 (setq end beg)
13449 (org-indent-line-function)
13451 (cons beg end)))))
13453 (defun org-entry-properties (&optional pom which specific)
13454 "Get all properties of the entry at point-or-marker POM.
13455 This includes the TODO keyword, the tags, time strings for deadline,
13456 scheduled, and clocking, and any additional properties defined in the
13457 entry. The return value is an alist, keys may occur multiple times
13458 if the property key was used several times.
13459 POM may also be nil, in which case the current entry is used.
13460 If WHICH is nil or `all', get all properties. If WHICH is
13461 `special' or `standard', only get that subclass. If WHICH
13462 is a string only get exactly this property. Specific can be a string, the
13463 specific property we are interested in. Specifying it can speed
13464 things up because then unnecessary parsing is avoided."
13465 (setq which (or which 'all))
13466 (org-with-point-at pom
13467 (let ((clockstr (substring org-clock-string 0 -1))
13468 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13469 (case-fold-search nil)
13470 beg end range props sum-props key key1 value string clocksum)
13471 (save-excursion
13472 (when (condition-case nil
13473 (and (org-mode-p) (org-back-to-heading t))
13474 (error nil))
13475 (setq beg (point))
13476 (setq sum-props (get-text-property (point) 'org-summaries))
13477 (setq clocksum (get-text-property (point) :org-clock-minutes))
13478 (outline-next-heading)
13479 (setq end (point))
13480 (when (memq which '(all special))
13481 ;; Get the special properties, like TODO and tags
13482 (goto-char beg)
13483 (when (and (or (not specific) (string= specific "TODO"))
13484 (looking-at org-todo-line-regexp) (match-end 2))
13485 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13486 (when (and (or (not specific) (string= specific "PRIORITY"))
13487 (looking-at org-priority-regexp))
13488 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13489 (when (and (or (not specific) (string= specific "TAGS"))
13490 (setq value (org-get-tags-string))
13492 (push (cons "TAGS" value) props))
13493 (when (and (or (not specific) (string= specific "ALLTAGS"))
13494 (setq value (org-get-tags-at)))
13495 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13496 ":"))
13497 props))
13498 (when (or (not specific) (string= specific "BLOCKED"))
13499 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13500 (when (or (not specific)
13501 (member specific
13502 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13503 "TIMESTAMP" "TIMESTAMP_IA")))
13504 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13505 (setq key (if (match-end 1)
13506 (substring (org-match-string-no-properties 1)
13507 0 -1))
13508 string (if (equal key clockstr)
13509 (org-no-properties
13510 (org-trim
13511 (buffer-substring
13512 (match-beginning 3) (goto-char
13513 (point-at-eol)))))
13514 (substring (org-match-string-no-properties 3)
13515 1 -1)))
13516 ;; Get the correct property name from the key. This is
13517 ;; necessary if the user has configured time keywords.
13518 (setq key1 (concat key ":"))
13519 (cond
13520 ((not key)
13521 (setq key
13522 (if (= (char-after (match-beginning 3)) ?\[)
13523 "TIMESTAMP_IA" "TIMESTAMP")))
13524 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13525 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13526 ((equal key1 org-closed-string) (setq key "CLOSED"))
13527 ((equal key1 org-clock-string) (setq key "CLOCK")))
13528 (when (or (equal key "CLOCK") (not (assoc key props)))
13529 (push (cons key string) props))))
13530 )
13532 (when (memq which '(all standard))
13533 ;; Get the standard properties, like :PROP: ...
13534 (setq range (org-get-property-block beg end))
13535 (when range
13536 (goto-char (car range))
13537 (while (re-search-forward
13539 (cdr range) t)
13540 (setq key (org-match-string-no-properties 1)
13541 value (org-trim (or (org-match-string-no-properties 2) "")))
13542 (unless (member key excluded)
13543 (push (cons key (or value "")) props)))))
13544 (if clocksum
13545 (push (cons "CLOCKSUM"
13546 (org-columns-number-to-string (/ (float clocksum) 60.)
13547 'add_times))
13548 props))
13549 (unless (assoc "CATEGORY" props)
13550 (setq value (or (org-get-category)
13551 (progn (org-refresh-category-properties)
13552 (org-get-category))))
13553 (push (cons "CATEGORY" value) props))
13554 (append sum-props (nreverse props)))))))
13556 (defun org-entry-get (pom property &optional inherit literal-nil)
13557 "Get value of PROPERTY for entry at point-or-marker POM.
13558 If INHERIT is non-nil and the entry does not have the property,
13559 then also check higher levels of the hierarchy.
13560 If INHERIT is the symbol `selective', use inheritance only if the setting
13561 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13562 If the property is present but empty, the return value is the empty string.
13563 If the property is not present at all, nil is returned.
13566 do not interpret it as the list atom nil. This is used for inheritance
13568 (org-with-point-at pom
13569 (if (and inherit (if (eq inherit 'selective)
13570 (org-property-inherit-p property)
13571 t))
13572 (org-entry-get-with-inheritance property literal-nil)
13573 (if (member property org-special-properties)
13574 ;; We need a special property. Use `org-entry-properties' to
13575 ;; retrieve it, but specify the wanted property
13576 (cdr (assoc property (org-entry-properties nil 'special property)))
13577 (let ((range (org-get-property-block)))
13578 (if (and range
13579 (goto-char (car range))
13580 (re-search-forward
13582 (cdr range) t))
13583 ;; Found the property, return it.
13584 (if (match-end 1)
13585 (if literal-nil
13586 (org-match-string-no-properties 1)
13587 (org-not-nil (org-match-string-no-properties 1)))
13588 "")))))))
13590 (defun org-property-or-variable-value (var &optional inherit)
13591 "Check if there is a property fixing the value of VAR.
13592 If yes, return this value. If not, return the current value of the variable."
13593 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13595 (read prop)
13596 (symbol-value var))))
13598 (defun org-entry-delete (pom property)
13599 "Delete the property PROPERTY from entry at point-or-marker POM."
13600 (org-with-point-at pom
13601 (if (member property org-special-properties)
13602 nil ; cannot delete these properties.
13603 (let ((range (org-get-property-block)))
13604 (if (and range
13605 (goto-char (car range))
13606 (re-search-forward
13608 (cdr range) t))
13609 (progn
13610 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13611 t)
13612 nil)))))
13614 ;; Multi-values properties are properties that contain multiple values
13615 ;; These values are assumed to be single words, separated by whitespace.
13616 (defun org-entry-add-to-multivalued-property (pom property value)
13617 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13618 (let* ((old (org-entry-get pom property))
13620 (setq value (org-entry-protect-space value))
13621 (unless (member value values)
13622 (setq values (cons value values))
13623 (org-entry-put pom property
13624 (mapconcat 'identity values " ")))))
13626 (defun org-entry-remove-from-multivalued-property (pom property value)
13627 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13628 (let* ((old (org-entry-get pom property))
13630 (setq value (org-entry-protect-space value))
13631 (when (member value values)
13632 (setq values (delete value values))
13633 (org-entry-put pom property
13634 (mapconcat 'identity values " ")))))
13636 (defun org-entry-member-in-multivalued-property (pom property value)
13637 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13638 (let* ((old (org-entry-get pom property))
13640 (setq value (org-entry-protect-space value))
13641 (member value values)))
13643 (defun org-entry-get-multivalued-property (pom property)
13644 "Return a list of values in a multivalued property."
13645 (let* ((value (org-entry-get pom property))
13647 (mapcar 'org-entry-restore-space values)))
13649 (defun org-entry-put-multivalued-property (pom property &rest values)
13650 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13651 VALUES should be a list of strings. Spaces will be protected."
13652 (org-entry-put pom property
13653 (mapconcat 'org-entry-protect-space values " "))
13654 (let* ((value (org-entry-get pom property))
13656 (mapcar 'org-entry-restore-space values)))
13658 (defun org-entry-protect-space (s)
13659 "Protect spaces and newline in string S."
13660 (while (string-match " " s)
13661 (setq s (replace-match "%20" t t s)))
13663 (setq s (replace-match "%0A" t t s)))
13664 s)
13666 (defun org-entry-restore-space (s)
13667 "Restore spaces and newline in string S."
13668 (while (string-match "%20" s)
13669 (setq s (replace-match " " t t s)))
13670 (while (string-match "%0A" s)
13672 s)
13674 (defvar org-entry-property-inherited-from (make-marker)
13675 "Marker pointing to the entry from where a property was inherited.
13676 Each call to `org-entry-get-with-inheritance' will set this marker to the
13677 location of the entry where the inheritance search matched. If there was
13678 no match, the marker will point nowhere.
13679 Note that also `org-entry-get' calls this function, if the INHERIT flag
13680 is set.")
13682 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13683 "Get entry property, and search higher levels if not present.
13684 The search will stop at the first ancestor which has the property defined.
13686 should be considered as undefined (this is the meaning of nil here).
13688 (move-marker org-entry-property-inherited-from nil)
13689 (let (tmp)
13690 (save-excursion
13691 (save-restriction
13692 (widen)
13693 (catch 'ex
13694 (while t
13695 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13696 (org-back-to-heading t)
13697 (move-marker org-entry-property-inherited-from (point))
13698 (throw 'ex tmp))
13699 (or (org-up-heading-safe) (throw 'ex nil)))))
13700 (setq tmp (or tmp
13701 (cdr (assoc property org-file-properties))
13702 (cdr (assoc property org-global-properties))
13703 (cdr (assoc property org-global-properties-fixed))))
13704 (if literal-nil tmp (org-not-nil tmp)))))
13706 (defvar org-property-changed-functions nil
13707 "Hook called when the value of a property has changed.
13708 Each hook function should accept two arguments, the name of the property
13709 and the new value.")
13711 (defun org-entry-put (pom property value)
13712 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13713 (org-with-point-at pom
13714 (org-back-to-heading t)
13715 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13716 range)
13717 (cond
13718 ((equal property "TODO")
13720 (not (member value org-todo-keywords-1)))
13722 (if (or (not value)
13724 (setq value 'none))
13725 (org-todo value)
13726 (org-set-tags nil 'align))
13727 ((equal property "PRIORITY")
13729 (string-to-char value) ?\ ))
13730 (org-set-tags nil 'align))
13731 ((equal property "SCHEDULED")
13732 (if (re-search-forward org-scheduled-time-regexp end t)
13733 (cond
13734 ((eq value 'earlier) (org-timestamp-change -1 'day))
13735 ((eq value 'later) (org-timestamp-change 1 'day))
13736 (t (call-interactively 'org-schedule)))
13737 (call-interactively 'org-schedule)))
13738 ((equal property "DEADLINE")
13739 (if (re-search-forward org-deadline-time-regexp end t)
13740 (cond
13741 ((eq value 'earlier) (org-timestamp-change -1 'day))
13742 ((eq value 'later) (org-timestamp-change 1 'day))
13743 (t (call-interactively 'org-deadline)))
13744 (call-interactively 'org-deadline)))
13745 ((member property org-special-properties)
13746 (error "The %s property can not yet be set with `org-entry-put'"
13747 property))
13748 (t ; a non-special property
13749 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13750 (setq range (org-get-property-block beg end 'force))
13751 (goto-char (car range))
13752 (if (re-search-forward
13754 (progn
13755 (delete-region (match-beginning 1) (match-end 1))
13756 (goto-char (match-beginning 1)))
13757 (goto-char (cdr range))
13759 (backward-char 1)
13760 (org-indent-line-function)
13761 (insert ":" property ":"))
13762 (and value (insert " " value))
13763 (org-indent-line-function)))))
13764 (run-hook-with-args 'org-property-changed-functions property value)))
13766 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13767 "Get all property keys in the current buffer.
13768 With INCLUDE-SPECIALS, also list the special properties that reflect things
13769 like tags and TODO state.
13770 With INCLUDE-DEFAULTS, also include properties that has special meaning
13771 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13772 With INCLUDE-COLUMNS, also include property names given in COLUMN
13773 formats in the current buffer."
13774 (let (rtn range cfmt s p)
13775 (save-excursion
13776 (save-restriction
13777 (widen)
13778 (goto-char (point-min))
13779 (while (re-search-forward org-property-start-re nil t)
13780 (setq range (org-get-property-block))
13781 (goto-char (car range))
13782 (while (re-search-forward
13784 (cdr range) t)
13785 (add-to-list 'rtn (org-match-string-no-properties 1)))
13786 (outline-next-heading))))
13788 (when include-specials
13789 (setq rtn (append org-special-properties rtn)))
13791 (when include-defaults
13792 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13793 (add-to-list 'rtn org-effort-property))
13795 (when include-columns
13796 (save-excursion
13797 (save-restriction
13798 (widen)
13799 (goto-char (point-min))
13800 (while (re-search-forward
13802 nil t)
13803 (setq cfmt (match-string 2) s 0)
13805 cfmt s)
13806 (setq s (match-end 0)
13807 p (match-string 1 cfmt))
13808 (unless (or (equal p "ITEM")
13809 (member p org-special-properties))
13810 (add-to-list 'rtn (match-string 1 cfmt))))))))
13812 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13814 (defun org-property-values (key)
13815 "Return a list of all values of property KEY."
13816 (save-excursion
13817 (save-restriction
13818 (widen)
13819 (goto-char (point-min))
13821 values)
13822 (while (re-search-forward re nil t)
13823 (add-to-list 'values (org-trim (match-string 1))))
13824 (delete "" values)))))
13826 (defun org-insert-property-drawer ()
13827 "Insert a property drawer into the current entry."
13828 (interactive)
13829 (org-back-to-heading t)
13830 (looking-at outline-regexp)
13831 (let ((indent (if org-adapt-indentation
13832 (- (match-end 0)(match-beginning 0))
13833 0))
13834 (beg (point))
13836 end hiddenp)
13837 (outline-next-heading)
13838 (setq end (point))
13839 (goto-char beg)
13840 (while (re-search-forward re end t))
13841 (setq hiddenp (org-invisible-p))
13842 (end-of-line 1)
13845 (if (member (match-string 1) '("CLOCK:" ":END:"))
13846 ;; just skip this line
13847 (beginning-of-line 2)
13848 ;; Drawer start, find the end
13850 (beginning-of-line 1)))
13851 (org-skip-over-state-notes)
13853 (if (eq (char-before) ?*) (forward-char 1))
13855 (beginning-of-line 0)
13856 (org-indent-to-column indent)
13857 (beginning-of-line 2)
13858 (org-indent-to-column indent)
13859 (beginning-of-line 0)
13860 (if hiddenp
13861 (save-excursion
13862 (org-back-to-heading t)
13863 (hide-entry))
13864 (org-flag-drawer t))))
13866 (defun org-set-property (property value)
13867 "In the current entry, set PROPERTY to VALUE.
13868 When called interactively, this will prompt for a property name, offering
13869 completion on existing and default properties. And then it will prompt
13870 for a value, offering completion either on allowed values (via an inherited
13871 xxx_ALL property) or on existing values in other instances of this property
13872 in the current file."
13873 (interactive
13874 (let* ((completion-ignore-case t)
13875 (keys (org-buffer-property-keys nil t t))
13876 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13877 (prop (if (member prop0 keys)
13878 prop0
13879 (or (cdr (assoc (downcase prop0)
13880 (mapcar (lambda (x) (cons (downcase x) x))
13881 keys)))
13882 prop0)))
13883 (cur (org-entry-get nil prop))
13884 (prompt (concat prop " value"
13886 (concat " [" cur "]") "") ": "))
13887 (allowed (org-property-get-allowed-values nil prop 'table))
13888 (existing (mapcar 'list (org-property-values prop)))
13889 (val (if allowed
13890 (org-completing-read prompt allowed nil
13891 (not (get-text-property 0 'org-unrestricted
13892 (caar allowed))))
13893 (let (org-completion-use-ido org-completion-use-iswitchb)
13894 (org-completing-read prompt existing nil nil "" nil cur)))))
13895 (list prop (if (equal val "") cur val))))
13896 (unless (equal (org-entry-get nil property) value)
13897 (org-entry-put nil property value)))
13899 (defun org-delete-property (property)
13900 "In the current entry, delete PROPERTY."
13901 (interactive
13902 (let* ((completion-ignore-case t)
13903 (prop (org-icompleting-read "Property: "
13904 (org-entry-properties nil 'standard))))
13905 (list prop)))
13906 (message "Property %s %s" property
13907 (if (org-entry-delete nil property)
13908 "deleted"
13909 "was not present in the entry")))
13911 (defun org-delete-property-globally (property)
13912 "Remove PROPERTY globally, from all entries."
13913 (interactive
13914 (let* ((completion-ignore-case t)
13915 (prop (org-icompleting-read
13916 "Globally remove property: "
13917 (mapcar 'list (org-buffer-property-keys)))))
13918 (list prop)))
13919 (save-excursion
13920 (save-restriction
13921 (widen)
13922 (goto-char (point-min))
13923 (let ((cnt 0))
13924 (while (re-search-forward
13926 nil t)
13927 (setq cnt (1+ cnt))
13928 (replace-match ""))
13931 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13933 (defun org-compute-property-at-point ()
13934 "Compute the property at point.
13935 This looks for an enclosing column format, extracts the operator and
13936 then applies it to the property in the column format's scope."
13937 (interactive)
13938 (unless (org-at-property-p)
13939 (error "Not at a property"))
13940 (let ((prop (org-match-string-no-properties 2)))
13941 (org-columns-get-format-and-top-level)
13942 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13943 (error "No operator defined for property %s" prop))
13944 (org-columns-compute prop)))
13946 (defvar org-property-allowed-value-functions nil
13947 "Hook for functions supplying allowed values for a specific property.
13948 The functions must take a single argument, the name of the property, and
13950 the values, this means that these values are intended as defaults for
13951 completion, but that other values should be allowed too.
13952 The functions must return nil if they are not responsible for this
13953 property.")
13955 (defun org-property-get-allowed-values (pom property &optional table)
13956 "Get allowed values for the property PROPERTY.
13957 When TABLE is non-nil, return an alist that can directly be used for
13958 completion."
13959 (let (vals)
13960 (cond
13961 ((equal property "TODO")
13962 (setq vals (org-with-point-at pom
13963 (append org-todo-keywords-1 '("")))))
13964 ((equal property "PRIORITY")
13965 (let ((n org-lowest-priority))
13966 (while (>= n org-highest-priority)
13967 (push (char-to-string n) vals)
13968 (setq n (1- n)))))
13969 ((member property org-special-properties))
13970 ((setq vals (run-hook-with-args-until-success
13971 'org-property-allowed-value-functions property)))
13972 (t
13973 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13975 (setq vals (car (read-from-string (concat "(" vals ")"))))
13976 (setq vals (mapcar (lambda (x)
13977 (cond ((stringp x) x)
13978 ((numberp x) (number-to-string x))
13979 ((symbolp x) (symbol-name x))
13980 (t "???")))
13981 vals)))))
13982 (when (member ":ETC" vals)
13983 (setq vals (remove ":ETC" vals))
13984 (org-add-props (car vals) '(org-unrestricted t)))
13985 (if table (mapcar 'list vals) vals)))
13987 (defun org-property-previous-allowed-value (&optional previous)
13988 "Switch to the next allowed value for this property."
13989 (interactive)
13990 (org-property-next-allowed-value t))
13992 (defun org-property-next-allowed-value (&optional previous)
13993 "Switch to the next allowed value for this property."
13994 (interactive)
13995 (unless (org-at-property-p)
13996 (error "Not at a property"))
13997 (let* ((key (match-string 2))
13998 (value (match-string 3))
13999 (allowed (or (org-property-get-allowed-values (point) key)
14000 (and (member value '("[ ]" "[-]" "[X]"))
14001 '("[ ]" "[X]"))))
14002 nval)
14003 (unless allowed
14004 (error "Allowed values for this property have not been defined"))
14005 (if previous (setq allowed (reverse allowed)))
14006 (if (member value allowed)
14007 (setq nval (car (cdr (member value allowed)))))
14008 (setq nval (or nval (car allowed)))
14009 (if (equal nval value)
14010 (error "Only one allowed value for this property"))
14011 (org-at-property-p)
14012 (replace-match (concat " :" key ": " nval) t t)
14013 (org-indent-line-function)
14014 (beginning-of-line 1)
14016 (run-hook-with-args 'org-property-changed-functions key nval)))
14018 (defun org-find-olp (path &optional this-buffer)
14019 "Return a marker pointing to the entry at outline path OLP.
14020 If anything goes wrong, throw an error.
14021 You can wrap this call to catch the error like this:
14023 (condition-case msg
14024 (org-mobile-locate-entry (match-string 4))
14025 (error (nth 1 msg)))
14027 The return value will then be either a string with the error message,
14028 or a marker if everything is OK.
14030 If THIS-BUFFER is set, the outline path does not contain a file,
14031 only headings."
14032 (let* ((file (if this-buffer buffer-file-name (pop path)))
14033 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14034 (level 1)
14035 (lmin 1)
14036 (lmax 1)
14037 limit re end found pos heading cnt)
14038 (unless buffer (error "File not found :%s" file))
14039 (with-current-buffer buffer
14040 (save-excursion
14041 (save-restriction
14042 (widen)
14043 (setq limit (point-max))
14044 (goto-char (point-min))
14045 (while (setq heading (pop path))
14046 (setq re (format org-complex-heading-regexp-format
14047 (regexp-quote heading)))
14048 (setq cnt 0 pos (point))
14049 (while (re-search-forward re end t)
14050 (setq level (- (match-end 1) (match-beginning 1)))
14051 (if (and (>= level lmin) (<= level lmax))
14052 (setq found (match-beginning 0) cnt (1+ cnt))))
14053 (when (= cnt 0) (error "Heading not found on level %d: %s"
14054 lmax heading))
14055 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14056 lmax heading))
14057 (goto-char found)
14058 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14059 (setq end (save-excursion (org-end-of-subtree t t))))
14060 (when (org-on-heading-p)
14061 (move-marker (make-marker) (point))))))))
14063 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14064 "Find node HEADING in BUFFER.
14065 Return a marker to the heading if it was found, or nil if not.
14066 If POS-ONLY is set, return just the position instead of a marker.
14068 The heading text must match exact, but it may have a TODO keyword,
14069 a priority cookie and tags in the standard locations."
14070 (with-current-buffer (or buffer (current-buffer))
14071 (save-excursion
14072 (save-restriction
14073 (widen)
14074 (goto-char (point-min))
14075 (let (case-fold-search)
14076 (if (re-search-forward
14077 (format org-complex-heading-regexp-format
14078 (regexp-quote heading)) nil t)
14079 (if pos-only
14080 (match-beginning 0)
14081 (move-marker (make-marker) (match-beginning 0)))))))))
14083 (defun org-find-exact-heading-in-directory (heading &optional dir)
14084 "Find Org node headline HEADING in all .org files in directory DIR.
14085 When the target headline is found, return a marker to this location."
14086 (let ((files (directory-files (or dir default-directory)
14088 file visiting m buffer)
14089 (catch 'found
14090 (while (setq file (pop files))
14091 (message "trying %s" file)
14092 (setq visiting (org-find-base-buffer-visiting file))
14093 (setq buffer (or visiting (find-file-noselect file)))
14094 (setq m (org-find-exact-headline-in-buffer
14095 heading buffer))
14096 (when (and (not m) (not visiting)) (kill-buffer buffer))
14097 (and m (throw 'found m))))))
14099 (defun org-find-entry-with-id (ident)
14100 "Locate the entry that contains the ID property with exact value IDENT.
14101 IDENT can be a string, a symbol or a number, this function will search for
14102 the string representation of it.
14103 Return the position where this entry starts, or nil if there is no such entry."
14104 (interactive "sID: ")
14105 (let ((id (cond
14106 ((stringp ident) ident)
14107 ((symbol-name ident) (symbol-name ident))
14108 ((numberp ident) (number-to-string ident))
14109 (t (error "IDENT %s must be a string, symbol or number" ident))))
14110 (case-fold-search nil))
14111 (save-excursion
14112 (save-restriction
14113 (widen)
14114 (goto-char (point-min))
14115 (when (re-search-forward
14117 nil t)
14118 (org-back-to-heading t)
14119 (point))))))
14121 ;;;; Timestamps
14123 (defvar org-last-changed-timestamp nil)
14124 (defvar org-last-inserted-timestamp nil
14125 "The last time stamp inserted with `org-insert-time-stamp'.")
14126 (defvar org-time-was-given) ; dynamically scoped parameter
14127 (defvar org-end-time-was-given) ; dynamically scoped parameter
14128 (defvar org-ts-what) ; dynamically scoped parameter
14130 (defun org-time-stamp (arg &optional inactive)
14131 "Prompt for a date/time and insert a time stamp.
14132 If the user specifies a time like HH:MM, or if this command is called
14133 with a prefix argument, the time stamp will contain date and time.
14134 Otherwise, only the date will be included. All parts of a date not
14135 specified by the user will be filled in from the current date/time.
14136 So if you press just return without typing anything, the time stamp
14137 will represent the current date/time. If there is already a timestamp
14138 at the cursor, it will be modified."
14139 (interactive "P")
14140 (let* ((ts nil)
14141 (default-time
14142 ;; Default time is either today, or, when entering a range,
14143 ;; the range start.
14144 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14145 (save-excursion
14146 (re-search-backward
14148 (- (point) 20) t)))
14149 (apply 'encode-time (org-parse-time-string (match-string 1)))
14150 (current-time)))
14151 (default-input (and ts (org-get-compact-tod ts)))
14152 org-time-was-given org-end-time-was-given time)
14153 (cond
14154 ((and (org-at-timestamp-p t)
14155 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14156 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14157 (insert "--")
14158 (setq time (let ((this-command this-command))
14159 (org-read-date arg 'totime nil nil
14160 default-time default-input)))
14161 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14162 ((org-at-timestamp-p t)
14163 (setq time (let ((this-command this-command))
14164 (org-read-date arg 'totime nil nil default-time default-input)))
14165 (when (org-at-timestamp-p t) ; just to get the match data
14166 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14167 (replace-match "")
14168 (setq org-last-changed-timestamp
14169 (org-insert-time-stamp
14170 time (or org-time-was-given arg)
14171 inactive nil nil (list org-end-time-was-given))))
14172 (message "Timestamp updated"))
14173 (t
14174 (setq time (let ((this-command this-command))
14175 (org-read-date arg 'totime nil nil default-time default-input)))
14176 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14177 nil nil (list org-end-time-was-given))))))
14179 ;; FIXME: can we use this for something else, like computing time differences?
14180 (defun org-get-compact-tod (s)
14181 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14182 (let* ((t1 (match-string 1 s))
14183 (h1 (string-to-number (match-string 2 s)))
14184 (m1 (string-to-number (match-string 3 s)))
14185 (t2 (and (match-end 4) (match-string 5 s)))
14186 (h2 (and t2 (string-to-number (match-string 6 s))))
14187 (m2 (and t2 (string-to-number (match-string 7 s))))
14188 dh dm)
14189 (if (not t2)
14190 t1
14191 (setq dh (- h2 h1) dm (- m2 m1))
14192 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14193 (concat t1 "+" (number-to-string dh)
14194 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14196 (defun org-time-stamp-inactive (&optional arg)
14197 "Insert an inactive time stamp.
14198 An inactive time stamp is enclosed in square brackets instead of angle
14199 brackets. It is inactive in the sense that it does not trigger agenda entries,
14200 does not link to the calendar and cannot be changed with the S-cursor keys.
14201 So these are more for recording a certain time/date."
14202 (interactive "P")
14203 (org-time-stamp arg 'inactive))
14205 (defvar org-date-ovl (make-overlay 1 1))
14206 (overlay-put org-date-ovl 'face 'org-warning)
14207 (org-detach-overlay org-date-ovl)
14209 (defvar org-ans1) ; dynamically scoped parameter
14210 (defvar org-ans2) ; dynamically scoped parameter
14212 (defvar org-plain-time-of-day-regexp) ; defined below
14214 (defvar org-overriding-default-time nil) ; dynamically scoped
14215 (defvar org-read-date-overlay nil)
14216 (defvar org-dcst nil) ; dynamically scoped
14217 (defvar org-read-date-history nil)
14218 (defvar org-read-date-final-answer nil)
14220 (defun org-read-date (&optional with-time to-time from-string prompt
14221 default-time default-input)
14222 "Read a date, possibly a time, and make things smooth for the user.
14223 The prompt will suggest to enter an ISO date, but you can also enter anything
14224 which will at least partially be understood by `parse-time-string'.
14225 Unrecognized parts of the date will default to the current day, month, year,
14226 hour and minute. If this command is called to replace a timestamp at point,
14227 of to enter the second timestamp of a range, the default time is taken
14228 from the existing stamp. Furthermore, the command prefers the future,
14229 so if you are giving a date where the year is not given, and the day-month
14230 combination is already past in the current year, it will assume you
14231 mean next year. For details, see the manual. A few examples:
14233 3-2-5 --> 2003-02-05
14234 feb 15 --> currentyear-02-15
14235 2/15 --> currentyear-02-15
14236 sep 12 9 --> 2009-09-12
14237 12:45 --> today 12:45
14238 22 sept 0:34 --> currentyear-09-22 0:34
14239 12 --> currentyear-currentmonth-12
14240 Fri --> nearest Friday (today or later)
14241 etc.
14243 Furthermore you can specify a relative date by giving, as the *first* thing
14244 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14245 change in days weeks, months, years.
14246 With a single plus or minus, the date is relative to today. With a double
14247 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14248 +4d --> four days from today
14249 +4 --> same as above
14250 +2w --> two weeks from today
14251 ++5 --> five days from default date
14253 The function understands only English month and weekday abbreviations,
14254 but this can be configured with the variables `parse-time-months' and
14255 `parse-time-weekdays'.
14257 While prompting, a calendar is popped up - you can also select the
14258 date with the mouse (button 1). The calendar shows a period of three
14259 months. To scroll it to other months, use the keys `>' and `<'.
14260 If you don't like the calendar, turn it off with
14261 \(setq org-read-date-popup-calendar nil)
14263 With optional argument TO-TIME, the date will immediately be converted
14264 to an internal time.
14265 With an optional argument WITH-TIME, the prompt will suggest to also
14266 insert a time. Note that when WITH-TIME is not set, you can still
14267 enter a time, and this function will inform the calling routine about
14268 this change. The calling routine may then choose to change the format
14269 used to insert the time stamp into the buffer to include the time.
14270 With optional argument FROM-STRING, read from this string instead from
14271 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14272 the time/date that is used for everything that is not specified by the
14273 user."
14274 (require 'parse-time)
14275 (let* ((org-time-stamp-rounding-minutes
14276 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14277 (org-dcst org-display-custom-times)
14278 (ct (org-current-time))
14279 (def (or org-overriding-default-time default-time ct))
14280 (defdecode (decode-time def))
14281 (dummy (progn
14282 (when (< (nth 2 defdecode) org-extend-today-until)
14283 (setcar (nthcdr 2 defdecode) -1)
14284 (setcar (nthcdr 1 defdecode) 59)
14285 (setq def (apply 'encode-time defdecode)
14286 defdecode (decode-time def)))))
14287 (calendar-frame-setup nil)
14288 (calendar-setup nil)
14289 (calendar-move-hook nil)
14290 (calendar-view-diary-initially-flag nil)
14291 (calendar-view-holidays-initially-flag nil)
14292 (timestr (format-time-string
14293 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14294 (prompt (concat (if prompt (concat prompt " ") "")
14295 (format "Date+time [%s]: " timestr)))
14296 ans (org-ans0 "") org-ans1 org-ans2 final)
14298 (cond
14299 (from-string (setq ans from-string))
14300 (org-read-date-popup-calendar
14301 (save-excursion
14302 (save-window-excursion
14303 (calendar)
14304 (calendar-forward-day (- (time-to-days def)
14305 (calendar-absolute-from-gregorian
14306 (calendar-current-date))))
14307 (org-eval-in-calendar nil t)
14308 (let* ((old-map (current-local-map))
14309 (map (copy-keymap calendar-mode-map))
14310 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14311 (org-defkey map (kbd "RET") 'org-calendar-select)
14312 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14313 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14314 (org-defkey minibuffer-local-map [(meta shift left)]
14315 (lambda () (interactive)
14316 (org-eval-in-calendar '(calendar-backward-month 1))))
14317 (org-defkey minibuffer-local-map [(meta shift right)]
14318 (lambda () (interactive)
14319 (org-eval-in-calendar '(calendar-forward-month 1))))
14320 (org-defkey minibuffer-local-map [(meta shift up)]
14321 (lambda () (interactive)
14322 (org-eval-in-calendar '(calendar-backward-year 1))))
14323 (org-defkey minibuffer-local-map [(meta shift down)]
14324 (lambda () (interactive)
14325 (org-eval-in-calendar '(calendar-forward-year 1))))
14326 (org-defkey minibuffer-local-map [?\e (shift left)]
14327 (lambda () (interactive)
14328 (org-eval-in-calendar '(calendar-backward-month 1))))
14329 (org-defkey minibuffer-local-map [?\e (shift right)]
14330 (lambda () (interactive)
14331 (org-eval-in-calendar '(calendar-forward-month 1))))
14332 (org-defkey minibuffer-local-map [?\e (shift up)]
14333 (lambda () (interactive)
14334 (org-eval-in-calendar '(calendar-backward-year 1))))
14335 (org-defkey minibuffer-local-map [?\e (shift down)]
14336 (lambda () (interactive)
14337 (org-eval-in-calendar '(calendar-forward-year 1))))
14338 (org-defkey minibuffer-local-map [(shift up)]
14339 (lambda () (interactive)
14340 (org-eval-in-calendar '(calendar-backward-week 1))))
14341 (org-defkey minibuffer-local-map [(shift down)]
14342 (lambda () (interactive)
14343 (org-eval-in-calendar '(calendar-forward-week 1))))
14344 (org-defkey minibuffer-local-map [(shift left)]
14345 (lambda () (interactive)
14346 (org-eval-in-calendar '(calendar-backward-day 1))))
14347 (org-defkey minibuffer-local-map [(shift right)]
14348 (lambda () (interactive)
14349 (org-eval-in-calendar '(calendar-forward-day 1))))
14350 (org-defkey minibuffer-local-map ">"
14351 (lambda () (interactive)
14352 (org-eval-in-calendar '(scroll-calendar-left 1))))
14353 (org-defkey minibuffer-local-map "<"
14354 (lambda () (interactive)
14355 (org-eval-in-calendar '(scroll-calendar-right 1))))
14356 (org-defkey minibuffer-local-map "\C-v"
14357 (lambda () (interactive)
14358 (org-eval-in-calendar
14359 '(calendar-scroll-left-three-months 1))))
14360 (org-defkey minibuffer-local-map "\M-v"
14361 (lambda () (interactive)
14362 (org-eval-in-calendar
14363 '(calendar-scroll-right-three-months 1))))
14364 (run-hooks 'org-read-date-minibuffer-setup-hook)
14365 (unwind-protect
14366 (progn
14367 (use-local-map map)
14368 (add-hook 'post-command-hook 'org-read-date-display)
14369 (setq org-ans0 (read-string prompt default-input
14370 'org-read-date-history nil))
14371 ;; org-ans0: from prompt
14372 ;; org-ans1: from mouse click
14373 ;; org-ans2: from calendar motion
14374 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14375 (remove-hook 'post-command-hook 'org-read-date-display)
14376 (use-local-map old-map)
14377 (when org-read-date-overlay
14378 (delete-overlay org-read-date-overlay)
14379 (setq org-read-date-overlay nil)))))))
14381 (t ; Naked prompt only
14382 (unwind-protect
14383 (setq ans (read-string prompt default-input
14384 'org-read-date-history timestr))
14385 (when org-read-date-overlay
14386 (delete-overlay org-read-date-overlay)
14387 (setq org-read-date-overlay nil)))))
14389 (setq final (org-read-date-analyze ans def defdecode))
14391 ;; One round trip to get rid of 34th of August and stuff like that....
14392 (setq final (decode-time (apply 'encode-time final)))
14394 (setq org-read-date-final-answer ans)
14396 (if to-time
14397 (apply 'encode-time final)
14398 (if (and (boundp 'org-time-was-given) org-time-was-given)
14399 (format "%04d-%02d-%02d %02d:%02d"
14400 (nth 5 final) (nth 4 final) (nth 3 final)
14401 (nth 2 final) (nth 1 final))
14402 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14404 (defvar def)
14405 (defvar defdecode)
14406 (defvar with-time)
14407 (defvar org-read-date-analyze-futurep nil)
14408 (defun org-read-date-display ()
14409 "Display the current date prompt interpretation in the minibuffer."
14410 (when org-read-date-display-live
14411 (when org-read-date-overlay
14412 (delete-overlay org-read-date-overlay))
14413 (let ((p (point)))
14414 (end-of-line 1)
14415 (while (not (equal (buffer-substring
14416 (max (point-min) (- (point) 4)) (point))
14417 " "))
14418 (insert " "))
14419 (goto-char p))
14420 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14421 " " (or org-ans1 org-ans2)))
14422 (org-end-time-was-given nil)
14423 (f (org-read-date-analyze ans def defdecode))
14424 (fmts (if org-dcst
14425 org-time-stamp-custom-formats
14426 org-time-stamp-formats))
14427 (fmt (if (or with-time
14428 (and (boundp 'org-time-was-given) org-time-was-given))
14429 (cdr fmts)
14430 (car fmts)))
14431 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14432 (when (and org-end-time-was-given
14433 (string-match org-plain-time-of-day-regexp txt))
14434 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14435 org-end-time-was-given
14436 (substring txt (match-end 0)))))
14437 (when org-read-date-analyze-futurep
14438 (setq txt (concat txt " (=>F)")))
14439 (setq org-read-date-overlay
14440 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14441 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14443 (defun org-read-date-analyze (ans def defdecode)
14444 "Analyze the combined answer of the date prompt."
14445 ;; FIXME: cleanup and comment
14446 (let ((nowdecode (decode-time (current-time)))
14447 delta deltan deltaw deltadef year month day
14448 hour minute second wday pm h2 m2 tl wday1
14449 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14450 (setq org-read-date-analyze-futurep nil)
14452 (setq ans "+0"))
14454 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14455 (setq ans (replace-match "" t t ans)
14456 deltan (car delta)
14457 deltaw (nth 1 delta)
14458 deltadef (nth 2 delta)))
14460 ;; Check if there is an iso week date in there
14461 ;; If yes, store the info and postpone interpreting it until the rest
14462 ;; of the parsing is done
14463 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14464 (setq iso-year (if (match-end 1)
14465 (org-small-year-to-year
14466 (string-to-number (match-string 1 ans))))
14467 iso-weekday (if (match-end 3)
14468 (string-to-number (match-string 3 ans)))
14469 iso-week (string-to-number (match-string 2 ans)))
14470 (setq ans (replace-match "" t t ans)))
14472 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14473 (when (string-match
14475 (setq year (if (match-end 2)
14476 (string-to-number (match-string 2 ans))
14477 (progn (setq kill-year t)
14478 (string-to-number (format-time-string "%Y"))))
14479 month (string-to-number (match-string 3 ans))
14480 day (string-to-number (match-string 4 ans)))
14481 (if (< year 100) (setq year (+ 2000 year)))
14483 t nil ans)))
14484 ;; Help matching american dates, like 5/30 or 5/30/7
14485 (when (string-match
14486 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14487 (setq year (if (match-end 4)
14488 (string-to-number (match-string 4 ans))
14489 (progn (setq kill-year t)
14490 (string-to-number (format-time-string "%Y"))))
14491 month (string-to-number (match-string 1 ans))
14492 day (string-to-number (match-string 2 ans)))
14493 (if (< year 100) (setq year (+ 2000 year)))
14495 t nil ans)))
14496 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14497 ;; If there is a time with am/pm, and *no* time without it, we convert
14498 ;; so that matching will be successful.
14499 (loop for i from 1 to 2 do ; twice, for end time as well
14502 (setq hour (string-to-number (match-string 1 ans))
14503 minute (if (match-end 3)
14504 (string-to-number (match-string 3 ans))
14505 0)
14506 pm (equal ?p
14507 (string-to-char (downcase (match-string 4 ans)))))
14508 (if (and (= hour 12) (not pm))
14509 (setq hour 0)
14510 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14511 (setq ans (replace-match (format "%02d:%02d" hour minute)
14512 t t ans))))
14514 ;; Check if a time range is given as a duration
14515 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14516 (setq hour (string-to-number (match-string 1 ans))
14517 h2 (+ hour (string-to-number (match-string 3 ans)))
14518 minute (string-to-number (match-string 2 ans))
14519 m2 (+ minute (if (match-end 5) (string-to-number
14520 (match-string 5 ans))0)))
14521 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14522 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14523 t t ans)))
14525 ;; Check if there is a time range
14526 (when (boundp 'org-end-time-was-given)
14527 (setq org-time-was-given nil)
14528 (when (and (string-match org-plain-time-of-day-regexp ans)
14529 (match-end 8))
14530 (setq org-end-time-was-given (match-string 8 ans))
14531 (setq ans (concat (substring ans 0 (match-beginning 7))
14532 (substring ans (match-end 7))))))
14534 (setq tl (parse-time-string ans)
14535 day (or (nth 3 tl) (nth 3 defdecode))
14536 month (or (nth 4 tl)
14537 (if (and org-read-date-prefer-future
14538 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14539 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14540 (nth 4 defdecode)))
14541 year (or (and (not kill-year) (nth 5 tl))
14542 (if (and org-read-date-prefer-future
14543 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14544 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14545 (nth 5 defdecode)))
14546 hour (or (nth 2 tl) (nth 2 defdecode))
14547 minute (or (nth 1 tl) (nth 1 defdecode))
14548 second (or (nth 0 tl) 0)
14549 wday (nth 6 tl))
14551 (when (and (eq org-read-date-prefer-future 'time)
14552 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14553 (equal day (nth 3 nowdecode))
14554 (equal month (nth 4 nowdecode))
14555 (equal year (nth 5 nowdecode))
14556 (nth 2 tl)
14557 (or (< (nth 2 tl) (nth 2 nowdecode))
14558 (and (= (nth 2 tl) (nth 2 nowdecode))
14559 (nth 1 tl)
14560 (< (nth 1 tl) (nth 1 nowdecode)))))
14561 (setq day (1+ day)
14562 futurep t))
14564 ;; Special date definitions below
14565 (cond
14566 (iso-week
14567 ;; There was an iso week
14568 (require 'cal-iso)
14569 (setq futurep nil)
14570 (setq year (or iso-year year)
14571 day (or iso-weekday wday 1)
14572 wday nil ; to make sure that the trigger below does not match
14573 iso-date (calendar-gregorian-from-absolute
14574 (calendar-absolute-from-iso
14575 (list iso-week day year))))
14576 ; FIXME: Should we also push ISO weeks into the future?
14577 ; (when (and org-read-date-prefer-future
14578 ; (not iso-year)
14579 ; (< (calendar-absolute-from-gregorian iso-date)
14580 ; (time-to-days (current-time))))
14581 ; (setq year (1+ year)
14582 ; iso-date (calendar-gregorian-from-absolute
14583 ; (calendar-absolute-from-iso
14584 ; (list iso-week day year)))))
14585 (setq month (car iso-date)
14586 year (nth 2 iso-date)
14587 day (nth 1 iso-date)))
14588 (deltan
14589 (setq futurep nil)
14590 (unless deltadef
14591 (let ((now (decode-time (current-time))))
14592 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14593 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14594 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14595 ((equal deltaw "m") (setq month (+ month deltan)))
14596 ((equal deltaw "y") (setq year (+ year deltan)))))
14597 ((and wday (not (nth 3 tl)))
14598 (setq futurep nil)
14599 ;; Weekday was given, but no day, so pick that day in the week
14600 ;; on or after the derived date.
14601 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14602 (unless (equal wday wday1)
14603 (setq day (+ day (% (- wday wday1 -7) 7))))))
14604 (if (and (boundp 'org-time-was-given)
14605 (nth 2 tl))
14606 (setq org-time-was-given t))
14607 (if (< year 100) (setq year (+ 2000 year)))
14608 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14609 (setq org-read-date-analyze-futurep futurep)
14610 (list second minute hour day month year)))
14612 (defvar parse-time-weekdays)
14614 (defun org-read-date-get-relative (s today default)
14615 "Check string S for special relative date string.
14616 TODAY and DEFAULT are internal times, for today and for a default.
14617 Return shift list (N what def-flag)
14619 N is the number of WHATs to shift.
14620 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14621 the DEFAULT date rather than TODAY."
14622 (when (and
14623 (string-match
14624 (concat
14629 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14630 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14631 (string-to-char (substring (match-string 1 s) -1))
14632 ?+))
14633 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14634 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14635 (what (if (match-end 3) (match-string 3 s) "d"))
14636 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14637 (date (if rel default today))
14638 (wday (nth 6 (decode-time date)))
14639 delta)
14640 (if wday1
14641 (progn
14642 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14643 (if (= dir ?-) (setq delta (- delta 7)))
14644 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14645 (list delta "d" rel))
14646 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14648 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14649 "Turn a user-specified date into the internal representation.
14650 The internal representation needed by the calendar is (month day year).
14651 This is a wrapper to handle the brain-dead convention in calendar that
14652 user function argument order change dependent on argument order."
14653 (if (boundp 'calendar-date-style)
14654 (cond
14655 ((eq calendar-date-style 'american)
14656 (list arg1 arg2 arg3))
14657 ((eq calendar-date-style 'european)
14658 (list arg2 arg1 arg3))
14659 ((eq calendar-date-style 'iso)
14660 (list arg2 arg3 arg1)))
14661 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14662 (if (org-bound-and-true-p european-calendar-style)
14663 (list arg2 arg1 arg3)
14664 (list arg1 arg2 arg3)))))
14666 (defun org-eval-in-calendar (form &optional keepdate)
14667 "Eval FORM in the calendar window and return to current window.
14668 Also, store the cursor date in variable org-ans2."
14669 (let ((sf (selected-frame))
14670 (sw (selected-window)))
14671 (select-window (get-buffer-window "*Calendar*" t))
14672 (eval form)
14673 (when (and (not keepdate) (calendar-cursor-to-date))
14674 (let* ((date (calendar-cursor-to-date))
14675 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14676 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14677 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14678 (select-window sw)
14679 (org-select-frame-set-input-focus sf)))
14681 (defun org-calendar-select ()
14682 "Return to `org-read-date' with the date currently selected.
14683 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14684 (interactive)
14685 (when (calendar-cursor-to-date)
14686 (let* ((date (calendar-cursor-to-date))
14687 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14688 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14689 (if (active-minibuffer-window) (exit-minibuffer))))
14691 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14692 "Insert a date stamp for the date given by the internal TIME.
14693 WITH-HM means use the stamp format that includes the time of the day.
14694 INACTIVE means use square brackets instead of angular ones, so that the
14695 stamp will not contribute to the agenda.
14696 PRE and POST are optional strings to be inserted before and after the
14697 stamp.
14698 The command returns the inserted time stamp."
14699 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14700 stamp)
14701 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14702 (insert-before-markers (or pre ""))
14703 (when (listp extra)
14704 (setq extra (car extra))
14705 (if (and (stringp extra)
14707 (setq extra (format "-%02d:%02d"
14708 (string-to-number (match-string 1 extra))
14709 (string-to-number (match-string 2 extra))))
14710 (setq extra nil)))
14711 (when extra
14712 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14713 (insert-before-markers (setq stamp (format-time-string fmt time)))
14714 (insert-before-markers (or post ""))
14715 (setq org-last-inserted-timestamp stamp)))
14717 (defun org-toggle-time-stamp-overlays ()
14718 "Toggle the use of custom time stamp formats."
14719 (interactive)
14720 (setq org-display-custom-times (not org-display-custom-times))
14721 (unless org-display-custom-times
14722 (let ((p (point-min)) (bmp (buffer-modified-p)))
14723 (while (setq p (next-single-property-change p 'display))
14724 (if (and (get-text-property p 'display)
14725 (eq (get-text-property p 'face) 'org-date))
14726 (remove-text-properties
14727 p (setq p (next-single-property-change p 'display))
14728 '(display t))))
14729 (set-buffer-modified-p bmp)))
14730 (if (featurep 'xemacs)
14731 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14732 (org-restart-font-lock)
14733 (setq org-table-may-need-update t)
14734 (if org-display-custom-times
14735 (message "Time stamps are overlayed with custom format")
14736 (message "Time stamp overlays removed")))
14738 (defun org-display-custom-time (beg end)
14739 "Overlay modified time stamp format over timestamp between BEG and END."
14740 (let* ((ts (buffer-substring beg end))
14741 t1 w1 with-hm tf time str w2 (off 0))
14742 (save-match-data
14743 (setq t1 (org-parse-time-string ts t))
14744 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14745 (setq off (- (match-end 0) (match-beginning 0)))))
14746 (setq end (- end off))
14747 (setq w1 (- end beg)
14748 with-hm (and (nth 1 t1) (nth 2 t1))
14749 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14750 time (org-fix-decoded-time t1)
14751 str (org-add-props
14752 (format-time-string
14753 (substring tf 1 -1) (apply 'encode-time time))
14754 nil 'mouse-face 'highlight)
14755 w2 (length str))
14756 (if (not (= w2 w1))
14757 (add-text-properties (1+ beg) (+ 2 beg)
14758 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14759 (if (featurep 'xemacs)
14760 (progn
14761 (put-text-property beg end 'invisible t)
14762 (put-text-property beg end 'end-glyph (make-glyph str)))
14763 (put-text-property beg end 'display str))))
14765 (defun org-translate-time (string)
14766 "Translate all timestamps in STRING to custom format.
14767 But do this only if the variable `org-display-custom-times' is set."
14768 (when org-display-custom-times
14769 (save-match-data
14770 (let* ((start 0)
14771 (re org-ts-regexp-both)
14772 t1 with-hm inactive tf time str beg end)
14773 (while (setq start (string-match re string start))
14774 (setq beg (match-beginning 0)
14775 end (match-end 0)
14776 t1 (save-match-data
14777 (org-parse-time-string (substring string beg end) t))
14778 with-hm (and (nth 1 t1) (nth 2 t1))
14779 inactive (equal (substring string beg (1+ beg)) "[")
14780 tf (funcall (if with-hm 'cdr 'car)
14781 org-time-stamp-custom-formats)
14782 time (org-fix-decoded-time t1)
14783 str (format-time-string
14784 (concat
14785 (if inactive "[" "<") (substring tf 1 -1)
14786 (if inactive "]" ">"))
14787 (apply 'encode-time time))
14788 string (replace-match str t t string)
14789 start (+ start (length str)))))))
14790 string)
14792 (defun org-fix-decoded-time (time)
14793 "Set 0 instead of nil for the first 6 elements of time.
14794 Don't touch the rest."
14795 (let ((n 0))
14796 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14798 (defun org-days-to-time (timestamp-string)
14799 "Difference between TIMESTAMP-STRING and now in days."
14800 (- (time-to-days (org-time-string-to-time timestamp-string))
14801 (time-to-days (current-time))))
14803 (defun org-deadline-close (timestamp-string &optional ndays)
14804 "Is the time in TIMESTAMP-STRING close to the current date?"
14805 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14806 (and (< (org-days-to-time timestamp-string) ndays)
14807 (not (org-entry-is-done-p))))
14809 (defun org-get-wdays (ts)
14810 "Get the deadline lead time appropriate for timestring TS."
14811 (cond
14812 ((<= org-deadline-warning-days 0)
14813 ;; 0 or negative, enforce this value no matter what
14814 (- org-deadline-warning-days))
14816 ;; lead time is specified.
14817 (floor (* (string-to-number (match-string 1 ts))
14818 (cdr (assoc (match-string 2 ts)
14819 '(("d" . 1) ("w" . 7)
14820 ("m" . 30.4) ("y" . 365.25)))))))
14821 ;; go for the default.
14822 (t org-deadline-warning-days)))
14824 (defun org-calendar-select-mouse (ev)
14825 "Return to `org-read-date' with the date currently selected.
14826 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14827 (interactive "e")
14828 (mouse-set-point ev)
14829 (when (calendar-cursor-to-date)
14830 (let* ((date (calendar-cursor-to-date))
14831 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14832 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14833 (if (active-minibuffer-window) (exit-minibuffer))))
14835 (defun org-check-deadlines (ndays)
14836 "Check if there are any deadlines due or past due.
14837 A deadline is considered due if it happens within `org-deadline-warning-days'
14838 days from today's date. If the deadline appears in an entry marked DONE,
14839 it is not shown. The prefix arg NDAYS can be used to test that many
14841 (interactive "P")
14842 (let* ((org-warn-days
14843 (cond
14844 ((equal ndays '(4)) 100000)
14845 (ndays (prefix-numeric-value ndays))
14846 (t (abs org-deadline-warning-days))))
14847 (case-fold-search nil)
14849 (callback
14850 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14852 (message "%d deadlines past-due or due within %d days"
14853 (org-occur regexp nil callback)
14854 org-warn-days)))
14856 (defun org-check-before-date (date)
14857 "Check if there are deadlines or scheduled entries before DATE."
14858 (interactive (list (org-read-date)))
14859 (let ((case-fold-search nil)
14863 (callback
14864 (lambda () (time-less-p
14865 (org-time-string-to-time (match-string 2))
14866 (org-time-string-to-time date)))))
14867 (message "%d entries before %s"
14868 (org-occur regexp nil callback) date)))
14870 (defun org-check-after-date (date)
14871 "Check if there are deadlines or scheduled entries after DATE."
14872 (interactive (list (org-read-date)))
14873 (let ((case-fold-search nil)
14877 (callback
14878 (lambda () (not
14879 (time-less-p
14880 (org-time-string-to-time (match-string 2))
14881 (org-time-string-to-time date))))))
14882 (message "%d entries after %s"
14883 (org-occur regexp nil callback) date)))
14885 (defun org-evaluate-time-range (&optional to-buffer)
14886 "Evaluate a time range by computing the difference between start and end.
14887 Normally the result is just printed in the echo area, but with prefix arg
14888 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14889 If the time range is actually in a table, the result is inserted into the
14890 next column.
14891 For time difference computation, a year is assumed to be exactly 365
14892 days in order to avoid rounding problems."
14893 (interactive "P")
14894 (or
14895 (org-clock-update-time-maybe)
14896 (save-excursion
14897 (unless (org-at-date-range-p t)
14898 (goto-char (point-at-bol))
14899 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14900 (if (not (org-at-date-range-p t))
14901 (error "Not at a time-stamp range, and none found in current line")))
14902 (let* ((ts1 (match-string 1))
14903 (ts2 (match-string 2))
14904 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14905 (match-end (match-end 0))
14906 (time1 (org-time-string-to-time ts1))
14907 (time2 (org-time-string-to-time ts2))
14908 (t1 (org-float-time time1))
14909 (t2 (org-float-time time2))
14910 (diff (abs (- t2 t1)))
14911 (negative (< (- t2 t1) 0))
14912 ;; (ys (floor (* 365 24 60 60)))
14913 (ds (* 24 60 60))
14914 (hs (* 60 60))
14915 (fy "%dy %dd %02d:%02d")
14916 (fy1 "%dy %dd")
14917 (fd "%dd %02d:%02d")
14918 (fd1 "%dd")
14919 (fh "%02d:%02d")
14920 y d h m align)
14921 (if havetime
14922 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14923 y 0
14924 d (floor (/ diff ds)) diff (mod diff ds)
14925 h (floor (/ diff hs)) diff (mod diff hs)
14926 m (floor (/ diff 60)))
14927 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14928 y 0
14929 d (floor (+ (/ diff ds) 0.5))
14930 h 0 m 0))
14931 (if (not to-buffer)
14932 (message "%s" (org-make-tdiff-string y d h m))
14933 (if (org-at-table-p)
14934 (progn
14935 (goto-char match-end)
14936 (setq align t)
14937 (and (looking-at " *|") (goto-char (match-end 0))))
14938 (goto-char match-end))
14939 (if (looking-at
14941 (replace-match ""))
14942 (if negative (insert " -"))
14943 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14944 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14945 (insert " " (format fh h m))))
14946 (if align (org-table-align))
14947 (message "Time difference inserted")))))
14949 (defun org-make-tdiff-string (y d h m)
14950 (let ((fmt "")
14951 (l nil))
14952 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14953 l (push y l)))
14954 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14955 l (push d l)))
14956 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14957 l (push h l)))
14958 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14959 l (push m l)))
14960 (apply 'format fmt (nreverse l))))
14962 (defun org-time-string-to-time (s)
14963 (apply 'encode-time (org-parse-time-string s)))
14964 (defun org-time-string-to-seconds (s)
14965 (org-float-time (org-time-string-to-time s)))
14967 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14968 "Convert a time stamp to an absolute day number.
14969 If there is a specifier for a cyclic time stamp, get the closest date to
14970 DAYNR.
14971 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14972 the variable date is bound by the calendar when this is called."
14973 (cond
14975 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14976 daynr
14977 (+ daynr 1000)))
14979 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14980 (time-to-days (current-time))) (match-string 0 s)
14981 prefer show-all))
14982 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14984 (defun org-days-to-iso-week (days)
14985 "Return the iso week number."
14986 (require 'cal-iso)
14987 (car (calendar-iso-from-absolute days)))
14989 (defun org-small-year-to-year (year)
14990 "Convert 2-digit years into 4-digit years.
14991 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14992 The year 2000 cannot be abbreviated. Any year larger than 99
14993 is returned unchanged."
14994 (if (< year 38)
14995 (setq year (+ 2000 year))
14996 (if (< year 100)
14997 (setq year (+ 1900 year))))
14998 year)
15000 (defun org-time-from-absolute (d)
15001 "Return the time corresponding to date D.
15002 D may be an absolute day number, or a calendar-type list (month day year)."
15003 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15004 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15006 (defun org-calendar-holiday ()
15007 "List of holidays, for Diary display in Org-mode."
15008 (require 'holidays)
15009 (let ((hl (funcall
15010 (if (fboundp 'calendar-check-holidays)
15011 'calendar-check-holidays 'check-calendar-holidays) date)))
15012 (if hl (mapconcat 'identity hl "; "))))
15014 (defun org-diary-sexp-entry (sexp entry date)
15015 "Process a SEXP diary ENTRY for DATE."
15016 (require 'diary-lib)
15017 (let ((result (if calendar-debug-sexp
15018 (let ((stack-trace-on-error t))
15019 (eval (car (read-from-string sexp))))
15020 (condition-case nil
15021 (eval (car (read-from-string sexp)))
15022 (error
15023 (beep)
15024 (message "Bad sexp at line %d in %s: %s"
15025 (org-current-line)
15026 (buffer-file-name) sexp)
15027 (sleep-for 2))))))
15028 (cond ((stringp result) result)
15029 ((and (consp result)
15030 (not (consp (cdr result)))
15031 (stringp (cdr result))) (cdr result))
15032 ((and (consp result)
15033 (stringp (car result))) result)
15034 (result entry)
15035 (t nil))))
15037 (defun org-diary-to-ical-string (frombuf)
15038 "Get iCalendar entries from diary entries in buffer FROMBUF.
15039 This uses the icalendar.el library."
15040 (let* ((tmpdir (if (featurep 'xemacs)
15041 (temp-directory)
15042 temporary-file-directory))
15043 (tmpfile (make-temp-name
15044 (expand-file-name "orgics" tmpdir)))
15045 buf rtn b e)
15046 (with-current-buffer frombuf
15047 (icalendar-export-region (point-min) (point-max) tmpfile)
15048 (setq buf (find-buffer-visiting tmpfile))
15049 (set-buffer buf)
15050 (goto-char (point-min))
15051 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15052 (setq b (match-beginning 0)))
15053 (goto-char (point-max))
15054 (if (re-search-backward "^END:VEVENT" nil t)
15055 (setq e (match-end 0)))
15057 (kill-buffer buf)
15058 (delete-file tmpfile)
15059 rtn))
15061 (defun org-closest-date (start current change prefer show-all)
15062 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15063 When PREFER is `past' return a date that is either CURRENT or past.
15064 When PREFER is `future', return a date that is either CURRENT or future.
15065 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15066 ;; Make the proper lists from the dates
15067 (catch 'exit
15068 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15069 dn dw sday cday n1 n2 n0
15070 d m y y1 y2 date1 date2 nmonths nm ny m2)
15072 (setq start (org-date-to-gregorian start)
15073 current (org-date-to-gregorian
15074 (if show-all
15075 current
15076 (time-to-days (current-time))))
15077 sday (calendar-absolute-from-gregorian start)
15078 cday (calendar-absolute-from-gregorian current))
15080 (if (<= cday sday) (throw 'exit sday))
15083 (setq dn (string-to-number (match-string 1 change))
15084 dw (cdr (assoc (match-string 2 change) a1)))
15085 (error "Invalid change specifier: %s" change))
15086 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15087 (cond
15088 ((eq dw 'day)
15089 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15090 n2 (+ n1 dn)))
15091 ((eq dw 'year)
15092 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15093 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15094 (setq date1 (list m d y1)
15095 n1 (calendar-absolute-from-gregorian date1)
15096 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15097 n2 (calendar-absolute-from-gregorian date2)))
15098 ((eq dw 'month)
15099 ;; approx number of month between the two dates
15100 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15101 ;; How often does dn fit in there?
15102 (setq d (nth 1 start) m (car start) y (nth 2 start)
15103 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15104 m (+ m nm)
15105 ny (floor (/ m 12))
15106 y (+ y ny)
15107 m (- m (* ny 12)))
15108 (while (> m 12) (setq m (- m 12) y (1+ y)))
15109 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15110 (setq m2 (+ m dn) y2 y)
15111 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15112 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15113 (while (<= n2 cday)
15114 (setq n1 n2 m m2 y y2)
15115 (setq m2 (+ m dn) y2 y)
15116 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15117 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15118 ;; Make sure n1 is the earlier date
15119 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15120 (if show-all
15121 (cond
15122 ((eq prefer 'past) (if (= cday n2) n2 n1))
15123 ((eq prefer 'future) (if (= cday n1) n1 n2))
15124 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15125 (cond
15126 ((eq prefer 'past) (if (= cday n2) n2 n1))
15127 ((eq prefer 'future) (if (= cday n1) n1 n2))
15128 (t (if (= cday n1) n1 n2)))))))
15130 (defun org-date-to-gregorian (date)
15131 "Turn any specification of DATE into a Gregorian date for the calendar."
15132 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15133 ((and (listp date) (= (length date) 3)) date)
15134 ((stringp date)
15135 (setq date (org-parse-time-string date))
15136 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15137 ((listp date)
15138 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15140 (defun org-parse-time-string (s &optional nodefault)
15141 "Parse the standard Org-mode time string.
15142 This should be a lot faster than the normal `parse-time-string'.
15143 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15144 hour and minute fields will be nil if not given."
15145 (if (string-match org-ts-regexp0 s)
15146 (list 0
15147 (if (or (match-beginning 8) (not nodefault))
15148 (string-to-number (or (match-string 8 s) "0")))
15149 (if (or (match-beginning 7) (not nodefault))
15150 (string-to-number (or (match-string 7 s) "0")))
15151 (string-to-number (match-string 4 s))
15152 (string-to-number (match-string 3 s))
15153 (string-to-number (match-string 2 s))
15154 nil nil nil)
15155 (error "Not a standard Org-mode time string: %s" s)))
15157 (defun org-timestamp-up (&optional arg)
15158 "Increase the date item at the cursor by one.
15159 If the cursor is on the year, change the year. If it is on the month or
15160 the day, change that.
15161 With prefix ARG, change by that many units."
15162 (interactive "p")
15163 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15165 (defun org-timestamp-down (&optional arg)
15166 "Decrease the date item at the cursor by one.
15167 If the cursor is on the year, change the year. If it is on the month or
15168 the day, change that.
15169 With prefix ARG, change by that many units."
15170 (interactive "p")
15171 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15173 (defun org-timestamp-up-day (&optional arg)
15174 "Increase the date in the time stamp by one day.
15175 With prefix ARG, change that many days."
15176 (interactive "p")
15177 (if (and (not (org-at-timestamp-p t))
15178 (org-on-heading-p))
15179 (org-todo 'up)
15180 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15182 (defun org-timestamp-down-day (&optional arg)
15183 "Decrease the date in the time stamp by one day.
15184 With prefix ARG, change that many days."
15185 (interactive "p")
15186 (if (and (not (org-at-timestamp-p t))
15187 (org-on-heading-p))
15188 (org-todo 'down)
15189 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15191 (defun org-at-timestamp-p (&optional inactive-ok)
15192 "Determine if the cursor is in or at a timestamp."
15193 (interactive)
15194 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15195 (pos (point))
15196 (ans (or (looking-at tsr)
15197 (save-excursion
15199 (if (> (point) (point-min)) (backward-char 1))
15200 (and (looking-at tsr)
15201 (> (- (match-end 0) pos) -1))))))
15202 (and ans
15203 (boundp 'org-ts-what)
15204 (setq org-ts-what
15205 (cond
15206 ((= pos (match-beginning 0)) 'bracket)
15207 ((= pos (1- (match-end 0))) 'bracket)
15208 ((org-pos-in-match-range pos 2) 'year)
15209 ((org-pos-in-match-range pos 3) 'month)
15210 ((org-pos-in-match-range pos 7) 'hour)
15211 ((org-pos-in-match-range pos 8) 'minute)
15212 ((or (org-pos-in-match-range pos 4)
15213 (org-pos-in-match-range pos 5)) 'day)
15214 ((and (> pos (or (match-end 8) (match-end 5)))
15215 (< pos (match-end 0)))
15216 (- pos (or (match-end 8) (match-end 5))))
15217 (t 'day))))
15218 ans))
15220 (defun org-toggle-timestamp-type ()
15221 "Toggle the type (<active> or [inactive]) of a time stamp."
15222 (interactive)
15223 (when (org-at-timestamp-p t)
15224 (let ((beg (match-beginning 0)) (end (match-end 0))
15225 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15226 (save-excursion
15227 (goto-char beg)
15228 (while (re-search-forward "[][<>]" end t)
15229 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15230 t t)))
15231 (message "Timestamp is now %sactive"
15232 (if (equal (char-after beg) ?<) "" "in")))))
15234 (defun org-timestamp-change (n &optional what updown)
15235 "Change the date in the time stamp at point.
15236 The date will be changed by N times WHAT. WHAT can be `day', `month',
15237 `year', `minute', `second'. If WHAT is not given, the cursor position
15238 in the timestamp determines what will be changed."
15239 (let ((pos (point))
15240 with-hm inactive
15241 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15242 org-ts-what
15243 extra rem
15244 ts time time0)
15245 (if (not (org-at-timestamp-p t))
15246 (error "Not at a timestamp"))
15247 (if (and (not what) (eq org-ts-what 'bracket))
15248 (org-toggle-timestamp-type)
15249 (if (and (not what) (not (eq org-ts-what 'day))
15250 org-display-custom-times
15251 (get-text-property (point) 'display)
15252 (not (get-text-property (1- (point)) 'display)))
15253 (setq org-ts-what 'day))
15254 (setq org-ts-what (or what org-ts-what)
15255 inactive (= (char-after (match-beginning 0)) ?\[)
15256 ts (match-string 0))
15257 (replace-match "")
15258 (if (string-match
15260 ts)
15261 (setq extra (match-string 1 ts)))
15263 (setq with-hm t))
15264 (setq time0 (org-parse-time-string ts))
15265 (when (and updown
15266 (eq org-ts-what 'minute)
15267 (not current-prefix-arg))
15268 ;; This looks like s-up and s-down. Change by one rounding step.
15269 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15270 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15271 (setcar (cdr time0) (+ (nth 1 time0)
15272 (if (> n 0) (- rem) (- dm rem))))))
15273 (setq time
15274 (encode-time (or (car time0) 0)
15275 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15276 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15277 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15278 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15279 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15280 (nthcdr 6 time0)))
15281 (when (and (member org-ts-what '(hour minute))
15282 extra
15284 (setq extra (org-modify-ts-extra
15285 extra
15286 (if (eq org-ts-what 'hour) 2 5)
15287 n dm)))
15288 (when (integerp org-ts-what)
15289 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15290 (if (eq what 'calendar)
15291 (let ((cal-date (org-get-date-from-calendar)))
15292 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15293 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15294 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15295 (setcar time0 (or (car time0) 0))
15296 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15297 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15298 (setq time (apply 'encode-time time0))))
15299 (setq org-last-changed-timestamp
15300 (org-insert-time-stamp time with-hm inactive nil nil extra))
15301 (org-clock-update-time-maybe)
15302 (goto-char pos)
15303 ;; Try to recenter the calendar window, if any
15304 (if (and org-calendar-follow-timestamp-change
15305 (get-buffer-window "*Calendar*" t)
15306 (memq org-ts-what '(day month year)))
15307 (org-recenter-calendar (time-to-days time))))))
15309 (defun org-modify-ts-extra (s pos n dm)
15310 "Change the different parts of the lead-time and repeat fields in timestamp."
15311 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15312 ng h m new rem)
15313 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15314 (cond
15315 ((or (org-pos-in-match-range pos 2)
15316 (org-pos-in-match-range pos 3))
15317 (setq m (string-to-number (match-string 3 s))
15318 h (string-to-number (match-string 2 s)))
15319 (if (org-pos-in-match-range pos 2)
15320 (setq h (+ h n))
15321 (setq n (* dm (org-no-warnings (signum n))))
15322 (when (not (= 0 (setq rem (% m dm))))
15323 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15324 (setq m (+ m n)))
15325 (if (< m 0) (setq m (+ m 60) h (1- h)))
15326 (if (> m 59) (setq m (- m 60) h (1+ h)))
15327 (setq h (min 24 (max 0 h)))
15328 (setq ng 1 new (format "-%02d:%02d" h m)))
15329 ((org-pos-in-match-range pos 6)
15330 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15331 ((org-pos-in-match-range pos 5)
15332 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15334 ((org-pos-in-match-range pos 9)
15335 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15336 ((org-pos-in-match-range pos 8)
15337 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15339 (when ng
15340 (setq s (concat
15341 (substring s 0 (match-beginning ng))
15342 new
15343 (substring s (match-end ng))))))
15344 s))
15346 (defun org-recenter-calendar (date)
15347 "If the calendar is visible, recenter it to DATE."
15348 (let* ((win (selected-window))
15349 (cwin (get-buffer-window "*Calendar*" t))
15350 (calendar-move-hook nil))
15351 (when cwin
15352 (select-window cwin)
15353 (calendar-goto-date (if (listp date) date
15354 (calendar-gregorian-from-absolute date)))
15355 (select-window win))))
15357 (defun org-goto-calendar (&optional arg)
15358 "Go to the Emacs calendar at the current date.
15359 If there is a time stamp in the current line, go to that date.
15360 A prefix ARG can be used to force the current date."
15361 (interactive "P")
15362 (let ((tsr org-ts-regexp) diff
15363 (calendar-move-hook nil)
15364 (calendar-view-holidays-initially-flag nil)
15365 (calendar-view-diary-initially-flag nil))
15366 (if (or (org-at-timestamp-p)
15367 (save-excursion
15368 (beginning-of-line 1)
15369 (looking-at (concat ".*" tsr))))
15370 (let ((d1 (time-to-days (current-time)))
15371 (d2 (time-to-days
15372 (org-time-string-to-time (match-string 1)))))
15373 (setq diff (- d2 d1))))
15374 (calendar)
15375 (calendar-goto-today)
15376 (if (and diff (not arg)) (calendar-forward-day diff))))
15378 (defun org-get-date-from-calendar ()
15379 "Return a list (month day year) of date at point in calendar."
15380 (with-current-buffer "*Calendar*"
15381 (save-match-data
15382 (calendar-cursor-to-date))))
15384 (defun org-date-from-calendar ()
15385 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15386 If there is already a time stamp at the cursor position, update it."
15387 (interactive)
15388 (if (org-at-timestamp-p t)
15389 (org-timestamp-change 0 'calendar)
15390 (let ((cal-date (org-get-date-from-calendar)))
15391 (org-insert-time-stamp
15392 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15394 (defun org-minutes-to-hh:mm-string (m)
15395 "Compute H:MM from a number of minutes."
15396 (let ((h (/ m 60)))
15397 (setq m (- m (* 60 h)))
15398 (format org-time-clocksum-format h m)))
15400 (defun org-hh:mm-string-to-minutes (s)
15401 "Convert a string H:MM to a number of minutes.
15402 If the string is just a number, interpret it as minutes.
15403 In fact, the first hh:mm or number in the string will be taken,
15404 there can be extra stuff in the string.
15405 If no number is found, the return value is 0."
15406 (cond
15408 (+ (* (string-to-number (match-string 1 s)) 60)
15409 (string-to-number (match-string 2 s))))
15411 (string-to-number (match-string 1 s)))
15412 (t 0)))
15414 ;;;; Files
15416 (defun org-save-all-org-buffers ()
15417 "Save all Org-mode buffers without user confirmation."
15418 (interactive)
15419 (message "Saving all Org-mode buffers...")
15420 (save-some-buffers t 'org-mode-p)
15421 (when (featurep 'org-id) (org-id-locations-save))
15422 (message "Saving all Org-mode buffers... done"))
15424 (defun org-revert-all-org-buffers ()
15425 "Revert all Org-mode buffers.
15426 Prompt for confirmation when there are unsaved changes.
15427 Be sure you know what you are doing before letting this function
15428 overwrite your changes.
15430 This function is useful in a setup where one tracks org files
15431 with a version control system, to revert on one machine after pulling
15432 changes from another. I believe the procedure must be like this:
15434 1. M-x org-save-all-org-buffers
15435 2. Pull changes from the other machine, resolve conflicts
15436 3. M-x org-revert-all-org-buffers"
15437 (interactive)
15438 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15439 (error "Abort"))
15440 (save-excursion
15441 (save-window-excursion
15442 (mapc
15443 (lambda (b)
15444 (when (and (with-current-buffer b (org-mode-p))
15445 (with-current-buffer b buffer-file-name))
15446 (switch-to-buffer b)
15447 (revert-buffer t 'no-confirm)))
15448 (buffer-list))
15449 (when (and (featurep 'org-id) org-id-track-globally)
15450 (org-id-locations-load)))))
15452 ;;;; Agenda files
15454 ;;;###autoload
15455 (defun org-switchb (&optional arg)
15456 "Switch between Org buffers.
15457 With a prefix argument, restrict available to files.
15458 With two prefix arguments, restrict available buffers to agenda files.
15460 Defaults to `iswitchb' for buffer name completion.
15461 Set `org-completion-use-ido' to make it use ido instead."
15462 (interactive "P")
15463 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15464 ((equal arg '(16)) (org-buffer-list 'agenda))
15465 (t (org-buffer-list))))
15466 (org-completion-use-iswitchb org-completion-use-iswitchb)
15467 (org-completion-use-ido org-completion-use-ido))
15468 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15469 (setq org-completion-use-iswitchb t))
15470 (switch-to-buffer
15471 (org-icompleting-read "Org buffer: "
15472 (mapcar 'list (mapcar 'buffer-name blist))
15473 nil t))))
15475 ;;; Define some older names previously used for this functionality
15476 ;;;###autoload
15477 (defalias 'org-ido-switchb 'org-switchb)
15478 ;;;###autoload
15479 (defalias 'org-iswitchb 'org-switchb)
15481 (defun org-buffer-list (&optional predicate exclude-tmp)
15482 "Return a list of Org buffers.
15483 PREDICATE can be `export', `files' or `agenda'.
15485 export restrict the list to Export buffers.
15486 files restrict the list to buffers visiting Org files.
15487 agenda restrict the list to buffers visiting agenda files.
15489 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15490 (let* ((bfn nil)
15491 (agenda-files (and (eq predicate 'agenda)
15492 (mapcar 'file-truename (org-agenda-files t))))
15493 (filter
15494 (cond
15495 ((eq predicate 'files)
15496 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15497 ((eq predicate 'export)
15498 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15499 ((eq predicate 'agenda)
15500 (lambda (b)
15501 (with-current-buffer b
15502 (and (eq major-mode 'org-mode)
15503 (setq bfn (buffer-file-name b))
15504 (member (file-truename bfn) agenda-files)))))
15505 (t (lambda (b) (with-current-buffer b
15506 (or (eq major-mode 'org-mode)
15507 (string-match "\*Org .*Export"
15508 (buffer-name b)))))))))
15509 (delq nil
15510 (mapcar
15511 (lambda(b)
15512 (if (and (funcall filter b)
15513 (or (not exclude-tmp)
15514 (not (string-match "tmp" (buffer-name b)))))
15515 b
15516 nil))
15517 (buffer-list)))))
15519 (defun org-agenda-files (&optional unrestricted archives)
15520 "Get the list of agenda files.
15521 Optional UNRESTRICTED means return the full list even if a restriction
15522 is currently in place.
15523 When ARCHIVES is t, include all archive files that are really being
15524 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15525 `org-agenda-archives-mode' is t."
15526 (let ((files
15527 (cond
15528 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15529 ((stringp org-agenda-files) (org-read-agenda-file-list))
15530 ((listp org-agenda-files) org-agenda-files)
15531 (t (error "Invalid value of `org-agenda-files'")))))
15532 (setq files (apply 'append
15533 (mapcar (lambda (f)
15534 (if (file-directory-p f)
15535 (directory-files
15536 f t org-agenda-file-regexp)
15537 (list f)))
15538 files)))
15539 (when org-agenda-skip-unavailable-files
15540 (setq files (delq nil
15541 (mapcar (function
15542 (lambda (file)
15543 (and (file-readable-p file) file)))
15544 files))))
15545 (when (or (eq archives t)
15546 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15547 (setq files (org-add-archive-files files)))
15548 files))
15550 (defun org-agenda-file-p (&optional file)
15551 "Return non-nil, if FILE is an agenda file.
15552 If FILE is omitted, use the file associated with the current
15553 buffer."
15554 (member (or file (buffer-file-name))
15555 (org-agenda-files t)))
15557 (defun org-edit-agenda-file-list ()
15558 "Edit the list of agenda files.
15559 Depending on setup, this either uses customize to edit the variable
15560 `org-agenda-files', or it visits the file that is holding the list. In the
15561 latter case, the buffer is set up in a way that saving it automatically kills
15562 the buffer and restores the previous window configuration."
15563 (interactive)
15564 (if (stringp org-agenda-files)
15565 (let ((cw (current-window-configuration)))
15566 (find-file org-agenda-files)
15567 (org-set-local 'org-window-configuration cw)
15568 (org-add-hook 'after-save-hook
15569 (lambda ()
15570 (set-window-configuration
15571 (prog1 org-window-configuration
15572 (kill-buffer (current-buffer))))
15573 (org-install-agenda-files-menu)
15574 (message "New agenda file list installed"))
15575 nil 'local)
15576 (message "%s" (substitute-command-keys
15578 (customize-variable 'org-agenda-files)))
15580 (defun org-store-new-agenda-file-list (list)
15581 "Set new value for the agenda file list and save it correctly."
15582 (if (stringp org-agenda-files)
15583 (let ((fe (org-read-agenda-file-list t)) b u)
15584 (while (setq b (find-buffer-visiting org-agenda-files))
15585 (kill-buffer b))
15586 (with-temp-file org-agenda-files
15587 (insert
15588 (mapconcat
15589 (lambda (f) ;; Keep un-expanded entries.
15590 (if (setq u (assoc f fe))
15591 (cdr u)
15592 f))
15595 (let ((org-mode-hook nil) (org-inhibit-startup t)
15596 (org-insert-mode-line-in-empty-file nil))
15597 (setq org-agenda-files list)
15598 (customize-save-variable 'org-agenda-files org-agenda-files))))
15600 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15601 "Read the list of agenda files from a file.
15602 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15603 filenames, used by `org-store-new-agenda-file-list' to write back
15604 un-expanded file names."
15605 (when (file-directory-p org-agenda-files)
15606 (error "`org-agenda-files' cannot be a single directory"))
15607 (when (stringp org-agenda-files)
15608 (with-temp-buffer
15609 (insert-file-contents org-agenda-files)
15610 (mapcar
15611 (lambda (f)
15612 (let ((e (expand-file-name (substitute-in-file-name f)
15613 org-directory)))
15614 (if pair-with-expansion
15615 (cons e f)
15616 e)))
15619 ;;;###autoload
15620 (defun org-cycle-agenda-files ()
15621 "Cycle through the files in `org-agenda-files'.
15622 If the current buffer visits an agenda file, find the next one in the list.
15623 If the current buffer does not, find the first agenda file."
15624 (interactive)
15625 (let* ((fs (org-agenda-files t))
15626 (files (append fs (list (car fs))))
15627 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15628 file)
15629 (unless files (error "No agenda files"))
15630 (catch 'exit
15631 (while (setq file (pop files))
15632 (if (equal (file-truename file) tcf)
15633 (when (car files)
15634 (find-file (car files))
15635 (throw 'exit t))))
15636 (find-file (car fs)))
15637 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15639 (defun org-agenda-file-to-front (&optional to-end)
15640 "Move/add the current file to the top of the agenda file list.
15641 If the file is not present in the list, it is added to the front. If it is
15642 present, it is moved there. With optional argument TO-END, add/move to the
15643 end of the list."
15644 (interactive "P")
15645 (let ((org-agenda-skip-unavailable-files nil)
15646 (file-alist (mapcar (lambda (x)
15647 (cons (file-truename x) x))
15648 (org-agenda-files t)))
15649 (ctf (file-truename buffer-file-name))
15650 x had)
15651 (setq x (assoc ctf file-alist) had x)
15653 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15654 (if to-end
15655 (setq file-alist (append (delq x file-alist) (list x)))
15656 (setq file-alist (cons x (delq x file-alist))))
15657 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15658 (org-install-agenda-files-menu)
15659 (message "File %s to %s of agenda file list"
15660 (if had "moved" "added") (if to-end "end" "front"))))
15662 (defun org-remove-file (&optional file)
15663 "Remove current file from the list of files in variable `org-agenda-files'.
15664 These are the files which are being checked for agenda entries.
15665 Optional argument FILE means use this file instead of the current."
15666 (interactive)
15667 (let* ((org-agenda-skip-unavailable-files nil)
15668 (file (or file buffer-file-name))
15669 (true-file (file-truename file))
15670 (afile (abbreviate-file-name file))
15671 (files (delq nil (mapcar
15672 (lambda (x)
15673 (if (equal true-file
15674 (file-truename x))
15675 nil x))
15676 (org-agenda-files t)))))
15677 (if (not (= (length files) (length (org-agenda-files t))))
15678 (progn
15679 (org-store-new-agenda-file-list files)
15680 (org-install-agenda-files-menu)
15681 (message "Removed file: %s" afile))
15682 (message "File was not in list: %s (not removed)" afile))))
15684 (defun org-file-menu-entry (file)
15685 (vector file (list 'find-file file) t))
15687 (defun org-check-agenda-file (file)
15688 "Make sure FILE exists. If not, ask user what to do."
15689 (when (not (file-exists-p file))
15690 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15691 (abbreviate-file-name file))
15692 (let ((r (downcase (read-char-exclusive))))
15693 (cond
15694 ((equal r ?r)
15695 (org-remove-file file)
15696 (throw 'nextfile t))
15697 (t (error "Abort"))))))
15699 (defun org-get-agenda-file-buffer (file)
15700 "Get a buffer visiting FILE. If the buffer needs to be created, add
15701 it to the list of buffers which might be released later."
15702 (let ((buf (org-find-base-buffer-visiting file)))
15703 (if buf
15704 buf ; just return it
15705 ;; Make a new buffer and remember it
15706 (setq buf (find-file-noselect file))
15707 (if buf (push buf org-agenda-new-buffers))
15708 buf)))
15710 (defun org-release-buffers (blist)
15711 "Release all buffers in list, asking the user for confirmation when needed.
15712 When a buffer is unmodified, it is just killed. When modified, it is saved
15713 \(if the user agrees) and then killed."
15714 (let (buf file)
15715 (while (setq buf (pop blist))
15716 (setq file (buffer-file-name buf))
15717 (when (and (buffer-modified-p buf)
15718 file
15719 (y-or-n-p (format "Save file %s? " file)))
15720 (with-current-buffer buf (save-buffer)))
15721 (kill-buffer buf))))
15723 (defun org-prepare-agenda-buffers (files)
15724 "Create buffers for all agenda files, protect archived trees and comments."
15725 (interactive)
15726 (let ((pa '(:org-archived t))
15727 (pc '(:org-comment t))
15728 (pall '(:org-archived t :org-comment t))
15729 (inhibit-read-only t)
15730 (rea (concat ":" org-archive-tag ":"))
15731 bmp file re)
15732 (save-excursion
15733 (save-restriction
15734 (while (setq file (pop files))
15735 (catch 'nextfile
15736 (if (bufferp file)
15737 (set-buffer file)
15738 (org-check-agenda-file file)
15739 (set-buffer (org-get-agenda-file-buffer file)))
15740 (widen)
15741 (setq bmp (buffer-modified-p))
15742 (org-refresh-category-properties)
15743 (setq org-todo-keywords-for-agenda
15744 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15745 (setq org-done-keywords-for-agenda
15746 (append org-done-keywords-for-agenda org-done-keywords))
15747 (setq org-todo-keyword-alist-for-agenda
15748 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15749 (setq org-drawers-for-agenda
15750 (append org-drawers-for-agenda org-drawers))
15751 (setq org-tag-alist-for-agenda
15752 (append org-tag-alist-for-agenda org-tag-alist))
15754 (save-excursion
15755 (remove-text-properties (point-min) (point-max) pall)
15756 (when org-agenda-skip-archived-trees
15757 (goto-char (point-min))
15758 (while (re-search-forward rea nil t)
15759 (if (org-on-heading-p t)
15760 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15761 (goto-char (point-min))
15763 (while (re-search-forward re nil t)
15764 (add-text-properties
15765 (match-beginning 0) (org-end-of-subtree t) pc)))
15766 (set-buffer-modified-p bmp)))))
15767 (setq org-todo-keywords-for-agenda
15768 (org-uniquify org-todo-keywords-for-agenda))
15769 (setq org-todo-keyword-alist-for-agenda
15770 (org-uniquify org-todo-keyword-alist-for-agenda)
15771 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15773 ;;;; Embedded LaTeX
15775 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15776 "Keymap for the minor `org-cdlatex-mode'.")
15778 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15779 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15780 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15781 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15782 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15784 (defvar org-cdlatex-texmathp-advice-is-done nil
15785 "Flag remembering if we have applied the advice to texmathp already.")
15787 (define-minor-mode org-cdlatex-mode
15788 "Toggle the minor `org-cdlatex-mode'.
15789 This mode supports entering LaTeX environment and math in LaTeX fragments
15790 in Org-mode.
15792 nil " OCDL" nil
15793 (when org-cdlatex-mode (require 'cdlatex))
15794 (unless org-cdlatex-texmathp-advice-is-done
15795 (setq org-cdlatex-texmathp-advice-is-done t)
15796 (defadvice texmathp (around org-math-always-on activate)
15797 "Always return t in org-mode buffers.
15798 This is because we want to insert math symbols without dollars even outside
15799 the LaTeX math segments. If Orgmode thinks that point is actually inside
15800 an embedded LaTeX fragment, let texmathp do its job.
15802 (interactive)
15803 (let (p)
15804 (cond
15805 ((not (org-mode-p)) ad-do-it)
15806 ((eq this-command 'cdlatex-math-symbol)
15807 (setq ad-return-value t
15808 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15809 (t
15810 (let ((p (org-inside-LaTeX-fragment-p)))
15811 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15812 (setq ad-return-value t
15813 texmathp-why '("Org-mode embedded math" . 0))
15814 (if p ad-do-it)))))))))
15816 (defun turn-on-org-cdlatex ()
15817 "Unconditionally turn on `org-cdlatex-mode'."
15818 (org-cdlatex-mode 1))
15820 (defun org-inside-LaTeX-fragment-p ()
15821 "Test if point is inside a LaTeX fragment.
15823 sequence appearing also before point.
15824 Even though the matchers for math are configurable, this function assumes
15826 delimiters are skipped when they have been removed by customization.
15827 The return value is nil, or a cons cell with the delimiter and
15828 and the position of this delimiter.
15830 This function does a reasonably good job, but can locally be fooled by
15831 for example currency specifications. For example it will assume being in
15833 fragments that are properly closed, but during editing, we have to live
15834 with the uncertainty caused by missing closing delimiters. This function
15835 looks only before point, not after."
15836 (catch 'exit
15837 (let ((pos (point))
15838 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15839 (lim (progn
15841 (point)))
15842 dd-on str (start 0) m re)
15843 (goto-char pos)
15844 (when dodollar
15846 re (nth 1 (assoc "$" org-latex-regexps)))
15847 (while (string-match re str start)
15848 (cond
15849 ((= (match-end 0) (length str))
15850 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15851 ((= (match-end 0) (- (length str) 5))
15852 (throw 'exit nil))
15853 (t (setq start (match-end 0))))))
15854 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15855 (goto-char pos)
15856 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15857 (and (match-beginning 2) (throw 'exit nil))
15858 ;; count $$
15860 (setq dd-on (not dd-on)))
15861 (goto-char pos)
15862 (if dd-on (cons "$$" m))))))
15864 (defun org-inside-latex-macro-p ()
15865 "Is point inside a LaTeX macro or its arguments?"
15866 (save-match-data
15867 (org-in-regexp
15870 (defun org-try-cdlatex-tab ()
15871 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15872 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15873 - inside a LaTeX fragment, or
15874 - after the first word in a line, where an abbreviation expansion could
15875 insert a LaTeX environment."
15876 (when org-cdlatex-mode
15877 (cond
15878 ((save-excursion
15879 (skip-chars-backward "a-zA-Z0-9*")
15881 (bolp))
15882 (cdlatex-tab) t)
15883 ((org-inside-LaTeX-fragment-p)
15884 (cdlatex-tab) t)
15885 (t nil))))
15887 (defun org-cdlatex-underscore-caret (&optional arg)
15888 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15889 Revert to the normal definition outside of these fragments."
15890 (interactive "P")
15891 (if (org-inside-LaTeX-fragment-p)
15892 (call-interactively 'cdlatex-sub-superscript)
15893 (let (org-cdlatex-mode)
15894 (call-interactively (key-binding (vector last-input-event))))))
15896 (defun org-cdlatex-math-modify (&optional arg)
15897 "Execute `cdlatex-math-modify' in LaTeX fragments.
15898 Revert to the normal definition outside of these fragments."
15899 (interactive "P")
15900 (if (org-inside-LaTeX-fragment-p)
15901 (call-interactively 'cdlatex-math-modify)
15902 (let (org-cdlatex-mode)
15903 (call-interactively (key-binding (vector last-input-event))))))
15905 (defvar org-latex-fragment-image-overlays nil
15906 "List of overlays carrying the images of latex fragments.")
15907 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15909 (defun org-remove-latex-fragment-image-overlays ()
15910 "Remove all overlays with LaTeX fragment images in current buffer."
15911 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15912 (setq org-latex-fragment-image-overlays nil))
15914 (defun org-preview-latex-fragment (&optional subtree)
15915 "Preview the LaTeX fragment at point, or all locally or globally.
15916 If the cursor is in a LaTeX fragment, create the image and overlay
15917 it over the source code. If there is no fragment at point, display
15918 all fragments in the current text, from one headline to the next. With
15919 prefix SUBTREE, display all fragments in the current subtree. With a
15921 the cursor is before the first headline,
15922 display all fragments in the buffer.
15924 (interactive "P")
15925 (org-remove-latex-fragment-image-overlays)
15926 (save-excursion
15927 (save-restriction
15928 (let (beg end at msg)
15929 (cond
15930 ((or (equal subtree '(16))
15931 (not (save-excursion
15932 (re-search-backward (concat "^" outline-regexp) nil t))))
15933 (setq beg (point-min) end (point-max)
15934 msg "Creating images for buffer...%s"))
15935 ((equal subtree '(4))
15936 (org-back-to-heading)
15937 (setq beg (point) end (org-end-of-subtree t)
15938 msg "Creating images for subtree...%s"))
15939 (t
15940 (if (setq at (org-inside-LaTeX-fragment-p))
15941 (goto-char (max (point-min) (- (cdr at) 2)))
15942 (org-back-to-heading))
15943 (setq beg (point) end (progn (outline-next-heading) (point))
15944 msg (if at "Creating image...%s"
15945 "Creating images for entry...%s"))))
15946 (message msg "")
15947 (narrow-to-region beg end)
15948 (goto-char beg)
15949 (org-format-latex
15950 (concat "ltxpng/" (file-name-sans-extension
15951 (file-name-nondirectory
15952 buffer-file-name)))
15953 default-directory 'overlays msg at 'forbuffer 'dvipng)
15954 (message msg "done. Use `C-c C-c' to remove images.")))))
15956 (defvar org-latex-regexps
15958 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15961 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15965 "Regular expressions for matching embedded LaTeX.")
15967 (defvar org-export-have-math nil) ;; dynamic scoping
15968 (defun org-format-latex (prefix &optional dir overlays msg at
15969 forbuffer processing-type)
15970 "Replace LaTeX fragments with links to an image, and produce images.
15971 Some of the options can be changed using the variable
15972 `org-format-latex-options'."
15973 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15974 (let* ((prefixnodir (file-name-nondirectory prefix))
15975 (absprefix (expand-file-name prefix dir))
15976 (todir (file-name-directory absprefix))
15977 (opt org-format-latex-options)
15978 (matchers (plist-get opt :matchers))
15979 (re-list org-latex-regexps)
15980 (org-format-latex-header-extra
15981 (plist-get (org-infile-export-plist) :latex-header-extra))
15982 (cnt 0) txt hash link beg end re e checkdir
15983 executables-checked string
15984 m n block linkfile movefile ov)
15985 ;; Check the different regular expressions
15986 (while (setq e (pop re-list))
15987 (setq m (car e) re (nth 1 e) n (nth 2 e)
15989 (when (member m matchers)
15990 (goto-char (point-min))
15991 (while (re-search-forward re nil t)
15992 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15993 (not (get-text-property (match-beginning n)
15994 'org-protected))
15995 (or (not overlays)
15996 (not (eq (get-char-property (match-beginning n)
15997 'org-overlay-type)
15998 'org-latex-overlay))))
15999 (setq org-export-have-math t)
16000 (cond
16001 ((eq processing-type 'verbatim)
16002 ;; Leave the text verbatim, just protect it
16003 (add-text-properties (match-beginning n) (match-end n)
16004 '(org-protected t)))
16005 ((eq processing-type 'mathjax)
16006 ;; Prepare for MathJax processing
16007 (setq string (match-string n))
16008 (if (member m '("$" "$1"))
16009 (save-excursion
16010 (delete-region (match-beginning n) (match-end n))
16011 (goto-char (match-beginning n))
16014 '(org-protected t))))
16015 (add-text-properties (match-beginning n) (match-end n)
16016 '(org-protected t))))
16017 ((or (eq processing-type 'dvipng) t)
16018 ;; Process to an image
16019 (setq txt (match-string n)
16020 beg (match-beginning n) end (match-end n)
16021 cnt (1+ cnt))
16022 (let (print-length print-level) ; make sure full list is printed
16023 (setq hash (sha1 (prin1-to-string
16024 (list org-format-latex-header
16025 org-format-latex-header-extra
16026 org-export-latex-default-packages-alist
16027 org-export-latex-packages-alist
16028 org-format-latex-options
16029 forbuffer txt)))
16030 linkfile (format "%s_%s.png" prefix hash)
16031 movefile (format "%s_%s.png" absprefix hash)))
16032 (setq link (concat block "[[file:" linkfile "]]" block))
16033 (if msg (message msg cnt))
16034 (goto-char beg)
16035 (unless checkdir ; make sure the directory exists
16036 (setq checkdir t)
16037 (or (file-directory-p todir) (make-directory todir t)))
16039 (unless executables-checked
16040 (org-check-external-command
16041 "latex" "needed to convert LaTeX fragments to images")
16042 (org-check-external-command
16043 "dvipng" "needed to convert LaTeX fragments to images")
16044 (setq executables-checked t))
16046 (unless (file-exists-p movefile)
16047 (org-create-formula-image
16048 txt movefile opt forbuffer))
16049 (if overlays
16050 (progn
16051 (mapc (lambda (o)
16052 (if (eq (overlay-get o 'org-overlay-type)
16053 'org-latex-overlay)
16054 (delete-overlay o)))
16055 (overlays-in beg end))
16056 (setq ov (make-overlay beg end))
16057 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16058 (if (featurep 'xemacs)
16059 (progn
16060 (overlay-put ov 'invisible t)
16061 (overlay-put
16062 ov 'end-glyph
16063 (make-glyph (vector 'png :file movefile))))
16064 (overlay-put
16065 ov 'display
16066 (list 'image :type 'png :file movefile :ascent 'center)))
16067 (push ov org-latex-fragment-image-overlays)
16068 (goto-char end))
16069 (delete-region beg end)
16070 (insert (org-add-props link
16071 (list 'org-latex-src
16072 (replace-regexp-in-string
16075 ;; This function borrows from Ganesh Swami's latex2png.el
16076 (defun org-create-formula-image (string tofile options buffer)
16077 "This calls dvipng."
16078 (require 'org-latex)
16079 (let* ((tmpdir (if (featurep 'xemacs)
16080 (temp-directory)
16081 temporary-file-directory))
16082 (texfilebase (make-temp-name
16083 (expand-file-name "orgtex" tmpdir)))
16084 (texfile (concat texfilebase ".tex"))
16085 (dvifile (concat texfilebase ".dvi"))
16086 (pngfile (concat texfilebase ".png"))
16087 (fnh (if (featurep 'xemacs)
16088 (font-height (get-face-font 'default))
16089 (face-attribute 'default :height nil)))
16090 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16091 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16092 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16093 "Black"))
16094 (bg (or (plist-get options (if buffer :background :html-background))
16095 "Transparent")))
16096 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16097 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16098 (with-temp-file texfile
16099 (insert (org-splice-latex-header
16100 org-format-latex-header
16101 org-export-latex-default-packages-alist
16102 org-export-latex-packages-alist t
16103 org-format-latex-header-extra))
16105 (require 'org-latex)
16106 (org-export-latex-fix-inputenc))
16107 (let ((dir default-directory))
16108 (condition-case nil
16109 (progn
16110 (cd tmpdir)
16111 (call-process "latex" nil nil nil texfile))
16112 (error nil))
16113 (cd dir))
16114 (if (not (file-exists-p dvifile))
16115 (progn (message "Failed to create dvi file from %s" texfile) nil)
16116 (condition-case nil
16117 (call-process "dvipng" nil nil nil
16118 "-fg" fg "-bg" bg
16119 "-D" dpi
16120 ;;"-x" scale "-y" scale
16121 "-T" "tight"
16122 "-o" pngfile
16123 dvifile)
16124 (error nil))
16125 (if (not (file-exists-p pngfile))
16126 (if org-format-latex-signal-error
16127 (error "Failed to create png file from %s" texfile)
16128 (message "Failed to create png file from %s" texfile)
16129 nil)
16130 ;; Use the requested file name and clean up
16131 (copy-file pngfile tofile 'replace)
16132 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16133 (delete-file (concat texfilebase e)))
16134 pngfile))))
16136 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16137 "Fill a LaTeX header template TPL.
16138 In the template, the following place holders will be recognized:
16141 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16143 [NO-PACKAGES] do not include PKG
16144 [EXTRA] the string EXTRA
16145 [NO-EXTRA] do not include EXTRA
16147 For backward compatibility, if both the positive and the negative place
16149 assumed to be present at the end of the template.
16150 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16151 EXTRA is a string.
16152 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16153 (let (rpl (end ""))
16155 (setq rpl (if (or (match-end 1) (not def-pkg))
16156 "" (org-latex-packages-to-string def-pkg snippets-p t))
16157 tpl (replace-match rpl t t tpl))
16158 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16161 (setq rpl (if (or (match-end 1) (not pkg))
16162 "" (org-latex-packages-to-string pkg snippets-p t))
16163 tpl (replace-match rpl t t tpl))
16164 (if pkg (setq end
16166 (org-latex-packages-to-string pkg snippets-p)))))
16169 (setq rpl (if (or (match-end 1) (not extra))
16171 tpl (replace-match rpl t t tpl))
16177 tpl)))
16179 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16181 (setq pkg (mapconcat (lambda(p)
16182 (cond
16183 ((stringp p) p)
16184 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16185 (format "%% Package %s omitted" (cadr p)))
16186 ((equal "" (car p))
16188 (t
16190 (car p) (cadr p)))))
16191 pkg
16195 (defun org-dvipng-color (attr)
16196 "Return an rgb color specification for dvipng."
16197 (apply 'format "rgb %s %s %s"
16198 (mapcar 'org-normalize-color
16199 (color-values (face-attribute 'default attr nil)))))
16201 (defun org-normalize-color (value)
16202 "Return string to be used as color value for an RGB component."
16203 (format "%g" (/ value 65535.0)))
16205 ;; Image display
16208 (defvar org-inline-image-overlays nil)
16209 (make-variable-buffer-local 'org-inline-image-overlays)
16211 (defun org-toggle-inline-images (&optional include-linked)
16212 "Toggle the display of inline images.
16213 INCLUDE-LINKED is passed to `org-display-inline-images'."
16214 (interactive "P")
16215 (if org-inline-image-overlays
16216 (progn
16217 (org-remove-inline-images)
16218 (message "Inline image display turned off"))
16219 (org-display-inline-images include-linked)
16220 (if org-inline-image-overlays
16221 (message "%d images displayed inline"
16222 (length org-inline-image-overlays))
16223 (message "No images to display inline"))))
16225 (defun org-display-inline-images (&optional include-linked refresh beg end)
16226 "Display inline images.
16227 Normally only links without a description part are inlined, because this
16228 is how it will work for export. When INCLUDE-LINKED is set, also links
16229 with a description part will be inlined. This can be nice for a quick
16230 look at those images, but it does not reflect what exported files will look
16231 like.
16232 When REFRESH is set, refresh existing images between BEG and END.
16233 This will create new image displays only if necessary.
16234 BEG and END default to the buffer boundaries."
16235 (interactive "P")
16236 (unless refresh
16237 (org-remove-inline-images)
16238 (clear-image-cache))
16239 (save-excursion
16240 (save-restriction
16241 (widen)
16242 (setq beg (or beg (point-min)) end (or end (point-max)))
16243 (goto-char (point-min))
16245 (substring (org-image-file-name-regexp) 0 -2)
16247 old file ov img)
16248 (while (re-search-forward re end t)
16249 (setq old (get-char-property-and-overlay (match-beginning 1)
16250 'org-image-overlay))
16251 (setq file (expand-file-name
16252 (concat (or (match-string 3) "") (match-string 4))))
16253 (when (file-exists-p file)
16254 (if (and (car-safe old) refresh)
16255 (image-refresh (overlay-get (cdr old) 'display))
16256 (setq img (save-match-data (create-image file)))
16257 (when img
16258 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16259 (overlay-put ov 'display img)
16260 (overlay-put ov 'face 'default)
16261 (overlay-put ov 'org-image-overlay t)
16262 (overlay-put ov 'modification-hooks
16263 (list 'org-display-inline-modification-hook))
16264 (push ov org-inline-image-overlays)))))))))
16266 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16267 "Remove inline-display overlay if a corresponding region is modified."
16268 (let ((inhibit-modification-hooks t))
16269 (when (and ov after)
16270 (delete ov org-inline-image-overlays)
16271 (delete-overlay ov))))
16273 (defun org-remove-inline-images ()
16274 "Remove inline display of images."
16275 (interactive)
16276 (mapc 'delete-overlay org-inline-image-overlays)
16277 (setq org-inline-image-overlays nil))
16279 ;;;; Key bindings
16281 ;; Make `C-c C-x' a prefix key
16282 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16284 ;; TAB key with modifiers
16285 (org-defkey org-mode-map "\C-i" 'org-cycle)
16286 (org-defkey org-mode-map [(tab)] 'org-cycle)
16287 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16288 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16290 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16291 ;; The following line is necessary under Suse GNU/Linux
16292 (unless (featurep 'xemacs)
16293 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16294 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16295 (define-key org-mode-map [backtab] 'org-shifttab)
16297 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16298 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16299 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16301 ;; Cursor keys with modifiers
16302 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16303 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16304 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16305 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16307 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16308 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16309 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16310 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16312 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16313 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16314 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16315 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16317 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16318 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16320 ;; Babel keys
16321 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16322 (mapc (lambda (pair)
16323 (define-key org-babel-map (car pair) (cdr pair)))
16324 org-babel-key-bindings)
16326 ;;; Extra keys for tty access.
16327 ;; We only set them when really needed because otherwise the
16328 ;; menus don't show the simple keys
16330 (when (or org-use-extra-keys
16331 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16332 (not window-system))
16333 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16334 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16335 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16336 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16337 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16338 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16339 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16340 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16341 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16342 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16343 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16344 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16345 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16346 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16347 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16348 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16349 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16350 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16351 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16352 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16353 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16354 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16355 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16356 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16357 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16358 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16359 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16360 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16362 ;; All the other keys
16364 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16365 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16366 (if (boundp 'narrow-map)
16367 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16368 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16369 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16370 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16371 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16372 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16373 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16374 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16375 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16376 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16377 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16378 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16379 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16380 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16381 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16382 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16383 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16384 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16386 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16387 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16388 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16389 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16390 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16391 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16392 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16393 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16394 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16395 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16396 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16397 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16398 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16399 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16400 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16401 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16402 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16403 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16404 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16406 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16407 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16408 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16409 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16410 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16411 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16412 (org-defkey org-mode-map "\C-c^" 'org-sort)
16413 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16414 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16415 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16416 (org-defkey org-mode-map "\C-m" 'org-return)
16417 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16418 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16419 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16420 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16421 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16422 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16423 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16424 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16425 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16426 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16427 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16428 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16429 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16430 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16431 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16432 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16433 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16434 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16435 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16436 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16437 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16439 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16440 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16441 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16442 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16444 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16445 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16446 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16447 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16448 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16449 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16450 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16451 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16452 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16453 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16455 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16456 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16457 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16458 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16459 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16460 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16461 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16463 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16464 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16465 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16466 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16467 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16469 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16471 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16473 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16474 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16476 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16479 (when (featurep 'xemacs)
16480 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16483 (defconst org-speed-commands-default
16484 '(
16485 ("Outline Navigation")
16486 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16487 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16488 ("f" . (org-speed-move-safe 'org-forward-same-level))
16489 ("b" . (org-speed-move-safe 'org-backward-same-level))
16490 ("u" . (org-speed-move-safe 'outline-up-heading))
16491 ("j" . org-goto)
16492 ("g" . (org-refile t))
16493 ("Outline Visibility")
16494 ("c" . org-cycle)
16495 ("C" . org-shifttab)
16496 (" " . org-display-outline-path)
16497 ("Outline Structure Editing")
16498 ("U" . org-shiftmetaup)
16499 ("D" . org-shiftmetadown)
16500 ("r" . org-metaright)
16501 ("l" . org-metaleft)
16502 ("R" . org-shiftmetaright)
16503 ("L" . org-shiftmetaleft)
16504 ("i" . (progn (forward-char 1) (call-interactively
16505 'org-insert-heading-respect-content)))
16506 ("^" . org-sort)
16507 ("w" . org-refile)
16508 ("a" . org-archive-subtree-default-with-confirmation)
16509 ("." . outline-mark-subtree)
16510 ("Clock Commands")
16511 ("I" . org-clock-in)
16512 ("O" . org-clock-out)
16513 ("Meta Data Editing")
16514 ("t" . org-todo)
16515 ("0" . (org-priority ?\ ))
16516 ("1" . (org-priority ?A))
16517 ("2" . (org-priority ?B))
16518 ("3" . (org-priority ?C))
16519 (";" . org-set-tags-command)
16520 ("e" . org-set-effort)
16521 ("Agenda Views etc")
16522 ("v" . org-agenda)
16523 ("/" . org-sparse-tree)
16524 ("Misc")
16525 ("o" . org-open-at-point)
16526 ("?" . org-speed-command-help)
16527 ("<" . (org-agenda-set-restriction-lock 'subtree))
16528 (">" . (org-agenda-remove-restriction-lock))
16529 )
16530 "The default speed commands.")
16532 (defun org-print-speed-command (e)
16533 (if (> (length (car e)) 1)
16534 (progn
16536 (princ (car e))
16538 (princ (make-string (length (car e)) ?-))
16540 (princ (car e))
16541 (princ " ")
16542 (if (symbolp (cdr e))
16543 (princ (symbol-name (cdr e)))
16544 (prin1 (cdr e)))
16547 (defun org-speed-command-help ()
16548 "Show the available speed commands."
16549 (interactive)
16550 (if (not org-use-speed-commands)
16551 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16552 (with-output-to-temp-buffer "*Help*"
16554 (mapc 'org-print-speed-command org-speed-commands-user)
16557 (mapc 'org-print-speed-command org-speed-commands-default))
16558 (with-current-buffer "*Help*"
16559 (setq truncate-lines t))))
16561 (defun org-speed-move-safe (cmd)
16562 "Execute CMD, but make sure that the cursor always ends up in a headline.
16563 If not, return to the original position and throw an error."
16564 (interactive)
16565 (let ((pos (point)))
16566 (call-interactively cmd)
16567 (unless (and (bolp) (org-on-heading-p))
16568 (goto-char pos)
16569 (error "Boundary reached while executing %s" cmd))))
16571 (defvar org-self-insert-command-undo-counter 0)
16573 (defvar org-table-auto-blank-field) ; defined in org-table.el
16574 (defvar org-speed-command nil)
16576 (defun org-speed-command-default-hook (keys)
16577 "Hook for activating single-letter speed commands.
16578 `org-speed-commands-default' specifies a minimal command set. Use
16579 `org-speed-commands-user' for further customization."
16580 (when (or (and (bolp) (looking-at outline-regexp))
16581 (and (functionp org-use-speed-commands)
16582 (funcall org-use-speed-commands)))
16583 (cdr (assoc keys (append org-speed-commands-user
16584 org-speed-commands-default)))))
16586 (defun org-babel-speed-command-hook (keys)
16587 "Hook for activating single-letter code block commands."
16588 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16589 (cdr (assoc keys org-babel-key-bindings))))
16591 (defcustom org-speed-command-hook
16592 '(org-speed-command-default-hook org-babel-speed-command-hook)
16593 "Hook for activating speed commands at strategic locations.
16594 Hook functions are called in sequence until a valid handler is
16595 found.
16597 Each hook takes a single argument, a user-pressed command key
16598 which is also a `self-insert-command' from the global map.
16600 Within the hook, examine the cursor position and the command key
16601 and return nil or a valid handler as appropriate. Handler could
16602 be one of an interactive command, a function, or a form.
16604 Set `org-use-speed-commands' to non-nil value to enable this
16605 hook. The default setting is `org-speed-command-default-hook'."
16606 :group 'org-structure
16607 :type 'hook)
16609 (defun org-self-insert-command (N)
16610 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16611 If the cursor is in a table looking at whitespace, the whitespace is
16612 overwritten, and the table is not marked as requiring realignment."
16613 (interactive "p")
16614 (cond
16615 ((and org-use-speed-commands
16616 (setq org-speed-command
16617 (run-hook-with-args-until-success
16618 'org-speed-command-hook (this-command-keys))))
16619 (cond
16620 ((commandp org-speed-command)
16621 (setq this-command org-speed-command)
16622 (call-interactively org-speed-command))
16623 ((functionp org-speed-command)
16624 (funcall org-speed-command))
16625 ((and org-speed-command (listp org-speed-command))
16626 (eval org-speed-command))
16627 (t (let (org-use-speed-commands)
16628 (call-interactively 'org-self-insert-command)))))
16629 ((and
16630 (org-table-p)
16631 (progn
16632 ;; check if we blank the field, and if that triggers align
16633 (and (featurep 'org-table) org-table-auto-blank-field
16634 (member last-command
16635 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16637 ;; got extra space, this field does not determine column width
16638 (let (org-table-may-need-update) (org-table-blank-field))
16639 ;; no extra space, this field may determine column width
16640 (org-table-blank-field)))
16641 t)
16642 (eq N 1)
16644 (let (org-table-may-need-update)
16645 (goto-char (1- (match-end 0)))
16646 (delete-backward-char 1)
16647 (goto-char (match-beginning 0))
16648 (self-insert-command N)))
16649 (t
16650 (setq org-table-may-need-update t)
16651 (self-insert-command N)
16652 (org-fix-tags-on-the-fly)
16653 (if org-self-insert-cluster-for-undo
16654 (if (not (eq last-command 'org-self-insert-command))
16655 (setq org-self-insert-command-undo-counter 1)
16656 (if (>= org-self-insert-command-undo-counter 20)
16657 (setq org-self-insert-command-undo-counter 1)
16658 (and (> org-self-insert-command-undo-counter 0)
16659 buffer-undo-list
16660 (not (cadr buffer-undo-list)) ; remove nil entry
16661 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16662 (setq org-self-insert-command-undo-counter
16663 (1+ org-self-insert-command-undo-counter))))))))
16665 (defun org-fix-tags-on-the-fly ()
16666 (when (and (equal (char-after (point-at-bol)) ?*)
16667 (org-on-heading-p))
16668 (org-align-tags-here org-tags-column)))
16670 (defun org-delete-backward-char (N)
16671 "Like `delete-backward-char', insert whitespace at field end in tables.
16672 When deleting backwards, in tables this function will insert whitespace in
16674 still be marked for re-alignment if the field did fill the entire column,
16675 because, in this case the deletion might narrow the column."
16676 (interactive "p")
16677 (if (and (org-table-p)
16678 (eq N 1)
16679 (string-match "|" (buffer-substring (point-at-bol) (point)))
16680 (looking-at ".*?|"))
16681 (let ((pos (point))
16683 (c org-table-may-need-update))
16684 (backward-delete-char N)
16685 (if (not overwrite-mode)
16686 (progn
16687 (skip-chars-forward "^|")
16688 (insert " ")
16689 (goto-char (1- pos))))
16690 ;; noalign: if there were two spaces at the end, this field
16691 ;; does not determine the width of the column.
16692 (if noalign (setq org-table-may-need-update c)))
16693 (backward-delete-char N)
16694 (org-fix-tags-on-the-fly)))
16696 (defun org-delete-char (N)
16697 "Like `delete-char', but insert whitespace at field end in tables.
16698 When deleting characters, in tables this function will insert whitespace in
16700 still be marked for re-alignment if the field did fill the entire column,
16701 because, in this case the deletion might narrow the column."
16702 (interactive "p")
16703 (if (and (org-table-p)
16704 (not (bolp))
16705 (not (= (char-after) ?|))
16706 (eq N 1))
16707 (if (looking-at ".*?|")
16708 (let ((pos (point))
16710 (c org-table-may-need-update))
16711 (replace-match (concat
16712 (substring (match-string 0) 1 -1)
16713 " |"))
16714 (goto-char pos)
16715 ;; noalign: if there were two spaces at the end, this field
16716 ;; does not determine the width of the column.
16717 (if noalign (setq org-table-may-need-update c)))
16718 (delete-char N))
16719 (delete-char N)
16720 (org-fix-tags-on-the-fly)))
16722 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16723 (put 'org-self-insert-command 'delete-selection t)
16724 (put 'orgtbl-self-insert-command 'delete-selection t)
16725 (put 'org-delete-char 'delete-selection 'supersede)
16726 (put 'org-delete-backward-char 'delete-selection 'supersede)
16727 (put 'org-yank 'delete-selection 'yank)
16729 ;; Make `flyspell-mode' delay after some commands
16730 (put 'org-self-insert-command 'flyspell-delayed t)
16731 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16732 (put 'org-delete-char 'flyspell-delayed t)
16733 (put 'org-delete-backward-char 'flyspell-delayed t)
16735 ;; Make pabbrev-mode expand after org-mode commands
16736 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16737 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16739 ;; How to do this: Measure non-white length of current string
16740 ;; If equal to column width, we should realign.
16742 (defun org-remap (map &rest commands)
16743 "In MAP, remap the functions given in COMMANDS.
16744 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16745 (let (new old)
16746 (while commands
16747 (setq old (pop commands) new (pop commands))
16748 (if (fboundp 'command-remapping)
16749 (org-defkey map (vector 'remap old) new)
16750 (substitute-key-definition old new map global-map)))))
16752 (when (eq org-enable-table-editor 'optimized)
16753 ;; If the user wants maximum table support, we need to hijack
16754 ;; some standard editing functions
16755 (org-remap org-mode-map
16756 'self-insert-command 'org-self-insert-command
16757 'delete-char 'org-delete-char
16758 'delete-backward-char 'org-delete-backward-char)
16759 (org-defkey org-mode-map "|" 'org-force-self-insert))
16761 (defvar org-ctrl-c-ctrl-c-hook nil
16762 "Hook for functions attaching themselves to `C-c C-c'.
16763 This can be used to add additional functionality to the C-c C-c key which
16764 executes context-dependent commands.
16765 Each function will be called with no arguments. The function must check
16766 if the context is appropriate for it to act. If yes, it should do its
16767 thing and then return a non-nil value. If the context is wrong,
16768 just do nothing and return nil.")
16770 (defvar org-tab-first-hook nil
16771 "Hook for functions to attach themselves to TAB.
16772 See `org-ctrl-c-ctrl-c-hook' for more information.
16773 This hook runs as the first action when TAB is pressed, even before
16774 `org-cycle' messes around with the `outline-regexp' to cater for
16775 inline tasks and plain list item folding.
16776 If any function in this hook returns t, any other actions that
16777 would have been caused by TAB (such as table field motion or visibility
16778 cycling) will not occur.")
16780 (defvar org-tab-after-check-for-table-hook nil
16781 "Hook for functions to attach themselves to TAB.
16782 See `org-ctrl-c-ctrl-c-hook' for more information.
16783 This hook runs after it has been established that the cursor is not in a
16784 table, but before checking if the cursor is in a headline or if global cycling
16785 should be done.
16786 If any function in this hook returns t, not other actions like visibility
16787 cycling will be done.")
16789 (defvar org-tab-after-check-for-cycling-hook nil
16790 "Hook for functions to attach themselves to TAB.
16791 See `org-ctrl-c-ctrl-c-hook' for more information.
16792 This hook runs after it has been established that not table field motion and
16793 not visibility should be done because of current context. This is probably
16794 the place where a package like yasnippets can hook in.")
16796 (defvar org-tab-before-tab-emulation-hook nil
16797 "Hook for functions to attach themselves to TAB.
16798 See `org-ctrl-c-ctrl-c-hook' for more information.
16799 This hook runs after every other options for TAB have been exhausted, but
16802 (defvar org-metaleft-hook nil
16803 "Hook for functions attaching themselves to `M-left'.
16804 See `org-ctrl-c-ctrl-c-hook' for more information.")
16805 (defvar org-metaright-hook nil
16806 "Hook for functions attaching themselves to `M-right'.
16807 See `org-ctrl-c-ctrl-c-hook' for more information.")
16808 (defvar org-metaup-hook nil
16809 "Hook for functions attaching themselves to `M-up'.
16810 See `org-ctrl-c-ctrl-c-hook' for more information.")
16811 (defvar org-metadown-hook nil
16812 "Hook for functions attaching themselves to `M-down'.
16813 See `org-ctrl-c-ctrl-c-hook' for more information.")
16814 (defvar org-shiftmetaleft-hook nil
16815 "Hook for functions attaching themselves to `M-S-left'.
16816 See `org-ctrl-c-ctrl-c-hook' for more information.")
16817 (defvar org-shiftmetaright-hook nil
16818 "Hook for functions attaching themselves to `M-S-right'.
16819 See `org-ctrl-c-ctrl-c-hook' for more information.")
16820 (defvar org-shiftmetaup-hook nil
16821 "Hook for functions attaching themselves to `M-S-up'.
16822 See `org-ctrl-c-ctrl-c-hook' for more information.")
16823 (defvar org-shiftmetadown-hook nil
16824 "Hook for functions attaching themselves to `M-S-down'.
16825 See `org-ctrl-c-ctrl-c-hook' for more information.")
16826 (defvar org-metareturn-hook nil
16827 "Hook for functions attaching themselves to `M-RET'.
16828 See `org-ctrl-c-ctrl-c-hook' for more information.")
16829 (defvar org-shiftup-hook nil
16830 "Hook for functions attaching themselves to `S-up'.
16831 See `org-ctrl-c-ctrl-c-hook' for more information.")
16832 (defvar org-shiftup-final-hook nil
16833 "Hook for functions attaching themselves to `S-up'.
16834 This one runs after all other options except shift-select have been excluded.
16835 See `org-ctrl-c-ctrl-c-hook' for more information.")
16836 (defvar org-shiftdown-hook nil
16837 "Hook for functions attaching themselves to `S-down'.
16838 See `org-ctrl-c-ctrl-c-hook' for more information.")
16839 (defvar org-shiftdown-final-hook nil
16840 "Hook for functions attaching themselves to `S-down'.
16841 This one runs after all other options except shift-select have been excluded.
16842 See `org-ctrl-c-ctrl-c-hook' for more information.")
16843 (defvar org-shiftleft-hook nil
16844 "Hook for functions attaching themselves to `S-left'.
16845 See `org-ctrl-c-ctrl-c-hook' for more information.")
16846 (defvar org-shiftleft-final-hook nil
16847 "Hook for functions attaching themselves to `S-left'.
16848 This one runs after all other options except shift-select have been excluded.
16849 See `org-ctrl-c-ctrl-c-hook' for more information.")
16850 (defvar org-shiftright-hook nil
16851 "Hook for functions attaching themselves to `S-right'.
16852 See `org-ctrl-c-ctrl-c-hook' for more information.")
16853 (defvar org-shiftright-final-hook nil
16854 "Hook for functions attaching themselves to `S-right'.
16855 This one runs after all other options except shift-select have been excluded.
16856 See `org-ctrl-c-ctrl-c-hook' for more information.")
16858 (defun org-modifier-cursor-error ()
16859 "Throw an error, a modified cursor command was applied in wrong context."
16860 (error "This command is active in special context like tables, headlines or items"))
16862 (defun org-shiftselect-error ()
16863 "Throw an error because Shift-Cursor command was applied in wrong context."
16864 (if (and (boundp 'shift-select-mode) shift-select-mode)
16865 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16866 (error "This command works only in special context like headlines or timestamps")))
16868 (defun org-call-for-shift-select (cmd)
16869 (let ((this-command-keys-shift-translated t))
16870 (call-interactively cmd)))
16872 (defun org-shifttab (&optional arg)
16873 "Global visibility cycling or move to previous table field.
16874 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16875 on context.
16876 See the individual commands for more information."
16877 (interactive "P")
16878 (cond
16879 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16880 ((integerp arg)
16881 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16882 (message "Content view to level: %d" arg)
16883 (org-content (prefix-numeric-value arg2))
16884 (setq org-cycle-global-status 'overview)))
16885 (t (call-interactively 'org-global-cycle))))
16887 (defun org-shiftmetaleft ()
16888 "Promote subtree or delete table column.
16889 Calls `org-promote-subtree', `org-outdent-item',
16890 or `org-table-delete-column', depending on context.
16891 See the individual commands for more information."
16892 (interactive)
16893 (cond
16894 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16895 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16896 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16897 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16898 (t (org-modifier-cursor-error))))
16900 (defun org-shiftmetaright ()
16901 "Demote subtree or insert table column.
16902 Calls `org-demote-subtree', `org-indent-item',
16903 or `org-table-insert-column', depending on context.
16904 See the individual commands for more information."
16905 (interactive)
16906 (cond
16907 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16908 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16909 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16910 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16911 (t (org-modifier-cursor-error))))
16913 (defun org-shiftmetaup (&optional arg)
16914 "Move subtree up or kill table row.
16915 Calls `org-move-subtree-up' or `org-table-kill-row' or
16916 `org-move-item-up' depending on context. See the individual commands
16917 for more information."
16918 (interactive "P")
16919 (cond
16920 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16921 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16922 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16923 ((org-at-item-p) (call-interactively 'org-move-item-up))
16924 (t (org-modifier-cursor-error))))
16926 (defun org-shiftmetadown (&optional arg)
16927 "Move subtree down or insert table row.
16928 Calls `org-move-subtree-down' or `org-table-insert-row' or
16929 `org-move-item-down', depending on context. See the individual
16930 commands for more information."
16931 (interactive "P")
16932 (cond
16933 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16934 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16935 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16936 ((org-at-item-p) (call-interactively 'org-move-item-down))
16937 (t (org-modifier-cursor-error))))
16939 (defsubst org-hidden-tree-error ()
16940 (error
16941 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16943 (defun org-metaleft (&optional arg)
16944 "Promote heading or move table column to left.
16945 Calls `org-do-promote' or `org-table-move-column', depending on context.
16946 With no specific context, calls the Emacs default `backward-word'.
16947 See the individual commands for more information."
16948 (interactive "P")
16949 (cond
16950 ((run-hook-with-args-until-success 'org-metaleft-hook))
16951 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16952 ((or (org-on-heading-p)
16953 (and (org-region-active-p)
16954 (save-excursion
16955 (goto-char (region-beginning))
16956 (org-on-heading-p))))
16957 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16958 (call-interactively 'org-do-promote))
16959 ((or (org-at-item-p)
16960 (and (org-region-active-p)
16961 (save-excursion
16962 (goto-char (region-beginning))
16963 (org-at-item-p))))
16964 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16965 (call-interactively 'org-outdent-item))
16966 (t (call-interactively 'backward-word))))
16968 (defun org-metaright (&optional arg)
16969 "Demote subtree or move table column to right.
16970 Calls `org-do-demote' or `org-table-move-column', depending on context.
16971 With no specific context, calls the Emacs default `forward-word'.
16972 See the individual commands for more information."
16973 (interactive "P")
16974 (cond
16975 ((run-hook-with-args-until-success 'org-metaright-hook))
16976 ((org-at-table-p) (call-interactively 'org-table-move-column))
16977 ((or (org-on-heading-p)
16978 (and (org-region-active-p)
16979 (save-excursion
16980 (goto-char (region-beginning))
16981 (org-on-heading-p))))
16982 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16983 (call-interactively 'org-do-demote))
16984 ((or (org-at-item-p)
16985 (and (org-region-active-p)
16986 (save-excursion
16987 (goto-char (region-beginning))
16988 (org-at-item-p))))
16989 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16990 (call-interactively 'org-indent-item))
16991 (t (call-interactively 'forward-word))))
16993 (defun org-check-for-hidden (what)
16994 "Check if there are hidden headlines/items in the current visual line.
16995 WHAT can be either `headlines' or `items'. If the current line is
16996 an outline or item heading and it has a folded subtree below it,
16997 this function returns t, nil otherwise."
16998 (let ((re (cond
16999 ((eq what 'headlines) (concat "^" org-outline-regexp))
17000 ((eq what 'items) (concat "^" (org-item-re t)))
17001 (t (error "This should not happen"))))
17002 beg end)
17003 (save-excursion
17004 (catch 'exit
17005 (unless (org-region-active-p)
17006 (setq beg (point-at-bol))
17007 (beginning-of-line 2)
17008 (while (and (not (eobp)) ;; this is like `next-line'
17009 (get-char-property (1- (point)) 'invisible))
17010 (beginning-of-line 2))
17011 (setq end (point))
17012 (goto-char beg)
17013 (goto-char (point-at-eol))
17014 (setq end (max end (point)))
17015 (while (re-search-forward re end t)
17016 (if (get-char-property (match-beginning 0) 'invisible)
17017 (throw 'exit t))))
17018 nil))))
17020 (defun org-metaup (&optional arg)
17021 "Move subtree up or move table row up.
17022 Calls `org-move-subtree-up' or `org-table-move-row' or
17023 `org-move-item-up', depending on context. See the individual commands
17024 for more information."
17025 (interactive "P")
17026 (cond
17027 ((run-hook-with-args-until-success 'org-metaup-hook))
17028 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17029 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17030 ((org-at-item-p) (call-interactively 'org-move-item-up))
17031 (t (transpose-lines 1) (beginning-of-line -1))))
17033 (defun org-metadown (&optional arg)
17034 "Move subtree down or move table row down.
17035 Calls `org-move-subtree-down' or `org-table-move-row' or
17036 `org-move-item-down', depending on context. See the individual
17037 commands for more information."
17038 (interactive "P")
17039 (cond
17040 ((run-hook-with-args-until-success 'org-metadown-hook))
17041 ((org-at-table-p) (call-interactively 'org-table-move-row))
17042 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17043 ((org-at-item-p) (call-interactively 'org-move-item-down))
17044 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17046 (defun org-shiftup (&optional arg)
17047 "Increase item in timestamp or increase priority of current headline.
17048 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17049 depending on context. See the individual commands for more information."
17050 (interactive "P")
17051 (cond
17052 ((run-hook-with-args-until-success 'org-shiftup-hook))
17053 ((and org-support-shift-select (org-region-active-p))
17054 (org-call-for-shift-select 'previous-line))
17055 ((org-at-timestamp-p t)
17056 (call-interactively (if org-edit-timestamp-down-means-later
17057 'org-timestamp-down 'org-timestamp-up)))
17058 ((and (not (eq org-support-shift-select 'always))
17059 org-enable-priority-commands
17060 (org-on-heading-p))
17061 (call-interactively 'org-priority-up))
17062 ((and (not org-support-shift-select) (org-at-item-p))
17063 (call-interactively 'org-previous-item))
17064 ((org-clocktable-try-shift 'up arg))
17065 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17066 (org-support-shift-select
17067 (org-call-for-shift-select 'previous-line))
17068 (t (org-shiftselect-error))))
17070 (defun org-shiftdown (&optional arg)
17071 "Decrease item in timestamp or decrease priority of current headline.
17072 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17073 depending on context. See the individual commands for more information."
17074 (interactive "P")
17075 (cond
17076 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17077 ((and org-support-shift-select (org-region-active-p))
17078 (org-call-for-shift-select 'next-line))
17079 ((org-at-timestamp-p t)
17080 (call-interactively (if org-edit-timestamp-down-means-later
17081 'org-timestamp-up 'org-timestamp-down)))
17082 ((and (not (eq org-support-shift-select 'always))
17083 org-enable-priority-commands
17084 (org-on-heading-p))
17085 (call-interactively 'org-priority-down))
17086 ((and (not org-support-shift-select) (org-at-item-p))
17087 (call-interactively 'org-next-item))
17088 ((org-clocktable-try-shift 'down arg))
17089 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17090 (org-support-shift-select
17091 (org-call-for-shift-select 'next-line))
17092 (t (org-shiftselect-error))))
17094 (defun org-shiftright (&optional arg)
17095 "Cycle the thing at point or in the current line, depending on context.
17096 Depending on context, this does one of the following:
17098 - switch a timestamp at point one day into the future
17099 - on a headline, switch to the next TODO keyword.
17100 - on an item, switch entire list to the next bullet type
17101 - on a property line, switch to the next allowed value
17102 - on a clocktable definition line, move time block into the future"
17103 (interactive "P")
17104 (cond
17105 ((run-hook-with-args-until-success 'org-shiftright-hook))
17106 ((and org-support-shift-select (org-region-active-p))
17107 (org-call-for-shift-select 'forward-char))
17108 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17109 ((and (not (eq org-support-shift-select 'always))
17110 (org-on-heading-p))
17111 (let ((org-inhibit-logging
17112 (not org-treat-S-cursor-todo-selection-as-state-change))
17113 (org-inhibit-blocking
17114 (not org-treat-S-cursor-todo-selection-as-state-change)))
17115 (org-call-with-arg 'org-todo 'right)))
17116 ((or (and org-support-shift-select
17117 (not (eq org-support-shift-select 'always))
17118 (org-at-item-bullet-p))
17119 (and (not org-support-shift-select) (org-at-item-p)))
17120 (org-call-with-arg 'org-cycle-list-bullet nil))
17121 ((and (not (eq org-support-shift-select 'always))
17122 (org-at-property-p))
17123 (call-interactively 'org-property-next-allowed-value))
17124 ((org-clocktable-try-shift 'right arg))
17125 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17126 (org-support-shift-select
17127 (org-call-for-shift-select 'forward-char))
17128 (t (org-shiftselect-error))))
17130 (defun org-shiftleft (&optional arg)
17131 "Cycle the thing at point or in the current line, depending on context.
17132 Depending on context, this does one of the following:
17134 - switch a timestamp at point one day into the past
17135 - on a headline, switch to the previous TODO keyword.
17136 - on an item, switch entire list to the previous bullet type
17137 - on a property line, switch to the previous allowed value
17138 - on a clocktable definition line, move time block into the past"
17139 (interactive "P")
17140 (cond
17141 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17142 ((and org-support-shift-select (org-region-active-p))
17143 (org-call-for-shift-select 'backward-char))
17144 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17145 ((and (not (eq org-support-shift-select 'always))
17146 (org-on-heading-p))
17147 (let ((org-inhibit-logging
17148 (not org-treat-S-cursor-todo-selection-as-state-change))
17149 (org-inhibit-blocking
17150 (not org-treat-S-cursor-todo-selection-as-state-change)))
17151 (org-call-with-arg 'org-todo 'left)))
17152 ((or (and org-support-shift-select
17153 (not (eq org-support-shift-select 'always))
17154 (org-at-item-bullet-p))
17155 (and (not org-support-shift-select) (org-at-item-p)))
17156 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17157 ((and (not (eq org-support-shift-select 'always))
17158 (org-at-property-p))
17159 (call-interactively 'org-property-previous-allowed-value))
17160 ((org-clocktable-try-shift 'left arg))
17161 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17162 (org-support-shift-select
17163 (org-call-for-shift-select 'backward-char))
17164 (t (org-shiftselect-error))))
17166 (defun org-shiftcontrolright ()
17167 "Switch to next TODO set."
17168 (interactive)
17169 (cond
17170 ((and org-support-shift-select (org-region-active-p))
17171 (org-call-for-shift-select 'forward-word))
17172 ((and (not (eq org-support-shift-select 'always))
17173 (org-on-heading-p))
17174 (org-call-with-arg 'org-todo 'nextset))
17175 (org-support-shift-select
17176 (org-call-for-shift-select 'forward-word))
17177 (t (org-shiftselect-error))))
17179 (defun org-shiftcontrolleft ()
17180 "Switch to previous TODO set."
17181 (interactive)
17182 (cond
17183 ((and org-support-shift-select (org-region-active-p))
17184 (org-call-for-shift-select 'backward-word))
17185 ((and (not (eq org-support-shift-select 'always))
17186 (org-on-heading-p))
17187 (org-call-with-arg 'org-todo 'previousset))
17188 (org-support-shift-select
17189 (org-call-for-shift-select 'backward-word))
17190 (t (org-shiftselect-error))))
17192 (defun org-ctrl-c-ret ()
17193 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17194 (interactive)
17195 (cond
17196 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17197 (t (call-interactively 'org-insert-heading))))
17199 (defun org-copy-special ()
17200 "Copy region in table or copy current subtree.
17201 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17202 See the individual commands for more information."
17203 (interactive)
17204 (call-interactively
17205 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17207 (defun org-cut-special ()
17208 "Cut region in table or cut current subtree.
17209 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17210 See the individual commands for more information."
17211 (interactive)
17212 (call-interactively
17213 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17215 (defun org-paste-special (arg)
17216 "Paste rectangular region into table, or past subtree relative to level.
17217 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17218 See the individual commands for more information."
17219 (interactive "P")
17220 (if (org-at-table-p)
17221 (org-table-paste-rectangle)
17222 (org-paste-subtree arg)))
17224 (defun org-edit-special (&optional arg)
17225 "Call a special editor for the stuff at point.
17226 When at a table, call the formula editor with `org-table-edit-formulas'.
17227 When at the first line of an src example, call `org-edit-src-code'.
17228 When in an #+include line, visit the include file. Otherwise call
17229 `ffap' to visit the file at point."
17230 (interactive)
17231 ;; possibly prep session before editing source
17232 (when arg
17233 (let* ((info (org-babel-get-src-block-info))
17234 (lang (nth 0 info))
17235 (params (nth 2 info))
17236 (session (cdr (assoc :session params))))
17237 (when (and info session) ;; we are in a source-code block with a session
17238 (funcall
17239 (intern (concat "org-babel-prep-session:" lang)) session params))))
17240 (cond ;; proceed with `org-edit-special'
17241 ((save-excursion
17242 (beginning-of-line 1)
17243 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17244 (find-file (org-trim (match-string 1))))
17245 ((org-edit-src-code))
17246 ((org-edit-fixed-width-region))
17247 ((org-at-table.el-p)
17248 (org-edit-src-code))
17249 ((org-at-table-p)
17250 (call-interactively 'org-table-edit-formulas))
17251 (t (call-interactively 'ffap))))
17254 (defun org-ctrl-c-ctrl-c (&optional arg)
17255 "Set tags in headline, or update according to changed information at point.
17257 This command does many different things, depending on context:
17259 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17260 this is what we do.
17262 - If the cursor is on a statistics cookie, update it.
17264 - If the cursor is in a headline, prompt for tags and insert them
17265 into the current line, aligned to `org-tags-column'. When called
17266 with prefix arg, realign all tags in the current buffer.
17268 - If the cursor is in one of the special #+KEYWORD lines, this
17269 triggers scanning the buffer for these lines and updating the
17270 information.
17272 - If the cursor is inside a table, realign the table. This command
17273 works even if the automatic table editor has been turned off.
17275 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17276 the entire table.
17278 - If the cursor is at a footnote reference or definition, jump to
17279 the corresponding definition or references, respectively.
17281 - If the cursor is a the beginning of a dynamic block, update it.
17283 - If the current buffer is a capture buffer, close note and file it.
17285 - If the cursor is on a <<<target>>>, update radio targets and
17286 corresponding links in this buffer.
17288 - If the cursor is on a numbered item in a plain list, renumber the
17289 ordered list.
17291 - If the cursor is on a checkbox, toggle it.
17293 - If the cursor is on a code block, evaluate it. The variable
17294 `org-confirm-babel-evaluate' can be used to control prompting
17295 before code block evaluation, by default every code block
17296 evaluation requires confirmation. Code block evaluation can be
17297 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17298 (interactive "P")
17299 (let ((org-enable-table-editor t))
17300 (cond
17301 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17302 org-occur-highlights
17303 org-latex-fragment-image-overlays)
17304 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17305 (org-remove-occur-highlights)
17306 (org-remove-latex-fragment-image-overlays)
17307 (message "Temporary highlights/overlays removed from current buffer"))
17308 ((and (local-variable-p 'org-finish-function (current-buffer))
17309 (fboundp org-finish-function))
17310 (funcall org-finish-function))
17311 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17312 ((or (looking-at org-property-start-re)
17313 (org-at-property-p))
17314 (call-interactively 'org-property-action))
17315 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17317 (or (org-on-heading-p) (org-at-item-p)))
17318 (call-interactively 'org-update-statistics-cookies))
17319 ((org-on-heading-p) (call-interactively 'org-set-tags))
17320 ((org-at-table.el-p)
17321 (message "Use C-c ' to edit table.el tables"))
17322 ((org-at-table-p)
17323 (org-table-maybe-eval-formula)
17324 (if arg
17325 (call-interactively 'org-table-recalculate)
17326 (org-table-maybe-recalculate-line))
17327 (call-interactively 'org-table-align))
17328 ((or (org-footnote-at-reference-p)
17329 (org-footnote-at-definition-p))
17330 (call-interactively 'org-footnote-action))
17331 ((org-at-item-checkbox-p)
17332 (call-interactively 'org-list-repair)
17333 (call-interactively 'org-toggle-checkbox)
17334 (org-list-send-list 'maybe))
17335 ((org-at-item-p)
17336 (call-interactively 'org-list-repair)
17337 (when arg (call-interactively 'org-toggle-checkbox))
17338 (org-list-send-list 'maybe))
17339 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17340 ;; Dynamic block
17341 (beginning-of-line 1)
17342 (save-excursion (org-update-dblock)))
17343 ((save-excursion
17344 (beginning-of-line 1)
17346 (cond
17347 ((equal (match-string 1) "TBLFM")
17348 ;; Recalculate the table before this line
17349 (save-excursion
17350 (beginning-of-line 1)
17352 (if (org-at-table-p)
17353 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17354 (t
17355 (let ((org-inhibit-startup-visibility-stuff t)
17356 (org-startup-align-all-tables nil))
17357 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17358 (message "Local setup has been refreshed"))))
17359 ((org-clock-update-time-maybe))
17360 (t (error "C-c C-c can do nothing useful at this location")))))
17362 (defun org-mode-restart ()
17363 "Restart Org-mode, to scan again for special lines.
17364 Also updates the keyword regular expressions."
17365 (interactive)
17366 (org-mode)
17367 (message "Org-mode restarted"))
17369 (defun org-kill-note-or-show-branches ()
17370 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17371 (interactive)
17372 (if (not org-finish-function)
17373 (progn
17374 (hide-subtree)
17375 (call-interactively 'show-branches))
17376 (let ((org-note-abort t))
17377 (funcall org-finish-function))))
17379 (defun org-return (&optional indent)
17380 "Goto next table row or insert a newline.
17381 Calls `org-table-next-row' or `newline', depending on context.
17382 See the individual commands for more information."
17383 (interactive)
17384 (cond
17385 ((bobp) (if indent (newline-and-indent) (newline)))
17386 ((org-at-table-p)
17387 (org-table-justify-field-maybe)
17388 (call-interactively 'org-table-next-row))
17389 ((and org-return-follows-link
17390 (eq (get-text-property (point) 'face) 'org-link))
17391 (call-interactively 'org-open-at-point))
17392 ((and (org-at-heading-p)
17393 (looking-at
17395 (org-show-entry)
17396 (end-of-line 1)
17397 (newline))
17398 (t (if indent (newline-and-indent) (newline)))))
17400 (defun org-return-indent ()
17401 "Goto next table row or insert a newline and indent.
17402 Calls `org-table-next-row' or `newline-and-indent', depending on
17403 context. See the individual commands for more information."
17404 (interactive)
17405 (org-return t))
17407 (defun org-ctrl-c-star ()
17408 "Compute table, or change heading status of lines.
17409 Calls `org-table-recalculate' or `org-toggle-heading',
17410 depending on context."
17411 (interactive)
17412 (cond
17413 ((org-at-table-p)
17414 (call-interactively 'org-table-recalculate))
17415 (t
17416 ;; Convert all lines in region to list items
17417 (call-interactively 'org-toggle-heading))))
17419 (defun org-ctrl-c-minus ()
17420 "Insert separator line in table or modify bullet status of line.
17421 Also turns a plain line or a region of lines into list items.
17422 Calls `org-table-insert-hline', `org-toggle-item', or
17423 `org-cycle-list-bullet', depending on context."
17424 (interactive)
17425 (cond
17426 ((org-at-table-p)
17427 (call-interactively 'org-table-insert-hline))
17428 ((org-region-active-p)
17429 (call-interactively 'org-toggle-item))
17430 ((org-in-item-p)
17431 (call-interactively 'org-cycle-list-bullet))
17432 (t
17433 (call-interactively 'org-toggle-item))))
17435 (defun org-toggle-item ()
17436 "Convert headings or normal lines to items, items to normal lines.
17437 If there is no active region, only the current line is considered.
17439 If the first line in the region is a headline, convert all headlines to items.
17441 If the first line in the region is an item, convert all items to normal lines.
17443 If the first line is normal text, add an item bullet to each line."
17444 (interactive)
17445 (let (l2 l beg end)
17446 (if (org-region-active-p)
17447 (setq beg (region-beginning) end (region-end))
17448 (setq beg (point-at-bol)
17449 end (min (1+ (point-at-eol)) (point-max))))
17450 (save-excursion
17451 (goto-char end)
17452 (setq l2 (org-current-line))
17453 (goto-char beg)
17454 (beginning-of-line 1)
17455 (setq l (1- (org-current-line)))
17456 (if (org-at-item-p)
17457 ;; We already have items, de-itemize
17458 (while (< (setq l (1+ l)) l2)
17459 (when (org-at-item-p)
17461 (delete-region (point) (match-end 0)))
17462 (beginning-of-line 2))
17463 (if (org-on-heading-p)
17464 ;; Headings, convert to items
17465 (while (< (setq l (1+ l)) l2)
17466 (if (looking-at org-outline-regexp)
17467 (replace-match (org-list-bullet-string "-") t t))
17468 (beginning-of-line 2))
17469 ;; normal lines, turn them into items
17470 (while (< (setq l (1+ l)) l2)
17471 (unless (org-at-item-p)
17473 (replace-match
17475 (beginning-of-line 2)))))))
17477 (defun org-toggle-heading (&optional nstars)
17478 "Convert headings to normal text, or items or text to headings.
17479 If there is no active region, only the current line is considered.
17481 If the first line is a heading, remove the stars from all headlines
17482 in the region.
17484 If the first line is a plain list item, turn all plain list items
17485 into headings.
17487 If the first line is a normal line, turn each and every line in the
17488 region into a heading.
17490 When converting a line into a heading, the number of stars is chosen
17491 such that the lines become children of the current entry. However,
17492 when a prefix argument is given, its value determines the number of
17493 stars to add."
17494 (interactive "P")
17495 (let (l2 l itemp beg end)
17496 (if (org-region-active-p)
17497 (setq beg (region-beginning) end (region-end))
17498 (setq beg (point-at-bol)
17499 end (min (1+ (point-at-eol)) (point-max))))
17500 (save-excursion
17501 (goto-char end)
17502 (setq l2 (org-current-line))
17503 (goto-char beg)
17504 (beginning-of-line 1)
17505 (setq l (1- (org-current-line)))
17506 (if (org-on-heading-p)
17507 ;; We already have headlines, de-star them
17508 (while (< (setq l (1+ l)) l2)
17509 (when (org-on-heading-p t)
17510 (and (looking-at outline-regexp) (replace-match "")))
17511 (beginning-of-line 2))
17512 (setq itemp (org-at-item-p))
17513 (let* ((stars
17514 (if nstars
17515 (make-string (prefix-numeric-value current-prefix-arg)
17516 ?*)
17517 (save-excursion
17518 (if (re-search-backward org-complex-heading-regexp nil t)
17519 (match-string 1) ""))))
17520 (add-stars (cond (nstars "")
17521 ((equal stars "") "*")
17522 (org-odd-levels-only "**")
17523 (t "*")))
17524 (rpl (concat stars add-stars " ")))
17525 (while (< (setq l (1+ l)) l2)
17526 (if itemp
17527 (and (org-at-item-p) (replace-match rpl t t))
17528 (unless (org-on-heading-p)
17530 (replace-match (concat rpl (match-string 2))))))
17531 (beginning-of-line 2)))))))
17533 (defun org-meta-return (&optional arg)
17534 "Insert a new heading or wrap a region in a table.
17535 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17536 See the individual commands for more information."
17537 (interactive "P")
17538 (cond
17539 ((run-hook-with-args-until-success 'org-metareturn-hook))
17540 ((org-at-table-p)
17541 (call-interactively 'org-table-wrap-region))
17542 (t (call-interactively 'org-insert-heading))))
17544 ;;; Menu entries
17546 ;; Define the Org-mode menus
17547 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17548 '("Tbl"
17549 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17550 ["Next Field" org-cycle (org-at-table-p)]
17551 ["Previous Field" org-shifttab (org-at-table-p)]
17552 ["Next Row" org-return (org-at-table-p)]
17553 "--"
17554 ["Blank Field" org-table-blank-field (org-at-table-p)]
17555 ["Edit Field" org-table-edit-field (org-at-table-p)]
17556 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17557 "--"
17558 ("Column"
17559 ["Move Column Left" org-metaleft (org-at-table-p)]
17560 ["Move Column Right" org-metaright (org-at-table-p)]
17561 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17562 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17563 ("Row"
17564 ["Move Row Up" org-metaup (org-at-table-p)]
17565 ["Move Row Down" org-metadown (org-at-table-p)]
17566 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17567 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17568 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17569 "--"
17570 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17571 ("Rectangle"
17572 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17573 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17574 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17575 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17576 "--"
17577 ("Calculate"
17578 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17579 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17580 ["Edit Formulas" org-edit-special (org-at-table-p)]
17581 "--"
17582 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17583 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17584 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17585 "--"
17586 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17587 "--"
17588 ["Sum Column/Rectangle" org-table-sum
17589 (or (org-at-table-p) (org-region-active-p))]
17590 ["Which Column?" org-table-current-column (org-at-table-p)])
17591 ["Debug Formulas"
17592 org-table-toggle-formula-debugger
17593 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17594 ["Show Col/Row Numbers"
17595 org-table-toggle-coordinate-overlays
17596 :style toggle
17597 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17598 "--"
17599 ["Create" org-table-create (and (not (org-at-table-p))
17600 org-enable-table-editor)]
17601 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17602 ["Import from File" org-table-import (not (org-at-table-p))]
17603 ["Export to File" org-table-export (org-at-table-p)]
17604 "--"
17605 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17607 (easy-menu-define org-org-menu org-mode-map "Org menu"
17608 '("Org"
17609 ("Show/Hide"
17610 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17611 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17612 ["Sparse Tree..." org-sparse-tree t]
17613 ["Reveal Context" org-reveal t]
17614 ["Show All" show-all t]
17615 "--"
17616 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17617 "--"
17618 ["New Heading" org-insert-heading t]
17619 ("Navigate Headings"
17620 ["Up" outline-up-heading t]
17621 ["Next" outline-next-visible-heading t]
17622 ["Previous" outline-previous-visible-heading t]
17623 ["Next Same Level" outline-forward-same-level t]
17624 ["Previous Same Level" outline-backward-same-level t]
17625 "--"
17626 ["Jump" org-goto t])
17627 ("Edit Structure"
17628 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17629 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17630 "--"
17631 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17632 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17633 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17634 "--"
17635 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17636 "--"
17637 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17638 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17639 ["Demote Heading" org-metaright (not (org-at-table-p))]
17640 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17641 "--"
17642 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17643 "--"
17644 ["Convert to odd levels" org-convert-to-odd-levels t]
17645 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17646 ("Editing"
17647 ["Emphasis..." org-emphasize t]
17648 ["Edit Source Example" org-edit-special t]
17649 "--"
17650 ["Footnote new/jump" org-footnote-action t]
17651 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17652 ("Archive"
17653 ["Archive (default method)" org-archive-subtree-default t]
17654 "--"
17655 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17656 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17657 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17658 )
17659 "--"
17660 ("Hyperlinks"
17661 ["Store Link (Global)" org-store-link t]
17662 ["Find existing link to here" org-occur-link-in-agenda-files t]
17663 ["Insert Link" org-insert-link t]
17664 ["Follow Link" org-open-at-point t]
17665 "--"
17666 ["Next link" org-next-link t]
17667 ["Previous link" org-previous-link t]
17668 "--"
17669 ["Descriptive Links"
17670 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17671 :style radio
17672 :selected (member '(org-link) buffer-invisibility-spec)]
17673 ["Literal Links"
17674 (progn
17675 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17676 :style radio
17677 :selected (not (member '(org-link) buffer-invisibility-spec))])
17678 "--"
17679 ("TODO Lists"
17680 ["TODO/DONE/-" org-todo t]
17681 ("Select keyword"
17682 ["Next keyword" org-shiftright (org-on-heading-p)]
17683 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17684 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17685 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17686 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17687 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17688 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17689 "--"
17690 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17691 :selected org-enforce-todo-dependencies :style toggle :active t]
17692 "Settings for tree at point"
17693 ["Do Children sequentially" org-toggle-ordered-property :style radio
17694 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17695 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17696 ["Do Children parallel" org-toggle-ordered-property :style radio
17697 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17698 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17699 "--"
17700 ["Set Priority" org-priority t]
17701 ["Priority Up" org-shiftup t]
17702 ["Priority Down" org-shiftdown t]
17703 "--"
17704 ["Get news from all feeds" org-feed-update-all t]
17705 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17706 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17707 ("TAGS and Properties"
17708 ["Set Tags" org-set-tags-command t]
17709 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17710 "--"
17711 ["Set property" org-set-property t]
17712 ["Column view of properties" org-columns t]
17713 ["Insert Column View DBlock" org-insert-columns-dblock t])
17714 ("Dates and Scheduling"
17715 ["Timestamp" org-time-stamp t]
17716 ["Timestamp (inactive)" org-time-stamp-inactive t]
17717 ("Change Date"
17718 ["1 Day Later" org-shiftright t]
17719 ["1 Day Earlier" org-shiftleft t]
17720 ["1 ... Later" org-shiftup t]
17721 ["1 ... Earlier" org-shiftdown t])
17722 ["Compute Time Range" org-evaluate-time-range t]
17723 ["Schedule Item" org-schedule t]
17724 ["Deadline" org-deadline t]
17725 "--"
17726 ["Custom time format" org-toggle-time-stamp-overlays
17727 :style radio :selected org-display-custom-times]
17728 "--"
17729 ["Goto Calendar" org-goto-calendar t]
17730 ["Date from Calendar" org-date-from-calendar t]
17731 "--"
17732 ["Start/Restart Timer" org-timer-start t]
17733 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17734 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17735 ["Insert Timer String" org-timer t]
17736 ["Insert Timer Item" org-timer-item t])
17737 ("Logging work"
17738 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17739 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17740 ["Clock out" org-clock-out t]
17741 ["Clock cancel" org-clock-cancel t]
17742 "--"
17743 ["Mark as default task" org-clock-mark-default-task t]
17744 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17745 ["Goto running clock" org-clock-goto t]
17746 "--"
17747 ["Display times" org-clock-display t]
17748 ["Create clock table" org-clock-report t]
17749 "--"
17750 ["Record DONE time"
17751 (progn (setq org-log-done (not org-log-done))
17752 (message "Switching to %s will %s record a timestamp"
17753 (car org-done-keywords)
17754 (if org-log-done "automatically" "not")))
17755 :style toggle :selected org-log-done])
17756 "--"
17757 ["Agenda Command..." org-agenda t]
17758 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17759 ("File List for Agenda")
17760 ("Special views current file"
17761 ["TODO Tree" org-show-todo-tree t]
17762 ["Check Deadlines" org-check-deadlines t]
17763 ["Timeline" org-timeline t]
17764 ["Tags/Property tree" org-match-sparse-tree t])
17765 "--"
17766 ["Export/Publish..." org-export t]
17767 ("LaTeX"
17768 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17769 :selected org-cdlatex-mode]
17770 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17771 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17772 ["Modify math symbol" org-cdlatex-math-modify
17773 (org-inside-LaTeX-fragment-p)]
17774 ["Insert citation" org-reftex-citation t]
17775 "--"
17776 ["Template for BEAMER" org-insert-beamer-options-template t])
17777 "--"
17778 ("MobileOrg"
17779 ["Push Files and Views" org-mobile-push t]
17780 ["Get Captured and Flagged" org-mobile-pull t]
17781 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17782 "--"
17783 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17784 "--"
17785 ("Documentation"
17786 ["Show Version" org-version t]
17787 ["Info Documentation" org-info t])
17788 ("Customize"
17789 ["Browse Org Group" org-customize t]
17790 "--"
17791 ["Expand This Menu" org-create-customize-menu
17792 (fboundp 'customize-menu-create)])
17793 ["Send bug report" org-submit-bug-report t]
17794 "--"
17795 ("Refresh/Reload"
17796 ["Refresh setup current buffer" org-mode-restart t]
17797 ["Reload Org (after update)" org-reload t]
17798 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17799 ))
17801 (defun org-info (&optional node)
17802 "Read documentation for Org-mode in the info system.
17803 With optional NODE, go directly to that node."
17804 (interactive)
17805 (info (format "(org)%s" (or node ""))))
17807 ;;;###autoload
17808 (defun org-submit-bug-report ()
17809 "Submit a bug report on Org-mode via mail.
17811 Don't hesitate to report any problems or inaccurate documentation.
17813 If you don't have setup sending mail from (X)Emacs, please copy the
17814 output buffer into your mail program, as it gives us important
17815 information about your Org-mode version and configuration."
17816 (interactive)
17817 (require 'reporter)
17818 (org-load-modules-maybe)
17819 (org-require-autoloaded-modules)
17820 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17821 (reporter-submit-bug-report
17822 "emacs-orgmode@gnu.org"
17823 (org-version)
17824 (let (list)
17825 (save-window-excursion
17826 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17827 (delete-other-windows)
17828 (erase-buffer)
17829 (insert "You are about to submit a bug report to the Org-mode mailing list.
17831 We would like to add your full Org-mode and Outline configuration to the
17832 bug report. This greatly simplifies the work of the maintainer and
17833 other experts on the mailing list.
17835 HOWEVER, some variables you have customized may contain private
17836 information. The names of customers, colleagues, or friends, might
17837 appear in the form of file names, tags, todo states, or search strings.
17838 If you answer yes to the prompt, you might want to check and remove
17839 such private information before sending the email.")
17840 (add-text-properties (point-min) (point-max) '(face org-warning))
17841 (when (yes-or-no-p "Include your Org-mode configuration ")
17842 (mapatoms
17843 (lambda (v)
17844 (and (boundp v)
17846 (or (and (symbol-value v)
17848 (and
17849 (get v 'custom-type) (get v 'standard-value)
17850 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17851 (push v list)))))
17852 (kill-buffer (get-buffer "*Warn about privacy*"))
17853 list))
17854 nil nil
17855 "Remember to cover the basics, that is, what you expected to happen and
17856 what in fact did happen. You don't know how to make a good report? See
17858 http://orgmode.org/manual/Feedback.html#Feedback
17860 Your bug report will be posted to the Org-mode mailing list.
17861 ------------------------------------------------------------------------")
17862 (save-excursion
17867 (defun org-install-agenda-files-menu ()
17868 (let ((bl (buffer-list)))
17869 (save-excursion
17870 (while bl
17871 (set-buffer (pop bl))
17872 (if (org-mode-p) (setq bl nil)))
17873 (when (org-mode-p)
17874 (easy-menu-change
17875 '("Org") "File List for Agenda"
17876 (append
17877 (list
17878 ["Edit File List" (org-edit-agenda-file-list) t]
17879 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17880 ["Remove Current File from List" org-remove-file t]
17881 ["Cycle through agenda files" org-cycle-agenda-files t]
17882 ["Occur in all agenda files" org-occur-in-agenda-files t]
17883 "--")
17884 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17886 ;;;; Documentation
17888 ;;;###autoload
17889 (defun org-require-autoloaded-modules ()
17890 (interactive)
17891 (mapc 'require
17892 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17893 org-docbook org-exp org-html org-icalendar
17894 org-id org-latex
17895 org-publish org-remember org-table
17896 org-timer org-xoxo)))
17898 ;;;###autoload
17899 (defun org-reload (&optional uncompiled)
17900 "Reload all org lisp files.
17901 With prefix arg UNCOMPILED, load the uncompiled versions."
17902 (interactive "P")
17903 (require 'find-func)
17905 (dir-org (file-name-directory (org-find-library-name "org")))
17906 (dir-org-contrib (ignore-errors
17907 (file-name-directory
17908 (org-find-library-name "org-contribdir"))))
17909 (babel-files
17910 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17911 (append (list nil "comint" "eval" "exp" "keys"
17912 "lob" "ref" "table" "tangle")
17913 (delq nil
17914 (mapcar
17915 (lambda (lang)
17916 (when (cdr lang) (symbol-name (car lang))))
17917 org-babel-load-languages)))))
17918 (files
17919 (append (directory-files dir-org t file-re)
17920 babel-files
17921 (and dir-org-contrib
17922 (directory-files dir-org-contrib t file-re))))
17923 (remove-re (concat (if (featurep 'xemacs)
17924 "org-colview" "org-colview-xemacs")
17926 (setq files (mapcar 'file-name-sans-extension files))
17927 (setq files (mapcar
17928 (lambda (x) (if (string-match remove-re x) nil x))
17929 files))
17930 (setq files (delq nil files))
17931 (mapc
17932 (lambda (f)
17933 (when (featurep (intern (file-name-nondirectory f)))
17934 (if (and (not uncompiled)
17935 (file-exists-p (concat f ".elc")))
17936 (load (concat f ".elc") nil nil t)
17937 (load (concat f ".el") nil nil t))))
17938 files))
17939 (org-version))
17941 ;;;###autoload
17942 (defun org-customize ()
17943 "Call the customize function with org as argument."
17944 (interactive)
17945 (org-load-modules-maybe)
17946 (org-require-autoloaded-modules)
17947 (customize-browse 'org))
17949 (defun org-create-customize-menu ()
17950 "Create a full customization menu for Org-mode, insert it into the menu."
17951 (interactive)
17952 (org-load-modules-maybe)
17953 (org-require-autoloaded-modules)
17954 (if (fboundp 'customize-menu-create)
17955 (progn
17956 (easy-menu-change
17957 '("Org") "Customize"
17958 `(["Browse Org group" org-customize t]
17959 "--"
17960 ,(customize-menu-create 'org)
17961 ["Set" Custom-set t]
17962 ["Save" Custom-save t]
17963 ["Reset to Current" Custom-reset-current t]
17964 ["Reset to Saved" Custom-reset-saved t]
17965 ["Reset to Standard Settings" Custom-reset-standard t]))
17967 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17969 ;;;; Miscellaneous stuff
17971 ;;; Generally useful functions
17973 (defun org-get-at-bol (property)
17974 "Get text property PROPERTY at beginning of line."
17975 (get-text-property (point-at-bol) property))
17977 (defun org-find-text-property-in-string (prop s)
17978 "Return the first non-nil value of property PROP in string S."
17979 (or (get-text-property 0 prop s)
17980 (get-text-property (or (next-single-property-change 0 prop s) 0)
17981 prop s)))
17983 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17984 "Display the given MESSAGE as a warning."
17985 (if (fboundp 'display-warning)
17986 (display-warning 'org message
17987 (if (featurep 'xemacs) 'warning :warning))
17988 (let ((buf (get-buffer-create "*Org warnings*")))
17989 (with-current-buffer buf
17990 (goto-char (point-max))
17991 (insert "Warning (Org): " message)
17992 (unless (bolp)
17993 (newline)))
17994 (display-buffer buf)
17995 (sit-for 0))))
17997 (defun org-in-commented-line ()
17998 "Is point in a line starting with `#'?"
17999 (equal (char-after (point-at-bol)) ?#))
18001 (defun org-in-indented-comment-line ()
18002 "Is point in a line starting with `#' after some white space?"
18003 (save-excursion
18004 (save-match-data
18005 (goto-char (point-at-bol))
18008 (defun org-in-verbatim-emphasis ()
18009 (save-match-data
18010 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18012 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18013 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18014 (if (and marker (marker-buffer marker)
18015 (buffer-live-p (marker-buffer marker)))
18016 (progn
18017 (switch-to-buffer (marker-buffer marker))
18018 (if (or (> marker (point-max)) (< marker (point-min)))
18019 (widen))
18020 (goto-char marker)
18021 (org-show-context 'org-goto))
18022 (if bookmark
18023 (bookmark-jump bookmark)
18024 (error "Cannot find location"))))
18026 (defun org-quote-csv-field (s)
18027 "Quote field for inclusion in CSV material."
18030 s))
18032 (defun org-plist-delete (plist property)
18033 "Delete PROPERTY from PLIST.
18034 This is in contrast to merely setting it to 0."
18035 (let (p)
18036 (while plist
18037 (if (not (eq property (car plist)))
18038 (setq p (plist-put p (car plist) (nth 1 plist))))
18039 (setq plist (cddr plist)))
18040 p))
18042 (defun org-force-self-insert (N)
18043 "Needed to enforce self-insert under remapping."
18044 (interactive "p")
18045 (self-insert-command N))
18047 (defun org-string-width (s)
18048 "Compute width of string, ignoring invisible characters.
18049 This ignores character with invisibility property `org-link', and also
18050 characters with property `org-cwidth', because these will become invisible
18051 upon the next fontification round."
18052 (let (b l)
18053 (when (or (eq t buffer-invisibility-spec)
18054 (assq 'org-link buffer-invisibility-spec))
18055 (while (setq b (text-property-any 0 (length s)
18056 'invisible 'org-link s))
18057 (setq s (concat (substring s 0 b)
18058 (substring s (or (next-single-property-change
18059 b 'invisible s) (length s)))))))
18060 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18061 (setq s (concat (substring s 0 b)
18062 (substring s (or (next-single-property-change
18063 b 'org-cwidth s) (length s))))))
18064 (setq l (string-width s) b -1)
18065 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18066 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18067 l))
18069 (defun org-get-indentation (&optional line)
18070 "Get the indentation of the current line, interpreting tabs.
18071 When LINE is given, assume it represents a line and compute its indentation."
18072 (if line
18073 (if (string-match "^ *" (org-remove-tabs line))
18074 (match-end 0))
18075 (save-excursion
18076 (beginning-of-line 1)
18078 (current-column))))
18080 (defun org-remove-tabs (s &optional width)
18081 "Replace tabulators in S with spaces.
18082 Assumes that s is a single line, starting in column 0."
18083 (setq width (or width tab-width))
18085 (setq s (replace-match
18086 (make-string
18087 (- (* width (/ (+ (match-beginning 0) width) width))
18088 (match-beginning 0)) ?\ )
18089 t t s)))
18090 s)
18092 (defun org-fix-indentation (line ind)
18093 "Fix indentation in LINE.
18094 IND is a cons cell with target and minimum indentation.
18095 If the current indentation in LINE is smaller than the minimum,
18096 leave it alone. If it is larger than ind, set it to the target."
18097 (let* ((l (org-remove-tabs line))
18098 (i (org-get-indentation l))
18099 (i1 (car ind)) (i2 (cdr ind)))
18100 (if (>= i i2) (setq l (substring line i2)))
18101 (if (> i1 0)
18102 (concat (make-string i1 ?\ ) l)
18103 l)))
18105 (defun org-remove-indentation (code &optional n)
18106 "Remove the maximum common indentation from the lines in CODE.
18107 N may optionally be the number of spaces to remove."
18108 (with-temp-buffer
18109 (insert code)
18110 (org-do-remove-indentation n)
18111 (buffer-string)))
18113 (defun org-do-remove-indentation (&optional n)
18114 "Remove the maximum common indentation from the buffer."
18115 (untabify (point-min) (point-max))
18116 (let ((min 10000) re)
18117 (if n
18118 (setq min n)
18119 (goto-char (point-min))
18121 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18122 (unless (or (= min 0) (= min 10000))
18124 (goto-char (point-min))
18125 (while (re-search-forward re nil t)
18126 (replace-match "")
18127 (end-of-line 1))
18128 min)))
18130 (defun org-fill-template (template alist)
18131 "Find each %key of ALIST in TEMPLATE and replace it."
18132 (let ((case-fold-search nil)
18133 entry key value)
18134 (setq alist (sort (copy-sequence alist)
18135 (lambda (a b) (< (length (car a)) (length (car b))))))
18136 (while (setq entry (pop alist))
18137 (setq template
18138 (replace-regexp-in-string
18139 (concat "%" (regexp-quote (car entry)))
18140 (cdr entry) template t t)))
18141 template))
18143 (defun org-base-buffer (buffer)
18144 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18145 (if (not buffer)
18146 buffer
18147 (or (buffer-base-buffer buffer)
18148 buffer)))
18150 (defun org-trim (s)
18151 "Remove whitespace at beginning and end of string."
18154 s)
18156 (defun org-wrap (string &optional width lines)
18157 "Wrap string to either a number of lines, or a width in characters.
18158 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18159 that costs. If there is a word longer than WIDTH, the text is actually
18160 wrapped to the length of that word.
18161 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18162 many lines, whatever width that takes.
18163 The return value is a list of lines, without newlines at the end."
18165 (maxword (apply 'max (mapcar 'org-string-width words)))
18166 w ll)
18167 (cond (width
18168 (org-do-wrap words (max maxword width)))
18169 (lines
18170 (setq w maxword)
18171 (setq ll (org-do-wrap words maxword))
18172 (if (<= (length ll) lines)
18173 ll
18174 (setq ll words)
18175 (while (> (length ll) lines)
18176 (setq w (1+ w))
18177 (setq ll (org-do-wrap words w)))
18178 ll))
18179 (t (error "Cannot wrap this")))))
18181 (defun org-do-wrap (words width)
18182 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18183 (let (lines line)
18184 (while words
18185 (setq line (pop words))
18186 (while (and words (< (+ (length line) (length (car words))) width))
18187 (setq line (concat line " " (pop words))))
18188 (setq lines (push line lines)))
18189 (nreverse lines)))
18191 (defun org-split-string (string &optional separators)
18192 "Splits STRING into substrings at SEPARATORS.
18193 No empty strings are returned if there are matches at the beginning
18194 and end of string."
18196 (start 0)
18197 notfirst
18198 (list nil))
18199 (while (and (string-match rexp string
18200 (if (and notfirst
18201 (= start (match-beginning 0))
18202 (< start (length string)))
18203 (1+ start) start))
18204 (< (match-beginning 0) (length string)))
18205 (setq notfirst t)
18206 (or (eq (match-beginning 0) 0)
18207 (and (eq (match-beginning 0) (match-end 0))
18208 (eq (match-beginning 0) start))
18209 (setq list
18210 (cons (substring string start (match-beginning 0))
18211 list)))
18212 (setq start (match-end 0)))
18213 (or (eq start (length string))
18214 (setq list
18215 (cons (substring string start)
18216 list)))
18217 (nreverse list)))
18219 (defun org-quote-vert (s)
18221 (while (string-match "|" s)
18223 s)
18225 (defun org-uuidgen-p (s)
18226 "Is S an ID created by UUIDGEN?"
18227 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18229 (defun org-context ()
18230 "Return a list of contexts of the current cursor position.
18231 If several contexts apply, all are returned.
18232 Each context entry is a list with a symbol naming the context, and
18233 two positions indicating start and end of the context. Possible
18234 contexts are:
18236 :headline anywhere in a headline
18237 :headline-stars on the leading stars in a headline
18238 :todo-keyword on a TODO keyword (including DONE) in a headline
18239 :tags on the TAGS in a headline
18240 :priority on the priority cookie in a headline
18241 :item on the first line of a plain list item
18242 :item-bullet on the bullet/number of a plain list item
18243 :checkbox on the checkbox in a plain list item
18244 :table in an org-mode table
18245 :table-special on a special filed in a table
18246 :table-table in a table.el table
18247 :link on a hyperlink
18248 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18249 :target on a <<target>>
18250 :radio-target on a <<<radio-target>>>
18251 :latex-fragment on a LaTeX fragment
18252 :latex-preview on a LaTeX fragment with overlayed preview image
18254 This function expects the position to be visible because it uses font-lock
18255 faces as a help to recognize the following contexts: :table-special, :link,
18256 and :keyword."
18257 (let* ((f (get-text-property (point) 'face))
18258 (faces (if (listp f) f (list f)))
18259 (p (point)) clist o)
18260 ;; First the large context
18261 (cond
18262 ((org-on-heading-p t)
18263 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18264 (when (progn
18265 (beginning-of-line 1)
18266 (looking-at org-todo-line-tags-regexp))
18267 (push (org-point-in-group p 1 :headline-stars) clist)
18268 (push (org-point-in-group p 2 :todo-keyword) clist)
18269 (push (org-point-in-group p 4 :tags) clist))
18270 (goto-char p)
18273 (push (org-point-in-group p 0 :priority) clist)))
18275 ((org-at-item-p)
18276 (push (org-point-in-group p 2 :item-bullet) clist)
18277 (push (list :item (point-at-bol)
18278 (save-excursion (org-end-of-item) (point)))
18279 clist)
18280 (and (org-at-item-checkbox-p)
18281 (push (org-point-in-group p 0 :checkbox) clist)))
18283 ((org-at-table-p)
18284 (push (list :table (org-table-begin) (org-table-end)) clist)
18285 (if (memq 'org-formula faces)
18286 (push (list :table-special
18287 (previous-single-property-change p 'face)
18288 (next-single-property-change p 'face)) clist)))
18289 ((org-at-table-p 'any)
18290 (push (list :table-table) clist)))
18291 (goto-char p)
18293 ;; Now the small context
18294 (cond
18295 ((org-at-timestamp-p)
18296 (push (org-point-in-group p 0 :timestamp) clist))
18297 ((memq 'org-link faces)
18298 (push (list :link
18299 (previous-single-property-change p 'face)
18300 (next-single-property-change p 'face)) clist))
18301 ((memq 'org-special-keyword faces)
18302 (push (list :keyword
18303 (previous-single-property-change p 'face)
18304 (next-single-property-change p 'face)) clist))
18305 ((org-on-target-p)
18306 (push (org-point-in-group p 0 :target) clist)
18307 (goto-char (1- (match-beginning 0)))
18308 (if (looking-at org-radio-target-regexp)
18309 (push (org-point-in-group p 0 :radio-target) clist))
18310 (goto-char p))
18311 ((setq o (car (delq nil
18312 (mapcar
18313 (lambda (x)
18314 (if (memq x org-latex-fragment-image-overlays) x))
18315 (overlays-at (point))))))
18316 (push (list :latex-fragment
18317 (overlay-start o) (overlay-end o)) clist)
18318 (push (list :latex-preview
18319 (overlay-start o) (overlay-end o)) clist))
18320 ((org-inside-LaTeX-fragment-p)
18321 ;; FIXME: positions wrong.
18322 (push (list :latex-fragment (point) (point)) clist)))
18324 (setq clist (nreverse (delq nil clist)))
18325 clist))
18327 ;; FIXME: Compare with at-regexp-p Do we need both?
18328 (defun org-in-regexp (re &optional nlines visually)
18329 "Check if point is inside a match of regexp.
18330 Normally only the current line is checked, but you can include NLINES extra
18331 lines both before and after point into the search.
18332 If VISUALLY is set, require that the cursor is not after the match but
18333 really on, so that the block visually is on the match."
18334 (catch 'exit
18335 (let ((pos (point))
18336 (eol (point-at-eol (+ 1 (or nlines 0))))
18337 (inc (if visually 1 0)))
18338 (save-excursion
18339 (beginning-of-line (- 1 (or nlines 0)))
18340 (while (re-search-forward re eol t)
18341 (if (and (<= (match-beginning 0) pos)
18342 (>= (+ inc (match-end 0)) pos))
18343 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18345 (defun org-at-regexp-p (regexp)
18346 "Is point inside a match of REGEXP in the current line?"
18347 (catch 'exit
18348 (save-excursion
18349 (let ((pos (point)) (end (point-at-eol)))
18350 (beginning-of-line 1)
18351 (while (re-search-forward regexp end t)
18352 (if (and (<= (match-beginning 0) pos)
18353 (>= (match-end 0) pos))
18354 (throw 'exit t)))
18355 nil))))
18357 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18358 "Return t if the current point is between matches of START-RE and END-RE.
18359 This will also return t if point is on one of the two matches or
18360 in an unfinished block. END-RE can be a string or a form
18361 returning a string.
18363 An optional third argument bounds the search for START-RE. It
18364 defaults to previous heading or `point-min'."
18365 (let ((pos (point))
18366 (limit (or bound (save-excursion (outline-previous-heading)))))
18367 (save-excursion
18368 ;; we're on a block when point is on start-re...
18369 (or (org-at-regexp-p start-re)
18370 ;; ... or start-re can be found above...
18371 (and (re-search-backward start-re limit t)
18372 ;; ... but no end-re between start-re and point.
18373 (not (re-search-forward (eval end-re) pos t)))))))
18375 (defun org-occur-in-agenda-files (regexp &optional nlines)
18376 "Call `multi-occur' with buffers for all agenda files."
18378 (let* ((files (org-agenda-files))
18379 (tnames (mapcar 'file-truename files))
18380 (extra org-agenda-text-search-extra-files)
18381 f)
18382 (when (eq (car extra) 'agenda-archives)
18383 (setq extra (cdr extra))
18384 (setq files (org-add-archive-files files)))
18385 (while (setq f (pop extra))
18386 (unless (member (file-truename f) tnames)
18387 (add-to-list 'files f 'append)
18388 (add-to-list 'tnames (file-truename f) 'append)))
18389 (multi-occur
18390 (mapcar (lambda (x)
18391 (with-current-buffer
18392 (or (get-file-buffer x) (find-file-noselect x))
18393 (widen)
18394 (current-buffer)))
18395 files)
18396 regexp)))
18398 (if (boundp 'occur-mode-find-occurrence-hook)
18399 ;; Emacs 23
18400 (add-hook 'occur-mode-find-occurrence-hook
18401 (lambda ()
18402 (when (org-mode-p)
18403 (org-reveal))))
18404 ;; Emacs 22
18405 (defadvice occur-mode-goto-occurrence
18406 (after org-occur-reveal activate)
18407 (and (org-mode-p) (org-reveal)))
18408 (defadvice occur-mode-goto-occurrence-other-window
18409 (after org-occur-reveal activate)
18410 (and (org-mode-p) (org-reveal)))
18411 (defadvice occur-mode-display-occurrence
18412 (after org-occur-reveal activate)
18413 (when (org-mode-p)
18414 (let ((pos (occur-mode-find-occurrence)))
18415 (with-current-buffer (marker-buffer pos)
18416 (save-excursion
18417 (goto-char pos)
18418 (org-reveal)))))))
18420 (defun org-occur-link-in-agenda-files ()
18421 "Create a link and search for it in the agendas.
18422 The link is not stored in `org-stored-links', it is just created
18423 for the search purpose."
18424 (interactive)
18425 (let ((link (condition-case nil
18426 (org-store-link nil)
18427 (error "Unable to create a link to here"))))
18428 (org-occur-in-agenda-files (regexp-quote link))))
18430 (defun org-uniquify (list)
18431 "Remove duplicate elements from LIST."
18432 (let (res)
18433 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18434 res))
18436 (defun org-delete-all (elts list)
18437 "Remove all elements in ELTS from LIST."
18438 (while elts
18439 (setq list (delete (pop elts) list)))
18440 list)
18442 (defun org-count (cl-item cl-seq)
18443 "Count the number of occurrences of ITEM in SEQ.
18444 Taken from `count' in cl-seq.el with all keyword arguments removed."
18445 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18446 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18447 (while (< cl-start cl-end)
18448 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18449 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18450 (setq cl-start (1+ cl-start)))
18451 cl-count))
18453 (defun org-remove-if (predicate seq)
18454 "Remove everything from SEQ that fulfills PREDICATE."
18455 (let (res e)
18456 (while seq
18457 (setq e (pop seq))
18458 (if (not (funcall predicate e)) (push e res)))
18459 (nreverse res)))
18461 (defun org-remove-if-not (predicate seq)
18462 "Remove everything from SEQ that does not fulfill PREDICATE."
18463 (let (res e)
18464 (while seq
18465 (setq e (pop seq))
18466 (if (funcall predicate e) (push e res)))
18467 (nreverse res)))
18469 (defun org-back-over-empty-lines ()
18470 "Move backwards over whitespace, to the beginning of the first empty line.
18471 Returns the number of empty lines passed."
18472 (let ((pos (point)))
18474 (beginning-of-line 2)
18475 (goto-char (min (point) pos))
18476 (count-lines (point) pos)))
18478 (defun org-skip-whitespace ()
18481 (defun org-point-in-group (point group &optional context)
18482 "Check if POINT is in match-group GROUP.
18483 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18484 match. If the match group does not exist or point is not inside it,
18485 return nil."
18486 (and (match-beginning group)
18487 (>= point (match-beginning group))
18488 (<= point (match-end group))
18489 (if context
18490 (list context (match-beginning group) (match-end group))
18491 t)))
18493 (defun org-switch-to-buffer-other-window (&rest args)
18494 "Switch to buffer in a second window on the current frame.
18495 In particular, do not allow pop-up frames.
18496 Returns the newly created buffer."
18497 (let (pop-up-frames special-display-buffer-names special-display-regexps
18498 special-display-function)
18499 (apply 'switch-to-buffer-other-window args)))
18501 (defun org-combine-plists (&rest plists)
18502 "Create a single property list from all plists in PLISTS.
18503 The process starts by copying the first list, and then setting properties
18504 from the other lists. Settings in the last list are the most significant
18505 ones and overrule settings in the other lists."
18506 (let ((rtn (copy-sequence (pop plists)))
18507 p v ls)
18508 (while plists
18509 (setq ls (pop plists))
18510 (while ls
18511 (setq p (pop ls) v (pop ls))
18512 (setq rtn (plist-put rtn p v))))
18513 rtn))
18515 (defun org-move-line-down (arg)
18516 "Move the current line down. With prefix argument, move it past ARG lines."
18517 (interactive "p")
18518 (let ((col (current-column))
18519 beg end pos)
18520 (beginning-of-line 1) (setq beg (point))
18521 (beginning-of-line 2) (setq end (point))
18522 (beginning-of-line (+ 1 arg))
18523 (setq pos (move-marker (make-marker) (point)))
18524 (insert (delete-and-extract-region beg end))
18525 (goto-char pos)
18526 (org-move-to-column col)))
18528 (defun org-move-line-up (arg)
18529 "Move the current line up. 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 (- 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-replace-escapes (string table)
18542 "Replace %-escapes in STRING with values in TABLE.
18544 The sequences in STRING may contain normal field width and padding information,
18546 so values can contain further %-escapes if they are define later in TABLE."
18547 (let ((tbl (copy-alist table))
18548 (case-fold-search nil)
18549 (pchg 0)
18550 e re rpl)
18551 (while (setq e (pop tbl))
18552 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18553 (when (and (cdr e) (string-match re (cdr e)))
18554 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18555 (safe "SREF"))
18556 (add-text-properties 0 3 (list 'sref sref) safe)
18557 (setcdr e (replace-match safe t t (cdr e)))))
18558 (while (string-match re string)
18559 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18560 (cdr e)))
18561 (setq string (replace-match rpl t t string))))
18562 (while (setq pchg (next-property-change pchg string))
18563 (let ((sref (get-text-property pchg 'sref string)))
18564 (when (and sref (string-match "SREF" string pchg))
18565 (setq string (replace-match sref t t string)))))
18566 string))
18568 (defun org-sublist (list start end)
18569 "Return a section of LIST, from START to END.
18570 Counting starts at 1."
18571 (let (rtn (c start))
18572 (setq list (nthcdr (1- start) list))
18573 (while (and list (<= c end))
18574 (push (pop list) rtn)
18575 (setq c (1+ c)))
18576 (nreverse rtn)))
18578 (defun org-find-base-buffer-visiting (file)
18579 "Like `find-buffer-visiting' but always return the base buffer and
18580 not an indirect buffer."
18581 (let ((buf (or (get-file-buffer file)
18582 (find-buffer-visiting file))))
18583 (if buf
18584 (or (buffer-base-buffer buf) buf)
18585 nil)))
18587 (defun org-image-file-name-regexp (&optional extensions)
18588 "Return regexp matching the file names of images.
18589 If EXTENSIONS is given, only match these."
18590 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18591 (image-file-name-regexp)
18592 (let ((image-file-name-extensions
18593 (or extensions
18594 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18595 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18597 (regexp-opt (nconc (mapcar 'upcase
18598 image-file-name-extensions)
18599 image-file-name-extensions)
18600 t)
18603 (defun org-file-image-p (file &optional extensions)
18604 "Return non-nil if FILE is an image."
18605 (save-match-data
18606 (string-match (org-image-file-name-regexp extensions) file)))
18608 (defun org-get-cursor-date ()
18609 "Return the date at cursor in as a time.
18610 This works in the calendar and in the agenda, anywhere else it just
18611 returns the current time."
18612 (let (date day defd)
18613 (cond
18614 ((eq major-mode 'calendar-mode)
18615 (setq date (calendar-cursor-to-date)
18616 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18617 ((eq major-mode 'org-agenda-mode)
18618 (setq day (get-text-property (point) 'day))
18619 (if day
18620 (setq date (calendar-gregorian-from-absolute day)
18621 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18622 (nth 2 date))))))
18623 (or defd (current-time))))
18625 (defvar org-agenda-action-marker (make-marker)
18626 "Marker pointing to the entry for the next agenda action.")
18628 (defun org-mark-entry-for-agenda-action ()
18629 "Mark the current entry as target of an agenda action.
18630 Agenda actions are actions executed from the agenda with the key `k',
18631 which make use of the date at the cursor."
18632 (interactive)
18633 (move-marker org-agenda-action-marker
18634 (save-excursion (org-back-to-heading t) (point))
18635 (current-buffer))
18636 (message
18637 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18639 ;;; Paragraph filling stuff.
18640 ;; We want this to be just right, so use the full arsenal.
18642 (defun org-indent-line-function ()
18643 "Indent line like previous, but further if previous was headline or item."
18644 (interactive)
18645 (let* ((pos (point))
18646 (itemp (org-at-item-p))
18647 (case-fold-search t)
18649 (inline-task-p (and (featurep 'org-inlinetask)
18650 (org-inlinetask-in-task-p)))
18651 column bpos bcol tpos tcol bullet btype bullet-type)
18652 ;; Find the previous relevant line
18653 (beginning-of-line 1)
18654 (cond
18655 ;; Comments
18656 ((looking-at "#") (setq column 0))
18657 ;; Headings
18659 ;; Drawers
18661 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18662 (save-excursion
18663 (goto-char (1- (match-beginning 1)))
18664 (setq column (current-column))))
18665 ;; Special blocks
18667 (save-excursion
18668 (re-search-backward
18670 (setq column (org-get-indentation (match-string 0))))
18673 (save-excursion
18675 (setq column
18676 (if (equal (downcase (match-string 1)) "src")
18677 ;; src blocks: let `org-edit-src-exit' handle them
18678 (org-get-indentation)
18679 (org-get-indentation (match-string 0)))))
18680 ;; Lists
18681 ((org-in-item-p)
18682 (org-beginning-of-item)
18683 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18684 (setq bpos (match-beginning 1) tpos (match-end 0)
18685 bcol (progn (goto-char bpos) (current-column))
18686 tcol (progn (goto-char tpos) (current-column))
18687 bullet (match-string 1)
18688 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
18689 (if (> tcol (+ bcol org-description-max-indent))
18690 (setq tcol (+ bcol 5)))
18691 (if (not itemp)
18692 (setq column tcol)
18693 (beginning-of-line 1)
18694 (goto-char pos)
18696 (progn
18698 (setq bullet (match-string 1)
18699 btype (if (string-match "[0-9]" bullet) "n" bullet))
18700 (setq column (if (equal btype bullet-type) bcol tcol)))
18701 (setq column (org-get-indentation)))))
18702 ;; This line has nothing special, look upside to get a clue about
18703 ;; what to do.
18704 (t
18705 (beginning-of-line 0)
18706 (while (and (not (bobp))
18707 ;; skip comments, verbatim, empty lines, tables,
18708 ;; inline tasks
18710 (and (org-in-item-p) (goto-char (org-list-top-point)))
18711 (and (not inline-task-p)
18712 (featurep 'org-inlinetask)
18713 (org-inlinetask-in-task-p)))
18715 (not (looking-at org-drawer-regexp)))
18716 (beginning-of-line 0))
18717 (cond
18718 ;; There was an heading above.
18720 (if (not org-adapt-indentation)
18721 (setq column 0)
18722 (goto-char (match-end 0))
18723 (setq column (current-column))))
18724 ;; A drawer had started and is unfinished: indent consequently.
18725 ((looking-at org-drawer-regexp)
18726 (goto-char (1- (match-beginning 1)))
18727 (setq column (current-column)))
18728 ;; The drawer had ended: indent like its :END: line.
18730 (goto-char (match-end 1))
18731 (setq column (current-column)))
18732 ;; Else, nothing noticeable found: get indentation and go on.
18733 (t (setq column (org-get-indentation))))))
18734 (goto-char pos)
18735 (if (<= (current-column) (current-indentation))
18736 (org-indent-line-to column)
18737 (save-excursion (org-indent-line-to column)))
18738 (setq column (current-column))
18739 (beginning-of-line 1)
18740 (if (looking-at
18742 (replace-match (concat (match-string 1)
18743 (format org-property-format
18744 (match-string 2) (match-string 3)))
18745 t t))
18746 (org-move-to-column column)))
18748 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18749 "Variable to store copy of `adaptive-fill-regexp'.
18750 Since `adaptive-fill-regexp' is set to never match, we need to
18751 store a backup of its value before entering `org-mode' so that
18752 the functionality can be provided as a fall-back.")
18754 (defun org-set-autofill-regexps ()
18755 (interactive)
18756 ;; In the paragraph separator we include headlines, because filling
18757 ;; text in a line directly attached to a headline would otherwise
18758 ;; fill the headline as well.
18761 ;; The paragraph starter includes hand-formatted lists.
18762 (org-set-local
18763 'paragraph-start
18764 (concat
18773 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18774 ;; But only if the user has not turned off tables or fixed-width regions
18775 (org-set-local
18776 'auto-fill-inhibit-regexp
18779 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18780 (concat
18782 (if org-enable-table-editor "|" "")
18783 (if org-enable-fixed-width-editor ":" "")
18784 "]"))))
18785 ;; We use our own fill-paragraph function, to make sure that tables
18786 ;; and fixed-width regions are not wrapped. That function will pass
18787 ;; through to `fill-paragraph' when appropriate.
18788 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18789 ;; Adaptive filling: To get full control, first make sure that
18790 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18791 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18792 (org-set-local 'org-adaptive-fill-regexp-backup
18793 adaptive-fill-regexp))
18795 (org-set-local 'adaptive-fill-function
18796 'org-adaptive-fill-function)
18797 (org-set-local
18798 'align-mode-rules-list
18799 '((org-in-buffer-settings
18801 (modes . '(org-mode))))))
18803 (defun org-fill-paragraph (&optional justify)
18804 "Re-align a table, pass through to fill-paragraph if no table."
18805 (let ((table-p (org-at-table-p))
18806 (table.el-p (org-at-table.el-p)))
18807 (cond ((and (equal (char-after (point-at-bol)) ?*)
18808 (save-excursion (goto-char (point-at-bol))
18809 (looking-at outline-regexp)))
18810 t) ; skip headlines
18811 (table.el-p t) ; skip table.el tables
18812 (table-p (org-table-align) t) ; align org-mode tables
18813 (t nil)))) ; call paragraph-fill
18815 ;; For reference, this is the default value of adaptive-fill-regexp
18818 (defun org-adaptive-fill-function ()
18819 "Return a fill prefix for org-mode files.
18820 In particular, this makes sure hanging paragraphs for hand-formatted lists
18821 work correctly."
18822 (cond
18823 ;; Comment line
18825 (match-string-no-properties 0))
18826 ;; Description list
18828 (save-excursion
18829 (if (> (match-end 1) (+ (match-beginning 1)
18830 org-description-max-indent))
18831 (goto-char (+ (match-beginning 1) 5))
18832 (goto-char (match-end 0)))
18833 (make-string (current-column) ?\ )))
18834 ;; Ordered or unordered list
18836 (save-excursion
18837 (goto-char (match-end 0))
18838 (make-string (current-column) ?\ )))
18839 ;; Other text
18840 ((looking-at org-adaptive-fill-regexp-backup)
18841 (match-string-no-properties 0))))
18843 ;;; Other stuff.
18845 (defun org-toggle-fixed-width-section (arg)
18846 "Toggle the fixed-width export.
18847 If there is no active region, the QUOTE keyword at the current headline is
18848 inserted or removed. When present, it causes the text between this headline
18849 and the next to be exported as fixed-width text, and unmodified.
18850 If there is an active region, this command adds or removes a colon as the
18851 first character of this line. If the first character of a line is a colon,
18852 this line is also exported in fixed-width font."
18853 (interactive "P")
18854 (let* ((cc 0)
18855 (regionp (org-region-active-p))
18856 (beg (if regionp (region-beginning) (point)))
18857 (end (if regionp (region-end)))
18858 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18859 (case-fold-search nil)
18861 off)
18862 (if regionp
18863 (save-excursion
18864 (goto-char beg)
18865 (setq cc (current-column))
18866 (beginning-of-line 1)
18867 (setq off (looking-at re))
18868 (while (> nlines 0)
18869 (setq nlines (1- nlines))
18870 (beginning-of-line 1)
18871 (cond
18872 (arg
18873 (org-move-to-column cc t)
18875 (forward-line -1))
18876 ((and off (looking-at re))
18877 (replace-match "" t t nil 1))
18878 ((not off) (org-move-to-column cc t) (insert ": ")))
18879 (forward-line 1)))
18880 (save-excursion
18881 (org-back-to-heading)
18882 (if (looking-at (concat outline-regexp
18884 (replace-match "" t t nil 1)
18885 (if (looking-at outline-regexp)
18886 (progn
18887 (goto-char (match-end 0))
18888 (insert org-quote-string " "))))))))
18890 (defun org-reftex-citation ()
18891 "Use reftex-citation to insert a citation into the buffer.
18892 This looks for a line like
18894 #+BIBLIOGRAPHY: foo plain option:-d
18896 and derives from it that foo.bib is the bibliography file relevant
18897 for this document. It then installs the necessary environment for RefTeX
18898 to work in this buffer and calls `reftex-citation' to insert a citation
18899 into the buffer.
18901 Export of such citations to both LaTeX and HTML is handled by the contributed
18902 package org-exp-bibtex by Taru Karttunen."
18903 (interactive)
18904 (let ((reftex-docstruct-symbol 'rds)
18906 rds bib)
18907 (save-excursion
18908 (save-restriction
18909 (widen)
18910 (let ((case-fold-search t)
18912 (if (not (save-excursion
18913 (or (re-search-forward re nil t)
18914 (re-search-backward re nil t))))
18915 (error "No bibliography defined in file")
18916 (setq bib (concat (match-string 1) ".bib")
18917 rds (list (list 'bib bib)))))))
18918 (call-interactively 'reftex-citation)))
18920 ;;;; Functions extending outline functionality
18922 (defun org-beginning-of-line (&optional arg)
18923 "Go to the beginning of the current line. If that is invisible, continue
18924 to a visible line beginning. This makes the function of C-a more intuitive.
18925 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18926 first attempt, and only move to after the tags when the cursor is already
18927 beyond the end of the headline."
18928 (interactive "P")
18929 (let ((pos (point))
18930 (special (if (consp org-special-ctrl-a/e)
18931 (car org-special-ctrl-a/e)
18932 org-special-ctrl-a/e))
18933 refpos)
18934 (if (org-bound-and-true-p line-move-visual)
18935 (beginning-of-visual-line 1)
18936 (beginning-of-line 1))
18937 (if (and arg (fboundp 'move-beginning-of-line))
18938 (call-interactively 'move-beginning-of-line)
18939 (if (bobp)
18940 nil
18941 (backward-char 1)
18942 (if (org-truely-invisible-p)
18943 (while (and (not (bobp)) (org-truely-invisible-p))
18944 (backward-char 1)
18945 (beginning-of-line 1))
18946 (forward-char 1))))
18947 (when special
18948 (cond
18949 ((and (looking-at org-complex-heading-regexp)
18950 (= (char-after (match-end 1)) ?\ ))
18951 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18952 (point-at-eol)))
18953 (goto-char
18954 (if (eq special t)
18955 (cond ((> pos refpos) refpos)
18956 ((= pos (point)) refpos)
18957 (t (point)))
18958 (cond ((> pos (point)) (point))
18959 ((not (eq last-command this-command)) (point))
18960 (t refpos)))))
18961 ((org-at-item-p)
18962 (goto-char
18963 (if (eq special t)
18964 (cond ((> pos (match-end 4)) (match-end 4))
18965 ((= pos (point)) (match-end 4))
18966 (t (point)))
18967 (cond ((> pos (point)) (point))
18968 ((not (eq last-command this-command)) (point))
18969 (t (match-end 4))))))))
18970 (org-no-warnings
18971 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18973 (defun org-end-of-line (&optional arg)
18974 "Go to the end of the line.
18975 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18976 first attempt, and only move to after the tags when the cursor is already
18977 beyond the end of the headline."
18978 (interactive "P")
18979 (let ((special (if (consp org-special-ctrl-a/e)
18980 (cdr org-special-ctrl-a/e)
18981 org-special-ctrl-a/e)))
18982 (if (or (not special)
18983 (not (org-on-heading-p))
18984 arg)
18985 (call-interactively
18986 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18987 ((fboundp 'move-end-of-line) 'move-end-of-line)
18988 (t 'end-of-line)))
18989 (let ((pos (point)))
18990 (beginning-of-line 1)
18992 (if (eq special t)
18993 (if (or (< pos (match-beginning 1))
18994 (= pos (match-end 0)))
18995 (goto-char (match-beginning 1))
18996 (goto-char (match-end 0)))
18997 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18998 (goto-char (match-end 0))
18999 (goto-char (match-beginning 1))))
19000 (call-interactively (if (fboundp 'move-end-of-line)
19001 'move-end-of-line
19002 'end-of-line)))))
19003 (org-no-warnings
19004 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19006 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19007 (define-key org-mode-map "\C-e" 'org-end-of-line)
19008 (define-key org-mode-map [home] 'org-beginning-of-line)
19009 (define-key org-mode-map [end] 'org-end-of-line)
19011 (defun org-backward-sentence (&optional arg)
19012 "Go to beginning of sentence, or beginning of table field.
19013 This will call `backward-sentence' or `org-table-beginning-of-field',
19014 depending on context."
19015 (interactive "P")
19016 (cond
19017 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19018 (t (call-interactively 'backward-sentence))))
19020 (defun org-forward-sentence (&optional arg)
19021 "Go to end of sentence, or end of table field.
19022 This will call `forward-sentence' or `org-table-end-of-field',
19023 depending on context."
19024 (interactive "P")
19025 (cond
19026 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19027 (t (call-interactively 'forward-sentence))))
19029 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19030 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19032 (defun org-kill-line (&optional arg)
19033 "Kill line, to tags or end of line."
19034 (interactive "P")
19035 (cond
19036 ((or (not org-special-ctrl-k)
19037 (bolp)
19038 (not (org-on-heading-p)))
19039 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19040 org-ctrl-k-protect-subtree)
19041 (if (or (eq org-ctrl-k-protect-subtree 'error)
19042 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19043 (error "C-k aborted - would kill hidden subtree")))
19044 (call-interactively 'kill-line))
19046 (kill-region (point) (match-beginning 1))
19047 (org-set-tags nil t))
19048 (t (kill-region (point) (point-at-eol)))))
19050 (define-key org-mode-map "\C-k" 'org-kill-line)
19052 (defun org-yank (&optional arg)
19053 "Yank. If the kill is a subtree, treat it specially.
19054 This command will look at the current kill and check if is a single
19055 subtree, or a series of subtrees[1]. If it passes the test, and if the
19056 cursor is at the beginning of a line or after the stars of a currently
19057 empty headline, then the yank is handled specially. How exactly depends
19058 on the value of the following variables, both set by default.
19060 org-yank-folded-subtrees
19061 When set, the subtree(s) will be folded after insertion, but only
19062 if doing so would now swallow text after the yanked text.
19064 org-yank-adjusted-subtrees
19065 When set, the subtree will be promoted or demoted in order to
19066 fit into the local outline tree structure, which means that the level
19067 will be adjusted so that it becomes the smaller one of the two
19068 *visible* surrounding headings.
19070 Any prefix to this command will cause `yank' to be called directly with
19072 will just
19073 plainly yank the text as it is.
19075 \[1] The test checks if the first non-white line is a heading
19076 and if there are no other headings with fewer stars."
19077 (interactive "P")
19078 (org-yank-generic 'yank arg))
19080 (defun org-yank-generic (command arg)
19081 "Perform some yank-like command.
19083 This function implements the behavior described in the `org-yank'
19084 documentation. However, it has been generalized to work for any
19085 interactive command with similar behavior."
19087 ;; pretend to be command COMMAND
19088 (setq this-command command)
19090 (if arg
19091 (call-interactively command)
19093 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19094 (and (org-kill-is-subtree-p)
19095 (or (bolp)
19097 (string-match
19099 (buffer-substring (point-at-bol) (point)))))))
19100 swallowp)
19101 (cond
19102 ((and subtreep org-yank-folded-subtrees)
19103 (let ((beg (point))
19104 end)
19105 (if (and subtreep org-yank-adjusted-subtrees)
19106 (org-paste-subtree nil nil 'for-yank)
19107 (call-interactively command))
19109 (setq end (point))
19110 (goto-char beg)
19111 (when (and (bolp) subtreep
19112 (not (setq swallowp
19113 (org-yank-folding-would-swallow-text beg end))))
19114 (or (looking-at outline-regexp)
19115 (re-search-forward (concat "^" outline-regexp) end t))
19116 (while (and (< (point) end) (looking-at outline-regexp))
19117 (hide-subtree)
19118 (org-cycle-show-empty-lines 'folded)
19119 (condition-case nil
19120 (outline-forward-same-level 1)
19121 (error (goto-char end)))))
19122 (when swallowp
19123 (message
19124 "Inserted text not folded because that would swallow text"))
19126 (goto-char end)
19128 (beginning-of-line 1)
19129 (push-mark beg 'nomsg)))
19130 ((and subtreep org-yank-adjusted-subtrees)
19131 (let ((beg (point-at-bol)))
19132 (org-paste-subtree nil nil 'for-yank)
19133 (push-mark beg 'nomsg)))
19134 (t
19135 (call-interactively command))))))
19137 (defun org-yank-folding-would-swallow-text (beg end)
19138 "Would hide-subtree at BEG swallow any text after END?"
19139 (let (level)
19140 (save-excursion
19141 (goto-char beg)
19142 (when (or (looking-at outline-regexp)
19143 (re-search-forward (concat "^" outline-regexp) end t))
19144 (setq level (org-outline-level)))
19145 (goto-char end)
19147 (if (or (eobp)
19148 (and (bolp) (looking-at org-outline-regexp)
19149 (<= (org-outline-level) level)))
19150 nil ; Nothing would be swallowed
19151 t)))) ; something would swallow
19153 (define-key org-mode-map "\C-y" 'org-yank)
19155 (defun org-invisible-p ()
19156 "Check if point is at a character currently not visible."
19157 ;; Early versions of noutline don't have `outline-invisible-p'.
19158 (if (fboundp 'outline-invisible-p)
19159 (outline-invisible-p)
19160 (get-char-property (point) 'invisible)))
19162 (defun org-truely-invisible-p ()
19163 "Check if point is at a character currently not visible.
19164 This version does not only check the character property, but also
19165 `visible-mode'."
19166 ;; Early versions of noutline don't have `outline-invisible-p'.
19167 (if (org-bound-and-true-p visible-mode)
19168 nil
19169 (if (fboundp 'outline-invisible-p)
19170 (outline-invisible-p)
19171 (get-char-property (point) 'invisible))))
19173 (defun org-invisible-p2 ()
19174 "Check if point is at a character currently not visible."
19175 (save-excursion
19176 (if (and (eolp) (not (bobp))) (backward-char 1))
19177 ;; Early versions of noutline don't have `outline-invisible-p'.
19178 (if (fboundp 'outline-invisible-p)
19179 (outline-invisible-p)
19180 (get-char-property (point) 'invisible))))
19182 (defun org-back-to-heading (&optional invisible-ok)
19183 "Call `outline-back-to-heading', but provide a better error message."
19184 (condition-case nil
19185 (outline-back-to-heading invisible-ok)
19186 (error (error "Before first headline at position %d in buffer %s"
19187 (point) (current-buffer)))))
19189 (defun org-beginning-of-defun ()
19190 "Go to the beginning of the subtree, i.e. back to the heading."
19191 (org-back-to-heading))
19192 (defun org-end-of-defun ()
19193 "Go to the end of the subtree."
19194 (org-end-of-subtree nil t))
19196 (defun org-before-first-heading-p ()
19197 "Before first heading?"
19198 (save-excursion
19201 (defun org-on-heading-p (&optional ignored)
19202 (outline-on-heading-p t))
19203 (defun org-at-heading-p (&optional ignored)
19204 (outline-on-heading-p t))
19206 (defun org-point-at-end-of-empty-headline ()
19207 "If point is at the end of an empty headline, return t, else nil.
19208 If the heading only contains a TODO keyword, it is still still considered
19209 empty."
19211 (save-excursion
19212 (beginning-of-line 1)
19215 (defun org-at-heading-or-item-p ()
19216 (or (org-on-heading-p) (org-at-item-p)))
19218 (defun org-on-target-p ()
19219 (or (org-in-regexp org-radio-target-regexp)
19220 (org-in-regexp org-target-regexp)))
19222 (defun org-up-heading-all (arg)
19223 "Move to the heading line of which the present line is a subheading.
19224 This function considers both visible and invisible heading lines.
19225 With argument, move up ARG levels."
19226 (if (fboundp 'outline-up-heading-all)
19227 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19228 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19230 (defun org-up-heading-safe ()
19231 "Move to the heading line of which the present line is a subheading.
19232 This version will not throw an error. It will return the level of the
19233 headline found, or nil if no higher level is found.
19235 Also, this function will be a lot faster than `outline-up-heading',
19236 because it relies on stars being the outline starters. This can really
19237 make a significant difference in outlines with very many siblings."
19238 (let (start-level re)
19239 (org-back-to-heading t)
19240 (setq start-level (funcall outline-level))
19241 (if (equal start-level 1)
19242 nil
19244 (if (re-search-backward re nil t)
19245 (funcall outline-level)))))
19247 (defun org-first-sibling-p ()
19248 "Is this heading the first child of its parents?"
19249 (interactive)
19250 (let ((re (concat "^" outline-regexp))
19251 level l)
19252 (unless (org-at-heading-p t)
19253 (error "Not at a heading"))
19254 (setq level (funcall outline-level))
19255 (save-excursion
19256 (if (not (re-search-backward re nil t))
19257 t
19258 (setq l (funcall outline-level))
19259 (< l level)))))
19261 (defun org-goto-sibling (&optional previous)
19262 "Goto the next sibling, even if it is invisible.
19263 When PREVIOUS is set, go to the previous sibling instead. Returns t
19264 when a sibling was found. When none is found, return nil and don't
19265 move point."
19266 (let ((fun (if previous 're-search-backward 're-search-forward))
19267 (pos (point))
19268 (re (concat "^" outline-regexp))
19269 level l)
19270 (when (condition-case nil (org-back-to-heading t) (error nil))
19271 (setq level (funcall outline-level))
19272 (catch 'exit
19273 (or previous (forward-char 1))
19274 (while (funcall fun re nil t)
19275 (setq l (funcall outline-level))
19276 (when (< l level) (goto-char pos) (throw 'exit nil))
19277 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19278 (goto-char pos)
19279 nil))))
19281 (defun org-show-siblings ()
19282 "Show all siblings of the current headline."
19283 (save-excursion
19284 (while (org-goto-sibling) (org-flag-heading nil)))
19285 (save-excursion
19286 (while (org-goto-sibling 'previous)
19287 (org-flag-heading nil))))
19289 (defun org-goto-first-child ()
19290 "Goto the first child, even if it is invisible.
19291 Return t when a child was found. Otherwise don't move point and
19292 return nil."
19293 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19294 (when (condition-case nil (org-back-to-heading t) (error nil))
19295 (setq level (outline-level))
19296 (forward-char 1)
19297 (if (and (re-search-forward re nil t) (> (outline-level) level))
19298 (progn (goto-char (match-beginning 0)) t)
19299 (goto-char pos) nil))))
19301 (defun org-show-hidden-entry ()
19302 "Show an entry where even the heading is hidden."
19303 (save-excursion
19304 (org-show-entry)))
19306 (defun org-flag-heading (flag &optional entry)
19307 "Flag the current heading. FLAG non-nil means make invisible.
19308 When ENTRY is non-nil, show the entire entry."
19309 (save-excursion
19310 (org-back-to-heading t)
19311 ;; Check if we should show the entire entry
19312 (if entry
19313 (progn
19314 (org-show-entry)
19315 (save-excursion
19316 (and (outline-next-heading)
19317 (org-flag-heading nil))))
19318 (outline-flag-region (max (point-min) (1- (point)))
19319 (save-excursion (outline-end-of-heading) (point))
19320 flag))))
19322 (defun org-get-next-sibling ()
19323 "Move to next heading of the same level, and return point.
19324 If there is no such heading, return nil.
19325 This is like outline-next-sibling, but invisible headings are ok."
19326 (let ((level (funcall outline-level)))
19327 (outline-next-heading)
19328 (while (and (not (eobp)) (> (funcall outline-level) level))
19329 (outline-next-heading))
19330 (if (or (eobp) (< (funcall outline-level) level))
19331 nil
19332 (point))))
19334 (defun org-get-last-sibling ()
19335 "Move to previous heading of the same level, and return point.
19336 If there is no such heading, return nil."
19337 (let ((opoint (point))
19338 (level (funcall outline-level)))
19339 (outline-previous-heading)
19340 (when (and (/= (point) opoint) (outline-on-heading-p t))
19341 (while (and (> (funcall outline-level) level)
19342 (not (bobp)))
19343 (outline-previous-heading))
19344 (if (< (funcall outline-level) level)
19345 nil
19346 (point)))))
19348 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19349 ;; This contains an exact copy of the original function, but it uses
19350 ;; `org-back-to-heading', to make it work also in invisible
19351 ;; trees. And is uses an invisible-OK argument.
19352 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19353 ;; Furthermore, when used inside Org, finding the end of a large subtree
19354 ;; with many children and grandchildren etc, this can be much faster
19355 ;; than the outline version.
19356 (org-back-to-heading invisible-OK)
19357 (let ((first t)
19358 (level (funcall outline-level)))
19359 (if (and (org-mode-p) (< level 1000))
19360 ;; A true heading (not a plain list item), in Org-mode
19361 ;; This means we can easily find the end by looking
19362 ;; only for the right number of stars. Using a regexp to do
19363 ;; this is so much faster than using a Lisp loop.
19365 (forward-char 1)
19366 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19367 ;; something else, do it the slow way
19368 (while (and (not (eobp))
19369 (or first (> (funcall outline-level) level)))
19370 (setq first nil)
19371 (outline-next-heading)))
19372 (unless to-heading
19374 (progn
19375 ;; Go to end of line before heading
19376 (forward-char -1)
19378 ;; leave blank line before heading
19379 (forward-char -1))))))
19380 (point))
19382 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19383 "Use Org version in org-mode, for dramatic speed-up."
19384 (if (eq major-mode 'org-mode)
19385 (progn
19386 (org-end-of-subtree nil t)
19387 (unless (eobp) (backward-char 1)))
19388 ad-do-it))
19390 (defun org-forward-same-level (arg &optional invisible-ok)
19391 "Move forward to the arg'th subheading at same level as this one.
19392 Stop at the first and last subheadings of a superior heading.
19393 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19394 it wil also look at invisible ones."
19395 (interactive "p")
19396 (org-back-to-heading invisible-ok)
19397 (org-on-heading-p)
19398 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19400 l)
19401 (forward-char 1)
19402 (while (> arg 0)
19403 (while (and (re-search-forward re nil 'move)
19404 (setq l (- (match-end 0) (match-beginning 0) 1))
19405 (= l level)
19406 (not invisible-ok)
19407 (progn (backward-char 1) (org-invisible-p)))
19408 (if (< l level) (setq arg 1)))
19409 (setq arg (1- arg)))
19410 (beginning-of-line 1)))
19412 (defun org-backward-same-level (arg &optional invisible-ok)
19413 "Move backward to the arg'th subheading at same level as this one.
19414 Stop at the first and last subheadings of a superior heading."
19415 (interactive "p")
19416 (org-back-to-heading)
19417 (org-on-heading-p)
19418 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19420 l)
19421 (while (> arg 0)
19422 (while (and (re-search-backward re nil 'move)
19423 (setq l (- (match-end 0) (match-beginning 0) 1))
19424 (= l level)
19425 (not invisible-ok)
19426 (org-invisible-p))
19427 (if (< l level) (setq arg 1)))
19428 (setq arg (1- arg)))))
19430 (defun org-show-subtree ()
19431 "Show everything after this heading at deeper levels."
19432 (outline-flag-region
19433 (point)
19434 (save-excursion
19435 (org-end-of-subtree t t))
19436 nil))
19438 (defun org-show-entry ()
19439 "Show the body directly following this heading.
19440 Show the heading too, if it is currently invisible."
19441 (interactive)
19442 (save-excursion
19443 (condition-case nil
19444 (progn
19445 (org-back-to-heading t)
19446 (outline-flag-region
19447 (max (point-min) (1- (point)))
19448 (save-excursion
19449 (if (re-search-forward
19451 (match-beginning 1)
19452 (point-max)))
19453 nil)
19454 (org-cycle-hide-drawers 'children))
19455 (error nil))))
19457 (defun org-make-options-regexp (kwds &optional extra)
19458 "Make a regular expression for keyword lines."
19459 (concat
19460 "^"
19467 ;; Make isearch reveal the necessary context
19468 (defun org-isearch-end ()
19469 "Reveal context after isearch exits."
19470 (when isearch-success ; only if search was successful
19471 (if (featurep 'xemacs)
19472 ;; Under XEmacs, the hook is run in the correct place,
19473 ;; we directly show the context.
19474 (org-show-context 'isearch)
19475 ;; In Emacs the hook runs *before* restoring the overlays.
19476 ;; So we have to use a one-time post-command-hook to do this.
19477 ;; (Emacs 22 has a special variable, see function `org-mode')
19478 (unless (and (boundp 'isearch-mode-end-hook-quit)
19479 isearch-mode-end-hook-quit)
19480 ;; Only when the isearch was not quitted.
19481 (org-add-hook 'post-command-hook 'org-isearch-post-command
19482 'append 'local)))))
19484 (defun org-isearch-post-command ()
19485 "Remove self from hook, and show context."
19486 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19487 (org-show-context 'isearch))
19490 ;;;; Integration with and fixes for other packages
19492 ;;; Imenu support
19494 (defvar org-imenu-markers nil
19495 "All markers currently used by Imenu.")
19496 (make-variable-buffer-local 'org-imenu-markers)
19498 (defun org-imenu-new-marker (&optional pos)
19499 "Return a new marker for use by Imenu, and remember the marker."
19500 (let ((m (make-marker)))
19501 (move-marker m (or pos (point)))
19502 (push m org-imenu-markers)
19503 m))
19505 (defun org-imenu-get-tree ()
19506 "Produce the index for Imenu."
19507 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19508 (setq org-imenu-markers nil)
19509 (let* ((n org-imenu-depth)
19510 (re (concat "^" outline-regexp))
19511 (subs (make-vector (1+ n) nil))
19512 (last-level 0)
19513 m level head)
19514 (save-excursion
19515 (save-restriction
19516 (widen)
19517 (goto-char (point-max))
19518 (while (re-search-backward re nil t)
19519 (setq level (org-reduced-level (funcall outline-level)))
19520 (when (<= level n)
19521 (looking-at org-complex-heading-regexp)
19522 (setq head (org-link-display-format
19523 (org-match-string-no-properties 4))
19524 m (org-imenu-new-marker))
19525 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19526 (if (>= level last-level)
19527 (push (cons head m) (aref subs level))
19528 (push (cons head (aref subs (1+ level))) (aref subs level))
19529 (loop for i from (1+ level) to n do (aset subs i nil)))
19530 (setq last-level level)))))
19531 (aref subs 1)))
19533 (eval-after-load "imenu"
19534 '(progn
19535 (add-hook 'imenu-after-jump-hook
19536 (lambda ()
19537 (if (eq major-mode 'org-mode)
19538 (org-show-context 'org-goto))))))
19540 (defun org-link-display-format (link)
19541 "Replace a link with either the description, or the link target
19542 if no description is present"
19543 (save-match-data
19544 (if (string-match org-bracket-link-analytic-regexp link)
19545 (replace-match (if (match-end 5)
19546 (match-string 5 link)
19547 (concat (match-string 1 link)
19548 (match-string 3 link)))
19549 nil t link)
19550 link)))
19552 ;; Speedbar support
19554 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19555 "Overlay marking the agenda restriction line in speedbar.")
19556 (overlay-put org-speedbar-restriction-lock-overlay
19557 'face 'org-agenda-restriction-lock)
19558 (overlay-put org-speedbar-restriction-lock-overlay
19559 'help-echo "Agendas are currently limited to this item.")
19560 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19562 (defun org-speedbar-set-agenda-restriction ()
19563 "Restrict future agenda commands to the location at point in speedbar.
19565 (interactive)
19566 (require 'org-agenda)
19567 (let (p m tp np dir txt)
19568 (cond
19569 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19570 'org-imenu t))
19571 (setq m (get-text-property p 'org-imenu-marker))
19572 (with-current-buffer (marker-buffer m)
19573 (goto-char m)
19574 (org-agenda-set-restriction-lock 'subtree)))
19575 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19576 'speedbar-function 'speedbar-find-file))
19577 (setq tp (previous-single-property-change
19578 (1+ p) 'speedbar-function)
19579 np (next-single-property-change
19580 tp 'speedbar-function)
19581 dir (speedbar-line-directory)
19582 txt (buffer-substring-no-properties (or tp (point-min))
19583 (or np (point-max))))
19584 (with-current-buffer (find-file-noselect
19585 (let ((default-directory dir))
19586 (expand-file-name txt)))
19587 (unless (org-mode-p)
19588 (error "Cannot restrict to non-Org-mode file"))
19589 (org-agenda-set-restriction-lock 'file)))
19590 (t (error "Don't know how to restrict Org-mode's agenda")))
19591 (move-overlay org-speedbar-restriction-lock-overlay
19592 (point-at-bol) (point-at-eol))
19593 (setq current-prefix-arg nil)
19594 (org-agenda-maybe-redo)))
19596 (eval-after-load "speedbar"
19597 '(progn
19598 (speedbar-add-supported-extension ".org")
19599 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19600 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19601 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19602 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19603 (add-hook 'speedbar-visiting-tag-hook
19604 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19606 ;;; Fixes and Hacks for problems with other packages
19608 ;; Make flyspell not check words in links, to not mess up our keymap
19609 (defun org-mode-flyspell-verify ()
19610 "Don't let flyspell put overlays at active buttons."
19611 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19612 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19614 (defun org-remove-flyspell-overlays-in (beg end)
19615 "Remove flyspell overlays in region."
19616 (and (org-bound-and-true-p flyspell-mode)
19617 (fboundp 'flyspell-delete-region-overlays)
19618 (flyspell-delete-region-overlays beg end))
19619 (add-text-properties beg end '(org-no-flyspell t)))
19621 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19622 (eval-after-load "bookmark"
19623 '(if (boundp 'bookmark-after-jump-hook)
19624 ;; We can use the hook
19625 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19626 ;; Hook not available, use advice
19627 (defadvice bookmark-jump (after org-make-visible activate)
19628 "Make the position visible."
19629 (org-bookmark-jump-unhide))))
19631 ;; Make sure saveplace shows the location if it was hidden
19632 (eval-after-load "saveplace"
19633 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19634 "Make the position visible."
19635 (org-bookmark-jump-unhide)))
19637 ;; Make sure ecb shows the location if it was hidden
19638 (eval-after-load "ecb"
19639 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19640 "Make hierarchy visible when jumping into location from ECB tree buffer."
19641 (if (eq major-mode 'org-mode)
19642 (org-show-context))))
19644 (defun org-bookmark-jump-unhide ()
19645 "Unhide the current position, to show the bookmark location."
19646 (and (org-mode-p)
19647 (or (org-invisible-p)
19648 (save-excursion (goto-char (max (point-min) (1- (point))))
19649 (org-invisible-p)))
19650 (org-show-context 'bookmark-jump)))
19652 ;; Make session.el ignore our circular variable
19653 (eval-after-load "session"
19654 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19656 ;;;; Experimental code
19658 (defun org-closed-in-range ()
19659 "Sparse tree of items closed in a certain time range.
19660 Still experimental, may disappear in the future."
19661 (interactive)
19662 ;; Get the time interval from the user.
19663 (let* ((time1 (org-float-time
19664 (org-read-date nil 'to-time nil "Starting date: ")))
19665 (time2 (org-float-time
19666 (org-read-date nil 'to-time nil "End date:")))
19667 ;; callback function
19668 (callback (lambda ()
19669 (let ((time
19670 (org-float-time
19671 (apply 'encode-time
19672 (org-parse-time-string
19673 (match-string 1))))))
19674 ;; check if time in interval
19675 (and (>= time time1) (<= time time2))))))
19676 ;; make tree, check each match with the callback
19679 ;;;; Finish up
19681 (provide 'org)
19683 (run-hooks 'org-load-hook)
19685 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19687 ;;; org.el ends here