| blob | 61668ce0cc7303c24890b99b3109dec6b80b5316 |
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, 2011
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.5
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
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
110 ;; babel
119 ;; load languages based on value of `org-babel-load-languages'
121 ;;;###autoload
123 "Load the languages defined in `org-babel-load-languages'."
135 org-babel-load-languages))
138 "Languages which can be evaluated in Org-mode buffers.
139 This list can be used to load support for any of the languages
140 below, note that each language will depend on a different set of
141 system executables and/or Emacs modes. When a language is
143 with `org-babel-execute-src-block' bound by default to C-c
144 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
145 be set to remove code block evaluation from the C-c C-c
146 keybinding. By default only Emacs Lisp (which has no
147 requirements) is loaded."
151 :key-type
185 ;;;; Customization variables
187 "Remove ID property of clones of a subtree.
188 When non-nil, clones of a subtree don't inherit the ID property.
189 Otherwise they inherit the ID property with a new unique
190 identifier."
194 ;;; Version
200 "Show the org-mode version in the echo area.
201 With prefix arg HERE, insert it at point."
227 ;;; Compatibility constants
229 ;;; The custom variables
232 "Outline-based notes management and organizer."
238 "Mode hook for Org-mode, run after the mode was turned on."
243 "Hook that is run after org.el has been loaded."
252 "Load all extensions listed in `org-modules'."
257 org-modules)
261 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
270 (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)
271 "Modules that should always be loaded together with org.el.
272 If a description starts with <C>, the file is not part of Emacs
273 and loading it will require that you have downloaded and properly installed
274 the org-mode distribution.
276 You can also use this system to load external packages (i.e. neither Org
277 core modules, nor modules from the CONTRIB directory). Just add symbols
278 to the end of the list. If the package is called org-xyz.el, then you need
279 to add the symbol `xyz', and the package must have a call to
281 (provide 'org-xyz)"
284 :type
315 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
323 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
332 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
348 "Non-nil means make shift-cursor commands select text when possible.
350 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
351 selecting a region, or enlarge regions started in this way.
352 In Org-mode, in special contexts, these same keys are used for other
353 purposes, important enough to compete with shift selection. Org tries
354 to balance these needs by supporting `shift-select-mode' outside these
355 special contexts, under control of this variable.
357 The default of this variable is nil, to avoid confusing behavior. Shifted
358 cursor keys will then execute Org commands in the following contexts:
359 - on a headline, changing TODO state (left/right) and priority (up/down)
360 - on a time stamp, changing the time
361 - in a plain list item, changing the bullet type
362 - in a property definition line, switching between allowed values
363 - in the BEGIN line of a clock table (changing the time block).
364 Outside these contexts, the commands will throw an error.
366 When this variable is t and the cursor is not in a special context,
367 Org-mode will support shift-selection for making and enlarging regions.
368 To make this more effective, the bullet cycling will no longer happen
369 anywhere in an item line, but only if the cursor is exactly on the bullet.
371 If you set this variable to the symbol `always', then the keys
372 will not be special in headlines, property lines, and item lines, to make
373 shift selection work there as well. If this is what you want, you can
374 use the following alternative commands: `C-c C-t' and `C-c ,' to
375 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
376 TODO sets, `C-c -' to cycle item bullet types, and properties can be
377 edited by hand or in column view.
379 However, when the cursor is on a timestamp, shift-cursor commands
380 will still edit the time stamp - this is just too good to give up.
382 XEmacs user should have this variable set to nil, because shift-select-mode
383 is Emacs 23 only."
391 "Options concerning startup of Org-mode."
396 "Non-nil means entering Org-mode will switch to OVERVIEW.
397 This can also be configured on a per-file basis by adding one of
398 the following lines anywhere in the buffer:
400 #+STARTUP: fold (or `overview', this is equivalent)
401 #+STARTUP: nofold (or `showall', this is equivalent)
402 #+STARTUP: content
403 #+STARTUP: showeverything"
412 "Non-nil means entering Org-mode will set `truncate-lines'.
413 This is useful since some lines containing links can be very long and
414 uninteresting. Also tables look terrible when wrapped."
419 "Non-nil means turn on `org-indent-mode' on startup.
420 This can also be configured on a per-file basis by adding one of
421 the following lines anywhere in the buffer:
423 #+STARTUP: indent
424 #+STARTUP: noindent"
432 When this option is turned on, you can use TeX-like syntax for sub- and
434 considered as a single item - so grouping with {} is normally not
435 needed. For example, the following things will be parsed as single
436 sub- or superscripts.
438 10^24 or 10^tau several digits will be considered 1 item.
439 10^-12 or 10^-tau a leading sign with digits or a word
440 x^2-y^3 will be read as x^2 - y^3, because items are
441 terminated by almost any nonword/nondigit char.
442 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
444 Still, ambiguity is possible - so when in doubt use {} to enclose the
445 sub/superscript. If you set this variable to the symbol `{}',
446 the braces are *required* in order to trigger interpretations as
448 frequently in plain text.
450 Not all export backends support this, but HTML does.
465 "Non-nil means turn on `org-beamer-mode' on startup.
466 This can also be configured on a per-file basis by adding one of
467 the following lines anywhere in the buffer:
469 #+STARTUP: beamer"
474 "Non-nil means align all tables when visiting a file.
475 This is useful when the column width in tables is forced with <N> cookies
476 in table fields. Such tables will look correct only after the first re-align.
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: align
480 #+STARTUP: noalign"
485 "Non-nil means show inline images when loading a new Org file.
486 This can also be configured on a per-file basis by adding one of
487 the following lines anywhere in the buffer:
488 #+STARTUP: inlineimages
489 #+STARTUP: noinlineimages"
494 "Non-nil means insert the first line setting Org-mode in empty files.
495 When the function `org-mode' is called interactively in an empty file, this
496 normally means that the file name does not automatically trigger Org-mode.
497 To ensure that the file will always be in Org-mode in the future, a
498 line enforcing Org-mode will be inserted into the buffer, if this option
499 has been set."
504 "Non-nil means use alternative key bindings for some keys.
505 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
506 These keys are also used by other packages like shift-selection-mode'
507 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
508 If you want to use Org-mode together with one of these other modes,
509 or more generally if you would like to move some Org-mode commands to
510 other keys, set this variable and configure the keys with the variable
511 `org-disputed-keys'.
513 This option is only relevant at load-time of Org-mode, and must be set
514 *before* org.el is loaded. Changing it requires a restart of Emacs to
515 become effective."
520 "Non-nil means use extra key sequence definitions for certain commands.
521 This happens automatically if you run XEmacs or if `window-system'
522 is nil. This variable lets you do the same manually. You must
523 set it before loading org.
525 Example: on Carbon Emacs 22 running graphically, with an external
526 keyboard on a Powerbook, the default way of setting M-left might
527 not work for either Alt or ESC. Setting this variable will make
528 it work for ESC."
542 "Keys for which Org-mode and other modes compete.
543 This is an alist, cars are the default keys, second element specifies
544 the alternative to use when `org-replace-disputed-keys' is t.
546 Keys can be specified in any syntax supported by `define-key'.
547 The value of this option takes effect only at Org-mode's startup,
548 therefore you'll have to restart Emacs to apply it after changing."
553 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
554 Or return the original if not disputed.
555 Also apply the translations defined in `org-xemacs-key-equivalents'."
560 org-disputed-keys)))
564 key)
574 "Define a key, possibly translated, as returned by `org-key'."
578 "The ellipsis to use in the Org-mode outline.
579 When nil, just use the standard three dots. When a string, use that instead,
580 When a face, use the standard 3 dots, but with the specified face.
581 The change affects only Org-mode (which will then use its own display table).
582 Changing this requires executing `M-x org-mode' in a buffer to become
583 effective."
593 "Keywords in Org-mode."
598 "String to mark deadline entries.
599 A deadline 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 to mark scheduled TODO entries.
608 A schedule is this string, followed by a time stamp. Should be a word,
609 terminated by a colon. You can insert a schedule keyword and
611 Changes become only effective after restarting Emacs."
616 "String used as the prefix for timestamps logging closing a TODO entry."
621 "String used as prefix for timestamps clocking work hours on an item."
626 "Entries starting with this keyword will never be exported.
627 An entry can be toggled between COMMENT and normal with
629 Changes become only effective after restarting Emacs."
634 "Entries starting with this keyword will be exported in fixed-width font.
635 Quoting applies only to the text in the entry following the headline, and does
636 not extend beyond the next headline, even if that is lower level.
637 An entry can be toggled between QUOTE and normal with
644 "Regular expression for specifying repeated events.
648 "Options concerning the general structure of Org-mode files."
653 "Options about how to make context of a location visible."
677 "Non-nil means show full hierarchy when revealing a location.
678 Org-mode often shows locations in an org-mode file which might have
679 been invisible before. When this is set, the hierarchy of headings
680 above the exposed location is shown.
681 Turning this off for example for sparse trees makes them very compact.
682 Instead of t, this can also be an alist specifying this option for different
683 contexts. Valid contexts are
684 agenda when exposing an entry from the agenda
685 org-goto when using the command `org-goto' on key C-c C-j
686 occur-tree when using the command `org-occur' on key C-c /
687 tags-tree when constructing a sparse tree based on tags matches
688 link-search when exposing search matches associated with a link
689 mark-goto when exposing the jump goal of a mark
690 bookmark-jump when exposing a bookmark location
691 isearch when exiting from an incremental search
692 default default for all contexts not set explicitly"
697 "Non-nil means show following heading when revealing a location.
698 Org-mode often shows locations in an org-mode file which might have
699 been invisible before. When this is set, the heading following the
700 match is shown.
701 Turning this off for example for sparse trees makes them very compact,
702 but makes it harder to edit the location of the match. In such a case,
704 Instead of t, this can also be an alist specifying this option for different
705 contexts. See `org-show-hierarchy-above' for valid contexts."
710 "Non-nil means show all sibling heading when revealing a location.
711 Org-mode often shows locations in an org-mode file which might have
712 been invisible before. When this is set, the sibling of the current entry
713 heading are all made visible. If `org-show-hierarchy-above' is t,
714 the same happens on each level of the hierarchy above the current entry.
716 By default this is on for the isearch context, off for all other contexts.
717 Turning this off for example for sparse trees makes them very compact,
718 but makes it harder to edit the location of the match. In such a case,
720 Instead of t, this can also be an alist specifying this option for different
721 contexts. See `org-show-hierarchy-above' for valid contexts."
726 "Non-nil means show the entry below a headline when revealing a location.
727 Org-mode often shows locations in an org-mode file which might have
728 been invisible before. When this is set, the text below the headline that is
729 exposed is also shown.
731 By default this is off for all contexts.
732 Instead of t, this can also be an alist specifying this option for different
733 contexts. See `org-show-hierarchy-above' for valid contexts."
738 "How should indirect tree buffers be displayed?
739 This applies to indirect buffers created with the commands
741 Valid values are:
742 current-window Display in the current window
743 other-window Just display in another window.
744 dedicated-frame Create one new frame, and re-use it each time.
745 new-frame Make a new frame each time. Note that in this case
746 previously-made indirect buffers are kept, and you need to
747 kill these buffers yourself."
757 "Non-nil means activate single letter commands at beginning of a headline.
758 This may also be a function to test for appropriate locations where speed
759 commands should be active."
767 "Alist of additional speed commands.
768 This list will be checked before `org-speed-commands-default'
769 when the variable `org-use-speed-commands' is non-nil
770 and when the cursor is at the beginning of a headline.
771 The car if each entry is a string with a single letter, which must
772 be assigned to `self-insert-command' in the global map.
773 The cdr is either a command to be called interactively, a function
774 to be called, or a form to be evaluated.
775 An entry that is just a list with a single string will be interpreted
776 as a descriptive headline that will be added when listing the speed
777 commands in the Help buffer using the `?' speed command."
789 "Options concerning visibility cycling in Org-mode."
794 "Non-nil means skip CHILDREN state in entries that don't have any."
799 "Maximum level which should still be subject to visibility cycling.
800 Levels higher than this will, for cycling, be treated as text, not a headline.
801 When `org-odd-levels-only' is set, a value of N in this variable actually
802 means 2N-1 stars as the limiting headline.
803 When nil, cycle all levels.
804 Note that the limiting level of cycling is also influenced by
805 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
806 `org-inlinetask-min-level' is, cycling will be limited to levels one less
807 than its value."
814 "Names of drawers. Drawers are not opened by cycling on the headline above.
815 Drawers only open with a TAB on the drawer line itself. A drawer looks like
816 this:
817 :DRAWERNAME:
818 .....
819 :END:
821 the property API.
823 Drawers can be defined on the per-file basis with a line like:
825 #+DRAWERS: HIDDEN STATE PROPERTIES"
831 "Non-nil means entering Org-mode will fold all blocks.
832 This can also be set in on a per-file basis with
834 #+STARTUP: hideblocks
835 #+STARTUP: showblocks"
841 "Cycle globally if cursor is at beginning of buffer and not at a headline.
842 This makes it possible to do global cycling without having to use S-TAB or
844 of the buffer
845 must not be a headline - it may be empty or some other text. When used in
846 this way, `org-cycle-hook' is disables temporarily, to make sure the
847 cursor stays at the beginning of the buffer.
848 When this option is nil, don't do anything special at the beginning
849 of the buffer."
854 "Non-nil means cycle entry level or item indentation in new empty entries.
856 When the cursor is at the end of an empty headline, i.e with only stars
857 and maybe a TODO keyword, TAB will then switch the entry to become a child,
858 and then all possible ancestor states, before returning to the original state.
859 This makes data entry extremely fast: M-RET to create a new headline,
860 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
862 When the cursor is at the end of an empty plain list item, one TAB will
863 make it a subitem, two or more tabs will back up to make this an item
864 higher up in the item hierarchy."
869 "Where should `org-cycle' emulate TAB.
870 nil Never
871 white Only in completely white lines
872 whitestart Only at the beginning of lines, before the first non-white char
873 t Everywhere except in headlines
874 exc-hl-bol Everywhere except at the start of a headline
875 If TAB is used in a place where it does not emulate TAB, the current subtree
876 visibility is cycled."
883 ))
886 "Number of empty lines needed to keep an empty line between collapsed trees.
887 If you leave an empty line between the end of a subtree and the following
888 headline, this empty line is hidden when the subtree is folded.
889 Org-mode will leave (exactly) one empty line visible if the number of
890 empty lines is equal or larger to the number given in this variable.
891 So the default 2 means at least 2 empty lines after the end of a subtree
892 are needed to produce free space between a collapsed subtree and the
893 following headline.
895 If the number is negative, and the number of empty lines is at least -N,
896 all empty lines are shown.
898 Special case: when 0, never leave empty lines in collapsed view."
904 "Hook that is run before visibility cycling is happening.
905 The function(s) in this hook must accept a single argument which indicates
906 the new state that will be set right after running this hook. The
907 argument is a symbol. Before a global state change, it can have the values
908 `overview', `content', or `all'. Before a local state change, it can have
909 the values `folded', `children', or `subtree'."
914 org-cycle-hide-drawers
915 org-cycle-show-empty-lines
916 org-optimize-window-after-visibility-change)
917 "Hook that is run after `org-cycle' has changed the buffer visibility.
918 The function(s) in this hook must accept a single argument which indicates
919 the new state that was set by the most recent `org-cycle' command. The
920 argument is a symbol. After a global state change, it can have the values
921 `overview', `content', or `all'. After a local state change, it can have
922 the values `folded', `children', or `subtree'."
927 "Options concerning structure editing in Org-mode."
932 "Non-nil means skip even levels and only use odd levels for the outline.
933 This has the effect that two stars are being added/taken away in
934 promotion/demotion commands. It also influences how levels are
935 handled by the exporters.
936 Changing it requires restart of `font-lock-mode' to become effective
937 for fontification also in regions already fontified.
938 You may also set this on a per-file basis by adding one of the following
939 lines to the buffer:
941 #+STARTUP: odd
942 #+STARTUP: oddeven"
948 "Non-nil means adapt indentation to outline node level.
950 When this variable is set, Org assumes that you write outlines by
951 indenting text in each node to align with the headline (after the stars).
952 The following issues are influenced by this variable:
954 - When this is set and the *entire* text in an entry is indented, the
955 indentation is increased by one space in a demotion command, and
956 decreased by one in a promotion command. If any line in the entry
957 body starts with text at column 0, indentation is not changed at all.
959 - Property drawers and planning information is inserted indented when
960 this variable s set. When nil, they will not be indented.
962 - TAB indents a line relative to context. The lines below a headline
963 will be indented when this variable is set.
965 Note that this is all about true indentation, by adding and removing
966 space characters. See also `org-indent.el' which does level-dependent
967 indentation in a virtual way, i.e. at display time in Emacs."
972 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
974 When t, `C-a' will bring back the cursor to the beginning of the
975 headline text, i.e. after the stars and after a possible TODO keyword.
976 In an item, this will be the position after the bullet.
977 When the cursor is already at that position, another `C-a' will bring
978 it to the beginning of the line.
980 `C-e' will jump to the end of the headline, ignoring the presence of tags
981 in the headline. A second `C-e' will then jump to the true end of the
982 line, after any tags. This also means that, when this variable is
983 non-nil, `C-e' also will never jump beyond the end of the heading of a
984 folded section, i.e. not after the ellipses.
986 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
987 going to the true line boundary first. Only a directly following, identical
988 keypress will bring the cursor to the special positions.
990 This may also be a cons cell where the behavior for `C-a' and `C-e' is
991 set separately."
1010 "Non-nil means `C-k' will behave specially in headlines.
1011 When nil, `C-k' will call the default `kill-line' command.
1012 When t, the following will happen while the cursor is in the headline:
1014 - When the cursor is at the beginning of a headline, kill the entire
1015 line and possible the folded subtree below the line.
1016 - When in the middle of the headline text, kill the headline up to the tags.
1017 - When after the headline text, kill the tags."
1022 "Non-nil means, do not delete a hidden subtree with C-k.
1023 When set to the symbol `error', simply throw an error when C-k is
1024 used to kill (part-of) a headline that has hidden text behind it.
1025 Any other non-nil value will result in a query to the user, if it is
1026 OK to kill that hidden subtree. When nil, kill without remorse."
1034 "Non-nil means when yanking subtrees, fold them.
1035 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1036 it starts with a heading and all other headings in it are either children
1037 or siblings, then fold all the subtrees. However, do this only if no
1038 text after the yank would be swallowed into a folded tree by this action."
1043 "Non-nil means when yanking subtrees, adjust the level.
1044 With this setting, `org-paste-subtree' is used to insert the subtree, see
1045 this function for details."
1050 "Non-nil means M-RET will split the line at the cursor position.
1051 When nil, it will go to the end of the line before making a
1052 new line.
1053 You may also set this option in a different way for different
1054 contexts. Valid contexts are:
1056 headline when creating a new headline
1057 item when creating a new item
1058 table in a table field
1059 default the value to be used for all contexts not explicitly
1060 customized"
1077 "Non-nil means insert new headings after the current subtree.
1078 When nil, the new heading is created directly after the current line.
1081 for the duration of the command."
1087 "Should `org-insert-heading' leave a blank line before new heading/item?
1088 The value is an alist, with `heading' and `plain-list-item' as car,
1089 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1090 Org will look at the surrounding headings/items and try to make an
1091 intelligent decision whether to insert a blank line or not.
1093 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1094 set, the setting here is ignored and no empty line is inserted, to avoid
1095 breaking the list structure."
1108 "Hook being run after inserting a new heading."
1114 This currently only means they are never auto-wrapped.
1115 When nil, such lines will be treated like ordinary lines.
1116 See also the QUOTE keyword."
1121 "Non-nil means typing characters in `org-goto' starts incremental search."
1126 "Options concerning sparse trees in Org-mode."
1131 "Non-nil means highlight all matches that define a sparse tree.
1132 The highlights will automatically disappear the next time the buffer is
1133 changed by an edit command."
1138 "Non-nil means any change to the buffer will remove temporary highlights.
1139 Such highlights are created by `org-occur' and `org-clock-display'.
1140 When nil, `C-c C-c needs to be used to get rid of the highlights.
1141 The highlights created by `org-preview-latex-fragment' always need
1142 `C-c C-c' to be removed."
1149 "Hook that is run after `org-occur' has constructed a sparse tree.
1150 This can be used to recenter the window to show as much of the structure
1151 as possible."
1156 "Options concerning imenu and speedbar in Org-mode."
1161 "The maximum level for Imenu access to Org-mode headlines.
1162 This also applied for speedbar access."
1167 "Options concerning tables in Org-mode."
1173 When nil, such lines will be treated like ordinary lines.
1175 When equal to the symbol `optimized', the table editor will be optimized to
1176 do the following:
1177 - Automatic overwrite mode in front of whitespace in table fields.
1178 This makes the structure of the table stay in tact as long as the edited
1179 field does not exceed the column width.
1180 - Minimize the number of realigns. Normally, the table is aligned each time
1181 TAB or RET are pressed to move to another field. With optimization this
1182 happens only if changes to a field might have changed the column width.
1183 Optimization requires replacing the functions `self-insert-command',
1184 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1185 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1186 very good at guessing when a re-align will be necessary, but you can always
1189 If you would like to use the optimized version in Org-mode, but the
1190 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1192 This variable can be used to turn on and off the table editor during a session,
1193 but in order to toggle optimization, a restart is required.
1195 See also the variable `org-table-auto-blank-field'."
1203 "Non-nil means cluster self-insert commands for undo when possible.
1204 If this is set, then, like in the Emacs command loop, 20 consecutive
1205 characters will be undone together.
1206 This is configurable, because there is some impact on typing performance."
1211 "Non-nil means TAB will automatically notice a table.el table.
1212 When it sees such a table, it moves point into it and - if necessary -
1213 calls `table-recognize-table'."
1218 "Options concerning links in Org-mode."
1223 "Buffer-local version of `org-link-abbrev-alist', which see.
1228 "Alist of link abbreviations.
1229 The car of each element is a string, to be replaced at the start of a link.
1231 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1233 [[linkkey:tag][description]]
1235 The 'linkkey' must be a word word, starting with a letter, followed
1236 by letters, numbers, '-' or '_'.
1238 If REPLACE is a string, the tag will simply be appended to create the link.
1241 be inserted at that point (see the function `url-hexify-string').
1243 REPLACE may also be a function that will be called with the tag as the
1244 only argument to create the link, which should be returned as a string.
1246 See the manual for examples."
1256 "Non-nil means hide link part and only show description of bracket links.
1257 Bracket links are like [[link][description]]. This variable sets the initial
1258 state in new org-mode buffers. The setting can then be toggled on a
1259 per-buffer basis from the Org->Hyperlinks menu."
1264 "How the path name in file links should be stored.
1265 Valid values are:
1267 relative Relative to the current directory, i.e. the directory of the file
1268 into which the link is being inserted.
1269 absolute Absolute path, if possible with ~ for home directory.
1270 noabbrev Absolute path, no abbreviation of home directory.
1271 adaptive Use relative path for files in the current directory and sub-
1272 directories of it. For other files, use an absolute path."
1281 "Types of links that should be activated in Org-mode files.
1282 This is a list of symbols, each leading to the activation of a certain link
1283 type. In principle, it does not hurt to turn on most link types - there may
1284 be a small gain when turning off unused link types. The types are:
1286 bracket The recommended [[link][description]] or [[link]] links with hiding.
1287 angle Links in angular brackets that may contain whitespace like
1288 <bbdb:Carsten Dominik>.
1289 plain Plain links in normal text, no whitespace, like http://google.com.
1290 radio Text that is matched by a radio target, see manual for details.
1291 tag Tag settings in a headline (link to tag search).
1292 date Time stamps (link to calendar).
1293 footnote Footnote labels.
1295 Changing this variable requires a restart of Emacs to become effective."
1307 "Function to use to generate link descriptions from links.
1308 If nil the link location will be used. This function must take
1309 two parameters; the first is the link and the second the
1310 description `org-insert-link' has generated, and should return the
1311 description to use."
1316 "Options concerning storing links in Org-mode."
1321 "Format of the description part of a link to an email or usenet message.
1322 The following %-escapes will be replaced by corresponding information:
1330 %s subject
1331 %d date
1332 %m message-id.
1334 You may use normal field width specification between the % and the letter.
1335 This is for example useful to limit the length of the subject.
1349 It should match if the message is from the user him/herself."
1354 "Non-nil means storing a link to an Org file will use entry IDs.
1356 Note that before this variable is even considered, org-id must be loaded,
1357 so please customize `org-modules' and turn it on.
1359 The variable can have the following values:
1361 t Create an ID if needed to make a link to the current entry.
1363 create-if-interactive
1364 If `org-store-link' is called directly (interactively, as a user
1365 command), do create an ID to support the link. But when doing the
1366 job for remember, only use the ID if it already exists. The
1367 purpose of this setting is to avoid proliferation of unwanted
1368 IDs, just because you happen to be in an Org file when you
1369 call `org-remember' that automatically and preemptively
1370 creates a link. If you do want to get an ID link in a remember
1371 template to an entry not having an ID, create it first by
1372 explicitly creating a link to it, using `C-c C-l' first.
1374 create-if-interactive-and-no-custom-id
1375 Like create-if-interactive, but do not create an ID if there is
1376 a CUSTOM_ID property defined in the entry. This is the default.
1378 use-existing
1379 Use existing ID, do not create one.
1381 nil Never use an ID to make a link, instead link using a text search for
1382 the headline text."
1387 create-if-interactive)
1389 create-if-interactive-and-no-custom-id)
1394 "Non-nil means file links from `org-store-link' contain context.
1395 A search string will be added to the file name with :: as separator and
1396 used to find the context when the link is activated by the command
1397 `org-open-at-point'. When this option is t, the entire active region
1398 will be placed in the search string of the file link. If set to a
1399 positive integer, only the first n lines of context will be stored.
1402 negates this setting for the duration of the command."
1407 "Non-nil means keep link in list for entire session.
1409 The command `org-store-link' adds a link pointing to the current
1410 location to an internal list. These links accumulate during a session.
1411 The command `org-insert-link' can be used to insert links into any
1412 Org-mode file (offering completion for all stored links). When this
1414 will be removed from the list, to make completing the unused links
1415 more efficient."
1420 "Options concerning following links in Org-mode."
1425 "Function to translate links with different syntax to Org syntax.
1426 This can be used to translate links created for example by the Planner
1427 or emacs-wiki packages to Org syntax.
1428 The function must accept two parameters, a TYPE containing the link
1430 which is everything after the link protocol. It should return a cons
1431 with possibly modified values of type and path.
1432 Org contains a function for this, so if you set this variable to
1433 `org-translate-link-from-planner', you should be able follow many
1434 links created by planner."
1439 "Hook that is run after a link has been followed."
1444 "Non-nil means on links TAB will follow the link.
1445 Needs to be set before org.el is loaded.
1446 This really should not be used, it does not make sense, and the
1447 implementation is bad."
1452 "Non-nil means on links RET will follow the link."
1458 "Non-nil means mouse-1 on a link will follow the link.
1459 A longer mouse click will still set point. Does not work on XEmacs.
1460 Needs to be set before org.el is loaded."
1465 "Number of different positions to be recorded in the ring.
1466 Changing this requires a restart of Emacs to work correctly."
1471 "Non-nil means internal links in Org files must exactly match a headline.
1472 When nil, the link search tries to match a phrase with all words
1473 in the search text."
1479 query-to-create)))
1486 "Setup the frame configuration for following links.
1487 When following a link with Emacs, it may often be useful to display
1488 this link in another window or frame. This variable can be used to
1489 set this up for the different types of links.
1490 For VM, use any of
1491 `vm-visit-folder'
1492 `vm-visit-folder-other-window'
1493 `vm-visit-folder-other-frame'
1494 For Gnus, use any of
1495 `gnus'
1496 `gnus-other-frame'
1497 `org-gnus-no-new-news'
1498 For FILE, use any of
1499 `find-file'
1500 `find-file-other-window'
1501 `find-file-other-frame'
1502 For Wanderlust use any of
1503 `wl'
1504 `wl-other-frame'
1505 For the calendar, use the variable `calendar-setup'.
1506 For BBDB, it is currently only possible to display the matches in
1507 another window."
1531 "Non-nil means use indirect buffer to display infile links.
1532 Activating internal links (from one location in a file to another location
1533 in the same file) normally just jumps to the location. When the link is
1535 is displayed in
1536 another window. When this option is set, the other window actually displays
1537 an indirect buffer clone of the current buffer, to avoid any visibility
1538 changes to the current buffer."
1543 "Non-nil means `org-open-file' will open non-existing files.
1544 When nil, an error will be generated.
1545 This variable applies only to external applications because they
1546 might choke on non-existing files. If the link is to a file that
1547 will be opened in Emacs, the variable is ignored."
1552 "Non-nil means a link to a directory really means to index.org.
1553 When nil, following a directory link will run dired or open a finder/explorer
1554 window on that directory."
1559 "Function and arguments to call for following mailto links.
1560 This is a list with the first element being a Lisp function, and the
1561 remaining elements being arguments to the function. In string arguments,
1562 %a will be replaced by the address, and %s will be replaced by the subject
1563 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1572 "Non-nil means ask for confirmation before executing shell links.
1573 Shell links can be dangerous: just think about a link
1575 [[shell:rm -rf ~/*][Google Search]]
1578 but really it would remove your entire home directory.
1579 Therefore we advise against setting this variable to nil.
1580 Just change it to `y-or-n-p' if you want to confirm with a
1588 'safe-local-variable
1592 "A regexp to skip confirmation for shell links."
1597 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1598 Elisp links can be dangerous: just think about a link
1603 but really it would remove your entire home directory.
1604 Therefore we advise against setting this variable to nil.
1605 Just change it to `y-or-n-p' if you want to confirm with a
1613 'safe-local-variable
1617 "A regexp to skip confirmation for Elisp links."
1625 "Default file applications on a UNIX or GNU/Linux system.
1636 "Default file applications on a MacOS X system.
1638 for some files for which the OS does not have a good default.
1646 'mswindows-shell-execute
1651 'mswindows-shell-execute
1654 "Default file applications on a Windows NT system.
1659 '(
1664 )
1665 "External applications for opening `file:path' items in a document.
1666 Org-mode uses system defaults for different file types, but
1667 you can use this variable to set the application for a given file
1668 extension. The entries in this list are cons cells where the car identifies
1669 files and the cdr the corresponding command. Possible values for the
1670 file identifier are
1672 ways, depending on its contents:
1674 - Alphanumeric characters only:
1675 Match links with this file extension.
1677 to open PDFs with evince.
1679 - Regular expression: Match links where the
1680 filename matches the regexp. If you want to
1681 use groups here, use shy groups.
1685 to open *.html and *.xhtml with firefox.
1687 - Regular expression which contains (non-shy) groups:
1689 anything after that, matches the regexp.
1690 In a custom command string, %1, %2, etc. are replaced with
1691 the parts of the link that were matched by the groups.
1692 For backwards compatibility, if a command string is given
1693 that does not use any of the group matches, this case is
1694 handled identically to the second one (i.e. match against
1695 file name only).
1696 In a custom lisp form, you can access the group matches with
1697 (match-string n link).
1700 to open [[file:document.pdf::5]] with evince at page 5.
1702 `directory' Matches a directory
1703 `remote' Matches a remote file, accessible through tramp or efs.
1704 Remote files most likely should be visited through Emacs
1705 because external applications cannot handle such paths.
1706 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1707 so all files Emacs knows how to handle. Using this with
1708 command `emacs' will open most files in Emacs. Beware that this
1709 will also open html files inside Emacs, unless you add
1711 t Default for files not matched by any of the other options.
1712 `system' The system command to open files, like `open' on Windows
1713 and Mac OS X, and mailcap under GNU/Linux. This is the command
1714 that will be selected if you call `C-c C-o' with a double
1717 Possible values for the command are:
1718 `emacs' The file will be visited by the current Emacs process.
1719 `default' Use the default application for this file type, which is the
1720 association for t in the list, most likely in the system-specific
1721 part.
1722 This can be used to overrule an unwanted setting in the
1723 system-specific variable.
1725 This command is specified by the entry whose car is `system'.
1726 Most likely, the system-specific version of this variable
1727 does define this command, but you can overrule/replace it
1728 here.
1729 string A command to be executed by a shell; %s will be replaced
1730 by the path to the file.
1731 sexp A Lisp form which will be evaluated. The file path will
1732 be available in the Lisp variable `file'.
1733 For more examples, see the system specific constants
1734 `org-file-apps-defaults-macosx'
1735 `org-file-apps-defaults-windowsnt'
1736 `org-file-apps-defaults-gnu'."
1746 auto-mode))
1757 "Options concerning refiling entries in Org-mode."
1762 "Directory with org files.
1763 This is just a default location to look for Org files. There is no need
1764 at all to put your files into this directory. It is only used in the
1765 following situations:
1767 1. When a remember template specifies a target file that is not an
1768 absolute path. The path will then be interpreted relative to
1769 `org-directory'
1770 2. When a remember note is filed away in an interactive way (when exiting the
1771 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1772 with `org-directory' as the default path."
1778 "Default target for storing notes.
1779 Used as a fall back file for org-remember.el and org-capture.el, for
1780 templates that do not specify a target file."
1785 file))
1788 "The default interface to be used for `org-goto'.
1789 Allowed values are:
1790 outline The interface shows an outline of the relevant file
1791 and the correct heading is found by moving through
1792 the outline or by searching with incremental search.
1793 outline-path-completion Headlines in the current buffer are offered via
1794 completion. This is the interface also used by
1795 the refile command."
1802 "Maximum target level when running `org-goto' with refile interface."
1807 "Non-nil means store new notes at the beginning of a file or entry.
1808 When nil, new notes will be filed to the end of a file or entry.
1809 This can also be a list with cons cells of regular expressions that
1810 are matched against file names, and values."
1820 "Information to record when a task is refiled.
1822 Possible values are:
1824 nil Don't add anything
1825 time Add a time stamp to the task
1826 note Prompt for a note and add it with template `org-log-note-headings'
1828 This option can also be set with on a per-file-basis with
1830 #+STARTUP: nologrefile
1831 #+STARTUP: logrefile
1832 #+STARTUP: lognoterefile
1834 You can have local logging settings for a subtree by setting the LOGGING
1835 property to one or more of these keywords.
1837 When bulk-refiling from the agenda, the value `note' is forbidden and
1838 will temporarily be changed to `time'."
1848 This is list of cons cells. Each cell contains:
1849 - a specification of the files to be considered, either a list of files,
1850 or a symbol whose function or variable value will be used to retrieve
1851 a file name or a list of file names. If you use `org-agenda-files' for
1852 that, all agenda files will be scanned for targets. Nil means consider
1853 headings in the current buffer.
1854 - A specification of how to find candidate refile targets. This may be
1855 any of:
1857 This tag has to be present in all target headlines, inheritance will
1858 not be considered.
1860 todo keyword.
1862 headlines that are refiling targets.
1863 - a cons cell (:level . N). Any headline of level N is considered a target.
1864 Note that, when `org-odd-levels-only' is set, level corresponds to
1865 order in hierarchy, not to the number of stars.
1866 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1867 Note that, when `org-odd-levels-only' is set, level corresponds to
1868 order in hierarchy, not to the number of stars.
1870 You can set the variable `org-refile-target-verify-function' to a function
1871 to verify each headline found by the simple criteria above.
1873 When this variable is nil, all top-level headlines in the current buffer
1874 are used, equivalent to the value `((nil . (:level . 1))'."
1890 "Function to verify if the headline at point should be a refile target.
1891 The function will be called without arguments, with point at the
1892 beginning of the headline. It should return t and leave point
1893 where it is if the headline is a valid target for refiling.
1895 If the target should not be selected, the function must return nil.
1896 In addition to this, it may move point to a place from where the search
1897 should be continued. For example, the function may decide that the entire
1898 subtree of the current entry should be excluded and move point to the end
1899 of the subtree."
1904 "Non-nil means cache refile targets to speed up the process.
1905 The cache for a particular file will be updated automatically when
1906 the buffer has been killed, or when any of the marker used for flagging
1907 refile targets no longer points at a live buffer.
1908 If you have added new entries to a buffer that might themselves be targets,
1909 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1910 find that easier, `C-u C-u C-u C-c C-w'."
1915 "Non-nil means provide refile targets as paths.
1916 So a level 3 headline will be available as level1/level2/level3.
1918 When the value is `file', also include the file name (without directory)
1919 into the path. In this case, you can also stop the completion after
1920 the file name, to get entries inserted as top level in the file.
1922 When `full-file-path', include the full file path."
1931 "Non-nil means complete the outline path in hierarchical steps.
1932 When Org-mode uses the refile interface to select an outline path
1933 \(see variable `org-refile-use-outline-path'), the completion of
1934 the path can be done is a single go, or if can be done in steps down
1935 the headline hierarchy. Going in steps is probably the best if you
1936 do not use a special completion package like `ido' or `icicles'.
1937 However, when using these packages, going in one step can be very
1938 fast, while still showing the whole path to the entry."
1943 "Non-nil means allow to create new nodes as refile targets.
1945 of an existing node. When the value of this variable is `confirm',
1946 new node creation must be confirmed by the user (recommended)
1947 When nil, the completion must match an existing entry.
1949 Note that, if the new heading is not seen by the criteria
1950 listed in `org-refile-targets', multiple instances of the same
1951 heading would be created by trying again to file under the new
1952 heading."
1960 "Options concerning TODO items in Org-mode."
1965 "Options concerning Progress logging in Org-mode."
1970 '(
1973 "The available interpretation symbols for customizing `org-todo-keywords'.
1977 "List of TODO entry keyword sequences and their interpretation.
1980 Each sequence starts with a symbol, either `sequence' or `type',
1981 indicating if the keywords should be interpreted as a sequence of
1982 action steps, or as different types of TODO items. The first
1983 keywords are states requiring action - these states will select a headline
1984 for inclusion into the global TODO list Org-mode produces. If one of
1987 the last keyword is treated as the only DONE state of the sequence.
1990 additional state where no keyword is present. For details about this
1991 cycling, see the manual.
1993 TODO keywords and interpretation can also be set on a per-file basis with
1994 the special #+SEQ_TODO and #+TYP_TODO lines.
1996 Each keyword can optionally specify a character for fast state selection
1997 \(in combination with the variable `org-use-fast-todo-selection')
1998 and specifiers for state change logging, using the same syntax
2001 indicates to record a time stamp each time this state is selected.
2003 Each keyword may also specify if a timestamp or a note should be
2004 recorded when entering or leaving the state, by adding additional
2005 characters in the parenthesis after the keyword. This looks like this:
2007 record only the time of the state change. With X and Y being either
2009 Y when leaving the state if and only if the *target* state does not
2010 define X. You may omit any of the fast-selection key or X or /Y,
2011 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2013 For backward compatibility, this variable may also be just a list
2014 of keywords - in this case the interpretation (sequence or type) will be
2015 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2025 ;;Quick and dirty way to see
2026 ;;`org-todo-interpretations'. This takes the
2027 ;;place of item arguments
2028 :convert-widget
2035 org-todo-interpretation-widgets))
2036 widget))
2067 "Controls how TODO keywords are interpreted.
2068 This variable is in principle obsolete and is only used for
2069 backward compatibility, if the interpretation of todo keywords is
2070 not given already in `org-todo-keywords'. See that variable for
2071 more information."
2078 "Non-nil means use the fast todo selection scheme with C-c C-t.
2079 This variable describes if and under what circumstances the cycling
2080 mechanism for TODO keywords will be replaced by a single-key, direct
2081 selection scheme.
2083 When nil, fast selection is never used.
2085 When the symbol `prefix', it will be used when `org-todo' is called with
2086 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2087 in an agenda buffer.
2089 When t, fast selection is used by default. In this case, the prefix
2090 argument forces cycling instead.
2092 In all cases, the special interface is only used if access keys have actually
2093 been assigned by the user, i.e. if keywords in the configuration are followed
2094 by a letter in parenthesis, like TODO(t)."
2102 "Non-nil means update todo statistics after insert and toggle.
2103 ALL-HEADLINES means update todo statistics by including headlines
2104 with no TODO keyword as well, counting them as not done.
2105 A list of TODO keywords means the same, but skip keywords that are
2106 not in this list.
2108 When this is set, todo statistics is updated in the parent of the
2109 current entry each time a todo state is changed."
2119 "Non-nil means TODO statistics covers just direct children.
2120 When nil, all entries in the subtree are considered.
2121 This has only an effect if `org-provide-todo-statistics' is set.
2122 To set this to nil for only a single subtree, use a COOKIE_DATA
2128 "Hook which is run after the state of a TODO item was changed.
2129 The new state (a string with a TODO keyword, or nil) is available in the
2130 Lisp variable `state'."
2135 "Hook for functions that are allowed to block a state change.
2137 Each function gets as its single argument a property list, see
2138 `org-trigger-hook' for more information about this list.
2140 If any of the functions in this hook returns nil, the state change
2144 "Hook for functions that are triggered by a state change.
2146 Each function gets as its single argument a property list with at least
2147 the following elements:
2149 (:type type-of-change :position pos-at-entry-start
2150 :from old-state :to new-state)
2152 Depending on the type, more properties may be present.
2154 This mechanism is currently implemented for:
2156 TODO state changes
2157 ------------------
2158 :type todo-state-change
2159 :from previous state (keyword as a string), or nil, or a symbol
2160 'todo' or 'done', to indicate the general type of state.
2164 "Non-nil means undone TODO entries will block switching the parent to DONE.
2165 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2166 be blocked if any prior sibling is not yet done.
2167 Finally, if the parent is blocked because of ordered siblings of its own,
2168 the child will also be blocked.
2169 This variable needs to be set before org.el is loaded, and you need to
2170 restart Emacs after a change to make the change effective. The only way
2171 to change is while Emacs is running is through the customize interface."
2183 "Non-nil means unchecked boxes will block switching the parent to DONE.
2184 When this is nil, checkboxes have no influence on switching TODO states.
2185 When non-nil, you first need to check off all check boxes before the TODO
2186 entry can be switched to DONE.
2187 This variable needs to be set before org.el is loaded, and you need to
2188 restart Emacs after a change to make the change effective. The only way
2189 to change is while Emacs is running is through the customize interface."
2201 "Non-nil means inserting a TODO heading is treated as state change.
2203 logging will apply if appropriate. When nil, the new TODO item will
2204 be inserted directly, and no logging will take place."
2209 "Non-nil means switching TODO states with S-cursor counts as state change.
2210 This is the default behavior. However, setting this to nil allows a
2211 convenient way to select a TODO state and bypass any logging associated
2212 with that."
2217 "Tag changes that should be triggered by TODO state changes.
2218 This is a list. Each entry is
2220 (state-change (tag . flag) .......)
2222 State-change can be a string with a state, and empty string to indicate the
2223 state that has no TODO keyword, or it can be one of the symbols `todo'
2224 or `done', meaning any not-done or done state, respectively."
2238 "Information to record when a task moves to the DONE state.
2240 Possible values are:
2242 nil Don't add anything, just change the keyword
2243 time Add a time stamp to the task
2244 note Prompt for a note and add it with template `org-log-note-headings'
2246 This option can also be set with on a per-file-basis with
2248 #+STARTUP: nologdone
2249 #+STARTUP: logdone
2250 #+STARTUP: lognotedone
2252 You can have local logging settings for a subtree by setting the LOGGING
2253 property to one or more of these keywords."
2261 ;; Normalize old uses of org-log-done.
2268 "Information to record when the scheduling date of a tasks is modified.
2270 Possible values are:
2272 nil Don't add anything, just change the date
2273 time Add a time stamp to the task
2274 note Prompt for a note and add it with template `org-log-note-headings'
2276 This option can also be set with on a per-file-basis with
2278 #+STARTUP: nologreschedule
2279 #+STARTUP: logreschedule
2280 #+STARTUP: lognotereschedule"
2289 "Information to record when the deadline date of a tasks is modified.
2291 Possible values are:
2293 nil Don't add anything, just change the date
2294 time Add a time stamp to the task
2295 note Prompt for a note and add it with template `org-log-note-headings'
2297 This option can also be set with on a per-file-basis with
2299 #+STARTUP: nologredeadline
2300 #+STARTUP: logredeadline
2301 #+STARTUP: lognoteredeadline
2303 You can have local logging settings for a subtree by setting the LOGGING
2304 property to one or more of these keywords."
2313 "Non-nil means record a note when clocking out of an item.
2314 This can also be configured on a per-file basis by adding one of
2315 the following lines anywhere in the buffer:
2317 #+STARTUP: lognoteclock-out
2318 #+STARTUP: nolognoteclock-out"
2324 "Non-nil means the CLOSED time stamp will contain date and time.
2325 When nil, only the date will be recorded."
2339 "Headings for notes added to entries.
2340 The value is an alist, with the car being a symbol indicating the note
2341 context, and the cdr is the heading to be used. The heading may also be the
2342 empty string.
2343 %t in the heading will be replaced by a time stamp.
2344 %T will be an active time stamp instead the default inactive one
2345 %s will be replaced by the new TODO state, in double quotes.
2346 %S will be replaced by the old TODO state, in double quotes.
2347 %u will be replaced by the user name.
2348 %U will be replaced by the full user name.
2350 In fact, it is not a good idea to change the `state' entry, because
2351 agenda log mode depends on the format of these entries."
2357 "Heading when changing todo state (todo sequence only)"
2371 "Non-nil means insert state change notes and time stamps into a drawer.
2372 When nil, state changes notes will be inserted after the headline and
2373 any scheduling and clock lines, but not inside a drawer.
2375 The value of this variable should be the name of the drawer to use.
2376 LOGBOOK is proposed at the default drawer for this purpose, you can
2377 also set this to a string to define the drawer of your choice.
2381 If this variable is set, `org-log-state-notes-insert-after-drawers'
2382 will be ignored.
2384 You can set the property LOG_INTO_DRAWER to overrule this setting for
2385 a subtree."
2397 "Return the value of `org-log-into-drawer', but let properties overrule.
2398 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2399 used instead of the default value."
2407 "Non-nil means insert state change notes after any drawers in entry.
2408 Only the drawers that *immediately* follow the headline and the
2409 deadline/scheduled line are skipped.
2410 When nil, insert notes right after the heading and perhaps the line
2411 with deadline/scheduling if present.
2413 This variable will have no effect if `org-log-into-drawer' is
2414 set."
2420 "Non-nil means the latest state note will be directly after heading.
2421 When nil, the state change notes will be ordered according to time."
2427 "The TODO state to which a repeater should return the repeating task.
2428 By default this is the first task in a TODO sequence, or the previous state
2429 in a TODO_TYP set. But you can specify another task here.
2430 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2436 "Non-nil means record moving through the DONE state when triggering repeat.
2437 An auto-repeating task is immediately switched back to TODO when
2440 record a closing note, there will be no record of the task moving
2441 through DONE. This variable forces taking a note anyway.
2443 nil Don't force a record
2444 time Record a time stamp
2445 note Record a note
2447 This option can also be set with on a per-file-basis with
2449 #+STARTUP: logrepeat
2450 #+STARTUP: lognoterepeat
2451 #+STARTUP: nologrepeat
2453 You can have local logging settings for a subtree by setting the LOGGING
2454 property to one or more of these keywords."
2464 "Priorities in Org-mode."
2469 "Non-nil means priority commands are active.
2470 When nil, these commands will be disabled, so that you never accidentally
2471 set a priority."
2476 "The highest priority of TODO items. A character like ?A, ?B etc.
2477 Must have a smaller ASCII number than `org-lowest-priority'."
2482 "The lowest priority of TODO items. A character like ?A, ?B etc.
2483 Must have a larger ASCII number than `org-highest-priority'."
2488 "The default priority of TODO items.
2489 This is the priority an item get if no explicit priority is given."
2494 "Non-nil means start with default priority when starting to cycle.
2495 When this is nil, the first step in the cycle will be (depending on the
2496 command used) one higher or lower that the default priority."
2501 "Function to extract the priority from a string.
2502 The string is normally the headline. If this is nil Org computes the
2503 priority from the priority cookie like [#A] in the headline. It returns
2504 an integer, increasing by 1000 for each priority level.
2505 The user can set a different function here, which should take a string
2506 as an argument and return the numeric priority."
2511 "Options concerning time stamps and deadlines in Org-mode."
2516 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2517 When nil, these labeled time stamps are forces into the second line of an
2518 entry, just after the headline. When scheduling from the global TODO list,
2519 the time stamp will always be forced into the second line."
2524 "Formats for `format-time-string' which are used for time stamps.
2528 "Number of minutes to round time stamps to.
2529 These are two values, the first applies when first creating a time stamp.
2530 The second applies when changing it with the commands `S-up' and `S-down'.
2531 When changing the time stamp, this means that it will change in steps
2532 of N minutes, as given by the second value.
2534 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2535 numbers should be factors of 60, so for example 5, 10, 15.
2537 When this is larger than 1, you can still force an exact time stamp by using
2538 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2539 and by using a prefix arg to `S-up/down' to specify the exact number
2540 of minutes to shift."
2550 ;; Normalize old customizations of this variable.
2554 org-time-stamp-rounding-minutes)))
2557 "Non-nil means overlay custom formats over all time stamps.
2558 The formats are defined through the variable `org-time-stamp-custom-formats'.
2559 To turn this on on a per-file basis, insert anywhere in the file:
2560 #+STARTUP: customtime"
2568 "Custom formats for time stamps. See `format-time-string' for the syntax.
2569 These are overlayed over the default ISO format if the variable
2570 `org-display-custom-times' is set. Time like %H:%M should be at the
2571 end of the second format. The custom formats are also honored by export
2572 commands, if custom time display is turned on at the time of export."
2577 "Get the right format for a time string."
2582 f)))
2585 "The format string used when creating CLOCKSUM lines.
2586 This is also used when org-mode generates a time duration."
2592 org-mode generates a time duration."
2597 "The format string used when creating CLOCKSUM lines, or when
2598 org-mode generates a time duration."
2603 "No. of days before expiration during which a deadline becomes active.
2604 This variable governs the display in sparse trees and in the agenda.
2605 When 0 or negative, it means use this number (the absolute value of it)
2606 even if a deadline has a different individual lead time specified.
2608 Custom commands can set this variable in the options section."
2614 "Non-nil means assume future for incomplete date input from user.
2615 This affects the following situations:
2616 1. The user gives a month but not a year.
2619 2. The user gives a day, but no month.
2622 it will be considered as *this* month.
2624 If you set this variable to the symbol `time', then also the following
2625 will work:
2627 3. If the user gives a time, but no day. If the time is before now,
2628 to will be interpreted as tomorrow.
2630 Currently none of this works for ISO week specifications.
2632 When this option is nil, the current day, month and year will always be
2633 used as defaults.
2635 See also `org-agenda-jump-prefer-future'."
2643 "Should the agenda jump command prefer the future for incomplete dates?
2644 The default is to do the same as configured in `org-read-date-prefer-future'.
2645 But you can also set a deviating value here.
2646 This may t or nil, or the symbol `org-read-date-prefer-future'."
2651 org-read-date-prefer-future)
2656 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2658 Depending on the system Emacs is running on, certain dates cannot
2659 be represented with the type used internally to represent time.
2660 Dates between 1970-1-1 and 2038-1-1 can always be represented
2661 correctly. Some systems allow for earlier dates, some for later,
2662 some for both. One way to find out it to insert any date into an
2663 Org buffer, putting the cursor on the year and hitting S-up and
2664 S-down to test the range.
2666 When this variable is set to t, the date/time prompt will not let
2667 you specify dates outside the 1970-2037 range, so it is certain that
2668 these dates will work in whatever version of Emacs you are
2669 running, and also that you can move a file from one Emacs implementation
2670 to another. WHenever Org is forcing the year for you, it will display
2671 a message and beep.
2673 When this variable is nil, Org will check if the date is
2674 representable in the specific Emacs implementation you are using.
2675 If not, it will force a year, usually the current year, and beep
2676 to remind you. Currently this setting is not recommended because
2677 the likelihood that you will open your Org files in an Emacs that
2678 has limited date range is not negligible.
2680 A workaround for this problem is to use diary sexp dates for time
2681 stamps outside of this range."
2686 "Non-nil means display current interpretation of date prompt live.
2687 This display will be in an overlay, in the minibuffer."
2692 "Non-nil means pop up a calendar when prompting for a date.
2693 In the calendar, the date can be selected with mouse-1. However, the
2694 minibuffer will also be active, and you can simply enter the date as well.
2695 When nil, only the minibuffer will be available."
2703 "Hook to be used to set up keys for the date/time interface.
2704 Add key definitions to `minibuffer-local-map', which will be a temporary
2705 copy."
2710 "The hour when your day really ends. Must be an integer.
2711 This has influence for the following applications:
2713 the time given here, the day recognized as TODAY is actually yesterday.
2714 - When a date is read from the user and it is still before the time given
2715 here, the current date and time will be assumed to be yesterday, 23:59.
2716 Also, timestamps inserted in remember templates follow this rule.
2718 IMPORTANT: This is a feature whose implementation is and likely will
2719 remain incomplete. Really, it is only here because past midnight seems to
2720 be the favorite working time of John Wiegley :-)"
2725 "Non-nil means S-down will increase the time in a time stamp.
2726 When nil, S-up will increase."
2731 "Non-nil means make the calendar window follow timestamp changes.
2732 When a timestamp is modified and the calendar window is visible, it will be
2733 moved to the new date."
2738 "Options concerning tags in Org-mode."
2743 "List of tags allowed in Org-mode files.
2744 When this list is nil, Org-mode will base TAG input on what is already in the
2745 buffer.
2746 The value of this variable is an alist, the car of each entry must be a
2747 keyword as a string, the cdr may be a character that is used to select
2748 that tag through the fast-tag-selection interface.
2749 See the manual for details."
2764 "List of tags that will always appear in all Org-mode files.
2765 This is in addition to any in buffer settings or customizations
2766 of `org-tag-alist'.
2767 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2768 The value of this variable is an alist, the car of each entry must be a
2769 keyword as a string, the cdr may be a character that is used to select
2770 that tag through the fast-tag-selection interface.
2771 See the manual for details.
2772 To disable these tags on a per-file basis, insert anywhere in the file:
2773 #+STARTUP: noptag"
2784 "If non-nil, always offer completion for all tags of all agenda files.
2785 Instead of customizing this variable directly, you might want to
2786 set it locally for capture buffers, because there no list of
2787 tags in that file can be created dynamically (there are none).
2789 (add-hook 'org-capture-mode-hook
2790 (lambda ()
2791 (set (make-local-variable
2792 'org-complete-tags-always-offer-all-agenda-tags)
2793 t)))"
2798 "List of tags that can be inherited by all entries in the file.
2799 The tags will be inherited if the variable `org-use-tag-inheritance'
2800 says they should be.
2804 "Non-nil means use fast tag selection scheme.
2805 This is a special interface to select and deselect tags with single keys.
2806 When nil, fast selection is never used.
2807 When the symbol `auto', fast selection is used if and only if selection
2808 characters for tags have been configured, either through the variable
2809 `org-tag-alist' or through a #+TAGS line in the buffer.
2810 When t, fast selection is always used and selection keys are assigned
2811 automatically if necessary."
2819 "Non-nil means fast tag selection exits after first change.
2820 When nil, you have to press RET to exit it.
2821 During fast tag selection, you can toggle this flag with `C-c'.
2822 This variable can also have the value `expert'. In this case, the window
2823 displaying the tags menu is not even shown, until you press C-c again."
2831 "Non-nil means fast tags selection interface will also offer TODO states.
2835 "The column to which tags should be indented in a headline.
2836 If this number is positive, it specifies the column. If it is negative,
2837 it means that the tags should be flushright to that column. For example,
2838 -80 works well for a normal 80 character screen."
2843 "Non-nil means realign tags after pro/demotion of TODO state change.
2844 These operations change the length of a headline and therefore shift
2845 the tags around. With this options turned on, after each such operation
2846 the tags are again aligned to `org-tags-column'."
2851 "Non-nil means tags in levels apply also for sublevels.
2852 When nil, only the tags directly given in a specific line apply there.
2853 This may also be a list of tags that should be inherited, or a regexp that
2854 matches tags that should be inherited. Additional control is possible
2855 with the variable `org-tags-exclude-from-inheritance' which gives an
2856 explicit list of tags to be excluded from inheritance., even if the value of
2857 `org-use-tag-inheritance' would select it for inheritance.
2859 If this option is t, a match early-on in a tree can lead to a large
2860 number of matches in the subtree when constructing the agenda or creating
2861 a sparse tree. If you only want to see the first match in a tree during
2862 a search, check out the variable `org-tags-match-list-sublevels'."
2871 "List of tags that should never be inherited.
2872 This is a way to exclude a few tags from inheritance. For way to do
2873 the opposite, to actively allow inheritance for selected tags,
2874 see the variable `org-use-tag-inheritance'."
2879 "Check if TAG is one that should be inherited."
2891 "Non-nil means list also sublevels of headlines matching a search.
2892 This variable applies to tags/property searches, and also to stuck
2893 projects because this search is based on a tags match as well.
2895 When set to the symbol `indented', sublevels are indented with
2896 leading dots.
2898 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2899 the sublevels of a headline matching a tag search often also match
2900 the same search. Listing all of them can create very long lists.
2901 Setting this variable to nil causes subtrees of a match to be skipped.
2903 This variable is semi-obsolete and probably should always be true. It
2904 is better to limit inheritance to certain tags using the variables
2905 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2913 "When set, tags are sorted using this function as a comparator."
2929 "Options concerning properties in Org-mode."
2934 "How property key/value pairs should be formatted by `indent-line'.
2935 When `indent-line' hits a property definition, it will format the line
2936 according to this format, mainly to make sure that the values are
2937 lined-up with respect to each other."
2942 "Non-nil means properties apply also for sublevels.
2944 This setting is chiefly used during property searches. Turning it on can
2945 cause significant overhead when doing a search, which is why it is not
2946 on by default.
2948 When nil, only the properties directly given in the current entry count.
2949 When t, every property is inherited. The value may also be a list of
2950 properties that should have inheritance, or a regular expression matching
2951 properties that should be inherited.
2953 However, note that some special properties use inheritance under special
2954 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2956 for valid values of a property.
2958 Note for programmers:
2959 When querying an entry with `org-entry-get', you can control if inheritance
2960 should be used. By default, `org-entry-get' looks only at the local
2961 properties. You can request inheritance by setting the inherit argument
2962 to t (to force inheritance) or to `selective' (to respect the setting
2963 in this variable)."
2972 "Check if PROPERTY is one that should be inherited."
2983 "The default column format, if no other format has been defined.
2984 This variable can be set on the per-file basis by inserting a line
2986 #+COLUMNS: %25ITEM ....."
2991 "The ellipses to be used when a field in column view is truncated.
2992 When this is the empty string, as many characters as possible are shown,
2993 but then there will be no visual indication that the field has been truncated.
2994 When this is a string of length N, the last N characters of a truncated
2995 field are replaced by this string. If the column is narrower than the
2996 ellipses string, only part of the ellipses string will be shown."
3001 "Function that modifies values for display in column view.
3002 For example, it can be used to cut out a certain part from a time stamp.
3003 The function must take 2 arguments:
3005 column-title The title of the column (*not* the property name)
3006 value The value that should be modified.
3008 The function should return the value that should be displayed,
3009 or nil if the normal value should be used."
3014 "The property that is being used to keep track of effort estimates.
3015 Effort estimates given in this property need to have the format H:MM."
3023 "List of property/value pairs that can be inherited by any entry.
3025 These are fixed values, for the preset properties. The user variable
3026 that can be used to add to this list is `org-global-properties'.
3028 The entries in this list are cons cells where the car is a property
3029 name and cdr is a string with the value. If the value represents
3034 "List of property/value pairs that can be inherited by any entry.
3036 This list will be combined with the constant `org-global-properties-fixed'.
3038 The entries in this list are cons cells where the car is a property
3039 name and cdr is a string with the value.
3041 You can set buffer-local values for the same purpose in the variable
3042 `org-file-properties' this by adding lines like
3044 #+PROPERTY: NAME VALUE"
3051 "List of property/value pairs that can be inherited by any entry.
3052 Valid for the current buffer.
3057 "Options concerning agenda views in Org-mode."
3062 "Variable used by org files to set a category for agenda display.
3063 Such files should use a file variable to set it, for example
3067 or contain a special line
3069 #+CATEGORY: ELisp
3071 If the file does not specify a category, then file's base name
3077 "The files to be used for agenda display.
3081 If an entry is a directory, all files in that directory that are matched by
3082 `org-agenda-file-regexp' will be part of the file list.
3084 If the value of the variable is not a list but a single file name, then
3085 the list of agenda files is actually stored and maintained in that file, one
3086 agenda file per line. In this file paths can be given relative to
3087 `org-directory'. Tilde expansion and environment variable substitution
3088 are also made."
3095 "Regular expression to match files for `org-agenda-files'.
3096 If any element in the list in that variable contains a directory instead
3097 of a normal file, all files in that directory that are matched by this
3098 regular expression will be included."
3103 "List of extra files to be searched by text search commands.
3104 These files will be search in addition to the agenda files by the
3105 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3106 Note that these files will only be searched for text search commands,
3107 not for the other agenda views like todo lists, tag searches or the weekly
3108 agenda. This variable is intended to list notes and possibly archive files
3109 that should also be searched by these two commands.
3110 In fact, if the first element in the list is the symbol `agenda-archives',
3111 than all archive files of all agenda files will be added to the search
3112 scope."
3123 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3124 A nil value means to remove them, after a query, from the list."
3129 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3130 The command `org-calendar-goto-agenda' will be bound to this key. The
3131 default is the character `c' because then `c' can be used to switch back and
3132 forth between agenda and calendar."
3137 "The key to be installed in `calendar-mode-map' for agenda-action.
3138 The command `org-agenda-action' will be bound to this key. The
3139 default is the character `k' because we use the same key in the agenda."
3144 "The key to be installed in `calendar-mode-map' for adding diary entries.
3145 This option is irrelevant until `org-agenda-diary-file' has been configured
3146 to point to an Org-mode file. When that is the case, the command
3147 `org-agenda-diary-entry' will be bound to the key given here, by default
3148 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3149 if you want to continue doing this, you need to change this to a different
3150 key."
3155 "File to which to add new entries with the `i' key in agenda and calendar.
3156 When this is the symbol `diary-file', the functionality in the Emacs
3157 calendar will be used to add entries to the `diary-file'. But when this
3158 points to a file, `org-agenda-diary-entry' will be used instead."
3174 org-calendar-insert-diary-entry-key
3178 "Options for embedding LaTeX code into Org-mode."
3186 "Options for creating images from LaTeX fragments.
3187 This is a property list with the following properties:
3189 `default' means use the foreground of the default face.
3191 `default' means use the background of the default face.
3192 :scale a scaling factor for the size of the images, to get more pixels
3193 :html-foreground, :html-background, :html-scale
3194 the same numbers for HTML export.
3195 :matchers a list indicating which matchers should be used to
3196 find LaTeX fragments. Valid members of this list are:
3207 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3208 When nil, just push out a message."
3217 \[PACKAGES]
3218 \[DEFAULT-PACKAGES]
3219 % The settings below are copied from fullpage.sty
3232 "The document header used for processing LaTeX fragments.
3233 It is imperative that this header make sure that no page number
3234 appears on the page. The package defined in the variables
3235 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3237 will be appended."
3244 "Set the packages alist and make sure it has 3 elements per entry."
3248 x))
3249 val)))
3253 "Get the packages alist and make sure it has 3 elements per entry."
3257 x))
3260 ;; The following variables are defined here because is it also used
3261 ;; when formatting latex fragments. Originally it was part of the
3262 ;; LaTeX exporter, which is why the name includes "export".
3279 )
3280 "Alist of default packages to be inserted in the header.
3281 Change this only if one of the packages here causes an incompatibility
3282 with another package you are using.
3283 The packages in this list are needed by one part or another of Org-mode
3284 to function properly.
3286 - inputenc, fontenc: for basic font and character selection
3287 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3288 for interpreting the entities in `org-entities'. You can skip some of these
3289 packages if you don't use any of the symbols in it.
3290 - graphicx: for including images
3291 - float, wrapfig: for figure placement
3292 - longtable: for long tables
3293 - hyperref: for cross references
3295 Therefore you should not modify this variable unless you know what you
3296 are doing. The one reason to change it anyway is that you might be loading
3297 some other package that conflicts with one of the default packages.
3299 If SNIPPET-FLAG is t, the package also needs to be included when
3300 compiling LaTeX snippets into images for inclusion into HTML."
3313 "Alist of packages to be inserted in every LaTeX header.
3314 These will be inserted after `org-export-latex-default-packages-alist'.
3316 SNIPPET-FLAG, when t, indicates that this package is also needed when
3317 turning LaTeX snippets into images for inclusion into HTML.
3318 Make sure that you only list packages here which:
3319 - you want in every file
3320 - do not conflict with the default packages in
3321 `org-export-latex-default-packages-alist'
3322 - do not conflict with the setup in `org-format-latex-header'."
3336 "Settings for Org-mode appearance."
3341 "Non-nil means fontify only the stars in each headline.
3342 When nil, the entire headline is fontified.
3343 Changing it requires restart of `font-lock-mode' to become effective
3344 also in regions already fontified."
3349 "Non-nil means hide the first N-1 stars in a headline.
3350 This works by using the face `org-hide' for these stars. This
3351 face is white for a light background, and black for a dark
3352 background. You may have to customize the face `org-hide' to
3353 make this work.
3354 Changing it requires restart of `font-lock-mode' to become effective
3355 also in regions already fontified.
3356 You may also set this on a per-file basis by adding one of the following
3357 lines to the buffer:
3359 #+STARTUP: hidestars
3360 #+STARTUP: showstars"
3365 "List of symbols corresponding to keywords to be hidden the org buffer.
3366 For example, a value '(title) for this list will make the document's title
3367 appear in the buffer without the initial #+TITLE: keyword."
3375 "Non-nil means change the face of a headline if it is marked DONE.
3376 Normally, only the TODO/DONE keyword indicates the state of a headline.
3377 When this is non-nil, the headline after the keyword is set to the
3378 `org-headline-done' as an additional indication."
3383 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3384 Changing this variable requires a restart of Emacs to take effect."
3389 "Non-nil means fontify the whole line for headings.
3390 This is useful when setting a background color for the
3391 org-level-* faces."
3396 "Non-nil means fontify what is treated specially by the exporters."
3401 "Non-nil mean font-lock should hide the emphasis marker characters."
3406 "Non-nil means show entities as UTF8 characters.
3412 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3417 "Regular expression for matching emphasis.
3418 After a match, the match groups contain these elements:
3419 0 The match of the full regular expression, including the characters
3420 before and after the proper match
3421 1 The character before the proper match, or empty at beginning of line
3422 2 The proper match, including the leading and trailing markers
3423 3 The leading marker like * or /, indicating the type of highlighting
3424 4 The text between the emphasis markers, not including the markers
3431 "Set variable and compute the emphasis regular expression."
3435 org-emphasis-alist org-emphasis-regexp-components)
3447 ;; make sure special characters appear at the right position in the class
3459 ;; Make the regexp
3467 body1
3479 body1
3487 "Components used to build the regular expression for emphasis.
3488 This is a list with five entries. Terminology: In an emphasis string
3492 specify what is allowed/forbidden in each part:
3494 pre Chars allowed as prematch. Beginning of line will be allowed too.
3495 post Chars allowed as postmatch. End of line will be allowed too.
3496 border The chars *forbidden* as border characters.
3498 non-shy groups here, and don't allow newline here.
3499 newline The maximum number of newlines allowed in an emphasis exp.
3501 Use customize to modify this, or restart Emacs after changing it."
3520 )
3521 "Special syntax for emphasized text.
3522 Text starting and ending with a special character will be emphasized, for
3523 example *bold*, _underlined_ and /italic/. This variable sets the marker
3524 characters, the face to be used by font-lock for highlighting in Org-mode
3525 Emacs buffers, and the HTML tags to be used for this.
3526 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3527 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3528 Use customize to modify this, or restart Emacs after changing it."
3543 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3546 ;;; Miscellaneous options
3549 "Completion in Org-mode."
3554 "Non-nil means use ido completion wherever possible.
3555 Note that `ido-mode' must be active for this variable to be relevant.
3556 If you decide to turn this variable on, you might well want to turn off
3557 `org-outline-path-complete-in-steps'.
3558 See also `org-completion-use-iswitchb'."
3563 "Non-nil means use iswitchb completion wherever possible.
3564 Note that `iswitchb-mode' must be active for this variable to be relevant.
3565 If you decide to turn this variable on, you might well want to turn off
3566 `org-outline-path-complete-in-steps'.
3567 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3573 Normal means, no org-mode-specific context."
3577 ;;; Functions and variables from their packages
3578 ;; Declared here to avoid compiler warnings
3580 ;; XEmacs only
3586 ;; Emacs only
3589 ;; Various packages
3607 org-format-agenda-item "org-agenda"
3638 ;;; Autoload and prepare some org modules
3640 ;; Some table stuff that needs to be defined here, because it is used
3641 ;; by the functions setting up org-mode or checking for table context.
3654 "Detect the first line outside a table when searching from within it.
3657 ;; Autoload the functions in org-table.el that are needed by functions here.
3662 org-table-convert org-table-convert-region org-table-copy-down
3663 org-table-copy-region org-table-create
3664 org-table-create-or-convert-from-region
3665 org-table-create-with-table.el org-table-current-dline
3666 org-table-cut-region org-table-delete-column org-table-edit-field
3667 org-table-edit-formulas org-table-end org-table-eval-formula
3668 org-table-export org-table-field-info
3669 org-table-get-stored-formulas org-table-goto-column
3670 org-table-hline-and-move org-table-import org-table-insert-column
3671 org-table-insert-hline org-table-insert-row org-table-iterate
3672 org-table-justify-field-maybe org-table-kill-row
3673 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3674 org-table-move-column org-table-move-column-left
3675 org-table-move-column-right org-table-move-row
3676 org-table-move-row-down org-table-move-row-up
3677 org-table-next-field org-table-next-row org-table-paste-rectangle
3678 org-table-previous-field org-table-recalculate
3679 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3680 org-table-toggle-coordinate-overlays
3681 org-table-toggle-formula-debugger org-table-wrap-region
3682 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3683 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3684 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3687 "Return t if the cursor is inside an org-type table.
3688 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3693 org-table-line-regexp)))
3694 nil))
3698 "Return t if and only if we are at a table.el table."
3704 "If there is a table.el table nearby, recognize it and move into it."
3710 nil
3720 t
3725 t)
3726 nil)
3727 nil))
3730 "Return t if the cursor is inside a hline in a table."
3735 nil))
3740 "Apply FUNCTION to the start of all tables in the buffer."
3756 ;; Declare and autoload functions from org-exp.el & Co
3764 org-insert-export-options-template
3765 org-table-clean-before-export))
3768 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3769 org-export-region-as-ascii))
3772 org-replace-region-by-latex org-export-region-as-latex
3773 org-export-as-latex org-export-as-pdf
3774 org-export-as-pdf-and-open))
3777 org-export-as-html-batch org-export-as-html-to-buffer
3778 org-replace-region-by-html org-export-region-as-html
3779 org-export-as-html))
3782 org-replace-region-by-docbook org-export-region-as-docbook
3783 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3784 org-export-as-docbook))
3787 org-export-icalendar-all-agenda-files
3788 org-export-icalendar-combine-agenda-files))
3792 ;; Declare and autoload functions from org-agenda.el
3797 org-todo-list org-tags-view org-agenda-list-stuck-projects
3798 org-diary org-agenda-to-appt
3799 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3801 ;; Autoload org-remember
3806 org-remember-apply-template org-remember org-remember-handler)))
3811 org-capture-import-remember-templates)))
3813 ;; Autoload org-clock.el
3828 "Return non-nil if clock is currently running.
3829 The return value is actually the clock marker."
3834 "org-clock"
3836 org-clock-goto org-clock-sum org-clock-display
3837 org-clock-remove-overlays org-clock-report
3838 org-clocktable-shift org-dblock-write:clocktable
3839 org-get-clocktable org-resolve-clocks)))
3842 "If this is a CLOCK line, update it and return t.
3843 Otherwise, return nil."
3852 ts te h m s neg)
3855 nil)
3860 ;; The clock is running here
3881 t))))))
3884 "Check if the current buffer contains the running clock.
3885 If yes, offer to stop it and to save the buffer with the changes."
3894 "Check if this line starts a clock table, if yes, shift the time block."
3898 ;; Autoload org-timer.el
3902 "org-timer"
3904 org-timer-change-times-in-region
3905 org-timer-set-timer
3906 org-timer-reset-timers
3907 org-timer-show-remaining-time)))
3909 ;; Autoload org-feed.el
3913 "org-feed"
3917 ;; Autoload org-indent.el
3919 ;; Define the variable already here, to make sure we have it.
3921 "Non-nil if Org-Indent mode is enabled.
3926 "org-indent"
3929 ;; Autoload org-mobile.el
3933 "org-mobile"
3936 ;; Autoload archiving code
3937 ;; The stuff that is needed for cycling and tags has to be defined here.
3940 "Options concerning archiving in Org-mode."
3945 "The location where subtrees should be archived.
3947 The value of this variable is a string, consisting of two parts,
3948 separated by a double-colon. The first part is a filename and
3949 the second part is a headline.
3951 When the filename is omitted, archiving happens in the same file.
3952 %s in the filename will be replaced by the current file
3953 name (without the directory part). Archiving to a different file
3954 is useful to keep archived entries from contributing to the
3955 Org-mode Agenda.
3957 The archived entries will be filed as subtrees of the specified
3958 headline. When the headline is omitted, the subtrees are simply
3959 filed away at the end of the file, as top-level entries. Also in
3960 the heading you can use %s to represent the file name, this can be
3961 useful when using the same archive for a number of different files.
3963 Here are a few examples:
3965 If the current file is Projects.org, archive in file
3966 Projects.org_archive, as top-level trees. This is the default.
3969 Archive in the current file, under the top-level headline
3973 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3976 Archive in file ~/org/archive.org (absolute path), under headlines
3980 Archive in file ./basement (relative path), as level 3 trees
3983 You may set this option on a per-file basis by adding to the buffer a
3984 line like
3986 #+ARCHIVE: basement::** Finished Tasks
3988 You may also define it locally for a subtree by setting an ARCHIVE property
3989 in the entry. If such a property is found in an entry, or anywhere up
3990 the hierarchy, it will be used."
3995 "The tag that marks a subtree as archived.
3996 An archived subtree does not open during visibility cycling, and does
3997 not contribute to the agenda listings.
3998 After changing this, font-lock must be restarted in the relevant buffers to
3999 get the proper fontification."
4005 "Non-nil means the agenda will skip any items located in archived trees.
4006 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4007 variable is no longer recommended, you should leave it at the value t.
4008 Instead, use the key `v' to cycle the archives-mode in the agenda."
4014 "Non-nil means ignore archived trees when creating column view."
4020 "Non-nil means `org-cycle' will open archived trees.
4021 An archived tree is a tree marked with the tag ARCHIVE.
4022 When nil, archived trees will stay folded. You can still open them with
4023 normal outline commands like `show-all', but not with the cycling commands."
4029 "Non-nil means sparse tree construction shows matches in archived trees.
4030 When nil, matches in these trees are highlighted, but the trees are kept in
4031 collapsed state."
4037 "Re-hide all archived subtrees after a visibility state change."
4048 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4051 "Cycle subtree even if it is archived."
4058 "Re-hide all archived subtrees after a visibility state change."
4073 flag)))
4080 org-archive-to-archive-sibling org-toggle-archive-tag
4081 org-archive-subtree-default
4082 org-archive-subtree-default-with-confirmation)))
4084 ;; Autoload Column View Code
4092 org-columns-compute org-agenda-columns org-columns-remove-overlays
4095 ;; Autoload ID code
4103 org-id-get-with-outline-path-completion
4104 org-id-get-with-outline-drilling org-id-store-link
4105 org-id-goto org-id-find org-id-store-link))
4107 ;; Autoload Plotting Code
4112 ;;; Variables for pre-computed regular expressions, all buffer local
4130 "Matches a headline and puts everything into groups:
4131 group 1: the stars
4132 group 2: The todo keyword, maybe
4133 group 3: Priority cookie
4134 group 4: True headline
4138 "Printf format to make regexp to match an exact headline.
4139 This regexp will match the headline of any node which hase the exact
4140 headline text that is put into the format, but may have any TODO state,
4144 "Matches a headline and puts TODO state into group 2 if present.
4199 "Regular expression to match a plain time or time range.
4200 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4201 groups carry important information:
4202 0 the full match
4203 1 the first time, range or not
4211 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4212 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4213 groups carry important information:
4214 0 the full match
4215 7 hours of duration
4224 "Regular expression to match a timestamp time or time range.
4225 After a match, the following groups carry important information:
4226 0 the full match
4227 1 date plus weekday, for back referencing to make sure both times are on the same day
4228 2 the first time, range or not
4283 "Variable associated with STARTUP options for org-mode.
4284 Each element is a list of three items: The startup options as written
4285 in the #+STARTUP line, the corresponding variable, and the value to
4286 set this variable to if the option is found. An optional forth element PUSH
4290 "Precompute regular expressions for current buffer."
4310 kwds kws0 kwsa key log value cat arch tags const links hw dws
4311 tail sep kws1 prio props ftags drawers beamer-p
4333 ;; general TODO-like setup
4345 links)))
4351 props)))
4356 ftags
4366 l var val)
4396 ))))
4413 ;; Process the TODO keywords
4415 ;; Use the global values as if they had been given locally.
4427 kws)))
4430 kwsa nil
4433 ;; 1 2
4441 kw)
4443 kws0)
4460 ;; Process the constants
4468 ;; Process the tags.
4479 tgs))
4487 ;; Compute the regular expressions and other local variables
4495 org-drawer-regexp
4499 org-not-done-keywords
4501 org-todo-regexp
4504 org-not-done-regexp
4508 org-not-done-heading-regexp
4512 org-todo-line-regexp
4516 org-complex-heading-regexp
4521 org-complex-heading-regexp-format
4530 org-nl-done-regexp
4534 org-todo-line-tags-regexp
4539 org-looking-at-done-regexp
4544 org-deadline-time-regexp
4546 org-deadline-line-regexp
4548 org-scheduled-regexp
4550 org-scheduled-time-regexp
4552 org-closed-time-regexp
4554 org-keyword-time-regexp
4560 org-keyword-time-not-clock-regexp
4566 org-maybe-keyword-time-regexp
4572 org-planning-or-clock-line-re
4577 org-all-time-keywords
4580 org-clock-string org-closed-string))
4581 )
4586 "Return the contents of FILE, as a string."
4600 "Extract the log state setting from a TODO keyword string.
4614 "Remove a pair of parenthesis at the end of each string in LIST."
4618 x))
4619 list))
4622 "Assign fast keys to a keyword-key alist.
4623 Respect keys that are already there."
4641 ;;; Some variables used in various places
4648 "Function to be called when `C-c C-c' is used.
4652 ;; FIXME: Occasionally check by commenting these, to make sure
4653 ;; no other functions uses these, forgetting to let-bind them.
4658 ;; Defined somewhere in this file, but used before definition.
4664 ;;;; Define the Org-mode
4667 (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"))
4670 ;; We use a before-change function to check if a table might need
4671 ;; an update.
4673 "Indicates that a table might need an update.
4674 This variable is set by `org-before-change-function'.
4677 "Every change indicates that a table might need an update."
4688 ;;;###autoload
4690 "Outline-based notes management and organizer, alias
4693 Org-mode develops organizational tasks around a NOTES file which
4694 contains information about projects as plain text. Org-mode is
4695 implemented on top of outline-mode, which is ideal to keep the content
4696 of large files well structured. It supports ToDo items, deadlines and
4697 time stamps, which magically appear in the diary listing of the Emacs
4698 calendar. Tables are easily created with a built-in table editor.
4699 Plain text URL-like links connect to websites, emails (VM), Usenet
4700 messages (Gnus), BBDB entries, and any files related to the project.
4701 For printing and sharing of notes, an Org-mode file (or a part of it)
4702 can be exported as a structured ASCII or HTML file.
4704 The following commands are available:
4708 ;; Get rid of Outline menus, they are not needed
4709 ;; Need to do this here because define-derived-mode sets up
4710 ;; the keymap so late. Still, it is a waste to call this each time
4711 ;; we switch another buffer into org-mode.
4714 ;; Assume this is Greg's port, it uses easymenu
4739 org-display-table 4
4742 org-ellipsis)))
4747 ;; tag faces set outside customize.... force initialization.
4749 ;; Calc embedded
4755 ;; Activate before-change-function
4759 ;; Check for running clock before killing a buffer
4761 ;; Paragraphs and auto-filling
4765 ;; Beginning/end of defun
4768 ;; Next error for sparse trees
4770 ;; Make sure dependence stuff works reliably, even for users who set it
4771 ;; too late :-(
4783 ;; Comment characters
4787 ;; Align options lines
4789 'align-mode-rules-list
4794 ;; Imenu
4798 ;; Make isearch reveal context
4801 ;; Emacs 21 and XEmacs make use of the hook
4803 ;; Emacs 22 deals with this through a special variable
4807 ;; Turn on org-beamer-mode?
4810 ;; Setup the pcomplete hooks
4821 ;; If empty file that did not turn on org-mode automatically, make it to.
4846 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4856 "Return today date, considering `org-extend-today-until'."
4861 ;;;; Font-Lock stuff, including the activators
4892 "Regular expression used to analyze links.
4893 Here is what the match groups contain after a match:
4894 1: http:
4895 2: http
4896 3: path
4897 4: [desc]
4905 "Number of stacked braces for sub/superscript matching.
4906 This has to be set before loading org.el to be effective."
4911 "Create a regular expression which will match a balanced sexp.
4912 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4913 as single character strings.
4914 The regexp returned will match the entire expression including the
4915 delimiters. It will also define a single group which contains the
4916 match except for the outermost delimiters. The maximum depth of
4917 stacked delimiters is N. Escaping delimiters is not possible."
4946 "Update the link regular expressions.
4947 This should be called after the variable `org-link-types' has changed."
4951 org-link-re-with-space
4957 org-link-re-with-space2
4963 org-link-re-with-space3
4968 org-angle-link-re
4974 org-plain-link-re
4978 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4979 org-bracket-link-regexp
4981 org-bracket-link-analytic-regexp
4989 org-bracket-link-analytic-regexp++
4997 org-any-link-re
5006 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5008 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5009 "Regular expression matching time strings for analysis.
5010 This one does not require the space after the date, so it can be used
5012 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5028 "Regular expression matching a time stamp or time stamp range.
5034 "Run through the buffer and add overlays to links."
5043 'face
5056 rtn))
5059 "Insert or change an emphasis, i.e. a font like bold or italic.
5060 If there is an active region, change that region to a new emphasis.
5061 If there is no region, just insert the marker characters and position
5062 the cursor between them.
5063 CHAR should be either the marker character, or the first character of the
5064 HTML tag associated with that emphasis. If CHAR is a space, the means
5065 to remove the emphasis of the selected region.
5066 If char is not given (for example in an interactive call) it
5067 will be prompted for."
5118 "Run through the buffer and add overlays to links."
5127 nil
5133 t)))))
5141 t)))
5144 "When non-nil, fontify code in code blocks."
5150 "Fontify #+ lines and blocks, in the correct ways."
5153 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5154 limit t)
5162 end end1 quoting block-type ovl)
5165 ;; a single line of backend-specific content
5173 ; for backend-specific code
5174 t)
5176 ;; Truly a block
5188 beg end
5192 ; for end_src
5196 ;; remove old background overlays
5201 ;; add a background overlay
5207 ; end of source block
5215 t))
5228 ;; just any other in-buffer setting, but not indented
5232 t)
5240 t)
5248 "Run through the buffer and add overlays to links."
5256 t)))
5259 "Run through the buffer and add overlays to links."
5261 limit t)
5266 'keymap org-mouse-map
5267 'help-echo
5269 "Footnote definition"
5271 ))
5273 t)))
5276 "Run through the buffer and add overlays to bracketed links."
5280 ;; FIXME: above we should remove the escapes.
5281 ;; but that requires another match, protecting match data,
5282 ;; a lot of overhead for font-lock.
5289 ;; We need to remove the invisible property here. Table narrowing
5290 ;; may have made some of this invisible.
5308 t)))
5311 "Run through the buffer and add overlays to dates."
5323 t)))
5332 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5336 "Run through the buffer and add overlays to target matches."
5344 'keymap org-mouse-map
5348 t)))))
5351 "Find all radio targets in this file and update the regular expression."
5366 t)))
5373 ;; This should be with the exporter code, but we also use if for font-locking
5383 "Compute regular expression for stuff treated specially by exporters."
5390 org-latex-regexps)))
5418 org-entities)))
5422 org-latex-entities)
5423 nil))
5425 ))
5426 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5429 org-export-html-special-string-regexps)))
5434 ))))
5436 'org-latex-and-specials-regexp
5441 "Run through the buffer and add overlays to links."
5445 limit t))
5459 rtn)))
5462 "Restart `font-lock-mode', to force refontification."
5468 "Return a list of all targets in this file.
5469 With optional argument RADIO, only find radio targets."
5471 rtn)
5476 rtn)))
5479 "Make regular expression matching all strings in TARGETS.
5480 The regular expression finds the targets also if there is a line break
5481 between words."
5490 x)
5491 targets
5503 t)))
5506 "Compute the outline level of the heading at point.
5507 This function assumes that the cursor is at the beginning of a line matched
5508 by `outline-regexp'. Otherwise it returns garbage.
5509 If this is called at a normal headline, the level is the number of stars.
5510 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5517 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5524 "Functions that can manipulate `org-font-lock-extra-keywords'.
5525 This is calles after `org-font-lock-extra-keywords' is defined, but before
5526 it is installed to be used by font lock. This can be useful if something
5537 ;; Call the hook
5539 ;; Headlines
5546 ;; Table lines
5549 ;; Table internals
5554 ;; Drawers
5557 ;; Properties
5561 ;; Links
5572 ;; TODO lines
5575 ;; DONE
5581 nil)
5582 ;; Priorities
5584 ;; Tags
5586 ;; Special keywords
5591 ;; Emphasis
5596 ;; Checkboxes
5597 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5602 ;; Description list items
5605 ;; ARCHIVEd headings
5608 ;; Specials
5612 ;; Code
5614 ;; COMMENT
5619 ;; Blocks and meta lines
5621 )))
5624 ;; Now set the full font-lock-keywords
5631 "Toggle the composition display of entities as UTF8 characters."
5643 "Find an entity to fontify."
5649 limit t)
5661 nil))))
5664 "Fontify string S like in Org-mode."
5676 "Get the right face for match N in font-lock matching of headlines."
5689 "Get the right face for a TODO keyword KWD.
5690 If KWD is a number, get the corresponding match group."
5698 "Create a face list that inherits INHERIT, but sets the foreground color.
5699 When FACE-OR-COLOR is not a string, just return it."
5703 face-or-color)
5704 face-or-color))
5707 "Add the special tag faces."
5716 "Add the special priority faces."
5723 org-priority-faces)))
5728 "Get the right face for a TODO keyword KWD.
5729 If KWD is a number, get the corresponding match group."
5736 "Remove fontification and activation overlays from links."
5741 deactivate-mark buffer-file-name buffer-file-truename)
5744 beg end
5746 ;; also remove line-prefix and wrap-prefix properties
5748 invisible t intangible t
5749 line-prefix t wrap-prefix t
5750 org-no-flyspell t org-emphasis t)
5752 invisible t intangible t
5753 org-no-flyspell t org-emphasis t)))
5763 "Remove specific display properties that have been added by font lock.
5764 The will remove the raise properties that are used to show superscripts
5765 and subscripts."
5775 "Add raise properties to sub/superscripts."
5779 org-match-substring-regexp
5780 org-match-substring-with-braces-regexp)
5781 limit t)
5791 ;; FIXME: Should we go back one character here, for a_b^c
5792 ;; (goto-char (1- pos)) ;????????????????????
5794 t
5796 'display
5812 t)))))
5814 ;;;; Visibility cycling, including org-goto and indirect buffer
5816 ;;; Cycling
5823 ;;;###autoload
5828 "TAB-action and visibility cycling for Org-mode.
5830 This is the command invoked in Org-mode by the TAB key. Its main purpose
5831 is outline visibility cycling, but it also invokes other actions
5832 in special contexts.
5834 - When this function is called with a prefix argument, rotate the entire
5835 buffer through 3 states (global cycling)
5836 1. OVERVIEW: Show only top-level headlines.
5837 2. CONTENTS: Show all headlines of all levels, but no body text.
5838 3. SHOW ALL: Show everything.
5839 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5840 determined by the variable `org-startup-folded', and by any VISIBILITY
5841 properties in the buffer.
5842 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5843 including any drawers.
5845 - When inside a table, re-align the table and move to the next field.
5847 - When point is at the beginning of a headline, rotate the subtree started
5848 by this line through 3 different states (local cycling)
5849 1. FOLDED: Only the main headline is shown.
5850 2. CHILDREN: The main headline and the direct children are shown.
5851 From this state, you can move to one of the children
5852 and zoom in further.
5853 3. SUBTREE: Show the entire subtree, including body text.
5854 If there is no subtree, switch directly from CHILDREN to FOLDED.
5856 - When point is at the beginning of an empty headline and the variable
5857 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5858 of the headline by demoting and promoting it to likely levels. This
5859 speeds up creation document structure by pressing TAB once or several
5860 times right after creating a new headline.
5862 - When there is a numeric prefix, go up to a heading with level ARG, do
5863 a `show-subtree' and return to the previous cursor position. If ARG
5864 is negative, go up that many levels.
5866 - When point is not at the beginning of a headline, execute the global
5867 binding for TAB, which is re-indenting the line. See the option
5868 `org-cycle-emulate-tab' for details.
5870 - Special case: if point is at the beginning of the buffer and there is
5871 no headline in line 1, this function will act as if called with prefix arg
5872 (C-u TAB, same as S-TAB) also when called without prefix arg.
5873 But only if also the variable `org-cycle-global-at-bob' is t."
5883 org-inlinetask-min-level
5888 limit-level)))
5891 outline-regexp
5899 org-cycle-hook))
5903 ;; special case: use global cycling
5917 ;; Table: enter it or move to the next field.
5928 ;; Global cycling: delegate to `org-cycle-internal-global'.
5931 ;; Drawers: delegate to `org-flag-drawer'.
5939 ;; Show-subtree, ARG levels up from here.
5947 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5953 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5960 ;; From there: TAB emulation and template completion.
5984 t
5993 "Do the global cycling action."
5997 ;; We just created the overview - now do table of contents
5998 ;; This can be slow in very large buffers, so indicate action
6008 ;; We just showed the table of contents - now show everything
6016 ;; Default action: go to overview
6024 "Do the local cycling action."
6026 ;; First, determine end of headline (EOH), end of subtree or item
6027 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6051 ;; Determine end invisible part of buffer (EOL)
6053 ;; XEmacs doesn't have `next-single-char-property-change'
6063 ;; Find out what to do next and set `this-command'
6066 ;; Nothing is hidden behind this heading
6078 org-cycle-skip-children-state-if-no-children))))
6079 ;; Entire subtree is hidden in one line: children view
6085 ;; Fold every list in subtree to top-level items.
6107 ;; We just showed the children, or no children are there,
6108 ;; now show everything.
6115 ;; Default action: hide the subtree.
6122 ;;;###autoload
6124 "Cycle the global visibility. For details see `org-cycle'.
6126 With a numeric prefix, show all headlines up to that level."
6142 "Set the visibility required by startup options and properties."
6157 "Switch subtree visibilities according to :VISIBILITY: property."
6164 nil t)
6189 "Switch to overview mode, showing only top-level headlines.
6190 Really, this shows all headlines with level equal or greater than the level
6191 of the first headline in the buffer. This is important, because if the
6192 first headline is not level one, then (hide-sublevels 1) gives confusing
6193 results."
6204 "Show all headlines in the buffer, like a table of contents.
6205 With numerical argument N, show content up to level N."
6208 ;; Visit all headings and show their offspring
6215 t)
6224 "Adjust the window after a change in outline visibility.
6225 This function is the default value of the hook `org-cycle-hook'."
6235 "Remove outline overlays that do not contain non-white stuff."
6245 "Fix visibility issues after moving a subtree."
6246 ;; First, find a reasonable region to look at:
6247 ;; Start two siblings above, end three below
6265 ;; Properly fold already folded siblings
6276 "Show empty lines above all visible headlines.
6277 The region to be covered depends on STATE when called through
6278 `org-cycle-hook'. Lisp program can use t for STATE to get the
6279 entire buffer covered. Note that an empty line is only shown if there
6280 are at least `org-cycle-separator-lines' empty lines before the headline."
6290 beg end b e)
6314 ;; Never hide empty lines at the end of the file.
6324 "Move to the parent and re-show empty lines before visible headlines."
6330 "Return `org-agenda-files' list, plus all open org-mode files.
6331 This is useful for operations that need to scan all of a user's
6332 open and agenda-wise Org files."
6340 files))
6343 "Return the beginning position of the current entry."
6347 "Return the end position of the current entry."
6351 "Re-hide all drawers after a visibility state change."
6378 "Is the end of the current subtree visible?"
6383 "Move cursor to the first headline and recenter the headline.
6384 Optional argument N means put the headline into the Nth line of the window."
6390 ;;; Saving and restoring visibility
6393 "Return a list of the locations of all outline overlays.
6394 These are overlays with the `invisible' property value `outline'.
6395 The return value is a list of cons cells, with start and stop
6396 positions for each overlay.
6397 If USE-MARKERS is set, return the positions as markers."
6415 "Create visibility overlays for all positions in DATA.
6416 DATA should have been made by `org-outline-overlay-data'."
6425 data)))))
6427 ;;; Folding of blocks
6438 "Call FUNCTION at the head of all source blocks in the current buffer.
6439 Optional arguments START and END can be used to limit the range."
6451 "Toggle the visibility of all blocks in the current buffer."
6455 "Fold all blocks in the current buffer."
6461 "Unfold all blocks in the current buffer."
6467 "Toggle visibility of block at point."
6478 "Toggle the visibility of the current block."
6485 ov)
6501 ;; make the block accessible to isearch
6503 ov 'isearch-open-invisible
6514 ;; org-tab-after-check-for-cycling-hook
6516 ;; Remove overlays when changing major mode
6521 ;;; Org-goto
6527 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6543 nil)
6544 (org-defkey map "q" 'org-goto-quit)
6545 (org-defkey map "n" 'outline-next-visible-heading)
6546 (org-defkey map "p" 'outline-previous-visible-heading)
6547 (org-defkey map "f" 'outline-forward-same-level)
6548 (org-defkey map "b" 'outline-backward-same-level)
6549 (org-defkey map "u" 'outline-up-heading))
6550 (org-defkey map "/" 'org-occur)
6551 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6552 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6553 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6554 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6555 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6556 map))
6558 (defconst org-goto-help
6559 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6560 RET=jump to location [Q]uit and return to previous location
6561 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6563 (defvar org-goto-start-pos) ; dynamically scoped parameter
6565 ;; FIXME: Docstring does not mention both interfaces
6566 (defun org-goto (&optional alternative-interface)
6567 "Look up a different location in the current file, keeping current visibility.
6569 When you want look-up or go to a different location in a document, the
6570 fastest way is often to fold the entire buffer and then dive into the tree.
6571 This method has the disadvantage, that the previous location will be folded,
6572 which may not be what you want.
6574 This command works around this by showing a copy of the current buffer
6575 in an indirect buffer, in overview mode. You can dive into the tree in
6576 that copy, use org-occur and incremental search to find a location.
6577 When pressing RET or `Q', the command returns to the original buffer in
6578 which the visibility is still unchanged. After RET is will also jump to
6579 the location selected in the indirect buffer and expose the
6580 the headline hierarchy above."
6581 (interactive "P")
6582 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6583 (org-refile-use-outline-path t)
6584 (org-refile-target-verify-function nil)
6585 (interface
6586 (if (not alternative-interface)
6587 org-goto-interface
6588 (if (eq org-goto-interface 'outline)
6589 'outline-path-completion
6590 'outline)))
6591 (org-goto-start-pos (point))
6592 (selected-point
6593 (if (eq interface 'outline)
6594 (car (org-get-location (current-buffer) org-goto-help))
6595 (let ((pa (org-refile-get-location "Goto")))
6596 (org-refile-check-position pa)
6597 (nth 3 pa)))))
6598 (if selected-point
6599 (progn
6600 (org-mark-ring-push org-goto-start-pos)
6601 (goto-char selected-point)
6602 (if (or (outline-invisible-p) (org-invisible-p2))
6603 (org-show-context 'org-goto)))
6604 (message "Quit"))))
6606 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6607 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6608 (defvar org-goto-local-auto-isearch-map) ; defined below
6610 (defun org-get-location (buf help)
6611 "Let the user select a location in the Org-mode buffer BUF.
6612 This function uses a recursive edit. It returns the selected position
6613 or nil."
6614 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6615 (isearch-hide-immediately nil)
6616 (isearch-search-fun-function
6617 (lambda () 'org-goto-local-search-headings))
6618 (org-goto-selected-point org-goto-exit-command)
6619 (pop-up-frames nil)
6620 (special-display-buffer-names nil)
6621 (special-display-regexps nil)
6622 (special-display-function nil))
6623 (save-excursion
6624 (save-window-excursion
6625 (delete-other-windows)
6626 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6627 (switch-to-buffer
6628 (condition-case nil
6629 (make-indirect-buffer (current-buffer) "*org-goto*")
6630 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6631 (with-output-to-temp-buffer "*Help*"
6632 (princ help))
6633 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6634 (setq buffer-read-only nil)
6635 (let ((org-startup-truncated t)
6636 (org-startup-folded nil)
6637 (org-startup-align-all-tables nil))
6638 (org-mode)
6639 (org-overview))
6640 (setq buffer-read-only t)
6641 (if (and (boundp 'org-goto-start-pos)
6642 (integer-or-marker-p org-goto-start-pos))
6643 (let ((org-show-hierarchy-above t)
6644 (org-show-siblings t)
6645 (org-show-following-heading t))
6646 (goto-char org-goto-start-pos)
6647 (and (outline-invisible-p) (org-show-context)))
6648 (goto-char (point-min)))
6649 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6650 (message "Select location and press RET")
6651 (use-local-map org-goto-map)
6652 (recursive-edit)
6653 ))
6654 (kill-buffer "*org-goto*")
6655 (cons org-goto-selected-point org-goto-exit-command)))
6657 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6658 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6659 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6660 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6662 (defun org-goto-local-search-headings (string bound noerror)
6663 "Search and make sure that any matches are in headlines."
6664 (catch 'return
6665 (while (if isearch-forward
6666 (search-forward string bound noerror)
6667 (search-backward string bound noerror))
6668 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6669 (and (member :headline context)
6670 (not (member :tags context))))
6671 (throw 'return (point))))))
6673 (defun org-goto-local-auto-isearch ()
6674 "Start isearch."
6675 (interactive)
6676 (goto-char (point-min))
6677 (let ((keys (this-command-keys)))
6678 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6679 (isearch-mode t)
6680 (isearch-process-search-char (string-to-char keys)))))
6682 (defun org-goto-ret (&optional arg)
6683 "Finish `org-goto' by going to the new location."
6684 (interactive "P")
6685 (setq org-goto-selected-point (point)
6686 org-goto-exit-command 'return)
6687 (throw 'exit nil))
6689 (defun org-goto-left ()
6690 "Finish `org-goto' by going to the new location."
6691 (interactive)
6692 (if (org-on-heading-p)
6693 (progn
6694 (beginning-of-line 1)
6695 (setq org-goto-selected-point (point)
6696 org-goto-exit-command 'left)
6697 (throw 'exit nil))
6698 (error "Not on a heading")))
6700 (defun org-goto-right ()
6701 "Finish `org-goto' by going to the new location."
6702 (interactive)
6703 (if (org-on-heading-p)
6704 (progn
6705 (setq org-goto-selected-point (point)
6706 org-goto-exit-command 'right)
6707 (throw 'exit nil))
6708 (error "Not on a heading")))
6710 (defun org-goto-quit ()
6711 "Finish `org-goto' without cursor motion."
6712 (interactive)
6713 (setq org-goto-selected-point nil)
6714 (setq org-goto-exit-command 'quit)
6715 (throw 'exit nil))
6717 ;;; Indirect buffer display of subtrees
6719 (defvar org-indirect-dedicated-frame nil
6720 "This is the frame being used for indirect tree display.")
6721 (defvar org-last-indirect-buffer nil)
6723 (defun org-tree-to-indirect-buffer (&optional arg)
6724 "Create indirect buffer and narrow it to current subtree.
6725 With numerical prefix ARG, go up to this level and then take that tree.
6726 If ARG is negative, go up that many levels.
6727 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6728 indirect buffer previously made with this command, to avoid proliferation of
6729 indirect buffers. However, when you call the command with a \
6731 when `org-indirect-buffer-display' is `new-frame', the last buffer
6732 is kept so that you can work with several indirect buffers at the same time.
6733 If `org-indirect-buffer-display' is `dedicated-frame', the \
6735 requests that a new frame be made for the new buffer, so that the dedicated
6736 frame is not changed."
6737 (interactive "P")
6738 (let ((cbuf (current-buffer))
6739 (cwin (selected-window))
6740 (pos (point))
6741 beg end level heading ibuf)
6742 (save-excursion
6743 (org-back-to-heading t)
6744 (when (numberp arg)
6745 (setq level (org-outline-level))
6746 (if (< arg 0) (setq arg (+ level arg)))
6747 (while (> (setq level (org-outline-level)) arg)
6748 (outline-up-heading 1 t)))
6749 (setq beg (point)
6750 heading (org-get-heading))
6751 (org-end-of-subtree t t)
6752 (if (org-on-heading-p) (backward-char 1))
6753 (setq end (point)))
6754 (if (and (buffer-live-p org-last-indirect-buffer)
6755 (not (eq org-indirect-buffer-display 'new-frame))
6756 (not arg))
6757 (kill-buffer org-last-indirect-buffer))
6758 (setq ibuf (org-get-indirect-buffer cbuf)
6759 org-last-indirect-buffer ibuf)
6760 (cond
6761 ((or (eq org-indirect-buffer-display 'new-frame)
6762 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6763 (select-frame (make-frame))
6764 (delete-other-windows)
6765 (switch-to-buffer ibuf)
6766 (org-set-frame-title heading))
6767 ((eq org-indirect-buffer-display 'dedicated-frame)
6768 (raise-frame
6769 (select-frame (or (and org-indirect-dedicated-frame
6770 (frame-live-p org-indirect-dedicated-frame)
6771 org-indirect-dedicated-frame)
6772 (setq org-indirect-dedicated-frame (make-frame)))))
6773 (delete-other-windows)
6774 (switch-to-buffer ibuf)
6775 (org-set-frame-title (concat "Indirect: " heading)))
6776 ((eq org-indirect-buffer-display 'current-window)
6777 (switch-to-buffer ibuf))
6778 ((eq org-indirect-buffer-display 'other-window)
6779 (pop-to-buffer ibuf))
6780 (t (error "Invalid value")))
6781 (if (featurep 'xemacs)
6782 (save-excursion (org-mode) (turn-on-font-lock)))
6783 (narrow-to-region beg end)
6784 (show-all)
6785 (goto-char pos)
6786 (and (window-live-p cwin) (select-window cwin))))
6788 (defun org-get-indirect-buffer (&optional buffer)
6789 (setq buffer (or buffer (current-buffer)))
6790 (let ((n 1) (base (buffer-name buffer)) bname)
6791 (while (buffer-live-p
6792 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6793 (setq n (1+ n)))
6794 (condition-case nil
6795 (make-indirect-buffer buffer bname 'clone)
6796 (error (make-indirect-buffer buffer bname)))))
6798 (defun org-set-frame-title (title)
6799 "Set the title of the current frame to the string TITLE."
6800 ;; FIXME: how to name a single frame in XEmacs???
6801 (unless (featurep 'xemacs)
6802 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6804 ;;;; Structure editing
6806 ;;; Inserting headlines
6808 (defun org-previous-line-empty-p ()
6809 (save-excursion
6810 (and (not (bobp))
6811 (or (beginning-of-line 0) t)
6812 (save-match-data
6815 (defun org-insert-heading (&optional force-heading invisible-ok)
6816 "Insert a new heading or item with same depth at point.
6817 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6818 If point is at the beginning of a headline, insert a sibling before the
6819 current headline. If point is not at the beginning, split the line,
6820 create the new headline with the text in the current line after point
6821 \(but see also the variable `org-M-RET-may-split-line').
6823 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6824 This is important for non-interactive uses of the command."
6825 (interactive "P")
6826 (if (or (= (buffer-size) 0)
6827 (and (not (save-excursion
6828 (and (ignore-errors (org-back-to-heading invisible-ok))
6829 (org-on-heading-p))))
6830 (not (org-in-item-p))))
6831 (progn
6833 (run-hooks 'org-insert-heading-hook))
6834 (when (or force-heading (not (org-insert-item)))
6835 (let* ((empty-line-p nil)
6836 (level nil)
6837 (on-heading (org-on-heading-p))
6838 (head (save-excursion
6839 (condition-case nil
6840 (progn
6841 (org-back-to-heading invisible-ok)
6842 (when (and (not on-heading)
6843 (featurep 'org-inlinetask)
6844 (integerp org-inlinetask-min-level)
6845 (>= (length (match-string 0))
6846 org-inlinetask-min-level))
6847 ;; Find a heading level before the inline task
6848 (while (and (setq level (org-up-heading-safe))
6849 (>= level org-inlinetask-min-level)))
6850 (if (org-on-heading-p)
6851 (org-back-to-heading invisible-ok)
6852 (error "This should not happen")))
6853 (setq empty-line-p (org-previous-line-empty-p))
6854 (match-string 0))
6855 (error "*"))))
6856 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6857 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6858 pos hide-previous previous-pos)
6859 (cond
6860 ((and (org-on-heading-p) (bolp)
6861 (or (bobp)
6862 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6863 ;; insert before the current line
6864 (open-line (if blank 2 1)))
6865 ((and (bolp)
6866 (not org-insert-heading-respect-content)
6867 (or (bobp)
6868 (save-excursion
6869 (backward-char 1) (not (outline-invisible-p)))))
6870 ;; insert right here
6871 nil)
6872 (t
6873 ;; somewhere in the line
6874 (save-excursion
6875 (setq previous-pos (point-at-bol))
6876 (end-of-line)
6877 (setq hide-previous (outline-invisible-p)))
6878 (and org-insert-heading-respect-content (org-show-subtree))
6879 (let ((split
6880 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6881 (save-excursion
6882 (let ((p (point)))
6883 (goto-char (point-at-bol))
6884 (and (looking-at org-complex-heading-regexp)
6885 (> p (match-beginning 4)))))))
6886 tags pos)
6887 (cond
6888 (org-insert-heading-respect-content
6889 (org-end-of-subtree nil t)
6890 (when (featurep 'org-inlinetask)
6891 (while (and (not (eobp))
6893 (>= (length (match-string 1))
6894 org-inlinetask-min-level))
6895 (org-end-of-subtree nil t)))
6896 (or (bolp) (newline))
6897 (or (org-previous-line-empty-p)
6898 (and blank (newline)))
6899 (open-line 1))
6900 ((org-on-heading-p)
6901 (when hide-previous
6902 (show-children)
6903 (org-show-entry))
6905 (setq tags (and (match-end 2) (match-string 2)))
6906 (and (match-end 1)
6907 (delete-region (match-beginning 1) (match-end 1)))
6908 (setq pos (point-at-bol))
6909 (or split (end-of-line 1))
6910 (delete-horizontal-space)
6912 (buffer-substring (point-at-bol) (point)))
6913 (insert " "))
6914 (newline (if blank 2 1))
6915 (when tags
6916 (save-excursion
6917 (goto-char pos)
6918 (end-of-line 1)
6919 (insert " " tags)
6920 (org-set-tags nil 'align))))
6921 (t
6922 (or split (end-of-line 1))
6923 (newline (if blank 2 1)))))))
6924 (insert head) (just-one-space)
6925 (setq pos (point))
6926 (end-of-line 1)
6927 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6928 (when (and org-insert-heading-respect-content hide-previous)
6929 (save-excursion
6930 (goto-char previous-pos)
6931 (hide-subtree)))
6932 (run-hooks 'org-insert-heading-hook)))))
6934 (defun org-get-heading (&optional no-tags)
6935 "Return the heading of the current entry, without the stars."
6936 (save-excursion
6937 (org-back-to-heading t)
6938 (if (looking-at
6939 (if no-tags
6942 (match-string 1) "")))
6944 (defun org-heading-components ()
6945 "Return the components of the current heading.
6946 This is a list with the following elements:
6947 - the level as an integer
6948 - the reduced level, different if `org-odd-levels-only' is set.
6949 - the TODO keyword, or nil
6950 - the priority character, like ?A, or nil if no priority is given
6951 - the headline text itself, or the tags string if no headline text
6952 - the tags string, or nil."
6953 (save-excursion
6954 (org-back-to-heading t)
6955 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6956 (list (length (match-string 1))
6957 (org-reduced-level (length (match-string 1)))
6958 (org-match-string-no-properties 2)
6959 (and (match-end 3) (aref (match-string 3) 2))
6960 (org-match-string-no-properties 4)
6961 (org-match-string-no-properties 5)))))
6963 (defun org-get-entry ()
6964 "Get the entry text, after heading, entire subtree."
6965 (save-excursion
6966 (org-back-to-heading t)
6967 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6969 (defun org-insert-heading-after-current ()
6970 "Insert a new heading with same level as current, after current subtree."
6971 (interactive)
6972 (org-back-to-heading)
6973 (org-insert-heading)
6974 (org-move-subtree-down)
6975 (end-of-line 1))
6977 (defun org-insert-heading-respect-content ()
6978 (interactive)
6979 (let ((org-insert-heading-respect-content t))
6980 (org-insert-heading t)))
6982 (defun org-insert-todo-heading-respect-content (&optional force-state)
6983 (interactive "P")
6984 (let ((org-insert-heading-respect-content t))
6985 (org-insert-todo-heading force-state t)))
6987 (defun org-insert-todo-heading (arg &optional force-heading)
6988 "Insert a new heading with the same level and TODO state as current heading.
6989 If the heading has no TODO state, or if the state is DONE, use the first
6990 state (TODO by default). Also with prefix arg, force first state."
6991 (interactive "P")
6992 (when (or force-heading (not (org-insert-item 'checkbox)))
6993 (org-insert-heading force-heading)
6994 (save-excursion
6995 (org-back-to-heading)
6996 (outline-previous-heading)
6997 (looking-at org-todo-line-regexp))
6998 (let*
6999 ((new-mark-x
7000 (if (or arg
7001 (not (match-beginning 2))
7002 (member (match-string 2) org-done-keywords))
7003 (car org-todo-keywords-1)
7004 (match-string 2)))
7005 (new-mark
7006 (or
7007 (run-hook-with-args-until-success
7008 'org-todo-get-default-hook new-mark-x nil)
7009 new-mark-x)))
7010 (beginning-of-line 1)
7012 (if org-treat-insert-todo-heading-as-state-change
7013 (org-todo new-mark)
7014 (insert new-mark " "))))
7015 (when org-provide-todo-statistics
7016 (org-update-parent-todo-statistics))))
7018 (defun org-insert-subheading (arg)
7019 "Insert a new subheading and demote it.
7020 Works for outline headings and for plain lists alike."
7021 (interactive "P")
7022 (org-insert-heading arg)
7023 (cond
7024 ((org-on-heading-p) (org-do-demote))
7025 ((org-at-item-p) (org-indent-item))))
7027 (defun org-insert-todo-subheading (arg)
7028 "Insert a new subheading with TODO keyword or checkbox and demote it.
7029 Works for outline headings and for plain lists alike."
7030 (interactive "P")
7031 (org-insert-todo-heading arg)
7032 (cond
7033 ((org-on-heading-p) (org-do-demote))
7034 ((org-at-item-p) (org-indent-item))))
7036 ;;; Promotion and Demotion
7038 (defvar org-after-demote-entry-hook nil
7039 "Hook run after an entry has been demoted.
7040 The cursor will be at the beginning of the entry.
7041 When a subtree is being demoted, the hook will be called for each node.")
7043 (defvar org-after-promote-entry-hook nil
7044 "Hook run after an entry has been promoted.
7045 The cursor will be at the beginning of the entry.
7046 When a subtree is being promoted, the hook will be called for each node.")
7048 (defun org-promote-subtree ()
7049 "Promote the entire subtree.
7050 See also `org-promote'."
7051 (interactive)
7052 (save-excursion
7053 (org-with-limited-levels (org-map-tree 'org-promote)))
7054 (org-fix-position-after-promote))
7056 (defun org-demote-subtree ()
7057 "Demote the entire subtree. See `org-demote'.
7058 See also `org-promote'."
7059 (interactive)
7060 (save-excursion
7061 (org-with-limited-levels (org-map-tree 'org-demote)))
7062 (org-fix-position-after-promote))
7065 (defun org-do-promote ()
7066 "Promote the current heading higher up the tree.
7067 If the region is active in `transient-mark-mode', promote all headings
7068 in the region."
7069 (interactive)
7070 (save-excursion
7071 (if (org-region-active-p)
7072 (org-map-region 'org-promote (region-beginning) (region-end))
7073 (org-promote)))
7074 (org-fix-position-after-promote))
7076 (defun org-do-demote ()
7077 "Demote the current heading lower down the tree.
7078 If the region is active in `transient-mark-mode', demote all headings
7079 in the region."
7080 (interactive)
7081 (save-excursion
7082 (if (org-region-active-p)
7083 (org-map-region 'org-demote (region-beginning) (region-end))
7084 (org-demote)))
7085 (org-fix-position-after-promote))
7087 (defun org-fix-position-after-promote ()
7088 "Make sure that after pro/demotion cursor position is right."
7089 (let ((pos (point)))
7090 (when (save-excursion
7091 (beginning-of-line 1)
7092 (looking-at org-todo-line-regexp)
7093 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7094 (cond ((eobp) (insert " "))
7095 ((eolp) (insert " "))
7096 ((equal (char-after) ?\ ) (forward-char 1))))))
7098 (defun org-current-level ()
7099 "Return the level of the current entry, or nil if before the first headline.
7100 The level is the number of stars at the beginning of the headline."
7101 (save-excursion
7102 (org-with-limited-levels
7103 (ignore-errors
7104 (org-back-to-heading t)
7105 (funcall outline-level)))))
7107 (defun org-get-previous-line-level ()
7108 "Return the outline depth of the last headline before the current line.
7109 Returns 0 for the first headline in the buffer, and nil if before the
7110 first headline."
7111 (let ((current-level (org-current-level))
7112 (prev-level (when (> (line-number-at-pos) 1)
7113 (save-excursion
7114 (beginning-of-line 0)
7115 (org-current-level)))))
7116 (cond ((null current-level) nil) ; Before first headline
7117 ((null prev-level) 0) ; At first headline
7118 (prev-level))))
7120 (defun org-reduced-level (l)
7121 "Compute the effective level of a heading.
7122 This takes into account the setting of `org-odd-levels-only'."
7123 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7125 (defun org-level-increment ()
7126 "Return the number of stars that will be added or removed at a
7127 time to headlines when structure editing, based on the value of
7128 `org-odd-levels-only'."
7129 (if org-odd-levels-only 2 1))
7131 (defun org-get-valid-level (level &optional change)
7132 "Rectify a level change under the influence of `org-odd-levels-only'
7133 LEVEL is a current level, CHANGE is by how much the level should be
7134 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7135 even level numbers will become the next higher odd number."
7136 (if org-odd-levels-only
7137 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7138 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7139 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7140 (max 1 (+ level (or change 0)))))
7142 (if (boundp 'define-obsolete-function-alias)
7143 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7144 (define-obsolete-function-alias 'org-get-legal-level
7145 'org-get-valid-level)
7146 (define-obsolete-function-alias 'org-get-legal-level
7147 'org-get-valid-level "23.1")))
7149 (defun org-promote ()
7150 "Promote the current heading higher up the tree.
7151 If the region is active in `transient-mark-mode', promote all headings
7152 in the region."
7153 (org-back-to-heading t)
7154 (let* ((level (save-match-data (funcall outline-level)))
7155 (after-change-functions (remove 'flyspell-after-change-function
7156 after-change-functions))
7157 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7158 (diff (abs (- level (length up-head) -1))))
7159 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7160 (replace-match up-head nil t)
7161 ;; Fixup tag positioning
7162 (and org-auto-align-tags (org-set-tags nil t))
7163 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7164 (run-hooks 'org-after-promote-entry-hook)))
7166 (defun org-demote ()
7167 "Demote the current heading lower down the tree.
7168 If the region is active in `transient-mark-mode', demote all headings
7169 in the region."
7170 (org-back-to-heading t)
7171 (let* ((level (save-match-data (funcall outline-level)))
7172 (after-change-functions (remove 'flyspell-after-change-function
7173 after-change-functions))
7174 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7175 (diff (abs (- level (length down-head) -1))))
7176 (replace-match down-head nil t)
7177 ;; Fixup tag positioning
7178 (and org-auto-align-tags (org-set-tags nil t))
7179 (if org-adapt-indentation (org-fixup-indentation diff))
7180 (run-hooks 'org-after-demote-entry-hook)))
7182 (defun org-cycle-level ()
7183 "Cycle the level of an empty headline through possible states.
7184 This goes first to child, then to parent, level, then up the hierarchy.
7185 After top level, it switches back to sibling level."
7186 (interactive)
7187 (let ((org-adapt-indentation nil))
7188 (when (org-point-at-end-of-empty-headline)
7189 (setq this-command 'org-cycle-level) ; Only needed for caching
7190 (let ((cur-level (org-current-level))
7191 (prev-level (org-get-previous-line-level)))
7192 (cond
7193 ;; If first headline in file, promote to top-level.
7194 ((= prev-level 0)
7195 (loop repeat (/ (- cur-level 1) (org-level-increment))
7196 do (org-do-promote)))
7197 ;; If same level as prev, demote one.
7198 ((= prev-level cur-level)
7199 (org-do-demote))
7200 ;; If parent is top-level, promote to top level if not already.
7201 ((= prev-level 1)
7202 (loop repeat (/ (- cur-level 1) (org-level-increment))
7203 do (org-do-promote)))
7204 ;; If top-level, return to prev-level.
7205 ((= cur-level 1)
7206 (loop repeat (/ (- prev-level 1) (org-level-increment))
7207 do (org-do-demote)))
7208 ;; If less than prev-level, promote one.
7209 ((< cur-level prev-level)
7210 (org-do-promote))
7211 ;; If deeper than prev-level, promote until higher than
7212 ;; prev-level.
7213 ((> cur-level prev-level)
7214 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7215 do (org-do-promote))))
7216 t))))
7218 (defun org-map-tree (fun)
7219 "Call FUN for every heading underneath the current one."
7220 (org-back-to-heading)
7221 (let ((level (funcall outline-level)))
7222 (save-excursion
7223 (funcall fun)
7224 (while (and (progn
7225 (outline-next-heading)
7226 (> (funcall outline-level) level))
7227 (not (eobp)))
7228 (funcall fun)))))
7230 (defun org-map-region (fun beg end)
7231 "Call FUN for every heading between BEG and END."
7232 (let ((org-ignore-region t))
7233 (save-excursion
7234 (setq end (copy-marker end))
7235 (goto-char beg)
7236 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7237 (< (point) end))
7238 (funcall fun))
7239 (while (and (progn
7240 (outline-next-heading)
7241 (< (point) end))
7242 (not (eobp)))
7243 (funcall fun)))))
7245 (defun org-fixup-indentation (diff)
7246 "Change the indentation in the current entry by DIFF.
7247 However, if any line in the current entry has no indentation, or if it
7248 would end up with no indentation after the change, nothing at all is done."
7249 (save-excursion
7250 (let ((end (save-excursion (outline-next-heading)
7251 (point-marker)))
7252 (prohibit (if (> diff 0)
7255 col)
7256 (unless (save-excursion (end-of-line 1)
7257 (re-search-forward prohibit end t))
7258 (while (and (< (point) end)
7260 (goto-char (match-end 0))
7261 (setq col (current-column))
7262 (if (< diff 0) (replace-match ""))
7263 (org-indent-to-column (+ diff col))))
7264 (move-marker end nil))))
7266 (defun org-convert-to-odd-levels ()
7267 "Convert an org-mode file with all levels allowed to one with odd levels.
7268 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7269 level 5 etc."
7270 (interactive)
7271 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7272 (let ((outline-regexp org-outline-regexp)
7273 (outline-level 'org-outline-level)
7274 (org-odd-levels-only nil) n)
7275 (save-excursion
7276 (goto-char (point-min))
7278 (setq n (- (length (match-string 0)) 2))
7279 (while (>= (setq n (1- n)) 0)
7280 (org-demote))
7281 (end-of-line 1))))))
7283 (defun org-convert-to-oddeven-levels ()
7284 "Convert an org-mode file with only odd levels to one with odd/even levels.
7285 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7286 file contains a section with an even level, conversion would
7287 destroy the structure of the file. An error is signaled in this
7288 case."
7289 (interactive)
7290 (goto-char (point-min))
7291 ;; First check if there are no even levels
7293 (org-show-context t)
7294 (error "Not all levels are odd in this file. Conversion not possible"))
7295 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7296 (let ((outline-regexp org-outline-regexp)
7297 (outline-level 'org-outline-level)
7298 (org-odd-levels-only nil) n)
7299 (save-excursion
7300 (goto-char (point-min))
7302 (setq n (/ (1- (length (match-string 0))) 2))
7303 (while (>= (setq n (1- n)) 0)
7304 (org-promote))
7305 (end-of-line 1))))))
7307 (defun org-tr-level (n)
7308 "Make N odd if required."
7309 (if org-odd-levels-only (1+ (/ n 2)) n))
7311 ;;; Vertical tree motion, cutting and pasting of subtrees
7313 (defun org-move-subtree-up (&optional arg)
7314 "Move the current subtree up past ARG headlines of the same level."
7315 (interactive "p")
7316 (org-move-subtree-down (- (prefix-numeric-value arg))))
7318 (defun org-move-subtree-down (&optional arg)
7319 "Move the current subtree down past ARG headlines of the same level."
7320 (interactive "p")
7321 (setq arg (prefix-numeric-value arg))
7322 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7323 'org-get-last-sibling))
7324 (ins-point (make-marker))
7325 (cnt (abs arg))
7326 (col (current-column))
7327 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7328 ;; Select the tree
7329 (org-back-to-heading)
7330 (setq beg0 (point))
7331 (save-excursion
7332 (setq ne-beg (org-back-over-empty-lines))
7333 (setq beg (point)))
7334 (save-match-data
7335 (save-excursion (outline-end-of-heading)
7336 (setq folded (outline-invisible-p)))
7337 (outline-end-of-subtree))
7338 (outline-next-heading)
7339 (setq ne-end (org-back-over-empty-lines))
7340 (setq end (point))
7341 (goto-char beg0)
7342 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7343 ;; include less whitespace
7344 (save-excursion
7345 (goto-char beg)
7346 (forward-line (- ne-beg ne-end))
7347 (setq beg (point))))
7348 ;; Find insertion point, with error handling
7349 (while (> cnt 0)
7350 (or (and (funcall movfunc) (looking-at outline-regexp))
7351 (progn (goto-char beg0)
7352 (error "Cannot move past superior level or buffer limit")))
7353 (setq cnt (1- cnt)))
7354 (if (> arg 0)
7355 ;; Moving forward - still need to move over subtree
7356 (progn (org-end-of-subtree t t)
7357 (save-excursion
7358 (org-back-over-empty-lines)
7359 (or (bolp) (newline)))))
7360 (setq ne-ins (org-back-over-empty-lines))
7361 (move-marker ins-point (point))
7362 (setq txt (buffer-substring beg end))
7363 (org-save-markers-in-region beg end)
7364 (delete-region beg end)
7365 (org-remove-empty-overlays-at beg)
7366 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7367 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7369 (let ((bbb (point)))
7370 (insert-before-markers txt)
7371 (org-reinstall-markers-in-region bbb)
7372 (move-marker ins-point bbb))
7374 (setq ins-end (point))
7375 (goto-char ins-point)
7376 (org-skip-whitespace)
7377 (when (and (< arg 0)
7378 (org-first-sibling-p)
7379 (> ne-ins ne-beg))
7380 ;; Move whitespace back to beginning
7381 (save-excursion
7382 (goto-char ins-end)
7383 (let ((kill-whole-line t))
7384 (kill-line (- ne-ins ne-beg)) (point)))
7386 (move-marker ins-point nil)
7387 (if folded
7388 (hide-subtree)
7389 (org-show-entry)
7390 (show-children)
7391 (org-cycle-hide-drawers 'children))
7392 (org-clean-visibility-after-subtree-move)
7393 ;; move back to the initial column we were at
7394 (move-to-column col)))
7396 (defvar org-subtree-clip ""
7397 "Clipboard for cut and paste of subtrees.
7398 This is actually only a copy of the kill, because we use the normal kill
7399 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7401 (defvar org-subtree-clip-folded nil
7402 "Was the last copied subtree folded?
7403 This is used to fold the tree back after pasting.")
7405 (defun org-cut-subtree (&optional n)
7406 "Cut the current subtree into the clipboard.
7407 With prefix arg N, cut this many sequential subtrees.
7408 This is a short-hand for marking the subtree and then cutting it."
7409 (interactive "p")
7410 (org-copy-subtree n 'cut))
7412 (defun org-copy-subtree (&optional n cut force-store-markers)
7413 "Cut the current subtree into the clipboard.
7414 With prefix arg N, cut this many sequential subtrees.
7415 This is a short-hand for marking the subtree and then copying it.
7416 If CUT is non-nil, actually cut the subtree.
7417 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7418 of some markers in the region, even if CUT is non-nil. This is
7419 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7420 (interactive "p")
7421 (let (beg end folded (beg0 (point)))
7422 (if (interactive-p)
7423 (org-back-to-heading nil) ; take what looks like a subtree
7424 (org-back-to-heading t)) ; take what is really there
7425 (org-back-over-empty-lines)
7426 (setq beg (point))
7428 (save-match-data
7429 (save-excursion (outline-end-of-heading)
7430 (setq folded (outline-invisible-p)))
7431 (condition-case nil
7432 (org-forward-same-level (1- n) t)
7433 (error nil))
7434 (org-end-of-subtree t t))
7435 (org-back-over-empty-lines)
7436 (setq end (point))
7437 (goto-char beg0)
7438 (when (> end beg)
7439 (setq org-subtree-clip-folded folded)
7440 (when (or cut force-store-markers)
7441 (org-save-markers-in-region beg end))
7442 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7443 (setq org-subtree-clip (current-kill 0))
7444 (message "%s: Subtree(s) with %d characters"
7445 (if cut "Cut" "Copied")
7446 (length org-subtree-clip)))))
7448 (defun org-paste-subtree (&optional level tree for-yank)
7449 "Paste the clipboard as a subtree, with modification of headline level.
7450 The entire subtree is promoted or demoted in order to match a new headline
7451 level.
7453 If the cursor is at the beginning of a headline, the same level as
7454 that headline is used to paste the tree
7456 If not, the new level is derived from the *visible* headings
7457 before and after the insertion point, and taken to be the inferior headline
7458 level of the two. So if the previous visible heading is level 3 and the
7459 next is level 4 (or vice versa), level 4 will be used for insertion.
7460 This makes sure that the subtree remains an independent subtree and does
7461 not swallow low level entries.
7463 You can also force a different level, either by using a numeric prefix
7464 argument, or by inserting the heading marker by hand. For example, if the
7467 If optional TREE is given, use this text instead of the kill ring.
7469 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7470 move back over whitespace before inserting, and move point to the end of
7471 the inserted text when done."
7472 (interactive "P")
7473 (setq tree (or tree (and kill-ring (current-kill 0))))
7474 (unless (org-kill-is-subtree-p tree)
7475 (error "%s"
7476 (substitute-command-keys
7478 (let* ((visp (not (outline-invisible-p)))
7479 (txt tree)
7484 (old-level (if (string-match ^re txt)
7485 (- (match-end 0) (match-beginning 0) 1)
7486 -1))
7487 (force-level (cond (level (prefix-numeric-value level))
7489 (string-match
7490 ^re_ (buffer-substring
7491 (point-at-bol) (point))))
7492 (- (match-end 1) (match-beginning 1)))
7493 ((and (bolp)
7494 (looking-at org-outline-regexp))
7495 (- (match-end 0) (point) 1))
7496 (t nil)))
7497 (previous-level (save-excursion
7498 (condition-case nil
7499 (progn
7500 (outline-previous-visible-heading 1)
7501 (if (looking-at re)
7502 (- (match-end 0) (match-beginning 0) 1)
7503 1))
7504 (error 1))))
7505 (next-level (save-excursion
7506 (condition-case nil
7507 (progn
7508 (or (looking-at outline-regexp)
7509 (outline-next-visible-heading 1))
7510 (if (looking-at re)
7511 (- (match-end 0) (match-beginning 0) 1)
7512 1))
7513 (error 1))))
7514 (new-level (or force-level (max previous-level next-level)))
7515 (shift (if (or (= old-level -1)
7516 (= new-level -1)
7517 (= old-level new-level))
7518 0
7519 (- new-level old-level)))
7520 (delta (if (> shift 0) -1 1))
7521 (func (if (> shift 0) 'org-demote 'org-promote))
7522 (org-odd-levels-only nil)
7523 beg end newend)
7524 ;; Remove the forced level indicator
7525 (if force-level
7526 (delete-region (point-at-bol) (point)))
7527 ;; Paste
7528 (beginning-of-line 1)
7529 (unless for-yank (org-back-over-empty-lines))
7530 (setq beg (point))
7531 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7532 (insert-before-markers txt)
7534 (setq newend (point))
7535 (org-reinstall-markers-in-region beg)
7536 (setq end (point))
7537 (goto-char beg)
7539 (setq beg (point))
7540 (if (and (outline-invisible-p) visp)
7541 (save-excursion (outline-show-heading)))
7542 ;; Shift if necessary
7543 (unless (= shift 0)
7544 (save-restriction
7545 (narrow-to-region beg end)
7546 (while (not (= shift 0))
7547 (org-map-region func (point-min) (point-max))
7548 (setq shift (+ delta shift)))
7549 (goto-char (point-min))
7550 (setq newend (point-max))))
7551 (when (or (interactive-p) for-yank)
7552 (message "Clipboard pasted as level %d subtree" new-level))
7553 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7554 kill-ring
7555 (eq org-subtree-clip (current-kill 0))
7556 org-subtree-clip-folded)
7557 ;; The tree was folded before it was killed/copied
7558 (hide-subtree))
7559 (and for-yank (goto-char newend))))
7561 (defun org-kill-is-subtree-p (&optional txt)
7562 "Check if the current kill is an outline subtree, or a set of trees.
7563 Returns nil if kill does not start with a headline, or if the first
7564 headline level is not the largest headline level in the tree.
7565 So this will actually accept several entries of equal levels as well,
7566 which is OK for `org-paste-subtree'.
7567 If optional TXT is given, check this string instead of the current kill."
7568 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7569 (start-level (and kill
7572 kill)
7573 (- (match-end 2) (match-beginning 2) 1)))
7574 (re (concat "^" org-outline-regexp))
7575 (start (1+ (or (match-beginning 2) -1))))
7576 (if (not start-level)
7577 (progn
7578 nil) ;; does not even start with a heading
7579 (catch 'exit
7580 (while (setq start (string-match re kill (1+ start)))
7581 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7582 (throw 'exit nil)))
7583 t))))
7585 (defvar org-markers-to-move nil
7586 "Markers that should be moved with a cut-and-paste operation.
7587 Those markers are stored together with their positions relative to
7588 the start of the region.")
7590 (defun org-save-markers-in-region (beg end)
7591 "Check markers in region.
7592 If these markers are between BEG and END, record their position relative
7593 to BEG, so that after moving the block of text, we can put the markers back
7594 into place.
7595 This function gets called just before an entry or tree gets cut from the
7596 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7597 called immediately, to move the markers with the entries."
7598 (setq org-markers-to-move nil)
7599 (when (featurep 'org-clock)
7600 (org-clock-save-markers-for-cut-and-paste beg end))
7601 (when (featurep 'org-agenda)
7602 (org-agenda-save-markers-for-cut-and-paste beg end)))
7604 (defun org-check-and-save-marker (marker beg end)
7605 "Check if MARKER is between BEG and END.
7606 If yes, remember the marker and the distance to BEG."
7607 (when (and (marker-buffer marker)
7608 (equal (marker-buffer marker) (current-buffer)))
7609 (if (and (>= marker beg) (< marker end))
7610 (push (cons marker (- marker beg)) org-markers-to-move))))
7612 (defun org-reinstall-markers-in-region (beg)
7613 "Move all remembered markers to their position relative to BEG."
7614 (mapc (lambda (x)
7615 (move-marker (car x) (+ beg (cdr x))))
7616 org-markers-to-move)
7617 (setq org-markers-to-move nil))
7619 (defun org-narrow-to-subtree ()
7620 "Narrow buffer to the current subtree."
7621 (interactive)
7622 (save-excursion
7623 (save-match-data
7624 (org-with-limited-levels
7625 (narrow-to-region
7626 (progn (org-back-to-heading t) (point))
7627 (progn (org-end-of-subtree t t)
7628 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7629 (point)))))))
7631 (defun org-narrow-to-block ()
7632 "Narrow buffer to the current block."
7633 (interactive)
7636 (case-fold-search t) ;; allow #+BEGIN
7637 b_start b_end)
7638 (if (org-in-regexps-block-p bstart bend)
7639 (progn
7640 (save-excursion (re-search-backward bstart nil t)
7641 (setq b_start (match-beginning 0)))
7642 (save-excursion (re-search-forward bend nil t)
7643 (setq b_end (match-end 0)))
7644 (narrow-to-region b_start b_end))
7645 (error "Not in a block"))))
7647 (eval-when-compile
7648 (defvar org-property-drawer-re))
7650 (defvar org-property-start-re) ;; defined below
7651 (defun org-clone-subtree-with-time-shift (n &optional shift)
7652 "Clone the task (subtree) at point N times.
7653 The clones will be inserted as siblings.
7655 In interactive use, the user will be prompted for the number of
7656 clones to be produced, and for a time SHIFT, which may be a
7657 repeater as used in time stamps, for example `+3d'.
7659 When a valid repeater is given and the entry contains any time
7660 stamps, the clones will become a sequence in time, with time
7661 stamps in the subtree shifted for each clone produced. If SHIFT
7662 is nil or the empty string, time stamps will be left alone. The
7663 ID property of the original subtree is removed.
7665 If the original subtree did contain time stamps with a repeater,
7666 the following will happen:
7667 - the repeater will be removed in each clone
7668 - an additional clone will be produced, with the current, unshifted
7669 date(s) in the entry.
7670 - the original entry will be placed *after* all the clones, with
7671 repeater intact.
7672 - the start days in the repeater in the original entry will be shifted
7673 to past the last clone.
7674 I this way you can spell out a number of instances of a repeating task,
7675 and still retain the repeater to cover future instances of the task."
7676 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7677 (let (beg end template task idprop
7678 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7679 (if (not (and (integerp n) (> n 0)))
7680 (error "Invalid number of replications %s" n))
7683 shift)))
7684 (error "Invalid shift specification %s" shift))
7685 (when doshift
7686 (setq shift-n (string-to-number (match-string 1 shift))
7687 shift-what (cdr (assoc (match-string 2 shift)
7688 '(("d" . day) ("w" . week)
7689 ("m" . month) ("y" . year))))))
7690 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7691 (setq nmin 1 nmax n)
7692 (org-back-to-heading t)
7693 (setq beg (point))
7694 (setq idprop (org-entry-get nil "ID"))
7695 (org-end-of-subtree t t)
7697 (setq end (point))
7698 (setq template (buffer-substring beg end))
7699 (when (and doshift
7701 (delete-region beg end)
7702 (setq end beg)
7703 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7704 (goto-char end)
7705 (loop for n from nmin to nmax do
7706 ;; prepare clone
7707 (with-temp-buffer
7708 (insert template)
7709 (org-mode)
7710 (goto-char (point-min))
7711 (and idprop (if org-clone-delete-id
7712 (org-entry-delete nil "ID")
7713 (org-id-get-create t)))
7714 (while (re-search-forward org-property-start-re nil t)
7715 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7716 (goto-char (point-min))
7717 (when doshift
7718 (while (re-search-forward org-ts-regexp-both nil t)
7719 (org-timestamp-change (* n shift-n) shift-what))
7720 (unless (= n n-no-remove)
7721 (goto-char (point-min))
7722 (while (re-search-forward org-ts-regexp nil t)
7723 (save-excursion
7724 (goto-char (match-beginning 0))
7726 (delete-region (match-beginning 1) (match-end 1)))))))
7727 (setq task (buffer-string)))
7728 (insert task))
7729 (goto-char beg)))
7731 ;;; Outline Sorting
7733 (defun org-sort (with-case)
7734 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7735 Optional argument WITH-CASE means sort case-sensitively.
7736 With a double prefix argument, also remove duplicate entries."
7737 (interactive "P")
7738 (cond
7739 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7740 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7741 (t
7742 (org-call-with-arg 'org-sort-entries with-case))))
7744 (defun org-sort-remove-invisible (s)
7745 (remove-text-properties 0 (length s) org-rm-props s)
7746 (while (string-match org-bracket-link-regexp s)
7747 (setq s (replace-match (if (match-end 2)
7748 (match-string 3 s)
7749 (match-string 1 s)) t t s)))
7750 s)
7752 (defvar org-priority-regexp) ; defined later in the file
7754 (defvar org-after-sorting-entries-or-items-hook nil
7755 "Hook that is run after a bunch of entries or items have been sorted.
7756 When children are sorted, the cursor is in the parent line when this
7757 hook gets called. When a region or a plain list is sorted, the cursor
7758 will be in the first entry of the sorted region/list.")
7760 (defun org-sort-entries
7761 (&optional with-case sorting-type getkey-func compare-func property)
7762 "Sort entries on a certain level of an outline tree.
7763 If there is an active region, the entries in the region are sorted.
7764 Else, if the cursor is before the first entry, sort the top-level items.
7765 Else, the children of the entry at point are sorted.
7767 Sorting can be alphabetically, numerically, by date/time as given by
7768 a time stamp, by a property or by priority.
7770 The command prompts for the sorting type unless it has been given to the
7771 function through the SORTING-TYPE argument, which needs to be a character,
7772 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7773 precise meaning of each character:
7775 n Numerically, by converting the beginning of the entry/item to a number.
7776 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7777 t By date/time, either the first active time stamp in the entry, or, if
7778 none exist, by the first inactive one.
7779 s By the scheduled date/time.
7780 d By deadline date/time.
7781 c By creation time, which is assumed to be the first inactive time stamp
7782 at the beginning of a line.
7783 p By priority according to the cookie.
7784 r By the value of a property.
7786 Capital letters will reverse the sort order.
7788 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7789 called with point at the beginning of the record. It must return either
7790 a string or a number that should serve as the sorting key for that record.
7792 Comparing entries ignores case by default. However, with an optional argument
7793 WITH-CASE, the sorting considers case as well."
7794 (interactive "P")
7795 (let ((case-func (if with-case 'identity 'downcase))
7796 start beg end stars re re2
7797 txt what tmp)
7798 ;; Find beginning and end of region to sort
7799 (cond
7800 ((org-region-active-p)
7801 ;; we will sort the region
7802 (setq end (region-end)
7803 what "region")
7804 (goto-char (region-beginning))
7805 (if (not (org-on-heading-p)) (outline-next-heading))
7806 (setq start (point)))
7807 ((or (org-on-heading-p)
7808 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7809 ;; we will sort the children of the current headline
7810 (org-back-to-heading)
7811 (setq start (point)
7812 end (progn (org-end-of-subtree t t)
7814 (org-back-over-empty-lines)
7815 (point))
7816 what "children")
7817 (goto-char start)
7818 (show-subtree)
7819 (outline-next-heading))
7820 (t
7821 ;; we will sort the top-level entries in this file
7822 (goto-char (point-min))
7823 (or (org-on-heading-p) (outline-next-heading))
7824 (setq start (point))
7825 (goto-char (point-max))
7826 (beginning-of-line 1)
7828 ;; File ends in a non-white line
7829 (end-of-line 1)
7831 (setq end (point-max))
7832 (setq what "top-level")
7833 (goto-char start)
7834 (show-all)))
7836 (setq beg (point))
7837 (if (>= beg end) (error "Nothing to sort"))
7840 (setq stars (match-string 1)
7841 re (concat "^" (regexp-quote stars) " +")
7843 txt (buffer-substring beg end))
7845 (if (and (not (equal stars "*")) (string-match re2 txt))
7846 (error "Region to sort contains a level above the first entry"))
7848 (unless sorting-type
7849 (message
7850 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7852 A/N/T/S/D/C/P/O/F means reversed:"
7853 what)
7854 (setq sorting-type (read-char-exclusive))
7856 (and (= (downcase sorting-type) ?f)
7857 (setq getkey-func
7858 (org-icompleting-read "Sort using function: "
7859 obarray 'fboundp t nil nil))
7860 (setq getkey-func (intern getkey-func)))
7862 (and (= (downcase sorting-type) ?r)
7863 (setq property
7864 (org-icompleting-read "Property: "
7865 (mapcar 'list (org-buffer-property-keys t))
7866 nil t))))
7868 (message "Sorting entries...")
7870 (save-restriction
7871 (narrow-to-region start end)
7872 (let ((dcst (downcase sorting-type))
7873 (case-fold-search nil)
7874 (now (current-time)))
7875 (sort-subr
7876 (/= dcst sorting-type)
7877 ;; This function moves to the beginning character of the "record" to
7878 ;; be sorted.
7879 (lambda nil
7880 (if (re-search-forward re nil t)
7881 (goto-char (match-beginning 0))
7882 (goto-char (point-max))))
7883 ;; This function moves to the last character of the "record" being
7884 ;; sorted.
7885 (lambda nil
7886 (save-match-data
7887 (condition-case nil
7888 (outline-forward-same-level 1)
7889 (error
7890 (goto-char (point-max))))))
7891 ;; This function returns the value that gets sorted against.
7892 (lambda nil
7893 (cond
7894 ((= dcst ?n)
7895 (if (looking-at org-complex-heading-regexp)
7896 (string-to-number (match-string 4))
7897 nil))
7898 ((= dcst ?a)
7899 (if (looking-at org-complex-heading-regexp)
7900 (funcall case-func (match-string 4))
7901 nil))
7902 ((= dcst ?t)
7903 (let ((end (save-excursion (outline-next-heading) (point))))
7904 (if (or (re-search-forward org-ts-regexp end t)
7905 (re-search-forward org-ts-regexp-both end t))
7906 (org-time-string-to-seconds (match-string 0))
7907 (org-float-time now))))
7908 ((= dcst ?c)
7909 (let ((end (save-excursion (outline-next-heading) (point))))
7910 (if (re-search-forward
7912 end t)
7913 (org-time-string-to-seconds (match-string 0))
7914 (org-float-time now))))
7915 ((= dcst ?s)
7916 (let ((end (save-excursion (outline-next-heading) (point))))
7917 (if (re-search-forward org-scheduled-time-regexp end t)
7918 (org-time-string-to-seconds (match-string 1))
7919 (org-float-time now))))
7920 ((= dcst ?d)
7921 (let ((end (save-excursion (outline-next-heading) (point))))
7922 (if (re-search-forward org-deadline-time-regexp end t)
7923 (org-time-string-to-seconds (match-string 1))
7924 (org-float-time now))))
7925 ((= dcst ?p)
7926 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7927 (string-to-char (match-string 2))
7928 org-default-priority))
7929 ((= dcst ?r)
7930 (or (org-entry-get nil property) ""))
7931 ((= dcst ?o)
7932 (if (looking-at org-complex-heading-regexp)
7933 (- 9999 (length (member (match-string 2)
7934 org-todo-keywords-1)))))
7935 ((= dcst ?f)
7936 (if getkey-func
7937 (progn
7938 (setq tmp (funcall getkey-func))
7939 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7940 tmp)
7941 (error "Invalid key function `%s'" getkey-func)))
7942 (t (error "Invalid sorting type `%c'" sorting-type))))
7943 nil
7944 (cond
7945 ((= dcst ?a) 'string<)
7946 ((= dcst ?f) compare-func)
7947 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7948 (t nil)))))
7949 (run-hooks 'org-after-sorting-entries-or-items-hook)
7950 (message "Sorting entries...done")))
7952 (defun org-do-sort (table what &optional with-case sorting-type)
7953 "Sort TABLE of WHAT according to SORTING-TYPE.
7954 The user will be prompted for the SORTING-TYPE if the call to this
7955 function does not specify it. WHAT is only for the prompt, to indicate
7956 what is being sorted. The sorting key will be extracted from
7957 the car of the elements of the table.
7958 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7959 (unless sorting-type
7960 (message
7961 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7962 what)
7963 (setq sorting-type (read-char-exclusive)))
7964 (let ((dcst (downcase sorting-type))
7965 extractfun comparefun)
7966 ;; Define the appropriate functions
7967 (cond
7968 ((= dcst ?n)
7969 (setq extractfun 'string-to-number
7970 comparefun (if (= dcst sorting-type) '< '>)))
7971 ((= dcst ?a)
7972 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7973 (lambda(x) (downcase (org-sort-remove-invisible x))))
7974 comparefun (if (= dcst sorting-type)
7975 'string<
7976 (lambda (a b) (and (not (string< a b))
7977 (not (string= a b)))))))
7978 ((= dcst ?t)
7979 (setq extractfun
7980 (lambda (x)
7981 (if (or (string-match org-ts-regexp x)
7982 (string-match org-ts-regexp-both x))
7983 (org-float-time
7984 (org-time-string-to-time (match-string 0 x)))
7985 0))
7986 comparefun (if (= dcst sorting-type) '< '>)))
7987 (t (error "Invalid sorting type `%c'" sorting-type)))
7989 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7990 table)
7991 (lambda (a b) (funcall comparefun (car a) (car b))))))
7994 ;;; The orgstruct minor mode
7996 ;; Define a minor mode which can be used in other modes in order to
7997 ;; integrate the org-mode structure editing commands.
7999 ;; This is really a hack, because the org-mode structure commands use
8000 ;; keys which normally belong to the major mode. Here is how it
8001 ;; works: The minor mode defines all the keys necessary to operate the
8002 ;; structure commands, but wraps the commands into a function which
8003 ;; tests if the cursor is currently at a headline or a plain list
8004 ;; item. If that is the case, the structure command is used,
8005 ;; temporarily setting many Org-mode variables like regular
8006 ;; expressions for filling etc. However, when any of those keys is
8007 ;; used at a different location, function uses `key-binding' to look
8008 ;; up if the key has an associated command in another currently active
8009 ;; keymap (minor modes, major mode, global), and executes that
8010 ;; command. There might be problems if any of the keys is otherwise
8011 ;; used as a prefix key.
8013 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8014 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8015 ;; addresses this by checking explicitly for both bindings.
8017 (defvar orgstruct-mode-map (make-sparse-keymap)
8018 "Keymap for the minor `orgstruct-mode'.")
8020 (defvar org-local-vars nil
8021 "List of local variables, for use by `orgstruct-mode'.")
8023 ;;;###autoload
8024 (define-minor-mode orgstruct-mode
8025 "Toggle the minor mode `orgstruct-mode'.
8026 This mode is for using Org-mode structure commands in other
8027 modes. The following keys behave as if Org-mode were active, if
8028 the cursor is on a headline, or on a plain list item (both as
8029 defined by Org-mode).
8031 M-up Move entry/item up
8032 M-down Move entry/item down
8033 M-left Promote
8034 M-right Demote
8035 M-S-up Move entry/item up
8036 M-S-down Move entry/item down
8037 M-S-left Promote subtree
8038 M-S-right Demote subtree
8039 M-q Fill paragraph and items like in Org-mode
8040 C-c ^ Sort entries
8041 C-c - Cycle list bullet
8042 TAB Cycle item visibility
8043 M-RET Insert new heading/item
8044 S-M-RET Insert new TODO heading / Checkbox item
8045 C-c C-c Set tags / toggle checkbox"
8046 nil " OrgStruct" nil
8047 (org-load-modules-maybe)
8048 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8050 ;;;###autoload
8051 (defun turn-on-orgstruct ()
8052 "Unconditionally turn on `orgstruct-mode'."
8053 (orgstruct-mode 1))
8055 (defun orgstruct++-mode (&optional arg)
8056 "Toggle `orgstruct-mode', the enhanced version of it.
8057 In addition to setting orgstruct-mode, this also exports all indentation
8058 and autofilling variables from org-mode into the buffer. It will also
8059 recognize item context in multiline items.
8060 Note that turning off orgstruct-mode will *not* remove the
8061 indentation/paragraph settings. This can only be done by refreshing the
8063 (interactive "P")
8064 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8065 (if (< arg 1)
8066 (orgstruct-mode -1)
8067 (orgstruct-mode 1)
8068 (let (var val)
8069 (mapc
8070 (lambda (x)
8071 (when (string-match
8073 (symbol-name (car x)))
8074 (setq var (car x) val (nth 1 x))
8075 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8076 org-local-vars)
8077 (org-set-local 'orgstruct-is-++ t))))
8079 (defvar orgstruct-is-++ nil
8080 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8081 (make-variable-buffer-local 'orgstruct-is-++)
8083 ;;;###autoload
8084 (defun turn-on-orgstruct++ ()
8085 "Unconditionally turn on `orgstruct++-mode'."
8086 (orgstruct++-mode 1))
8088 (defun orgstruct-error ()
8089 "Error when there is no default binding for a structure key."
8090 (interactive)
8091 (error "This key has no function outside structure elements"))
8093 (defun orgstruct-setup ()
8094 "Setup orgstruct keymaps."
8095 (let ((nfunc 0)
8096 (bindings
8097 (list
8098 '([(meta up)] org-metaup)
8099 '([(meta down)] org-metadown)
8100 '([(meta left)] org-metaleft)
8101 '([(meta right)] org-metaright)
8102 '([(meta shift up)] org-shiftmetaup)
8103 '([(meta shift down)] org-shiftmetadown)
8104 '([(meta shift left)] org-shiftmetaleft)
8105 '([(meta shift right)] org-shiftmetaright)
8106 '([?\e (up)] org-metaup)
8107 '([?\e (down)] org-metadown)
8108 '([?\e (left)] org-metaleft)
8109 '([?\e (right)] org-metaright)
8110 '([?\e (shift up)] org-shiftmetaup)
8111 '([?\e (shift down)] org-shiftmetadown)
8112 '([?\e (shift left)] org-shiftmetaleft)
8113 '([?\e (shift right)] org-shiftmetaright)
8114 '([(shift up)] org-shiftup)
8115 '([(shift down)] org-shiftdown)
8116 '([(shift left)] org-shiftleft)
8117 '([(shift right)] org-shiftright)
8118 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8119 '("\M-q" fill-paragraph)
8120 '("\C-c^" org-sort)
8121 '("\C-c-" org-cycle-list-bullet)))
8122 elt key fun cmd)
8123 (while (setq elt (pop bindings))
8124 (setq nfunc (1+ nfunc))
8125 (setq key (org-key (car elt))
8126 fun (nth 1 elt)
8127 cmd (orgstruct-make-binding fun nfunc key))
8128 (org-defkey orgstruct-mode-map key cmd))
8130 ;; Special treatment needed for TAB and RET
8131 (org-defkey orgstruct-mode-map [(tab)]
8132 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8133 (org-defkey orgstruct-mode-map "\C-i"
8134 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8136 (org-defkey orgstruct-mode-map "\M-\C-m"
8137 (orgstruct-make-binding 'org-insert-heading 105
8138 "\M-\C-m" [(meta return)]))
8139 (org-defkey orgstruct-mode-map [(meta return)]
8140 (orgstruct-make-binding 'org-insert-heading 106
8141 [(meta return)] "\M-\C-m"))
8143 (org-defkey orgstruct-mode-map [(shift meta return)]
8144 (orgstruct-make-binding 'org-insert-todo-heading 107
8145 [(meta return)] "\M-\C-m"))
8147 (org-defkey orgstruct-mode-map "\e\C-m"
8148 (orgstruct-make-binding 'org-insert-heading 108
8149 "\e\C-m" [?\e (return)]))
8150 (org-defkey orgstruct-mode-map [?\e (return)]
8151 (orgstruct-make-binding 'org-insert-heading 109
8152 [?\e (return)] "\e\C-m"))
8153 (org-defkey orgstruct-mode-map [?\e (shift return)]
8154 (orgstruct-make-binding 'org-insert-todo-heading 110
8155 [?\e (return)] "\e\C-m"))
8157 (unless org-local-vars
8158 (setq org-local-vars (org-get-local-variables)))
8160 t))
8162 (defun orgstruct-make-binding (fun n &rest keys)
8163 "Create a function for binding in the structure minor mode.
8164 FUN is the command to call inside a table. N is used to create a unique
8165 command name. KEYS are keys that should be checked in for a command
8166 to execute outside of tables."
8167 (eval
8168 (list 'defun
8169 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8170 '(arg)
8172 "Outside of structure, run the binding of `"
8173 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8174 "'.")
8175 '(interactive "p")
8176 (list 'if
8177 `(org-context-p 'headline 'item
8178 (and orgstruct-is-++
8179 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8180 'item-body))
8181 (list 'org-run-like-in-org-mode (list 'quote fun))
8182 (list 'let '(orgstruct-mode)
8183 (list 'call-interactively
8184 (append '(or)
8185 (mapcar (lambda (k)
8186 (list 'key-binding k))
8187 keys)
8188 '('orgstruct-error))))))))
8190 (defun org-context-p (&rest contexts)
8191 "Check if local context is any of CONTEXTS.
8192 Possible values in the list of contexts are `table', `headline', and `item'."
8193 (let ((pos (point)))
8194 (goto-char (point-at-bol))
8195 (prog1 (or (and (memq 'table contexts)
8197 (and (memq 'headline contexts)
8199 (looking-at outline-regexp))
8200 (and (memq 'item contexts)
8202 (and (memq 'item-body contexts)
8203 (org-in-item-p)))
8204 (goto-char pos))))
8206 (defun org-get-local-variables ()
8207 "Return a list of all local variables in an org-mode buffer."
8208 (let (varlist)
8209 (with-current-buffer (get-buffer-create "*Org tmp*")
8210 (erase-buffer)
8211 (org-mode)
8212 (setq varlist (buffer-local-variables)))
8213 (kill-buffer "*Org tmp*")
8214 (delq nil
8215 (mapcar
8216 (lambda (x)
8217 (setq x
8218 (if (symbolp x)
8219 (list x)
8220 (list (car x) (list 'quote (cdr x)))))
8221 (if (string-match
8222 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8223 (symbol-name (car x)))
8224 x nil))
8225 varlist))))
8227 (defun org-clone-local-variables (from-buffer &optional regexp)
8228 "Clone local variables from FROM-BUFFER.
8229 Optional argument REGEXP selects variables to clone."
8230 (mapc
8231 (lambda (pair)
8232 (and (symbolp (car pair))
8233 (or (null regexp)
8234 (string-match regexp (symbol-name (car pair))))
8235 (set (make-local-variable (car pair))
8236 (cdr pair))))
8237 (buffer-local-variables from-buffer)))
8239 ;;;###autoload
8240 (defun org-run-like-in-org-mode (cmd)
8241 "Run a command, pretending that the current buffer is in Org-mode.
8242 This will temporarily bind local variables that are typically bound in
8243 Org-mode to the values they have in Org-mode, and then interactively
8244 call CMD."
8245 (org-load-modules-maybe)
8246 (unless org-local-vars
8247 (setq org-local-vars (org-get-local-variables)))
8248 (eval (list 'let org-local-vars
8249 (list 'call-interactively (list 'quote cmd)))))
8251 ;;;; Archiving
8253 (defun org-get-category (&optional pos force-refresh)
8254 "Get the category applying to position POS."
8255 (if force-refresh (org-refresh-category-properties))
8256 (let ((pos (or pos (point))))
8257 (or (get-text-property pos 'org-category)
8258 (progn (org-refresh-category-properties)
8259 (get-text-property pos 'org-category)))))
8261 (defun org-refresh-category-properties ()
8262 "Refresh category text properties in the buffer."
8263 (let ((def-cat (cond
8264 ((null org-category)
8265 (if buffer-file-name
8266 (file-name-sans-extension
8267 (file-name-nondirectory buffer-file-name))
8268 "???"))
8269 ((symbolp org-category) (symbol-name org-category))
8270 (t org-category)))
8271 beg end cat pos optionp)
8272 (org-unmodified
8273 (save-excursion
8274 (save-restriction
8275 (widen)
8276 (goto-char (point-min))
8277 (put-text-property (point) (point-max) 'org-category def-cat)
8278 (while (re-search-forward
8280 (setq pos (match-end 0)
8281 optionp (equal (char-after (match-beginning 0)) ?#)
8282 cat (org-trim (match-string 2)))
8283 (if optionp
8284 (setq beg (point-at-bol) end (point-max))
8285 (org-back-to-heading t)
8286 (setq beg (point) end (org-end-of-subtree t t)))
8287 (put-text-property beg end 'org-category cat)
8288 (goto-char pos)))))))
8291 ;;;; Link Stuff
8293 ;;; Link abbreviations
8295 (defun org-link-expand-abbrev (link)
8296 "Apply replacements as defined in `org-link-abbrev-alist."
8298 (let* ((key (match-string 1 link))
8299 (as (or (assoc key org-link-abbrev-alist-local)
8300 (assoc key org-link-abbrev-alist)))
8301 (tag (and (match-end 2) (match-string 3 link)))
8302 rpl)
8303 (if (not as)
8304 link
8305 (setq rpl (cdr as))
8306 (cond
8307 ((symbolp rpl) (funcall rpl tag))
8308 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8309 ((string-match "%h" rpl)
8310 (replace-match (url-hexify-string (or tag "")) t t rpl))
8311 (t (concat rpl tag)))))
8312 link))
8314 ;;; Storing and inserting links
8316 (defvar org-insert-link-history nil
8317 "Minibuffer history for links inserted with `org-insert-link'.")
8319 (defvar org-stored-links nil
8320 "Contains the links stored with `org-store-link'.")
8322 (defvar org-store-link-plist nil
8323 "Plist with info about the most recently link created with `org-store-link'.")
8325 (defvar org-link-protocols nil
8326 "Link protocols added to Org-mode using `org-add-link-type'.")
8328 (defvar org-store-link-functions nil
8329 "List of functions that are called to create and store a link.
8330 Each function will be called in turn until one returns a non-nil
8331 value. Each function should check if it is responsible for creating
8332 this link (for example by looking at the major mode).
8333 If not, it must exit and return nil.
8334 If yes, it should return a non-nil value after a calling
8335 `org-store-link-props' with a list of properties and values.
8336 Special properties are:
8340 This is obligatory as well.
8341 :description Optional default description for the second pair
8342 of brackets in an Org-mode link. The user can still change
8343 this when inserting this link into an Org-mode buffer.
8345 In addition to these, any additional properties can be specified
8346 and then used in remember templates.")
8348 (defun org-add-link-type (type &optional follow export)
8349 "Add TYPE to the list of `org-link-types'.
8350 Re-compute all regular expressions depending on `org-link-types'
8352 FOLLOW and EXPORT are two functions.
8354 FOLLOW should take the link path as the single argument and do whatever
8355 is necessary to follow the link, for example find a file or display
8356 a mail message.
8358 EXPORT should format the link path for export to one of the export formats.
8359 It should be a function accepting three arguments:
8362 desc the description of the link, if any, or a description added by
8363 org-export-normalize-links if there is none
8364 format the export format, a symbol like `html' or `latex' or `ascii'..
8366 The function may use the FORMAT information to return different values
8367 depending on the format. The return value will be put literally into
8368 the exported file. If the return value is nil, this means Org should
8369 do what it normally does with links which do not have EXPORT defined.
8371 Org-mode has a built-in default for exporting links. If you are happy with
8372 this default, there is no need to define an export function for the link
8373 type. For a simple example of an export function, see `org-bbdb.el'."
8374 (add-to-list 'org-link-types type t)
8375 (org-make-link-regexps)
8376 (if (assoc type org-link-protocols)
8377 (setcdr (assoc type org-link-protocols) (list follow export))
8378 (push (list type follow export) org-link-protocols)))
8380 (defvar org-agenda-buffer-name)
8382 ;;;###autoload
8383 (defun org-store-link (arg)
8385 This link is added to `org-stored-links' and can later be inserted
8388 For some link types, a prefix arg is interpreted:
8389 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8390 For file links, arg negates `org-context-in-file-links'."
8391 (interactive "P")
8392 (org-load-modules-maybe)
8393 (setq org-store-link-plist nil) ; reset
8394 (org-with-limited-levels
8395 (let (link cpltxt desc description search txt custom-id agenda-link)
8396 (cond
8398 ((run-hook-with-args-until-success 'org-store-link-functions)
8399 (setq link (plist-get org-store-link-plist :link)
8400 desc (or (plist-get org-store-link-plist :description) link)))
8402 ((equal (buffer-name) "*Org Edit Src Example*")
8403 (let (label gc)
8404 (while (or (not label)
8405 (save-excursion
8406 (save-restriction
8407 (widen)
8408 (goto-char (point-min))
8409 (re-search-forward
8410 (regexp-quote (format org-coderef-label-format label))
8411 nil t))))
8412 (when label (message "Label exists already") (sit-for 2))
8413 (setq label (read-string "Code line label: " label)))
8414 (end-of-line 1)
8415 (setq link (format org-coderef-label-format label))
8416 (setq gc (- 79 (length link)))
8417 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8418 (insert link)
8419 (setq link (concat "(" label ")") desc nil)))
8421 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8422 ;; We are in the agenda, link to referenced location
8423 (let ((m (or (get-text-property (point) 'org-hd-marker)
8424 (get-text-property (point) 'org-marker))))
8425 (when m
8426 (org-with-point-at m
8427 (setq agenda-link
8428 (if (interactive-p)
8429 (call-interactively 'org-store-link)
8430 (org-store-link nil)))))))
8432 ((eq major-mode 'calendar-mode)
8433 (let ((cd (calendar-cursor-to-date)))
8434 (setq link
8435 (format-time-string
8436 (car org-time-stamp-formats)
8437 (apply 'encode-time
8438 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8439 nil nil nil))))
8440 (org-store-link-props :type "calendar" :date cd)))
8442 ((eq major-mode 'w3-mode)
8443 (setq cpltxt (if (and (buffer-name)
8444 (not (string-match "Untitled" (buffer-name))))
8445 (buffer-name)
8446 (url-view-url t))
8447 link (org-make-link (url-view-url t)))
8448 (org-store-link-props :type "w3" :url (url-view-url t)))
8450 ((eq major-mode 'w3m-mode)
8451 (setq cpltxt (or w3m-current-title w3m-current-url)
8452 link (org-make-link w3m-current-url))
8453 (org-store-link-props :type "w3m" :url (url-view-url t)))
8455 ((setq search (run-hook-with-args-until-success
8456 'org-create-file-search-functions))
8457 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8458 "::" search))
8459 (setq cpltxt (or description link)))
8461 ((eq major-mode 'image-mode)
8462 (setq cpltxt (concat "file:"
8463 (abbreviate-file-name buffer-file-name))
8464 link (org-make-link cpltxt))
8465 (org-store-link-props :type "image" :file buffer-file-name))
8467 ((eq major-mode 'dired-mode)
8468 ;; link to the file in the current line
8469 (let ((file (dired-get-filename nil t)))
8470 (setq file (if file
8471 (abbreviate-file-name
8472 (expand-file-name (dired-get-filename nil t)))
8473 ;; otherwise, no file so use current directory.
8474 default-directory))
8475 (setq cpltxt (concat "file:" file)
8476 link (org-make-link cpltxt))))
8478 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8479 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8480 (cond
8482 (setq cpltxt
8483 (concat "file:"
8484 (abbreviate-file-name
8485 (buffer-file-name (buffer-base-buffer)))
8486 "::" (match-string 1))
8487 link (org-make-link cpltxt)))
8488 ((and (featurep 'org-id)
8489 (or (eq org-link-to-org-use-id t)
8490 (and (eq org-link-to-org-use-id 'create-if-interactive)
8491 (interactive-p))
8492 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8493 (interactive-p)
8494 (not custom-id))
8495 (and org-link-to-org-use-id
8496 (org-entry-get nil "ID"))))
8497 ;; We can make a link using the ID.
8498 (setq link (condition-case nil
8499 (prog1 (org-id-store-link)
8500 (setq desc (plist-get org-store-link-plist
8501 :description)))
8502 (error
8503 ;; probably before first headline, link to file only
8504 (concat "file:"
8505 (abbreviate-file-name
8506 (buffer-file-name (buffer-base-buffer))))))))
8507 (t
8508 ;; Just link to current headline
8509 (setq cpltxt (concat "file:"
8510 (abbreviate-file-name
8511 (buffer-file-name (buffer-base-buffer)))))
8512 ;; Add a context search string
8513 (when (org-xor org-context-in-file-links arg)
8514 (setq txt (cond
8515 ((org-on-heading-p) nil)
8516 ((org-region-active-p)
8517 (buffer-substring (region-beginning) (region-end)))
8518 (t nil)))
8520 (setq cpltxt
8521 (concat cpltxt "::"
8522 (condition-case nil
8523 (org-make-org-heading-search-string txt)
8524 (error "")))
8525 desc (or (nth 4 (ignore-errors
8526 (org-heading-components))) "NONE"))))
8528 (setq cpltxt (substring cpltxt 0 -2)))
8529 (setq link (org-make-link cpltxt)))))
8531 ((buffer-file-name (buffer-base-buffer))
8532 ;; Just link to this file here.
8533 (setq cpltxt (concat "file:"
8534 (abbreviate-file-name
8535 (buffer-file-name (buffer-base-buffer)))))
8536 ;; Add a context string
8537 (when (org-xor org-context-in-file-links arg)
8538 (setq txt (if (org-region-active-p)
8539 (buffer-substring (region-beginning) (region-end))
8540 (buffer-substring (point-at-bol) (point-at-eol))))
8541 ;; Only use search option if there is some text.
8543 (setq cpltxt
8544 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8545 desc "NONE")))
8546 (setq link (org-make-link cpltxt)))
8548 ((interactive-p)
8549 (error "Cannot link to a buffer which is not visiting a file"))
8551 (t (setq link nil)))
8553 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8554 (setq link (or link cpltxt)
8555 desc (or desc cpltxt))
8556 (if (equal desc "NONE") (setq desc nil))
8558 (if (and (or (interactive-p) executing-kbd-macro) link)
8559 (progn
8560 (setq org-stored-links
8561 (cons (list link desc) org-stored-links))
8562 (message "Stored: %s" (or desc link))
8563 (when custom-id
8564 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8565 "::#" custom-id))
8566 (setq org-stored-links
8567 (cons (list link desc) org-stored-links))))
8568 (or agenda-link (and link (org-make-link-string link desc)))))))
8570 (defun org-store-link-props (&rest plist)
8571 "Store link properties, extract names and addresses."
8572 (let (x adr)
8573 (when (setq x (plist-get plist :from))
8574 (setq adr (mail-extract-address-components x))
8575 (setq plist (plist-put plist :fromname (car adr)))
8576 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8577 (when (setq x (plist-get plist :to))
8578 (setq adr (mail-extract-address-components x))
8579 (setq plist (plist-put plist :toname (car adr)))
8580 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8581 (let ((from (plist-get plist :from))
8582 (to (plist-get plist :to)))
8583 (when (and from to org-from-is-user-regexp)
8584 (setq plist
8585 (plist-put plist :fromto
8586 (if (string-match org-from-is-user-regexp from)
8587 (concat "to %t")
8588 (concat "from %f"))))))
8589 (setq org-store-link-plist plist))
8591 (defun org-add-link-props (&rest plist)
8592 "Add these properties to the link property list."
8593 (let (key value)
8594 (while plist
8595 (setq key (pop plist) value (pop plist))
8596 (setq org-store-link-plist
8597 (plist-put org-store-link-plist key value)))))
8599 (defun org-email-link-description (&optional fmt)
8600 "Return the description part of an email link.
8601 This takes information from `org-store-link-plist' and formats it
8602 according to FMT (default from `org-email-link-description-format')."
8603 (setq fmt (or fmt org-email-link-description-format))
8604 (let* ((p org-store-link-plist)
8605 (to (plist-get p :toaddress))
8606 (from (plist-get p :fromaddress))
8607 (table
8608 (list
8609 (cons "%c" (plist-get p :fromto))
8610 (cons "%F" (plist-get p :from))
8611 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8612 (cons "%T" (plist-get p :to))
8613 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8614 (cons "%s" (plist-get p :subject))
8615 (cons "%d" (plist-get p :date))
8616 (cons "%m" (plist-get p :message-id)))))
8617 (when (string-match "%c" fmt)
8618 ;; Check if the user wrote this message
8619 (if (and org-from-is-user-regexp from to
8620 (save-match-data (string-match org-from-is-user-regexp from)))
8621 (setq fmt (replace-match "to %t" t t fmt))
8622 (setq fmt (replace-match "from %f" t t fmt))))
8623 (org-replace-escapes fmt table)))
8625 (defun org-make-org-heading-search-string (&optional string heading)
8626 "Make search string for STRING or current headline."
8627 (interactive)
8628 (let ((s (or string (org-get-heading)))
8629 (lines org-context-in-file-links))
8630 (unless (and string (not heading))
8631 ;; We are using a headline, clean up garbage in there.
8632 (if (string-match org-todo-regexp s)
8633 (setq s (replace-match "" t t s)))
8635 (setq s (replace-match "" t t s)))
8636 (setq s (org-trim s))
8639 (setq s (replace-match "" t t s)))
8640 (while (string-match org-ts-regexp s)
8641 (setq s (replace-match "" t t s))))
8642 (or string (setq s (concat "*" s))) ; Add * for headlines
8643 (when (and string (integerp lines) (> lines 0))
8645 (when (< lines (length slines))
8646 (setq s (mapconcat
8647 'identity
8648 (reverse (nthcdr (- (length slines) lines)
8652 (defun org-make-link (&rest strings)
8653 "Concatenate STRINGS."
8654 (apply 'concat strings))
8656 (defun org-make-link-string (link &optional description)
8657 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8659 (error "Empty link"))
8660 (when (and description
8661 (stringp description)
8663 (setq description nil))
8664 (when (stringp description)
8665 ;; Remove brackets from the description, they are fatal.
8667 (setq description (replace-match "{" t t description)))
8669 (setq description (replace-match "}" t t description))))
8670 (when (equal (org-link-escape link) description)
8671 ;; No description needed, it is identical
8672 (setq description nil))
8673 (when (and (not description)
8674 (not (equal link (org-link-escape link))))
8675 (setq description (org-extract-attributes link)))
8676 (setq link (if (string-match org-link-types-re link)
8677 (concat (match-string 1 link)
8678 (org-link-escape (substring link (match-end 1))))
8679 (org-link-escape link)))
8680 (concat "[[" link "]"
8681 (if description (concat "[" description "]") "")
8682 "]"))
8684 (defconst org-link-escape-chars
8685 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8686 "List of characters that should be escaped in link.
8687 This is the list that is used for internal purposes.")
8689 (defvar org-url-encoding-use-url-hexify nil)
8691 (defconst org-link-escape-chars-browser
8692 '(?\ )
8693 "List of escapes for characters that are problematic in links.
8694 This is the list that is used before handing over to the browser.")
8696 (defun org-link-escape (text &optional table merge)
8697 "Return percent escaped representation of TEXT.
8698 TEXT is a string with the text to escape.
8699 Optional argument TABLE is a list with characters that should be
8700 escaped. When nil, `org-link-escape-chars' is used.
8701 If optional argument MERGE is set, merge TABLE into
8702 `org-link-escape-chars'."
8703 (if (and org-url-encoding-use-url-hexify (not table))
8704 (url-hexify-string text)
8705 (cond
8706 ((and table merge)
8707 (mapc (lambda (defchr)
8708 (unless (member defchr table)
8709 (setq table (cons defchr table)))) org-link-escape-chars))
8710 ((null table)
8711 (setq table org-link-escape-chars)))
8712 (mapconcat
8713 (lambda (char)
8714 (if (or (member char table)
8715 (< char 32) (= char 37) (> char 126))
8716 (mapconcat (lambda (sequence-element)
8717 (format "%%%.2X" sequence-element))
8718 (or (encode-coding-char char 'utf-8)
8719 (error "Unable to percent escape character: %s"
8720 (char-to-string char))) "")
8721 (char-to-string char))) text "")))
8723 (defun org-link-unescape (str)
8724 "Unhex hexified unicode strings as returned from the JavaScript function
8725 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8726 (unless (and (null str) (string= "" str))
8727 (let ((pos 0) (case-fold-search t) unhexed)
8729 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8730 (setq str (replace-match unhexed t t str))
8731 (setq pos (+ pos (length unhexed))))))
8732 str)
8734 (defun org-link-unescape-compound (hex)
8735 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8736 Note: this function also decodes single byte encodings like
8738 (save-match-data
8739 (let* ((bytes (cdr (split-string hex "%")))
8740 (ret "")
8741 (eat 0)
8742 (sum 0))
8743 (while bytes
8744 (let* ((val (string-to-number (pop bytes) 16))
8745 (shift-xor
8746 (if (= 0 eat)
8747 (cond
8748 ((>= val 252) (cons 6 252))
8749 ((>= val 248) (cons 5 248))
8750 ((>= val 240) (cons 4 240))
8751 ((>= val 224) (cons 3 224))
8752 ((>= val 192) (cons 2 192))
8753 (t (cons 0 0)))
8754 (cons 6 128))))
8755 (if (>= val 192) (setq eat (car shift-xor)))
8756 (setq val (logxor val (cdr shift-xor)))
8757 (setq sum (+ (lsh sum (car shift-xor)) val))
8758 (if (> eat 0) (setq eat (- eat 1)))
8759 (cond
8760 ((= 0 eat) ;multi byte
8761 (setq ret (concat ret (org-char-to-string sum)))
8762 (setq sum 0))
8763 ((not bytes) ; single byte(s)
8764 (setq ret (org-link-unescape-single-byte-sequence hex))))
8765 )) ;; end (while bytes
8766 ret )))
8768 (defun org-link-unescape-single-byte-sequence (hex)
8769 "Unhexify hex-encoded single byte character sequences."
8770 (mapconcat (lambda (byte)
8771 (char-to-string (string-to-number byte 16)))
8772 (cdr (split-string hex "%")) ""))
8774 (defun org-xor (a b)
8775 "Exclusive or."
8776 (if a (not b) b))
8778 (defun org-fixup-message-id-for-http (s)
8779 "Replace special characters in a message id, so it can be used in an http query."
8780 (when (string-match "%" s)
8781 (setq s (mapconcat (lambda (c)
8782 (if (eq c ?%)
8783 "%25"
8784 (char-to-string c)))
8785 s "")))
8786 (while (string-match "<" s)
8787 (setq s (replace-match "%3C" t t s)))
8788 (while (string-match ">" s)
8789 (setq s (replace-match "%3E" t t s)))
8790 (while (string-match "@" s)
8791 (setq s (replace-match "%40" t t s)))
8792 s)
8794 ;;;###autoload
8795 (defun org-insert-link-global ()
8796 "Insert a link like Org-mode does.
8797 This command can be called in any mode to insert a link in Org-mode syntax."
8798 (interactive)
8799 (org-load-modules-maybe)
8800 (org-run-like-in-org-mode 'org-insert-link))
8802 (defun org-insert-link (&optional complete-file link-location)
8803 "Insert a link. At the prompt, enter the link.
8805 Completion can be used to insert any of the link protocol prefixes like
8806 http or ftp in use.
8808 The history can be used to select a link previously stored with
8809 `org-store-link'. When the empty string is entered (i.e. if you just
8810 press RET at the prompt), the link defaults to the most recently
8811 stored link. As SPC triggers completion in the minibuffer, you need to
8812 use M-SPC or C-q SPC to force the insertion of a space character.
8814 You will also be prompted for a description, and if one is given, it will
8815 be displayed in the buffer instead of the link.
8817 If there is already a link at point, this command will allow you to edit link
8818 and description parts.
8821 be selected using completion. The path to the file will be relative to the
8822 current directory if the file is in the current directory or a subdirectory.
8823 Otherwise, the link will be the absolute path as completed in the minibuffer
8824 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8825 option `org-link-file-path-type'.
8828 the current directory or below.
8831 `org-keep-stored-link-after-insertion'.
8833 If `org-make-link-description-function' is non-nil, this function will be
8834 called with the link target, and the result will be the default
8835 link description.
8837 If the LINK-LOCATION parameter is non-nil, this value will be
8838 used as the link location instead of reading one interactively."
8839 (interactive "P")
8840 (let* ((wcf (current-window-configuration))
8841 (region (if (org-region-active-p)
8842 (buffer-substring (region-beginning) (region-end))))
8843 (remove (and region (list (region-beginning) (region-end))))
8844 (desc region)
8845 tmphist ; byte-compile incorrectly complains about this
8846 (link link-location)
8847 entry file all-prefixes)
8848 (cond
8849 (link-location) ; specified by arg, just use it.
8850 ((org-in-regexp org-bracket-link-regexp 1)
8851 ;; We do have a link at point, and we are going to edit it.
8852 (setq remove (list (match-beginning 0) (match-end 0)))
8853 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8854 (setq link (read-string "Link: "
8855 (org-link-unescape
8856 (org-match-string-no-properties 1)))))
8857 ((or (org-in-regexp org-angle-link-re)
8858 (org-in-regexp org-plain-link-re))
8859 ;; Convert to bracket link
8860 (setq remove (list (match-beginning 0) (match-end 0))
8861 link (read-string "Link: "
8862 (org-remove-angle-brackets (match-string 0)))))
8863 ((member complete-file '((4) (16)))
8864 ;; Completing read for file names.
8865 (setq link (org-file-complete-link complete-file)))
8866 (t
8867 ;; Read link, with completion for stored links.
8868 (with-output-to-temp-buffer "*Org Links*"
8869 (princ "Insert a link.
8871 (when org-stored-links
8873 (princ (mapconcat
8874 (lambda (x)
8875 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8877 (let ((cw (selected-window)))
8878 (select-window (get-buffer-window "*Org Links*" 'visible))
8879 (setq truncate-lines t)
8880 (unless (pos-visible-in-window-p (point-max))
8881 (org-fit-window-to-buffer))
8882 (and (window-live-p cw) (select-window cw)))
8883 ;; Fake a link history, containing the stored links.
8884 (setq tmphist (append (mapcar 'car org-stored-links)
8885 org-insert-link-history))
8886 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8887 (mapcar 'car org-link-abbrev-alist)
8888 org-link-types))
8889 (unwind-protect
8890 (progn
8891 (setq link
8892 (let ((org-completion-use-ido nil)
8893 (org-completion-use-iswitchb nil))
8894 (org-completing-read
8895 "Link: "
8896 (append
8897 (mapcar (lambda (x) (list (concat x ":")))
8898 all-prefixes)
8899 (mapcar 'car org-stored-links))
8900 nil nil nil
8901 'tmphist
8902 (car (car org-stored-links)))))
8904 (error "No link selected"))
8905 (if (or (member link all-prefixes)
8906 (and (equal ":" (substring link -1))
8907 (member (substring link 0 -1) all-prefixes)
8908 (setq link (substring link 0 -1))))
8909 (setq link (org-link-try-special-completion link))))
8910 (set-window-configuration wcf)
8911 (kill-buffer "*Org Links*"))
8912 (setq entry (assoc link org-stored-links))
8913 (or entry (push link org-insert-link-history))
8914 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8915 (not org-keep-stored-link-after-insertion))
8916 (setq org-stored-links (delq (assoc link org-stored-links)
8917 org-stored-links)))
8918 (setq desc (or desc (nth 1 entry)))))
8920 (if (string-match org-plain-link-re link)
8921 ;; URL-like link, normalize the use of angular brackets.
8922 (setq link (org-make-link (org-remove-angle-brackets link))))
8924 ;; Check if we are linking to the current file with a search option
8925 ;; If yes, simplify the link by using only the search option.
8926 (when (and buffer-file-name
8928 (let* ((path (match-string 1 link))
8929 (case-fold-search nil)
8930 (search (match-string 2 link)))
8931 (save-match-data
8932 (if (equal (file-truename buffer-file-name) (file-truename path))
8933 ;; We are linking to this same file, with a search option
8934 (setq link search)))))
8936 ;; Check if we can/should use a relative path. If yes, simplify the link
8938 (let* ((type (match-string 1 link))
8939 (path (match-string 2 link))
8940 (origpath path)
8941 (case-fold-search nil))
8942 (cond
8943 ((or (eq org-link-file-path-type 'absolute)
8944 (equal complete-file '(16)))
8945 (setq path (abbreviate-file-name (expand-file-name path))))
8946 ((eq org-link-file-path-type 'noabbrev)
8947 (setq path (expand-file-name path)))
8948 ((eq org-link-file-path-type 'relative)
8949 (setq path (file-relative-name path)))
8950 (t
8951 (save-match-data
8952 (if (string-match (concat "^" (regexp-quote
8953 (expand-file-name
8954 (file-name-as-directory
8955 default-directory))))
8956 (expand-file-name path))
8957 ;; We are linking a file with relative path name.
8958 (setq path (substring (expand-file-name path)
8959 (match-end 0)))
8960 (setq path (abbreviate-file-name (expand-file-name path)))))))
8961 (setq link (concat type path))
8962 (if (equal desc origpath)
8963 (setq desc path))))
8965 (if org-make-link-description-function
8966 (setq desc (funcall org-make-link-description-function link desc)))
8968 (setq desc (read-string "Description: " desc))
8970 (if remove (apply 'delete-region remove))
8971 (insert (org-make-link-string link desc))))
8973 (defun org-link-try-special-completion (type)
8974 "If there is completion support for link type TYPE, offer it."
8975 (let ((fun (intern (concat "org-" type "-complete-link"))))
8976 (if (functionp fun)
8977 (funcall fun)
8978 (read-string "Link (no completion support): " (concat type ":")))))
8980 (defun org-file-complete-link (&optional arg)
8981 "Create a file link using completion."
8982 (let (file link)
8983 (setq file (read-file-name "File: "))
8984 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8985 (pwd1 (file-name-as-directory (abbreviate-file-name
8986 (expand-file-name ".")))))
8987 (cond
8988 ((equal arg '(16))
8989 (setq link (org-make-link
8990 "file:"
8991 (abbreviate-file-name (expand-file-name file)))))
8993 (setq link (org-make-link "file:" (match-string 1 file))))
8995 (expand-file-name file))
8996 (setq link (org-make-link
8997 "file:" (match-string 1 (expand-file-name file)))))
8998 (t (setq link (org-make-link "file:" file)))))
8999 link))
9001 (defun org-completing-read (&rest args)
9002 "Completing-read with SPACE being a normal character."
9003 (let ((minibuffer-local-completion-map
9004 (copy-keymap minibuffer-local-completion-map)))
9005 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9006 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9007 (apply 'org-icompleting-read args)))
9009 (defun org-completing-read-no-i (&rest args)
9010 (let (org-completion-use-ido org-completion-use-iswitchb)
9011 (apply 'org-completing-read args)))
9013 (defun org-iswitchb-completing-read (prompt choices &rest args)
9014 "Use iswitch as a completing-read replacement to choose from choices.
9015 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9016 from."
9017 (let* ((iswitchb-use-virtual-buffers nil)
9018 (iswitchb-make-buflist-hook
9019 (lambda ()
9020 (setq iswitchb-temp-buflist choices))))
9021 (iswitchb-read-buffer prompt)))
9023 (defun org-icompleting-read (&rest args)
9024 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9025 (org-without-partial-completion
9026 (if (and org-completion-use-ido
9027 (fboundp 'ido-completing-read)
9028 (boundp 'ido-mode) ido-mode
9029 (listp (second args)))
9030 (let ((ido-enter-matching-directory nil))
9031 (apply 'ido-completing-read (concat (car args))
9032 (if (consp (car (nth 1 args)))
9033 (mapcar 'car (nth 1 args))
9034 (nth 1 args))
9035 (cddr args)))
9036 (if (and org-completion-use-iswitchb
9037 (boundp 'iswitchb-mode) iswitchb-mode
9038 (listp (second args)))
9039 (apply 'org-iswitchb-completing-read (concat (car args))
9040 (if (consp (car (nth 1 args)))
9041 (mapcar 'car (nth 1 args))
9042 (nth 1 args))
9043 (cddr args))
9044 (apply 'completing-read args)))))
9046 (defun org-extract-attributes (s)
9047 "Extract the attributes cookie from a string and set as text property."
9048 (let (a attr (start 0) key value)
9049 (save-match-data
9051 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9053 (setq key (match-string 1 a) value (match-string 2 a)
9054 start (match-end 0)
9055 attr (plist-put attr (intern key) value))))
9056 (org-add-props s nil 'org-attr attr))
9057 s))
9059 (defun org-extract-attributes-from-string (tag)
9060 (let (key value attr)
9062 (setq key (match-string 1 tag) value (match-string 2 tag)
9063 tag (replace-match "" t t tag)
9064 attr (plist-put attr (intern key) value)))
9065 (cons tag attr)))
9067 (defun org-attributes-to-string (plist)
9068 "Format a property list into an HTML attribute list."
9069 (let ((s "") key value)
9070 (while plist
9071 (setq key (pop plist) value (pop plist))
9072 (and value
9074 s))
9076 ;;; Opening/following a link
9078 (defvar org-link-search-failed nil)
9080 (defvar org-open-link-functions nil
9081 "Hook for functions finding a plain text link.
9082 These functions must take a single argument, the link content.
9083 They will be called for links that look like [[link text][description]]
9087 These functions will be called *before* Org attempts to resolve the
9088 link by doing text searches in the current buffer - so if you want a
9090 handle this as a special case.
9092 When the function does handle the link, it must return a non-nil value.
9093 If it decides that it is not responsible for this link, it must return
9094 nil to indicate that that Org-mode can continue with other options
9095 like exact and fuzzy text search.")
9097 (defun org-next-link ()
9098 "Move forward to the next link.
9099 If the link is in hidden text, expose it."
9100 (interactive)
9101 (when (and org-link-search-failed (eq this-command last-command))
9102 (goto-char (point-min))
9103 (message "Link search wrapped back to beginning of buffer"))
9104 (setq org-link-search-failed nil)
9105 (let* ((pos (point))
9106 (ct (org-context))
9107 (a (assoc :link ct)))
9108 (if a (goto-char (nth 2 a)))
9109 (if (re-search-forward org-any-link-re nil t)
9110 (progn
9111 (goto-char (match-beginning 0))
9112 (if (outline-invisible-p) (org-show-context)))
9113 (goto-char pos)
9114 (setq org-link-search-failed t)
9115 (error "No further link found"))))
9117 (defun org-previous-link ()
9118 "Move backward to the previous link.
9119 If the link is in hidden text, expose it."
9120 (interactive)
9121 (when (and org-link-search-failed (eq this-command last-command))
9122 (goto-char (point-max))
9123 (message "Link search wrapped back to end of buffer"))
9124 (setq org-link-search-failed nil)
9125 (let* ((pos (point))
9126 (ct (org-context))
9127 (a (assoc :link ct)))
9128 (if a (goto-char (nth 1 a)))
9129 (if (re-search-backward org-any-link-re nil t)
9130 (progn
9131 (goto-char (match-beginning 0))
9132 (if (outline-invisible-p) (org-show-context)))
9133 (goto-char pos)
9134 (setq org-link-search-failed t)
9135 (error "No further link found"))))
9137 (defun org-translate-link (s)
9138 "Translate a link string if a translation function has been defined."
9139 (if (and org-link-translation-function
9140 (fboundp org-link-translation-function)
9142 (progn
9143 (setq s (funcall org-link-translation-function
9144 (match-string 1) (match-string 2)))
9145 (concat (car s) ":" (cdr s)))
9146 s))
9148 (defun org-translate-link-from-planner (type path)
9149 "Translate a link from Emacs Planner syntax so that Org can follow it.
9150 This is still an experimental function, your mileage may vary."
9151 (cond
9152 ((member type '("http" "https" "news" "ftp"))
9153 ;; standard Internet links are the same.
9154 nil)
9155 ((and (equal type "irc") (string-match "^//" path))
9156 ;; Planner has two / at the beginning of an irc link, we have 1.
9157 ;; We should have zero, actually....
9158 (setq path (substring path 1)))
9159 ((and (equal type "lisp") (string-match "^/" path))
9160 ;; Planner has a slash, we do not.
9161 (setq type "elisp" path (substring path 1)))
9163 ;; A typical message link. Planner has the id after the final slash,
9164 ;; we separate it with a hash mark
9165 (setq path (concat (match-string 1 path) "#"
9166 (org-remove-angle-brackets (match-string 2 path)))))
9167 )
9168 (cons type path))
9170 (defun org-find-file-at-mouse (ev)
9171 "Open file link or URL at mouse."
9172 (interactive "e")
9173 (mouse-set-point ev)
9174 (org-open-at-point 'in-emacs))
9176 (defun org-open-at-mouse (ev)
9177 "Open file link or URL at mouse."
9178 (interactive "e")
9179 (mouse-set-point ev)
9180 (if (eq major-mode 'org-agenda-mode)
9181 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9182 (org-open-at-point))
9184 (defvar org-window-config-before-follow-link nil
9185 "The window configuration before following a link.
9186 This is saved in case the need arises to restore it.")
9188 (defvar org-open-link-marker (make-marker)
9189 "Marker pointing to the location where `org-open-at-point; was called.")
9191 ;;;###autoload
9192 (defun org-open-at-point-global ()
9193 "Follow a link like Org-mode does.
9194 This command can be called in any mode to follow a link that has
9195 Org-mode syntax."
9196 (interactive)
9197 (org-run-like-in-org-mode 'org-open-at-point))
9199 ;;;###autoload
9200 (defun org-open-link-from-string (s &optional arg reference-buffer)
9201 "Open a link in the string S, as if it was in Org-mode."
9203 (let ((reference-buffer (or reference-buffer (current-buffer))))
9204 (with-temp-buffer
9205 (let ((org-inhibit-startup t))
9206 (org-mode)
9207 (insert s)
9208 (goto-char (point-min))
9209 (when reference-buffer
9210 (setq org-link-abbrev-alist-local
9211 (with-current-buffer reference-buffer
9212 org-link-abbrev-alist-local)))
9213 (org-open-at-point arg reference-buffer)))))
9215 (defvar org-open-at-point-functions nil
9216 "Hook that is run when following a link at point.
9218 Functions in this hook must return t if they identify and follow
9219 a link at point. If they don't find anything interesting at point,
9220 they must return nil.")
9222 (defun org-open-at-point (&optional arg reference-buffer)
9223 "Open link at or after point.
9224 If there is no link at point, this function will search forward up to
9225 the end of the current line.
9226 Normally, files will be opened by an appropriate application. If the
9227 optional prefix argument ARG is non-nil, Emacs will visit the file.
9228 With a double prefix argument, try to open outside of Emacs, in the
9229 application the system uses for this file type."
9230 (interactive "P")
9231 ;; if in a code block, then open the block's results
9232 (unless (call-interactively #'org-babel-open-src-block-result)
9233 (org-load-modules-maybe)
9234 (move-marker org-open-link-marker (point))
9235 (setq org-window-config-before-follow-link (current-window-configuration))
9236 (org-remove-occur-highlights nil nil t)
9237 (cond
9238 ((and (org-on-heading-p)
9239 (not (org-in-regexp
9244 (not (get-text-property (point) 'org-linked-text)))
9245 (or (org-offer-links-in-entry arg)
9246 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9247 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9248 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9249 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9250 (not (org-in-regexp org-bracket-link-regexp)))
9251 (org-footnote-action))
9252 (t
9253 (let (type path link line search (pos (point)))
9254 (catch 'match
9255 (save-excursion
9257 (when (org-in-regexp org-bracket-link-regexp 1)
9258 (setq link (org-extract-attributes
9259 (org-link-unescape (org-match-string-no-properties 1))))
9261 (setq link (replace-match " " t t link)))
9262 (setq link (org-link-expand-abbrev link))
9263 (cond
9264 ((or (file-name-absolute-p link)
9266 (setq type "file" path link))
9267 ((string-match org-link-re-with-space3 link)
9268 (setq type (match-string 1 link) path (match-string 2 link)))
9269 (t (setq type "thisfile" path link)))
9270 (throw 'match t)))
9272 (when (get-text-property (point) 'org-linked-text)
9273 (setq type "thisfile"
9274 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9275 (1+ (point)) (point))
9276 path (buffer-substring
9277 (or (previous-single-property-change pos 'org-linked-text)
9278 (point-min))
9279 (or (next-single-property-change pos 'org-linked-text)
9280 (point-max))))
9281 (throw 'match t))
9283 (save-excursion
9284 (when (or (org-in-regexp org-angle-link-re)
9285 (org-in-regexp org-plain-link-re))
9286 (setq type (match-string 1) path (match-string 2))
9287 (throw 'match t)))
9288 (save-excursion
9290 (setq type "tags"
9291 path (match-string 1))
9292 (while (string-match ":" path)
9293 (setq path (replace-match "+" t t path)))
9294 (throw 'match t)))
9296 (setq type "tree-match"
9297 path (match-string 1))
9298 (throw 'match t)))
9299 (unless path
9300 (error "No link found"))
9302 ;; switch back to reference buffer
9303 ;; needed when if called in a temporary buffer through
9304 ;; org-open-link-from-string
9305 (with-current-buffer (or reference-buffer (current-buffer))
9307 ;; Remove any trailing spaces in path
9309 (setq path (replace-match "" t t path)))
9310 (if (and org-link-translation-function
9311 (fboundp org-link-translation-function))
9312 ;; Check if we need to translate the link
9313 (let ((tmp (funcall org-link-translation-function type path)))
9314 (setq type (car tmp) path (cdr tmp))))
9316 (cond
9318 ((assoc type org-link-protocols)
9319 (funcall (nth 1 (assoc type org-link-protocols)) path))
9321 ((equal type "mailto")
9322 (let ((cmd (car org-link-mailto-program))
9323 (args (cdr org-link-mailto-program)) args1
9324 (address path) (subject "") a)
9326 (setq address (match-string 1 path)
9327 subject (org-link-escape (match-string 2 path))))
9328 (while args
9329 (cond
9330 ((not (stringp (car args))) (push (pop args) args1))
9331 (t (setq a (pop args))
9332 (if (string-match "%a" a)
9333 (setq a (replace-match address t t a)))
9334 (if (string-match "%s" a)
9335 (setq a (replace-match subject t t a)))
9336 (push a args1))))
9337 (apply cmd (nreverse args1))))
9339 ((member type '("http" "https" "ftp" "news"))
9340 (browse-url (concat type ":" (org-link-escape
9341 path org-link-escape-chars-browser))))
9343 ((string= type "doi")
9344 (browse-url (concat "http://dx.doi.org/"
9345 (org-link-escape
9346 path org-link-escape-chars-browser))))
9348 ((member type '("message"))
9349 (browse-url (concat type ":" path)))
9351 ((string= type "tags")
9352 (org-tags-view arg path))
9354 ((string= type "tree-match")
9357 ((string= type "file")
9359 (setq line (string-to-number (match-string 1 path))
9360 path (substring path 0 (match-beginning 0)))
9362 (setq search (match-string 1 path)
9363 path (substring path 0 (match-beginning 0)))))
9364 (if (string-match "[*?{]" (file-name-nondirectory path))
9365 (dired path)
9366 (org-open-file path arg line search)))
9368 ((string= type "shell")
9369 (let ((cmd path))
9370 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9371 (string-match org-confirm-shell-link-not-regexp cmd))
9372 (not org-confirm-shell-link-function)
9373 (funcall org-confirm-shell-link-function
9375 (org-add-props cmd nil
9376 'face 'org-warning))))
9377 (progn
9378 (message "Executing %s" cmd)
9379 (shell-command cmd))
9380 (error "Abort"))))
9382 ((string= type "elisp")
9383 (let ((cmd path))
9384 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9385 (string-match org-confirm-elisp-link-not-regexp cmd))
9386 (not org-confirm-elisp-link-function)
9387 (funcall org-confirm-elisp-link-function
9389 (org-add-props cmd nil
9390 'face 'org-warning))))
9391 (message "%s => %s" cmd
9392 (if (equal (string-to-char cmd) ?\()
9393 (eval (read cmd))
9394 (call-interactively (read cmd))))
9395 (error "Abort"))))
9397 ((and (string= type "thisfile")
9398 (run-hook-with-args-until-success
9399 'org-open-link-functions path)))
9401 ((string= type "thisfile")
9402 (if arg
9403 (switch-to-buffer-other-window
9404 (org-get-buffer-for-internal-link (current-buffer)))
9405 (org-mark-ring-push))
9406 (let ((cmd `(org-link-search
9407 ,path
9408 ,(cond ((equal arg '(4)) ''occur)
9409 ((equal arg '(16)) ''org-occur)
9410 (t nil))
9411 ,pos)))
9412 (condition-case nil (eval cmd)
9413 (error (progn (widen) (eval cmd))))))
9415 (t
9416 (browse-url-at-point)))))))
9417 (move-marker org-open-link-marker nil)
9418 (run-hook-with-args 'org-follow-link-hook)))
9420 (defun org-offer-links-in-entry (&optional nth zero)
9421 "Offer links in the current entry and follow the selected link.
9422 If there is only one link, follow it immediately as well.
9423 If NTH is an integer, immediately pick the NTH link found.
9424 If ZERO is a string, check also this string for a link, and if
9425 there is one, offer it as link number zero."
9429 (cnt ?0)
9430 (in-emacs (if (integerp nth) nil nth))
9431 have-zero end links link c)
9432 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9433 (push (match-string 0 zero) links)
9434 (setq cnt (1- cnt) have-zero t))
9435 (save-excursion
9436 (org-back-to-heading t)
9437 (setq end (save-excursion (outline-next-heading) (point)))
9438 (while (re-search-forward re end t)
9439 (push (match-string 0) links))
9440 (setq links (org-uniquify (reverse links))))
9442 (cond
9443 ((null links)
9444 (message "No links"))
9445 ((equal (length links) 1)
9446 (setq link (list (car links))))
9447 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9448 (setq link (nth (if have-zero nth (1- nth)) links)))
9449 (t ; we have to select a link
9450 (save-excursion
9451 (save-window-excursion
9452 (delete-other-windows)
9453 (with-output-to-temp-buffer "*Select Link*"
9454 (mapc (lambda (l)
9455 (if (not (string-match org-bracket-link-regexp l))
9457 (org-remove-angle-brackets l)))
9458 (if (match-end 3)
9460 (match-string 3 l) (match-string 1 l)))
9462 (match-string 1 l))))))
9463 links))
9464 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9465 (message "Select link to open, RET to open all:")
9466 (setq c (read-char-exclusive))
9467 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9468 (when (equal c ?q) (error "Abort"))
9469 (if (equal c ?\C-m)
9470 (setq link links)
9471 (setq nth (- c ?0))
9472 (if have-zero (setq nth (1+ nth)))
9473 (unless (and (integerp nth) (>= (length links) nth))
9474 (error "Invalid link selection"))
9475 (setq link (list (nth (1- nth) links))))))
9476 (if link
9477 (let ((buf (current-buffer)))
9478 (dolist (l link)
9479 (org-open-link-from-string l in-emacs buf))
9480 t)
9481 nil)))
9483 ;; Add special file links that specify the way of opening
9485 (org-add-link-type "file+sys" 'org-open-file-with-system)
9486 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9487 (defun org-open-file-with-system (path)
9488 "Open file at PATH using the system way of opening it."
9489 (org-open-file path 'system))
9490 (defun org-open-file-with-emacs (path)
9491 "Open file at PATH in Emacs."
9492 (org-open-file path 'emacs))
9493 (defun org-remove-file-link-modifiers ()
9494 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9495 (goto-char (point-min))
9497 (org-if-unprotected
9498 (replace-match "file:" t t))))
9499 (eval-after-load "org-exp"
9500 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9501 'org-remove-file-link-modifiers))
9503 ;;;; Time estimates
9505 (defun org-get-effort (&optional pom)
9506 "Get the effort estimate for the current entry."
9507 (org-entry-get pom org-effort-property))
9509 ;;; File search
9511 (defvar org-create-file-search-functions nil
9512 "List of functions to construct the right search string for a file link.
9513 These functions are called in turn with point at the location to
9514 which the link should point.
9516 A function in the hook should first test if it would like to
9517 handle this file type, for example by checking the `major-mode'
9518 or the file extension. If it decides not to handle this file, it
9519 should just return nil to give other functions a chance. If it
9520 does handle the file, it must return the search string to be used
9521 when following the link. The search string will be part of the
9522 file link, given after a double colon, and `org-open-at-point'
9523 will automatically search for it. If special measures must be
9524 taken to make the search successful, another function should be
9525 added to the companion hook `org-execute-file-search-functions',
9526 which see.
9528 A function in this hook may also use `setq' to set the variable
9529 `description' to provide a suggestion for the descriptive text to
9530 be used for this link when it gets inserted into an Org-mode
9533 (defvar org-execute-file-search-functions nil
9534 "List of functions to execute a file search triggered by a link.
9536 Functions added to this hook must accept a single argument, the
9537 search string that was part of the file link, the part after the
9538 double colon. The function must first check if it would like to
9539 handle this search, for example by checking the `major-mode' or
9540 the file extension. If it decides not to handle this search, it
9541 should just return nil to give other functions a chance. If it
9542 does handle the search, it must return a non-nil value to keep
9543 other functions from trying.
9545 Each function can access the current prefix argument through the
9546 variable `current-prefix-argument'. Note that a single prefix is
9547 used to force opening a link in Emacs, so it may be good to only
9548 use a numeric or double prefix to guide the search function.
9550 In case this is needed, a function in this hook can also restore
9551 the window configuration before `org-open-at-point' was called using:
9553 (set-window-configuration org-window-config-before-follow-link)")
9555 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9556 (defun org-link-search (s &optional type avoid-pos)
9557 "Search for a link search option.
9558 If S is surrounded by forward slashes, it is interpreted as a
9559 regular expression. In org-mode files, this will create an `org-occur'
9560 sparse tree. In ordinary files, `occur' will be used to list matches.
9561 If the current buffer is in `dired-mode', grep will be used to search
9562 in all files. If AVOID-POS is given, ignore matches near that position."
9563 (let ((case-fold-search t)
9567 org-emphasis-alist)
9569 (pos (point))
9570 (pre nil) (post nil)
9571 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9572 (cond
9573 ;; First check if there are any special search functions
9574 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9575 ;; Now try the builtin stuff
9576 ((and (equal (string-to-char s0) ?#)
9577 (> (length s0) 1)
9578 (save-excursion
9579 (goto-char (point-min))
9580 (and
9581 (re-search-forward
9583 (setq type 'dedicated
9584 pos (match-beginning 0))))
9585 ;; There is an exact target for this
9586 (goto-char pos)
9587 (org-back-to-heading t)))
9588 ((save-excursion
9589 (goto-char (point-min))
9590 (and
9591 (re-search-forward
9592 (concat "<<" (regexp-quote s0) ">>") nil t)
9593 (setq type 'dedicated
9594 pos (match-beginning 0))))
9595 ;; There is an exact target for this
9596 (goto-char pos))
9598 (save-excursion
9599 (goto-char (point-min))
9600 (and
9601 (re-search-forward
9602 (concat "[^[]" (regexp-quote
9603 (format org-coderef-label-format
9604 (match-string 1 s0))))
9605 nil t)
9606 (setq type 'dedicated
9607 pos (1+ (match-beginning 0))))))
9608 ;; There is a coderef target for this
9609 (goto-char pos))
9611 ;; A regular expression
9612 (cond
9613 ((org-mode-p)
9614 (org-occur (match-string 1 s)))
9615 ;;((eq major-mode 'dired-mode)
9616 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9617 (t (org-do-occur (match-string 1 s)))))
9618 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9619 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9620 (goto-char (point-min))
9621 (cond
9622 ((let (case-fold-search)
9623 (re-search-forward (format org-complex-heading-regexp-format
9624 (regexp-quote s))
9625 nil t))
9626 ;; OK, found a match
9627 (setq type 'dedicated)
9628 (goto-char (match-beginning 0)))
9629 ((and (not org-link-search-inhibit-query)
9630 (eq org-link-search-must-match-exact-headline 'query-to-create)
9631 (y-or-n-p "No match - create this as a new heading? "))
9632 (goto-char (point-max))
9633 (or (bolp) (newline))
9635 (beginning-of-line 0))
9636 (t
9637 (goto-char pos)
9638 (error "No match"))))
9639 (t
9640 ;; A normal search string
9641 (when (equal (string-to-char s) ?*)
9642 ;; Anchor on headlines, post may include tags.
9645 s (substring s 1)))
9646 (remove-text-properties
9647 0 (length s)
9648 '(face nil mouse-face nil keymap nil fontified nil) s)
9649 ;; Make a series of regular expressions to find a match
9658 re4 (concat "[^a-zA-Z_]" re4_)
9660 re1 (concat pre re2 post)
9661 re3 (concat pre (if pre re4_ re4) post)
9662 re5 (concat pre ".*" re4)
9663 re2 (concat pre re2)
9664 re2a (concat pre (if pre re2a_ re2a))
9665 re4 (concat pre (if pre re4_ re4))
9669 ))
9670 (cond
9671 ((eq type 'org-occur) (org-occur reall))
9672 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9673 (t (goto-char (point-min))
9674 (setq type 'fuzzy)
9675 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9676 (org-search-not-self 1 re1 nil t)
9677 (org-search-not-self 1 re2 nil t)
9678 (org-search-not-self 1 re2a nil t)
9679 (org-search-not-self 1 re3 nil t)
9680 (org-search-not-self 1 re4 nil t)
9681 (org-search-not-self 1 re5 nil t)
9682 )
9683 (goto-char (match-beginning 1))
9684 (goto-char pos)
9685 (error "No match"))))))
9686 (and (org-mode-p) (org-show-context 'link-search))
9687 type))
9689 (defun org-search-not-self (group &rest args)
9690 "Execute `re-search-forward', but only accept matches that do not
9691 enclose the position of `org-open-link-marker'."
9692 (let ((m org-open-link-marker))
9693 (catch 'exit
9694 (while (apply 're-search-forward args)
9695 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9696 (goto-char (match-end group))
9697 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9698 (> (match-beginning 0) (marker-position m))
9699 (< (match-end 0) (marker-position m)))
9700 (save-match-data
9701 (or (not (org-in-regexp
9702 org-bracket-link-analytic-regexp 1))
9703 (not (match-end 4)) ; no description
9704 (and (<= (match-beginning 4) (point))
9705 (>= (match-end 4) (point))))))
9706 (throw 'exit (point))))))))
9708 (defun org-get-buffer-for-internal-link (buffer)
9709 "Return a buffer to be used for displaying the link target of internal links."
9710 (cond
9711 ((not org-display-internal-link-with-indirect-buffer)
9712 buffer)
9713 ((string-match "(Clone)$" (buffer-name buffer))
9714 (message "Buffer is already a clone, not making another one")
9715 ;; we also do not modify visibility in this case
9716 buffer)
9717 (t ; make a new indirect buffer for displaying the link
9718 (let* ((bn (buffer-name buffer))
9719 (ibn (concat bn "(Clone)"))
9720 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9721 (with-current-buffer ib (org-overview))
9722 ib))))
9724 (defun org-do-occur (regexp &optional cleanup)
9725 "Call the Emacs command `occur'.
9726 If CLEANUP is non-nil, remove the printout of the regular expression
9727 in the *Occur* buffer. This is useful if the regex is long and not useful
9728 to read."
9729 (occur regexp)
9730 (when cleanup
9731 (let ((cwin (selected-window)) win beg end)
9732 (when (setq win (get-buffer-window "*Occur*"))
9733 (select-window win))
9734 (goto-char (point-min))
9735 (when (re-search-forward "match[a-z]+" nil t)
9736 (setq beg (match-end 0))
9738 (setq end (1- (match-beginning 0)))))
9739 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9740 (goto-char (point-min))
9741 (select-window cwin))))
9743 ;;; The mark ring for links jumps
9745 (defvar org-mark-ring nil
9746 "Mark ring for positions before jumps in Org-mode.")
9747 (defvar org-mark-ring-last-goto nil
9748 "Last position in the mark ring used to go back.")
9749 ;; Fill and close the ring
9750 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9751 (loop for i from 1 to org-mark-ring-length do
9752 (push (make-marker) org-mark-ring))
9753 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9754 org-mark-ring)
9756 (defun org-mark-ring-push (&optional pos buffer)
9757 "Put the current position or POS into the mark ring and rotate it."
9758 (interactive)
9759 (setq pos (or pos (point)))
9760 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9761 (move-marker (car org-mark-ring)
9762 (or pos (point))
9763 (or buffer (current-buffer)))
9764 (message "%s"
9765 (substitute-command-keys
9768 (defun org-mark-ring-goto (&optional n)
9769 "Jump to the previous position in the mark ring.
9770 With prefix arg N, jump back that many stored positions. When
9771 called several times in succession, walk through the entire ring.
9772 Org-mode commands jumping to a different position in the current file,
9773 or to another Org-mode file, automatically push the old position
9774 onto the ring."
9775 (interactive "p")
9776 (let (p m)
9777 (if (eq last-command this-command)
9778 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9779 (setq p org-mark-ring))
9780 (setq org-mark-ring-last-goto p)
9781 (setq m (car p))
9782 (switch-to-buffer (marker-buffer m))
9783 (goto-char m)
9784 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9786 (defun org-remove-angle-brackets (s)
9787 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9788 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9789 s)
9790 (defun org-add-angle-brackets (s)
9791 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9792 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9793 s)
9794 (defun org-remove-double-quotes (s)
9797 s)
9799 ;;; Following specific links
9801 (defun org-follow-timestamp-link ()
9802 (cond
9803 ((org-at-date-range-p t)
9804 (let ((org-agenda-start-on-weekday)
9805 (t1 (match-string 1))
9806 (t2 (match-string 2)))
9807 (setq t1 (time-to-days (org-time-string-to-time t1))
9808 t2 (time-to-days (org-time-string-to-time t2)))
9809 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9810 ((org-at-timestamp-p t)
9811 (org-agenda-list nil (time-to-days (org-time-string-to-time
9812 (substring (match-string 1) 0 10)))
9813 1))
9814 (t (error "This should not happen"))))
9817 ;;; Following file links
9818 (defvar org-wait nil)
9819 (defun org-open-file (path &optional in-emacs line search)
9820 "Open the file at PATH.
9821 First, this expands any special file name abbreviations. Then the
9822 configuration variable `org-file-apps' is checked if it contains an
9823 entry for this file type, and if yes, the corresponding command is launched.
9825 If no application is found, Emacs simply visits the file.
9827 With optional prefix argument IN-EMACS, Emacs will visit the file.
9829 prefix arg, Org tries to avoid opening in Emacs
9830 and to use an external application to visit the file.
9832 Optional LINE specifies a line to go to, optional SEARCH a string
9833 to search for. If LINE or SEARCH is given, the file will be
9834 opened in Emacs, unless an entry from org-file-apps that makes
9835 use of groups in a regexp matches.
9836 If the file does not exist, an error is thrown."
9837 (let* ((file (if (equal path "")
9838 buffer-file-name
9839 (substitute-in-file-name (expand-file-name path))))
9840 (file-apps (append org-file-apps (org-default-apps)))
9841 (apps (org-remove-if
9842 'org-file-apps-entry-match-against-dlink-p file-apps))
9843 (apps-dlink (org-remove-if-not
9844 'org-file-apps-entry-match-against-dlink-p file-apps))
9845 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9846 (dirp (if remp nil (file-directory-p file)))
9847 (file (if (and dirp org-open-directory-means-index-dot-org)
9848 (concat (file-name-as-directory file) "index.org")
9849 file))
9850 (a-m-a-p (assq 'auto-mode apps))
9851 (dfile (downcase file))
9852 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9853 (link (cond ((and (eq line nil)
9854 (eq search nil))
9855 file)
9856 (line
9857 (concat file "::" (number-to-string line)))
9858 (search
9859 (concat file "::" search))))
9860 (dlink (downcase link))
9861 (old-buffer (current-buffer))
9862 (old-pos (point))
9863 (old-mode major-mode)
9864 ext cmd link-match-data)
9866 (setq ext (match-string 1 dfile))
9868 (setq ext (match-string 1 dfile))))
9869 (cond
9870 ((member in-emacs '((16) system))
9871 (setq cmd (cdr (assoc 'system apps))))
9872 (in-emacs (setq cmd 'emacs))
9873 (t
9874 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9875 (and dirp (cdr (assoc 'directory apps)))
9876 ; first, try matching against apps-dlink
9877 ; if we get a match here, store the match data for later
9878 (let ((match (assoc-default dlink apps-dlink
9879 'string-match)))
9880 (if match
9881 (progn (setq link-match-data (match-data))
9882 match)
9883 (progn (setq in-emacs (or in-emacs line search))
9884 nil))) ; if we have no match in apps-dlink,
9885 ; always open the file in emacs if line or search
9886 ; is given (for backwards compatibility)
9887 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9888 'string-match)
9889 (cdr (assoc ext apps))
9890 (cdr (assoc t apps))))))
9891 (when (eq cmd 'system)
9892 (setq cmd (cdr (assoc 'system apps))))
9893 (when (eq cmd 'default)
9894 (setq cmd (cdr (assoc t apps))))
9895 (when (eq cmd 'mailcap)
9896 (require 'mailcap)
9897 (mailcap-parse-mailcaps)
9898 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9899 (command (mailcap-mime-info mime-type)))
9900 (if (stringp command)
9901 (setq cmd command)
9902 (setq cmd 'emacs))))
9903 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9904 (not (file-exists-p file))
9905 (not org-open-non-existing-files))
9906 (error "No such file: %s" file))
9907 (cond
9909 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9911 (setq cmd (replace-match "%s" t t cmd)))
9912 (while (string-match "%s" cmd)
9913 (setq cmd (replace-match
9914 (save-match-data
9915 (shell-quote-argument
9916 (convert-standard-filename file)))
9917 t t cmd)))
9919 ;; Replace "%1", "%2" etc. in command with group matches from regex
9920 (save-match-data
9921 (let ((match-index 1)
9922 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9923 (set-match-data link-match-data)
9924 (while (<= match-index number-of-groups)
9925 (let ((regex (concat "%" (number-to-string match-index)))
9926 (replace-with (match-string match-index dlink)))
9927 (while (string-match regex cmd)
9928 (setq cmd (replace-match replace-with t t cmd))))
9929 (setq match-index (+ match-index 1)))))
9931 (save-window-excursion
9932 (start-process-shell-command cmd nil cmd)
9933 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9934 ))
9935 ((or (stringp cmd)
9936 (eq cmd 'emacs))
9937 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9938 (widen)
9939 (if line (org-goto-line line)
9940 (if search (org-link-search search))))
9941 ((consp cmd)
9942 (let ((file (convert-standard-filename file)))
9943 (save-match-data
9944 (set-match-data link-match-data)
9945 (eval cmd))))
9946 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9947 (and (org-mode-p) (eq old-mode 'org-mode)
9948 (or (not (equal old-buffer (current-buffer)))
9949 (not (equal old-pos (point))))
9950 (org-mark-ring-push old-pos old-buffer))))
9952 (defun org-file-apps-entry-match-against-dlink-p (entry)
9953 "This function returns non-nil if `entry' uses a regular
9954 expression which should be matched against the whole link by
9955 org-open-file.
9957 It assumes that is the case when the entry uses a regular
9958 expression which has at least one grouping construct and the
9959 action is either a lisp form or a command string containing
9960 '%1', i.e. using at least one subexpression match as a
9961 parameter."
9962 (let ((selector (car entry))
9963 (action (cdr entry)))
9964 (if (stringp selector)
9965 (and (> (regexp-opt-depth selector) 0)
9966 (or (and (stringp action)
9967 (string-match "%[0-9]" action))
9968 (consp action)))
9969 nil)))
9971 (defun org-default-apps ()
9972 "Return the default applications for this operating system."
9973 (cond
9974 ((eq system-type 'darwin)
9975 org-file-apps-defaults-macosx)
9976 ((eq system-type 'windows-nt)
9977 org-file-apps-defaults-windowsnt)
9978 (t org-file-apps-defaults-gnu)))
9980 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9981 "Convert extensions to regular expressions in the cars of LIST.
9982 Also, weed out any non-string entries, because the return value is used
9983 only for regexp matching.
9984 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9985 point to the symbol `emacs', indicating that the file should
9986 be opened in Emacs."
9987 (append
9988 (delq nil
9989 (mapcar (lambda (x)
9990 (if (not (stringp (car x)))
9991 nil
9993 x
9995 list))
9996 (if add-auto-mode
9997 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9999 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10000 (defun org-file-remote-p (file)
10001 "Test whether FILE specifies a location on a remote system.
10002 Return non-nil if the location is indeed remote.
10006 (cond ((fboundp 'file-remote-p)
10007 (file-remote-p file))
10008 ((fboundp 'tramp-handle-file-remote-p)
10009 (tramp-handle-file-remote-p file))
10010 ((and (boundp 'ange-ftp-name-format)
10011 (string-match (car ange-ftp-name-format) file))
10012 t)
10013 (t nil)))
10016 ;;;; Refiling
10018 (defun org-get-org-file ()
10019 "Read a filename, with default directory `org-directory'."
10020 (let ((default (or org-default-notes-file remember-data-file)))
10021 (read-file-name (format "File name [%s]: " default)
10022 (file-name-as-directory org-directory)
10023 default)))
10025 (defun org-notes-order-reversed-p ()
10026 "Check if the current file should receive notes in reversed order."
10027 (cond
10028 ((not org-reverse-note-order) nil)
10029 ((eq t org-reverse-note-order) t)
10030 ((not (listp org-reverse-note-order)) nil)
10031 (t (catch 'exit
10032 (let ((all org-reverse-note-order)
10033 entry)
10034 (while (setq entry (pop all))
10035 (if (string-match (car entry) buffer-file-name)
10036 (throw 'exit (cdr entry))))
10037 nil)))))
10039 (defvar org-refile-target-table nil
10040 "The list of refile targets, created by `org-refile'.")
10042 (defvar org-agenda-new-buffers nil
10043 "Buffers created to visit agenda files.")
10045 (defvar org-refile-cache nil
10046 "Cache for refile targets.")
10048 (defvar org-refile-markers nil
10049 "All the markers used for caching refile locations.")
10051 (defun org-refile-marker (pos)
10052 "Get a new refile marker, but only if caching is in use."
10053 (if (not org-refile-use-cache)
10054 pos
10055 (let ((m (make-marker)))
10056 (move-marker m pos)
10057 (push m org-refile-markers)
10058 m)))
10060 (defun org-refile-cache-clear ()
10061 "Clear the refile cache and disable all the markers."
10062 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10063 (setq org-refile-markers nil)
10064 (setq org-refile-cache nil)
10065 (message "Refile cache has been cleared"))
10067 (defun org-refile-cache-check-set (set)
10068 "Check if all the markers in the cache still have live buffers."
10069 (let (marker)
10070 (catch 'exit
10071 (while (and set (setq marker (nth 3 (pop set))))
10072 ;; if org-refile-use-outline-path is 'file, marker may be nil
10073 (when (and marker (null (marker-buffer marker)))
10074 (message "not found") (sit-for 3)
10075 (throw 'exit nil)))
10076 t)))
10078 (defun org-refile-cache-put (set &rest identifiers)
10079 "Push the refile targets SET into the cache, under IDENTIFIERS."
10080 (let* ((key (sha1 (prin1-to-string identifiers)))
10081 (entry (assoc key org-refile-cache)))
10082 (if entry
10083 (setcdr entry set)
10084 (push (cons key set) org-refile-cache))))
10086 (defun org-refile-cache-get (&rest identifiers)
10087 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10088 (cond
10089 ((not org-refile-cache) nil)
10090 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10091 (t
10092 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10093 org-refile-cache))))
10094 (and set (org-refile-cache-check-set set) set)))))
10096 (defun org-refile-get-targets (&optional default-buffer)
10097 "Produce a table with refile targets."
10098 (let ((case-fold-search nil)
10099 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10100 (entries (or org-refile-targets '((nil . (:level . 1)))))
10101 targets tgs txt re files f desc descre fast-path-p level pos0)
10102 (message "Getting targets...")
10103 (with-current-buffer (or default-buffer (current-buffer))
10104 (while (setq entry (pop entries))
10105 (setq files (car entry) desc (cdr entry))
10106 (setq fast-path-p nil)
10107 (cond
10108 ((null files) (setq files (list (current-buffer))))
10109 ((eq files 'org-agenda-files)
10110 (setq files (org-agenda-files 'unrestricted)))
10111 ((and (symbolp files) (fboundp files))
10112 (setq files (funcall files)))
10113 ((and (symbolp files) (boundp files))
10114 (setq files (symbol-value files))))
10115 (if (stringp files) (setq files (list files)))
10116 (cond
10117 ((eq (car desc) :tag)
10119 ((eq (car desc) :todo)
10121 ((eq (car desc) :regexp)
10122 (setq descre (cdr desc)))
10123 ((eq (car desc) :level)
10125 (if org-odd-levels-only
10126 (1- (* 2 (cdr desc)))
10127 (cdr desc)))
10129 ((eq (car desc) :maxlevel)
10130 (setq fast-path-p t)
10132 (if org-odd-levels-only
10133 (1- (* 2 (cdr desc)))
10134 (cdr desc)))
10136 (t (error "Bad refiling target description %s" desc)))
10137 (while (setq f (pop files))
10138 (with-current-buffer
10139 (if (bufferp f) f (org-get-agenda-file-buffer f))
10140 (or
10141 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10142 (progn
10143 (if (bufferp f) (setq f (buffer-file-name
10144 (buffer-base-buffer f))))
10145 (setq f (and f (expand-file-name f)))
10146 (if (eq org-refile-use-outline-path 'file)
10147 (push (list (file-name-nondirectory f) f nil nil) tgs))
10148 (save-excursion
10149 (save-restriction
10150 (widen)
10151 (goto-char (point-min))
10152 (while (re-search-forward descre nil t)
10153 (goto-char (setq pos0 (point-at-bol)))
10154 (catch 'next
10155 (when org-refile-target-verify-function
10156 (save-match-data
10157 (or (funcall org-refile-target-verify-function)
10158 (throw 'next t))))
10159 (when (looking-at org-complex-heading-regexp)
10160 (setq level (org-reduced-level
10161 (- (match-end 1) (match-beginning 1)))
10162 txt (org-link-display-format (match-string 4))
10164 re (format org-complex-heading-regexp-format
10165 (regexp-quote (match-string 4))))
10166 (when org-refile-use-outline-path
10167 (setq txt (mapconcat
10168 'org-protect-slash
10169 (append
10170 (if (eq org-refile-use-outline-path
10171 'file)
10172 (list (file-name-nondirectory
10173 (buffer-file-name
10174 (buffer-base-buffer))))
10175 (if (eq org-refile-use-outline-path
10176 'full-file-path)
10177 (list (buffer-file-name
10178 (buffer-base-buffer)))))
10179 (org-get-outline-path fast-path-p
10180 level txt)
10181 (list txt))
10182 "/")))
10183 (push (list txt f re (org-refile-marker (point)))
10184 tgs)))
10185 (when (= (point) pos0)
10186 ;; verification function has not moved point
10187 (goto-char (point-at-eol))))))))
10188 (when org-refile-use-cache
10189 (org-refile-cache-put tgs (buffer-file-name) descre))
10190 (setq targets (append tgs targets))
10191 ))))
10192 (message "Getting targets...done")
10193 (nreverse targets)))
10195 (defun org-protect-slash (s)
10196 (while (string-match "/" s)
10198 s)
10200 (defvar org-olpa (make-vector 20 nil))
10202 (defun org-get-outline-path (&optional fastp level heading)
10203 "Return the outline path to the current entry, as a list.
10205 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10206 routine which makes outline path derivations for an entire file,
10207 avoiding backtracing. Refile target collection makes use of that."
10208 (if fastp
10209 (progn
10210 (if (> level 19)
10211 (error "Outline path failure, more than 19 levels"))
10212 (loop for i from level upto 19 do
10213 (aset org-olpa i nil))
10214 (prog1
10215 (delq nil (append org-olpa nil))
10216 (aset org-olpa level heading)))
10217 (let (rtn case-fold-search)
10218 (save-excursion
10219 (save-restriction
10220 (widen)
10221 (while (org-up-heading-safe)
10222 (when (looking-at org-complex-heading-regexp)
10223 (push (org-match-string-no-properties 4) rtn)))
10224 rtn)))))
10226 (defun org-format-outline-path (path &optional width prefix)
10227 "Format the outline path PATH for display.
10228 Width is the maximum number of characters that is available.
10229 Prefix is a prefix to be included in the returned string,
10230 such as the file name."
10231 (setq width (or width 79))
10232 (if prefix (setq width (- width (length prefix))))
10233 (if (not path)
10234 (or prefix "")
10235 (let* ((nsteps (length path))
10236 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10237 (maxwidth (if (<= total-width width)
10238 10000 ;; everything fits
10239 ;; we need to shorten the level headings
10240 (/ (- width nsteps) nsteps)))
10241 (org-odd-levels-only nil)
10242 (n 0)
10243 (total (1+ (length prefix))))
10244 (setq maxwidth (max maxwidth 10))
10245 (concat prefix
10246 (mapconcat
10247 (lambda (h)
10248 (setq n (1+ n))
10249 (if (and (= n nsteps) (< maxwidth 10000))
10250 (setq maxwidth (- total-width total)))
10251 (if (< (length h) maxwidth)
10252 (progn (setq total (+ total (length h) 1)) h)
10253 (setq h (substring h 0 (- maxwidth 2))
10254 total (+ total maxwidth 1))
10256 (setq h (substring h 0 (match-beginning 0))))
10257 (setq h (concat h "..")))
10258 (org-add-props h nil 'face
10259 (nth (% (1- n) org-n-level-faces)
10260 org-level-faces))
10261 h)
10262 path "/")))))
10264 (defun org-display-outline-path (&optional file current)
10265 "Display the current outline path in the echo area."
10266 (interactive "P")
10267 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10268 (case-fold-search nil)
10269 (path (and (org-mode-p) (org-get-outline-path))))
10270 (if current (setq path (append path
10271 (save-excursion
10272 (org-back-to-heading t)
10273 (if (looking-at org-complex-heading-regexp)
10274 (list (match-string 4)))))))
10275 (message "%s"
10276 (org-format-outline-path
10277 path
10278 (1- (frame-width))
10279 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10281 (defvar org-refile-history nil
10282 "History for refiling operations.")
10284 (defvar org-after-refile-insert-hook nil
10285 "Hook run after `org-refile' has inserted its stuff at the new location.
10286 Note that this is still *before* the stuff will be removed from
10287 the *old* location.")
10289 (defvar org-capture-last-stored-marker)
10290 (defun org-refile (&optional goto default-buffer rfloc)
10291 "Move the entry at point to another heading.
10292 The list of target headings is compiled using the information in
10293 `org-refile-targets', which see. This list is created before each use
10294 and will therefore always be up-to-date.
10296 At the target location, the entry is filed as a subitem of the target heading.
10297 Depending on `org-reverse-note-order', the new subitem will either be the
10298 first or the last subitem.
10300 If there is an active region, all entries in that region will be moved.
10301 However, the region must fulfill the requirement that the first heading
10302 is the first one sets the top-level of the moved text - at most siblings
10303 below it are allowed.
10305 With prefix arg GOTO, the command will only visit the target location,
10306 not actually move anything.
10308 go to the location where the last refiling
10309 operation has put the subtree.
10310 With a prefix argument of `2', refile to the running clock.
10312 RFLOC can be a refile location obtained in a different way.
10314 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10316 If you are using target caching (see `org-refile-use-cache'),
10317 You have to clear the target cache in order to find new targets.
10318 This can be done with a 0 prefix: `C-0 C-c C-w'"
10319 (interactive "P")
10320 (if (member goto '(0 (64)))
10321 (org-refile-cache-clear)
10322 (let* ((cbuf (current-buffer))
10323 (regionp (org-region-active-p))
10324 (region-start (and regionp (region-beginning)))
10325 (region-end (and regionp (region-end)))
10326 (region-length (and regionp (- region-end region-start)))
10327 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10328 pos it nbuf file re level reversed)
10329 (setq last-command nil)
10330 (when regionp
10331 (goto-char region-start)
10332 (or (bolp) (goto-char (point-at-bol)))
10333 (setq region-start (point))
10334 (unless (org-kill-is-subtree-p
10335 (buffer-substring region-start region-end))
10336 (error "The region is not a (sequence of) subtree(s)")))
10337 (if (equal goto '(16))
10338 (org-refile-goto-last-stored)
10339 (when (or
10340 (and (equal goto 2)
10341 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10342 (prog1
10343 (setq it (list (or org-clock-heading "running clock")
10344 (buffer-file-name
10345 (marker-buffer org-clock-hd-marker))
10346 ""
10347 (marker-position org-clock-hd-marker)))
10348 (setq goto nil)))
10349 (setq it (or rfloc
10350 (save-excursion
10351 (org-refile-get-location
10352 (if goto "Goto" "Refile to") default-buffer
10353 org-refile-allow-creating-parent-nodes)))))
10354 (setq file (nth 1 it)
10355 re (nth 2 it)
10356 pos (nth 3 it))
10357 (if (and (not goto)
10358 pos
10359 (equal (buffer-file-name) file)
10360 (if regionp
10361 (and (>= pos region-start)
10362 (<= pos region-end))
10363 (and (>= pos (point))
10364 (< pos (save-excursion
10365 (org-end-of-subtree t t))))))
10366 (error "Cannot refile to position inside the tree or region"))
10368 (setq nbuf (or (find-buffer-visiting file)
10369 (find-file-noselect file)))
10370 (if goto
10371 (progn
10372 (switch-to-buffer nbuf)
10373 (goto-char pos)
10374 (org-show-context 'org-goto))
10375 (if regionp
10376 (progn
10377 (org-kill-new (buffer-substring region-start region-end))
10378 (org-save-markers-in-region region-start region-end))
10379 (org-copy-subtree 1 nil t))
10380 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10381 (find-file-noselect file)))
10382 (setq reversed (org-notes-order-reversed-p))
10383 (save-excursion
10384 (save-restriction
10385 (widen)
10386 (if pos
10387 (progn
10388 (goto-char pos)
10389 (looking-at outline-regexp)
10390 (setq level (org-get-valid-level (funcall outline-level) 1))
10391 (goto-char
10392 (if reversed
10393 (or (outline-next-heading) (point-max))
10394 (or (save-excursion (org-get-next-sibling))
10395 (org-end-of-subtree t t)
10396 (point-max)))))
10397 (setq level 1)
10398 (if (not reversed)
10399 (goto-char (point-max))
10400 (goto-char (point-min))
10401 (or (outline-next-heading) (goto-char (point-max)))))
10402 (if (not (bolp)) (newline))
10403 (org-paste-subtree level)
10404 (when org-log-refile
10405 (org-add-log-setup 'refile nil nil 'findpos
10406 org-log-refile)
10407 (unless (eq org-log-refile 'note)
10408 (save-excursion (org-add-log-note))))
10409 (and org-auto-align-tags (org-set-tags nil t))
10410 (bookmark-set "org-refile-last-stored")
10411 ;; If we are refiling for capture, make sure that the
10412 ;; last-capture pointers point here
10413 (when (org-bound-and-true-p org-refile-for-capture)
10414 (bookmark-set "org-capture-last-stored-marker")
10415 (move-marker org-capture-last-stored-marker (point)))
10416 (if (fboundp 'deactivate-mark) (deactivate-mark))
10417 (run-hooks 'org-after-refile-insert-hook))))
10418 (if regionp
10419 (delete-region (point) (+ (point) region-length))
10420 (org-cut-subtree))
10421 (when (featurep 'org-inlinetask)
10422 (org-inlinetask-remove-END-maybe))
10423 (setq org-markers-to-move nil)
10426 (defun org-refile-goto-last-stored ()
10427 "Go to the location where the last refile was stored."
10428 (interactive)
10429 (bookmark-jump "org-refile-last-stored")
10430 (message "This is the location of the last refile"))
10432 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10433 "Prompt the user for a refile location, using PROMPT.
10434 PROMPT should not be suffixed with a colon and a space, because
10435 this function appends the default value from
10436 `org-refile-history' automatically, if that is not empty."
10437 (let ((org-refile-targets org-refile-targets)
10438 (org-refile-use-outline-path org-refile-use-outline-path))
10439 (setq org-refile-target-table (org-refile-get-targets default-buffer)))
10440 (unless org-refile-target-table
10441 (error "No refile targets"))
10442 (let* ((prompt (concat prompt
10443 (and (car org-refile-history)
10444 (concat " (default " (car org-refile-history) ")"))
10445 ": "))
10446 (cbuf (current-buffer))
10447 (partial-completion-mode nil)
10448 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10449 (cfunc (if (and org-refile-use-outline-path
10450 org-outline-path-complete-in-steps)
10451 'org-olpath-completing-read
10452 'org-icompleting-read))
10453 (extra (if org-refile-use-outline-path "/" ""))
10454 (filename (and cfn (expand-file-name cfn)))
10455 (tbl (mapcar
10456 (lambda (x)
10457 (if (and (not (member org-refile-use-outline-path
10458 '(file full-file-path)))
10459 (not (equal filename (nth 1 x))))
10460 (cons (concat (car x) extra " ("
10461 (file-name-nondirectory (nth 1 x)) ")")
10462 (cdr x))
10463 (cons (concat (car x) extra) (cdr x))))
10464 org-refile-target-table))
10465 (completion-ignore-case t)
10466 pa answ parent-target child parent old-hist)
10467 (setq old-hist org-refile-history)
10468 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10469 nil 'org-refile-history (car org-refile-history)))
10470 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10471 (org-refile-check-position pa)
10472 (if pa
10473 (progn
10474 (when (or (not org-refile-history)
10475 (not (eq old-hist org-refile-history))
10476 (not (equal (car pa) (car org-refile-history))))
10477 (setq org-refile-history
10478 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10479 org-refile-history
10480 (cdr org-refile-history))))
10481 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10482 (pop org-refile-history)))
10483 pa)
10485 (progn
10486 (setq parent (match-string 1 answ)
10487 child (match-string 2 answ))
10488 (setq parent-target (or (assoc parent tbl)
10489 (assoc (concat parent "/") tbl)))
10490 (when (and parent-target
10491 (or (eq new-nodes t)
10492 (and (eq new-nodes 'confirm)
10494 child)))))
10495 (org-refile-new-child parent-target child)))
10496 (error "Invalid target location")))))
10498 (defun org-refile-check-position (refile-pointer)
10499 "Check if the refile pointer matches the readline to which it points."
10500 (let* ((file (nth 1 refile-pointer))
10501 (re (nth 2 refile-pointer))
10502 (pos (nth 3 refile-pointer))
10503 buffer)
10504 (when (org-string-nw-p re)
10505 (setq buffer (if (markerp pos)
10506 (marker-buffer pos)
10507 (or (find-buffer-visiting file)
10508 (find-file-noselect file))))
10509 (with-current-buffer buffer
10510 (save-excursion
10511 (save-restriction
10512 (widen)
10513 (goto-char pos)
10514 (beginning-of-line 1)
10515 (unless (org-looking-at-p re)
10516 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10518 (defun org-refile-new-child (parent-target child)
10519 "Use refile target PARENT-TARGET to add new CHILD below it."
10520 (unless parent-target
10521 (error "Cannot find parent for new node"))
10522 (let ((file (nth 1 parent-target))
10523 (pos (nth 3 parent-target))
10524 level)
10525 (with-current-buffer (or (find-buffer-visiting file)
10526 (find-file-noselect file))
10527 (save-excursion
10528 (save-restriction
10529 (widen)
10530 (if pos
10531 (goto-char pos)
10532 (goto-char (point-max))
10533 (if (not (bolp)) (newline)))
10534 (when (looking-at outline-regexp)
10535 (setq level (funcall outline-level))
10536 (org-end-of-subtree t t))
10537 (org-back-over-empty-lines)
10539 (if pos (org-get-valid-level level 1) 1) ?*)
10541 (beginning-of-line 0)
10542 (list (concat (car parent-target) "/" child) file "" (point)))))))
10544 (defun org-olpath-completing-read (prompt collection &rest args)
10545 "Read an outline path like a file name."
10546 (let ((thetable collection)
10547 (org-completion-use-ido nil) ; does not work with ido.
10548 (org-completion-use-iswitchb nil)) ; or iswitchb
10549 (apply
10550 'org-icompleting-read prompt
10551 (lambda (string predicate &optional flag)
10552 (let (rtn r f (l (length string)))
10553 (cond
10554 ((eq flag nil)
10555 ;; try completion
10556 (try-completion string thetable))
10557 ((eq flag t)
10558 ;; all-completions
10559 (setq rtn (all-completions string thetable predicate))
10560 (mapcar
10561 (lambda (x)
10562 (setq r (substring x l))
10563 (if (string-match " ([^)]*)$" x)
10564 (setq f (match-string 0 x))
10565 (setq f ""))
10566 (if (string-match "/" r)
10567 (concat string (substring r 0 (match-end 0)) f)
10568 x))
10569 rtn))
10570 ((eq flag 'lambda)
10571 ;; exact match?
10572 (assoc string thetable)))
10573 ))
10574 args)))
10576 ;;;; Dynamic blocks
10578 (defun org-find-dblock (name)
10579 "Find the first dynamic block with name NAME in the buffer.
10580 If not found, stay at current position and return nil."
10581 (let (pos)
10582 (save-excursion
10583 (goto-char (point-min))
10585 nil t)
10586 (match-beginning 0))))
10587 (if pos (goto-char pos))
10588 pos))
10590 (defconst org-dblock-start-re
10592 "Matches the start line of a dynamic block, with parameters.")
10595 "Matches the end of a dynamic block.")
10597 (defun org-create-dblock (plist)
10598 "Create a dynamic block section, with parameters taken from PLIST.
10599 PLIST must contain a :name entry which is used as name of the block."
10601 (end-of-line 1)
10602 (newline))
10603 (let ((col (current-column))
10604 (name (plist-get plist :name)))
10605 (insert "#+BEGIN: " name)
10606 (while plist
10607 (if (eq (car plist) :name)
10608 (setq plist (cddr plist))
10609 (insert " " (prin1-to-string (pop plist)))))
10611 (beginning-of-line -2)))
10613 (defun org-prepare-dblock ()
10614 "Prepare dynamic block for refresh.
10615 This empties the block, puts the cursor at the insert position and returns
10616 the property list including an extra property :name with the block name."
10617 (unless (looking-at org-dblock-start-re)
10618 (error "Not at a dynamic block"))
10619 (let* ((begdel (1+ (match-end 0)))
10620 (name (org-no-properties (match-string 1)))
10621 (params (append (list :name name)
10622 (read (concat "(" (match-string 3) ")")))))
10623 (save-excursion
10624 (beginning-of-line 1)
10626 (setq params (plist-put params :indentation-column (current-column))))
10627 (unless (re-search-forward org-dblock-end-re nil t)
10628 (error "Dynamic block not terminated"))
10629 (setq params
10630 (append params
10631 (list :content (buffer-substring
10632 begdel (match-beginning 0)))))
10633 (delete-region begdel (match-beginning 0))
10634 (goto-char begdel)
10635 (open-line 1)
10636 params))
10638 (defun org-map-dblocks (&optional command)
10639 "Apply COMMAND to all dynamic blocks in the current buffer.
10640 If COMMAND is not given, use `org-update-dblock'."
10641 (let ((cmd (or command 'org-update-dblock)))
10642 (save-excursion
10643 (goto-char (point-min))
10644 (while (re-search-forward org-dblock-start-re nil t)
10645 (goto-char (match-beginning 0))
10646 (save-excursion
10647 (condition-case nil
10648 (funcall cmd)
10649 (error (message "Error during update of dynamic block"))))
10650 (unless (re-search-forward org-dblock-end-re nil t)
10651 (error "Dynamic block not terminated"))))))
10653 (defun org-dblock-update (&optional arg)
10654 "User command for updating dynamic blocks.
10655 Update the dynamic block at point. With prefix ARG, update all dynamic
10656 blocks in the buffer."
10657 (interactive "P")
10658 (if arg
10659 (org-update-all-dblocks)
10660 (or (looking-at org-dblock-start-re)
10661 (org-beginning-of-dblock))
10662 (org-update-dblock)))
10664 (defun org-update-dblock ()
10665 "Update the dynamic block at point.
10666 This means to empty the block, parse for parameters and then call
10667 the correct writing function."
10668 (interactive)
10669 (save-window-excursion
10670 (let* ((pos (point))
10671 (line (org-current-line))
10672 (params (org-prepare-dblock))
10673 (name (plist-get params :name))
10674 (indent (plist-get params :indentation-column))
10675 (cmd (intern (concat "org-dblock-write:" name))))
10676 (message "Updating dynamic block `%s' at line %d..." name line)
10677 (funcall cmd params)
10678 (message "Updating dynamic block `%s' at line %d...done" name line)
10679 (goto-char pos)
10680 (when (and indent (> indent 0))
10681 (setq indent (make-string indent ?\ ))
10682 (save-excursion
10683 (org-beginning-of-dblock)
10684 (forward-line 1)
10685 (while (not (looking-at org-dblock-end-re))
10686 (insert indent)
10687 (beginning-of-line 2))
10688 (when (looking-at org-dblock-end-re)
10690 (replace-match ""))
10691 (insert indent)))))))
10693 (defun org-beginning-of-dblock ()
10694 "Find the beginning of the dynamic block at point.
10695 Error if there is no such block at point."
10696 (let ((pos (point))
10697 beg)
10698 (end-of-line 1)
10699 (if (and (re-search-backward org-dblock-start-re nil t)
10700 (setq beg (match-beginning 0))
10701 (re-search-forward org-dblock-end-re nil t)
10702 (> (match-end 0) pos))
10703 (goto-char beg)
10704 (goto-char pos)
10705 (error "Not in a dynamic block"))))
10707 (defun org-update-all-dblocks ()
10708 "Update all dynamic blocks in the buffer.
10709 This function can be used in a hook."
10710 (interactive)
10711 (when (org-mode-p)
10712 (org-map-dblocks 'org-update-dblock)))
10715 ;;;; Completion
10717 (defconst org-additional-option-like-keywords
10718 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10719 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10720 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10721 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10722 "BEGIN:" "END:"
10723 "ORGTBL" "TBLFM:" "TBLNAME:"
10724 "BEGIN_EXAMPLE" "END_EXAMPLE"
10725 "BEGIN_QUOTE" "END_QUOTE"
10726 "BEGIN_VERSE" "END_VERSE"
10727 "BEGIN_CENTER" "END_CENTER"
10728 "BEGIN_SRC" "END_SRC"
10729 "BEGIN_RESULT" "END_RESULT"
10730 "SOURCE:" "SRCNAME:" "FUNCTION:"
10731 "RESULTS:"
10732 "HEADER:" "HEADERS:"
10733 "BABEL:"
10734 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10735 "CAPTION:" "LABEL:"
10736 "SETUPFILE:"
10737 "INCLUDE:"
10738 "BIND:"
10739 "MACRO:"))
10741 (defcustom org-structure-template-alist
10742 '(
10755 ("L" "#+latex: "
10759 ("H" "#+html: "
10762 ("A" "#+ascii: ")
10763 ("i" "#+include %file ?"
10765 )
10766 "Structure completion elements.
10767 This is a list of abbreviation keys and values. The value gets inserted
10768 if you type `<' followed by the key and then press the completion key,
10769 usually `M-TAB'. %file will be replaced by a file name after prompting
10770 for the file using completion.
10771 There are two templates for each key, the first uses the original Org syntax,
10772 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10773 the default when the /org-mtags.el/ module has been loaded. See also the
10774 variable `org-mtags-prefer-muse-templates'.
10775 This is an experimental feature, it is undecided if it is going to stay in."
10776 :group 'org-completion
10777 :type '(repeat
10778 (string :tag "Key")
10779 (string :tag "Template")
10780 (string :tag "Muse Template")))
10782 (defun org-try-structure-completion ()
10783 "Try to complete a structure template before point.
10785 expands them."
10786 (let ((l (buffer-substring (point-at-bol) (point)))
10787 a)
10790 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10791 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10792 (match-beginning 1)) a)
10793 t)))
10795 (defun org-complete-expand-structure-template (start cell)
10796 "Expand a structure template."
10797 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10798 (rpl (nth (if musep 2 1) cell))
10799 (ind ""))
10800 (delete-region start (point))
10802 (cond
10803 ((bolp))
10805 (setq ind (buffer-substring (point-at-bol) (point))))
10806 (t (newline))))
10807 (setq start (point))
10808 (if (string-match "%file" rpl)
10809 (setq rpl (replace-match
10810 (concat
10812 (save-match-data
10813 (abbreviate-file-name (read-file-name "Include file: ")))
10815 t t rpl)))
10818 (insert rpl)
10821 ;;;; TODO, DEADLINE, Comments
10823 (defun org-toggle-comment ()
10824 "Change the COMMENT state of an entry."
10825 (interactive)
10826 (save-excursion
10827 (org-back-to-heading)
10828 (let (case-fold-search)
10829 (if (looking-at (concat outline-regexp
10831 (replace-match "" t t nil 1)
10832 (if (looking-at outline-regexp)
10833 (progn
10834 (goto-char (match-end 0))
10835 (insert org-comment-string " ")))))))
10837 (defvar org-last-todo-state-is-todo nil
10838 "This is non-nil when the last TODO state change led to a TODO state.
10839 If the last change removed the TODO tag or switched to DONE, then
10840 this is nil.")
10842 (defvar org-setting-tags nil) ; dynamically skipped
10844 (defvar org-todo-setup-filter-hook nil
10845 "Hook for functions that pre-filter todo specs.
10846 Each function takes a todo spec and returns either nil or the spec
10847 transformed into canonical form." )
10849 (defvar org-todo-get-default-hook nil
10850 "Hook for functions that get a default item for todo.
10851 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10852 nil or a string to be used for the todo mark." )
10854 (defvar org-agenda-headline-snapshot-before-repeat)
10856 (defun org-todo (&optional arg)
10857 "Change the TODO state of an item.
10858 The state of an item is given by a keyword at the start of the heading,
10859 like
10860 *** TODO Write paper
10861 *** DONE Call mom
10863 The different keywords are specified in the variable `org-todo-keywords'.
10865 So for this example: when the item starts with TODO, it is changed to DONE.
10866 When it starts with DONE, the DONE is removed. And when neither TODO nor
10867 DONE are present, add TODO at the beginning of the heading.
10870 state.
10871 With numeric prefix arg, switch to that state.
10873 keywords (nextset).
10876 For calling through lisp, arg is also interpreted in the following way:
10877 'none -> empty state
10879 'done -> switch to DONE
10880 'nextset -> switch to the next set of keywords
10881 'previousset -> switch to the previous set of keywords
10883 really is a member of `org-todo-keywords'."
10884 (interactive "P")
10885 (if (equal arg '(16)) (setq arg 'nextset))
10886 (let ((org-blocker-hook org-blocker-hook)
10887 (case-fold-search nil))
10888 (when (equal arg '(64))
10889 (setq arg nil org-blocker-hook nil))
10890 (when (and org-blocker-hook
10891 (or org-inhibit-blocking
10892 (org-entry-get nil "NOBLOCKING")))
10893 (setq org-blocker-hook nil))
10894 (save-excursion
10895 (catch 'exit
10896 (org-back-to-heading t)
10897 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10899 (looking-at " *"))
10900 (let* ((match-data (match-data))
10901 (startpos (point-at-bol))
10902 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10903 (org-log-done org-log-done)
10904 (org-log-repeat org-log-repeat)
10905 (org-todo-log-states org-todo-log-states)
10906 (this (match-string 1))
10907 (hl-pos (match-beginning 0))
10908 (head (org-get-todo-sequence-head this))
10909 (ass (assoc head org-todo-kwd-alist))
10910 (interpret (nth 1 ass))
10911 (done-word (nth 3 ass))
10912 (final-done-word (nth 4 ass))
10913 (last-state (or this ""))
10914 (completion-ignore-case t)
10915 (member (member this org-todo-keywords-1))
10916 (tail (cdr member))
10917 (state (cond
10918 ((and org-todo-key-trigger
10919 (or (and (equal arg '(4))
10920 (eq org-use-fast-todo-selection 'prefix))
10921 (and (not arg) org-use-fast-todo-selection
10922 (not (eq org-use-fast-todo-selection
10923 'prefix)))))
10924 ;; Use fast selection
10925 (org-fast-todo-selection))
10926 ((and (equal arg '(4))
10927 (or (not org-use-fast-todo-selection)
10928 (not org-todo-key-trigger)))
10929 ;; Read a state with completion
10930 (org-icompleting-read
10931 "State: " (mapcar (lambda(x) (list x))
10932 org-todo-keywords-1)
10933 nil t))
10934 ((eq arg 'right)
10935 (if this
10936 (if tail (car tail) nil)
10937 (car org-todo-keywords-1)))
10938 ((eq arg 'left)
10939 (if (equal member org-todo-keywords-1)
10940 nil
10941 (if this
10942 (nth (- (length org-todo-keywords-1)
10943 (length tail) 2)
10944 org-todo-keywords-1)
10945 (org-last org-todo-keywords-1))))
10946 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10947 (setq arg nil))) ; hack to fall back to cycling
10948 (arg
10949 ;; user or caller requests a specific state
10950 (cond
10951 ((equal arg "") nil)
10952 ((eq arg 'none) nil)
10953 ((eq arg 'done) (or done-word (car org-done-keywords)))
10954 ((eq arg 'nextset)
10955 (or (car (cdr (member head org-todo-heads)))
10956 (car org-todo-heads)))
10957 ((eq arg 'previousset)
10958 (let ((org-todo-heads (reverse org-todo-heads)))
10959 (or (car (cdr (member head org-todo-heads)))
10960 (car org-todo-heads))))
10961 ((car (member arg org-todo-keywords-1)))
10962 ((stringp arg)
10963 (error "State `%s' not valid in this file" arg))
10964 ((nth (1- (prefix-numeric-value arg))
10965 org-todo-keywords-1))))
10966 ((null member) (or head (car org-todo-keywords-1)))
10967 ((equal this final-done-word) nil) ;; -> make empty
10968 ((null tail) nil) ;; -> first entry
10969 ((memq interpret '(type priority))
10970 (if (eq this-command last-command)
10971 (car tail)
10972 (if (> (length tail) 0)
10973 (or done-word (car org-done-keywords))
10974 nil)))
10975 (t
10976 (car tail))))
10977 (state (or
10978 (run-hook-with-args-until-success
10979 'org-todo-get-default-hook state last-state)
10980 state))
10981 (next (if state (concat " " state " ") " "))
10982 (change-plist (list :type 'todo-state-change :from this :to state
10983 :position startpos))
10984 dolog now-done-p)
10985 (when org-blocker-hook
10986 (setq org-last-todo-state-is-todo
10987 (not (member this org-done-keywords)))
10988 (unless (save-excursion
10989 (save-match-data
10990 (org-with-wide-buffer
10991 (run-hook-with-args-until-failure
10992 'org-blocker-hook change-plist))))
10993 (if (interactive-p)
10994 (error "TODO state change from %s to %s blocked" this state)
10995 ;; fail silently
10996 (message "TODO state change from %s to %s blocked" this state)
10997 (throw 'exit nil))))
10998 (store-match-data match-data)
10999 (replace-match next t t)
11000 (unless (pos-visible-in-window-p hl-pos)
11001 (message "TODO state changed to %s" (org-trim next)))
11002 (unless head
11003 (setq head (org-get-todo-sequence-head state)
11004 ass (assoc head org-todo-kwd-alist)
11005 interpret (nth 1 ass)
11006 done-word (nth 3 ass)
11007 final-done-word (nth 4 ass)))
11008 (when (memq arg '(nextset previousset))
11009 (message "Keyword-Set %d/%d: %s"
11010 (- (length org-todo-sets) -1
11011 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11012 (length org-todo-sets)
11013 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11014 (setq org-last-todo-state-is-todo
11015 (not (member state org-done-keywords)))
11016 (setq now-done-p (and (member state org-done-keywords)
11017 (not (member this org-done-keywords))))
11018 (and logging (org-local-logging logging))
11019 (when (and (or org-todo-log-states org-log-done)
11020 (not (eq org-inhibit-logging t))
11021 (not (memq arg '(nextset previousset))))
11022 ;; we need to look at recording a time and note
11023 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11024 (nth 2 (assoc this org-todo-log-states))))
11025 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11026 (setq dolog 'time))
11027 (when (and state
11028 (member state org-not-done-keywords)
11029 (not (member this org-not-done-keywords)))
11030 ;; This is now a todo state and was not one before
11031 ;; If there was a CLOSED time stamp, get rid of it.
11032 (org-add-planning-info nil nil 'closed))
11033 (when (and now-done-p org-log-done)
11034 ;; It is now done, and it was not done before
11035 (org-add-planning-info 'closed (org-current-time))
11036 (if (and (not dolog) (eq 'note org-log-done))
11037 (org-add-log-setup 'done state this 'findpos 'note)))
11038 (when (and state dolog)
11039 ;; This is a non-nil state, and we need to log it
11040 (org-add-log-setup 'state state this 'findpos dolog)))
11041 ;; Fixup tag positioning
11042 (org-todo-trigger-tag-changes state)
11043 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11044 (when org-provide-todo-statistics
11045 (org-update-parent-todo-statistics))
11046 (run-hooks 'org-after-todo-state-change-hook)
11047 (if (and arg (not (member state org-done-keywords)))
11048 (setq head (org-get-todo-sequence-head state)))
11049 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11050 ;; Do we need to trigger a repeat?
11051 (when now-done-p
11052 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11053 ;; This is for the agenda, take a snapshot of the headline.
11054 (save-match-data
11055 (setq org-agenda-headline-snapshot-before-repeat
11056 (org-get-heading))))
11057 (org-auto-repeat-maybe state))
11058 ;; Fixup cursor location if close to the keyword
11059 (if (and (outline-on-heading-p)
11060 (not (bolp))
11061 (save-excursion (beginning-of-line 1)
11062 (looking-at org-todo-line-regexp))
11063 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11064 (progn
11065 (goto-char (or (match-end 2) (match-end 1)))
11066 (and (looking-at " ") (just-one-space))))
11067 (when org-trigger-hook
11068 (save-excursion
11069 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11071 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11072 "Block turning an entry into a TODO, using the hierarchy.
11073 This checks whether the current task should be blocked from state
11074 changes. Such blocking occurs when:
11076 1. The task has children which are not all in a completed state.
11078 2. A task has a parent with the property :ORDERED:, and there
11079 are siblings prior to the current task with incomplete
11080 status.
11082 3. The parent of the task is blocked because it has siblings that should
11083 be done first, or is child of a block grandparent TODO entry."
11085 (if (not org-enforce-todo-dependencies)
11086 t ; if locally turned off don't block
11087 (catch 'dont-block
11088 ;; If this is not a todo state change, or if this entry is already DONE,
11089 ;; do not block
11090 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11091 (member (plist-get change-plist :from)
11092 (cons 'done org-done-keywords))
11093 (member (plist-get change-plist :to)
11094 (cons 'todo org-not-done-keywords))
11095 (not (plist-get change-plist :to)))
11096 (throw 'dont-block t))
11097 ;; If this task has children, and any are undone, it's blocked
11098 (save-excursion
11099 (org-back-to-heading t)
11100 (let ((this-level (funcall outline-level)))
11101 (outline-next-heading)
11102 (let ((child-level (funcall outline-level)))
11103 (while (and (not (eobp))
11104 (> child-level this-level))
11105 ;; this todo has children, check whether they are all
11106 ;; completed
11107 (if (and (not (org-entry-is-done-p))
11108 (org-entry-is-todo-p))
11109 (throw 'dont-block nil))
11110 (outline-next-heading)
11111 (setq child-level (funcall outline-level))))))
11112 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11113 ;; any previous siblings are undone, it's blocked
11114 (save-excursion
11115 (org-back-to-heading t)
11116 (let* ((pos (point))
11117 (parent-pos (and (org-up-heading-safe) (point))))
11118 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11119 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11120 (forward-line 1)
11121 (re-search-forward org-not-done-heading-regexp pos t))
11122 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11123 ;; Search further up the hierarchy, to see if an anchestor is blocked
11124 (while t
11125 (goto-char parent-pos)
11126 (if (not (looking-at org-not-done-heading-regexp))
11127 (throw 'dont-block t)) ; do not block, parent is not a TODO
11128 (setq pos (point))
11129 (setq parent-pos (and (org-up-heading-safe) (point)))
11130 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11131 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11132 (forward-line 1)
11133 (re-search-forward org-not-done-heading-regexp pos t))
11134 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11136 (defcustom org-track-ordered-property-with-tag nil
11137 "Should the ORDERED property also be shown as a tag?
11138 The ORDERED property decides if an entry should require subtasks to be
11139 completed in sequence. Since a property is not very visible, setting
11140 this option means that toggling the ORDERED property with the command
11141 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11142 not relevant for the behavior, but it makes things more visible.
11144 Note that toggling the tag with tags commands will not change the property
11145 and therefore not influence behavior!
11147 This can be t, meaning the tag ORDERED should be used, It can also be a
11148 string to select a different tag for this task."
11149 :group 'org-todo
11150 :type '(choice
11151 (const :tag "No tracking" nil)
11152 (const :tag "Track with ORDERED tag" t)
11153 (string :tag "Use other tag")))
11155 (defun org-toggle-ordered-property ()
11156 "Toggle the ORDERED property of the current entry.
11157 For better visibility, you can track the value of this property with a tag.
11158 See variable `org-track-ordered-property-with-tag'."
11159 (interactive)
11160 (let* ((t1 org-track-ordered-property-with-tag)
11161 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11162 (save-excursion
11163 (org-back-to-heading)
11164 (if (org-entry-get nil "ORDERED")
11165 (progn
11166 (org-delete-property "ORDERED")
11167 (and tag (org-toggle-tag tag 'off))
11168 (message "Subtasks can be completed in arbitrary order"))
11169 (org-entry-put nil "ORDERED" "t")
11170 (and tag (org-toggle-tag tag 'on))
11171 (message "Subtasks must be completed in sequence")))))
11173 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11174 (defun org-block-todo-from-checkboxes (change-plist)
11175 "Block turning an entry into a TODO, using checkboxes.
11176 This checks whether the current task should be blocked from state
11177 changes because there are unchecked boxes in this entry."
11178 (if (not org-enforce-todo-checkbox-dependencies)
11179 t ; if locally turned off don't block
11180 (catch 'dont-block
11181 ;; If this is not a todo state change, or if this entry is already DONE,
11182 ;; do not block
11183 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11184 (member (plist-get change-plist :from)
11185 (cons 'done org-done-keywords))
11186 (member (plist-get change-plist :to)
11187 (cons 'todo org-not-done-keywords))
11188 (not (plist-get change-plist :to)))
11189 (throw 'dont-block t))
11190 ;; If this task has checkboxes that are not checked, it's blocked
11191 (save-excursion
11192 (org-back-to-heading t)
11193 (let ((beg (point)) end)
11194 (outline-next-heading)
11195 (setq end (point))
11196 (goto-char beg)
11198 end t)
11199 (progn
11200 (if (boundp 'org-blocked-by-checkboxes)
11201 (setq org-blocked-by-checkboxes t))
11202 (throw 'dont-block nil)))))
11203 t))) ; do not block
11205 (defun org-entry-blocked-p ()
11206 "Is the current entry blocked?"
11207 (if (org-entry-get nil "NOBLOCKING")
11208 nil ;; Never block this entry
11209 (not
11210 (run-hook-with-args-until-failure
11211 'org-blocker-hook
11212 (list :type 'todo-state-change
11213 :position (point)
11214 :from 'todo
11215 :to 'done)))))
11217 (defun org-update-statistics-cookies (all)
11218 "Update the statistics cookie, either from TODO or from checkboxes.
11219 This should be called with the cursor in a line with a statistics cookie."
11220 (interactive "P")
11221 (if all
11222 (progn
11223 (org-update-checkbox-count 'all)
11224 (org-map-entries 'org-update-parent-todo-statistics))
11225 (if (not (org-on-heading-p))
11226 (org-update-checkbox-count)
11227 (let ((pos (move-marker (make-marker) (point)))
11228 end l1 l2)
11229 (ignore-errors (org-back-to-heading t))
11230 (if (not (org-on-heading-p))
11231 (org-update-checkbox-count)
11232 (setq l1 (org-outline-level))
11233 (setq end (save-excursion
11234 (outline-next-heading)
11235 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11236 (point)))
11237 (if (and (save-excursion
11238 (re-search-forward
11240 (not (save-excursion (re-search-forward
11242 (org-update-checkbox-count)
11243 (if (and l2 (> l2 l1))
11244 (progn
11245 (goto-char end)
11246 (org-update-parent-todo-statistics))
11247 (goto-char pos)
11248 (beginning-of-line 1)
11249 (while (re-search-forward
11251 (point-at-eol) t)
11252 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11253 (goto-char pos)
11254 (move-marker pos nil)))))
11256 (defvar org-entry-property-inherited-from) ;; defined below
11257 (defun org-update-parent-todo-statistics ()
11258 "Update any statistics cookie in the parent of the current headline.
11259 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11260 the entire subtree and this will travel up the hierarchy and update
11261 statistics everywhere."
11262 (interactive)
11263 (let* ((lim 0) prop
11264 (recursive (or (not org-hierarchical-todo-statistics)
11265 (string-match
11267 (or (setq prop (org-entry-get
11268 nil "COOKIE_DATA" 'inherit)) ""))))
11269 (lim (or (and prop (marker-position
11270 org-entry-property-inherited-from))
11271 lim))
11272 (first t)
11274 level ltoggle l1 new ndel
11275 (cnt-all 0) (cnt-done 0) is-percent kwd
11276 checkbox-beg ov ovs ove cookie-present)
11277 (catch 'exit
11278 (save-excursion
11279 (beginning-of-line 1)
11280 (if (org-at-heading-p)
11281 (setq ltoggle (funcall outline-level))
11282 (error "This should not happen"))
11283 (while (and (setq level (org-up-heading-safe))
11284 (or recursive first)
11285 (>= (point) lim))
11286 (setq first nil cookie-present nil)
11287 (unless (and level
11288 (not (string-match
11290 (downcase
11291 (or (org-entry-get
11292 nil "COOKIE_DATA")
11293 "")))))
11294 (throw 'exit nil))
11295 (while (re-search-forward box-re (point-at-eol) t)
11296 (setq cnt-all 0 cnt-done 0 cookie-present t)
11297 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11298 (save-match-data
11299 (unless (outline-next-heading) (throw 'exit nil))
11300 (while (and (looking-at org-complex-heading-regexp)
11301 (> (setq l1 (length (match-string 1))) level))
11302 (setq kwd (and (or recursive (= l1 ltoggle))
11303 (match-string 2)))
11304 (if (or (eq org-provide-todo-statistics 'all-headlines)
11305 (and (listp org-provide-todo-statistics)
11306 (or (member kwd org-provide-todo-statistics)
11307 (member kwd org-done-keywords))))
11308 (setq cnt-all (1+ cnt-all))
11309 (if (eq org-provide-todo-statistics t)
11310 (and kwd (setq cnt-all (1+ cnt-all)))))
11311 (and (member kwd org-done-keywords)
11312 (setq cnt-done (1+ cnt-done)))
11313 (outline-next-heading)))
11314 (setq new
11315 (if is-percent
11316 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11317 (format "[%d/%d]" cnt-done cnt-all))
11318 ndel (- (match-end 0) checkbox-beg))
11319 ;; handle overlays when updating cookie from column view
11320 (when (setq ov (car (overlays-at checkbox-beg)))
11321 (setq ovs (overlay-start ov) ove (overlay-end ov))
11322 (delete-overlay ov))
11323 (goto-char checkbox-beg)
11324 (insert new)
11325 (delete-region (point) (+ (point) ndel))
11326 (when ov (move-overlay ov ovs ove)))
11327 (when cookie-present
11328 (run-hook-with-args 'org-after-todo-statistics-hook
11329 cnt-done (- cnt-all cnt-done))))))
11330 (run-hooks 'org-todo-statistics-hook)))
11332 (defvar org-after-todo-statistics-hook nil
11333 "Hook that is called after a TODO statistics cookie has been updated.
11334 Each function is called with two arguments: the number of not-done entries
11335 and the number of done entries.
11337 For example, the following function, when added to this hook, will switch
11338 an entry to DONE when all children are done, and back to TODO when new
11339 entries are set to a TODO status. Note that this hook is only called
11340 when there is a statistics cookie in the headline!
11342 (defun org-summary-todo (n-done n-not-done)
11344 (let (org-log-done org-log-states) ; turn off logging
11346 ")
11348 (defvar org-todo-statistics-hook nil
11349 "Hook that is run whenever Org thinks TODO statistics should be updated.
11350 This hook runs even if there is no statistics cookie present, in which case
11351 `org-after-todo-statistics-hook' would not run.")
11353 (defun org-todo-trigger-tag-changes (state)
11354 "Apply the changes defined in `org-todo-state-tags-triggers'."
11355 (let ((l org-todo-state-tags-triggers)
11356 changes)
11357 (when (or (not state) (equal state ""))
11358 (setq changes (append changes (cdr (assoc "" l)))))
11359 (when (and (stringp state) (> (length state) 0))
11360 (setq changes (append changes (cdr (assoc state l)))))
11361 (when (member state org-not-done-keywords)
11362 (setq changes (append changes (cdr (assoc 'todo l)))))
11363 (when (member state org-done-keywords)
11364 (setq changes (append changes (cdr (assoc 'done l)))))
11365 (dolist (c changes)
11366 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11368 (defun org-local-logging (value)
11369 "Get logging settings from a property VALUE."
11370 (let* (words w a)
11371 ;; directly set the variables, they are already local.
11372 (setq org-log-done nil
11373 org-log-repeat nil
11374 org-todo-log-states nil)
11375 (setq words (org-split-string value))
11376 (while (setq w (pop words))
11377 (cond
11378 ((setq a (assoc w org-startup-options))
11379 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11380 (set (nth 1 a) (nth 2 a))))
11381 ((setq a (org-extract-log-state-settings w))
11382 (and (member (car a) org-todo-keywords-1)
11383 (push a org-todo-log-states)))))))
11385 (defun org-get-todo-sequence-head (kwd)
11386 "Return the head of the TODO sequence to which KWD belongs.
11387 If KWD is not set, check if there is a text property remembering the
11388 right sequence."
11389 (let (p)
11390 (cond
11391 ((not kwd)
11392 (or (get-text-property (point-at-bol) 'org-todo-head)
11393 (progn
11394 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11395 nil (point-at-eol)))
11396 (get-text-property p 'org-todo-head))))
11397 ((not (member kwd org-todo-keywords-1))
11398 (car org-todo-keywords-1))
11399 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11401 (defun org-fast-todo-selection ()
11402 "Fast TODO keyword selection with single keys.
11403 Returns the new TODO keyword, or nil if no state change should occur."
11404 (let* ((fulltable org-todo-key-alist)
11405 (done-keywords org-done-keywords) ;; needed for the faces.
11406 (maxlen (apply 'max (mapcar
11407 (lambda (x)
11408 (if (stringp (car x)) (string-width (car x)) 0))
11409 fulltable)))
11410 (expert nil)
11411 (fwidth (+ maxlen 3 1 3))
11412 (ncol (/ (- (window-width) 4) fwidth))
11413 tg cnt e c tbl
11414 groups ingroup)
11415 (save-excursion
11416 (save-window-excursion
11417 (if expert
11418 (set-buffer (get-buffer-create " *Org todo*"))
11419 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11420 (erase-buffer)
11421 (org-set-local 'org-done-keywords done-keywords)
11422 (setq tbl fulltable cnt 0)
11423 (while (setq e (pop tbl))
11424 (cond
11425 ((equal e '(:startgroup))
11426 (push '() groups) (setq ingroup t)
11427 (when (not (= cnt 0))
11428 (setq cnt 0)
11430 (insert "{ "))
11431 ((equal e '(:endgroup))
11432 (setq ingroup nil cnt 0)
11434 ((equal e '(:newline))
11435 (when (not (= cnt 0))
11436 (setq cnt 0)
11438 (setq e (car tbl))
11439 (while (equal (car tbl) '(:newline))
11441 (setq tbl (cdr tbl)))))
11442 (t
11443 (setq tg (car e) c (cdr e))
11444 (if ingroup (push tg (car groups)))
11445 (setq tg (org-add-props tg nil 'face
11446 (org-get-todo-face tg)))
11447 (if (and (= cnt 0) (not ingroup)) (insert " "))
11448 (insert "[" c "] " tg (make-string
11449 (- fwidth 4 (length tg)) ?\ ))
11450 (when (= (setq cnt (1+ cnt)) ncol)
11452 (if ingroup (insert " "))
11453 (setq cnt 0)))))
11455 (goto-char (point-min))
11456 (if (not expert) (org-fit-window-to-buffer))
11457 (message "[a-z..]:Set [SPC]:clear")
11458 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11459 (cond
11460 ((or (= c ?\C-g)
11461 (and (= c ?q) (not (rassoc c fulltable))))
11462 (setq quit-flag t))
11463 ((= c ?\ ) nil)
11464 ((setq e (rassoc c fulltable) tg (car e))
11465 tg)
11466 (t (setq quit-flag t)))))))
11468 (defun org-entry-is-todo-p ()
11469 (member (org-get-todo-state) org-not-done-keywords))
11471 (defun org-entry-is-done-p ()
11472 (member (org-get-todo-state) org-done-keywords))
11474 (defun org-get-todo-state ()
11475 (save-excursion
11476 (org-back-to-heading t)
11477 (and (looking-at org-todo-line-regexp)
11478 (match-end 2)
11479 (match-string 2))))
11481 (defun org-at-date-range-p (&optional inactive-ok)
11482 "Is the cursor inside a date range?"
11483 (interactive)
11484 (save-excursion
11485 (catch 'exit
11486 (let ((pos (point)))
11488 (skip-chars-backward "<[")
11489 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11490 (>= (match-end 0) pos)
11491 (throw 'exit t))
11493 (skip-chars-backward "<[")
11494 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11495 (>= (match-end 0) pos)
11496 (throw 'exit t)))
11497 nil)))
11499 (defun org-get-repeat (&optional tagline)
11500 "Check if there is a deadline/schedule with repeater in this entry."
11501 (save-match-data
11502 (save-excursion
11503 (org-back-to-heading t)
11504 (and (re-search-forward (if tagline
11506 org-repeat-re)
11507 (org-entry-end-position) t)
11508 (match-string-no-properties 1)))))
11510 (defvar org-last-changed-timestamp)
11511 (defvar org-last-inserted-timestamp)
11512 (defvar org-log-post-message)
11513 (defvar org-log-note-purpose)
11514 (defvar org-log-note-how)
11515 (defvar org-log-note-extra)
11516 (defun org-auto-repeat-maybe (done-word)
11517 "Check if the current headline contains a repeated deadline/schedule.
11518 If yes, set TODO state back to what it was and change the base date
11519 of repeating deadline/scheduled time stamps to new date.
11520 This function is run automatically after each state change to a DONE state."
11521 ;; last-state is dynamically scoped into this function
11522 (let* ((repeat (org-get-repeat))
11523 (aa (assoc last-state org-todo-kwd-alist))
11524 (interpret (nth 1 aa))
11525 (head (nth 2 aa))
11526 (whata '(("d" . day) ("m" . month) ("y" . year)))
11527 (msg "Entry repeats: ")
11528 (org-log-done nil)
11529 (org-todo-log-states nil)
11530 re type n what ts time to-state)
11531 (when repeat
11532 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11533 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11534 org-todo-repeat-to-state))
11535 (unless (and to-state (member to-state org-todo-keywords-1))
11536 (setq to-state (if (eq interpret 'type) last-state head)))
11537 (org-todo to-state)
11538 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11539 (org-entry-put nil "LAST_REPEAT" (format-time-string
11540 (org-time-stamp-format t t))))
11541 (when org-log-repeat
11542 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11543 (memq 'org-add-log-note post-command-hook))
11544 ;; OK, we are already setup for some record
11545 (if (eq org-log-repeat 'note)
11546 ;; make sure we take a note, not only a time stamp
11547 (setq org-log-note-how 'note))
11548 ;; Set up for taking a record
11549 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11550 last-state
11551 'findpos org-log-repeat)))
11552 (org-back-to-heading t)
11553 (org-add-planning-info nil nil 'closed)
11557 (while (re-search-forward
11558 re (save-excursion (outline-next-heading) (point)) t)
11559 (setq type (if (match-end 1) org-scheduled-string
11560 (if (match-end 3) org-deadline-string "Plain:"))
11561 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11563 (setq n (string-to-number (match-string 2 ts))
11564 what (match-string 3 ts))
11565 (if (equal what "w") (setq n (* n 7) what "d"))
11566 ;; Preparation, see if we need to modify the start date for the change
11567 (when (match-end 1)
11568 (setq time (save-match-data (org-time-string-to-time ts)))
11569 (cond
11570 ((equal (match-string 1 ts) ".")
11571 ;; Shift starting date to today
11572 (org-timestamp-change
11573 (- (time-to-days (current-time)) (time-to-days time))
11574 'day))
11575 ((equal (match-string 1 ts) "+")
11576 (let ((nshiftmax 10) (nshift 0))
11577 (while (or (= nshift 0)
11578 (<= (time-to-days time)
11579 (time-to-days (current-time))))
11580 (when (= (incf nshift) nshiftmax)
11581 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11582 (error "Abort")))
11583 (org-timestamp-change n (cdr (assoc what whata)))
11584 (org-at-timestamp-p t)
11585 (setq ts (match-string 1))
11586 (setq time (save-match-data (org-time-string-to-time ts)))))
11587 (org-timestamp-change (- n) (cdr (assoc what whata)))
11588 ;; rematch, so that we have everything in place for the real shift
11589 (org-at-timestamp-p t)
11590 (setq ts (match-string 1))
11592 (org-timestamp-change n (cdr (assoc what whata)))
11593 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11594 (setq org-log-post-message msg)
11595 (message "%s" msg))))
11597 (defun org-show-todo-tree (arg)
11598 "Make a compact tree which shows all headlines marked with TODO.
11599 The tree will show the lines where the regexp matches, and all higher
11600 headlines above the match.
11602 With a numeric prefix N, construct a sparse tree for the Nth element
11603 of `org-todo-keywords-1'."
11604 (interactive "P")
11605 (let ((case-fold-search nil)
11606 (kwd-re
11607 (cond ((null arg) org-not-done-regexp)
11608 ((equal arg '(4))
11609 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11610 (mapcar 'list org-todo-keywords-1))))
11614 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11615 (regexp-quote (nth (1- (prefix-numeric-value arg))
11616 org-todo-keywords-1)))
11617 (t (error "Invalid prefix argument: %s" arg)))))
11618 (message "%d TODO entries found"
11619 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11621 (defun org-deadline (&optional remove time)
11623 With argument REMOVE, remove any deadline from the item.
11624 When TIME is set, it should be an internal time specification, and the
11625 scheduling will use the corresponding date."
11626 (interactive "P")
11627 (let* ((old-date (org-entry-get nil "DEADLINE"))
11628 (repeater (and old-date
11629 (string-match
11631 old-date)
11632 (match-string 1 old-date))))
11633 (if remove
11634 (progn
11635 (when (and old-date org-log-redeadline)
11636 (org-add-log-setup 'deldeadline nil old-date 'findpos
11637 org-log-redeadline))
11638 (org-remove-timestamp-with-keyword org-deadline-string)
11639 (message "Item no longer has a deadline."))
11640 (org-add-planning-info 'deadline time 'closed)
11641 (when (and old-date org-log-redeadline
11642 (not (equal old-date
11643 (substring org-last-inserted-timestamp 1 -1))))
11644 (org-add-log-setup 'redeadline nil old-date 'findpos
11645 org-log-redeadline))
11646 (when repeater
11647 (save-excursion
11648 (org-back-to-heading t)
11649 (when (re-search-forward (concat org-deadline-string " "
11650 org-last-inserted-timestamp)
11651 (save-excursion
11652 (outline-next-heading) (point)) t)
11653 (goto-char (1- (match-end 0)))
11654 (insert " " repeater)
11655 (setq org-last-inserted-timestamp
11656 (concat (substring org-last-inserted-timestamp 0 -1)
11657 " " repeater
11658 (substring org-last-inserted-timestamp -1))))))
11659 (message "Deadline on %s" org-last-inserted-timestamp))))
11661 (defun org-schedule (&optional remove time)
11662 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11663 With argument REMOVE, remove any scheduling date from the item.
11664 When TIME is set, it should be an internal time specification, and the
11665 scheduling will use the corresponding date."
11666 (interactive "P")
11667 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11668 (repeater (and old-date
11669 (string-match
11671 old-date)
11672 (match-string 1 old-date))))
11673 (if remove
11674 (progn
11675 (when (and old-date org-log-reschedule)
11676 (org-add-log-setup 'delschedule nil old-date 'findpos
11677 org-log-reschedule))
11678 (org-remove-timestamp-with-keyword org-scheduled-string)
11679 (message "Item is no longer scheduled."))
11680 (org-add-planning-info 'scheduled time 'closed)
11681 (when (and old-date org-log-reschedule
11682 (not (equal old-date
11683 (substring org-last-inserted-timestamp 1 -1))))
11684 (org-add-log-setup 'reschedule nil old-date 'findpos
11685 org-log-reschedule))
11686 (when repeater
11687 (save-excursion
11688 (org-back-to-heading t)
11689 (when (re-search-forward (concat org-scheduled-string " "
11690 org-last-inserted-timestamp)
11691 (save-excursion
11692 (outline-next-heading) (point)) t)
11693 (goto-char (1- (match-end 0)))
11694 (insert " " repeater)
11695 (setq org-last-inserted-timestamp
11696 (concat (substring org-last-inserted-timestamp 0 -1)
11697 " " repeater
11698 (substring org-last-inserted-timestamp -1))))))
11699 (message "Scheduled to %s" org-last-inserted-timestamp))))
11701 (defun org-get-scheduled-time (pom &optional inherit)
11702 "Get the scheduled time as a time tuple, of a format suitable
11703 for calling org-schedule with, or if there is no scheduling,
11704 returns nil."
11705 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11706 (when time
11707 (apply 'encode-time (org-parse-time-string time)))))
11709 (defun org-get-deadline-time (pom &optional inherit)
11710 "Get the deadline as a time tuple, of a format suitable for
11711 calling org-deadline with, or if there is no scheduling, returns
11712 nil."
11713 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11714 (when time
11715 (apply 'encode-time (org-parse-time-string time)))))
11717 (defun org-remove-timestamp-with-keyword (keyword)
11718 "Remove all time stamps with KEYWORD in the current entry."
11720 beg)
11721 (save-excursion
11722 (org-back-to-heading t)
11723 (setq beg (point))
11724 (outline-next-heading)
11725 (while (re-search-backward re beg t)
11726 (replace-match "")
11728 (equal (char-before) ?\ ))
11729 (backward-delete-char 1)
11731 (point-at-bol) (point-at-eol)))
11732 (delete-region (point-at-bol)
11733 (min (point-max) (1+ (point-at-eol))))))))))
11735 (defun org-add-planning-info (what &optional time &rest remove)
11736 "Insert new timestamp with keyword in the line directly after the headline.
11737 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11738 If non is given, the user is prompted for a date.
11739 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11740 be removed."
11741 (interactive)
11742 (let (org-time-was-given org-end-time-was-given ts
11743 end default-time default-input)
11745 (catch 'exit
11746 (when (and (not time) (memq what '(scheduled deadline)))
11747 ;; Try to get a default date/time from existing timestamp
11748 (save-excursion
11749 (org-back-to-heading t)
11750 (setq end (save-excursion (outline-next-heading) (point)))
11751 (when (re-search-forward (if (eq what 'scheduled)
11752 org-scheduled-time-regexp
11753 org-deadline-time-regexp)
11754 end t)
11755 (setq ts (match-string 1)
11756 default-time
11757 (apply 'encode-time (org-parse-time-string ts))
11758 default-input (and ts (org-get-compact-tod ts))))))
11759 (when what
11760 ;; If necessary, get the time from the user
11761 (setq time (or time (org-read-date nil 'to-time nil nil
11762 default-time default-input))))
11764 (when (and org-insert-labeled-timestamps-at-point
11765 (member what '(scheduled deadline)))
11766 (insert
11767 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11768 (org-insert-time-stamp time org-time-was-given
11769 nil nil nil (list org-end-time-was-given))
11770 (setq what nil))
11771 (save-excursion
11772 (save-restriction
11773 (let (col list elt ts buffer-invisibility-spec)
11774 (org-back-to-heading t)
11776 (goto-char (match-end 1))
11777 (setq col (current-column))
11778 (goto-char (match-end 0))
11780 (when (and (not what)
11781 (not (looking-at
11783 org-keyword-time-not-clock-regexp))))
11784 ;; Nothing to add, nothing to remove...... :-)
11785 (throw 'exit nil))
11786 (if (and (not (looking-at outline-regexp))
11789 (not (equal (match-string 1) org-clock-string)))
11790 (narrow-to-region (match-beginning 0) (match-end 0))
11792 (backward-char 1)
11793 (narrow-to-region (point) (point))
11794 (and org-adapt-indentation (org-indent-to-column col)))
11795 ;; Check if we have to remove something.
11796 (setq list (cons what remove))
11797 (while list
11798 (setq elt (pop list))
11799 (goto-char (point-min))
11800 (when (or (and (eq elt 'scheduled)
11801 (re-search-forward org-scheduled-time-regexp nil t))
11802 (and (eq elt 'deadline)
11803 (re-search-forward org-deadline-time-regexp nil t))
11804 (and (eq elt 'closed)
11805 (re-search-forward org-closed-time-regexp nil t)))
11806 (replace-match "")
11807 (if (looking-at "--+<[^>]+>") (replace-match ""))
11808 (skip-chars-backward " ")
11809 (if (looking-at " +") (replace-match ""))))
11810 (goto-char (point-max))
11811 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11812 (when what
11813 (insert
11814 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11815 (cond ((eq what 'scheduled) org-scheduled-string)
11816 ((eq what 'deadline) org-deadline-string)
11817 ((eq what 'closed) org-closed-string))
11818 " ")
11819 (setq ts (org-insert-time-stamp
11820 time
11821 (or org-time-was-given
11822 (and (eq what 'closed) org-log-done-with-time))
11823 (eq what 'closed)
11824 nil nil (list org-end-time-was-given)))
11825 (end-of-line 1))
11826 (goto-char (point-min))
11827 (widen)
11830 (delete-region (1- (point)) (point-at-eol)))
11831 ts))))))
11833 (defvar org-log-note-marker (make-marker))
11834 (defvar org-log-note-purpose nil)
11835 (defvar org-log-note-state nil)
11836 (defvar org-log-note-previous-state nil)
11837 (defvar org-log-note-how nil)
11838 (defvar org-log-note-extra nil)
11839 (defvar org-log-note-window-configuration nil)
11840 (defvar org-log-note-return-to (make-marker))
11841 (defvar org-log-post-message nil
11842 "Message to be displayed after a log note has been stored.
11843 The auto-repeater uses this.")
11845 (defun org-add-note ()
11846 "Add a note to the current entry.
11847 This is done in the same way as adding a state change note."
11848 (interactive)
11849 (org-add-log-setup 'note nil nil 'findpos nil))
11851 (defvar org-property-end-re)
11852 (defun org-add-log-setup (&optional purpose state prev-state
11853 findpos how extra)
11854 "Set up the post command hook to take a note.
11855 If this is about to TODO state change, the new state is expected in STATE.
11856 When FINDPOS is non-nil, find the correct position for the note in
11857 the current entry. If not, assume that it can be inserted at point.
11858 HOW is an indicator what kind of note should be created.
11859 EXTRA is additional text that will be inserted into the notes buffer."
11860 (let* ((org-log-into-drawer (org-log-into-drawer))
11861 (drawer (cond ((stringp org-log-into-drawer)
11862 org-log-into-drawer)
11863 (org-log-into-drawer "LOGBOOK")
11864 (t nil))))
11865 (save-restriction
11866 (save-excursion
11867 (when findpos
11868 (org-back-to-heading t)
11869 (narrow-to-region (point) (save-excursion
11870 (outline-next-heading) (point)))
11874 (goto-char (match-end 0))
11875 (cond
11876 (drawer
11878 nil t)
11879 (progn
11880 (goto-char (match-end 0))
11881 (or org-log-states-order-reversed
11882 (and (re-search-forward org-property-end-re nil t)
11883 (goto-char (1- (match-beginning 0))))))
11885 (beginning-of-line 0)
11886 (org-indent-line-function)
11887 (beginning-of-line 2)
11888 (org-indent-line-function)
11889 (end-of-line 0)))
11890 ((and org-log-state-notes-insert-after-drawers
11891 (save-excursion
11892 (forward-line) (looking-at org-drawer-regexp)))
11893 (forward-line)
11894 (while (looking-at org-drawer-regexp)
11895 (goto-char (match-end 0))
11896 (re-search-forward org-property-end-re (point-max) t)
11897 (forward-line))
11898 (forward-line -1)))
11899 (unless org-log-states-order-reversed
11901 (org-skip-over-state-notes)
11903 (move-marker org-log-note-marker (point))
11904 (setq org-log-note-purpose purpose
11905 org-log-note-state state
11906 org-log-note-previous-state prev-state
11907 org-log-note-how how
11908 org-log-note-extra extra)
11909 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11911 (defun org-skip-over-state-notes ()
11912 "Skip past the list of State notes in an entry."
11914 (when (ignore-errors (goto-char (org-in-item-p)))
11915 (let* ((struct (org-list-struct))
11916 (prevs (org-list-prevs-alist struct)))
11918 (goto-char (or (org-list-get-next-item (point) struct prevs)
11919 (org-list-get-item-end (point) struct)))))))
11921 (defun org-add-log-note (&optional purpose)
11922 "Pop up a window for taking a note, and add this note later at point."
11923 (remove-hook 'post-command-hook 'org-add-log-note)
11924 (setq org-log-note-window-configuration (current-window-configuration))
11925 (delete-other-windows)
11926 (move-marker org-log-note-return-to (point))
11927 (switch-to-buffer (marker-buffer org-log-note-marker))
11928 (goto-char org-log-note-marker)
11929 (org-switch-to-buffer-other-window "*Org Note*")
11930 (erase-buffer)
11931 (if (memq org-log-note-how '(time state))
11932 (let (current-prefix-arg) (org-store-log-note))
11933 (let ((org-inhibit-startup t)) (org-mode))
11934 (insert (format "# Insert note for %s.
11936 (cond
11937 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11938 ((eq org-log-note-purpose 'done) "closed todo item")
11939 ((eq org-log-note-purpose 'state)
11941 (or org-log-note-previous-state "")
11942 (or org-log-note-state "")))
11943 ((eq org-log-note-purpose 'reschedule)
11944 "rescheduling")
11945 ((eq org-log-note-purpose 'delschedule)
11946 "no longer scheduled")
11947 ((eq org-log-note-purpose 'redeadline)
11948 "changing deadline")
11949 ((eq org-log-note-purpose 'deldeadline)
11950 "removing deadline")
11951 ((eq org-log-note-purpose 'refile)
11952 "refiling")
11953 ((eq org-log-note-purpose 'note)
11954 "this entry")
11955 (t (error "This should not happen")))))
11956 (if org-log-note-extra (insert org-log-note-extra))
11957 (org-set-local 'org-finish-function 'org-store-log-note)))
11959 (defvar org-note-abort nil) ; dynamically scoped
11960 (defun org-store-log-note ()
11961 "Finish taking a log note, and insert it to where it belongs."
11962 (let ((txt (buffer-string))
11963 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11964 lines ind bul)
11965 (kill-buffer (current-buffer))
11967 (setq txt (replace-match "" t t txt)))
11969 (setq txt (replace-match "" t t txt)))
11972 (setq note
11973 (org-replace-escapes
11974 note
11975 (list (cons "%u" (user-login-name))
11976 (cons "%U" user-full-name)
11977 (cons "%t" (format-time-string
11978 (org-time-stamp-format 'long 'inactive)
11979 (current-time)))
11980 (cons "%T" (format-time-string
11981 (org-time-stamp-format 'long nil)
11982 (current-time)))
11983 (cons "%s" (if org-log-note-state
11985 ""))
11986 (cons "%S" (if org-log-note-previous-state
11990 (push note lines))
11991 (when (or current-prefix-arg org-note-abort)
11992 (when org-log-into-drawer
11993 (org-remove-empty-drawer-at
11994 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11995 org-log-note-marker))
11996 (setq lines nil))
11997 (when lines
11998 (with-current-buffer (marker-buffer org-log-note-marker)
11999 (save-excursion
12000 (goto-char org-log-note-marker)
12001 (move-marker org-log-note-marker nil)
12002 (end-of-line 1)
12004 (setq ind (save-excursion
12005 (if (ignore-errors (goto-char (org-in-item-p)))
12006 (let ((struct (org-list-struct)))
12007 (org-list-get-ind
12008 (org-list-get-top-point struct) struct))
12010 (cond
12011 ((and (org-at-heading-p)
12012 org-adapt-indentation)
12013 (1+ (org-current-level)))
12014 ((org-at-heading-p) 0)
12015 (t (org-get-indentation))))))
12016 (setq bul (org-list-bullet-string "-"))
12017 (org-indent-line-to ind)
12018 (insert bul (pop lines))
12019 (let ((ind-body (+ (length bul) ind)))
12020 (while lines
12022 (org-indent-line-to ind-body)
12023 (insert (pop lines))))
12024 (message "Note stored")
12025 (org-back-to-heading t)
12026 (org-cycle-hide-drawers 'children)))))
12027 (set-window-configuration org-log-note-window-configuration)
12028 (with-current-buffer (marker-buffer org-log-note-return-to)
12029 (goto-char org-log-note-return-to))
12030 (move-marker org-log-note-return-to nil)
12031 (and org-log-post-message (message "%s" org-log-post-message)))
12033 (defun org-remove-empty-drawer-at (drawer pos)
12034 "Remove an empty drawer DRAWER at position POS.
12035 POS may also be a marker."
12036 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12037 (save-excursion
12038 (save-restriction
12039 (widen)
12040 (goto-char pos)
12041 (if (org-in-regexp
12043 (replace-match ""))))))
12045 (defun org-sparse-tree (&optional arg)
12046 "Create a sparse tree, prompt for the details.
12047 This command can create sparse trees. You first need to select the type
12048 of match used to create the tree:
12050 t Show all TODO entries.
12051 T Show entries with a specific TODO keyword.
12052 m Show entries selected by a tags/property match.
12053 p Enter a property name and its value (both with completion on existing
12054 names/values) and show entries with that property.
12055 r Show entries matching a regular expression (`/' can be used as well)
12056 d Show deadlines due within `org-deadline-warning-days'.
12057 b Show deadlines and scheduled items before a date.
12058 a Show deadlines and scheduled items after a date."
12059 (interactive "P")
12060 (let (ans kwd value)
12061 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12062 (setq ans (read-char-exclusive))
12063 (cond
12064 ((equal ans ?d)
12065 (call-interactively 'org-check-deadlines))
12066 ((equal ans ?b)
12067 (call-interactively 'org-check-before-date))
12068 ((equal ans ?a)
12069 (call-interactively 'org-check-after-date))
12070 ((equal ans ?t)
12071 (org-show-todo-tree nil))
12072 ((equal ans ?T)
12073 (org-show-todo-tree '(4)))
12074 ((member ans '(?T ?m))
12075 (call-interactively 'org-match-sparse-tree))
12076 ((member ans '(?p ?P))
12077 (setq kwd (org-icompleting-read "Property: "
12078 (mapcar 'list (org-buffer-property-keys))))
12079 (setq value (org-icompleting-read "Value: "
12080 (mapcar 'list (org-property-values kwd))))
12083 (org-match-sparse-tree arg (concat kwd "=" value)))
12084 ((member ans '(?r ?R ?/))
12085 (call-interactively 'org-occur))
12088 (defvar org-occur-highlights nil
12089 "List of overlays used for occur matches.")
12090 (make-variable-buffer-local 'org-occur-highlights)
12091 (defvar org-occur-parameters nil
12092 "Parameters of the active org-occur calls.
12093 This is a list, each call to org-occur pushes as cons cell,
12094 containing the regular expression and the callback, onto the list.
12095 The list can contain several entries if `org-occur' has been called
12096 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12097 will only contain one set of parameters. When the highlights are
12098 removed (for example with `C-c C-c', or with the next edit (depending
12099 on `org-remove-highlights-with-change'), this variable is emptied
12100 as well.")
12101 (make-variable-buffer-local 'org-occur-parameters)
12103 (defun org-occur (regexp &optional keep-previous callback)
12104 "Make a compact tree which shows all matches of REGEXP.
12105 The tree will show the lines where the regexp matches, and all higher
12106 headlines above the match. It will also show the heading after the match,
12107 to make sure editing the matching entry is easy.
12108 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12109 call to `org-occur' will be kept, to allow stacking of calls to this
12110 command.
12111 If CALLBACK is non-nil, it is a function which is called to confirm
12112 that the match should indeed be shown."
12114 (when (equal regexp "")
12115 (error "Regexp cannot be empty"))
12116 (unless keep-previous
12117 (org-remove-occur-highlights nil nil t))
12118 (push (cons regexp callback) org-occur-parameters)
12119 (let ((cnt 0))
12120 (save-excursion
12121 (goto-char (point-min))
12122 (if (or (not keep-previous) ; do not want to keep
12123 (not org-occur-highlights)) ; no previous matches
12124 ;; hide everything
12125 (org-overview))
12126 (while (re-search-forward regexp nil t)
12127 (when (or (not callback)
12128 (save-match-data (funcall callback)))
12129 (setq cnt (1+ cnt))
12130 (when org-highlight-sparse-tree-matches
12131 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12132 (org-show-context 'occur-tree))))
12133 (when org-remove-highlights-with-change
12134 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12135 nil 'local))
12136 (unless org-sparse-tree-open-archived-trees
12137 (org-hide-archived-subtrees (point-min) (point-max)))
12138 (run-hooks 'org-occur-hook)
12139 (if (interactive-p)
12140 (message "%d match(es) for regexp %s" cnt regexp))
12141 cnt))
12143 (defun org-occur-next-match (&optional n reset)
12144 "Function for `next-error-function' to find sparse tree matches.
12145 N is the number of matches to move, when negative move backwards.
12146 RESET is entirely ignored - this function always goes back to the
12147 starting point when no match is found."
12148 (let* ((limit (if (< n 0) (point-min) (point-max)))
12149 (search-func (if (< n 0)
12150 'previous-single-char-property-change
12151 'next-single-char-property-change))
12152 (n (abs n))
12153 (pos (point))
12154 p1)
12155 (catch 'exit
12156 (while (setq p1 (funcall search-func (point) 'org-type))
12157 (when (equal p1 limit)
12158 (goto-char pos)
12159 (error "No more matches"))
12160 (when (equal (get-char-property p1 'org-type) 'org-occur)
12161 (setq n (1- n))
12162 (when (= n 0)
12163 (goto-char p1)
12164 (throw 'exit (point))))
12165 (goto-char p1))
12166 (goto-char p1)
12167 (error "No more matches"))))
12169 (defun org-show-context (&optional key)
12170 "Make sure point and context are visible.
12171 How much context is shown depends upon the variables
12172 `org-show-hierarchy-above', `org-show-following-heading'. and
12173 `org-show-siblings'."
12174 (let ((heading-p (org-on-heading-p t))
12175 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12176 (following-p (org-get-alist-option org-show-following-heading key))
12177 (entry-p (org-get-alist-option org-show-entry-below key))
12178 (siblings-p (org-get-alist-option org-show-siblings key)))
12179 (catch 'exit
12180 ;; Show heading or entry text
12181 (if (and heading-p (not entry-p))
12182 (org-flag-heading nil) ; only show the heading
12183 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12184 (org-show-hidden-entry))) ; show entire entry
12185 (when following-p
12186 ;; Show next sibling, or heading below text
12187 (save-excursion
12188 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12189 (org-flag-heading nil))))
12190 (when siblings-p (org-show-siblings))
12191 (when hierarchy-p
12192 ;; show all higher headings, possibly with siblings
12193 (save-excursion
12194 (while (and (condition-case nil
12195 (progn (org-up-heading-all 1) t)
12196 (error nil))
12197 (not (bobp)))
12198 (org-flag-heading nil)
12199 (when siblings-p (org-show-siblings))))))))
12201 (defvar org-reveal-start-hook nil
12202 "Hook run before revealing a location.")
12204 (defun org-reveal (&optional siblings)
12205 "Show current entry, hierarchy above it, and the following headline.
12206 This can be used to show a consistent set of context around locations
12207 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12208 not t for the search context.
12210 With optional argument SIBLINGS, on each level of the hierarchy all
12211 siblings are shown. This repairs the tree structure to what it would
12212 look like when opened with hierarchical calls to `org-cycle'.
12214 go to the parent and show the
12215 entire tree."
12216 (interactive "P")
12217 (run-hooks 'org-reveal-start-hook)
12218 (let ((org-show-hierarchy-above t)
12219 (org-show-following-heading t)
12220 (org-show-siblings (if siblings t org-show-siblings)))
12221 (org-show-context nil))
12222 (when (equal siblings '(16))
12223 (save-excursion
12224 (when (org-up-heading-safe)
12225 (org-show-subtree)
12226 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12228 (defun org-highlight-new-match (beg end)
12229 "Highlight from BEG to END and mark the highlight is an occur headline."
12230 (let ((ov (make-overlay beg end)))
12231 (overlay-put ov 'face 'secondary-selection)
12232 (overlay-put ov 'org-type 'org-occur)
12233 (push ov org-occur-highlights)))
12235 (defun org-remove-occur-highlights (&optional beg end noremove)
12236 "Remove the occur highlights from the buffer.
12237 BEG and END are ignored. If NOREMOVE is nil, remove this function
12238 from the `before-change-functions' in the current buffer."
12239 (interactive)
12240 (unless org-inhibit-highlight-removal
12241 (mapc 'delete-overlay org-occur-highlights)
12242 (setq org-occur-highlights nil)
12243 (setq org-occur-parameters nil)
12244 (unless noremove
12245 (remove-hook 'before-change-functions
12246 'org-remove-occur-highlights 'local))))
12248 ;;;; Priorities
12251 "Regular expression matching the priority indicator.")
12253 (defvar org-remove-priority-next-time nil)
12255 (defun org-priority-up ()
12256 "Increase the priority of the current item."
12257 (interactive)
12258 (org-priority 'up))
12260 (defun org-priority-down ()
12261 "Decrease the priority of the current item."
12262 (interactive)
12263 (org-priority 'down))
12265 (defun org-priority (&optional action)
12266 "Change the priority of an item by ARG.
12267 ACTION can be `set', `up', `down', or a character."
12268 (interactive)
12269 (unless org-enable-priority-commands
12270 (error "Priority commands are disabled"))
12271 (setq action (or action 'set))
12272 (let (current new news have remove)
12273 (save-excursion
12274 (org-back-to-heading t)
12275 (if (looking-at org-priority-regexp)
12276 (setq current (string-to-char (match-string 2))
12277 have t)
12278 (setq current org-default-priority))
12279 (cond
12280 ((eq action 'remove)
12281 (setq remove t new ?\ ))
12282 ((or (eq action 'set)
12283 (if (featurep 'xemacs) (characterp action) (integerp action)))
12284 (if (not (eq action 'set))
12285 (setq new action)
12286 (message "Priority %c-%c, SPC to remove: "
12287 org-highest-priority org-lowest-priority)
12288 (save-match-data
12289 (setq new (read-char-exclusive))))
12290 (if (and (= (upcase org-highest-priority) org-highest-priority)
12291 (= (upcase org-lowest-priority) org-lowest-priority))
12292 (setq new (upcase new)))
12293 (cond ((equal new ?\ ) (setq remove t))
12294 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12295 (error "Priority must be between `%c' and `%c'"
12296 org-highest-priority org-lowest-priority))))
12297 ((eq action 'up)
12298 (if (and (not have) (eq last-command this-command))
12299 (setq new org-lowest-priority)
12300 (setq new (if (and org-priority-start-cycle-with-default (not have))
12301 org-default-priority (1- current)))))
12302 ((eq action 'down)
12303 (if (and (not have) (eq last-command this-command))
12304 (setq new org-highest-priority)
12305 (setq new (if (and org-priority-start-cycle-with-default (not have))
12306 org-default-priority (1+ current)))))
12307 (t (error "Invalid action")))
12308 (if (or (< (upcase new) org-highest-priority)
12309 (> (upcase new) org-lowest-priority))
12310 (setq remove t))
12311 (setq news (format "%c" new))
12312 (if have
12313 (if remove
12314 (replace-match "" t t nil 1)
12315 (replace-match news t t nil 2))
12316 (if remove
12317 (error "No priority cookie found in line")
12318 (let ((case-fold-search nil))
12319 (looking-at org-todo-line-regexp))
12320 (if (match-end 2)
12321 (progn
12322 (goto-char (match-end 2))
12323 (insert " [#" news "]"))
12324 (goto-char (match-beginning 3))
12325 (insert "[#" news "] "))))
12326 (org-preserve-lc (org-set-tags nil 'align)))
12327 (if remove
12328 (message "Priority removed")
12329 (message "Priority of current item set to %s" news))))
12331 (defun org-get-priority (s)
12332 "Find priority cookie and return priority."
12333 (if (functionp org-get-priority-function)
12334 (funcall org-get-priority-function)
12335 (save-match-data
12336 (if (not (string-match org-priority-regexp s))
12337 (* 1000 (- org-lowest-priority org-default-priority))
12338 (* 1000 (- org-lowest-priority
12339 (string-to-char (match-string 2 s))))))))
12341 ;;;; Tags
12343 (defvar org-agenda-archives-mode)
12344 (defvar org-map-continue-from nil
12345 "Position from where mapping should continue.
12346 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12348 (defvar org-scanner-tags nil
12349 "The current tag list while the tags scanner is running.")
12350 (defvar org-trust-scanner-tags nil
12351 "Should `org-get-tags-at' use the tags for the scanner.
12352 This is for internal dynamical scoping only.
12353 When this is non-nil, the function `org-get-tags-at' will return the value
12354 of `org-scanner-tags' instead of building the list by itself. This
12355 can lead to large speed-ups when the tags scanner is used in a file with
12356 many entries, and when the list of tags is retrieved, for example to
12357 obtain a list of properties. Building the tags list for each entry in such
12358 a file becomes an N^2 operation - but with this variable set, it scales
12359 as N.")
12361 (defun org-scan-tags (action matcher &optional todo-only)
12362 "Scan headline tags with inheritance and produce output ACTION.
12364 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12365 or `agenda' to produce an entry list for an agenda view. It can also be
12366 a Lisp form or a function that should be called at each matched headline, in
12367 this case the return value is a list of all return values from these calls.
12369 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12370 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12371 only lines with a TODO keyword are included in the output."
12372 (require 'org-agenda)
12375 (org-re
12377 (props (list 'face 'default
12378 'done-face 'org-agenda-done
12379 'undone-face 'default
12380 'mouse-face 'highlight
12381 'org-not-done-regexp org-not-done-regexp
12382 'org-todo-regexp org-todo-regexp
12383 'help-echo
12384 (format "mouse-2 or RET jump to org file %s"
12385 (abbreviate-file-name
12386 (or (buffer-file-name (buffer-base-buffer))
12387 (buffer-name (buffer-base-buffer)))))))
12388 (case-fold-search nil)
12389 (org-map-continue-from nil)
12390 lspos tags tags-list
12391 (tags-alist (list (cons 0 org-file-tags)))
12392 (llast 0) rtn rtn1 level category i txt
12393 todo marker entry priority)
12394 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12395 (setq action (list 'lambda nil action)))
12396 (save-excursion
12397 (goto-char (point-min))
12398 (when (eq action 'sparse-tree)
12399 (org-overview)
12400 (org-remove-occur-highlights))
12401 (while (re-search-forward re nil t)
12402 (catch :skip
12403 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12404 tags (if (match-end 4) (org-match-string-no-properties 4)))
12405 (goto-char (setq lspos (match-beginning 0)))
12406 (setq level (org-reduced-level (funcall outline-level))
12407 category (org-get-category))
12408 (setq i llast llast level)
12409 ;; remove tag lists from same and sublevels
12410 (while (>= i level)
12411 (when (setq entry (assoc i tags-alist))
12412 (setq tags-alist (delete entry tags-alist)))
12413 (setq i (1- i)))
12414 ;; add the next tags
12415 (when tags
12416 (setq tags (org-split-string tags ":")
12417 tags-alist
12418 (cons (cons level tags) tags-alist)))
12419 ;; compile tags for current headline
12420 (setq tags-list
12421 (if org-use-tag-inheritance
12422 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12423 tags)
12424 org-scanner-tags tags-list)
12425 (when org-use-tag-inheritance
12426 (setcdr (car tags-alist)
12427 (mapcar (lambda (x)
12428 (setq x (copy-sequence x))
12429 (org-add-prop-inherited x))
12430 (cdar tags-alist))))
12431 (when (and tags org-use-tag-inheritance
12432 (or (not (eq t org-use-tag-inheritance))
12433 org-tags-exclude-from-inheritance))
12434 ;; selective inheritance, remove uninherited ones
12435 (setcdr (car tags-alist)
12436 (org-remove-uniherited-tags (cdar tags-alist))))
12437 (when (and (or (not todo-only)
12438 (and (member todo org-not-done-keywords)
12439 (or (not org-agenda-tags-todo-honor-ignore-options)
12440 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12441 (let ((case-fold-search t)) (eval matcher))
12442 (or
12443 (not (member org-archive-tag tags-list))
12444 ;; we have an archive tag, should we use this anyway?
12445 (or (not org-agenda-skip-archived-trees)
12446 (and (eq action 'agenda) org-agenda-archives-mode))))
12447 (unless (eq action 'sparse-tree) (org-agenda-skip))
12449 ;; select this headline
12451 (cond
12452 ((eq action 'sparse-tree)
12453 (and org-highlight-sparse-tree-matches
12454 (org-get-heading) (match-end 0)
12455 (org-highlight-new-match
12456 (match-beginning 0) (match-beginning 1)))
12457 (org-show-context 'tags-tree))
12458 ((eq action 'agenda)
12459 (setq txt (org-format-agenda-item
12460 ""
12461 (concat
12462 (if (eq org-tags-match-list-sublevels 'indented)
12463 (make-string (1- level) ?.) "")
12464 (org-get-heading))
12465 category
12466 tags-list
12467 )
12468 priority (org-get-priority txt))
12469 (goto-char lspos)
12470 (setq marker (org-agenda-new-marker))
12471 (org-add-props txt props
12472 'org-marker marker 'org-hd-marker marker 'org-category category
12473 'todo-state todo
12474 'priority priority 'type "tagsmatch")
12475 (push txt rtn))
12476 ((functionp action)
12477 (setq org-map-continue-from nil)
12478 (save-excursion
12479 (setq rtn1 (funcall action))
12480 (push rtn1 rtn)))
12481 (t (error "Invalid action")))
12483 ;; if we are to skip sublevels, jump to end of subtree
12484 (unless org-tags-match-list-sublevels
12485 (org-end-of-subtree t)
12486 (backward-char 1))))
12487 ;; Get the correct position from where to continue
12488 (if org-map-continue-from
12489 (goto-char org-map-continue-from)
12490 (and (= (point) lspos) (end-of-line 1)))))
12491 (when (and (eq action 'sparse-tree)
12492 (not org-sparse-tree-open-archived-trees))
12493 (org-hide-archived-subtrees (point-min) (point-max)))
12494 (nreverse rtn)))
12496 (defun org-remove-uniherited-tags (tags)
12497 "Remove all tags that are not inherited from the list TAGS."
12498 (cond
12499 ((eq org-use-tag-inheritance t)
12500 (if org-tags-exclude-from-inheritance
12501 (org-delete-all org-tags-exclude-from-inheritance tags)
12502 tags))
12503 ((not org-use-tag-inheritance) nil)
12504 ((stringp org-use-tag-inheritance)
12505 (delq nil (mapcar
12506 (lambda (x)
12507 (if (and (string-match org-use-tag-inheritance x)
12508 (not (member x org-tags-exclude-from-inheritance)))
12509 x nil))
12510 tags)))
12511 ((listp org-use-tag-inheritance)
12512 (delq nil (mapcar
12513 (lambda (x)
12514 (if (member x org-use-tag-inheritance) x nil))
12515 tags)))))
12517 (defvar todo-only) ;; dynamically scoped
12519 (defun org-match-sparse-tree (&optional todo-only match)
12520 "Create a sparse tree according to tags string MATCH.
12521 MATCH can contain positive and negative selection of tags, like
12523 If optional argument TODO-ONLY is non-nil, only select lines that are
12524 also TODO lines."
12525 (interactive "P")
12526 (org-prepare-agenda-buffers (list (current-buffer)))
12527 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12529 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12531 (defvar org-cached-props nil)
12532 (defun org-cached-entry-get (pom property)
12533 (if (or (eq t org-use-property-inheritance)
12534 (and (stringp org-use-property-inheritance)
12535 (string-match org-use-property-inheritance property))
12536 (and (listp org-use-property-inheritance)
12537 (member property org-use-property-inheritance)))
12538 ;; Caching is not possible, check it directly
12539 (org-entry-get pom property 'inherit)
12540 ;; Get all properties, so that we can do complicated checks easily
12541 (cdr (assoc property (or org-cached-props
12542 (setq org-cached-props
12543 (org-entry-properties pom)))))))
12545 (defun org-global-tags-completion-table (&optional files)
12546 "Return the list of all tags in all agenda buffer/files.
12547 Optional FILES argument is a list of files to which can be used
12548 instead of the agenda files."
12549 (save-excursion
12550 (org-uniquify
12551 (delq nil
12552 (apply 'append
12553 (mapcar
12554 (lambda (file)
12555 (set-buffer (find-file-noselect file))
12556 (append (org-get-buffer-tags)
12557 (mapcar (lambda (x) (if (stringp (car-safe x))
12558 (list (car-safe x)) nil))
12559 org-tag-alist)))
12560 (if (and files (car files))
12561 files
12562 (org-agenda-files))))))))
12564 (defun org-make-tags-matcher (match)
12565 "Create the TAGS/TODO matcher form for the selection string MATCH."
12566 ;; todo-only is scoped dynamically into this function, and the function
12567 ;; may change it if the matcher asks for it.
12568 (unless match
12569 ;; Get a new match request, with completion
12570 (let ((org-last-tags-completion-table
12571 (org-global-tags-completion-table)))
12572 (setq match (org-completing-read-no-i
12573 "Match: " 'org-tags-completion-function nil nil nil
12574 'org-tags-history))))
12576 ;; Parse the string and create a lisp form
12577 (let ((match0 match)
12578 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12579 minus tag mm
12580 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12581 orterms term orlist re-p str-p level-p level-op time-p
12582 prop-p pn pv po gv rest)
12583 (if (string-match "/+" match)
12584 ;; match contains also a todo-matching request
12585 (progn
12586 (setq tagsmatch (substring match 0 (match-beginning 0))
12587 todomatch (substring match (match-end 0)))
12588 (if (string-match "^!" todomatch)
12589 (setq todo-only t todomatch (substring todomatch 1)))
12591 (setq todomatch nil)))
12592 ;; only matching tags
12593 (setq tagsmatch match todomatch nil))
12595 ;; Make the tags matcher
12597 (setq tagsmatcher t)
12598 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12599 (while (setq term (pop orterms))
12601 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12602 (while (string-match re term)
12603 (setq rest (substring term (match-end 0))
12604 minus (and (match-end 1)
12605 (equal (match-string 1 term) "-"))
12606 tag (save-match-data (replace-regexp-in-string
12608 (match-string 2 term)))
12609 re-p (equal (string-to-char tag) ?{)
12610 level-p (match-end 4)
12611 prop-p (match-end 5)
12612 mm (cond
12613 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12614 (level-p
12615 (setq level-op (org-op-to-function (match-string 3 term)))
12616 `(,level-op level ,(string-to-number
12617 (match-string 4 term))))
12618 (prop-p
12619 (setq pn (match-string 5 term)
12620 po (match-string 6 term)
12621 pv (match-string 7 term)
12622 re-p (equal (string-to-char pv) ?{)
12624 time-p (save-match-data
12626 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12627 (if time-p (setq pv (org-matcher-time pv)))
12628 (setq po (org-op-to-function po (if time-p 'time str-p)))
12629 (cond
12630 ((equal pn "CATEGORY")
12631 (setq gv '(get-text-property (point) 'org-category)))
12632 ((equal pn "TODO")
12633 (setq gv 'todo))
12634 (t
12635 (setq gv `(org-cached-entry-get nil ,pn))))
12636 (if re-p
12637 (if (eq po 'org<>)
12638 `(not (string-match ,pv (or ,gv "")))
12639 `(string-match ,pv (or ,gv "")))
12640 (if str-p
12641 `(,po (or ,gv "") ,pv)
12642 `(,po (string-to-number (or ,gv ""))
12643 ,(string-to-number pv) ))))
12644 (t `(member ,tag tags-list)))
12645 mm (if minus (list 'not mm) mm)
12646 term rest)
12647 (push mm tagsmatcher))
12648 (push (if (> (length tagsmatcher) 1)
12649 (cons 'and tagsmatcher)
12650 (car tagsmatcher))
12651 orlist)
12652 (setq tagsmatcher nil))
12653 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12654 (setq tagsmatcher
12655 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12656 ;; Make the todo matcher
12658 (setq todomatcher t)
12659 (setq orterms (org-split-string todomatch "|") orlist nil)
12660 (while (setq term (pop orterms))
12661 (while (string-match re term)
12662 (setq minus (and (match-end 1)
12663 (equal (match-string 1 term) "-"))
12664 kwd (match-string 2 term)
12665 re-p (equal (string-to-char kwd) ?{)
12666 term (substring term (match-end 0))
12667 mm (if re-p
12668 `(string-match ,(substring kwd 1 -1) todo)
12669 (list 'equal 'todo kwd))
12670 mm (if minus (list 'not mm) mm))
12671 (push mm todomatcher))
12672 (push (if (> (length todomatcher) 1)
12673 (cons 'and todomatcher)
12674 (car todomatcher))
12675 orlist)
12676 (setq todomatcher nil))
12677 (setq todomatcher (if (> (length orlist) 1)
12678 (cons 'or orlist) (car orlist))))
12680 ;; Return the string and lisp forms of the matcher
12681 (setq matcher (if todomatcher
12682 (list 'and tagsmatcher todomatcher)
12683 tagsmatcher))
12684 (cons match0 matcher)))
12686 (defun org-op-to-function (op &optional stringp)
12687 "Turn an operator into the appropriate function."
12688 (setq op
12689 (cond
12690 ((equal op "<" ) '(< string< org-time<))
12691 ((equal op ">" ) '(> org-string> org-time>))
12692 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12693 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12694 ((member op '("=" "==")) '(= string= org-time=))
12695 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12696 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12698 (defun org<> (a b) (not (= a b)))
12699 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12700 (defun org-string>= (a b) (not (string< a b)))
12701 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12702 (defun org-string<> (a b) (not (string= a b)))
12703 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12704 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12705 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12706 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12707 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12708 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12709 (defun org-2ft (s)
12710 "Convert S to a floating point time.
12711 If S is already a number, just return it. If it is a string, parse
12712 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12713 (cond
12714 ((numberp s) s)
12715 ((stringp s)
12716 (condition-case nil
12717 (float-time (apply 'encode-time (org-parse-time-string s)))
12718 (error 0.)))
12719 (t 0.)))
12721 (defun org-time-today ()
12722 "Time in seconds today at 0:00.
12723 Returns the float number of seconds since the beginning of the
12724 epoch to the beginning of today (00:00)."
12725 (float-time (apply 'encode-time
12726 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12728 (defun org-matcher-time (s)
12729 "Interpret a time comparison value."
12730 (save-match-data
12731 (cond
12732 ((string= s "<now>") (float-time))
12733 ((string= s "<today>") (org-time-today))
12734 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12735 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12737 (+ (org-time-today)
12738 (* (string-to-number (match-string 1 s))
12739 (cdr (assoc (match-string 2 s)
12740 '(("d" . 86400.0) ("w" . 604800.0)
12741 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12742 (t (org-2ft s)))))
12744 (defun org-match-any-p (re list)
12745 "Does re match any element of list?"
12746 (setq list (mapcar (lambda (x) (string-match re x)) list))
12747 (delq nil list))
12749 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12750 (defvar org-tags-overlay (make-overlay 1 1))
12751 (org-detach-overlay org-tags-overlay)
12753 (defun org-get-local-tags-at (&optional pos)
12754 "Get a list of tags defined in the current headline."
12755 (org-get-tags-at pos 'local))
12757 (defun org-get-local-tags ()
12758 "Get a list of tags defined in the current headline."
12759 (org-get-tags-at nil 'local))
12761 (defun org-get-tags-at (&optional pos local)
12762 "Get a list of all headline tags applicable at POS.
12763 POS defaults to point. If tags are inherited, the list contains
12764 the targets in the same sequence as the headlines appear, i.e.
12765 the tags of the current headline come last.
12766 When LOCAL is non-nil, only return tags from the current headline,
12767 ignore inherited ones."
12768 (interactive)
12769 (if (and org-trust-scanner-tags
12770 (or (not pos) (equal pos (point)))
12771 (not local))
12772 org-scanner-tags
12773 (let (tags ltags lastpos parent)
12774 (save-excursion
12775 (save-restriction
12776 (widen)
12777 (goto-char (or pos (point)))
12778 (save-match-data
12779 (catch 'done
12780 (condition-case nil
12781 (progn
12782 (org-back-to-heading t)
12783 (while (not (equal lastpos (point)))
12784 (setq lastpos (point))
12785 (when (looking-at
12787 (setq ltags (org-split-string
12788 (org-match-string-no-properties 1) ":"))
12789 (when parent
12790 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12791 (setq tags (append
12792 (if parent
12793 (org-remove-uniherited-tags ltags)
12794 ltags)
12795 tags)))
12796 (or org-use-tag-inheritance (throw 'done t))
12797 (if local (throw 'done t))
12798 (or (org-up-heading-safe) (error nil))
12799 (setq parent t)))
12800 (error nil)))))
12801 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12803 (defun org-add-prop-inherited (s)
12804 (add-text-properties 0 (length s) '(inherited t) s)
12805 s)
12807 (defun org-toggle-tag (tag &optional onoff)
12808 "Toggle the tag TAG for the current line.
12809 If ONOFF is `on' or `off', don't toggle but set to this state."
12810 (let (res current)
12811 (save-excursion
12812 (org-back-to-heading t)
12814 (point-at-eol) t)
12815 (progn
12816 (setq current (match-string 1))
12817 (replace-match ""))
12818 (setq current ""))
12819 (setq current (nreverse (org-split-string current ":")))
12820 (cond
12821 ((eq onoff 'on)
12822 (setq res t)
12823 (or (member tag current) (push tag current)))
12824 ((eq onoff 'off)
12825 (or (not (member tag current)) (setq current (delete tag current))))
12826 (t (if (member tag current)
12827 (setq current (delete tag current))
12828 (setq res t)
12829 (push tag current))))
12830 (end-of-line 1)
12831 (if current
12832 (progn
12833 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12834 (org-set-tags nil t))
12835 (delete-horizontal-space))
12836 (run-hooks 'org-after-tags-change-hook))
12837 res))
12839 (defun org-align-tags-here (to-col)
12840 ;; Assumes that this is a headline
12841 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12842 (beginning-of-line 1)
12844 (< pos (match-beginning 2)))
12845 (progn
12846 (setq tags-l (- (match-end 2) (match-beginning 2)))
12847 (goto-char (match-beginning 1))
12848 (insert " ")
12849 (delete-region (point) (1+ (match-beginning 2)))
12850 (setq ncol (max (1+ (current-column))
12851 (1+ col)
12852 (if (> to-col 0)
12853 to-col
12854 (- (abs to-col) tags-l))))
12855 (setq p (point))
12856 (insert (make-string (- ncol (current-column)) ?\ ))
12857 (setq ncol (current-column))
12858 (when indent-tabs-mode (tabify p (point-at-eol)))
12859 (org-move-to-column (min ncol col) t))
12860 (goto-char pos))))
12862 (defun org-set-tags-command (&optional arg just-align)
12863 "Call the set-tags command for the current entry."
12864 (interactive "P")
12865 (if (org-on-heading-p)
12866 (org-set-tags arg just-align)
12867 (save-excursion
12868 (org-back-to-heading t)
12869 (org-set-tags arg just-align))))
12871 (defun org-set-tags-to (data)
12872 "Set the tags of the current entry to DATA, replacing the current tags.
12873 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12874 If DATA is nil or the empty string, any tags will be removed."
12875 (interactive "sTags: ")
12876 (setq data
12877 (cond
12878 ((eq data nil) "")
12879 ((equal data "") "")
12880 ((stringp data)
12881 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12882 ":"))
12883 ((listp data)
12884 (concat ":" (mapconcat 'identity data ":") ":"))
12885 (t nil)))
12886 (when data
12887 (save-excursion
12888 (org-back-to-heading t)
12889 (when (looking-at org-complex-heading-regexp)
12890 (if (match-end 5)
12891 (progn
12892 (goto-char (match-beginning 5))
12893 (insert data)
12894 (delete-region (point) (point-at-eol))
12895 (org-set-tags nil 'align))
12896 (goto-char (point-at-eol))
12897 (insert " " data)
12898 (org-set-tags nil 'align)))
12899 (beginning-of-line 1)
12901 (delete-region (match-beginning 1) (match-end 1))))))
12903 (defun org-align-all-tags ()
12904 "Align the tags i all headings."
12905 (interactive)
12906 (save-excursion
12907 (or (ignore-errors (org-back-to-heading t))
12908 (outline-next-heading))
12909 (if (org-on-heading-p)
12910 (org-set-tags t)
12911 (message "No headings"))))
12913 (defvar org-indent-indentation-per-level)
12914 (defun org-set-tags (&optional arg just-align)
12915 "Set the tags for the current headline.
12916 With prefix ARG, realign all tags in headings in the current buffer."
12917 (interactive "P")
12918 (let* ((re (concat "^" outline-regexp))
12919 (current (org-get-tags-string))
12920 (col (current-column))
12921 (org-setting-tags t)
12922 table current-tags inherited-tags ; computed below when needed
12923 tags p0 c0 c1 rpl di tc level)
12924 (if arg
12925 (save-excursion
12926 (goto-char (point-min))
12927 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12928 (while (re-search-forward re nil t)
12929 (org-set-tags nil t)
12930 (end-of-line 1)))
12931 (message "All tags realigned to column %d" org-tags-column))
12932 (if just-align
12933 (setq tags current)
12934 ;; Get a new set of tags from the user
12935 (save-excursion
12936 (setq table (append org-tag-persistent-alist
12937 (or org-tag-alist (org-get-buffer-tags))
12938 (and
12939 org-complete-tags-always-offer-all-agenda-tags
12940 (org-global-tags-completion-table
12941 (org-agenda-files))))
12942 org-last-tags-completion-table table
12943 current-tags (org-split-string current ":")
12944 inherited-tags (nreverse
12945 (nthcdr (length current-tags)
12946 (nreverse (org-get-tags-at))))
12947 tags
12948 (if (or (eq t org-use-fast-tag-selection)
12949 (and org-use-fast-tag-selection
12950 (delq nil (mapcar 'cdr table))))
12951 (org-fast-tag-selection
12952 current-tags inherited-tags table
12953 (if org-fast-tag-selection-include-todo
12954 org-todo-key-alist))
12955 (let ((org-add-colon-after-tag-completion t))
12956 (org-trim
12957 (org-without-partial-completion
12958 (org-icompleting-read "Tags: "
12959 'org-tags-completion-function
12960 nil nil current 'org-tags-history)))))))
12961 (while (string-match "[-+&]+" tags)
12962 ;; No boolean logic, just a list
12963 (setq tags (replace-match ":" t t tags))))
12965 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12967 (if org-tags-sort-function
12968 (setq tags (mapconcat 'identity
12969 (sort (org-split-string
12970 tags (org-re "[^[:alnum:]_@#%]+"))
12971 org-tags-sort-function) ":")))
12974 (setq tags "")
12975 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12976 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12978 ;; Insert new tags at the correct column
12979 (beginning-of-line 1)
12980 (setq level (or (and (looking-at org-outline-regexp)
12981 (- (match-end 0) (point) 1))
12982 1))
12983 (cond
12984 ((and (equal current "") (equal tags "")))
12985 ((re-search-forward
12987 (point-at-eol) t)
12988 (if (equal tags "")
12989 (setq rpl "")
12990 (goto-char (match-beginning 0))
12991 (setq c0 (current-column)
12992 ;; compute offset for the case of org-indent-mode active
12993 di (if org-indent-mode
12994 (* (1- org-indent-indentation-per-level) (1- level))
12995 0)
12996 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12997 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12998 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12999 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13000 (replace-match rpl t t)
13001 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13002 tags)
13003 (t (error "Tags alignment failed")))
13004 (org-move-to-column col)
13005 (unless just-align
13006 (run-hooks 'org-after-tags-change-hook)))))
13008 (defun org-change-tag-in-region (beg end tag off)
13009 "Add or remove TAG for each entry in the region.
13010 This works in the agenda, and also in an org-mode buffer."
13011 (interactive
13012 (list (region-beginning) (region-end)
13013 (let ((org-last-tags-completion-table
13014 (if (org-mode-p)
13015 (org-get-buffer-tags)
13016 (org-global-tags-completion-table))))
13017 (org-icompleting-read
13018 "Tag: " 'org-tags-completion-function nil nil nil
13019 'org-tags-history))
13020 (progn
13022 (equal (read-char-exclusive) ?r))))
13023 (if (fboundp 'deactivate-mark) (deactivate-mark))
13024 (let ((agendap (equal major-mode 'org-agenda-mode))
13025 l1 l2 m buf pos newhead (cnt 0))
13026 (goto-char end)
13027 (setq l2 (1- (org-current-line)))
13028 (goto-char beg)
13029 (setq l1 (org-current-line))
13030 (loop for l from l1 to l2 do
13031 (org-goto-line l)
13032 (setq m (get-text-property (point) 'org-hd-marker))
13033 (when (or (and (org-mode-p) (org-on-heading-p))
13034 (and agendap m))
13035 (setq buf (if agendap (marker-buffer m) (current-buffer))
13036 pos (if agendap m (point)))
13037 (with-current-buffer buf
13038 (save-excursion
13039 (save-restriction
13040 (goto-char pos)
13041 (setq cnt (1+ cnt))
13042 (org-toggle-tag tag (if off 'off 'on))
13043 (setq newhead (org-get-heading)))))
13044 (and agendap (org-agenda-change-all-lines newhead m))))
13045 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13047 (defun org-tags-completion-function (string predicate &optional flag)
13048 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13049 (confirm (lambda (x) (stringp (car x)))))
13051 (setq s1 (match-string 1 string)
13052 s2 (match-string 2 string))
13053 (setq s1 "" s2 string))
13054 (cond
13055 ((eq flag nil)
13056 ;; try completion
13057 (setq rtn (try-completion s2 ctable confirm))
13058 (if (stringp rtn)
13059 (setq rtn
13060 (concat s1 s2 (substring rtn (length s2))
13061 (if (and org-add-colon-after-tag-completion
13062 (assoc rtn ctable))
13063 ":" ""))))
13064 rtn)
13065 ((eq flag t)
13066 ;; all-completions
13067 (all-completions s2 ctable confirm)
13068 )
13069 ((eq flag 'lambda)
13070 ;; exact match?
13071 (assoc s2 ctable)))
13072 ))
13074 (defun org-fast-tag-insert (kwd tags face &optional end)
13075 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13076 (insert (format "%-12s" (concat kwd ":"))
13077 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13078 (or end "")))
13080 (defun org-fast-tag-show-exit (flag)
13081 (save-excursion
13082 (org-goto-line 3)
13084 (replace-match ""))
13085 (when flag
13086 (end-of-line 1)
13087 (org-move-to-column (- (window-width) 19) t)
13088 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13090 (defun org-set-current-tags-overlay (current prefix)
13091 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13092 (if (featurep 'xemacs)
13093 (org-overlay-display org-tags-overlay (concat prefix s)
13094 'secondary-selection)
13095 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13096 (org-overlay-display org-tags-overlay (concat prefix s)))))
13098 (defvar org-last-tag-selection-key nil)
13099 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13100 "Fast tag selection with single keys.
13101 CURRENT is the current list of tags in the headline, INHERITED is the
13102 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13103 possibly with grouping information. TODO-TABLE is a similar table with
13104 TODO keywords, should these have keys assigned to them.
13105 If the keys are nil, a-z are automatically assigned.
13106 Returns the new tags string, or nil to not change the current settings."
13107 (let* ((fulltable (append table todo-table))
13108 (maxlen (apply 'max (mapcar
13109 (lambda (x)
13110 (if (stringp (car x)) (string-width (car x)) 0))
13111 fulltable)))
13112 (buf (current-buffer))
13113 (expert (eq org-fast-tag-selection-single-key 'expert))
13114 (buffer-tags nil)
13115 (fwidth (+ maxlen 3 1 3))
13116 (ncol (/ (- (window-width) 4) fwidth))
13117 (i-face 'org-done)
13118 (c-face 'org-todo)
13119 tg cnt e c char c1 c2 ntable tbl rtn
13120 ov-start ov-end ov-prefix
13121 (exit-after-next org-fast-tag-selection-single-key)
13122 (done-keywords org-done-keywords)
13123 groups ingroup)
13124 (save-excursion
13125 (beginning-of-line 1)
13126 (if (looking-at
13128 (setq ov-start (match-beginning 1)
13129 ov-end (match-end 1)
13130 ov-prefix "")
13131 (setq ov-start (1- (point-at-eol))
13132 ov-end (1+ ov-start))
13134 (setq ov-prefix
13135 (concat
13136 (buffer-substring (1- (point)) (point))
13137 (if (> (current-column) org-tags-column)
13138 " "
13139 (make-string (- org-tags-column (current-column)) ?\ ))))))
13140 (move-overlay org-tags-overlay ov-start ov-end)
13141 (save-window-excursion
13142 (if expert
13143 (set-buffer (get-buffer-create " *Org tags*"))
13144 (delete-other-windows)
13145 (split-window-vertically)
13146 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13147 (erase-buffer)
13148 (org-set-local 'org-done-keywords done-keywords)
13151 (org-fast-tag-show-exit exit-after-next)
13152 (org-set-current-tags-overlay current ov-prefix)
13153 (setq tbl fulltable char ?a cnt 0)
13154 (while (setq e (pop tbl))
13155 (cond
13156 ((equal (car e) :startgroup)
13157 (push '() groups) (setq ingroup t)
13158 (when (not (= cnt 0))
13159 (setq cnt 0)
13161 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13162 ((equal (car e) :endgroup)
13163 (setq ingroup nil cnt 0)
13165 ((equal e '(:newline))
13166 (when (not (= cnt 0))
13167 (setq cnt 0)
13169 (setq e (car tbl))
13170 (while (equal (car tbl) '(:newline))
13172 (setq tbl (cdr tbl)))))
13173 (t
13174 (setq tg (copy-sequence (car e)) c2 nil)
13175 (if (cdr e)
13176 (setq c (cdr e))
13177 ;; automatically assign a character.
13178 (setq c1 (string-to-char
13179 (downcase (substring
13180 tg (if (= (string-to-char tg) ?@) 1 0)))))
13181 (if (or (rassoc c1 ntable) (rassoc c1 table))
13182 (while (or (rassoc char ntable) (rassoc char table))
13183 (setq char (1+ char)))
13184 (setq c2 c1))
13185 (setq c (or c2 char)))
13186 (if ingroup (push tg (car groups)))
13187 (setq tg (org-add-props tg nil 'face
13188 (cond
13189 ((not (assoc tg table))
13190 (org-get-todo-face tg))
13191 ((member tg current) c-face)
13192 ((member tg inherited) i-face)
13193 (t nil))))
13194 (if (and (= cnt 0) (not ingroup)) (insert " "))
13195 (insert "[" c "] " tg (make-string
13196 (- fwidth 4 (length tg)) ?\ ))
13197 (push (cons tg c) ntable)
13198 (when (= (setq cnt (1+ cnt)) ncol)
13200 (if ingroup (insert " "))
13201 (setq cnt 0)))))
13202 (setq ntable (nreverse ntable))
13204 (goto-char (point-min))
13205 (if (not expert) (org-fit-window-to-buffer))
13206 (setq rtn
13207 (catch 'exit
13208 (while t
13209 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13210 (if (not groups) "no " "")
13211 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13212 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13213 (setq org-last-tag-selection-key c)
13214 (cond
13216 ((= c ?!)
13217 (setq groups (not groups))
13218 (goto-char (point-min))
13219 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13220 ((= c ?\C-c)
13221 (if (not expert)
13222 (org-fast-tag-show-exit
13223 (setq exit-after-next (not exit-after-next)))
13224 (setq expert nil)
13225 (delete-other-windows)
13226 (set-window-buffer (split-window-vertically) " *Org tags*")
13227 (org-switch-to-buffer-other-window " *Org tags*")
13228 (org-fit-window-to-buffer)))
13229 ((or (= c ?\C-g)
13230 (and (= c ?q) (not (rassoc c ntable))))
13231 (org-detach-overlay org-tags-overlay)
13232 (setq quit-flag t))
13233 ((= c ?\ )
13234 (setq current nil)
13235 (if exit-after-next (setq exit-after-next 'now)))
13237 (condition-case nil
13238 (setq tg (org-icompleting-read
13239 "Tag: "
13240 (or buffer-tags
13241 (with-current-buffer buf
13242 (org-get-buffer-tags)))))
13243 (quit (setq tg "")))
13245 (add-to-list 'buffer-tags (list tg))
13246 (if (member tg current)
13247 (setq current (delete tg current))
13248 (push tg current)))
13249 (if exit-after-next (setq exit-after-next 'now)))
13250 ((setq e (rassoc c todo-table) tg (car e))
13251 (with-current-buffer buf
13252 (save-excursion (org-todo tg)))
13253 (if exit-after-next (setq exit-after-next 'now)))
13254 ((setq e (rassoc c ntable) tg (car e))
13255 (if (member tg current)
13256 (setq current (delete tg current))
13257 (loop for g in groups do
13258 (if (member tg g)
13259 (mapc (lambda (x)
13260 (setq current (delete x current)))
13261 g)))
13262 (push tg current))
13263 (if exit-after-next (setq exit-after-next 'now))))
13265 ;; Create a sorted list
13266 (setq current
13267 (sort current
13268 (lambda (a b)
13269 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13270 (if (eq exit-after-next 'now) (throw 'exit t))
13271 (goto-char (point-min))
13272 (beginning-of-line 2)
13273 (delete-region (point) (point-at-eol))
13274 (org-fast-tag-insert "Current" current c-face)
13275 (org-set-current-tags-overlay current ov-prefix)
13276 (while (re-search-forward
13278 (setq tg (match-string 1))
13279 (add-text-properties
13280 (match-beginning 1) (match-end 1)
13281 (list 'face
13282 (cond
13283 ((member tg current) c-face)
13284 ((member tg inherited) i-face)
13285 (t (get-text-property (match-beginning 1) 'face))))))
13286 (goto-char (point-min)))))
13287 (org-detach-overlay org-tags-overlay)
13288 (if rtn
13289 (mapconcat 'identity current ":")
13290 nil))))
13292 (defun org-get-tags-string ()
13293 "Get the TAGS string in the current headline."
13294 (unless (org-on-heading-p t)
13295 (error "Not on a heading"))
13296 (save-excursion
13297 (beginning-of-line 1)
13299 (org-match-string-no-properties 1)
13300 "")))
13302 (defun org-get-tags ()
13303 "Get the list of tags specified in the current headline."
13304 (org-split-string (org-get-tags-string) ":"))
13306 (defun org-get-buffer-tags ()
13307 "Get a table of all tags used in the buffer, for completion."
13308 (let (tags)
13309 (save-excursion
13310 (goto-char (point-min))
13311 (while (re-search-forward
13313 (when (equal (char-after (point-at-bol 0)) ?*)
13314 (mapc (lambda (x) (add-to-list 'tags x))
13315 (org-split-string (org-match-string-no-properties 1) ":")))))
13316 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13317 (mapcar 'list tags)))
13319 ;;;; The mapping API
13321 ;;;###autoload
13322 (defun org-map-entries (func &optional match scope &rest skip)
13323 "Call FUNC at each headline selected by MATCH in SCOPE.
13325 FUNC is a function or a lisp form. The function will be called without
13326 arguments, with the cursor positioned at the beginning of the headline.
13327 The return values of all calls to the function will be collected and
13328 returned as a list.
13330 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13331 does not need to preserve point. After evaluation, the cursor will be
13332 moved to the end of the line (presumably of the headline of the
13333 processed entry) and search continues from there. Under some
13334 circumstances, this may not produce the wanted results. For example,
13335 if you have removed (e.g. archived) the current (sub)tree it could
13336 mean that the next entry will be skipped entirely. In such cases, you
13337 can specify the position from where search should continue by making
13338 FUNC set the variable `org-map-continue-from' to the desired buffer
13339 position.
13341 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13342 Only headlines that are matched by this query will be considered during
13343 the iteration. When MATCH is nil or t, all headlines will be
13344 visited by the iteration.
13346 SCOPE determines the scope of this command. It can be any of:
13348 nil The current buffer, respecting the restriction if any
13349 tree The subtree started with the entry at point
13350 file The current buffer, without restriction
13351 file-with-archives
13352 The current buffer, and any archives associated with it
13353 agenda All agenda files
13354 agenda-with-archives
13355 All agenda files with any archive files associated with them
13356 \(file1 file2 ...)
13357 If this is a list, all files in the list will be scanned
13359 The remaining args are treated as settings for the skipping facilities of
13360 the scanner. The following items can be given here:
13362 archive skip trees with the archive tag.
13363 comment skip trees with the COMMENT keyword
13364 function or Emacs Lisp form:
13365 will be used as value for `org-agenda-skip-function', so whenever
13366 the function returns t, FUNC will not be called for that
13367 entry and search will continue from the point where the
13368 function leaves it.
13370 If your function needs to retrieve the tags including inherited tags
13371 at the *current* entry, you can use the value of the variable
13372 `org-scanner-tags' which will be much faster than getting the value
13373 with `org-get-tags-at'. If your function gets properties with
13374 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13375 to t around the call to `org-entry-properties' to get the same speedup.
13376 Note that if your function moves around to retrieve tags and properties at
13377 a *different* entry, you cannot use these techniques."
13378 (let* ((org-agenda-archives-mode nil) ; just to make sure
13379 (org-agenda-skip-archived-trees (memq 'archive skip))
13380 (org-agenda-skip-comment-trees (memq 'comment skip))
13381 (org-agenda-skip-function
13382 (car (org-delete-all '(comment archive) skip)))
13383 (org-tags-match-list-sublevels t)
13384 matcher file res
13385 org-todo-keywords-for-agenda
13386 org-done-keywords-for-agenda
13387 org-todo-keyword-alist-for-agenda
13388 org-drawers-for-agenda
13389 org-tag-alist-for-agenda)
13391 (cond
13392 ((eq match t) (setq matcher t))
13393 ((eq match nil) (setq matcher t))
13394 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13396 (save-excursion
13397 (save-restriction
13398 (when (eq scope 'tree)
13399 (org-back-to-heading t)
13400 (org-narrow-to-subtree)
13401 (setq scope nil))
13403 (if (not scope)
13404 (progn
13405 (org-prepare-agenda-buffers
13406 (list (buffer-file-name (current-buffer))))
13407 (setq res (org-scan-tags func matcher)))
13408 ;; Get the right scope
13409 (cond
13410 ((and scope (listp scope) (symbolp (car scope)))
13411 (setq scope (eval scope)))
13412 ((eq scope 'agenda)
13413 (setq scope (org-agenda-files t)))
13414 ((eq scope 'agenda-with-archives)
13415 (setq scope (org-agenda-files t))
13416 (setq scope (org-add-archive-files scope)))
13417 ((eq scope 'file)
13418 (setq scope (list (buffer-file-name))))
13419 ((eq scope 'file-with-archives)
13420 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13421 (org-prepare-agenda-buffers scope)
13422 (while (setq file (pop scope))
13423 (with-current-buffer (org-find-base-buffer-visiting file)
13424 (save-excursion
13425 (save-restriction
13426 (widen)
13427 (goto-char (point-min))
13428 (setq res (append res (org-scan-tags func matcher))))))))))
13429 res))
13431 ;;;; Properties
13433 ;;; Setting and retrieving properties
13435 (defconst org-special-properties
13436 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13437 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13438 "The special properties valid in Org-mode.
13440 These are properties that are not defined in the property drawer,
13441 but in some other way.")
13443 (defconst org-default-properties
13444 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13445 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13446 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13447 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13448 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13449 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13450 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13451 "Some properties that are used by Org-mode for various purposes.
13452 Being in this list makes sure that they are offered for completion.")
13455 "Regular expression matching the first line of a property drawer.")
13458 "Regular expression matching the last line of a property drawer.")
13461 "Regular expression matching the first line of a property drawer.")
13464 "Regular expression matching the first line of a property drawer.")
13466 (defconst org-property-drawer-re
13469 "Matches an entire property drawer.")
13471 (defconst org-clock-drawer-re
13474 "Matches an entire clock drawer.")
13476 (defun org-property-action ()
13477 "Do an action on properties."
13478 (interactive)
13479 (let (c)
13480 (org-at-property-p)
13481 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13482 (setq c (read-char-exclusive))
13483 (cond
13484 ((equal c ?s)
13485 (call-interactively 'org-set-property))
13486 ((equal c ?d)
13487 (call-interactively 'org-delete-property))
13488 ((equal c ?D)
13489 (call-interactively 'org-delete-property-globally))
13490 ((equal c ?c)
13491 (call-interactively 'org-compute-property-at-point))
13492 (t (error "No such property action %c" c)))))
13494 (defun org-set-effort (&optional value)
13495 "Set the effort property of the current entry.
13496 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13497 allowed value."
13498 (interactive "P")
13499 (if (equal value 0) (setq value 10))
13500 (let* ((completion-ignore-case t)
13501 (prop org-effort-property)
13502 (cur (org-entry-get nil prop))
13503 (allowed (org-property-get-allowed-values nil prop 'table))
13504 (existing (mapcar 'list (org-property-values prop)))
13505 rpl
13506 (val (cond
13507 ((stringp value) value)
13508 ((and allowed (integerp value))
13509 (or (car (nth (1- value) allowed))
13510 (car (org-last allowed))))
13511 (allowed
13512 (message "Select 1-9,0, [RET%s]: %s"
13513 (if cur (concat "=" cur) "")
13514 (mapconcat 'car allowed " "))
13515 (setq rpl (read-char-exclusive))
13517 cur
13518 (setq rpl (- rpl ?0))
13519 (if (equal rpl 0) (setq rpl 10))
13520 (if (and (> rpl 0) (<= rpl (length allowed)))
13521 (car (nth (1- rpl) allowed))
13522 (org-completing-read "Effort: " allowed nil))))
13523 (t
13524 (let (org-completion-use-ido org-completion-use-iswitchb)
13525 (org-completing-read
13527 (concat "[" cur "]") "")
13528 ": ")
13529 existing nil nil "" nil cur))))))
13530 (unless (equal (org-entry-get nil prop) val)
13531 (org-entry-put nil prop val))
13532 (message "%s is now %s" prop val)))
13534 (defun org-at-property-p ()
13535 "Is cursor inside a property drawer?"
13536 (save-excursion
13537 (beginning-of-line 1)
13539 (save-match-data ;; Used by calling procedures
13540 (let ((p (point))
13541 (range (unless (org-before-first-heading-p)
13542 (org-get-property-block))))
13543 (and range (<= (car range) p) (< p (cdr range))))))))
13545 (defun org-get-property-block (&optional beg end force)
13546 "Return the (beg . end) range of the body of the property drawer.
13547 BEG and END can be beginning and end of subtree, if not given
13548 they will be found.
13549 If the drawer does not exist and FORCE is non-nil, create the drawer."
13550 (catch 'exit
13551 (save-excursion
13552 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13553 (end (or end (progn (outline-next-heading) (point)))))
13554 (goto-char beg)
13555 (if (re-search-forward org-property-start-re end t)
13556 (setq beg (1+ (match-end 0)))
13557 (if force
13558 (save-excursion
13559 (org-insert-property-drawer)
13560 (setq end (progn (outline-next-heading) (point))))
13561 (throw 'exit nil))
13562 (goto-char beg)
13563 (if (re-search-forward org-property-start-re end t)
13564 (setq beg (1+ (match-end 0)))))
13565 (if (re-search-forward org-property-end-re end t)
13566 (setq end (match-beginning 0))
13567 (or force (throw 'exit nil))
13568 (goto-char beg)
13569 (setq end beg)
13570 (org-indent-line-function)
13572 (cons beg end)))))
13574 (defun org-entry-properties (&optional pom which specific)
13575 "Get all properties of the entry at point-or-marker POM.
13576 This includes the TODO keyword, the tags, time strings for deadline,
13577 scheduled, and clocking, and any additional properties defined in the
13578 entry. The return value is an alist, keys may occur multiple times
13579 if the property key was used several times.
13580 POM may also be nil, in which case the current entry is used.
13581 If WHICH is nil or `all', get all properties. If WHICH is
13582 `special' or `standard', only get that subclass. If WHICH
13583 is a string only get exactly this property. SPECIFIC can be a string, the
13584 specific property we are interested in. Specifying it can speed
13585 things up because then unnecessary parsing is avoided."
13586 (setq which (or which 'all))
13587 (org-with-point-at pom
13588 (let ((clockstr (substring org-clock-string 0 -1))
13589 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13590 (case-fold-search nil)
13591 beg end range props sum-props key key1 value string clocksum)
13592 (save-excursion
13593 (when (condition-case nil
13594 (and (org-mode-p) (org-back-to-heading t))
13595 (error nil))
13596 (setq beg (point))
13597 (setq sum-props (get-text-property (point) 'org-summaries))
13598 (setq clocksum (get-text-property (point) :org-clock-minutes))
13599 (outline-next-heading)
13600 (setq end (point))
13601 (when (memq which '(all special))
13602 ;; Get the special properties, like TODO and tags
13603 (goto-char beg)
13604 (when (and (or (not specific) (string= specific "TODO"))
13605 (looking-at org-todo-line-regexp) (match-end 2))
13606 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13607 (when (and (or (not specific) (string= specific "PRIORITY"))
13608 (looking-at org-priority-regexp))
13609 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13610 (when (or (not specific) (string= specific "FILE"))
13611 (push (cons "FILE" buffer-file-name) props))
13612 (when (and (or (not specific) (string= specific "TAGS"))
13613 (setq value (org-get-tags-string))
13615 (push (cons "TAGS" value) props))
13616 (when (and (or (not specific) (string= specific "ALLTAGS"))
13617 (setq value (org-get-tags-at)))
13618 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13619 ":"))
13620 props))
13621 (when (or (not specific) (string= specific "BLOCKED"))
13622 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13623 (when (or (not specific)
13624 (member specific
13625 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13626 "TIMESTAMP" "TIMESTAMP_IA")))
13627 (catch 'match
13628 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13629 (setq key (if (match-end 1)
13630 (substring (org-match-string-no-properties 1)
13631 0 -1))
13632 string (if (equal key clockstr)
13633 (org-no-properties
13634 (org-trim
13635 (buffer-substring
13636 (match-beginning 3) (goto-char
13637 (point-at-eol)))))
13638 (substring (org-match-string-no-properties 3)
13639 1 -1)))
13640 ;; Get the correct property name from the key. This is
13641 ;; necessary if the user has configured time keywords.
13642 (setq key1 (concat key ":"))
13643 (cond
13644 ((not key)
13645 (setq key
13646 (if (= (char-after (match-beginning 3)) ?\[)
13647 "TIMESTAMP_IA" "TIMESTAMP")))
13648 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13649 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13650 ((equal key1 org-closed-string) (setq key "CLOSED"))
13651 ((equal key1 org-clock-string) (setq key "CLOCK")))
13652 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13653 (progn
13654 (push (cons key string) props)
13655 ;; no need to search further if match is found
13656 (throw 'match t))
13657 (when (or (equal key "CLOCK") (not (assoc key props)))
13658 (push (cons key string) props))))))
13659 )
13661 (when (memq which '(all standard))
13662 ;; Get the standard properties, like :PROP: ...
13663 (setq range (org-get-property-block beg end))
13664 (when range
13665 (goto-char (car range))
13666 (while (re-search-forward
13668 (cdr range) t)
13669 (setq key (org-match-string-no-properties 1)
13670 value (org-trim (or (org-match-string-no-properties 2) "")))
13671 (unless (member key excluded)
13672 (push (cons key (or value "")) props)))))
13673 (if clocksum
13674 (push (cons "CLOCKSUM"
13675 (org-columns-number-to-string (/ (float clocksum) 60.)
13676 'add_times))
13677 props))
13678 (unless (assoc "CATEGORY" props)
13679 (push (cons "CATEGORY" (org-get-category)) props))
13680 (append sum-props (nreverse props)))))))
13682 (defun org-entry-get (pom property &optional inherit literal-nil)
13683 "Get value of PROPERTY for entry at point-or-marker POM.
13684 If INHERIT is non-nil and the entry does not have the property,
13685 then also check higher levels of the hierarchy.
13686 If INHERIT is the symbol `selective', use inheritance only if the setting
13687 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13688 If the property is present but empty, the return value is the empty string.
13689 If the property is not present at all, nil is returned.
13692 do not interpret it as the list atom nil. This is used for inheritance
13694 (org-with-point-at pom
13695 (if (and inherit (if (eq inherit 'selective)
13696 (org-property-inherit-p property)
13697 t))
13698 (org-entry-get-with-inheritance property literal-nil)
13699 (if (member property org-special-properties)
13700 ;; We need a special property. Use `org-entry-properties' to
13701 ;; retrieve it, but specify the wanted property
13702 (cdr (assoc property (org-entry-properties nil 'special property)))
13703 (let ((range (unless (org-before-first-heading-p)
13704 (org-get-property-block))))
13705 (if (and range
13706 (goto-char (car range))
13707 (re-search-forward
13708 (org-re-property property)
13709 (cdr range) t))
13710 ;; Found the property, return it.
13711 (if (match-end 1)
13712 (if literal-nil
13713 (org-match-string-no-properties 1)
13714 (org-not-nil (org-match-string-no-properties 1)))
13715 "")))))))
13717 (defun org-property-or-variable-value (var &optional inherit)
13718 "Check if there is a property fixing the value of VAR.
13719 If yes, return this value. If not, return the current value of the variable."
13720 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13722 (read prop)
13723 (symbol-value var))))
13725 (defun org-entry-delete (pom property)
13726 "Delete the property PROPERTY from entry at point-or-marker POM."
13727 (org-with-point-at pom
13728 (if (member property org-special-properties)
13729 nil ; cannot delete these properties.
13730 (let ((range (org-get-property-block)))
13731 (if (and range
13732 (goto-char (car range))
13733 (re-search-forward
13734 (org-re-property property)
13735 (cdr range) t))
13736 (progn
13737 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13738 t)
13739 nil)))))
13741 ;; Multi-values properties are properties that contain multiple values
13742 ;; These values are assumed to be single words, separated by whitespace.
13743 (defun org-entry-add-to-multivalued-property (pom property value)
13744 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13745 (let* ((old (org-entry-get pom property))
13747 (setq value (org-entry-protect-space value))
13748 (unless (member value values)
13749 (setq values (cons value values))
13750 (org-entry-put pom property
13751 (mapconcat 'identity values " ")))))
13753 (defun org-entry-remove-from-multivalued-property (pom property value)
13754 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13755 (let* ((old (org-entry-get pom property))
13757 (setq value (org-entry-protect-space value))
13758 (when (member value values)
13759 (setq values (delete value values))
13760 (org-entry-put pom property
13761 (mapconcat 'identity values " ")))))
13763 (defun org-entry-member-in-multivalued-property (pom property value)
13764 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13765 (let* ((old (org-entry-get pom property))
13767 (setq value (org-entry-protect-space value))
13768 (member value values)))
13770 (defun org-entry-get-multivalued-property (pom property)
13771 "Return a list of values in a multivalued property."
13772 (let* ((value (org-entry-get pom property))
13774 (mapcar 'org-entry-restore-space values)))
13776 (defun org-entry-put-multivalued-property (pom property &rest values)
13777 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13778 VALUES should be a list of strings. Spaces will be protected."
13779 (org-entry-put pom property
13780 (mapconcat 'org-entry-protect-space values " "))
13781 (let* ((value (org-entry-get pom property))
13783 (mapcar 'org-entry-restore-space values)))
13785 (defun org-entry-protect-space (s)
13786 "Protect spaces and newline in string S."
13787 (while (string-match " " s)
13788 (setq s (replace-match "%20" t t s)))
13790 (setq s (replace-match "%0A" t t s)))
13791 s)
13793 (defun org-entry-restore-space (s)
13794 "Restore spaces and newline in string S."
13795 (while (string-match "%20" s)
13796 (setq s (replace-match " " t t s)))
13797 (while (string-match "%0A" s)
13799 s)
13801 (defvar org-entry-property-inherited-from (make-marker)
13802 "Marker pointing to the entry from where a property was inherited.
13803 Each call to `org-entry-get-with-inheritance' will set this marker to the
13804 location of the entry where the inheritance search matched. If there was
13805 no match, the marker will point nowhere.
13806 Note that also `org-entry-get' calls this function, if the INHERIT flag
13807 is set.")
13809 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13810 "Get entry property, and search higher levels if not present.
13811 The search will stop at the first ancestor which has the property defined.
13813 should be considered as undefined (this is the meaning of nil here).
13815 (move-marker org-entry-property-inherited-from nil)
13816 (let (tmp)
13817 (unless (org-before-first-heading-p)
13818 (save-excursion
13819 (save-restriction
13820 (widen)
13821 (catch 'ex
13822 (while t
13823 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13824 (org-back-to-heading t)
13825 (move-marker org-entry-property-inherited-from (point))
13826 (throw 'ex tmp))
13827 (or (org-up-heading-safe) (throw 'ex nil)))))))
13828 (setq tmp (or tmp
13829 (cdr (assoc property org-file-properties))
13830 (cdr (assoc property org-global-properties))
13831 (cdr (assoc property org-global-properties-fixed))))
13832 (if literal-nil tmp (org-not-nil tmp))))
13834 (defvar org-property-changed-functions nil
13835 "Hook called when the value of a property has changed.
13836 Each hook function should accept two arguments, the name of the property
13837 and the new value.")
13839 (defun org-entry-put (pom property value)
13840 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13841 (org-with-point-at pom
13842 (org-back-to-heading t)
13843 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13844 range)
13845 (cond
13846 ((equal property "TODO")
13848 (not (member value org-todo-keywords-1)))
13850 (if (or (not value)
13852 (setq value 'none))
13853 (org-todo value)
13854 (org-set-tags nil 'align))
13855 ((equal property "PRIORITY")
13857 (string-to-char value) ?\ ))
13858 (org-set-tags nil 'align))
13859 ((equal property "SCHEDULED")
13860 (if (re-search-forward org-scheduled-time-regexp end t)
13861 (cond
13862 ((eq value 'earlier) (org-timestamp-change -1 'day))
13863 ((eq value 'later) (org-timestamp-change 1 'day))
13864 (t (call-interactively 'org-schedule)))
13865 (call-interactively 'org-schedule)))
13866 ((equal property "DEADLINE")
13867 (if (re-search-forward org-deadline-time-regexp end t)
13868 (cond
13869 ((eq value 'earlier) (org-timestamp-change -1 'day))
13870 ((eq value 'later) (org-timestamp-change 1 'day))
13871 (t (call-interactively 'org-deadline)))
13872 (call-interactively 'org-deadline)))
13873 ((member property org-special-properties)
13874 (error "The %s property can not yet be set with `org-entry-put'"
13875 property))
13876 (t ; a non-special property
13877 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13878 (setq range (org-get-property-block beg end 'force))
13879 (goto-char (car range))
13880 (if (re-search-forward
13881 (org-re-property property) (cdr range) t)
13882 (progn
13883 (delete-region (match-beginning 1) (match-end 1))
13884 (goto-char (match-beginning 1)))
13885 (goto-char (cdr range))
13887 (backward-char 1)
13888 (org-indent-line-function)
13889 (insert ":" property ":"))
13890 (and value (insert " " value))
13891 (org-indent-line-function)))))
13892 (run-hook-with-args 'org-property-changed-functions property value)))
13894 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13895 "Get all property keys in the current buffer.
13896 With INCLUDE-SPECIALS, also list the special properties that reflect things
13897 like tags and TODO state.
13898 With INCLUDE-DEFAULTS, also include properties that has special meaning
13899 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
13900 and others.
13901 With INCLUDE-COLUMNS, also include property names given in COLUMN
13902 formats in the current buffer."
13903 (let (rtn range cfmt s p)
13904 (save-excursion
13905 (save-restriction
13906 (widen)
13907 (goto-char (point-min))
13908 (while (re-search-forward org-property-start-re nil t)
13909 (setq range (org-get-property-block))
13910 (goto-char (car range))
13911 (while (re-search-forward
13913 (cdr range) t)
13914 (add-to-list 'rtn (org-match-string-no-properties 1)))
13915 (outline-next-heading))))
13917 (when include-specials
13918 (setq rtn (append org-special-properties rtn)))
13920 (when include-defaults
13921 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13922 (add-to-list 'rtn org-effort-property))
13924 (when include-columns
13925 (save-excursion
13926 (save-restriction
13927 (widen)
13928 (goto-char (point-min))
13929 (while (re-search-forward
13931 nil t)
13932 (setq cfmt (match-string 2) s 0)
13934 cfmt s)
13935 (setq s (match-end 0)
13936 p (match-string 1 cfmt))
13937 (unless (or (equal p "ITEM")
13938 (member p org-special-properties))
13939 (add-to-list 'rtn (match-string 1 cfmt))))))))
13941 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13943 (defsubst org-re-property (property)
13944 "Return a regexp matching PROPERTY.
13945 Match group 1 will be set to the value "
13948 (defun org-property-values (key)
13949 "Return a list of all values of property KEY in the current buffer."
13950 (save-excursion
13951 (save-restriction
13952 (widen)
13953 (goto-char (point-min))
13954 (let ((re (org-re-property key))
13955 values)
13956 (while (re-search-forward re nil t)
13957 (add-to-list 'values (org-trim (match-string 1))))
13958 (delete "" values)))))
13960 (defun org-insert-property-drawer ()
13961 "Insert a property drawer into the current entry."
13962 (interactive)
13963 (org-back-to-heading t)
13964 (looking-at outline-regexp)
13965 (let ((indent (if org-adapt-indentation
13966 (- (match-end 0)(match-beginning 0))
13967 0))
13968 (beg (point))
13970 end hiddenp)
13971 (outline-next-heading)
13972 (setq end (point))
13973 (goto-char beg)
13974 (while (re-search-forward re end t))
13975 (setq hiddenp (outline-invisible-p))
13976 (end-of-line 1)
13979 (if (member (match-string 1) '("CLOCK:" ":END:"))
13980 ;; just skip this line
13981 (beginning-of-line 2)
13982 ;; Drawer start, find the end
13984 (beginning-of-line 1)))
13985 (org-skip-over-state-notes)
13987 (if (eq (char-before) ?*) (forward-char 1))
13989 (beginning-of-line 0)
13990 (org-indent-to-column indent)
13991 (beginning-of-line 2)
13992 (org-indent-to-column indent)
13993 (beginning-of-line 0)
13994 (if hiddenp
13995 (save-excursion
13996 (org-back-to-heading t)
13997 (hide-entry))
13998 (org-flag-drawer t))))
14000 (defvar org-property-set-functions-alist nil
14001 "Property set function alist.
14002 Each entry should have the following format:
14004 (PROPERTY . READ-FUNCTION)
14006 The read function will be called with the same argument as
14007 `org-completing-read'.")
14009 (defun org-set-property-function (property)
14010 "Get the function that should be used to set PROPERTY.
14011 This is computed according to `org-property-set-functions-alist'."
14012 (or (cdr (assoc property org-property-set-functions-alist))
14013 'org-completing-read))
14015 (defun org-read-property-value (property)
14016 "Read PROPERTY value from user."
14017 (let* ((completion-ignore-case t)
14018 (allowed (org-property-get-allowed-values nil property 'table))
14019 (cur (org-entry-get nil property))
14020 (prompt (concat property " value"
14022 (concat " [" cur "]") "") ": "))
14023 (set-function (org-set-property-function property))
14024 (val (if allowed
14025 (funcall set-function prompt allowed nil
14026 (not (get-text-property 0 'org-unrestricted
14027 (caar allowed))))
14028 (let (org-completion-use-ido org-completion-use-iswitchb)
14029 (funcall set-function prompt
14030 (mapcar 'list (org-property-values property))
14031 nil nil "" nil cur)))))
14032 (if (equal val "")
14033 cur
14034 val)))
14036 (defun org-read-property-name ()
14037 "Read a property name."
14038 (let* ((completion-ignore-case t)
14039 (keys (org-buffer-property-keys nil t t))
14040 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
14041 (if (member property keys)
14042 property
14043 (or (cdr (assoc (downcase property)
14044 (mapcar (lambda (x) (cons (downcase x) x))
14045 keys)))
14046 property))))
14048 (defun org-set-property (property value)
14049 "In the current entry, set PROPERTY to VALUE.
14050 When called interactively, this will prompt for a property name, offering
14051 completion on existing and default properties. And then it will prompt
14052 for a value, offering completion either on allowed values (via an inherited
14053 xxx_ALL property) or on existing values in other instances of this property
14054 in the current file."
14055 (interactive (list nil nil))
14056 (let* ((property (or property (org-read-property-name)))
14057 (value (or value (org-read-property-value property))))
14058 (unless (equal (org-entry-get nil property) value)
14059 (org-entry-put nil property value))))
14061 (defun org-delete-property (property)
14062 "In the current entry, delete PROPERTY."
14063 (interactive
14064 (let* ((completion-ignore-case t)
14065 (prop (org-icompleting-read "Property: "
14066 (org-entry-properties nil 'standard))))
14067 (list prop)))
14068 (message "Property %s %s" property
14069 (if (org-entry-delete nil property)
14070 "deleted"
14071 "was not present in the entry")))
14073 (defun org-delete-property-globally (property)
14074 "Remove PROPERTY globally, from all entries."
14075 (interactive
14076 (let* ((completion-ignore-case t)
14077 (prop (org-icompleting-read
14078 "Globally remove property: "
14079 (mapcar 'list (org-buffer-property-keys)))))
14080 (list prop)))
14081 (save-excursion
14082 (save-restriction
14083 (widen)
14084 (goto-char (point-min))
14085 (let ((cnt 0))
14086 (while (re-search-forward
14087 (org-re-property property)
14088 nil t)
14089 (setq cnt (1+ cnt))
14090 (replace-match ""))
14093 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14095 (defun org-compute-property-at-point ()
14096 "Compute the property at point.
14097 This looks for an enclosing column format, extracts the operator and
14098 then applies it to the property in the column format's scope."
14099 (interactive)
14100 (unless (org-at-property-p)
14101 (error "Not at a property"))
14102 (let ((prop (org-match-string-no-properties 2)))
14103 (org-columns-get-format-and-top-level)
14104 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14105 (error "No operator defined for property %s" prop))
14106 (org-columns-compute prop)))
14108 (defvar org-property-allowed-value-functions nil
14109 "Hook for functions supplying allowed values for a specific property.
14110 The functions must take a single argument, the name of the property, and
14112 the values, this means that these values are intended as defaults for
14113 completion, but that other values should be allowed too.
14114 The functions must return nil if they are not responsible for this
14115 property.")
14117 (defun org-property-get-allowed-values (pom property &optional table)
14118 "Get allowed values for the property PROPERTY.
14119 When TABLE is non-nil, return an alist that can directly be used for
14120 completion."
14121 (let (vals)
14122 (cond
14123 ((equal property "TODO")
14124 (setq vals (org-with-point-at pom
14125 (append org-todo-keywords-1 '("")))))
14126 ((equal property "PRIORITY")
14127 (let ((n org-lowest-priority))
14128 (while (>= n org-highest-priority)
14129 (push (char-to-string n) vals)
14130 (setq n (1- n)))))
14131 ((member property org-special-properties))
14132 ((setq vals (run-hook-with-args-until-success
14133 'org-property-allowed-value-functions property)))
14134 (t
14135 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14137 (setq vals (car (read-from-string (concat "(" vals ")"))))
14138 (setq vals (mapcar (lambda (x)
14139 (cond ((stringp x) x)
14140 ((numberp x) (number-to-string x))
14141 ((symbolp x) (symbol-name x))
14142 (t "???")))
14143 vals)))))
14144 (when (member ":ETC" vals)
14145 (setq vals (remove ":ETC" vals))
14146 (org-add-props (car vals) '(org-unrestricted t)))
14147 (if table (mapcar 'list vals) vals)))
14149 (defun org-property-previous-allowed-value (&optional previous)
14150 "Switch to the next allowed value for this property."
14151 (interactive)
14152 (org-property-next-allowed-value t))
14154 (defun org-property-next-allowed-value (&optional previous)
14155 "Switch to the next allowed value for this property."
14156 (interactive)
14157 (unless (org-at-property-p)
14158 (error "Not at a property"))
14159 (let* ((key (match-string 2))
14160 (value (match-string 3))
14161 (allowed (or (org-property-get-allowed-values (point) key)
14162 (and (member value '("[ ]" "[-]" "[X]"))
14163 '("[ ]" "[X]"))))
14164 nval)
14165 (unless allowed
14166 (error "Allowed values for this property have not been defined"))
14167 (if previous (setq allowed (reverse allowed)))
14168 (if (member value allowed)
14169 (setq nval (car (cdr (member value allowed)))))
14170 (setq nval (or nval (car allowed)))
14171 (if (equal nval value)
14172 (error "Only one allowed value for this property"))
14173 (org-at-property-p)
14174 (replace-match (concat " :" key ": " nval) t t)
14175 (org-indent-line-function)
14176 (beginning-of-line 1)
14178 (run-hook-with-args 'org-property-changed-functions key nval)))
14180 (defun org-find-olp (path &optional this-buffer)
14181 "Return a marker pointing to the entry at outline path OLP.
14182 If anything goes wrong, throw an error.
14183 You can wrap this call to catch the error like this:
14185 (condition-case msg
14186 (org-mobile-locate-entry (match-string 4))
14187 (error (nth 1 msg)))
14189 The return value will then be either a string with the error message,
14190 or a marker if everything is OK.
14192 If THIS-BUFFER is set, the outline path does not contain a file,
14193 only headings."
14194 (let* ((file (if this-buffer buffer-file-name (pop path)))
14195 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14196 (level 1)
14197 (lmin 1)
14198 (lmax 1)
14199 limit re end found pos heading cnt flevel)
14200 (unless buffer (error "File not found :%s" file))
14201 (with-current-buffer buffer
14202 (save-excursion
14203 (save-restriction
14204 (widen)
14205 (setq limit (point-max))
14206 (goto-char (point-min))
14207 (while (setq heading (pop path))
14208 (setq re (format org-complex-heading-regexp-format
14209 (regexp-quote heading)))
14210 (setq cnt 0 pos (point))
14211 (while (re-search-forward re end t)
14212 (setq level (- (match-end 1) (match-beginning 1)))
14213 (if (and (>= level lmin) (<= level lmax))
14214 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14215 (when (= cnt 0) (error "Heading not found on level %d: %s"
14216 lmax heading))
14217 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14218 lmax heading))
14219 (goto-char found)
14220 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14221 (setq end (save-excursion (org-end-of-subtree t t))))
14222 (when (org-on-heading-p)
14223 (move-marker (make-marker) (point))))))))
14225 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14226 "Find node HEADING in BUFFER.
14227 Return a marker to the heading if it was found, or nil if not.
14228 If POS-ONLY is set, return just the position instead of a marker.
14230 The heading text must match exact, but it may have a TODO keyword,
14231 a priority cookie and tags in the standard locations."
14232 (with-current-buffer (or buffer (current-buffer))
14233 (save-excursion
14234 (save-restriction
14235 (widen)
14236 (goto-char (point-min))
14237 (let (case-fold-search)
14238 (if (re-search-forward
14239 (format org-complex-heading-regexp-format
14240 (regexp-quote heading)) nil t)
14241 (if pos-only
14242 (match-beginning 0)
14243 (move-marker (make-marker) (match-beginning 0)))))))))
14245 (defun org-find-exact-heading-in-directory (heading &optional dir)
14246 "Find Org node headline HEADING in all .org files in directory DIR.
14247 When the target headline is found, return a marker to this location."
14248 (let ((files (directory-files (or dir default-directory)
14250 file visiting m buffer)
14251 (catch 'found
14252 (while (setq file (pop files))
14253 (message "trying %s" file)
14254 (setq visiting (org-find-base-buffer-visiting file))
14255 (setq buffer (or visiting (find-file-noselect file)))
14256 (setq m (org-find-exact-headline-in-buffer
14257 heading buffer))
14258 (when (and (not m) (not visiting)) (kill-buffer buffer))
14259 (and m (throw 'found m))))))
14261 (defun org-find-entry-with-id (ident)
14262 "Locate the entry that contains the ID property with exact value IDENT.
14263 IDENT can be a string, a symbol or a number, this function will search for
14264 the string representation of it.
14265 Return the position where this entry starts, or nil if there is no such entry."
14266 (interactive "sID: ")
14267 (let ((id (cond
14268 ((stringp ident) ident)
14269 ((symbol-name ident) (symbol-name ident))
14270 ((numberp ident) (number-to-string ident))
14271 (t (error "IDENT %s must be a string, symbol or number" ident))))
14272 (case-fold-search nil))
14273 (save-excursion
14274 (save-restriction
14275 (widen)
14276 (goto-char (point-min))
14277 (when (re-search-forward
14279 nil t)
14280 (org-back-to-heading t)
14281 (point))))))
14283 ;;;; Timestamps
14285 (defvar org-last-changed-timestamp nil)
14286 (defvar org-last-inserted-timestamp nil
14287 "The last time stamp inserted with `org-insert-time-stamp'.")
14288 (defvar org-time-was-given) ; dynamically scoped parameter
14289 (defvar org-end-time-was-given) ; dynamically scoped parameter
14290 (defvar org-ts-what) ; dynamically scoped parameter
14292 (defun org-time-stamp (arg &optional inactive)
14293 "Prompt for a date/time and insert a time stamp.
14294 If the user specifies a time like HH:MM, or if this command is called
14295 with a prefix argument, the time stamp will contain date and time.
14296 Otherwise, only the date will be included. All parts of a date not
14297 specified by the user will be filled in from the current date/time.
14298 So if you press just return without typing anything, the time stamp
14299 will represent the current date/time. If there is already a timestamp
14300 at the cursor, it will be modified."
14301 (interactive "P")
14302 (let* ((ts nil)
14303 (default-time
14304 ;; Default time is either today, or, when entering a range,
14305 ;; the range start.
14306 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14307 (save-excursion
14308 (re-search-backward
14310 (- (point) 20) t)))
14311 (apply 'encode-time (org-parse-time-string (match-string 1)))
14312 (current-time)))
14313 (default-input (and ts (org-get-compact-tod ts)))
14314 org-time-was-given org-end-time-was-given time)
14315 (cond
14316 ((and (org-at-timestamp-p t)
14317 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14318 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14319 (insert "--")
14320 (setq time (let ((this-command this-command))
14321 (org-read-date arg 'totime nil nil
14322 default-time default-input)))
14323 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14324 ((org-at-timestamp-p t)
14325 (setq time (let ((this-command this-command))
14326 (org-read-date arg 'totime nil nil default-time default-input)))
14327 (when (org-at-timestamp-p t) ; just to get the match data
14328 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14329 (replace-match "")
14330 (setq org-last-changed-timestamp
14331 (org-insert-time-stamp
14332 time (or org-time-was-given arg)
14333 inactive nil nil (list org-end-time-was-given))))
14334 (message "Timestamp updated"))
14335 (t
14336 (setq time (let ((this-command this-command))
14337 (org-read-date arg 'totime nil nil default-time default-input)))
14338 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14339 nil nil (list org-end-time-was-given))))))
14341 ;; FIXME: can we use this for something else, like computing time differences?
14342 (defun org-get-compact-tod (s)
14343 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14344 (let* ((t1 (match-string 1 s))
14345 (h1 (string-to-number (match-string 2 s)))
14346 (m1 (string-to-number (match-string 3 s)))
14347 (t2 (and (match-end 4) (match-string 5 s)))
14348 (h2 (and t2 (string-to-number (match-string 6 s))))
14349 (m2 (and t2 (string-to-number (match-string 7 s))))
14350 dh dm)
14351 (if (not t2)
14352 t1
14353 (setq dh (- h2 h1) dm (- m2 m1))
14354 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14355 (concat t1 "+" (number-to-string dh)
14356 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14358 (defun org-time-stamp-inactive (&optional arg)
14359 "Insert an inactive time stamp.
14360 An inactive time stamp is enclosed in square brackets instead of angle
14361 brackets. It is inactive in the sense that it does not trigger agenda entries,
14362 does not link to the calendar and cannot be changed with the S-cursor keys.
14363 So these are more for recording a certain time/date."
14364 (interactive "P")
14365 (org-time-stamp arg 'inactive))
14367 (defvar org-date-ovl (make-overlay 1 1))
14368 (overlay-put org-date-ovl 'face 'org-warning)
14369 (org-detach-overlay org-date-ovl)
14371 (defvar org-ans1) ; dynamically scoped parameter
14372 (defvar org-ans2) ; dynamically scoped parameter
14374 (defvar org-plain-time-of-day-regexp) ; defined below
14376 (defvar org-overriding-default-time nil) ; dynamically scoped
14377 (defvar org-read-date-overlay nil)
14378 (defvar org-dcst nil) ; dynamically scoped
14379 (defvar org-read-date-history nil)
14380 (defvar org-read-date-final-answer nil)
14381 (defvar org-read-date-analyze-futurep nil)
14382 (defvar org-read-date-analyze-forced-year nil)
14384 (defun org-read-date (&optional with-time to-time from-string prompt
14385 default-time default-input)
14386 "Read a date, possibly a time, and make things smooth for the user.
14387 The prompt will suggest to enter an ISO date, but you can also enter anything
14388 which will at least partially be understood by `parse-time-string'.
14389 Unrecognized parts of the date will default to the current day, month, year,
14390 hour and minute. If this command is called to replace a timestamp at point,
14391 of to enter the second timestamp of a range, the default time is taken
14392 from the existing stamp. Furthermore, the command prefers the future,
14393 so if you are giving a date where the year is not given, and the day-month
14394 combination is already past in the current year, it will assume you
14395 mean next year. For details, see the manual. A few examples:
14397 3-2-5 --> 2003-02-05
14398 feb 15 --> currentyear-02-15
14399 2/15 --> currentyear-02-15
14400 sep 12 9 --> 2009-09-12
14401 12:45 --> today 12:45
14402 22 sept 0:34 --> currentyear-09-22 0:34
14403 12 --> currentyear-currentmonth-12
14404 Fri --> nearest Friday (today or later)
14405 etc.
14407 Furthermore you can specify a relative date by giving, as the *first* thing
14408 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14409 change in days weeks, months, years.
14410 With a single plus or minus, the date is relative to today. With a double
14411 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14412 +4d --> four days from today
14413 +4 --> same as above
14414 +2w --> two weeks from today
14415 ++5 --> five days from default date
14417 The function understands only English month and weekday abbreviations,
14418 but this can be configured with the variables `parse-time-months' and
14419 `parse-time-weekdays'.
14421 While prompting, a calendar is popped up - you can also select the
14422 date with the mouse (button 1). The calendar shows a period of three
14423 months. To scroll it to other months, use the keys `>' and `<'.
14424 If you don't like the calendar, turn it off with
14425 \(setq org-read-date-popup-calendar nil)
14427 With optional argument TO-TIME, the date will immediately be converted
14428 to an internal time.
14429 With an optional argument WITH-TIME, the prompt will suggest to also
14430 insert a time. Note that when WITH-TIME is not set, you can still
14431 enter a time, and this function will inform the calling routine about
14432 this change. The calling routine may then choose to change the format
14433 used to insert the time stamp into the buffer to include the time.
14434 With optional argument FROM-STRING, read from this string instead from
14435 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14436 the time/date that is used for everything that is not specified by the
14437 user."
14438 (require 'parse-time)
14439 (let* ((org-time-stamp-rounding-minutes
14440 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14441 (org-dcst org-display-custom-times)
14442 (ct (org-current-time))
14443 (def (or org-overriding-default-time default-time ct))
14444 (defdecode (decode-time def))
14445 (dummy (progn
14446 (when (< (nth 2 defdecode) org-extend-today-until)
14447 (setcar (nthcdr 2 defdecode) -1)
14448 (setcar (nthcdr 1 defdecode) 59)
14449 (setq def (apply 'encode-time defdecode)
14450 defdecode (decode-time def)))))
14451 (calendar-frame-setup nil)
14452 (calendar-setup nil)
14453 (calendar-move-hook nil)
14454 (calendar-view-diary-initially-flag nil)
14455 (calendar-view-holidays-initially-flag nil)
14456 (timestr (format-time-string
14457 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14458 (prompt (concat (if prompt (concat prompt " ") "")
14459 (format "Date+time [%s]: " timestr)))
14460 ans (org-ans0 "") org-ans1 org-ans2 final)
14462 (cond
14463 (from-string (setq ans from-string))
14464 (org-read-date-popup-calendar
14465 (save-excursion
14466 (save-window-excursion
14467 (calendar)
14468 (calendar-forward-day (- (time-to-days def)
14469 (calendar-absolute-from-gregorian
14470 (calendar-current-date))))
14471 (org-eval-in-calendar nil t)
14472 (let* ((old-map (current-local-map))
14473 (map (copy-keymap calendar-mode-map))
14474 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14475 (org-defkey map (kbd "RET") 'org-calendar-select)
14476 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14477 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14478 (org-defkey minibuffer-local-map [(meta shift left)]
14479 (lambda () (interactive)
14480 (org-eval-in-calendar '(calendar-backward-month 1))))
14481 (org-defkey minibuffer-local-map [(meta shift right)]
14482 (lambda () (interactive)
14483 (org-eval-in-calendar '(calendar-forward-month 1))))
14484 (org-defkey minibuffer-local-map [(meta shift up)]
14485 (lambda () (interactive)
14486 (org-eval-in-calendar '(calendar-backward-year 1))))
14487 (org-defkey minibuffer-local-map [(meta shift down)]
14488 (lambda () (interactive)
14489 (org-eval-in-calendar '(calendar-forward-year 1))))
14490 (org-defkey minibuffer-local-map [?\e (shift left)]
14491 (lambda () (interactive)
14492 (org-eval-in-calendar '(calendar-backward-month 1))))
14493 (org-defkey minibuffer-local-map [?\e (shift right)]
14494 (lambda () (interactive)
14495 (org-eval-in-calendar '(calendar-forward-month 1))))
14496 (org-defkey minibuffer-local-map [?\e (shift up)]
14497 (lambda () (interactive)
14498 (org-eval-in-calendar '(calendar-backward-year 1))))
14499 (org-defkey minibuffer-local-map [?\e (shift down)]
14500 (lambda () (interactive)
14501 (org-eval-in-calendar '(calendar-forward-year 1))))
14502 (org-defkey minibuffer-local-map [(shift up)]
14503 (lambda () (interactive)
14504 (org-eval-in-calendar '(calendar-backward-week 1))))
14505 (org-defkey minibuffer-local-map [(shift down)]
14506 (lambda () (interactive)
14507 (org-eval-in-calendar '(calendar-forward-week 1))))
14508 (org-defkey minibuffer-local-map [(shift left)]
14509 (lambda () (interactive)
14510 (org-eval-in-calendar '(calendar-backward-day 1))))
14511 (org-defkey minibuffer-local-map [(shift right)]
14512 (lambda () (interactive)
14513 (org-eval-in-calendar '(calendar-forward-day 1))))
14514 (org-defkey minibuffer-local-map ">"
14515 (lambda () (interactive)
14516 (org-eval-in-calendar '(scroll-calendar-left 1))))
14517 (org-defkey minibuffer-local-map "<"
14518 (lambda () (interactive)
14519 (org-eval-in-calendar '(scroll-calendar-right 1))))
14520 (org-defkey minibuffer-local-map "\C-v"
14521 (lambda () (interactive)
14522 (org-eval-in-calendar
14523 '(calendar-scroll-left-three-months 1))))
14524 (org-defkey minibuffer-local-map "\M-v"
14525 (lambda () (interactive)
14526 (org-eval-in-calendar
14527 '(calendar-scroll-right-three-months 1))))
14528 (run-hooks 'org-read-date-minibuffer-setup-hook)
14529 (unwind-protect
14530 (progn
14531 (use-local-map map)
14532 (add-hook 'post-command-hook 'org-read-date-display)
14533 (setq org-ans0 (read-string prompt default-input
14534 'org-read-date-history nil))
14535 ;; org-ans0: from prompt
14536 ;; org-ans1: from mouse click
14537 ;; org-ans2: from calendar motion
14538 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14539 (remove-hook 'post-command-hook 'org-read-date-display)
14540 (use-local-map old-map)
14541 (when org-read-date-overlay
14542 (delete-overlay org-read-date-overlay)
14543 (setq org-read-date-overlay nil)))))))
14545 (t ; Naked prompt only
14546 (unwind-protect
14547 (setq ans (read-string prompt default-input
14548 'org-read-date-history timestr))
14549 (when org-read-date-overlay
14550 (delete-overlay org-read-date-overlay)
14551 (setq org-read-date-overlay nil)))))
14553 (setq final (org-read-date-analyze ans def defdecode))
14555 (when org-read-date-analyze-forced-year
14556 (message "Year was forced into %s"
14557 (if org-read-date-force-compatible-dates
14558 "compatible range (1970-2037)"
14559 "range representable on this machine"))
14560 (ding))
14562 ;; One round trip to get rid of 34th of August and stuff like that....
14563 (setq final (decode-time (apply 'encode-time final)))
14565 (setq org-read-date-final-answer ans)
14567 (if to-time
14568 (apply 'encode-time final)
14569 (if (and (boundp 'org-time-was-given) org-time-was-given)
14570 (format "%04d-%02d-%02d %02d:%02d"
14571 (nth 5 final) (nth 4 final) (nth 3 final)
14572 (nth 2 final) (nth 1 final))
14573 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14575 (defvar def)
14576 (defvar defdecode)
14577 (defvar with-time)
14578 (defun org-read-date-display ()
14579 "Display the current date prompt interpretation in the minibuffer."
14580 (when org-read-date-display-live
14581 (when org-read-date-overlay
14582 (delete-overlay org-read-date-overlay))
14583 (let ((p (point)))
14584 (end-of-line 1)
14585 (while (not (equal (buffer-substring
14586 (max (point-min) (- (point) 4)) (point))
14587 " "))
14588 (insert " "))
14589 (goto-char p))
14590 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14591 " " (or org-ans1 org-ans2)))
14592 (org-end-time-was-given nil)
14593 (f (org-read-date-analyze ans def defdecode))
14594 (fmts (if org-dcst
14595 org-time-stamp-custom-formats
14596 org-time-stamp-formats))
14597 (fmt (if (or with-time
14598 (and (boundp 'org-time-was-given) org-time-was-given))
14599 (cdr fmts)
14600 (car fmts)))
14601 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14602 (when (and org-end-time-was-given
14603 (string-match org-plain-time-of-day-regexp txt))
14604 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14605 org-end-time-was-given
14606 (substring txt (match-end 0)))))
14607 (when org-read-date-analyze-futurep
14608 (setq txt (concat txt " (=>F)")))
14609 (setq org-read-date-overlay
14610 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14611 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14613 (defun org-read-date-analyze (ans def defdecode)
14614 "Analyze the combined answer of the date prompt."
14615 ;; FIXME: cleanup and comment
14616 (let ((nowdecode (decode-time (current-time)))
14617 delta deltan deltaw deltadef year month day
14618 hour minute second wday pm h2 m2 tl wday1
14619 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14620 (setq org-read-date-analyze-futurep nil
14621 org-read-date-analyze-forced-year nil)
14623 (setq ans "+0"))
14625 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14626 (setq ans (replace-match "" t t ans)
14627 deltan (car delta)
14628 deltaw (nth 1 delta)
14629 deltadef (nth 2 delta)))
14631 ;; Check if there is an iso week date in there
14632 ;; If yes, store the info and postpone interpreting it until the rest
14633 ;; of the parsing is done
14634 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14635 (setq iso-year (if (match-end 1)
14636 (org-small-year-to-year
14637 (string-to-number (match-string 1 ans))))
14638 iso-weekday (if (match-end 3)
14639 (string-to-number (match-string 3 ans)))
14640 iso-week (string-to-number (match-string 2 ans)))
14641 (setq ans (replace-match "" t t ans)))
14643 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14644 (when (string-match
14646 (setq year (if (match-end 2)
14647 (string-to-number (match-string 2 ans))
14648 (progn (setq kill-year t)
14649 (string-to-number (format-time-string "%Y"))))
14650 month (string-to-number (match-string 3 ans))
14651 day (string-to-number (match-string 4 ans)))
14652 (if (< year 100) (setq year (+ 2000 year)))
14654 t nil ans)))
14656 ;; Help matching dottet european dates
14657 (when (string-match
14658 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14659 (setq year (if (match-end 3)
14660 (string-to-number (match-string 3 ans))
14661 (progn (setq kill-year t)
14662 (string-to-number (format-time-string "%Y"))))
14663 day (string-to-number (match-string 1 ans))
14664 month (string-to-number (match-string 2 ans))
14666 t nil ans)))
14668 ;; Help matching american dates, like 5/30 or 5/30/7
14669 (when (string-match
14670 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14671 (setq year (if (match-end 4)
14672 (string-to-number (match-string 4 ans))
14673 (progn (setq kill-year t)
14674 (string-to-number (format-time-string "%Y"))))
14675 month (string-to-number (match-string 1 ans))
14676 day (string-to-number (match-string 2 ans)))
14677 (if (< year 100) (setq year (+ 2000 year)))
14679 t nil ans)))
14680 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14681 ;; If there is a time with am/pm, and *no* time without it, we convert
14682 ;; so that matching will be successful.
14683 (loop for i from 1 to 2 do ; twice, for end time as well
14686 (setq hour (string-to-number (match-string 1 ans))
14687 minute (if (match-end 3)
14688 (string-to-number (match-string 3 ans))
14689 0)
14690 pm (equal ?p
14691 (string-to-char (downcase (match-string 4 ans)))))
14692 (if (and (= hour 12) (not pm))
14693 (setq hour 0)
14694 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14695 (setq ans (replace-match (format "%02d:%02d" hour minute)
14696 t t ans))))
14698 ;; Check if a time range is given as a duration
14699 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14700 (setq hour (string-to-number (match-string 1 ans))
14701 h2 (+ hour (string-to-number (match-string 3 ans)))
14702 minute (string-to-number (match-string 2 ans))
14703 m2 (+ minute (if (match-end 5) (string-to-number
14704 (match-string 5 ans))0)))
14705 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14706 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14707 t t ans)))
14709 ;; Check if there is a time range
14710 (when (boundp 'org-end-time-was-given)
14711 (setq org-time-was-given nil)
14712 (when (and (string-match org-plain-time-of-day-regexp ans)
14713 (match-end 8))
14714 (setq org-end-time-was-given (match-string 8 ans))
14715 (setq ans (concat (substring ans 0 (match-beginning 7))
14716 (substring ans (match-end 7))))))
14718 (setq tl (parse-time-string ans)
14719 day (or (nth 3 tl) (nth 3 defdecode))
14720 month (or (nth 4 tl)
14721 (if (and org-read-date-prefer-future
14722 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14723 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14724 (nth 4 defdecode)))
14725 year (or (and (not kill-year) (nth 5 tl))
14726 (if (and org-read-date-prefer-future
14727 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14728 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14729 (nth 5 defdecode)))
14730 hour (or (nth 2 tl) (nth 2 defdecode))
14731 minute (or (nth 1 tl) (nth 1 defdecode))
14732 second (or (nth 0 tl) 0)
14733 wday (nth 6 tl))
14735 (when (and (eq org-read-date-prefer-future 'time)
14736 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14737 (equal day (nth 3 nowdecode))
14738 (equal month (nth 4 nowdecode))
14739 (equal year (nth 5 nowdecode))
14740 (nth 2 tl)
14741 (or (< (nth 2 tl) (nth 2 nowdecode))
14742 (and (= (nth 2 tl) (nth 2 nowdecode))
14743 (nth 1 tl)
14744 (< (nth 1 tl) (nth 1 nowdecode)))))
14745 (setq day (1+ day)
14746 futurep t))
14748 ;; Special date definitions below
14749 (cond
14750 (iso-week
14751 ;; There was an iso week
14752 (require 'cal-iso)
14753 (setq futurep nil)
14754 (setq year (or iso-year year)
14755 day (or iso-weekday wday 1)
14756 wday nil ; to make sure that the trigger below does not match
14757 iso-date (calendar-gregorian-from-absolute
14758 (calendar-absolute-from-iso
14759 (list iso-week day year))))
14760 ; FIXME: Should we also push ISO weeks into the future?
14761 ; (when (and org-read-date-prefer-future
14762 ; (not iso-year)
14763 ; (< (calendar-absolute-from-gregorian iso-date)
14764 ; (time-to-days (current-time))))
14765 ; (setq year (1+ year)
14766 ; iso-date (calendar-gregorian-from-absolute
14767 ; (calendar-absolute-from-iso
14768 ; (list iso-week day year)))))
14769 (setq month (car iso-date)
14770 year (nth 2 iso-date)
14771 day (nth 1 iso-date)))
14772 (deltan
14773 (setq futurep nil)
14774 (unless deltadef
14775 (let ((now (decode-time (current-time))))
14776 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14777 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14778 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14779 ((equal deltaw "m") (setq month (+ month deltan)))
14780 ((equal deltaw "y") (setq year (+ year deltan)))))
14781 ((and wday (not (nth 3 tl)))
14782 (setq futurep nil)
14783 ;; Weekday was given, but no day, so pick that day in the week
14784 ;; on or after the derived date.
14785 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14786 (unless (equal wday wday1)
14787 (setq day (+ day (% (- wday wday1 -7) 7))))))
14788 (if (and (boundp 'org-time-was-given)
14789 (nth 2 tl))
14790 (setq org-time-was-given t))
14791 (if (< year 100) (setq year (+ 2000 year)))
14792 ;; Check of the date is representable
14793 (if org-read-date-force-compatible-dates
14794 (progn
14795 (if (< year 1970)
14796 (setq year 1970 org-read-date-analyze-forced-year t))
14797 (if (> year 2037)
14798 (setq year 2037 org-read-date-analyze-forced-year t)))
14799 (condition-case nil
14800 (encode-time second minute hour day month year)
14801 (error
14802 (setq year (nth 5 defdecode))
14803 (setq org-read-date-analyze-forced-year t))))
14804 (setq org-read-date-analyze-futurep futurep)
14805 (list second minute hour day month year)))
14807 (defvar parse-time-weekdays)
14809 (defun org-read-date-get-relative (s today default)
14810 "Check string S for special relative date string.
14811 TODAY and DEFAULT are internal times, for today and for a default.
14812 Return shift list (N what def-flag)
14814 N is the number of WHATs to shift.
14815 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14816 the DEFAULT date rather than TODAY."
14817 (when (and
14818 (string-match
14819 (concat
14824 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14825 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14826 (string-to-char (substring (match-string 1 s) -1))
14827 ?+))
14828 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14829 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14830 (what (if (match-end 3) (match-string 3 s) "d"))
14831 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14832 (date (if rel default today))
14833 (wday (nth 6 (decode-time date)))
14834 delta)
14835 (if wday1
14836 (progn
14837 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14838 (if (= dir ?-) (setq delta (- delta 7)))
14839 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14840 (list delta "d" rel))
14841 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14843 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14844 "Turn a user-specified date into the internal representation.
14845 The internal representation needed by the calendar is (month day year).
14846 This is a wrapper to handle the brain-dead convention in calendar that
14847 user function argument order change dependent on argument order."
14848 (if (boundp 'calendar-date-style)
14849 (cond
14850 ((eq calendar-date-style 'american)
14851 (list arg1 arg2 arg3))
14852 ((eq calendar-date-style 'european)
14853 (list arg2 arg1 arg3))
14854 ((eq calendar-date-style 'iso)
14855 (list arg2 arg3 arg1)))
14856 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14857 (if (org-bound-and-true-p european-calendar-style)
14858 (list arg2 arg1 arg3)
14859 (list arg1 arg2 arg3)))))
14861 (defun org-eval-in-calendar (form &optional keepdate)
14862 "Eval FORM in the calendar window and return to current window.
14863 Also, store the cursor date in variable org-ans2."
14864 (let ((sf (selected-frame))
14865 (sw (selected-window)))
14866 (select-window (get-buffer-window "*Calendar*" t))
14867 (eval form)
14868 (when (and (not keepdate) (calendar-cursor-to-date))
14869 (let* ((date (calendar-cursor-to-date))
14870 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14871 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14872 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14873 (select-window sw)
14874 (org-select-frame-set-input-focus sf)))
14876 (defun org-calendar-select ()
14877 "Return to `org-read-date' with the date currently selected.
14878 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14879 (interactive)
14880 (when (calendar-cursor-to-date)
14881 (let* ((date (calendar-cursor-to-date))
14882 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14883 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14884 (if (active-minibuffer-window) (exit-minibuffer))))
14886 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14887 "Insert a date stamp for the date given by the internal TIME.
14888 WITH-HM means use the stamp format that includes the time of the day.
14889 INACTIVE means use square brackets instead of angular ones, so that the
14890 stamp will not contribute to the agenda.
14891 PRE and POST are optional strings to be inserted before and after the
14892 stamp.
14893 The command returns the inserted time stamp."
14894 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14895 stamp)
14896 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14897 (insert-before-markers (or pre ""))
14898 (when (listp extra)
14899 (setq extra (car extra))
14900 (if (and (stringp extra)
14902 (setq extra (format "-%02d:%02d"
14903 (string-to-number (match-string 1 extra))
14904 (string-to-number (match-string 2 extra))))
14905 (setq extra nil)))
14906 (when extra
14907 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14908 (insert-before-markers (setq stamp (format-time-string fmt time)))
14909 (insert-before-markers (or post ""))
14910 (setq org-last-inserted-timestamp stamp)))
14912 (defun org-toggle-time-stamp-overlays ()
14913 "Toggle the use of custom time stamp formats."
14914 (interactive)
14915 (setq org-display-custom-times (not org-display-custom-times))
14916 (unless org-display-custom-times
14917 (let ((p (point-min)) (bmp (buffer-modified-p)))
14918 (while (setq p (next-single-property-change p 'display))
14919 (if (and (get-text-property p 'display)
14920 (eq (get-text-property p 'face) 'org-date))
14921 (remove-text-properties
14922 p (setq p (next-single-property-change p 'display))
14923 '(display t))))
14924 (set-buffer-modified-p bmp)))
14925 (if (featurep 'xemacs)
14926 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14927 (org-restart-font-lock)
14928 (setq org-table-may-need-update t)
14929 (if org-display-custom-times
14930 (message "Time stamps are overlayed with custom format")
14931 (message "Time stamp overlays removed")))
14933 (defun org-display-custom-time (beg end)
14934 "Overlay modified time stamp format over timestamp between BEG and END."
14935 (let* ((ts (buffer-substring beg end))
14936 t1 w1 with-hm tf time str w2 (off 0))
14937 (save-match-data
14938 (setq t1 (org-parse-time-string ts t))
14939 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14940 (setq off (- (match-end 0) (match-beginning 0)))))
14941 (setq end (- end off))
14942 (setq w1 (- end beg)
14943 with-hm (and (nth 1 t1) (nth 2 t1))
14944 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14945 time (org-fix-decoded-time t1)
14946 str (org-add-props
14947 (format-time-string
14948 (substring tf 1 -1) (apply 'encode-time time))
14949 nil 'mouse-face 'highlight)
14950 w2 (length str))
14951 (if (not (= w2 w1))
14952 (add-text-properties (1+ beg) (+ 2 beg)
14953 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14954 (if (featurep 'xemacs)
14955 (progn
14956 (put-text-property beg end 'invisible t)
14957 (put-text-property beg end 'end-glyph (make-glyph str)))
14958 (put-text-property beg end 'display str))))
14960 (defun org-translate-time (string)
14961 "Translate all timestamps in STRING to custom format.
14962 But do this only if the variable `org-display-custom-times' is set."
14963 (when org-display-custom-times
14964 (save-match-data
14965 (let* ((start 0)
14966 (re org-ts-regexp-both)
14967 t1 with-hm inactive tf time str beg end)
14968 (while (setq start (string-match re string start))
14969 (setq beg (match-beginning 0)
14970 end (match-end 0)
14971 t1 (save-match-data
14972 (org-parse-time-string (substring string beg end) t))
14973 with-hm (and (nth 1 t1) (nth 2 t1))
14974 inactive (equal (substring string beg (1+ beg)) "[")
14975 tf (funcall (if with-hm 'cdr 'car)
14976 org-time-stamp-custom-formats)
14977 time (org-fix-decoded-time t1)
14978 str (format-time-string
14979 (concat
14980 (if inactive "[" "<") (substring tf 1 -1)
14981 (if inactive "]" ">"))
14982 (apply 'encode-time time))
14983 string (replace-match str t t string)
14984 start (+ start (length str)))))))
14985 string)
14987 (defun org-fix-decoded-time (time)
14988 "Set 0 instead of nil for the first 6 elements of time.
14989 Don't touch the rest."
14990 (let ((n 0))
14991 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14993 (defun org-days-to-time (timestamp-string)
14994 "Difference between TIMESTAMP-STRING and now in days."
14995 (- (time-to-days (org-time-string-to-time timestamp-string))
14996 (time-to-days (current-time))))
14998 (defun org-deadline-close (timestamp-string &optional ndays)
14999 "Is the time in TIMESTAMP-STRING close to the current date?"
15000 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15001 (and (< (org-days-to-time timestamp-string) ndays)
15002 (not (org-entry-is-done-p))))
15004 (defun org-get-wdays (ts)
15005 "Get the deadline lead time appropriate for timestring TS."
15006 (cond
15007 ((<= org-deadline-warning-days 0)
15008 ;; 0 or negative, enforce this value no matter what
15009 (- org-deadline-warning-days))
15011 ;; lead time is specified.
15012 (floor (* (string-to-number (match-string 1 ts))
15013 (cdr (assoc (match-string 2 ts)
15014 '(("d" . 1) ("w" . 7)
15015 ("m" . 30.4) ("y" . 365.25)))))))
15016 ;; go for the default.
15017 (t org-deadline-warning-days)))
15019 (defun org-calendar-select-mouse (ev)
15020 "Return to `org-read-date' with the date currently selected.
15021 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15022 (interactive "e")
15023 (mouse-set-point ev)
15024 (when (calendar-cursor-to-date)
15025 (let* ((date (calendar-cursor-to-date))
15026 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15027 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15028 (if (active-minibuffer-window) (exit-minibuffer))))
15030 (defun org-check-deadlines (ndays)
15031 "Check if there are any deadlines due or past due.
15032 A deadline is considered due if it happens within `org-deadline-warning-days'
15033 days from today's date. If the deadline appears in an entry marked DONE,
15034 it is not shown. The prefix arg NDAYS can be used to test that many
15036 (interactive "P")
15037 (let* ((org-warn-days
15038 (cond
15039 ((equal ndays '(4)) 100000)
15040 (ndays (prefix-numeric-value ndays))
15041 (t (abs org-deadline-warning-days))))
15042 (case-fold-search nil)
15044 (callback
15045 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15047 (message "%d deadlines past-due or due within %d days"
15048 (org-occur regexp nil callback)
15049 org-warn-days)))
15051 (defun org-check-before-date (date)
15052 "Check if there are deadlines or scheduled entries before DATE."
15053 (interactive (list (org-read-date)))
15054 (let ((case-fold-search nil)
15058 (callback
15059 (lambda () (time-less-p
15060 (org-time-string-to-time (match-string 2))
15061 (org-time-string-to-time date)))))
15062 (message "%d entries before %s"
15063 (org-occur regexp nil callback) date)))
15065 (defun org-check-after-date (date)
15066 "Check if there are deadlines or scheduled entries after DATE."
15067 (interactive (list (org-read-date)))
15068 (let ((case-fold-search nil)
15072 (callback
15073 (lambda () (not
15074 (time-less-p
15075 (org-time-string-to-time (match-string 2))
15076 (org-time-string-to-time date))))))
15077 (message "%d entries after %s"
15078 (org-occur regexp nil callback) date)))
15080 (defun org-evaluate-time-range (&optional to-buffer)
15081 "Evaluate a time range by computing the difference between start and end.
15082 Normally the result is just printed in the echo area, but with prefix arg
15083 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15084 If the time range is actually in a table, the result is inserted into the
15085 next column.
15086 For time difference computation, a year is assumed to be exactly 365
15087 days in order to avoid rounding problems."
15088 (interactive "P")
15089 (or
15090 (org-clock-update-time-maybe)
15091 (save-excursion
15092 (unless (org-at-date-range-p t)
15093 (goto-char (point-at-bol))
15094 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15095 (if (not (org-at-date-range-p t))
15096 (error "Not at a time-stamp range, and none found in current line")))
15097 (let* ((ts1 (match-string 1))
15098 (ts2 (match-string 2))
15099 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15100 (match-end (match-end 0))
15101 (time1 (org-time-string-to-time ts1))
15102 (time2 (org-time-string-to-time ts2))
15103 (t1 (org-float-time time1))
15104 (t2 (org-float-time time2))
15105 (diff (abs (- t2 t1)))
15106 (negative (< (- t2 t1) 0))
15107 ;; (ys (floor (* 365 24 60 60)))
15108 (ds (* 24 60 60))
15109 (hs (* 60 60))
15110 (fy "%dy %dd %02d:%02d")
15111 (fy1 "%dy %dd")
15112 (fd "%dd %02d:%02d")
15113 (fd1 "%dd")
15114 (fh "%02d:%02d")
15115 y d h m align)
15116 (if havetime
15117 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15118 y 0
15119 d (floor (/ diff ds)) diff (mod diff ds)
15120 h (floor (/ diff hs)) diff (mod diff hs)
15121 m (floor (/ diff 60)))
15122 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15123 y 0
15124 d (floor (+ (/ diff ds) 0.5))
15125 h 0 m 0))
15126 (if (not to-buffer)
15127 (message "%s" (org-make-tdiff-string y d h m))
15128 (if (org-at-table-p)
15129 (progn
15130 (goto-char match-end)
15131 (setq align t)
15132 (and (looking-at " *|") (goto-char (match-end 0))))
15133 (goto-char match-end))
15134 (if (looking-at
15136 (replace-match ""))
15137 (if negative (insert " -"))
15138 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15139 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15140 (insert " " (format fh h m))))
15141 (if align (org-table-align))
15142 (message "Time difference inserted")))))
15144 (defun org-make-tdiff-string (y d h m)
15145 (let ((fmt "")
15146 (l nil))
15147 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15148 l (push y l)))
15149 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15150 l (push d l)))
15151 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15152 l (push h l)))
15153 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15154 l (push m l)))
15155 (apply 'format fmt (nreverse l))))
15157 (defun org-time-string-to-time (s)
15158 (apply 'encode-time (org-parse-time-string s)))
15159 (defun org-time-string-to-seconds (s)
15160 (org-float-time (org-time-string-to-time s)))
15162 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15163 "Convert a time stamp to an absolute day number.
15164 If there is a specifier for a cyclic time stamp, get the closest date to
15165 DAYNR.
15166 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15167 The variable date is bound by the calendar when this is called."
15168 (cond
15170 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15171 daynr
15172 (+ daynr 1000)))
15174 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15175 (time-to-days (current-time))) (match-string 0 s)
15176 prefer show-all))
15177 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15179 (defun org-days-to-iso-week (days)
15180 "Return the iso week number."
15181 (require 'cal-iso)
15182 (car (calendar-iso-from-absolute days)))
15184 (defun org-small-year-to-year (year)
15185 "Convert 2-digit years into 4-digit years.
15186 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15187 The year 2000 cannot be abbreviated. Any year larger than 99
15188 is returned unchanged."
15189 (if (< year 38)
15190 (setq year (+ 2000 year))
15191 (if (< year 100)
15192 (setq year (+ 1900 year))))
15193 year)
15195 (defun org-time-from-absolute (d)
15196 "Return the time corresponding to date D.
15197 D may be an absolute day number, or a calendar-type list (month day year)."
15198 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15199 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15201 (defun org-calendar-holiday ()
15202 "List of holidays, for Diary display in Org-mode."
15203 (require 'holidays)
15204 (let ((hl (funcall
15205 (if (fboundp 'calendar-check-holidays)
15206 'calendar-check-holidays 'check-calendar-holidays) date)))
15207 (if hl (mapconcat 'identity hl "; "))))
15209 (defun org-diary-sexp-entry (sexp entry date)
15210 "Process a SEXP diary ENTRY for DATE."
15211 (require 'diary-lib)
15212 (let ((result (if calendar-debug-sexp
15213 (let ((stack-trace-on-error t))
15214 (eval (car (read-from-string sexp))))
15215 (condition-case nil
15216 (eval (car (read-from-string sexp)))
15217 (error
15218 (beep)
15219 (message "Bad sexp at line %d in %s: %s"
15220 (org-current-line)
15221 (buffer-file-name) sexp)
15222 (sleep-for 2))))))
15223 (cond ((stringp result) (split-string result "; "))
15224 ((and (consp result)
15225 (not (consp (cdr result)))
15226 (stringp (cdr result))) (cdr result))
15227 ((and (consp result)
15228 (stringp (car result))) result)
15229 (result entry)
15230 (t nil))))
15232 (defun org-diary-to-ical-string (frombuf)
15233 "Get iCalendar entries from diary entries in buffer FROMBUF.
15234 This uses the icalendar.el library."
15235 (let* ((tmpdir (if (featurep 'xemacs)
15236 (temp-directory)
15237 temporary-file-directory))
15238 (tmpfile (make-temp-name
15239 (expand-file-name "orgics" tmpdir)))
15240 buf rtn b e)
15241 (with-current-buffer frombuf
15242 (icalendar-export-region (point-min) (point-max) tmpfile)
15243 (setq buf (find-buffer-visiting tmpfile))
15244 (set-buffer buf)
15245 (goto-char (point-min))
15246 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15247 (setq b (match-beginning 0)))
15248 (goto-char (point-max))
15249 (if (re-search-backward "^END:VEVENT" nil t)
15250 (setq e (match-end 0)))
15252 (kill-buffer buf)
15253 (delete-file tmpfile)
15254 rtn))
15256 (defun org-closest-date (start current change prefer show-all)
15257 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15258 When PREFER is `past', return a date that is either CURRENT or past.
15259 When PREFER is `future', return a date that is either CURRENT or future.
15260 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15261 ;; Make the proper lists from the dates
15262 (catch 'exit
15263 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15264 dn dw sday cday n1 n2 n0
15265 d m y y1 y2 date1 date2 nmonths nm ny m2)
15267 (setq start (org-date-to-gregorian start)
15268 current (org-date-to-gregorian
15269 (if show-all
15270 current
15271 (time-to-days (current-time))))
15272 sday (calendar-absolute-from-gregorian start)
15273 cday (calendar-absolute-from-gregorian current))
15275 (if (<= cday sday) (throw 'exit sday))
15278 (setq dn (string-to-number (match-string 1 change))
15279 dw (cdr (assoc (match-string 2 change) a1)))
15280 (error "Invalid change specifier: %s" change))
15281 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15282 (cond
15283 ((eq dw 'day)
15284 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15285 n2 (+ n1 dn)))
15286 ((eq dw 'year)
15287 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15288 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15289 (setq date1 (list m d y1)
15290 n1 (calendar-absolute-from-gregorian date1)
15291 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15292 n2 (calendar-absolute-from-gregorian date2)))
15293 ((eq dw 'month)
15294 ;; approx number of month between the two dates
15295 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15296 ;; How often does dn fit in there?
15297 (setq d (nth 1 start) m (car start) y (nth 2 start)
15298 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15299 m (+ m nm)
15300 ny (floor (/ m 12))
15301 y (+ y ny)
15302 m (- m (* ny 12)))
15303 (while (> m 12) (setq m (- m 12) y (1+ y)))
15304 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15305 (setq m2 (+ m dn) y2 y)
15306 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15307 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15308 (while (<= n2 cday)
15309 (setq n1 n2 m m2 y y2)
15310 (setq m2 (+ m dn) y2 y)
15311 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15312 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15313 ;; Make sure n1 is the earlier date
15314 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15315 (if show-all
15316 (cond
15317 ((eq prefer 'past) (if (= cday n2) n2 n1))
15318 ((eq prefer 'future) (if (= cday n1) n1 n2))
15319 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15320 (cond
15321 ((eq prefer 'past) (if (= cday n2) n2 n1))
15322 ((eq prefer 'future) (if (= cday n1) n1 n2))
15323 (t (if (= cday n1) n1 n2)))))))
15325 (defun org-date-to-gregorian (date)
15326 "Turn any specification of DATE into a Gregorian date for the calendar."
15327 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15328 ((and (listp date) (= (length date) 3)) date)
15329 ((stringp date)
15330 (setq date (org-parse-time-string date))
15331 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15332 ((listp date)
15333 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15335 (defun org-parse-time-string (s &optional nodefault)
15336 "Parse the standard Org-mode time string.
15337 This should be a lot faster than the normal `parse-time-string'.
15338 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15339 hour and minute fields will be nil if not given."
15340 (if (string-match org-ts-regexp0 s)
15341 (list 0
15342 (if (or (match-beginning 8) (not nodefault))
15343 (string-to-number (or (match-string 8 s) "0")))
15344 (if (or (match-beginning 7) (not nodefault))
15345 (string-to-number (or (match-string 7 s) "0")))
15346 (string-to-number (match-string 4 s))
15347 (string-to-number (match-string 3 s))
15348 (string-to-number (match-string 2 s))
15349 nil nil nil)
15350 (error "Not a standard Org-mode time string: %s" s)))
15352 (defun org-timestamp-up (&optional arg)
15353 "Increase the date item at the cursor by one.
15354 If the cursor is on the year, change the year. If it is on the month or
15355 the day, change that.
15356 With prefix ARG, change by that many units."
15357 (interactive "p")
15358 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15360 (defun org-timestamp-down (&optional arg)
15361 "Decrease the date item at the cursor by one.
15362 If the cursor is on the year, change the year. If it is on the month or
15363 the day, change that.
15364 With prefix ARG, change by that many units."
15365 (interactive "p")
15366 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15368 (defun org-timestamp-up-day (&optional arg)
15369 "Increase the date in the time stamp by one day.
15370 With prefix ARG, change that many days."
15371 (interactive "p")
15372 (if (and (not (org-at-timestamp-p t))
15373 (org-on-heading-p))
15374 (org-todo 'up)
15375 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15377 (defun org-timestamp-down-day (&optional arg)
15378 "Decrease the date in the time stamp by one day.
15379 With prefix ARG, change that many days."
15380 (interactive "p")
15381 (if (and (not (org-at-timestamp-p t))
15382 (org-on-heading-p))
15383 (org-todo 'down)
15384 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15386 (defun org-at-timestamp-p (&optional inactive-ok)
15387 "Determine if the cursor is in or at a timestamp."
15388 (interactive)
15389 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15390 (pos (point))
15391 (ans (or (looking-at tsr)
15392 (save-excursion
15394 (if (> (point) (point-min)) (backward-char 1))
15395 (and (looking-at tsr)
15396 (> (- (match-end 0) pos) -1))))))
15397 (and ans
15398 (boundp 'org-ts-what)
15399 (setq org-ts-what
15400 (cond
15401 ((= pos (match-beginning 0)) 'bracket)
15402 ((= pos (1- (match-end 0))) 'bracket)
15403 ((org-pos-in-match-range pos 2) 'year)
15404 ((org-pos-in-match-range pos 3) 'month)
15405 ((org-pos-in-match-range pos 7) 'hour)
15406 ((org-pos-in-match-range pos 8) 'minute)
15407 ((or (org-pos-in-match-range pos 4)
15408 (org-pos-in-match-range pos 5)) 'day)
15409 ((and (> pos (or (match-end 8) (match-end 5)))
15410 (< pos (match-end 0)))
15411 (- pos (or (match-end 8) (match-end 5))))
15412 (t 'day))))
15413 ans))
15415 (defun org-toggle-timestamp-type ()
15416 "Toggle the type (<active> or [inactive]) of a time stamp."
15417 (interactive)
15418 (when (org-at-timestamp-p t)
15419 (let ((beg (match-beginning 0)) (end (match-end 0))
15420 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15421 (save-excursion
15422 (goto-char beg)
15423 (while (re-search-forward "[][<>]" end t)
15424 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15425 t t)))
15426 (message "Timestamp is now %sactive"
15427 (if (equal (char-after beg) ?<) "" "in")))))
15429 (defun org-timestamp-change (n &optional what updown)
15430 "Change the date in the time stamp at point.
15431 The date will be changed by N times WHAT. WHAT can be `day', `month',
15432 `year', `minute', `second'. If WHAT is not given, the cursor position
15433 in the timestamp determines what will be changed."
15434 (let ((pos (point))
15435 with-hm inactive
15436 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15437 org-ts-what
15438 extra rem
15439 ts time time0)
15440 (if (not (org-at-timestamp-p t))
15441 (error "Not at a timestamp"))
15442 (if (and (not what) (eq org-ts-what 'bracket))
15443 (org-toggle-timestamp-type)
15444 (if (and (not what) (not (eq org-ts-what 'day))
15445 org-display-custom-times
15446 (get-text-property (point) 'display)
15447 (not (get-text-property (1- (point)) 'display)))
15448 (setq org-ts-what 'day))
15449 (setq org-ts-what (or what org-ts-what)
15450 inactive (= (char-after (match-beginning 0)) ?\[)
15451 ts (match-string 0))
15452 (replace-match "")
15453 (if (string-match
15455 ts)
15456 (setq extra (match-string 1 ts)))
15458 (setq with-hm t))
15459 (setq time0 (org-parse-time-string ts))
15460 (when (and updown
15461 (eq org-ts-what 'minute)
15462 (not current-prefix-arg))
15463 ;; This looks like s-up and s-down. Change by one rounding step.
15464 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15465 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15466 (setcar (cdr time0) (+ (nth 1 time0)
15467 (if (> n 0) (- rem) (- dm rem))))))
15468 (setq time
15469 (encode-time (or (car time0) 0)
15470 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15471 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15472 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15473 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15474 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15475 (nthcdr 6 time0)))
15476 (when (and (member org-ts-what '(hour minute))
15477 extra
15479 (setq extra (org-modify-ts-extra
15480 extra
15481 (if (eq org-ts-what 'hour) 2 5)
15482 n dm)))
15483 (when (integerp org-ts-what)
15484 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15485 (if (eq what 'calendar)
15486 (let ((cal-date (org-get-date-from-calendar)))
15487 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15488 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15489 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15490 (setcar time0 (or (car time0) 0))
15491 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15492 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15493 (setq time (apply 'encode-time time0))))
15494 (setq org-last-changed-timestamp
15495 (org-insert-time-stamp time with-hm inactive nil nil extra))
15496 (org-clock-update-time-maybe)
15497 (goto-char pos)
15498 ;; Try to recenter the calendar window, if any
15499 (if (and org-calendar-follow-timestamp-change
15500 (get-buffer-window "*Calendar*" t)
15501 (memq org-ts-what '(day month year)))
15502 (org-recenter-calendar (time-to-days time))))))
15504 (defun org-modify-ts-extra (s pos n dm)
15505 "Change the different parts of the lead-time and repeat fields in timestamp."
15506 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15507 ng h m new rem)
15508 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15509 (cond
15510 ((or (org-pos-in-match-range pos 2)
15511 (org-pos-in-match-range pos 3))
15512 (setq m (string-to-number (match-string 3 s))
15513 h (string-to-number (match-string 2 s)))
15514 (if (org-pos-in-match-range pos 2)
15515 (setq h (+ h n))
15516 (setq n (* dm (org-no-warnings (signum n))))
15517 (when (not (= 0 (setq rem (% m dm))))
15518 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15519 (setq m (+ m n)))
15520 (if (< m 0) (setq m (+ m 60) h (1- h)))
15521 (if (> m 59) (setq m (- m 60) h (1+ h)))
15522 (setq h (min 24 (max 0 h)))
15523 (setq ng 1 new (format "-%02d:%02d" h m)))
15524 ((org-pos-in-match-range pos 6)
15525 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15526 ((org-pos-in-match-range pos 5)
15527 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15529 ((org-pos-in-match-range pos 9)
15530 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15531 ((org-pos-in-match-range pos 8)
15532 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15534 (when ng
15535 (setq s (concat
15536 (substring s 0 (match-beginning ng))
15537 new
15538 (substring s (match-end ng))))))
15539 s))
15541 (defun org-recenter-calendar (date)
15542 "If the calendar is visible, recenter it to DATE."
15543 (let* ((win (selected-window))
15544 (cwin (get-buffer-window "*Calendar*" t))
15545 (calendar-move-hook nil))
15546 (when cwin
15547 (select-window cwin)
15548 (calendar-goto-date (if (listp date) date
15549 (calendar-gregorian-from-absolute date)))
15550 (select-window win))))
15552 (defun org-goto-calendar (&optional arg)
15553 "Go to the Emacs calendar at the current date.
15554 If there is a time stamp in the current line, go to that date.
15555 A prefix ARG can be used to force the current date."
15556 (interactive "P")
15557 (let ((tsr org-ts-regexp) diff
15558 (calendar-move-hook nil)
15559 (calendar-view-holidays-initially-flag nil)
15560 (calendar-view-diary-initially-flag nil))
15561 (if (or (org-at-timestamp-p)
15562 (save-excursion
15563 (beginning-of-line 1)
15564 (looking-at (concat ".*" tsr))))
15565 (let ((d1 (time-to-days (current-time)))
15566 (d2 (time-to-days
15567 (org-time-string-to-time (match-string 1)))))
15568 (setq diff (- d2 d1))))
15569 (calendar)
15570 (calendar-goto-today)
15571 (if (and diff (not arg)) (calendar-forward-day diff))))
15573 (defun org-get-date-from-calendar ()
15574 "Return a list (month day year) of date at point in calendar."
15575 (with-current-buffer "*Calendar*"
15576 (save-match-data
15577 (calendar-cursor-to-date))))
15579 (defun org-date-from-calendar ()
15580 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15581 If there is already a time stamp at the cursor position, update it."
15582 (interactive)
15583 (if (org-at-timestamp-p t)
15584 (org-timestamp-change 0 'calendar)
15585 (let ((cal-date (org-get-date-from-calendar)))
15586 (org-insert-time-stamp
15587 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15589 (defun org-minutes-to-hh:mm-string (m)
15590 "Compute H:MM from a number of minutes."
15591 (let ((h (/ m 60)))
15592 (setq m (- m (* 60 h)))
15593 (format org-time-clocksum-format h m)))
15595 (defun org-hh:mm-string-to-minutes (s)
15596 "Convert a string H:MM to a number of minutes.
15597 If the string is just a number, interpret it as minutes.
15598 In fact, the first hh:mm or number in the string will be taken,
15599 there can be extra stuff in the string.
15600 If no number is found, the return value is 0."
15601 (cond
15602 ((integerp s) s)
15604 (+ (* (string-to-number (match-string 1 s)) 60)
15605 (string-to-number (match-string 2 s))))
15607 (string-to-number (match-string 1 s)))
15608 (t 0)))
15610 (defcustom org-effort-durations
15611 `(("h" . 60)
15612 ("d" . ,(* 60 8))
15613 ("w" . ,(* 60 8 5))
15614 ("m" . ,(* 60 8 5 4))
15615 ("y" . ,(* 60 8 5 40)))
15616 "Conversion factor to minutes for an effort modifier.
15618 Each entry has the form (MODIFIER . MINUTES).
15620 In an effort string, a number followed by MODIFIER is multiplied
15621 by the specified number of MINUTES to obtain an effort in
15622 minutes.
15626 :group 'org-agenda
15627 :type '(alist :key-type (string :tag "Modifier")
15628 :value-type (number :tag "Minutes")))
15630 (defun org-duration-string-to-minutes (s)
15631 "Convert a duration string S to minutes.
15633 A bare number is interpreted as minutes, modifiers can be set by
15634 customizing `org-effort-durations' (which see).
15636 Entries containing a colon are interpreted as H:MM by
15637 `org-hh:mm-string-to-minutes'."
15638 (let ((result 0)
15640 (regexp-opt (mapcar 'car org-effort-durations))
15642 (while (string-match re s)
15643 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15644 (string-to-number (match-string 1 s))))
15645 (setq s (replace-match "" nil t s)))
15646 (incf result (org-hh:mm-string-to-minutes s))
15647 result))
15649 ;;;; Files
15651 (defun org-save-all-org-buffers ()
15652 "Save all Org-mode buffers without user confirmation."
15653 (interactive)
15654 (message "Saving all Org-mode buffers...")
15655 (save-some-buffers t 'org-mode-p)
15656 (when (featurep 'org-id) (org-id-locations-save))
15657 (message "Saving all Org-mode buffers... done"))
15659 (defun org-revert-all-org-buffers ()
15660 "Revert all Org-mode buffers.
15661 Prompt for confirmation when there are unsaved changes.
15662 Be sure you know what you are doing before letting this function
15663 overwrite your changes.
15665 This function is useful in a setup where one tracks org files
15666 with a version control system, to revert on one machine after pulling
15667 changes from another. I believe the procedure must be like this:
15669 1. M-x org-save-all-org-buffers
15670 2. Pull changes from the other machine, resolve conflicts
15671 3. M-x org-revert-all-org-buffers"
15672 (interactive)
15673 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15674 (error "Abort"))
15675 (save-excursion
15676 (save-window-excursion
15677 (mapc
15678 (lambda (b)
15679 (when (and (with-current-buffer b (org-mode-p))
15680 (with-current-buffer b buffer-file-name))
15681 (switch-to-buffer b)
15682 (revert-buffer t 'no-confirm)))
15683 (buffer-list))
15684 (when (and (featurep 'org-id) org-id-track-globally)
15685 (org-id-locations-load)))))
15687 ;;;; Agenda files
15689 ;;;###autoload
15690 (defun org-switchb (&optional arg)
15691 "Switch between Org buffers.
15692 With a prefix argument, restrict available to files.
15693 With two prefix arguments, restrict available buffers to agenda files.
15695 Defaults to `iswitchb' for buffer name completion.
15696 Set `org-completion-use-ido' to make it use ido instead."
15697 (interactive "P")
15698 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15699 ((equal arg '(16)) (org-buffer-list 'agenda))
15700 (t (org-buffer-list))))
15701 (org-completion-use-iswitchb org-completion-use-iswitchb)
15702 (org-completion-use-ido org-completion-use-ido))
15703 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15704 (setq org-completion-use-iswitchb t))
15705 (switch-to-buffer
15706 (org-icompleting-read "Org buffer: "
15707 (mapcar 'list (mapcar 'buffer-name blist))
15708 nil t))))
15710 ;;; Define some older names previously used for this functionality
15711 ;;;###autoload
15712 (defalias 'org-ido-switchb 'org-switchb)
15713 ;;;###autoload
15714 (defalias 'org-iswitchb 'org-switchb)
15716 (defun org-buffer-list (&optional predicate exclude-tmp)
15717 "Return a list of Org buffers.
15718 PREDICATE can be `export', `files' or `agenda'.
15720 export restrict the list to Export buffers.
15721 files restrict the list to buffers visiting Org files.
15722 agenda restrict the list to buffers visiting agenda files.
15724 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15725 (let* ((bfn nil)
15726 (agenda-files (and (eq predicate 'agenda)
15727 (mapcar 'file-truename (org-agenda-files t))))
15728 (filter
15729 (cond
15730 ((eq predicate 'files)
15731 (lambda (b) (with-current-buffer b (org-mode-p))))
15732 ((eq predicate 'export)
15733 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15734 ((eq predicate 'agenda)
15735 (lambda (b)
15736 (with-current-buffer b
15737 (and (org-mode-p)
15738 (setq bfn (buffer-file-name b))
15739 (member (file-truename bfn) agenda-files)))))
15740 (t (lambda (b) (with-current-buffer b
15741 (or (org-mode-p)
15742 (string-match "\*Org .*Export"
15743 (buffer-name b)))))))))
15744 (delq nil
15745 (mapcar
15746 (lambda(b)
15747 (if (and (funcall filter b)
15748 (or (not exclude-tmp)
15749 (not (string-match "tmp" (buffer-name b)))))
15750 b
15751 nil))
15752 (buffer-list)))))
15754 (defun org-agenda-files (&optional unrestricted archives)
15755 "Get the list of agenda files.
15756 Optional UNRESTRICTED means return the full list even if a restriction
15757 is currently in place.
15758 When ARCHIVES is t, include all archive files that are really being
15759 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15760 `org-agenda-archives-mode' is t."
15761 (let ((files
15762 (cond
15763 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15764 ((stringp org-agenda-files) (org-read-agenda-file-list))
15765 ((listp org-agenda-files) org-agenda-files)
15766 (t (error "Invalid value of `org-agenda-files'")))))
15767 (setq files (apply 'append
15768 (mapcar (lambda (f)
15769 (if (file-directory-p f)
15770 (directory-files
15771 f t org-agenda-file-regexp)
15772 (list f)))
15773 files)))
15774 (when org-agenda-skip-unavailable-files
15775 (setq files (delq nil
15776 (mapcar (function
15777 (lambda (file)
15778 (and (file-readable-p file) file)))
15779 files))))
15780 (when (or (eq archives t)
15781 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15782 (setq files (org-add-archive-files files)))
15783 files))
15785 (defun org-agenda-file-p (&optional file)
15786 "Return non-nil, if FILE is an agenda file.
15787 If FILE is omitted, use the file associated with the current
15788 buffer."
15789 (member (or file (buffer-file-name))
15790 (org-agenda-files t)))
15792 (defun org-edit-agenda-file-list ()
15793 "Edit the list of agenda files.
15794 Depending on setup, this either uses customize to edit the variable
15795 `org-agenda-files', or it visits the file that is holding the list. In the
15796 latter case, the buffer is set up in a way that saving it automatically kills
15797 the buffer and restores the previous window configuration."
15798 (interactive)
15799 (if (stringp org-agenda-files)
15800 (let ((cw (current-window-configuration)))
15801 (find-file org-agenda-files)
15802 (org-set-local 'org-window-configuration cw)
15803 (org-add-hook 'after-save-hook
15804 (lambda ()
15805 (set-window-configuration
15806 (prog1 org-window-configuration
15807 (kill-buffer (current-buffer))))
15808 (org-install-agenda-files-menu)
15809 (message "New agenda file list installed"))
15810 nil 'local)
15811 (message "%s" (substitute-command-keys
15813 (customize-variable 'org-agenda-files)))
15815 (defun org-store-new-agenda-file-list (list)
15816 "Set new value for the agenda file list and save it correctly."
15817 (if (stringp org-agenda-files)
15818 (let ((fe (org-read-agenda-file-list t)) b u)
15819 (while (setq b (find-buffer-visiting org-agenda-files))
15820 (kill-buffer b))
15821 (with-temp-file org-agenda-files
15822 (insert
15823 (mapconcat
15824 (lambda (f) ;; Keep un-expanded entries.
15825 (if (setq u (assoc f fe))
15826 (cdr u)
15827 f))
15830 (let ((org-mode-hook nil) (org-inhibit-startup t)
15831 (org-insert-mode-line-in-empty-file nil))
15832 (setq org-agenda-files list)
15833 (customize-save-variable 'org-agenda-files org-agenda-files))))
15835 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15836 "Read the list of agenda files from a file.
15837 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15838 filenames, used by `org-store-new-agenda-file-list' to write back
15839 un-expanded file names."
15840 (when (file-directory-p org-agenda-files)
15841 (error "`org-agenda-files' cannot be a single directory"))
15842 (when (stringp org-agenda-files)
15843 (with-temp-buffer
15844 (insert-file-contents org-agenda-files)
15845 (mapcar
15846 (lambda (f)
15847 (let ((e (expand-file-name (substitute-in-file-name f)
15848 org-directory)))
15849 (if pair-with-expansion
15850 (cons e f)
15851 e)))
15854 ;;;###autoload
15855 (defun org-cycle-agenda-files ()
15856 "Cycle through the files in `org-agenda-files'.
15857 If the current buffer visits an agenda file, find the next one in the list.
15858 If the current buffer does not, find the first agenda file."
15859 (interactive)
15860 (let* ((fs (org-agenda-files t))
15861 (files (append fs (list (car fs))))
15862 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15863 file)
15864 (unless files (error "No agenda files"))
15865 (catch 'exit
15866 (while (setq file (pop files))
15867 (if (equal (file-truename file) tcf)
15868 (when (car files)
15869 (find-file (car files))
15870 (throw 'exit t))))
15871 (find-file (car fs)))
15872 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15874 (defun org-agenda-file-to-front (&optional to-end)
15875 "Move/add the current file to the top of the agenda file list.
15876 If the file is not present in the list, it is added to the front. If it is
15877 present, it is moved there. With optional argument TO-END, add/move to the
15878 end of the list."
15879 (interactive "P")
15880 (let ((org-agenda-skip-unavailable-files nil)
15881 (file-alist (mapcar (lambda (x)
15882 (cons (file-truename x) x))
15883 (org-agenda-files t)))
15884 (ctf (file-truename buffer-file-name))
15885 x had)
15886 (setq x (assoc ctf file-alist) had x)
15888 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15889 (if to-end
15890 (setq file-alist (append (delq x file-alist) (list x)))
15891 (setq file-alist (cons x (delq x file-alist))))
15892 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15893 (org-install-agenda-files-menu)
15894 (message "File %s to %s of agenda file list"
15895 (if had "moved" "added") (if to-end "end" "front"))))
15897 (defun org-remove-file (&optional file)
15898 "Remove current file from the list of files in variable `org-agenda-files'.
15899 These are the files which are being checked for agenda entries.
15900 Optional argument FILE means use this file instead of the current."
15901 (interactive)
15902 (let* ((org-agenda-skip-unavailable-files nil)
15903 (file (or file buffer-file-name))
15904 (true-file (file-truename file))
15905 (afile (abbreviate-file-name file))
15906 (files (delq nil (mapcar
15907 (lambda (x)
15908 (if (equal true-file
15909 (file-truename x))
15910 nil x))
15911 (org-agenda-files t)))))
15912 (if (not (= (length files) (length (org-agenda-files t))))
15913 (progn
15914 (org-store-new-agenda-file-list files)
15915 (org-install-agenda-files-menu)
15916 (message "Removed file: %s" afile))
15917 (message "File was not in list: %s (not removed)" afile))))
15919 (defun org-file-menu-entry (file)
15920 (vector file (list 'find-file file) t))
15922 (defun org-check-agenda-file (file)
15923 "Make sure FILE exists. If not, ask user what to do."
15924 (when (not (file-exists-p file))
15925 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15926 (abbreviate-file-name file))
15927 (let ((r (downcase (read-char-exclusive))))
15928 (cond
15929 ((equal r ?r)
15930 (org-remove-file file)
15931 (throw 'nextfile t))
15932 (t (error "Abort"))))))
15934 (defun org-get-agenda-file-buffer (file)
15935 "Get a buffer visiting FILE. If the buffer needs to be created, add
15936 it to the list of buffers which might be released later."
15937 (let ((buf (org-find-base-buffer-visiting file)))
15938 (if buf
15939 buf ; just return it
15940 ;; Make a new buffer and remember it
15941 (setq buf (find-file-noselect file))
15942 (if buf (push buf org-agenda-new-buffers))
15943 buf)))
15945 (defun org-release-buffers (blist)
15946 "Release all buffers in list, asking the user for confirmation when needed.
15947 When a buffer is unmodified, it is just killed. When modified, it is saved
15948 \(if the user agrees) and then killed."
15949 (let (buf file)
15950 (while (setq buf (pop blist))
15951 (setq file (buffer-file-name buf))
15952 (when (and (buffer-modified-p buf)
15953 file
15954 (y-or-n-p (format "Save file %s? " file)))
15955 (with-current-buffer buf (save-buffer)))
15956 (kill-buffer buf))))
15958 (defun org-prepare-agenda-buffers (files)
15959 "Create buffers for all agenda files, protect archived trees and comments."
15960 (interactive)
15961 (let ((pa '(:org-archived t))
15962 (pc '(:org-comment t))
15963 (pall '(:org-archived t :org-comment t))
15964 (inhibit-read-only t)
15965 (rea (concat ":" org-archive-tag ":"))
15966 bmp file re)
15967 (save-excursion
15968 (save-restriction
15969 (while (setq file (pop files))
15970 (catch 'nextfile
15971 (if (bufferp file)
15972 (set-buffer file)
15973 (org-check-agenda-file file)
15974 (set-buffer (org-get-agenda-file-buffer file)))
15975 (widen)
15976 (setq bmp (buffer-modified-p))
15977 (org-refresh-category-properties)
15978 (setq org-todo-keywords-for-agenda
15979 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15980 (setq org-done-keywords-for-agenda
15981 (append org-done-keywords-for-agenda org-done-keywords))
15982 (setq org-todo-keyword-alist-for-agenda
15983 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15984 (setq org-drawers-for-agenda
15985 (append org-drawers-for-agenda org-drawers))
15986 (setq org-tag-alist-for-agenda
15987 (append org-tag-alist-for-agenda org-tag-alist))
15989 (save-excursion
15990 (remove-text-properties (point-min) (point-max) pall)
15991 (when org-agenda-skip-archived-trees
15992 (goto-char (point-min))
15993 (while (re-search-forward rea nil t)
15994 (if (org-on-heading-p t)
15995 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15996 (goto-char (point-min))
15998 (while (re-search-forward re nil t)
15999 (add-text-properties
16000 (match-beginning 0) (org-end-of-subtree t) pc)))
16001 (set-buffer-modified-p bmp)))))
16002 (setq org-todo-keywords-for-agenda
16003 (org-uniquify org-todo-keywords-for-agenda))
16004 (setq org-todo-keyword-alist-for-agenda
16005 (org-uniquify org-todo-keyword-alist-for-agenda)
16006 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16008 ;;;; Embedded LaTeX
16010 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16011 "Keymap for the minor `org-cdlatex-mode'.")
16013 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16014 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16015 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16016 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16017 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16019 (defvar org-cdlatex-texmathp-advice-is-done nil
16020 "Flag remembering if we have applied the advice to texmathp already.")
16022 (define-minor-mode org-cdlatex-mode
16023 "Toggle the minor `org-cdlatex-mode'.
16024 This mode supports entering LaTeX environment and math in LaTeX fragments
16025 in Org-mode.
16027 nil " OCDL" nil
16028 (when org-cdlatex-mode (require 'cdlatex))
16029 (unless org-cdlatex-texmathp-advice-is-done
16030 (setq org-cdlatex-texmathp-advice-is-done t)
16031 (defadvice texmathp (around org-math-always-on activate)
16032 "Always return t in org-mode buffers.
16033 This is because we want to insert math symbols without dollars even outside
16034 the LaTeX math segments. If Orgmode thinks that point is actually inside
16035 an embedded LaTeX fragment, let texmathp do its job.
16037 (interactive)
16038 (let (p)
16039 (cond
16040 ((not (org-mode-p)) ad-do-it)
16041 ((eq this-command 'cdlatex-math-symbol)
16042 (setq ad-return-value t
16043 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16044 (t
16045 (let ((p (org-inside-LaTeX-fragment-p)))
16046 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16047 (setq ad-return-value t
16048 texmathp-why '("Org-mode embedded math" . 0))
16049 (if p ad-do-it)))))))))
16051 (defun turn-on-org-cdlatex ()
16052 "Unconditionally turn on `org-cdlatex-mode'."
16053 (org-cdlatex-mode 1))
16055 (defun org-inside-LaTeX-fragment-p ()
16056 "Test if point is inside a LaTeX fragment.
16058 sequence appearing also before point.
16059 Even though the matchers for math are configurable, this function assumes
16061 delimiters are skipped when they have been removed by customization.
16062 The return value is nil, or a cons cell with the delimiter and
16063 and the position of this delimiter.
16065 This function does a reasonably good job, but can locally be fooled by
16066 for example currency specifications. For example it will assume being in
16068 fragments that are properly closed, but during editing, we have to live
16069 with the uncertainty caused by missing closing delimiters. This function
16070 looks only before point, not after."
16071 (catch 'exit
16072 (let ((pos (point))
16073 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16074 (lim (progn
16076 (point)))
16077 dd-on str (start 0) m re)
16078 (goto-char pos)
16079 (when dodollar
16081 re (nth 1 (assoc "$" org-latex-regexps)))
16082 (while (string-match re str start)
16083 (cond
16084 ((= (match-end 0) (length str))
16085 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16086 ((= (match-end 0) (- (length str) 5))
16087 (throw 'exit nil))
16088 (t (setq start (match-end 0))))))
16089 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16090 (goto-char pos)
16091 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16092 (and (match-beginning 2) (throw 'exit nil))
16093 ;; count $$
16095 (setq dd-on (not dd-on)))
16096 (goto-char pos)
16097 (if dd-on (cons "$$" m))))))
16099 (defun org-inside-latex-macro-p ()
16100 "Is point inside a LaTeX macro or its arguments?"
16101 (save-match-data
16102 (org-in-regexp
16105 (defun org-try-cdlatex-tab ()
16106 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16107 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16108 - inside a LaTeX fragment, or
16109 - after the first word in a line, where an abbreviation expansion could
16110 insert a LaTeX environment."
16111 (when org-cdlatex-mode
16112 (cond
16113 ((save-excursion
16114 (skip-chars-backward "a-zA-Z0-9*")
16116 (bolp))
16117 (cdlatex-tab) t)
16118 ((org-inside-LaTeX-fragment-p)
16119 (cdlatex-tab) t)
16120 (t nil))))
16122 (defun org-cdlatex-underscore-caret (&optional arg)
16123 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16124 Revert to the normal definition outside of these fragments."
16125 (interactive "P")
16126 (if (org-inside-LaTeX-fragment-p)
16127 (call-interactively 'cdlatex-sub-superscript)
16128 (let (org-cdlatex-mode)
16129 (call-interactively (key-binding (vector last-input-event))))))
16131 (defun org-cdlatex-math-modify (&optional arg)
16132 "Execute `cdlatex-math-modify' in LaTeX fragments.
16133 Revert to the normal definition outside of these fragments."
16134 (interactive "P")
16135 (if (org-inside-LaTeX-fragment-p)
16136 (call-interactively 'cdlatex-math-modify)
16137 (let (org-cdlatex-mode)
16138 (call-interactively (key-binding (vector last-input-event))))))
16140 (defvar org-latex-fragment-image-overlays nil
16141 "List of overlays carrying the images of latex fragments.")
16142 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16144 (defun org-remove-latex-fragment-image-overlays ()
16145 "Remove all overlays with LaTeX fragment images in current buffer."
16146 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16147 (setq org-latex-fragment-image-overlays nil))
16149 (defun org-preview-latex-fragment (&optional subtree)
16150 "Preview the LaTeX fragment at point, or all locally or globally.
16151 If the cursor is in a LaTeX fragment, create the image and overlay
16152 it over the source code. If there is no fragment at point, display
16153 all fragments in the current text, from one headline to the next. With
16154 prefix SUBTREE, display all fragments in the current subtree. With a
16156 the cursor is before the first headline,
16157 display all fragments in the buffer.
16159 (interactive "P")
16160 (org-remove-latex-fragment-image-overlays)
16161 (save-excursion
16162 (save-restriction
16163 (let (beg end at msg)
16164 (cond
16165 ((or (equal subtree '(16))
16166 (not (save-excursion
16167 (re-search-backward (concat "^" outline-regexp) nil t))))
16168 (setq beg (point-min) end (point-max)
16169 msg "Creating images for buffer...%s"))
16170 ((equal subtree '(4))
16171 (org-back-to-heading)
16172 (setq beg (point) end (org-end-of-subtree t)
16173 msg "Creating images for subtree...%s"))
16174 (t
16175 (if (setq at (org-inside-LaTeX-fragment-p))
16176 (goto-char (max (point-min) (- (cdr at) 2)))
16177 (org-back-to-heading))
16178 (setq beg (point) end (progn (outline-next-heading) (point))
16179 msg (if at "Creating image...%s"
16180 "Creating images for entry...%s"))))
16181 (message msg "")
16182 (narrow-to-region beg end)
16183 (goto-char beg)
16184 (org-format-latex
16185 (concat "ltxpng/" (file-name-sans-extension
16186 (file-name-nondirectory
16187 buffer-file-name)))
16188 default-directory 'overlays msg at 'forbuffer 'dvipng)
16189 (message msg "done. Use `C-c C-c' to remove images.")))))
16191 (defvar org-latex-regexps
16193 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16196 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16200 "Regular expressions for matching embedded LaTeX.")
16202 (defvar org-export-have-math nil) ;; dynamic scoping
16203 (defun org-format-latex (prefix &optional dir overlays msg at
16204 forbuffer processing-type)
16205 "Replace LaTeX fragments with links to an image, and produce images.
16206 Some of the options can be changed using the variable
16207 `org-format-latex-options'."
16208 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16209 (let* ((prefixnodir (file-name-nondirectory prefix))
16210 (absprefix (expand-file-name prefix dir))
16211 (todir (file-name-directory absprefix))
16212 (opt org-format-latex-options)
16213 (matchers (plist-get opt :matchers))
16214 (re-list org-latex-regexps)
16215 (org-format-latex-header-extra
16216 (plist-get (org-infile-export-plist) :latex-header-extra))
16217 (cnt 0) txt hash link beg end re e checkdir
16218 executables-checked string
16219 m n block linkfile movefile ov)
16220 ;; Check the different regular expressions
16221 (while (setq e (pop re-list))
16222 (setq m (car e) re (nth 1 e) n (nth 2 e)
16224 (when (member m matchers)
16225 (goto-char (point-min))
16226 (while (re-search-forward re nil t)
16227 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16228 (not (get-text-property (match-beginning n)
16229 'org-protected))
16230 (or (not overlays)
16231 (not (eq (get-char-property (match-beginning n)
16232 'org-overlay-type)
16233 'org-latex-overlay))))
16234 (setq org-export-have-math t)
16235 (cond
16236 ((eq processing-type 'verbatim)
16237 ;; Leave the text verbatim, just protect it
16238 (add-text-properties (match-beginning n) (match-end n)
16239 '(org-protected t)))
16240 ((eq processing-type 'mathjax)
16241 ;; Prepare for MathJax processing
16242 (setq string (match-string n))
16243 (if (member m '("$" "$1"))
16244 (save-excursion
16245 (delete-region (match-beginning n) (match-end n))
16246 (goto-char (match-beginning n))
16249 '(org-protected t))))
16250 (add-text-properties (match-beginning n) (match-end n)
16251 '(org-protected t))))
16252 ((or (eq processing-type 'dvipng) t)
16253 ;; Process to an image
16254 (setq txt (match-string n)
16255 beg (match-beginning n) end (match-end n)
16256 cnt (1+ cnt))
16257 (let (print-length print-level) ; make sure full list is printed
16258 (setq hash (sha1 (prin1-to-string
16259 (list org-format-latex-header
16260 org-format-latex-header-extra
16261 org-export-latex-default-packages-alist
16262 org-export-latex-packages-alist
16263 org-format-latex-options
16264 forbuffer txt)))
16265 linkfile (format "%s_%s.png" prefix hash)
16266 movefile (format "%s_%s.png" absprefix hash)))
16267 (setq link (concat block "[[file:" linkfile "]]" block))
16268 (if msg (message msg cnt))
16269 (goto-char beg)
16270 (unless checkdir ; make sure the directory exists
16271 (setq checkdir t)
16272 (or (file-directory-p todir) (make-directory todir t)))
16274 (unless executables-checked
16275 (org-check-external-command
16276 "latex" "needed to convert LaTeX fragments to images")
16277 (org-check-external-command
16278 "dvipng" "needed to convert LaTeX fragments to images")
16279 (setq executables-checked t))
16281 (unless (file-exists-p movefile)
16282 (org-create-formula-image
16283 txt movefile opt forbuffer))
16284 (if overlays
16285 (progn
16286 (mapc (lambda (o)
16287 (if (eq (overlay-get o 'org-overlay-type)
16288 'org-latex-overlay)
16289 (delete-overlay o)))
16290 (overlays-in beg end))
16291 (setq ov (make-overlay beg end))
16292 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16293 (if (featurep 'xemacs)
16294 (progn
16295 (overlay-put ov 'invisible t)
16296 (overlay-put
16297 ov 'end-glyph
16298 (make-glyph (vector 'png :file movefile))))
16299 (overlay-put
16300 ov 'display
16301 (list 'image :type 'png :file movefile :ascent 'center)))
16302 (push ov org-latex-fragment-image-overlays)
16303 (goto-char end))
16304 (delete-region beg end)
16305 (insert (org-add-props link
16306 (list 'org-latex-src
16307 (replace-regexp-in-string
16310 ;; This function borrows from Ganesh Swami's latex2png.el
16311 (defun org-create-formula-image (string tofile options buffer)
16312 "This calls dvipng."
16313 (require 'org-latex)
16314 (let* ((tmpdir (if (featurep 'xemacs)
16315 (temp-directory)
16316 temporary-file-directory))
16317 (texfilebase (make-temp-name
16318 (expand-file-name "orgtex" tmpdir)))
16319 (texfile (concat texfilebase ".tex"))
16320 (dvifile (concat texfilebase ".dvi"))
16321 (pngfile (concat texfilebase ".png"))
16322 (fnh (if (featurep 'xemacs)
16323 (font-height (get-face-font 'default))
16324 (face-attribute 'default :height nil)))
16325 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16326 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16327 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16328 "Black"))
16329 (bg (or (plist-get options (if buffer :background :html-background))
16330 "Transparent")))
16331 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16332 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16333 (with-temp-file texfile
16334 (insert (org-splice-latex-header
16335 org-format-latex-header
16336 org-export-latex-default-packages-alist
16337 org-export-latex-packages-alist t
16338 org-format-latex-header-extra))
16340 (require 'org-latex)
16341 (org-export-latex-fix-inputenc))
16342 (let ((dir default-directory))
16343 (condition-case nil
16344 (progn
16345 (cd tmpdir)
16346 (call-process "latex" nil nil nil texfile))
16347 (error nil))
16348 (cd dir))
16349 (if (not (file-exists-p dvifile))
16350 (progn (message "Failed to create dvi file from %s" texfile) nil)
16351 (condition-case nil
16352 (call-process "dvipng" nil nil nil
16353 "-fg" fg "-bg" bg
16354 "-D" dpi
16355 ;;"-x" scale "-y" scale
16356 "-T" "tight"
16357 "-o" pngfile
16358 dvifile)
16359 (error nil))
16360 (if (not (file-exists-p pngfile))
16361 (if org-format-latex-signal-error
16362 (error "Failed to create png file from %s" texfile)
16363 (message "Failed to create png file from %s" texfile)
16364 nil)
16365 ;; Use the requested file name and clean up
16366 (copy-file pngfile tofile 'replace)
16367 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16368 (delete-file (concat texfilebase e)))
16369 pngfile))))
16371 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16372 "Fill a LaTeX header template TPL.
16373 In the template, the following place holders will be recognized:
16376 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16378 [NO-PACKAGES] do not include PKG
16379 [EXTRA] the string EXTRA
16380 [NO-EXTRA] do not include EXTRA
16382 For backward compatibility, if both the positive and the negative place
16384 assumed to be present at the end of the template.
16385 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16386 EXTRA is a string.
16387 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16388 (let (rpl (end ""))
16390 (setq rpl (if (or (match-end 1) (not def-pkg))
16391 "" (org-latex-packages-to-string def-pkg snippets-p t))
16392 tpl (replace-match rpl t t tpl))
16393 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16396 (setq rpl (if (or (match-end 1) (not pkg))
16397 "" (org-latex-packages-to-string pkg snippets-p t))
16398 tpl (replace-match rpl t t tpl))
16399 (if pkg (setq end
16401 (org-latex-packages-to-string pkg snippets-p)))))
16404 (setq rpl (if (or (match-end 1) (not extra))
16406 tpl (replace-match rpl t t tpl))
16412 tpl)))
16414 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16416 (setq pkg (mapconcat (lambda(p)
16417 (cond
16418 ((stringp p) p)
16419 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16420 (format "%% Package %s omitted" (cadr p)))
16421 ((equal "" (car p))
16423 (t
16425 (car p) (cadr p)))))
16426 pkg
16430 (defun org-dvipng-color (attr)
16431 "Return an rgb color specification for dvipng."
16432 (apply 'format "rgb %s %s %s"
16433 (mapcar 'org-normalize-color
16434 (color-values (face-attribute 'default attr nil)))))
16436 (defun org-normalize-color (value)
16437 "Return string to be used as color value for an RGB component."
16438 (format "%g" (/ value 65535.0)))
16440 ;; Image display
16443 (defvar org-inline-image-overlays nil)
16444 (make-variable-buffer-local 'org-inline-image-overlays)
16446 (defun org-toggle-inline-images (&optional include-linked)
16447 "Toggle the display of inline images.
16448 INCLUDE-LINKED is passed to `org-display-inline-images'."
16449 (interactive "P")
16450 (if org-inline-image-overlays
16451 (progn
16452 (org-remove-inline-images)
16453 (message "Inline image display turned off"))
16454 (org-display-inline-images include-linked)
16455 (if org-inline-image-overlays
16456 (message "%d images displayed inline"
16457 (length org-inline-image-overlays))
16458 (message "No images to display inline"))))
16460 (defun org-display-inline-images (&optional include-linked refresh beg end)
16461 "Display inline images.
16462 Normally only links without a description part are inlined, because this
16463 is how it will work for export. When INCLUDE-LINKED is set, also links
16464 with a description part will be inlined. This can be nice for a quick
16465 look at those images, but it does not reflect what exported files will look
16466 like.
16467 When REFRESH is set, refresh existing images between BEG and END.
16468 This will create new image displays only if necessary.
16469 BEG and END default to the buffer boundaries."
16470 (interactive "P")
16471 (unless refresh
16472 (org-remove-inline-images)
16473 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16474 (save-excursion
16475 (save-restriction
16476 (widen)
16477 (setq beg (or beg (point-min)) end (or end (point-max)))
16478 (goto-char (point-min))
16480 (substring (org-image-file-name-regexp) 0 -2)
16482 old file ov img)
16483 (while (re-search-forward re end t)
16484 (setq old (get-char-property-and-overlay (match-beginning 1)
16485 'org-image-overlay))
16486 (setq file (expand-file-name
16487 (concat (or (match-string 3) "") (match-string 4))))
16488 (when (file-exists-p file)
16489 (if (and (car-safe old) refresh)
16490 (image-refresh (overlay-get (cdr old) 'display))
16491 (setq img (save-match-data (create-image file)))
16492 (when img
16493 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16494 (overlay-put ov 'display img)
16495 (overlay-put ov 'face 'default)
16496 (overlay-put ov 'org-image-overlay t)
16497 (overlay-put ov 'modification-hooks
16498 (list 'org-display-inline-modification-hook))
16499 (push ov org-inline-image-overlays)))))))))
16501 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16502 "Remove inline-display overlay if a corresponding region is modified."
16503 (let ((inhibit-modification-hooks t))
16504 (when (and ov after)
16505 (delete ov org-inline-image-overlays)
16506 (delete-overlay ov))))
16508 (defun org-remove-inline-images ()
16509 "Remove inline display of images."
16510 (interactive)
16511 (mapc 'delete-overlay org-inline-image-overlays)
16512 (setq org-inline-image-overlays nil))
16514 ;;;; Key bindings
16516 ;; Make `C-c C-x' a prefix key
16517 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16519 ;; TAB key with modifiers
16520 (org-defkey org-mode-map "\C-i" 'org-cycle)
16521 (org-defkey org-mode-map [(tab)] 'org-cycle)
16522 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16523 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16525 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16526 ;; The following line is necessary under Suse GNU/Linux
16527 (unless (featurep 'xemacs)
16528 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16529 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16530 (define-key org-mode-map [backtab] 'org-shifttab)
16532 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16533 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16534 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16536 ;; Cursor keys with modifiers
16537 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16538 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16539 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16540 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16542 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16543 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16544 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16545 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16547 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16548 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16549 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16550 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16552 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16553 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16555 ;; Babel keys
16556 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16557 (mapc (lambda (pair)
16558 (define-key org-babel-map (car pair) (cdr pair)))
16559 org-babel-key-bindings)
16561 ;;; Extra keys for tty access.
16562 ;; We only set them when really needed because otherwise the
16563 ;; menus don't show the simple keys
16565 (when (or org-use-extra-keys
16566 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16567 (not window-system))
16568 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16569 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16570 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16571 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16572 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16573 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16574 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16575 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16576 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16577 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16578 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16579 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16580 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16581 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16582 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16583 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16584 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16585 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16586 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16587 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16588 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16589 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16590 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16591 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16592 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16593 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16594 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16595 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16597 ;; All the other keys
16599 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16600 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16601 (if (boundp 'narrow-map)
16602 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16603 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16604 (if (boundp 'narrow-map)
16605 (org-defkey narrow-map "b" 'org-narrow-to-block)
16606 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16607 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16608 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16609 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16610 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16611 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16612 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16613 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16614 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16615 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16616 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16617 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16618 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16619 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16620 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16621 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16622 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16624 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16625 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16626 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16627 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16628 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16629 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16630 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16631 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16632 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16633 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16634 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16635 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16636 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16637 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16638 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16639 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16640 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16641 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16642 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16644 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16645 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16646 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16647 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16648 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16649 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16650 (org-defkey org-mode-map "\C-c^" 'org-sort)
16651 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16652 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16653 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16654 (org-defkey org-mode-map "\C-m" 'org-return)
16655 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16656 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16657 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16658 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16659 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16660 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16661 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16662 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16663 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16664 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16665 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16666 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16667 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16668 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16669 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16670 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16671 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16672 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16673 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16674 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16675 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16676 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16678 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16679 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16680 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16681 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16683 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16684 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16685 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16686 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16687 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16688 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16689 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16690 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16691 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16692 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16694 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16695 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16696 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16697 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16698 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16699 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16700 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16702 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16703 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16704 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16705 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16706 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16708 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16710 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16712 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16713 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16715 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16718 (when (featurep 'xemacs)
16719 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16722 (defconst org-speed-commands-default
16723 '(
16724 ("Outline Navigation")
16725 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16726 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16727 ("f" . (org-speed-move-safe 'org-forward-same-level))
16728 ("b" . (org-speed-move-safe 'org-backward-same-level))
16729 ("u" . (org-speed-move-safe 'outline-up-heading))
16730 ("j" . org-goto)
16731 ("g" . (org-refile t))
16732 ("Outline Visibility")
16733 ("c" . org-cycle)
16734 ("C" . org-shifttab)
16735 (" " . org-display-outline-path)
16736 ("Outline Structure Editing")
16737 ("U" . org-shiftmetaup)
16738 ("D" . org-shiftmetadown)
16739 ("r" . org-metaright)
16740 ("l" . org-metaleft)
16741 ("R" . org-shiftmetaright)
16742 ("L" . org-shiftmetaleft)
16743 ("i" . (progn (forward-char 1) (call-interactively
16744 'org-insert-heading-respect-content)))
16745 ("^" . org-sort)
16746 ("w" . org-refile)
16747 ("a" . org-archive-subtree-default-with-confirmation)
16748 ("." . org-mark-subtree)
16749 ("Clock Commands")
16750 ("I" . org-clock-in)
16751 ("O" . org-clock-out)
16752 ("Meta Data Editing")
16753 ("t" . org-todo)
16754 ("0" . (org-priority ?\ ))
16755 ("1" . (org-priority ?A))
16756 ("2" . (org-priority ?B))
16757 ("3" . (org-priority ?C))
16758 (";" . org-set-tags-command)
16759 ("e" . org-set-effort)
16760 ("Agenda Views etc")
16761 ("v" . org-agenda)
16762 ("/" . org-sparse-tree)
16763 ("Misc")
16764 ("o" . org-open-at-point)
16765 ("?" . org-speed-command-help)
16766 ("<" . (org-agenda-set-restriction-lock 'subtree))
16767 (">" . (org-agenda-remove-restriction-lock))
16768 )
16769 "The default speed commands.")
16771 (defun org-print-speed-command (e)
16772 (if (> (length (car e)) 1)
16773 (progn
16775 (princ (car e))
16777 (princ (make-string (length (car e)) ?-))
16779 (princ (car e))
16780 (princ " ")
16781 (if (symbolp (cdr e))
16782 (princ (symbol-name (cdr e)))
16783 (prin1 (cdr e)))
16786 (defun org-speed-command-help ()
16787 "Show the available speed commands."
16788 (interactive)
16789 (if (not org-use-speed-commands)
16790 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16791 (with-output-to-temp-buffer "*Help*"
16793 (mapc 'org-print-speed-command org-speed-commands-user)
16796 (mapc 'org-print-speed-command org-speed-commands-default))
16797 (with-current-buffer "*Help*"
16798 (setq truncate-lines t))))
16800 (defun org-speed-move-safe (cmd)
16801 "Execute CMD, but make sure that the cursor always ends up in a headline.
16802 If not, return to the original position and throw an error."
16803 (interactive)
16804 (let ((pos (point)))
16805 (call-interactively cmd)
16806 (unless (and (bolp) (org-on-heading-p))
16807 (goto-char pos)
16808 (error "Boundary reached while executing %s" cmd))))
16810 (defvar org-self-insert-command-undo-counter 0)
16812 (defvar org-table-auto-blank-field) ; defined in org-table.el
16813 (defvar org-speed-command nil)
16815 (defun org-speed-command-default-hook (keys)
16816 "Hook for activating single-letter speed commands.
16817 `org-speed-commands-default' specifies a minimal command set. Use
16818 `org-speed-commands-user' for further customization."
16819 (when (or (and (bolp) (looking-at outline-regexp))
16820 (and (functionp org-use-speed-commands)
16821 (funcall org-use-speed-commands)))
16822 (cdr (assoc keys (append org-speed-commands-user
16823 org-speed-commands-default)))))
16825 (defun org-babel-speed-command-hook (keys)
16826 "Hook for activating single-letter code block commands."
16827 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16828 (cdr (assoc keys org-babel-key-bindings))))
16830 (defcustom org-speed-command-hook
16831 '(org-speed-command-default-hook org-babel-speed-command-hook)
16832 "Hook for activating speed commands at strategic locations.
16833 Hook functions are called in sequence until a valid handler is
16834 found.
16836 Each hook takes a single argument, a user-pressed command key
16837 which is also a `self-insert-command' from the global map.
16839 Within the hook, examine the cursor position and the command key
16840 and return nil or a valid handler as appropriate. Handler could
16841 be one of an interactive command, a function, or a form.
16843 Set `org-use-speed-commands' to non-nil value to enable this
16844 hook. The default setting is `org-speed-command-default-hook'."
16845 :group 'org-structure
16846 :type 'hook)
16848 (defun org-self-insert-command (N)
16849 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16850 If the cursor is in a table looking at whitespace, the whitespace is
16851 overwritten, and the table is not marked as requiring realignment."
16852 (interactive "p")
16853 (cond
16854 ((and org-use-speed-commands
16855 (setq org-speed-command
16856 (run-hook-with-args-until-success
16857 'org-speed-command-hook (this-command-keys))))
16858 (cond
16859 ((commandp org-speed-command)
16860 (setq this-command org-speed-command)
16861 (call-interactively org-speed-command))
16862 ((functionp org-speed-command)
16863 (funcall org-speed-command))
16864 ((and org-speed-command (listp org-speed-command))
16865 (eval org-speed-command))
16866 (t (let (org-use-speed-commands)
16867 (call-interactively 'org-self-insert-command)))))
16868 ((and
16869 (org-table-p)
16870 (progn
16871 ;; check if we blank the field, and if that triggers align
16872 (and (featurep 'org-table) org-table-auto-blank-field
16873 (member last-command
16874 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16876 ;; got extra space, this field does not determine column width
16877 (let (org-table-may-need-update) (org-table-blank-field))
16878 ;; no extra space, this field may determine column width
16879 (org-table-blank-field)))
16880 t)
16881 (eq N 1)
16883 (let (org-table-may-need-update)
16884 (goto-char (1- (match-end 0)))
16885 (delete-backward-char 1)
16886 (goto-char (match-beginning 0))
16887 (self-insert-command N)))
16888 (t
16889 (setq org-table-may-need-update t)
16890 (self-insert-command N)
16891 (org-fix-tags-on-the-fly)
16892 (if org-self-insert-cluster-for-undo
16893 (if (not (eq last-command 'org-self-insert-command))
16894 (setq org-self-insert-command-undo-counter 1)
16895 (if (>= org-self-insert-command-undo-counter 20)
16896 (setq org-self-insert-command-undo-counter 1)
16897 (and (> org-self-insert-command-undo-counter 0)
16898 buffer-undo-list
16899 (not (cadr buffer-undo-list)) ; remove nil entry
16900 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16901 (setq org-self-insert-command-undo-counter
16902 (1+ org-self-insert-command-undo-counter))))))))
16904 (defun org-fix-tags-on-the-fly ()
16905 (when (and (equal (char-after (point-at-bol)) ?*)
16906 (org-on-heading-p))
16907 (org-align-tags-here org-tags-column)))
16909 (defun org-delete-backward-char (N)
16910 "Like `delete-backward-char', insert whitespace at field end in tables.
16911 When deleting backwards, in tables this function will insert whitespace in
16913 still be marked for re-alignment if the field did fill the entire column,
16914 because, in this case the deletion might narrow the column."
16915 (interactive "p")
16916 (if (and (org-table-p)
16917 (eq N 1)
16918 (string-match "|" (buffer-substring (point-at-bol) (point)))
16919 (looking-at ".*?|"))
16920 (let ((pos (point))
16922 (c org-table-may-need-update))
16923 (backward-delete-char N)
16924 (if (not overwrite-mode)
16925 (progn
16926 (skip-chars-forward "^|")
16927 (insert " ")
16928 (goto-char (1- pos))))
16929 ;; noalign: if there were two spaces at the end, this field
16930 ;; does not determine the width of the column.
16931 (if noalign (setq org-table-may-need-update c)))
16932 (backward-delete-char N)
16933 (org-fix-tags-on-the-fly)))
16935 (defun org-delete-char (N)
16936 "Like `delete-char', but insert whitespace at field end in tables.
16937 When deleting characters, in tables this function will insert whitespace in
16939 still be marked for re-alignment if the field did fill the entire column,
16940 because, in this case the deletion might narrow the column."
16941 (interactive "p")
16942 (if (and (org-table-p)
16943 (not (bolp))
16944 (not (= (char-after) ?|))
16945 (eq N 1))
16946 (if (looking-at ".*?|")
16947 (let ((pos (point))
16949 (c org-table-may-need-update))
16950 (replace-match (concat
16951 (substring (match-string 0) 1 -1)
16952 " |"))
16953 (goto-char pos)
16954 ;; noalign: if there were two spaces at the end, this field
16955 ;; does not determine the width of the column.
16956 (if noalign (setq org-table-may-need-update c)))
16957 (delete-char N))
16958 (delete-char N)
16959 (org-fix-tags-on-the-fly)))
16961 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16962 (put 'org-self-insert-command 'delete-selection t)
16963 (put 'orgtbl-self-insert-command 'delete-selection t)
16964 (put 'org-delete-char 'delete-selection 'supersede)
16965 (put 'org-delete-backward-char 'delete-selection 'supersede)
16966 (put 'org-yank 'delete-selection 'yank)
16968 ;; Make `flyspell-mode' delay after some commands
16969 (put 'org-self-insert-command 'flyspell-delayed t)
16970 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16971 (put 'org-delete-char 'flyspell-delayed t)
16972 (put 'org-delete-backward-char 'flyspell-delayed t)
16974 ;; Make pabbrev-mode expand after org-mode commands
16975 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16976 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16978 ;; How to do this: Measure non-white length of current string
16979 ;; If equal to column width, we should realign.
16981 (defun org-remap (map &rest commands)
16982 "In MAP, remap the functions given in COMMANDS.
16983 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16984 (let (new old)
16985 (while commands
16986 (setq old (pop commands) new (pop commands))
16987 (if (fboundp 'command-remapping)
16988 (org-defkey map (vector 'remap old) new)
16989 (substitute-key-definition old new map global-map)))))
16991 (when (eq org-enable-table-editor 'optimized)
16992 ;; If the user wants maximum table support, we need to hijack
16993 ;; some standard editing functions
16994 (org-remap org-mode-map
16995 'self-insert-command 'org-self-insert-command
16996 'delete-char 'org-delete-char
16997 'delete-backward-char 'org-delete-backward-char)
16998 (org-defkey org-mode-map "|" 'org-force-self-insert))
17000 (defvar org-ctrl-c-ctrl-c-hook nil
17001 "Hook for functions attaching themselves to `C-c C-c'.
17002 This can be used to add additional functionality to the C-c C-c key which
17003 executes context-dependent commands.
17004 Each function will be called with no arguments. The function must check
17005 if the context is appropriate for it to act. If yes, it should do its
17006 thing and then return a non-nil value. If the context is wrong,
17007 just do nothing and return nil.")
17009 (defvar org-tab-first-hook nil
17010 "Hook for functions to attach themselves to TAB.
17011 See `org-ctrl-c-ctrl-c-hook' for more information.
17012 This hook runs as the first action when TAB is pressed, even before
17013 `org-cycle' messes around with the `outline-regexp' to cater for
17014 inline tasks and plain list item folding.
17015 If any function in this hook returns t, any other actions that
17016 would have been caused by TAB (such as table field motion or visibility
17017 cycling) will not occur.")
17019 (defvar org-tab-after-check-for-table-hook nil
17020 "Hook for functions to attach themselves to TAB.
17021 See `org-ctrl-c-ctrl-c-hook' for more information.
17022 This hook runs after it has been established that the cursor is not in a
17023 table, but before checking if the cursor is in a headline or if global cycling
17024 should be done.
17025 If any function in this hook returns t, not other actions like visibility
17026 cycling will be done.")
17028 (defvar org-tab-after-check-for-cycling-hook nil
17029 "Hook for functions to attach themselves to TAB.
17030 See `org-ctrl-c-ctrl-c-hook' for more information.
17031 This hook runs after it has been established that not table field motion and
17032 not visibility should be done because of current context. This is probably
17033 the place where a package like yasnippets can hook in.")
17035 (defvar org-tab-before-tab-emulation-hook nil
17036 "Hook for functions to attach themselves to TAB.
17037 See `org-ctrl-c-ctrl-c-hook' for more information.
17038 This hook runs after every other options for TAB have been exhausted, but
17041 (defvar org-metaleft-hook nil
17042 "Hook for functions attaching themselves to `M-left'.
17043 See `org-ctrl-c-ctrl-c-hook' for more information.")
17044 (defvar org-metaright-hook nil
17045 "Hook for functions attaching themselves to `M-right'.
17046 See `org-ctrl-c-ctrl-c-hook' for more information.")
17047 (defvar org-metaup-hook nil
17048 "Hook for functions attaching themselves to `M-up'.
17049 See `org-ctrl-c-ctrl-c-hook' for more information.")
17050 (defvar org-metadown-hook nil
17051 "Hook for functions attaching themselves to `M-down'.
17052 See `org-ctrl-c-ctrl-c-hook' for more information.")
17053 (defvar org-shiftmetaleft-hook nil
17054 "Hook for functions attaching themselves to `M-S-left'.
17055 See `org-ctrl-c-ctrl-c-hook' for more information.")
17056 (defvar org-shiftmetaright-hook nil
17057 "Hook for functions attaching themselves to `M-S-right'.
17058 See `org-ctrl-c-ctrl-c-hook' for more information.")
17059 (defvar org-shiftmetaup-hook nil
17060 "Hook for functions attaching themselves to `M-S-up'.
17061 See `org-ctrl-c-ctrl-c-hook' for more information.")
17062 (defvar org-shiftmetadown-hook nil
17063 "Hook for functions attaching themselves to `M-S-down'.
17064 See `org-ctrl-c-ctrl-c-hook' for more information.")
17065 (defvar org-metareturn-hook nil
17066 "Hook for functions attaching themselves to `M-RET'.
17067 See `org-ctrl-c-ctrl-c-hook' for more information.")
17068 (defvar org-shiftup-hook nil
17069 "Hook for functions attaching themselves to `S-up'.
17070 See `org-ctrl-c-ctrl-c-hook' for more information.")
17071 (defvar org-shiftup-final-hook nil
17072 "Hook for functions attaching themselves to `S-up'.
17073 This one runs after all other options except shift-select have been excluded.
17074 See `org-ctrl-c-ctrl-c-hook' for more information.")
17075 (defvar org-shiftdown-hook nil
17076 "Hook for functions attaching themselves to `S-down'.
17077 See `org-ctrl-c-ctrl-c-hook' for more information.")
17078 (defvar org-shiftdown-final-hook nil
17079 "Hook for functions attaching themselves to `S-down'.
17080 This one runs after all other options except shift-select have been excluded.
17081 See `org-ctrl-c-ctrl-c-hook' for more information.")
17082 (defvar org-shiftleft-hook nil
17083 "Hook for functions attaching themselves to `S-left'.
17084 See `org-ctrl-c-ctrl-c-hook' for more information.")
17085 (defvar org-shiftleft-final-hook nil
17086 "Hook for functions attaching themselves to `S-left'.
17087 This one runs after all other options except shift-select have been excluded.
17088 See `org-ctrl-c-ctrl-c-hook' for more information.")
17089 (defvar org-shiftright-hook nil
17090 "Hook for functions attaching themselves to `S-right'.
17091 See `org-ctrl-c-ctrl-c-hook' for more information.")
17092 (defvar org-shiftright-final-hook nil
17093 "Hook for functions attaching themselves to `S-right'.
17094 This one runs after all other options except shift-select have been excluded.
17095 See `org-ctrl-c-ctrl-c-hook' for more information.")
17097 (defun org-modifier-cursor-error ()
17098 "Throw an error, a modified cursor command was applied in wrong context."
17099 (error "This command is active in special context like tables, headlines or items"))
17101 (defun org-shiftselect-error ()
17102 "Throw an error because Shift-Cursor command was applied in wrong context."
17103 (if (and (boundp 'shift-select-mode) shift-select-mode)
17104 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17105 (error "This command works only in special context like headlines or timestamps")))
17107 (defun org-call-for-shift-select (cmd)
17108 (let ((this-command-keys-shift-translated t))
17109 (call-interactively cmd)))
17111 (defun org-shifttab (&optional arg)
17112 "Global visibility cycling or move to previous table field.
17113 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17114 on context.
17115 See the individual commands for more information."
17116 (interactive "P")
17117 (cond
17118 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17119 ((integerp arg)
17120 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17121 (message "Content view to level: %d" arg)
17122 (org-content (prefix-numeric-value arg2))
17123 (setq org-cycle-global-status 'overview)))
17124 (t (call-interactively 'org-global-cycle))))
17126 (defun org-shiftmetaleft ()
17127 "Promote subtree or delete table column.
17128 Calls `org-promote-subtree', `org-outdent-item',
17129 or `org-table-delete-column', depending on context.
17130 See the individual commands for more information."
17131 (interactive)
17132 (cond
17133 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17134 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17135 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17136 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17137 (t (org-modifier-cursor-error))))
17139 (defun org-shiftmetaright ()
17140 "Demote subtree or insert table column.
17141 Calls `org-demote-subtree', `org-indent-item',
17142 or `org-table-insert-column', depending on context.
17143 See the individual commands for more information."
17144 (interactive)
17145 (cond
17146 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17147 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17148 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17149 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17150 (t (org-modifier-cursor-error))))
17152 (defun org-shiftmetaup (&optional arg)
17153 "Move subtree up or kill table row.
17154 Calls `org-move-subtree-up' or `org-table-kill-row' or
17155 `org-move-item-up' depending on context. See the individual commands
17156 for more information."
17157 (interactive "P")
17158 (cond
17159 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17160 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17161 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17162 ((org-at-item-p) (call-interactively 'org-move-item-up))
17163 (t (org-modifier-cursor-error))))
17165 (defun org-shiftmetadown (&optional arg)
17166 "Move subtree down or insert table row.
17167 Calls `org-move-subtree-down' or `org-table-insert-row' or
17168 `org-move-item-down', depending on context. See the individual
17169 commands for more information."
17170 (interactive "P")
17171 (cond
17172 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17173 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17174 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17175 ((org-at-item-p) (call-interactively 'org-move-item-down))
17176 (t (org-modifier-cursor-error))))
17178 (defsubst org-hidden-tree-error ()
17179 (error
17180 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17182 (defun org-metaleft (&optional arg)
17183 "Promote heading or move table column to left.
17184 Calls `org-do-promote' or `org-table-move-column', depending on context.
17185 With no specific context, calls the Emacs default `backward-word'.
17186 See the individual commands for more information."
17187 (interactive "P")
17188 (cond
17189 ((run-hook-with-args-until-success 'org-metaleft-hook))
17190 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17191 ((org-with-limited-levels
17192 (or (org-on-heading-p)
17193 (and (org-region-active-p)
17194 (save-excursion
17195 (goto-char (region-beginning))
17196 (org-on-heading-p)))))
17197 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17198 (call-interactively 'org-do-promote))
17199 ;; At an inline task.
17200 ((org-on-heading-p)
17201 (call-interactively 'org-inlinetask-promote))
17202 ((or (org-at-item-p)
17203 (and (org-region-active-p)
17204 (save-excursion
17205 (goto-char (region-beginning))
17206 (org-at-item-p))))
17207 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17208 (call-interactively 'org-outdent-item))
17209 (t (call-interactively 'backward-word))))
17211 (defun org-metaright (&optional arg)
17212 "Demote subtree or move table column to right.
17213 Calls `org-do-demote' or `org-table-move-column', depending on context.
17214 With no specific context, calls the Emacs default `forward-word'.
17215 See the individual commands for more information."
17216 (interactive "P")
17217 (cond
17218 ((run-hook-with-args-until-success 'org-metaright-hook))
17219 ((org-at-table-p) (call-interactively 'org-table-move-column))
17220 ((org-with-limited-levels
17221 (or (org-on-heading-p)
17222 (and (org-region-active-p)
17223 (save-excursion
17224 (goto-char (region-beginning))
17225 (org-on-heading-p)))))
17226 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17227 (call-interactively 'org-do-demote))
17228 ;; At an inline task.
17229 ((org-on-heading-p)
17230 (call-interactively 'org-inlinetask-demote))
17231 ((or (org-at-item-p)
17232 (and (org-region-active-p)
17233 (save-excursion
17234 (goto-char (region-beginning))
17235 (org-at-item-p))))
17236 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17237 (call-interactively 'org-indent-item))
17238 (t (call-interactively 'forward-word))))
17240 (defun org-check-for-hidden (what)
17241 "Check if there are hidden headlines/items in the current visual line.
17242 WHAT can be either `headlines' or `items'. If the current line is
17243 an outline or item heading and it has a folded subtree below it,
17244 this function returns t, nil otherwise."
17245 (let ((re (cond
17246 ((eq what 'headlines) (concat "^" org-outline-regexp))
17247 ((eq what 'items) (org-item-beginning-re))
17248 (t (error "This should not happen"))))
17249 beg end)
17250 (save-excursion
17251 (catch 'exit
17252 (unless (org-region-active-p)
17253 (setq beg (point-at-bol))
17254 (beginning-of-line 2)
17255 (while (and (not (eobp)) ;; this is like `next-line'
17256 (get-char-property (1- (point)) 'invisible))
17257 (beginning-of-line 2))
17258 (setq end (point))
17259 (goto-char beg)
17260 (goto-char (point-at-eol))
17261 (setq end (max end (point)))
17262 (while (re-search-forward re end t)
17263 (if (get-char-property (match-beginning 0) 'invisible)
17264 (throw 'exit t))))
17265 nil))))
17267 (defun org-metaup (&optional arg)
17268 "Move subtree up or move table row up.
17269 Calls `org-move-subtree-up' or `org-table-move-row' or
17270 `org-move-item-up', depending on context. See the individual commands
17271 for more information."
17272 (interactive "P")
17273 (cond
17274 ((run-hook-with-args-until-success 'org-metaup-hook))
17275 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17276 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17277 ((org-at-item-p) (call-interactively 'org-move-item-up))
17278 (t (transpose-lines 1) (beginning-of-line -1))))
17280 (defun org-metadown (&optional arg)
17281 "Move subtree down or move table row down.
17282 Calls `org-move-subtree-down' or `org-table-move-row' or
17283 `org-move-item-down', depending on context. See the individual
17284 commands for more information."
17285 (interactive "P")
17286 (cond
17287 ((run-hook-with-args-until-success 'org-metadown-hook))
17288 ((org-at-table-p) (call-interactively 'org-table-move-row))
17289 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17290 ((org-at-item-p) (call-interactively 'org-move-item-down))
17291 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17293 (defun org-shiftup (&optional arg)
17294 "Increase item in timestamp or increase priority of current headline.
17295 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17296 depending on context. See the individual commands for more information."
17297 (interactive "P")
17298 (cond
17299 ((run-hook-with-args-until-success 'org-shiftup-hook))
17300 ((and org-support-shift-select (org-region-active-p))
17301 (org-call-for-shift-select 'previous-line))
17302 ((org-at-timestamp-p t)
17303 (call-interactively (if org-edit-timestamp-down-means-later
17304 'org-timestamp-down 'org-timestamp-up)))
17305 ((and (not (eq org-support-shift-select 'always))
17306 org-enable-priority-commands
17307 (org-on-heading-p))
17308 (call-interactively 'org-priority-up))
17309 ((and (not org-support-shift-select) (org-at-item-p))
17310 (call-interactively 'org-previous-item))
17311 ((org-clocktable-try-shift 'up arg))
17312 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17313 (org-support-shift-select
17314 (org-call-for-shift-select 'previous-line))
17315 (t (org-shiftselect-error))))
17317 (defun org-shiftdown (&optional arg)
17318 "Decrease item in timestamp or decrease priority of current headline.
17319 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17320 depending on context. See the individual commands for more information."
17321 (interactive "P")
17322 (cond
17323 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17324 ((and org-support-shift-select (org-region-active-p))
17325 (org-call-for-shift-select 'next-line))
17326 ((org-at-timestamp-p t)
17327 (call-interactively (if org-edit-timestamp-down-means-later
17328 'org-timestamp-up 'org-timestamp-down)))
17329 ((and (not (eq org-support-shift-select 'always))
17330 org-enable-priority-commands
17331 (org-on-heading-p))
17332 (call-interactively 'org-priority-down))
17333 ((and (not org-support-shift-select) (org-at-item-p))
17334 (call-interactively 'org-next-item))
17335 ((org-clocktable-try-shift 'down arg))
17336 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17337 (org-support-shift-select
17338 (org-call-for-shift-select 'next-line))
17339 (t (org-shiftselect-error))))
17341 (defun org-shiftright (&optional arg)
17342 "Cycle the thing at point or in the current line, depending on context.
17343 Depending on context, this does one of the following:
17345 - switch a timestamp at point one day into the future
17346 - on a headline, switch to the next TODO keyword.
17347 - on an item, switch entire list to the next bullet type
17348 - on a property line, switch to the next allowed value
17349 - on a clocktable definition line, move time block into the future"
17350 (interactive "P")
17351 (cond
17352 ((run-hook-with-args-until-success 'org-shiftright-hook))
17353 ((and org-support-shift-select (org-region-active-p))
17354 (org-call-for-shift-select 'forward-char))
17355 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17356 ((and (not (eq org-support-shift-select 'always))
17357 (org-on-heading-p))
17358 (let ((org-inhibit-logging
17359 (not org-treat-S-cursor-todo-selection-as-state-change))
17360 (org-inhibit-blocking
17361 (not org-treat-S-cursor-todo-selection-as-state-change)))
17362 (org-call-with-arg 'org-todo 'right)))
17363 ((or (and org-support-shift-select
17364 (not (eq org-support-shift-select 'always))
17365 (org-at-item-bullet-p))
17366 (and (not org-support-shift-select) (org-at-item-p)))
17367 (org-call-with-arg 'org-cycle-list-bullet nil))
17368 ((and (not (eq org-support-shift-select 'always))
17369 (org-at-property-p))
17370 (call-interactively 'org-property-next-allowed-value))
17371 ((org-clocktable-try-shift 'right arg))
17372 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17373 (org-support-shift-select
17374 (org-call-for-shift-select 'forward-char))
17375 (t (org-shiftselect-error))))
17377 (defun org-shiftleft (&optional arg)
17378 "Cycle the thing at point or in the current line, depending on context.
17379 Depending on context, this does one of the following:
17381 - switch a timestamp at point one day into the past
17382 - on a headline, switch to the previous TODO keyword.
17383 - on an item, switch entire list to the previous bullet type
17384 - on a property line, switch to the previous allowed value
17385 - on a clocktable definition line, move time block into the past"
17386 (interactive "P")
17387 (cond
17388 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17389 ((and org-support-shift-select (org-region-active-p))
17390 (org-call-for-shift-select 'backward-char))
17391 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17392 ((and (not (eq org-support-shift-select 'always))
17393 (org-on-heading-p))
17394 (let ((org-inhibit-logging
17395 (not org-treat-S-cursor-todo-selection-as-state-change))
17396 (org-inhibit-blocking
17397 (not org-treat-S-cursor-todo-selection-as-state-change)))
17398 (org-call-with-arg 'org-todo 'left)))
17399 ((or (and org-support-shift-select
17400 (not (eq org-support-shift-select 'always))
17401 (org-at-item-bullet-p))
17402 (and (not org-support-shift-select) (org-at-item-p)))
17403 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17404 ((and (not (eq org-support-shift-select 'always))
17405 (org-at-property-p))
17406 (call-interactively 'org-property-previous-allowed-value))
17407 ((org-clocktable-try-shift 'left arg))
17408 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17409 (org-support-shift-select
17410 (org-call-for-shift-select 'backward-char))
17411 (t (org-shiftselect-error))))
17413 (defun org-shiftcontrolright ()
17414 "Switch to next TODO set."
17415 (interactive)
17416 (cond
17417 ((and org-support-shift-select (org-region-active-p))
17418 (org-call-for-shift-select 'forward-word))
17419 ((and (not (eq org-support-shift-select 'always))
17420 (org-on-heading-p))
17421 (org-call-with-arg 'org-todo 'nextset))
17422 (org-support-shift-select
17423 (org-call-for-shift-select 'forward-word))
17424 (t (org-shiftselect-error))))
17426 (defun org-shiftcontrolleft ()
17427 "Switch to previous TODO set."
17428 (interactive)
17429 (cond
17430 ((and org-support-shift-select (org-region-active-p))
17431 (org-call-for-shift-select 'backward-word))
17432 ((and (not (eq org-support-shift-select 'always))
17433 (org-on-heading-p))
17434 (org-call-with-arg 'org-todo 'previousset))
17435 (org-support-shift-select
17436 (org-call-for-shift-select 'backward-word))
17437 (t (org-shiftselect-error))))
17439 (defun org-ctrl-c-ret ()
17440 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17441 (interactive)
17442 (cond
17443 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17444 (t (call-interactively 'org-insert-heading))))
17446 (defun org-copy-special ()
17447 "Copy region in table or copy current subtree.
17448 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17449 See the individual commands for more information."
17450 (interactive)
17451 (call-interactively
17452 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17454 (defun org-cut-special ()
17455 "Cut region in table or cut current subtree.
17456 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17457 See the individual commands for more information."
17458 (interactive)
17459 (call-interactively
17460 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17462 (defun org-paste-special (arg)
17463 "Paste rectangular region into table, or past subtree relative to level.
17464 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17465 See the individual commands for more information."
17466 (interactive "P")
17467 (if (org-at-table-p)
17468 (org-table-paste-rectangle)
17469 (org-paste-subtree arg)))
17471 (defun org-edit-special (&optional arg)
17472 "Call a special editor for the stuff at point.
17473 When at a table, call the formula editor with `org-table-edit-formulas'.
17474 When at the first line of an src example, call `org-edit-src-code'.
17475 When in an #+include line, visit the include file. Otherwise call
17476 `ffap' to visit the file at point."
17477 (interactive)
17478 ;; possibly prep session before editing source
17479 (when arg
17480 (let* ((info (org-babel-get-src-block-info))
17481 (lang (nth 0 info))
17482 (params (nth 2 info))
17483 (session (cdr (assoc :session params))))
17484 (when (and info session) ;; we are in a source-code block with a session
17485 (funcall
17486 (intern (concat "org-babel-prep-session:" lang)) session params))))
17487 (cond ;; proceed with `org-edit-special'
17488 ((save-excursion
17489 (beginning-of-line 1)
17490 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17491 (find-file (org-trim (match-string 1))))
17492 ((org-edit-src-code))
17493 ((org-edit-fixed-width-region))
17494 ((org-at-table.el-p)
17495 (org-edit-src-code))
17496 ((or (org-at-table-p)
17497 (save-excursion
17498 (beginning-of-line 1)
17500 (call-interactively 'org-table-edit-formulas))
17501 (t (call-interactively 'ffap))))
17503 (defun org-ctrl-c-ctrl-c (&optional arg)
17504 "Set tags in headline, or update according to changed information at point.
17506 This command does many different things, depending on context:
17508 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17509 this is what we do.
17511 - If the cursor is on a statistics cookie, update it.
17513 - If the cursor is in a headline, prompt for tags and insert them
17514 into the current line, aligned to `org-tags-column'. When called
17515 with prefix arg, realign all tags in the current buffer.
17517 - If the cursor is in one of the special #+KEYWORD lines, this
17518 triggers scanning the buffer for these lines and updating the
17519 information.
17521 - If the cursor is inside a table, realign the table. This command
17522 works even if the automatic table editor has been turned off.
17524 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17525 the entire table.
17527 - If the cursor is at a footnote reference or definition, jump to
17528 the corresponding definition or references, respectively.
17530 - If the cursor is a the beginning of a dynamic block, update it.
17532 - If the current buffer is a capture buffer, close note and file it.
17534 - If the cursor is on a <<<target>>>, update radio targets and
17535 corresponding links in this buffer.
17537 - If the cursor is on a numbered item in a plain list, renumber the
17538 ordered list.
17540 - If the cursor is on a checkbox, toggle it.
17542 - If the cursor is on a code block, evaluate it. The variable
17543 `org-confirm-babel-evaluate' can be used to control prompting
17544 before code block evaluation, by default every code block
17545 evaluation requires confirmation. Code block evaluation can be
17546 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17547 (interactive "P")
17548 (let ((org-enable-table-editor t))
17549 (cond
17550 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17551 org-occur-highlights
17552 org-latex-fragment-image-overlays)
17553 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17554 (org-remove-occur-highlights)
17555 (org-remove-latex-fragment-image-overlays)
17556 (message "Temporary highlights/overlays removed from current buffer"))
17557 ((and (local-variable-p 'org-finish-function (current-buffer))
17558 (fboundp org-finish-function))
17559 (funcall org-finish-function))
17560 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17561 ((or (looking-at org-property-start-re)
17562 (org-at-property-p))
17563 (call-interactively 'org-property-action))
17564 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17566 (or (org-on-heading-p) (org-at-item-p)))
17567 (call-interactively 'org-update-statistics-cookies))
17568 ((org-on-heading-p) (call-interactively 'org-set-tags))
17569 ((org-at-table.el-p)
17570 (message "Use C-c ' to edit table.el tables"))
17571 ((org-at-table-p)
17572 (org-table-maybe-eval-formula)
17573 (if arg
17574 (call-interactively 'org-table-recalculate)
17575 (org-table-maybe-recalculate-line))
17576 (call-interactively 'org-table-align)
17577 (orgtbl-send-table 'maybe))
17578 ((or (org-footnote-at-reference-p)
17579 (org-footnote-at-definition-p))
17580 (call-interactively 'org-footnote-action))
17581 ((org-at-item-checkbox-p)
17582 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17583 ;; list only if at top item.
17584 (let* ((cbox (match-string 1))
17585 (struct (org-list-struct))
17586 (old-struct (copy-tree struct))
17587 (parents (org-list-parents-alist struct))
17588 (prevs (org-list-prevs-alist struct))
17589 (orderedp (org-entry-get nil "ORDERED"))
17590 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17591 block-item)
17592 ;; Use a light version of `org-toggle-checkbox' to avoid
17593 ;; computing list structure twice.
17594 (org-list-set-checkbox (point-at-bol) struct
17595 (cond
17596 ((equal arg '(16)) "[-]")
17597 ((equal arg '(4)) nil)
17598 ((equal "[X]" cbox) "[ ]")
17599 (t "[X]")))
17600 (org-list-struct-fix-ind struct parents)
17601 (org-list-struct-fix-bul struct prevs)
17602 (setq block-item
17603 (org-list-struct-fix-box struct parents prevs orderedp))
17604 (when block-item
17605 (message
17606 "Checkboxes were removed due to unchecked box at line %d"
17607 (org-current-line block-item)))
17608 (org-list-struct-apply-struct struct old-struct)
17609 (org-update-checkbox-count-maybe)
17610 (when firstp (org-list-send-list 'maybe))))
17611 ((org-at-item-p)
17612 ;; Cursor at an item: repair list. Do checkbox related actions
17613 ;; only if function was called with an argument. Send list only
17614 ;; if at top item.
17615 (let* ((struct (org-list-struct))
17616 (old-struct (copy-tree struct))
17617 (parents (org-list-parents-alist struct))
17618 (prevs (org-list-prevs-alist struct))
17619 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17620 (org-list-struct-fix-ind struct parents)
17621 (org-list-struct-fix-bul struct prevs)
17622 (when arg
17623 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17624 (org-list-struct-fix-box struct parents prevs))
17625 (org-list-struct-apply-struct struct old-struct)
17626 (when arg (org-update-checkbox-count-maybe))
17627 (when firstp (org-list-send-list 'maybe))))
17628 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17629 ;; Dynamic block
17630 (beginning-of-line 1)
17631 (save-excursion (org-update-dblock)))
17632 ((save-excursion
17633 (beginning-of-line 1)
17635 (cond
17636 ((equal (match-string 1) "TBLFM")
17637 ;; Recalculate the table before this line
17638 (save-excursion
17639 (beginning-of-line 1)
17641 (if (org-at-table-p)
17642 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17643 (t
17644 (let ((org-inhibit-startup-visibility-stuff t)
17645 (org-startup-align-all-tables nil))
17646 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17647 (message "Local setup has been refreshed"))))
17648 ((org-clock-update-time-maybe))
17649 (t (error "C-c C-c can do nothing useful at this location")))))
17651 (defun org-mode-restart ()
17652 "Restart Org-mode, to scan again for special lines.
17653 Also updates the keyword regular expressions."
17654 (interactive)
17655 (org-mode)
17656 (message "Org-mode restarted"))
17658 (defun org-kill-note-or-show-branches ()
17659 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17660 (interactive)
17661 (if (not org-finish-function)
17662 (progn
17663 (hide-subtree)
17664 (call-interactively 'show-branches))
17665 (let ((org-note-abort t))
17666 (funcall org-finish-function))))
17668 (defun org-return (&optional indent)
17669 "Goto next table row or insert a newline.
17670 Calls `org-table-next-row' or `newline', depending on context.
17671 See the individual commands for more information."
17672 (interactive)
17673 (cond
17674 ((bobp) (if indent (newline-and-indent) (newline)))
17675 ((org-at-table-p)
17676 (org-table-justify-field-maybe)
17677 (call-interactively 'org-table-next-row))
17678 ;; when `newline-and-indent' is called within a list, make sure
17679 ;; text moved stays inside the item.
17680 ((and (org-in-item-p) indent)
17681 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17682 (progn
17683 (newline)
17684 (org-indent-line-to (length (match-string 0))))
17685 (let ((ind (org-get-indentation)))
17686 (newline)
17687 (if (org-looking-back org-list-end-re)
17688 (org-indent-line-function)
17689 (org-indent-line-to ind)))))
17690 ((and org-return-follows-link
17691 (eq (get-text-property (point) 'face) 'org-link))
17692 (call-interactively 'org-open-at-point))
17693 ((and (org-at-heading-p)
17694 (looking-at
17696 (org-show-entry)
17697 (end-of-line 1)
17698 (newline))
17699 (t (if indent (newline-and-indent) (newline)))))
17701 (defun org-return-indent ()
17702 "Goto next table row or insert a newline and indent.
17703 Calls `org-table-next-row' or `newline-and-indent', depending on
17704 context. See the individual commands for more information."
17705 (interactive)
17706 (org-return t))
17708 (defun org-ctrl-c-star ()
17709 "Compute table, or change heading status of lines.
17710 Calls `org-table-recalculate' or `org-toggle-heading',
17711 depending on context."
17712 (interactive)
17713 (cond
17714 ((org-at-table-p)
17715 (call-interactively 'org-table-recalculate))
17716 (t
17717 ;; Convert all lines in region to list items
17718 (call-interactively 'org-toggle-heading))))
17720 (defun org-ctrl-c-minus ()
17721 "Insert separator line in table or modify bullet status of line.
17722 Also turns a plain line or a region of lines into list items.
17723 Calls `org-table-insert-hline', `org-toggle-item', or
17724 `org-cycle-list-bullet', depending on context."
17725 (interactive)
17726 (cond
17727 ((org-at-table-p)
17728 (call-interactively 'org-table-insert-hline))
17729 ((org-region-active-p)
17730 (call-interactively 'org-toggle-item))
17731 ((org-in-item-p)
17732 (call-interactively 'org-cycle-list-bullet))
17733 (t
17734 (call-interactively 'org-toggle-item))))
17736 (defun org-toggle-item (arg)
17737 "Convert headings or normal lines to items, items to normal lines.
17738 If there is no active region, only the current line is considered.
17740 If the first non blank line in the region is an headline, convert
17741 all headlines to items.
17743 If it is an item, convert all items to normal lines.
17745 If it is normal text, change region into an item. With a prefix
17746 argument ARG, change each line in region into an item."
17747 (interactive "P")
17748 (let (l2 l beg end)
17749 (if (org-region-active-p)
17750 (setq beg (region-beginning) end (region-end))
17751 (setq beg (point-at-bol)
17752 end (min (1+ (point-at-eol)) (point-max))))
17753 (org-with-limited-levels
17754 (save-excursion
17755 (goto-char end)
17756 (setq l2 (org-current-line))
17757 (goto-char beg)
17758 (beginning-of-line 1)
17759 ;; Ignore blank lines at beginning of region
17761 (beginning-of-line 1)
17762 (setq l (1- (org-current-line)))
17763 (cond
17764 ;; Case 1. Start at an item: de-itemize.
17765 ((org-at-item-p)
17766 (while (< (setq l (1+ l)) l2)
17767 (when (org-at-item-p)
17769 (delete-region (point) (match-end 0)))
17770 (beginning-of-line 2)))
17771 ;; Case 2. Start an an heading: convert to items.
17772 ((org-on-heading-p)
17773 (let* ((bul (org-list-bullet-string "-"))
17774 (len (length bul))
17775 (ind 0) (level 0))
17776 (while (< (setq l (1+ l)) l2)
17777 (cond
17778 ((looking-at outline-regexp)
17779 (let* ((lvl (org-reduced-level
17780 (- (length (match-string 0)) 2)))
17781 (s (concat (make-string (* len lvl) ? ) bul)))
17782 (replace-match s t t)
17783 (setq ind (length s) level lvl)))
17784 ;; Ignore blank lines and inline tasks.
17787 ;; Ensure normal text belongs to the new item.
17788 (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
17789 ind))))
17790 (beginning-of-line 2))))
17791 ;; Case 3. Normal line with ARG: turn each of them into items
17792 ;; unless they are already one.
17793 (arg
17794 (while (< (setq l (1+ l)) l2)
17795 (unless (or (org-on-heading-p) (org-at-item-p))
17797 (replace-match
17799 (beginning-of-line 2)))
17800 ;; Case 4. Normal line without ARG: make the first line of
17801 ;; region an item, and shift indentation of others
17802 ;; lines to set them as item's body.
17803 (t (let* ((bul (org-list-bullet-string "-"))
17804 (bul-len (length bul))
17805 (ref-ind (org-get-indentation)))
17807 (insert bul)
17808 (beginning-of-line 2)
17809 (while (and (< (setq l (1+ l)) l2) (< (point) end))
17810 ;; Ensure that lines less indented than first one
17811 ;; still get included in item body.
17812 (org-indent-line-to (+ (max ref-ind (org-get-indentation))
17813 bul-len))
17814 (beginning-of-line 2)))))))))
17816 (defun org-toggle-heading (&optional nstars)
17817 "Convert headings to normal text, or items or text to headings.
17818 If there is no active region, only the current line is considered.
17820 If the first non blank line is an headline, remove the stars from
17821 all headlines in the region.
17823 If it is a plain list item, turn all plain list items into headings.
17825 If it is a normal line, turn each and every normal line (i.e. not
17826 an heading or an item) in the region into a heading.
17828 When converting a line into a heading, the number of stars is chosen
17829 such that the lines become children of the current entry. However,
17830 when a prefix argument is given, its value determines the number of
17831 stars to add."
17832 (interactive "P")
17833 (let (l2 l itemp beg end)
17834 (if (org-region-active-p)
17835 (setq beg (region-beginning) end (copy-marker (region-end)))
17836 (setq beg (point-at-bol)
17837 end (min (1+ (point-at-eol)) (point-max))))
17838 ;; Ensure inline tasks don't count as headings.
17839 (org-with-limited-levels
17840 (save-excursion
17841 (goto-char end)
17842 (setq l2 (org-current-line))
17843 (goto-char beg)
17844 (beginning-of-line 1)
17845 ;; Ignore blank lines at beginning of region
17847 (beginning-of-line 1)
17848 (setq l (1- (org-current-line)))
17849 (cond
17850 ;; Case 1. Started at an heading: de-star headings.
17851 ((org-on-heading-p)
17852 (while (< (setq l (1+ l)) l2)
17853 (when (org-on-heading-p t)
17854 (looking-at outline-regexp) (replace-match ""))
17855 (beginning-of-line 2)))
17856 ;; Case 2. Started at an item: change items into headlines.
17857 ((org-at-item-p)
17858 (let ((stars (make-string
17859 (if nstars
17860 (prefix-numeric-value current-prefix-arg)
17861 (or (org-current-level) 0))
17862 ?*)))
17863 (while (< (point) end)
17864 (when (org-at-item-p)
17865 ;; Pay attention to cases when region ends before list.
17866 (let* ((struct (org-list-struct))
17867 (list-end (min (org-list-get-bottom-point struct) end)))
17868 (save-restriction
17869 (narrow-to-region (point) list-end)
17870 (insert
17871 (org-list-to-subtree
17872 (org-list-parse-list t)
17873 '(:istart (concat stars (funcall get-stars depth))
17874 :icount (concat stars
17875 (funcall get-stars depth))))))))
17876 (beginning-of-line 2))))
17877 ;; Case 3. Started at normal text: make every line an heading,
17878 ;; skipping headlines and items.
17879 (t (let* ((stars (make-string
17880 (if nstars
17881 (prefix-numeric-value current-prefix-arg)
17882 (or (org-current-level) 0))
17883 ?*))
17884 (add-stars (cond (nstars "")
17885 ((equal stars "") "*")
17886 (org-odd-levels-only "**")
17887 (t "*")))
17888 (rpl (concat stars add-stars " ")))
17889 (while (< (setq l (1+ l)) l2)
17890 (unless (or (org-on-heading-p) (org-at-item-p))
17892 (replace-match (concat rpl (match-string 2)))))
17893 (beginning-of-line 2)))))))))
17895 (defun org-meta-return (&optional arg)
17896 "Insert a new heading or wrap a region in a table.
17897 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17898 See the individual commands for more information."
17899 (interactive "P")
17900 (cond
17901 ((run-hook-with-args-until-success 'org-metareturn-hook))
17902 ((org-at-table-p)
17903 (call-interactively 'org-table-wrap-region))
17904 (t (call-interactively 'org-insert-heading))))
17906 ;;; Menu entries
17908 ;; Define the Org-mode menus
17909 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17910 '("Tbl"
17911 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17912 ["Next Field" org-cycle (org-at-table-p)]
17913 ["Previous Field" org-shifttab (org-at-table-p)]
17914 ["Next Row" org-return (org-at-table-p)]
17915 "--"
17916 ["Blank Field" org-table-blank-field (org-at-table-p)]
17917 ["Edit Field" org-table-edit-field (org-at-table-p)]
17918 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17919 "--"
17920 ("Column"
17921 ["Move Column Left" org-metaleft (org-at-table-p)]
17922 ["Move Column Right" org-metaright (org-at-table-p)]
17923 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17924 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17925 ("Row"
17926 ["Move Row Up" org-metaup (org-at-table-p)]
17927 ["Move Row Down" org-metadown (org-at-table-p)]
17928 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17929 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17930 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17931 "--"
17932 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17933 ("Rectangle"
17934 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17935 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17936 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17937 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17938 "--"
17939 ("Calculate"
17940 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17941 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17942 ["Edit Formulas" org-edit-special (org-at-table-p)]
17943 "--"
17944 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17945 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17946 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17947 "--"
17948 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17949 "--"
17950 ["Sum Column/Rectangle" org-table-sum
17951 (or (org-at-table-p) (org-region-active-p))]
17952 ["Which Column?" org-table-current-column (org-at-table-p)])
17953 ["Debug Formulas"
17954 org-table-toggle-formula-debugger
17955 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17956 ["Show Col/Row Numbers"
17957 org-table-toggle-coordinate-overlays
17958 :style toggle
17959 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17960 "--"
17961 ["Create" org-table-create (and (not (org-at-table-p))
17962 org-enable-table-editor)]
17963 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17964 ["Import from File" org-table-import (not (org-at-table-p))]
17965 ["Export to File" org-table-export (org-at-table-p)]
17966 "--"
17967 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17969 (easy-menu-define org-org-menu org-mode-map "Org menu"
17970 '("Org"
17971 ("Show/Hide"
17972 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17973 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17974 ["Sparse Tree..." org-sparse-tree t]
17975 ["Reveal Context" org-reveal t]
17976 ["Show All" show-all t]
17977 "--"
17978 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17979 "--"
17980 ["New Heading" org-insert-heading t]
17981 ("Navigate Headings"
17982 ["Up" outline-up-heading t]
17983 ["Next" outline-next-visible-heading t]
17984 ["Previous" outline-previous-visible-heading t]
17985 ["Next Same Level" outline-forward-same-level t]
17986 ["Previous Same Level" outline-backward-same-level t]
17987 "--"
17988 ["Jump" org-goto t])
17989 ("Edit Structure"
17990 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17991 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17992 "--"
17993 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17994 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17995 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17996 "--"
17997 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17998 "--"
17999 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18000 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18001 ["Demote Heading" org-metaright (not (org-at-table-p))]
18002 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18003 "--"
18004 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18005 "--"
18006 ["Convert to odd levels" org-convert-to-odd-levels t]
18007 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18008 ("Editing"
18009 ["Emphasis..." org-emphasize t]
18010 ["Edit Source Example" org-edit-special t]
18011 "--"
18012 ["Footnote new/jump" org-footnote-action t]
18013 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18014 ("Archive"
18015 ["Archive (default method)" org-archive-subtree-default t]
18016 "--"
18017 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18018 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18019 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18020 )
18021 "--"
18022 ("Hyperlinks"
18023 ["Store Link (Global)" org-store-link t]
18024 ["Find existing link to here" org-occur-link-in-agenda-files t]
18025 ["Insert Link" org-insert-link t]
18026 ["Follow Link" org-open-at-point t]
18027 "--"
18028 ["Next link" org-next-link t]
18029 ["Previous link" org-previous-link t]
18030 "--"
18031 ["Descriptive Links"
18032 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18033 :style radio
18034 :selected (member '(org-link) buffer-invisibility-spec)]
18035 ["Literal Links"
18036 (progn
18037 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18038 :style radio
18039 :selected (not (member '(org-link) buffer-invisibility-spec))])
18040 "--"
18041 ("TODO Lists"
18042 ["TODO/DONE/-" org-todo t]
18043 ("Select keyword"
18044 ["Next keyword" org-shiftright (org-on-heading-p)]
18045 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18046 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18047 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18048 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18049 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18050 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18051 "--"
18052 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18053 :selected org-enforce-todo-dependencies :style toggle :active t]
18054 "Settings for tree at point"
18055 ["Do Children sequentially" org-toggle-ordered-property :style radio
18056 :selected (org-entry-get nil "ORDERED")
18057 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18058 ["Do Children parallel" org-toggle-ordered-property :style radio
18059 :selected (not (org-entry-get nil "ORDERED"))
18060 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18061 "--"
18062 ["Set Priority" org-priority t]
18063 ["Priority Up" org-shiftup t]
18064 ["Priority Down" org-shiftdown t]
18065 "--"
18066 ["Get news from all feeds" org-feed-update-all t]
18067 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18068 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18069 ("TAGS and Properties"
18070 ["Set Tags" org-set-tags-command t]
18071 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18072 "--"
18073 ["Set property" org-set-property t]
18074 ["Column view of properties" org-columns t]
18075 ["Insert Column View DBlock" org-insert-columns-dblock t])
18076 ("Dates and Scheduling"
18077 ["Timestamp" org-time-stamp t]
18078 ["Timestamp (inactive)" org-time-stamp-inactive t]
18079 ("Change Date"
18080 ["1 Day Later" org-shiftright t]
18081 ["1 Day Earlier" org-shiftleft t]
18082 ["1 ... Later" org-shiftup t]
18083 ["1 ... Earlier" org-shiftdown t])
18084 ["Compute Time Range" org-evaluate-time-range t]
18085 ["Schedule Item" org-schedule t]
18086 ["Deadline" org-deadline t]
18087 "--"
18088 ["Custom time format" org-toggle-time-stamp-overlays
18089 :style radio :selected org-display-custom-times]
18090 "--"
18091 ["Goto Calendar" org-goto-calendar t]
18092 ["Date from Calendar" org-date-from-calendar t]
18093 "--"
18094 ["Start/Restart Timer" org-timer-start t]
18095 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18096 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18097 ["Insert Timer String" org-timer t]
18098 ["Insert Timer Item" org-timer-item t])
18099 ("Logging work"
18100 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18101 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18102 ["Clock out" org-clock-out t]
18103 ["Clock cancel" org-clock-cancel t]
18104 "--"
18105 ["Mark as default task" org-clock-mark-default-task t]
18106 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18107 ["Goto running clock" org-clock-goto t]
18108 "--"
18109 ["Display times" org-clock-display t]
18110 ["Create clock table" org-clock-report t]
18111 "--"
18112 ["Record DONE time"
18113 (progn (setq org-log-done (not org-log-done))
18114 (message "Switching to %s will %s record a timestamp"
18115 (car org-done-keywords)
18116 (if org-log-done "automatically" "not")))
18117 :style toggle :selected org-log-done])
18118 "--"
18119 ["Agenda Command..." org-agenda t]
18120 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18121 ("File List for Agenda")
18122 ("Special views current file"
18123 ["TODO Tree" org-show-todo-tree t]
18124 ["Check Deadlines" org-check-deadlines t]
18125 ["Timeline" org-timeline t]
18126 ["Tags/Property tree" org-match-sparse-tree t])
18127 "--"
18128 ["Export/Publish..." org-export t]
18129 ("LaTeX"
18130 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18131 :selected org-cdlatex-mode]
18132 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18133 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18134 ["Modify math symbol" org-cdlatex-math-modify
18135 (org-inside-LaTeX-fragment-p)]
18136 ["Insert citation" org-reftex-citation t]
18137 "--"
18138 ["Template for BEAMER" org-insert-beamer-options-template t])
18139 "--"
18140 ("MobileOrg"
18141 ["Push Files and Views" org-mobile-push t]
18142 ["Get Captured and Flagged" org-mobile-pull t]
18143 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18144 "--"
18145 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18146 "--"
18147 ("Documentation"
18148 ["Show Version" org-version t]
18149 ["Info Documentation" org-info t])
18150 ("Customize"
18151 ["Browse Org Group" org-customize t]
18152 "--"
18153 ["Expand This Menu" org-create-customize-menu
18154 (fboundp 'customize-menu-create)])
18155 ["Send bug report" org-submit-bug-report t]
18156 "--"
18157 ("Refresh/Reload"
18158 ["Refresh setup current buffer" org-mode-restart t]
18159 ["Reload Org (after update)" org-reload t]
18160 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18161 ))
18163 (defun org-info (&optional node)
18164 "Read documentation for Org-mode in the info system.
18165 With optional NODE, go directly to that node."
18166 (interactive)
18167 (info (format "(org)%s" (or node ""))))
18169 ;;;###autoload
18170 (defun org-submit-bug-report ()
18171 "Submit a bug report on Org-mode via mail.
18173 Don't hesitate to report any problems or inaccurate documentation.
18175 If you don't have setup sending mail from (X)Emacs, please copy the
18176 output buffer into your mail program, as it gives us important
18177 information about your Org-mode version and configuration."
18178 (interactive)
18179 (require 'reporter)
18180 (org-load-modules-maybe)
18181 (org-require-autoloaded-modules)
18182 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18183 (reporter-submit-bug-report
18184 "emacs-orgmode@gnu.org"
18185 (org-version)
18186 (let (list)
18187 (save-window-excursion
18188 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
18189 (delete-other-windows)
18190 (erase-buffer)
18191 (insert "You are about to submit a bug report to the Org-mode mailing list.
18193 We would like to add your full Org-mode and Outline configuration to the
18194 bug report. This greatly simplifies the work of the maintainer and
18195 other experts on the mailing list.
18197 HOWEVER, some variables you have customized may contain private
18198 information. The names of customers, colleagues, or friends, might
18199 appear in the form of file names, tags, todo states, or search strings.
18200 If you answer yes to the prompt, you might want to check and remove
18201 such private information before sending the email.")
18202 (add-text-properties (point-min) (point-max) '(face org-warning))
18203 (when (yes-or-no-p "Include your Org-mode configuration ")
18204 (mapatoms
18205 (lambda (v)
18206 (and (boundp v)
18208 (or (and (symbol-value v)
18210 (and
18211 (get v 'custom-type) (get v 'standard-value)
18212 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18213 (push v list)))))
18214 (kill-buffer (get-buffer "*Warn about privacy*"))
18215 list))
18216 nil nil
18217 "Remember to cover the basics, that is, what you expected to happen and
18218 what in fact did happen. You don't know how to make a good report? See
18220 http://orgmode.org/manual/Feedback.html#Feedback
18222 Your bug report will be posted to the Org-mode mailing list.
18223 ------------------------------------------------------------------------")
18224 (save-excursion
18229 (defun org-install-agenda-files-menu ()
18230 (let ((bl (buffer-list)))
18231 (save-excursion
18232 (while bl
18233 (set-buffer (pop bl))
18234 (if (org-mode-p) (setq bl nil)))
18235 (when (org-mode-p)
18236 (easy-menu-change
18237 '("Org") "File List for Agenda"
18238 (append
18239 (list
18240 ["Edit File List" (org-edit-agenda-file-list) t]
18241 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18242 ["Remove Current File from List" org-remove-file t]
18243 ["Cycle through agenda files" org-cycle-agenda-files t]
18244 ["Occur in all agenda files" org-occur-in-agenda-files t]
18245 "--")
18246 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18248 ;;;; Documentation
18250 ;;;###autoload
18251 (defun org-require-autoloaded-modules ()
18252 (interactive)
18253 (mapc 'require
18254 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18255 org-docbook org-exp org-html org-icalendar
18256 org-id org-latex
18257 org-publish org-remember org-table
18258 org-timer org-xoxo)))
18260 ;;;###autoload
18261 (defun org-reload (&optional uncompiled)
18262 "Reload all org lisp files.
18263 With prefix arg UNCOMPILED, load the uncompiled versions."
18264 (interactive "P")
18265 (require 'find-func)
18267 (dir-org (file-name-directory (org-find-library-name "org")))
18268 (dir-org-contrib (ignore-errors
18269 (file-name-directory
18270 (org-find-library-name "org-contribdir"))))
18271 (babel-files
18272 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18273 (append (list nil "comint" "eval" "exp" "keys"
18274 "lob" "ref" "table" "tangle")
18275 (delq nil
18276 (mapcar
18277 (lambda (lang)
18278 (when (cdr lang) (symbol-name (car lang))))
18279 org-babel-load-languages)))))
18280 (files
18281 (append (directory-files dir-org t file-re)
18282 babel-files
18283 (and dir-org-contrib
18284 (directory-files dir-org-contrib t file-re))))
18285 (remove-re (concat (if (featurep 'xemacs)
18286 "org-colview" "org-colview-xemacs")
18288 (setq files (mapcar 'file-name-sans-extension files))
18289 (setq files (mapcar
18290 (lambda (x) (if (string-match remove-re x) nil x))
18291 files))
18292 (setq files (delq nil files))
18293 (mapc
18294 (lambda (f)
18295 (when (featurep (intern (file-name-nondirectory f)))
18296 (if (and (not uncompiled)
18297 (file-exists-p (concat f ".elc")))
18298 (load (concat f ".elc") nil nil t)
18299 (load (concat f ".el") nil nil t))))
18300 files))
18301 (org-version))
18303 ;;;###autoload
18304 (defun org-customize ()
18305 "Call the customize function with org as argument."
18306 (interactive)
18307 (org-load-modules-maybe)
18308 (org-require-autoloaded-modules)
18309 (customize-browse 'org))
18311 (defun org-create-customize-menu ()
18312 "Create a full customization menu for Org-mode, insert it into the menu."
18313 (interactive)
18314 (org-load-modules-maybe)
18315 (org-require-autoloaded-modules)
18316 (if (fboundp 'customize-menu-create)
18317 (progn
18318 (easy-menu-change
18319 '("Org") "Customize"
18320 `(["Browse Org group" org-customize t]
18321 "--"
18322 ,(customize-menu-create 'org)
18323 ["Set" Custom-set t]
18324 ["Save" Custom-save t]
18325 ["Reset to Current" Custom-reset-current t]
18326 ["Reset to Saved" Custom-reset-saved t]
18327 ["Reset to Standard Settings" Custom-reset-standard t]))
18329 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18331 ;;;; Miscellaneous stuff
18333 ;;; Generally useful functions
18335 (defun org-get-at-bol (property)
18336 "Get text property PROPERTY at beginning of line."
18337 (get-text-property (point-at-bol) property))
18339 (defun org-find-text-property-in-string (prop s)
18340 "Return the first non-nil value of property PROP in string S."
18341 (or (get-text-property 0 prop s)
18342 (get-text-property (or (next-single-property-change 0 prop s) 0)
18343 prop s)))
18345 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18346 "Display the given MESSAGE as a warning."
18347 (if (fboundp 'display-warning)
18348 (display-warning 'org message
18349 (if (featurep 'xemacs) 'warning :warning))
18350 (let ((buf (get-buffer-create "*Org warnings*")))
18351 (with-current-buffer buf
18352 (goto-char (point-max))
18353 (insert "Warning (Org): " message)
18354 (unless (bolp)
18355 (newline)))
18356 (display-buffer buf)
18357 (sit-for 0))))
18359 (defun org-eval (form)
18360 "Eval FORM and return result."
18361 (condition-case error
18362 (eval form)
18363 (error (format "%%![Error: %s]" error))))
18365 (defun org-in-commented-line ()
18366 "Is point in a line starting with `#'?"
18367 (equal (char-after (point-at-bol)) ?#))
18369 (defun org-in-indented-comment-line ()
18370 "Is point in a line starting with `#' after some white space?"
18371 (save-excursion
18372 (save-match-data
18373 (goto-char (point-at-bol))
18376 (defun org-in-verbatim-emphasis ()
18377 (save-match-data
18378 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18380 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18381 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18382 (if (and marker (marker-buffer marker)
18383 (buffer-live-p (marker-buffer marker)))
18384 (progn
18385 (switch-to-buffer (marker-buffer marker))
18386 (if (or (> marker (point-max)) (< marker (point-min)))
18387 (widen))
18388 (goto-char marker)
18389 (org-show-context 'org-goto))
18390 (if bookmark
18391 (bookmark-jump bookmark)
18392 (error "Cannot find location"))))
18394 (defun org-quote-csv-field (s)
18395 "Quote field for inclusion in CSV material."
18398 s))
18400 (defun org-force-self-insert (N)
18401 "Needed to enforce self-insert under remapping."
18402 (interactive "p")
18403 (self-insert-command N))
18405 (defun org-string-width (s)
18406 "Compute width of string, ignoring invisible characters.
18407 This ignores character with invisibility property `org-link', and also
18408 characters with property `org-cwidth', because these will become invisible
18409 upon the next fontification round."
18410 (let (b l)
18411 (when (or (eq t buffer-invisibility-spec)
18412 (assq 'org-link buffer-invisibility-spec))
18413 (while (setq b (text-property-any 0 (length s)
18414 'invisible 'org-link s))
18415 (setq s (concat (substring s 0 b)
18416 (substring s (or (next-single-property-change
18417 b 'invisible s) (length s)))))))
18418 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18419 (setq s (concat (substring s 0 b)
18420 (substring s (or (next-single-property-change
18421 b 'org-cwidth s) (length s))))))
18422 (setq l (string-width s) b -1)
18423 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18424 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18425 l))
18427 (defun org-shorten-string (s maxlength)
18428 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18429 If the string is shorter or has length MAXLENGTH, just return the
18430 original string. If it is longer, the functions finds a space in the
18431 string, breaks this string off at that locations and adds three dots
18432 as ellipsis. Including the ellipsis, the string will not be longer
18433 than MAXLENGTH. If finding a good breaking point in the string does
18434 not work, the string is just chopped off in the middle of a word
18435 if necessary."
18436 (if (<= (length s) maxlength)
18437 s
18438 (let* ((n (max (- maxlength 4) 1))
18440 (if (string-match re s)
18441 (concat (match-string 1 s) "...")
18442 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18444 (defun org-get-indentation (&optional line)
18445 "Get the indentation of the current line, interpreting tabs.
18446 When LINE is given, assume it represents a line and compute its indentation."
18447 (if line
18448 (if (string-match "^ *" (org-remove-tabs line))
18449 (match-end 0))
18450 (save-excursion
18451 (beginning-of-line 1)
18453 (current-column))))
18455 (defun org-get-string-indentation (s)
18456 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18457 (let ((n -1) (i 0) (w tab-width) c)
18458 (catch 'exit
18459 (while (< (setq n (1+ n)) (length s))
18460 (setq c (aref s n))
18461 (cond ((= c ?\ ) (setq i (1+ i)))
18463 (t (throw 'exit t)))))
18464 i))
18466 (defun org-remove-tabs (s &optional width)
18467 "Replace tabulators in S with spaces.
18468 Assumes that s is a single line, starting in column 0."
18469 (setq width (or width tab-width))
18471 (setq s (replace-match
18472 (make-string
18473 (- (* width (/ (+ (match-beginning 0) width) width))
18474 (match-beginning 0)) ?\ )
18475 t t s)))
18476 s)
18478 (defun org-fix-indentation (line ind)
18479 "Fix indentation in LINE.
18480 IND is a cons cell with target and minimum indentation.
18481 If the current indentation in LINE is smaller than the minimum,
18482 leave it alone. If it is larger than ind, set it to the target."
18483 (let* ((l (org-remove-tabs line))
18484 (i (org-get-indentation l))
18485 (i1 (car ind)) (i2 (cdr ind)))
18486 (if (>= i i2) (setq l (substring line i2)))
18487 (if (> i1 0)
18488 (concat (make-string i1 ?\ ) l)
18489 l)))
18491 (defun org-remove-indentation (code &optional n)
18492 "Remove the maximum common indentation from the lines in CODE.
18493 N may optionally be the number of spaces to remove."
18494 (with-temp-buffer
18495 (insert code)
18496 (org-do-remove-indentation n)
18497 (buffer-string)))
18499 (defun org-do-remove-indentation (&optional n)
18500 "Remove the maximum common indentation from the buffer."
18501 (untabify (point-min) (point-max))
18502 (let ((min 10000) re)
18503 (if n
18504 (setq min n)
18505 (goto-char (point-min))
18507 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18508 (unless (or (= min 0) (= min 10000))
18510 (goto-char (point-min))
18511 (while (re-search-forward re nil t)
18512 (replace-match "")
18513 (end-of-line 1))
18514 min)))
18516 (defun org-fill-template (template alist)
18517 "Find each %key of ALIST in TEMPLATE and replace it."
18518 (let ((case-fold-search nil)
18519 entry key value)
18520 (setq alist (sort (copy-sequence alist)
18521 (lambda (a b) (< (length (car a)) (length (car b))))))
18522 (while (setq entry (pop alist))
18523 (setq template
18524 (replace-regexp-in-string
18525 (concat "%" (regexp-quote (car entry)))
18526 (cdr entry) template t t)))
18527 template))
18529 (defun org-base-buffer (buffer)
18530 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18531 (if (not buffer)
18532 buffer
18533 (or (buffer-base-buffer buffer)
18534 buffer)))
18536 (defun org-trim (s)
18537 "Remove whitespace at beginning and end of string."
18540 s)
18542 (defun org-wrap (string &optional width lines)
18543 "Wrap string to either a number of lines, or a width in characters.
18544 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18545 that costs. If there is a word longer than WIDTH, the text is actually
18546 wrapped to the length of that word.
18547 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18548 many lines, whatever width that takes.
18549 The return value is a list of lines, without newlines at the end."
18551 (maxword (apply 'max (mapcar 'org-string-width words)))
18552 w ll)
18553 (cond (width
18554 (org-do-wrap words (max maxword width)))
18555 (lines
18556 (setq w maxword)
18557 (setq ll (org-do-wrap words maxword))
18558 (if (<= (length ll) lines)
18559 ll
18560 (setq ll words)
18561 (while (> (length ll) lines)
18562 (setq w (1+ w))
18563 (setq ll (org-do-wrap words w)))
18564 ll))
18565 (t (error "Cannot wrap this")))))
18567 (defun org-do-wrap (words width)
18568 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18569 (let (lines line)
18570 (while words
18571 (setq line (pop words))
18572 (while (and words (< (+ (length line) (length (car words))) width))
18573 (setq line (concat line " " (pop words))))
18574 (setq lines (push line lines)))
18575 (nreverse lines)))
18577 (defun org-split-string (string &optional separators)
18578 "Splits STRING into substrings at SEPARATORS.
18579 No empty strings are returned if there are matches at the beginning
18580 and end of string."
18582 (start 0)
18583 notfirst
18584 (list nil))
18585 (while (and (string-match rexp string
18586 (if (and notfirst
18587 (= start (match-beginning 0))
18588 (< start (length string)))
18589 (1+ start) start))
18590 (< (match-beginning 0) (length string)))
18591 (setq notfirst t)
18592 (or (eq (match-beginning 0) 0)
18593 (and (eq (match-beginning 0) (match-end 0))
18594 (eq (match-beginning 0) start))
18595 (setq list
18596 (cons (substring string start (match-beginning 0))
18597 list)))
18598 (setq start (match-end 0)))
18599 (or (eq start (length string))
18600 (setq list
18601 (cons (substring string start)
18602 list)))
18603 (nreverse list)))
18605 (defun org-quote-vert (s)
18607 (while (string-match "|" s)
18609 s)
18611 (defun org-uuidgen-p (s)
18612 "Is S an ID created by UUIDGEN?"
18613 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18615 (defun org-context ()
18616 "Return a list of contexts of the current cursor position.
18617 If several contexts apply, all are returned.
18618 Each context entry is a list with a symbol naming the context, and
18619 two positions indicating start and end of the context. Possible
18620 contexts are:
18622 :headline anywhere in a headline
18623 :headline-stars on the leading stars in a headline
18624 :todo-keyword on a TODO keyword (including DONE) in a headline
18625 :tags on the TAGS in a headline
18626 :priority on the priority cookie in a headline
18627 :item on the first line of a plain list item
18628 :item-bullet on the bullet/number of a plain list item
18629 :checkbox on the checkbox in a plain list item
18630 :table in an org-mode table
18631 :table-special on a special filed in a table
18632 :table-table in a table.el table
18633 :link on a hyperlink
18634 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18635 :target on a <<target>>
18636 :radio-target on a <<<radio-target>>>
18637 :latex-fragment on a LaTeX fragment
18638 :latex-preview on a LaTeX fragment with overlayed preview image
18640 This function expects the position to be visible because it uses font-lock
18641 faces as a help to recognize the following contexts: :table-special, :link,
18642 and :keyword."
18643 (let* ((f (get-text-property (point) 'face))
18644 (faces (if (listp f) f (list f)))
18645 (p (point)) clist o)
18646 ;; First the large context
18647 (cond
18648 ((org-on-heading-p t)
18649 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18650 (when (progn
18651 (beginning-of-line 1)
18652 (looking-at org-todo-line-tags-regexp))
18653 (push (org-point-in-group p 1 :headline-stars) clist)
18654 (push (org-point-in-group p 2 :todo-keyword) clist)
18655 (push (org-point-in-group p 4 :tags) clist))
18656 (goto-char p)
18659 (push (org-point-in-group p 0 :priority) clist)))
18661 ((org-at-item-p)
18662 (push (org-point-in-group p 2 :item-bullet) clist)
18663 (push (list :item (point-at-bol)
18664 (save-excursion (org-end-of-item) (point)))
18665 clist)
18666 (and (org-at-item-checkbox-p)
18667 (push (org-point-in-group p 0 :checkbox) clist)))
18669 ((org-at-table-p)
18670 (push (list :table (org-table-begin) (org-table-end)) clist)
18671 (if (memq 'org-formula faces)
18672 (push (list :table-special
18673 (previous-single-property-change p 'face)
18674 (next-single-property-change p 'face)) clist)))
18675 ((org-at-table-p 'any)
18676 (push (list :table-table) clist)))
18677 (goto-char p)
18679 ;; Now the small context
18680 (cond
18681 ((org-at-timestamp-p)
18682 (push (org-point-in-group p 0 :timestamp) clist))
18683 ((memq 'org-link faces)
18684 (push (list :link
18685 (previous-single-property-change p 'face)
18686 (next-single-property-change p 'face)) clist))
18687 ((memq 'org-special-keyword faces)
18688 (push (list :keyword
18689 (previous-single-property-change p 'face)
18690 (next-single-property-change p 'face)) clist))
18691 ((org-on-target-p)
18692 (push (org-point-in-group p 0 :target) clist)
18693 (goto-char (1- (match-beginning 0)))
18694 (if (looking-at org-radio-target-regexp)
18695 (push (org-point-in-group p 0 :radio-target) clist))
18696 (goto-char p))
18697 ((setq o (car (delq nil
18698 (mapcar
18699 (lambda (x)
18700 (if (memq x org-latex-fragment-image-overlays) x))
18701 (overlays-at (point))))))
18702 (push (list :latex-fragment
18703 (overlay-start o) (overlay-end o)) clist)
18704 (push (list :latex-preview
18705 (overlay-start o) (overlay-end o)) clist))
18706 ((org-inside-LaTeX-fragment-p)
18707 ;; FIXME: positions wrong.
18708 (push (list :latex-fragment (point) (point)) clist)))
18710 (setq clist (nreverse (delq nil clist)))
18711 clist))
18713 ;; FIXME: Compare with at-regexp-p Do we need both?
18714 (defun org-in-regexp (re &optional nlines visually)
18715 "Check if point is inside a match of regexp.
18716 Normally only the current line is checked, but you can include NLINES extra
18717 lines both before and after point into the search.
18718 If VISUALLY is set, require that the cursor is not after the match but
18719 really on, so that the block visually is on the match."
18720 (catch 'exit
18721 (let ((pos (point))
18722 (eol (point-at-eol (+ 1 (or nlines 0))))
18723 (inc (if visually 1 0)))
18724 (save-excursion
18725 (beginning-of-line (- 1 (or nlines 0)))
18726 (while (re-search-forward re eol t)
18727 (if (and (<= (match-beginning 0) pos)
18728 (>= (+ inc (match-end 0)) pos))
18729 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18731 (defun org-at-regexp-p (regexp)
18732 "Is point inside a match of REGEXP in the current line?"
18733 (catch 'exit
18734 (save-excursion
18735 (let ((pos (point)) (end (point-at-eol)))
18736 (beginning-of-line 1)
18737 (while (re-search-forward regexp end t)
18738 (if (and (<= (match-beginning 0) pos)
18739 (>= (match-end 0) pos))
18740 (throw 'exit t)))
18741 nil))))
18743 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18744 "Return t if the current point is between matches of START-RE and END-RE.
18745 This will also return t if point is on one of the two matches or
18746 in an unfinished block. END-RE can be a string or a form
18747 returning a string.
18749 An optional third argument bounds the search for START-RE. It
18750 defaults to previous heading or `point-min'."
18751 (let ((pos (point))
18752 (limit (or bound (save-excursion (outline-previous-heading)))))
18753 (save-excursion
18754 ;; we're on a block when point is on start-re...
18755 (or (org-at-regexp-p start-re)
18756 ;; ... or start-re can be found above...
18757 (and (re-search-backward start-re limit t)
18758 ;; ... but no end-re between start-re and point.
18759 (not (re-search-forward (eval end-re) pos t)))))))
18761 (defun org-occur-in-agenda-files (regexp &optional nlines)
18762 "Call `multi-occur' with buffers for all agenda files."
18764 (let* ((files (org-agenda-files))
18765 (tnames (mapcar 'file-truename files))
18766 (extra org-agenda-text-search-extra-files)
18767 f)
18768 (when (eq (car extra) 'agenda-archives)
18769 (setq extra (cdr extra))
18770 (setq files (org-add-archive-files files)))
18771 (while (setq f (pop extra))
18772 (unless (member (file-truename f) tnames)
18773 (add-to-list 'files f 'append)
18774 (add-to-list 'tnames (file-truename f) 'append)))
18775 (multi-occur
18776 (mapcar (lambda (x)
18777 (with-current-buffer
18778 (or (get-file-buffer x) (find-file-noselect x))
18779 (widen)
18780 (current-buffer)))
18781 files)
18782 regexp)))
18784 (if (boundp 'occur-mode-find-occurrence-hook)
18785 ;; Emacs 23
18786 (add-hook 'occur-mode-find-occurrence-hook
18787 (lambda ()
18788 (when (org-mode-p)
18789 (org-reveal))))
18790 ;; Emacs 22
18791 (defadvice occur-mode-goto-occurrence
18792 (after org-occur-reveal activate)
18793 (and (org-mode-p) (org-reveal)))
18794 (defadvice occur-mode-goto-occurrence-other-window
18795 (after org-occur-reveal activate)
18796 (and (org-mode-p) (org-reveal)))
18797 (defadvice occur-mode-display-occurrence
18798 (after org-occur-reveal activate)
18799 (when (org-mode-p)
18800 (let ((pos (occur-mode-find-occurrence)))
18801 (with-current-buffer (marker-buffer pos)
18802 (save-excursion
18803 (goto-char pos)
18804 (org-reveal)))))))
18806 (defun org-occur-link-in-agenda-files ()
18807 "Create a link and search for it in the agendas.
18808 The link is not stored in `org-stored-links', it is just created
18809 for the search purpose."
18810 (interactive)
18811 (let ((link (condition-case nil
18812 (org-store-link nil)
18813 (error "Unable to create a link to here"))))
18814 (org-occur-in-agenda-files (regexp-quote link))))
18816 (defun org-uniquify (list)
18817 "Remove duplicate elements from LIST."
18818 (let (res)
18819 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18820 res))
18822 (defun org-delete-all (elts list)
18823 "Remove all elements in ELTS from LIST."
18824 (while elts
18825 (setq list (delete (pop elts) list)))
18826 list)
18828 (defun org-count (cl-item cl-seq)
18829 "Count the number of occurrences of ITEM in SEQ.
18830 Taken from `count' in cl-seq.el with all keyword arguments removed."
18831 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18832 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18833 (while (< cl-start cl-end)
18834 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18835 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18836 (setq cl-start (1+ cl-start)))
18837 cl-count))
18839 (defun org-remove-if (predicate seq)
18840 "Remove everything from SEQ that fulfills PREDICATE."
18841 (let (res e)
18842 (while seq
18843 (setq e (pop seq))
18844 (if (not (funcall predicate e)) (push e res)))
18845 (nreverse res)))
18847 (defun org-remove-if-not (predicate seq)
18848 "Remove everything from SEQ that does not fulfill PREDICATE."
18849 (let (res e)
18850 (while seq
18851 (setq e (pop seq))
18852 (if (funcall predicate e) (push e res)))
18853 (nreverse res)))
18855 (defun org-back-over-empty-lines ()
18856 "Move backwards over whitespace, to the beginning of the first empty line.
18857 Returns the number of empty lines passed."
18858 (let ((pos (point)))
18859 (if (cdr (assoc 'heading org-blank-before-new-entry))
18861 (forward-line -1))
18862 (beginning-of-line 2)
18863 (goto-char (min (point) pos))
18864 (count-lines (point) pos)))
18866 (defun org-skip-whitespace ()
18869 (defun org-point-in-group (point group &optional context)
18870 "Check if POINT is in match-group GROUP.
18871 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18872 match. If the match group does not exist or point is not inside it,
18873 return nil."
18874 (and (match-beginning group)
18875 (>= point (match-beginning group))
18876 (<= point (match-end group))
18877 (if context
18878 (list context (match-beginning group) (match-end group))
18879 t)))
18881 (defun org-switch-to-buffer-other-window (&rest args)
18882 "Switch to buffer in a second window on the current frame.
18883 In particular, do not allow pop-up frames.
18884 Returns the newly created buffer."
18885 (let (pop-up-frames special-display-buffer-names special-display-regexps
18886 special-display-function)
18887 (apply 'switch-to-buffer-other-window args)))
18889 (defun org-combine-plists (&rest plists)
18890 "Create a single property list from all plists in PLISTS.
18891 The process starts by copying the first list, and then setting properties
18892 from the other lists. Settings in the last list are the most significant
18893 ones and overrule settings in the other lists."
18894 (let ((rtn (copy-sequence (pop plists)))
18895 p v ls)
18896 (while plists
18897 (setq ls (pop plists))
18898 (while ls
18899 (setq p (pop ls) v (pop ls))
18900 (setq rtn (plist-put rtn p v))))
18901 rtn))
18903 (defun org-move-line-down (arg)
18904 "Move the current line down. With prefix argument, move it past ARG lines."
18905 (interactive "p")
18906 (let ((col (current-column))
18907 beg end pos)
18908 (beginning-of-line 1) (setq beg (point))
18909 (beginning-of-line 2) (setq end (point))
18910 (beginning-of-line (+ 1 arg))
18911 (setq pos (move-marker (make-marker) (point)))
18912 (insert (delete-and-extract-region beg end))
18913 (goto-char pos)
18914 (org-move-to-column col)))
18916 (defun org-move-line-up (arg)
18917 "Move the current line up. With prefix argument, move it past ARG lines."
18918 (interactive "p")
18919 (let ((col (current-column))
18920 beg end pos)
18921 (beginning-of-line 1) (setq beg (point))
18922 (beginning-of-line 2) (setq end (point))
18923 (beginning-of-line (- arg))
18924 (setq pos (move-marker (make-marker) (point)))
18925 (insert (delete-and-extract-region beg end))
18926 (goto-char pos)
18927 (org-move-to-column col)))
18929 (defun org-replace-escapes (string table)
18930 "Replace %-escapes in STRING with values in TABLE.
18932 The sequences in STRING may contain normal field width and padding information,
18934 so values can contain further %-escapes if they are define later in TABLE."
18935 (let ((tbl (copy-alist table))
18936 (case-fold-search nil)
18937 (pchg 0)
18938 e re rpl)
18939 (while (setq e (pop tbl))
18940 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18941 (when (and (cdr e) (string-match re (cdr e)))
18942 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18943 (safe "SREF"))
18944 (add-text-properties 0 3 (list 'sref sref) safe)
18945 (setcdr e (replace-match safe t t (cdr e)))))
18946 (while (string-match re string)
18947 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18948 (cdr e)))
18949 (setq string (replace-match rpl t t string))))
18950 (while (setq pchg (next-property-change pchg string))
18951 (let ((sref (get-text-property pchg 'sref string)))
18952 (when (and sref (string-match "SREF" string pchg))
18953 (setq string (replace-match sref t t string)))))
18954 string))
18956 (defun org-sublist (list start end)
18957 "Return a section of LIST, from START to END.
18958 Counting starts at 1."
18959 (let (rtn (c start))
18960 (setq list (nthcdr (1- start) list))
18961 (while (and list (<= c end))
18962 (push (pop list) rtn)
18963 (setq c (1+ c)))
18964 (nreverse rtn)))
18966 (defun org-find-base-buffer-visiting (file)
18967 "Like `find-buffer-visiting' but always return the base buffer and
18968 not an indirect buffer."
18969 (let ((buf (or (get-file-buffer file)
18970 (find-buffer-visiting file))))
18971 (if buf
18972 (or (buffer-base-buffer buf) buf)
18973 nil)))
18975 (defun org-image-file-name-regexp (&optional extensions)
18976 "Return regexp matching the file names of images.
18977 If EXTENSIONS is given, only match these."
18978 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18979 (image-file-name-regexp)
18980 (let ((image-file-name-extensions
18981 (or extensions
18982 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18983 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18985 (regexp-opt (nconc (mapcar 'upcase
18986 image-file-name-extensions)
18987 image-file-name-extensions)
18988 t)
18991 (defun org-file-image-p (file &optional extensions)
18992 "Return non-nil if FILE is an image."
18993 (save-match-data
18994 (string-match (org-image-file-name-regexp extensions) file)))
18996 (defun org-get-cursor-date ()
18997 "Return the date at cursor in as a time.
18998 This works in the calendar and in the agenda, anywhere else it just
18999 returns the current time."
19000 (let (date day defd)
19001 (cond
19002 ((eq major-mode 'calendar-mode)
19003 (setq date (calendar-cursor-to-date)
19004 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19005 ((eq major-mode 'org-agenda-mode)
19006 (setq day (get-text-property (point) 'day))
19007 (if day
19008 (setq date (calendar-gregorian-from-absolute day)
19009 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19010 (nth 2 date))))))
19011 (or defd (current-time))))
19013 (defvar org-agenda-action-marker (make-marker)
19014 "Marker pointing to the entry for the next agenda action.")
19016 (defun org-mark-entry-for-agenda-action ()
19017 "Mark the current entry as target of an agenda action.
19018 Agenda actions are actions executed from the agenda with the key `k',
19019 which make use of the date at the cursor."
19020 (interactive)
19021 (move-marker org-agenda-action-marker
19022 (save-excursion (org-back-to-heading t) (point))
19023 (current-buffer))
19024 (message
19025 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19027 (defun org-mark-subtree ()
19028 "Mark the current subtree.
19029 This puts point at the start of the current subtree, and mark at the end.
19031 If point is in an inline task, mark that task instead."
19032 (interactive)
19033 (let ((inline-task-p
19034 (and (featurep 'org-inlinetask)
19035 (org-inlinetask-in-task-p)))
19036 (beg))
19037 ;; Get beginning of subtree
19038 (cond
19039 (inline-task-p (org-inlinetask-goto-beginning))
19040 ((org-at-heading-p) (beginning-of-line))
19041 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19042 (setq beg (point))
19043 ;; Get end of it
19044 (if inline-task-p
19045 (org-inlinetask-goto-end)
19046 (org-end-of-subtree))
19047 ;; Mark zone
19048 (push-mark (point) nil t)
19049 (goto-char beg)))
19051 ;;; Paragraph filling stuff.
19052 ;; We want this to be just right, so use the full arsenal.
19054 (defun org-indent-line-function ()
19055 "Indent line depending on context."
19056 (interactive)
19057 (let* ((pos (point))
19058 (itemp (org-at-item-p))
19059 (case-fold-search t)
19061 (inline-task-p (and (featurep 'org-inlinetask)
19062 (org-inlinetask-in-task-p)))
19063 (inline-re (and inline-task-p
19064 (org-inlinetask-outline-regexp)))
19065 column)
19066 (beginning-of-line 1)
19067 (cond
19068 ;; Comments
19069 ((looking-at "# ") (setq column 0))
19070 ;; Headings
19072 ;; Footnote definition
19073 ((looking-at org-footnote-definition-re) (setq column 0))
19074 ;; Literal examples
19076 (setq column (org-get-indentation))) ; do nothing
19077 ;; Lists
19078 ((ignore-errors (goto-char (org-in-item-p)))
19079 (setq column (if itemp
19080 (org-get-indentation)
19081 (org-list-item-body-column (point))))
19082 (goto-char pos))
19083 ;; Drawers
19085 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19086 (save-excursion
19087 (goto-char (1- (match-beginning 1)))
19088 (setq column (current-column))))
19089 ;; Special blocks
19091 (save-excursion
19092 (re-search-backward
19094 (setq column (org-get-indentation (match-string 0))))
19097 (save-excursion
19099 (setq column
19100 (if (equal (downcase (match-string 1)) "src")
19101 ;; src blocks: let `org-edit-src-exit' handle them
19102 (org-get-indentation)
19103 (org-get-indentation (match-string 0)))))
19104 ;; This line has nothing special, look at the previous relevant
19105 ;; line to compute indentation
19106 (t
19107 (beginning-of-line 0)
19108 (while (and (not (bobp))
19109 (not (looking-at org-drawer-regexp))
19110 ;; When point started in an inline task, do not move
19111 ;; above task starting line.
19112 (not (and inline-task-p (looking-at inline-re)))
19113 ;; Skip drawers, blocks, empty lines, verbatim,
19114 ;; comments, tables, footnotes definitions, lists,
19115 ;; inline tasks.
19117 (re-search-backward org-drawer-regexp nil t))
19121 (looking-at org-footnote-definition-re)
19122 (and (ignore-errors (goto-char (org-in-item-p)))
19123 (goto-char
19124 (org-list-get-top-point (org-list-struct))))
19125 (and (not inline-task-p)
19126 (featurep 'org-inlinetask)
19127 (org-inlinetask-in-task-p)
19128 (or (org-inlinetask-goto-beginning) t))))
19129 (beginning-of-line 0))
19130 (cond
19131 ;; There was an heading above.
19133 (if (not org-adapt-indentation)
19134 (setq column 0)
19135 (goto-char (match-end 0))
19136 (setq column (current-column))))
19137 ;; A drawer had started and is unfinished
19138 ((looking-at org-drawer-regexp)
19139 (goto-char (1- (match-beginning 1)))
19140 (setq column (current-column)))
19141 ;; Else, nothing noticeable found: get indentation and go on.
19142 (t (setq column (org-get-indentation))))))
19143 ;; Now apply indentation and move cursor accordingly
19144 (goto-char pos)
19145 (if (<= (current-column) (current-indentation))
19146 (org-indent-line-to column)
19147 (save-excursion (org-indent-line-to column)))
19148 ;; Special polishing for properties, see `org-property-format'
19149 (setq column (current-column))
19150 (beginning-of-line 1)
19151 (if (looking-at
19153 (replace-match (concat (match-string 1)
19154 (format org-property-format
19155 (match-string 2) (match-string 3)))
19156 t t))
19157 (org-move-to-column column)))
19159 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19160 "Variable to store copy of `adaptive-fill-regexp'.
19161 Since `adaptive-fill-regexp' is set to never match, we need to
19162 store a backup of its value before entering `org-mode' so that
19163 the functionality can be provided as a fall-back.")
19165 (defun org-set-autofill-regexps ()
19166 (interactive)
19167 ;; In the paragraph separator we include headlines, because filling
19168 ;; text in a line directly attached to a headline would otherwise
19169 ;; fill the headline as well.
19172 ;; The paragraph starter includes hand-formatted lists.
19173 (org-set-local
19174 'paragraph-start
19175 (concat
19184 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19185 ;; But only if the user has not turned off tables or fixed-width regions
19186 (org-set-local
19187 'auto-fill-inhibit-regexp
19190 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19191 (concat
19193 (if org-enable-table-editor "|" "")
19194 (if org-enable-fixed-width-editor ":" "")
19195 "]"))))
19196 ;; We use our own fill-paragraph function, to make sure that tables
19197 ;; and fixed-width regions are not wrapped. That function will pass
19198 ;; through to `fill-paragraph' when appropriate.
19199 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19200 ;; Prevent auto-fill from inserting unwanted new items.
19201 (org-set-local 'fill-nobreak-predicate
19202 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19203 fill-nobreak-predicate
19204 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19205 ;; Adaptive filling: To get full control, first make sure that
19206 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19207 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19208 (org-set-local 'org-adaptive-fill-regexp-backup
19209 adaptive-fill-regexp))
19211 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19212 (org-set-local 'adaptive-fill-function
19213 'org-adaptive-fill-function)
19214 (org-set-local
19215 'align-mode-rules-list
19216 '((org-in-buffer-settings
19218 (modes . '(org-mode))))))
19220 (defun org-fill-item-nobreak-p ()
19221 "Non-nil when a line break at point would insert a new item."
19222 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19224 (defun org-fill-paragraph (&optional justify)
19225 "Re-align a table, pass through to fill-paragraph if no table."
19226 (let ((table-p (org-at-table-p))
19227 (table.el-p (org-at-table.el-p))
19228 (itemp (org-in-item-p)))
19229 (cond ((and (equal (char-after (point-at-bol)) ?*)
19230 (save-excursion (goto-char (point-at-bol))
19231 (looking-at outline-regexp)))
19232 t) ; skip headlines
19233 (table.el-p t) ; skip table.el tables
19234 (table-p (org-table-align) t) ; align Org tables
19235 (itemp ; align text in items
19236 (let* ((struct (save-excursion (goto-char itemp)
19237 (org-list-struct)))
19238 (parents (org-list-parents-alist struct))
19239 (children (org-list-get-children itemp struct parents))
19240 beg end prev next prefix)
19241 ;; Determine in which part of item point is: before
19242 ;; first child, after last child, between two
19243 ;; sub-lists, or simply in item if there's no child.
19244 (cond
19245 ((not children)
19246 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19247 beg itemp
19248 end (org-list-get-item-end itemp struct)))
19249 ((< (point) (setq next (car children)))
19250 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19251 beg itemp
19252 end next))
19253 ((> (point) (setq prev (car (last children))))
19254 (setq beg (org-list-get-item-end prev struct)
19255 end (org-list-get-item-end itemp struct)
19256 prefix (save-excursion
19257 (goto-char beg)
19259 (make-string (current-column) ?\ ))))
19260 (t (catch 'exit
19261 (while (setq next (pop children))
19262 (if (> (point) next)
19263 (setq prev next)
19264 (setq beg (org-list-get-item-end prev struct)
19265 end next
19266 prefix (save-excursion
19267 (goto-char beg)
19269 (make-string (current-column) ?\ )))
19270 (throw 'exit nil))))))
19271 ;; Use `fill-paragraph' with buffer narrowed to item
19272 ;; without any child, and with our computed PREFIX.
19273 (flet ((fill-context-prefix (from to &optional flr) prefix))
19274 (save-restriction
19275 (narrow-to-region beg end)
19276 (save-excursion (fill-paragraph justify)))) t))
19277 ;; Special case where point is not in a list but is on
19278 ;; a paragraph adjacent to a list: make sure this paragraph
19279 ;; doesn't get merged with the end of the list by narrowing
19280 ;; buffer first.
19281 ((save-excursion (forward-paragraph -1)
19282 (setq itemp (org-in-item-p)))
19283 (let ((struct (save-excursion (goto-char itemp)
19284 (org-list-struct))))
19285 (save-restriction
19286 (narrow-to-region (org-list-get-bottom-point struct)
19287 (save-excursion (forward-paragraph 1)
19288 (point)))
19289 (fill-paragraph justify) t)))
19290 ;; Else simply call `fill-paragraph'.
19291 (t nil))))
19293 ;; For reference, this is the default value of adaptive-fill-regexp
19296 (defun org-adaptive-fill-function ()
19297 "Return a fill prefix for org-mode files."
19298 (let (itemp)
19299 (save-excursion
19300 (cond
19301 ;; Comment line
19303 (match-string-no-properties 0))
19304 ;; Plain list item
19305 ((org-at-item-p)
19306 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19307 ;; Point is in a list after `backward-paragraph': original
19308 ;; point wasn't in the list, or filling would have been taken
19309 ;; care of by `org-auto-fill-function', but the list and the
19310 ;; real paragraph are not separated by a blank line. Thus, move
19311 ;; point after the list to go back to real paragraph and
19312 ;; determine fill-prefix.
19313 ((setq itemp (org-in-item-p))
19314 (goto-char itemp)
19315 (let* ((struct (org-list-struct))
19316 (bottom (org-list-get-bottom-point struct)))
19317 (goto-char bottom)
19318 (make-string (org-get-indentation) ?\ )))
19319 ;; Other text
19320 ((looking-at org-adaptive-fill-regexp-backup)
19321 (match-string-no-properties 0))))))
19323 (defun org-auto-fill-function ()
19324 "Auto-fill function."
19325 (let (itemp prefix)
19326 ;; When in a list, compute an appropriate fill-prefix and make
19327 ;; sure it will be used by `do-auto-fill'.
19328 (if (setq itemp (org-in-item-p))
19329 (progn
19330 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19331 (flet ((fill-context-prefix (from to &optional flr) prefix))
19332 (do-auto-fill)))
19333 ;; Else just use `do-auto-fill'.
19334 (do-auto-fill))))
19336 ;;; Other stuff.
19338 (defun org-toggle-fixed-width-section (arg)
19339 "Toggle the fixed-width export.
19340 If there is no active region, the QUOTE keyword at the current headline is
19341 inserted or removed. When present, it causes the text between this headline
19342 and the next to be exported as fixed-width text, and unmodified.
19343 If there is an active region, this command adds or removes a colon as the
19344 first character of this line. If the first character of a line is a colon,
19345 this line is also exported in fixed-width font."
19346 (interactive "P")
19347 (let* ((cc 0)
19348 (regionp (org-region-active-p))
19349 (beg (if regionp (region-beginning) (point)))
19350 (end (if regionp (region-end)))
19351 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19352 (case-fold-search nil)
19354 off)
19355 (if regionp
19356 (save-excursion
19357 (goto-char beg)
19358 (setq cc (current-column))
19359 (beginning-of-line 1)
19360 (setq off (looking-at re))
19361 (while (> nlines 0)
19362 (setq nlines (1- nlines))
19363 (beginning-of-line 1)
19364 (cond
19365 (arg
19366 (org-move-to-column cc t)
19368 (forward-line -1))
19369 ((and off (looking-at re))
19370 (replace-match "" t t nil 1))
19371 ((not off) (org-move-to-column cc t) (insert ": ")))
19372 (forward-line 1)))
19373 (save-excursion
19374 (org-back-to-heading)
19375 (if (looking-at (concat outline-regexp
19377 (replace-match "" t t nil 1)
19378 (if (looking-at outline-regexp)
19379 (progn
19380 (goto-char (match-end 0))
19381 (insert org-quote-string " "))))))))
19383 (defun org-reftex-citation ()
19384 "Use reftex-citation to insert a citation into the buffer.
19385 This looks for a line like
19387 #+BIBLIOGRAPHY: foo plain option:-d
19389 and derives from it that foo.bib is the bibliography file relevant
19390 for this document. It then installs the necessary environment for RefTeX
19391 to work in this buffer and calls `reftex-citation' to insert a citation
19392 into the buffer.
19394 Export of such citations to both LaTeX and HTML is handled by the contributed
19395 package org-exp-bibtex by Taru Karttunen."
19396 (interactive)
19397 (let ((reftex-docstruct-symbol 'rds)
19399 rds bib)
19400 (save-excursion
19401 (save-restriction
19402 (widen)
19403 (let ((case-fold-search t)
19405 (if (not (save-excursion
19406 (or (re-search-forward re nil t)
19407 (re-search-backward re nil t))))
19408 (error "No bibliography defined in file")
19409 (setq bib (concat (match-string 1) ".bib")
19410 rds (list (list 'bib bib)))))))
19411 (call-interactively 'reftex-citation)))
19413 ;;;; Functions extending outline functionality
19415 (defun org-beginning-of-line (&optional arg)
19416 "Go to the beginning of the current line. If that is invisible, continue
19417 to a visible line beginning. This makes the function of C-a more intuitive.
19418 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19419 first attempt, and only move to after the tags when the cursor is already
19420 beyond the end of the headline."
19421 (interactive "P")
19422 (let ((pos (point))
19423 (special (if (consp org-special-ctrl-a/e)
19424 (car org-special-ctrl-a/e)
19425 org-special-ctrl-a/e))
19426 refpos)
19427 (if (org-bound-and-true-p line-move-visual)
19428 (beginning-of-visual-line 1)
19429 (beginning-of-line 1))
19430 (if (and arg (fboundp 'move-beginning-of-line))
19431 (call-interactively 'move-beginning-of-line)
19432 (if (bobp)
19433 nil
19434 (backward-char 1)
19435 (if (org-truely-invisible-p)
19436 (while (and (not (bobp)) (org-truely-invisible-p))
19437 (backward-char 1)
19438 (beginning-of-line 1))
19439 (forward-char 1))))
19440 (when special
19441 (cond
19442 ((and (looking-at org-complex-heading-regexp)
19443 (= (char-after (match-end 1)) ?\ ))
19444 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19445 (point-at-eol)))
19446 (goto-char
19447 (if (eq special t)
19448 (cond ((> pos refpos) refpos)
19449 ((= pos (point)) refpos)
19450 (t (point)))
19451 (cond ((> pos (point)) (point))
19452 ((not (eq last-command this-command)) (point))
19453 (t refpos)))))
19454 ((org-at-item-p)
19455 (goto-char
19456 (if (eq special t)
19457 (cond ((> pos (match-end 0)) (match-end 0))
19458 ((= pos (point)) (match-end 0))
19459 (t (point)))
19460 (cond ((> pos (point)) (point))
19461 ((not (eq last-command this-command)) (point))
19462 (t (match-end 0))))))))
19463 (org-no-warnings
19464 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19466 (defun org-end-of-line (&optional arg)
19467 "Go to the end of the line.
19468 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19469 first attempt, and only move to after the tags when the cursor is already
19470 beyond the end of the headline."
19471 (interactive "P")
19472 (let ((special (if (consp org-special-ctrl-a/e)
19473 (cdr org-special-ctrl-a/e)
19474 org-special-ctrl-a/e)))
19475 (if (or (not special)
19476 (not (org-on-heading-p))
19477 arg)
19478 (call-interactively
19479 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19480 ((fboundp 'move-end-of-line) 'move-end-of-line)
19481 (t 'end-of-line)))
19482 (let ((pos (point)))
19483 (beginning-of-line 1)
19485 (if (eq special t)
19486 (if (or (< pos (match-beginning 1))
19487 (= pos (match-end 0)))
19488 (goto-char (match-beginning 1))
19489 (goto-char (match-end 0)))
19490 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19491 (goto-char (match-end 0))
19492 (goto-char (match-beginning 1))))
19493 (call-interactively (if (fboundp 'move-end-of-line)
19494 'move-end-of-line
19495 'end-of-line)))))
19496 (org-no-warnings
19497 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19499 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19500 (define-key org-mode-map "\C-e" 'org-end-of-line)
19502 (defun org-backward-sentence (&optional arg)
19503 "Go to beginning of sentence, or beginning of table field.
19504 This will call `backward-sentence' or `org-table-beginning-of-field',
19505 depending on context."
19506 (interactive "P")
19507 (cond
19508 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19509 (t (call-interactively 'backward-sentence))))
19511 (defun org-forward-sentence (&optional arg)
19512 "Go to end of sentence, or end of table field.
19513 This will call `forward-sentence' or `org-table-end-of-field',
19514 depending on context."
19515 (interactive "P")
19516 (cond
19517 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19518 (t (call-interactively 'forward-sentence))))
19520 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19521 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19523 (defun org-kill-line (&optional arg)
19524 "Kill line, to tags or end of line."
19525 (interactive "P")
19526 (cond
19527 ((or (not org-special-ctrl-k)
19528 (bolp)
19529 (not (org-on-heading-p)))
19530 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19531 org-ctrl-k-protect-subtree)
19532 (if (or (eq org-ctrl-k-protect-subtree 'error)
19533 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19534 (error "C-k aborted - would kill hidden subtree")))
19535 (call-interactively 'kill-line))
19537 (kill-region (point) (match-beginning 1))
19538 (org-set-tags nil t))
19539 (t (kill-region (point) (point-at-eol)))))
19541 (define-key org-mode-map "\C-k" 'org-kill-line)
19543 (defun org-yank (&optional arg)
19544 "Yank. If the kill is a subtree, treat it specially.
19545 This command will look at the current kill and check if is a single
19546 subtree, or a series of subtrees[1]. If it passes the test, and if the
19547 cursor is at the beginning of a line or after the stars of a currently
19548 empty headline, then the yank is handled specially. How exactly depends
19549 on the value of the following variables, both set by default.
19551 org-yank-folded-subtrees
19552 When set, the subtree(s) will be folded after insertion, but only
19553 if doing so would now swallow text after the yanked text.
19555 org-yank-adjusted-subtrees
19556 When set, the subtree will be promoted or demoted in order to
19557 fit into the local outline tree structure, which means that the level
19558 will be adjusted so that it becomes the smaller one of the two
19559 *visible* surrounding headings.
19561 Any prefix to this command will cause `yank' to be called directly with
19563 will just
19564 plainly yank the text as it is.
19566 \[1] The test checks if the first non-white line is a heading
19567 and if there are no other headings with fewer stars."
19568 (interactive "P")
19569 (org-yank-generic 'yank arg))
19571 (defun org-yank-generic (command arg)
19572 "Perform some yank-like command.
19574 This function implements the behavior described in the `org-yank'
19575 documentation. However, it has been generalized to work for any
19576 interactive command with similar behavior."
19578 ;; pretend to be command COMMAND
19579 (setq this-command command)
19581 (if arg
19582 (call-interactively command)
19584 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19585 (and (org-kill-is-subtree-p)
19586 (or (bolp)
19588 (string-match
19590 (buffer-substring (point-at-bol) (point)))))))
19591 swallowp)
19592 (cond
19593 ((and subtreep org-yank-folded-subtrees)
19594 (let ((beg (point))
19595 end)
19596 (if (and subtreep org-yank-adjusted-subtrees)
19597 (org-paste-subtree nil nil 'for-yank)
19598 (call-interactively command))
19600 (setq end (point))
19601 (goto-char beg)
19602 (when (and (bolp) subtreep
19603 (not (setq swallowp
19604 (org-yank-folding-would-swallow-text beg end))))
19605 (or (looking-at outline-regexp)
19606 (re-search-forward (concat "^" outline-regexp) end t))
19607 (while (and (< (point) end) (looking-at outline-regexp))
19608 (hide-subtree)
19609 (org-cycle-show-empty-lines 'folded)
19610 (condition-case nil
19611 (outline-forward-same-level 1)
19612 (error (goto-char end)))))
19613 (when swallowp
19614 (message
19615 "Inserted text not folded because that would swallow text"))
19617 (goto-char end)
19619 (beginning-of-line 1)
19620 (push-mark beg 'nomsg)))
19621 ((and subtreep org-yank-adjusted-subtrees)
19622 (let ((beg (point-at-bol)))
19623 (org-paste-subtree nil nil 'for-yank)
19624 (push-mark beg 'nomsg)))
19625 (t
19626 (call-interactively command))))))
19628 (defun org-yank-folding-would-swallow-text (beg end)
19629 "Would hide-subtree at BEG swallow any text after END?"
19630 (let (level)
19631 (save-excursion
19632 (goto-char beg)
19633 (when (or (looking-at outline-regexp)
19634 (re-search-forward (concat "^" outline-regexp) end t))
19635 (setq level (org-outline-level)))
19636 (goto-char end)
19638 (if (or (eobp)
19639 (and (bolp) (looking-at org-outline-regexp)
19640 (<= (org-outline-level) level)))
19641 nil ; Nothing would be swallowed
19642 t)))) ; something would swallow
19644 (define-key org-mode-map "\C-y" 'org-yank)
19646 (defun org-truely-invisible-p ()
19647 "Check if point is at a character currently not visible.
19648 This version does not only check the character property, but also
19649 `visible-mode'."
19650 ;; Early versions of noutline don't have `outline-invisible-p'.
19651 (if (org-bound-and-true-p visible-mode)
19652 nil
19653 (outline-invisible-p)))
19655 (defun org-invisible-p2 ()
19656 "Check if point is at a character currently not visible."
19657 (save-excursion
19658 (if (and (eolp) (not (bobp))) (backward-char 1))
19659 ;; Early versions of noutline don't have `outline-invisible-p'.
19660 (outline-invisible-p)))
19662 (defun org-back-to-heading (&optional invisible-ok)
19663 "Call `outline-back-to-heading', but provide a better error message."
19664 (condition-case nil
19665 (outline-back-to-heading invisible-ok)
19666 (error (error "Before first headline at position %d in buffer %s"
19667 (point) (current-buffer)))))
19669 (defun org-beginning-of-defun ()
19670 "Go to the beginning of the subtree, i.e. back to the heading."
19671 (org-back-to-heading))
19672 (defun org-end-of-defun ()
19673 "Go to the end of the subtree."
19674 (org-end-of-subtree nil t))
19676 (defun org-before-first-heading-p ()
19677 "Before first heading?"
19678 (save-excursion
19679 (end-of-line)
19682 (defun org-on-heading-p (&optional ignored)
19683 (outline-on-heading-p t))
19684 (defun org-at-heading-p (&optional ignored)
19685 (outline-on-heading-p t))
19687 (defun org-point-at-end-of-empty-headline ()
19688 "If point is at the end of an empty headline, return t, else nil.
19689 If the heading only contains a TODO keyword, it is still still considered
19690 empty."
19692 (save-excursion
19693 (beginning-of-line 1)
19694 (let ((case-fold-search nil))
19697 (defun org-at-heading-or-item-p ()
19698 (or (org-on-heading-p) (org-at-item-p)))
19700 (defun org-on-target-p ()
19701 (or (org-in-regexp org-radio-target-regexp)
19702 (org-in-regexp org-target-regexp)))
19704 (defun org-up-heading-all (arg)
19705 "Move to the heading line of which the present line is a subheading.
19706 This function considers both visible and invisible heading lines.
19707 With argument, move up ARG levels."
19708 (if (fboundp 'outline-up-heading-all)
19709 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19710 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19712 (defun org-up-heading-safe ()
19713 "Move to the heading line of which the present line is a subheading.
19714 This version will not throw an error. It will return the level of the
19715 headline found, or nil if no higher level is found.
19717 Also, this function will be a lot faster than `outline-up-heading',
19718 because it relies on stars being the outline starters. This can really
19719 make a significant difference in outlines with very many siblings."
19720 (let (start-level re)
19721 (org-back-to-heading t)
19722 (setq start-level (funcall outline-level))
19723 (if (equal start-level 1)
19724 nil
19726 (if (re-search-backward re nil t)
19727 (funcall outline-level)))))
19729 (defun org-first-sibling-p ()
19730 "Is this heading the first child of its parents?"
19731 (interactive)
19732 (let ((re (concat "^" outline-regexp))
19733 level l)
19734 (unless (org-at-heading-p t)
19735 (error "Not at a heading"))
19736 (setq level (funcall outline-level))
19737 (save-excursion
19738 (if (not (re-search-backward re nil t))
19739 t
19740 (setq l (funcall outline-level))
19741 (< l level)))))
19743 (defun org-goto-sibling (&optional previous)
19744 "Goto the next sibling, even if it is invisible.
19745 When PREVIOUS is set, go to the previous sibling instead. Returns t
19746 when a sibling was found. When none is found, return nil and don't
19747 move point."
19748 (let ((fun (if previous 're-search-backward 're-search-forward))
19749 (pos (point))
19750 (re (concat "^" outline-regexp))
19751 level l)
19752 (when (condition-case nil (org-back-to-heading t) (error nil))
19753 (setq level (funcall outline-level))
19754 (catch 'exit
19755 (or previous (forward-char 1))
19756 (while (funcall fun re nil t)
19757 (setq l (funcall outline-level))
19758 (when (< l level) (goto-char pos) (throw 'exit nil))
19759 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19760 (goto-char pos)
19761 nil))))
19763 (defun org-show-siblings ()
19764 "Show all siblings of the current headline."
19765 (save-excursion
19766 (while (org-goto-sibling) (org-flag-heading nil)))
19767 (save-excursion
19768 (while (org-goto-sibling 'previous)
19769 (org-flag-heading nil))))
19771 (defun org-goto-first-child ()
19772 "Goto the first child, even if it is invisible.
19773 Return t when a child was found. Otherwise don't move point and
19774 return nil."
19775 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19776 (when (condition-case nil (org-back-to-heading t) (error nil))
19777 (setq level (outline-level))
19778 (forward-char 1)
19779 (if (and (re-search-forward re nil t) (> (outline-level) level))
19780 (progn (goto-char (match-beginning 0)) t)
19781 (goto-char pos) nil))))
19783 (defun org-show-hidden-entry ()
19784 "Show an entry where even the heading is hidden."
19785 (save-excursion
19786 (org-show-entry)))
19788 (defun org-flag-heading (flag &optional entry)
19789 "Flag the current heading. FLAG non-nil means make invisible.
19790 When ENTRY is non-nil, show the entire entry."
19791 (save-excursion
19792 (org-back-to-heading t)
19793 ;; Check if we should show the entire entry
19794 (if entry
19795 (progn
19796 (org-show-entry)
19797 (save-excursion
19798 (and (outline-next-heading)
19799 (org-flag-heading nil))))
19800 (outline-flag-region (max (point-min) (1- (point)))
19801 (save-excursion (outline-end-of-heading) (point))
19802 flag))))
19804 (defun org-get-next-sibling ()
19805 "Move to next heading of the same level, and return point.
19806 If there is no such heading, return nil.
19807 This is like outline-next-sibling, but invisible headings are ok."
19808 (let ((level (funcall outline-level)))
19809 (outline-next-heading)
19810 (while (and (not (eobp)) (> (funcall outline-level) level))
19811 (outline-next-heading))
19812 (if (or (eobp) (< (funcall outline-level) level))
19813 nil
19814 (point))))
19816 (defun org-get-last-sibling ()
19817 "Move to previous heading of the same level, and return point.
19818 If there is no such heading, return nil."
19819 (let ((opoint (point))
19820 (level (funcall outline-level)))
19821 (outline-previous-heading)
19822 (when (and (/= (point) opoint) (outline-on-heading-p t))
19823 (while (and (> (funcall outline-level) level)
19824 (not (bobp)))
19825 (outline-previous-heading))
19826 (if (< (funcall outline-level) level)
19827 nil
19828 (point)))))
19830 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19831 ;; This contains an exact copy of the original function, but it uses
19832 ;; `org-back-to-heading', to make it work also in invisible
19833 ;; trees. And is uses an invisible-OK argument.
19834 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19835 ;; Furthermore, when used inside Org, finding the end of a large subtree
19836 ;; with many children and grandchildren etc, this can be much faster
19837 ;; than the outline version.
19838 (org-back-to-heading invisible-OK)
19839 (let ((first t)
19840 (level (funcall outline-level)))
19841 (if (and (org-mode-p) (< level 1000))
19842 ;; A true heading (not a plain list item), in Org-mode
19843 ;; This means we can easily find the end by looking
19844 ;; only for the right number of stars. Using a regexp to do
19845 ;; this is so much faster than using a Lisp loop.
19847 (forward-char 1)
19848 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19849 ;; something else, do it the slow way
19850 (while (and (not (eobp))
19851 (or first (> (funcall outline-level) level)))
19852 (setq first nil)
19853 (outline-next-heading)))
19854 (unless to-heading
19856 (progn
19857 ;; Go to end of line before heading
19858 (forward-char -1)
19860 ;; leave blank line before heading
19861 (forward-char -1))))))
19862 (point))
19864 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19865 "Use Org version in org-mode, for dramatic speed-up."
19866 (if (org-mode-p)
19867 (progn
19868 (org-end-of-subtree nil t)
19869 (unless (eobp) (backward-char 1)))
19870 ad-do-it))
19872 (defun org-end-of-meta-data-and-drawers ()
19873 "Jump to the first text after meta data and drawers in the current entry.
19874 This will move over empty lines, lines with planning time stamps,
19875 clocking lines, and drawers."
19876 (org-back-to-heading t)
19877 (let ((end (save-excursion (outline-next-heading) (point)))
19883 (forward-line 1)
19885 (if (not (match-end 1))
19886 ;; empty or planning line
19887 (forward-line 1)
19888 ;; a drawer, find the end
19890 (forward-line 1)))
19891 (point)))
19893 (defun org-forward-same-level (arg &optional invisible-ok)
19894 "Move forward to the arg'th subheading at same level as this one.
19895 Stop at the first and last subheadings of a superior heading.
19896 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19897 it wil also look at invisible ones."
19898 (interactive "p")
19899 (org-back-to-heading invisible-ok)
19900 (org-on-heading-p)
19901 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19903 l)
19904 (forward-char 1)
19905 (while (> arg 0)
19906 (while (and (re-search-forward re nil 'move)
19907 (setq l (- (match-end 0) (match-beginning 0) 1))
19908 (= l level)
19909 (not invisible-ok)
19910 (progn (backward-char 1) (outline-invisible-p)))
19911 (if (< l level) (setq arg 1)))
19912 (setq arg (1- arg)))
19913 (beginning-of-line 1)))
19915 (defun org-backward-same-level (arg &optional invisible-ok)
19916 "Move backward to the arg'th subheading at same level as this one.
19917 Stop at the first and last subheadings of a superior heading."
19918 (interactive "p")
19919 (org-back-to-heading)
19920 (org-on-heading-p)
19921 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19923 l)
19924 (while (> arg 0)
19925 (while (and (re-search-backward re nil 'move)
19926 (setq l (- (match-end 0) (match-beginning 0) 1))
19927 (= l level)
19928 (not invisible-ok)
19929 (outline-invisible-p))
19930 (if (< l level) (setq arg 1)))
19931 (setq arg (1- arg)))))
19933 (defun org-show-subtree ()
19934 "Show everything after this heading at deeper levels."
19935 (outline-flag-region
19936 (point)
19937 (save-excursion
19938 (org-end-of-subtree t t))
19939 nil))
19941 (defun org-show-entry ()
19942 "Show the body directly following this heading.
19943 Show the heading too, if it is currently invisible."
19944 (interactive)
19945 (save-excursion
19946 (condition-case nil
19947 (progn
19948 (org-back-to-heading t)
19949 (outline-flag-region
19950 (max (point-min) (1- (point)))
19951 (save-excursion
19952 (if (re-search-forward
19954 (match-beginning 1)
19955 (point-max)))
19956 nil)
19957 (org-cycle-hide-drawers 'children))
19958 (error nil))))
19960 (defun org-make-options-regexp (kwds &optional extra)
19961 "Make a regular expression for keyword lines."
19962 (concat
19963 "^"
19970 ;; Make isearch reveal the necessary context
19971 (defun org-isearch-end ()
19972 "Reveal context after isearch exits."
19973 (when isearch-success ; only if search was successful
19974 (if (featurep 'xemacs)
19975 ;; Under XEmacs, the hook is run in the correct place,
19976 ;; we directly show the context.
19977 (org-show-context 'isearch)
19978 ;; In Emacs the hook runs *before* restoring the overlays.
19979 ;; So we have to use a one-time post-command-hook to do this.
19980 ;; (Emacs 22 has a special variable, see function `org-mode')
19981 (unless (and (boundp 'isearch-mode-end-hook-quit)
19982 isearch-mode-end-hook-quit)
19983 ;; Only when the isearch was not quitted.
19984 (org-add-hook 'post-command-hook 'org-isearch-post-command
19985 'append 'local)))))
19987 (defun org-isearch-post-command ()
19988 "Remove self from hook, and show context."
19989 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19990 (org-show-context 'isearch))
19993 ;;;; Integration with and fixes for other packages
19995 ;;; Imenu support
19997 (defvar org-imenu-markers nil
19998 "All markers currently used by Imenu.")
19999 (make-variable-buffer-local 'org-imenu-markers)
20001 (defun org-imenu-new-marker (&optional pos)
20002 "Return a new marker for use by Imenu, and remember the marker."
20003 (let ((m (make-marker)))
20004 (move-marker m (or pos (point)))
20005 (push m org-imenu-markers)
20006 m))
20008 (defun org-imenu-get-tree ()
20009 "Produce the index for Imenu."
20010 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20011 (setq org-imenu-markers nil)
20012 (let* ((n org-imenu-depth)
20013 (re (concat "^" outline-regexp))
20014 (subs (make-vector (1+ n) nil))
20015 (last-level 0)
20016 m level head)
20017 (save-excursion
20018 (save-restriction
20019 (widen)
20020 (goto-char (point-max))
20021 (while (re-search-backward re nil t)
20022 (setq level (org-reduced-level (funcall outline-level)))
20023 (when (<= level n)
20024 (looking-at org-complex-heading-regexp)
20025 (setq head (org-link-display-format
20026 (org-match-string-no-properties 4))
20027 m (org-imenu-new-marker))
20028 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20029 (if (>= level last-level)
20030 (push (cons head m) (aref subs level))
20031 (push (cons head (aref subs (1+ level))) (aref subs level))
20032 (loop for i from (1+ level) to n do (aset subs i nil)))
20033 (setq last-level level)))))
20034 (aref subs 1)))
20036 (eval-after-load "imenu"
20037 '(progn
20038 (add-hook 'imenu-after-jump-hook
20039 (lambda ()
20040 (if (org-mode-p)
20041 (org-show-context 'org-goto))))))
20043 (defun org-link-display-format (link)
20044 "Replace a link with either the description, or the link target
20045 if no description is present"
20046 (save-match-data
20047 (if (string-match org-bracket-link-analytic-regexp link)
20048 (replace-match (if (match-end 5)
20049 (match-string 5 link)
20050 (concat (match-string 1 link)
20051 (match-string 3 link)))
20052 nil t link)
20053 link)))
20055 ;; Speedbar support
20057 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20058 "Overlay marking the agenda restriction line in speedbar.")
20059 (overlay-put org-speedbar-restriction-lock-overlay
20060 'face 'org-agenda-restriction-lock)
20061 (overlay-put org-speedbar-restriction-lock-overlay
20062 'help-echo "Agendas are currently limited to this item.")
20063 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20065 (defun org-speedbar-set-agenda-restriction ()
20066 "Restrict future agenda commands to the location at point in speedbar.
20068 (interactive)
20069 (require 'org-agenda)
20070 (let (p m tp np dir txt)
20071 (cond
20072 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20073 'org-imenu t))
20074 (setq m (get-text-property p 'org-imenu-marker))
20075 (with-current-buffer (marker-buffer m)
20076 (goto-char m)
20077 (org-agenda-set-restriction-lock 'subtree)))
20078 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20079 'speedbar-function 'speedbar-find-file))
20080 (setq tp (previous-single-property-change
20081 (1+ p) 'speedbar-function)
20082 np (next-single-property-change
20083 tp 'speedbar-function)
20084 dir (speedbar-line-directory)
20085 txt (buffer-substring-no-properties (or tp (point-min))
20086 (or np (point-max))))
20087 (with-current-buffer (find-file-noselect
20088 (let ((default-directory dir))
20089 (expand-file-name txt)))
20090 (unless (org-mode-p)
20091 (error "Cannot restrict to non-Org-mode file"))
20092 (org-agenda-set-restriction-lock 'file)))
20093 (t (error "Don't know how to restrict Org-mode's agenda")))
20094 (move-overlay org-speedbar-restriction-lock-overlay
20095 (point-at-bol) (point-at-eol))
20096 (setq current-prefix-arg nil)
20097 (org-agenda-maybe-redo)))
20099 (eval-after-load "speedbar"
20100 '(progn
20101 (speedbar-add-supported-extension ".org")
20102 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20103 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20104 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20105 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20106 (add-hook 'speedbar-visiting-tag-hook
20107 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20109 ;;; Fixes and Hacks for problems with other packages
20111 ;; Make flyspell not check words in links, to not mess up our keymap
20112 (defun org-mode-flyspell-verify ()
20113 "Don't let flyspell put overlays at active buttons."
20114 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
20115 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
20117 (defun org-remove-flyspell-overlays-in (beg end)
20118 "Remove flyspell overlays in region."
20119 (and (org-bound-and-true-p flyspell-mode)
20120 (fboundp 'flyspell-delete-region-overlays)
20121 (flyspell-delete-region-overlays beg end))
20122 (add-text-properties beg end '(org-no-flyspell t)))
20124 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20125 (eval-after-load "bookmark"
20126 '(if (boundp 'bookmark-after-jump-hook)
20127 ;; We can use the hook
20128 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20129 ;; Hook not available, use advice
20130 (defadvice bookmark-jump (after org-make-visible activate)
20131 "Make the position visible."
20132 (org-bookmark-jump-unhide))))
20134 ;; Make sure saveplace shows the location if it was hidden
20135 (eval-after-load "saveplace"
20136 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20137 "Make the position visible."
20138 (org-bookmark-jump-unhide)))
20140 ;; Make sure ecb shows the location if it was hidden
20141 (eval-after-load "ecb"
20142 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20143 "Make hierarchy visible when jumping into location from ECB tree buffer."
20144 (if (org-mode-p)
20145 (org-show-context))))
20147 (defun org-bookmark-jump-unhide ()
20148 "Unhide the current position, to show the bookmark location."
20149 (and (org-mode-p)
20150 (or (outline-invisible-p)
20151 (save-excursion (goto-char (max (point-min) (1- (point))))
20152 (outline-invisible-p)))
20153 (org-show-context 'bookmark-jump)))
20155 ;; Make session.el ignore our circular variable
20156 (eval-after-load "session"
20157 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20159 ;;;; Experimental code
20161 (defun org-closed-in-range ()
20162 "Sparse tree of items closed in a certain time range.
20163 Still experimental, may disappear in the future."
20164 (interactive)
20165 ;; Get the time interval from the user.
20166 (let* ((time1 (org-float-time
20167 (org-read-date nil 'to-time nil "Starting date: ")))
20168 (time2 (org-float-time
20169 (org-read-date nil 'to-time nil "End date:")))
20170 ;; callback function
20171 (callback (lambda ()
20172 (let ((time
20173 (org-float-time
20174 (apply 'encode-time
20175 (org-parse-time-string
20176 (match-string 1))))))
20177 ;; check if time in interval
20178 (and (>= time time1) (<= time time2))))))
20179 ;; make tree, check each match with the callback
20182 ;;;; Finish up
20184 (provide 'org)
20186 (run-hooks 'org-load-hook)
20188 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20190 ;;; org.el ends here