| blob | 27a3949448ac7437607b4e3718e48bb2873e8f32 |
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
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)
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
5200 ; end of source block
5208 t))
5221 ;; just any other in-buffer setting, but not indented
5225 t)
5233 t)
5241 "Run through the buffer and add overlays to links."
5249 t)))
5252 "Run through the buffer and add overlays to links."
5254 limit t)
5259 'keymap org-mouse-map
5260 'help-echo
5262 "Footnote definition"
5264 ))
5266 t)))
5269 "Run through the buffer and add overlays to bracketed links."
5273 ;; FIXME: above we should remove the escapes.
5274 ;; but that requires another match, protecting match data,
5275 ;; a lot of overhead for font-lock.
5282 ;; We need to remove the invisible property here. Table narrowing
5283 ;; may have made some of this invisible.
5301 t)))
5304 "Run through the buffer and add overlays to dates."
5316 t)))
5325 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5329 "Run through the buffer and add overlays to target matches."
5337 'keymap org-mouse-map
5341 t)))))
5344 "Find all radio targets in this file and update the regular expression."
5359 t)))
5366 ;; This should be with the exporter code, but we also use if for font-locking
5376 "Compute regular expression for stuff treated specially by exporters."
5383 org-latex-regexps)))
5411 org-entities)))
5415 org-latex-entities)
5416 nil))
5418 ))
5419 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5422 org-export-html-special-string-regexps)))
5427 ))))
5429 'org-latex-and-specials-regexp
5434 "Run through the buffer and add overlays to links."
5438 limit t))
5452 rtn)))
5455 "Restart `font-lock-mode', to force refontification."
5461 "Return a list of all targets in this file.
5462 With optional argument RADIO, only find radio targets."
5464 rtn)
5469 rtn)))
5472 "Make regular expression matching all strings in TARGETS.
5473 The regular expression finds the targets also if there is a line break
5474 between words."
5483 x)
5484 targets
5496 t)))
5499 "Compute the outline level of the heading at point.
5500 This function assumes that the cursor is at the beginning of a line matched
5501 by `outline-regexp'. Otherwise it returns garbage.
5502 If this is called at a normal headline, the level is the number of stars.
5503 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5510 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5517 "Functions that can manipulate `org-font-lock-extra-keywords'.
5518 This is calles after `org-font-lock-extra-keywords' is defined, but before
5519 it is installed to be used by font lock. This can be useful if something
5530 ;; Call the hook
5532 ;; Headlines
5539 ;; Table lines
5542 ;; Table internals
5547 ;; Drawers
5550 ;; Properties
5554 ;; Links
5565 ;; TODO lines
5568 ;; DONE
5574 nil)
5575 ;; Priorities
5577 ;; Tags
5579 ;; Special keywords
5584 ;; Emphasis
5589 ;; Checkboxes
5590 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5595 ;; Description list items
5598 ;; ARCHIVEd headings
5601 ;; Specials
5605 ;; Code
5607 ;; COMMENT
5612 ;; Blocks and meta lines
5614 )))
5617 ;; Now set the full font-lock-keywords
5624 "Toggle the composition display of entities as UTF8 characters."
5636 "Find an entity to fontify."
5642 limit t)
5654 nil))))
5657 "Fontify string S like in Org-mode."
5669 "Get the right face for match N in font-lock matching of headlines."
5682 "Get the right face for a TODO keyword KWD.
5683 If KWD is a number, get the corresponding match group."
5691 "Create a face list that inherits INHERIT, but sets the foreground color.
5692 When FACE-OR-COLOR is not a string, just return it."
5696 face-or-color)
5697 face-or-color))
5700 "Add the special tag faces."
5709 "Add the special priority faces."
5716 org-priority-faces)))
5721 "Get the right face for a TODO keyword KWD.
5722 If KWD is a number, get the corresponding match group."
5729 "Remove fontification and activation overlays from links."
5734 deactivate-mark buffer-file-name buffer-file-truename)
5737 beg end
5739 ;; also remove line-prefix and wrap-prefix properties
5741 invisible t intangible t
5742 line-prefix t wrap-prefix t
5743 org-no-flyspell t org-emphasis t)
5745 invisible t intangible t
5746 org-no-flyspell t org-emphasis t)))
5756 "Remove specific display properties that have been added by font lock.
5757 The will remove the raise properties that are used to show superscripts
5758 and subscripts."
5768 "Add raise properties to sub/superscripts."
5772 org-match-substring-regexp
5773 org-match-substring-with-braces-regexp)
5774 limit t)
5784 ;; FIXME: Should we go back one character here, for a_b^c
5785 ;; (goto-char (1- pos)) ;????????????????????
5787 t
5789 'display
5805 t)))))
5807 ;;;; Visibility cycling, including org-goto and indirect buffer
5809 ;;; Cycling
5816 ;;;###autoload
5821 "TAB-action and visibility cycling for Org-mode.
5823 This is the command invoked in Org-mode by the TAB key. Its main purpose
5824 is outline visibility cycling, but it also invokes other actions
5825 in special contexts.
5827 - When this function is called with a prefix argument, rotate the entire
5828 buffer through 3 states (global cycling)
5829 1. OVERVIEW: Show only top-level headlines.
5830 2. CONTENTS: Show all headlines of all levels, but no body text.
5831 3. SHOW ALL: Show everything.
5832 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5833 determined by the variable `org-startup-folded', and by any VISIBILITY
5834 properties in the buffer.
5835 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5836 including any drawers.
5838 - When inside a table, re-align the table and move to the next field.
5840 - When point is at the beginning of a headline, rotate the subtree started
5841 by this line through 3 different states (local cycling)
5842 1. FOLDED: Only the main headline is shown.
5843 2. CHILDREN: The main headline and the direct children are shown.
5844 From this state, you can move to one of the children
5845 and zoom in further.
5846 3. SUBTREE: Show the entire subtree, including body text.
5847 If there is no subtree, switch directly from CHILDREN to FOLDED.
5849 - When point is at the beginning of an empty headline and the variable
5850 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5851 of the headline by demoting and promoting it to likely levels. This
5852 speeds up creation document structure by pressing TAB once or several
5853 times right after creating a new headline.
5855 - When there is a numeric prefix, go up to a heading with level ARG, do
5856 a `show-subtree' and return to the previous cursor position. If ARG
5857 is negative, go up that many levels.
5859 - When point is not at the beginning of a headline, execute the global
5860 binding for TAB, which is re-indenting the line. See the option
5861 `org-cycle-emulate-tab' for details.
5863 - Special case: if point is at the beginning of the buffer and there is
5864 no headline in line 1, this function will act as if called with prefix arg
5865 (C-u TAB, same as S-TAB) also when called without prefix arg.
5866 But only if also the variable `org-cycle-global-at-bob' is t."
5876 org-inlinetask-min-level
5881 limit-level)))
5884 outline-regexp
5892 org-cycle-hook))
5896 ;; special case: use global cycling
5910 ;; Table: enter it or move to the next field.
5921 ;; Global cycling: delegate to `org-cycle-internal-global'.
5924 ;; Drawers: delegate to `org-flag-drawer'.
5932 ;; Show-subtree, ARG levels up from here.
5940 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5946 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5953 ;; From there: TAB emulation and template completion.
5977 t
5986 "Do the global cycling action."
5990 ;; We just created the overview - now do table of contents
5991 ;; This can be slow in very large buffers, so indicate action
6001 ;; We just showed the table of contents - now show everything
6009 ;; Default action: go to overview
6017 "Do the local cycling action."
6019 ;; First, determine end of headline (EOH), end of subtree or item
6020 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6044 ;; Determine end invisible part of buffer (EOL)
6046 ;; XEmacs doesn't have `next-single-char-property-change'
6056 ;; Find out what to do next and set `this-command'
6059 ;; Nothing is hidden behind this heading
6071 org-cycle-skip-children-state-if-no-children))))
6072 ;; Entire subtree is hidden in one line: children view
6078 ;; Fold every list in subtree to top-level items.
6100 ;; We just showed the children, or no children are there,
6101 ;; now show everything.
6108 ;; Default action: hide the subtree.
6115 ;;;###autoload
6117 "Cycle the global visibility. For details see `org-cycle'.
6119 With a numeric prefix, show all headlines up to that level."
6135 "Set the visibility required by startup options and properties."
6150 "Switch subtree visibilities according to :VISIBILITY: property."
6157 nil t)
6182 "Switch to overview mode, showing only top-level headlines.
6183 Really, this shows all headlines with level equal or greater than the level
6184 of the first headline in the buffer. This is important, because if the
6185 first headline is not level one, then (hide-sublevels 1) gives confusing
6186 results."
6197 "Show all headlines in the buffer, like a table of contents.
6198 With numerical argument N, show content up to level N."
6201 ;; Visit all headings and show their offspring
6208 t)
6217 "Adjust the window after a change in outline visibility.
6218 This function is the default value of the hook `org-cycle-hook'."
6228 "Remove outline overlays that do not contain non-white stuff."
6238 "Fix visibility issues after moving a subtree."
6239 ;; First, find a reasonable region to look at:
6240 ;; Start two siblings above, end three below
6258 ;; Properly fold already folded siblings
6269 "Show empty lines above all visible headlines.
6270 The region to be covered depends on STATE when called through
6271 `org-cycle-hook'. Lisp program can use t for STATE to get the
6272 entire buffer covered. Note that an empty line is only shown if there
6273 are at least `org-cycle-separator-lines' empty lines before the headline."
6283 beg end b e)
6307 ;; Never hide empty lines at the end of the file.
6317 "Move to the parent and re-show empty lines before visible headlines."
6323 "Return `org-agenda-files' list, plus all open org-mode files.
6324 This is useful for operations that need to scan all of a user's
6325 open and agenda-wise Org files."
6333 files))
6336 "Return the beginning position of the current entry."
6340 "Return the end position of the current entry."
6344 "Re-hide all drawers after a visibility state change."
6371 "Is the end of the current subtree visible?"
6376 "Move cursor to the first headline and recenter the headline.
6377 Optional argument N means put the headline into the Nth line of the window."
6383 ;;; Saving and restoring visibility
6386 "Return a list of the locations of all outline overlays.
6387 These are overlays with the `invisible' property value `outline'.
6388 The return value is a list of cons cells, with start and stop
6389 positions for each overlay.
6390 If USE-MARKERS is set, return the positions as markers."
6408 "Create visibility overlays for all positions in DATA.
6409 DATA should have been made by `org-outline-overlay-data'."
6418 data)))))
6420 ;;; Folding of blocks
6431 "Call FUNCTION at the head of all source blocks in the current buffer.
6432 Optional arguments START and END can be used to limit the range."
6444 "Toggle the visibility of all blocks in the current buffer."
6448 "Fold all blocks in the current buffer."
6454 "Unfold all blocks in the current buffer."
6460 "Toggle visibility of block at point."
6471 "Toggle the visibility of the current block."
6478 ov)
6494 ;; make the block accessible to isearch
6496 ov 'isearch-open-invisible
6507 ;; org-tab-after-check-for-cycling-hook
6509 ;; Remove overlays when changing major mode
6514 ;;; Org-goto
6520 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6536 nil)
6537 (org-defkey map "q" 'org-goto-quit)
6538 (org-defkey map "n" 'outline-next-visible-heading)
6539 (org-defkey map "p" 'outline-previous-visible-heading)
6540 (org-defkey map "f" 'outline-forward-same-level)
6541 (org-defkey map "b" 'outline-backward-same-level)
6542 (org-defkey map "u" 'outline-up-heading))
6543 (org-defkey map "/" 'org-occur)
6544 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6545 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6546 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6547 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6548 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6549 map))
6551 (defconst org-goto-help
6552 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6553 RET=jump to location [Q]uit and return to previous location
6554 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6556 (defvar org-goto-start-pos) ; dynamically scoped parameter
6558 ;; FIXME: Docstring does not mention both interfaces
6559 (defun org-goto (&optional alternative-interface)
6560 "Look up a different location in the current file, keeping current visibility.
6562 When you want look-up or go to a different location in a document, the
6563 fastest way is often to fold the entire buffer and then dive into the tree.
6564 This method has the disadvantage, that the previous location will be folded,
6565 which may not be what you want.
6567 This command works around this by showing a copy of the current buffer
6568 in an indirect buffer, in overview mode. You can dive into the tree in
6569 that copy, use org-occur and incremental search to find a location.
6570 When pressing RET or `Q', the command returns to the original buffer in
6571 which the visibility is still unchanged. After RET is will also jump to
6572 the location selected in the indirect buffer and expose the
6573 the headline hierarchy above."
6574 (interactive "P")
6575 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6576 (org-refile-use-outline-path t)
6577 (org-refile-target-verify-function nil)
6578 (interface
6579 (if (not alternative-interface)
6580 org-goto-interface
6581 (if (eq org-goto-interface 'outline)
6582 'outline-path-completion
6583 'outline)))
6584 (org-goto-start-pos (point))
6585 (selected-point
6586 (if (eq interface 'outline)
6587 (car (org-get-location (current-buffer) org-goto-help))
6588 (let ((pa (org-refile-get-location "Goto")))
6589 (org-refile-check-position pa)
6590 (nth 3 pa)))))
6591 (if selected-point
6592 (progn
6593 (org-mark-ring-push org-goto-start-pos)
6594 (goto-char selected-point)
6595 (if (or (outline-invisible-p) (org-invisible-p2))
6596 (org-show-context 'org-goto)))
6597 (message "Quit"))))
6599 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6600 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6601 (defvar org-goto-local-auto-isearch-map) ; defined below
6603 (defun org-get-location (buf help)
6604 "Let the user select a location in the Org-mode buffer BUF.
6605 This function uses a recursive edit. It returns the selected position
6606 or nil."
6607 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6608 (isearch-hide-immediately nil)
6609 (isearch-search-fun-function
6610 (lambda () 'org-goto-local-search-headings))
6611 (org-goto-selected-point org-goto-exit-command)
6612 (pop-up-frames nil)
6613 (special-display-buffer-names nil)
6614 (special-display-regexps nil)
6615 (special-display-function nil))
6616 (save-excursion
6617 (save-window-excursion
6618 (delete-other-windows)
6619 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6620 (switch-to-buffer
6621 (condition-case nil
6622 (make-indirect-buffer (current-buffer) "*org-goto*")
6623 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6624 (with-output-to-temp-buffer "*Help*"
6625 (princ help))
6626 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6627 (setq buffer-read-only nil)
6628 (let ((org-startup-truncated t)
6629 (org-startup-folded nil)
6630 (org-startup-align-all-tables nil))
6631 (org-mode)
6632 (org-overview))
6633 (setq buffer-read-only t)
6634 (if (and (boundp 'org-goto-start-pos)
6635 (integer-or-marker-p org-goto-start-pos))
6636 (let ((org-show-hierarchy-above t)
6637 (org-show-siblings t)
6638 (org-show-following-heading t))
6639 (goto-char org-goto-start-pos)
6640 (and (outline-invisible-p) (org-show-context)))
6641 (goto-char (point-min)))
6642 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6643 (message "Select location and press RET")
6644 (use-local-map org-goto-map)
6645 (recursive-edit)
6646 ))
6647 (kill-buffer "*org-goto*")
6648 (cons org-goto-selected-point org-goto-exit-command)))
6650 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6651 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6652 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6653 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6655 (defun org-goto-local-search-headings (string bound noerror)
6656 "Search and make sure that any matches are in headlines."
6657 (catch 'return
6658 (while (if isearch-forward
6659 (search-forward string bound noerror)
6660 (search-backward string bound noerror))
6661 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6662 (and (member :headline context)
6663 (not (member :tags context))))
6664 (throw 'return (point))))))
6666 (defun org-goto-local-auto-isearch ()
6667 "Start isearch."
6668 (interactive)
6669 (goto-char (point-min))
6670 (let ((keys (this-command-keys)))
6671 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6672 (isearch-mode t)
6673 (isearch-process-search-char (string-to-char keys)))))
6675 (defun org-goto-ret (&optional arg)
6676 "Finish `org-goto' by going to the new location."
6677 (interactive "P")
6678 (setq org-goto-selected-point (point)
6679 org-goto-exit-command 'return)
6680 (throw 'exit nil))
6682 (defun org-goto-left ()
6683 "Finish `org-goto' by going to the new location."
6684 (interactive)
6685 (if (org-on-heading-p)
6686 (progn
6687 (beginning-of-line 1)
6688 (setq org-goto-selected-point (point)
6689 org-goto-exit-command 'left)
6690 (throw 'exit nil))
6691 (error "Not on a heading")))
6693 (defun org-goto-right ()
6694 "Finish `org-goto' by going to the new location."
6695 (interactive)
6696 (if (org-on-heading-p)
6697 (progn
6698 (setq org-goto-selected-point (point)
6699 org-goto-exit-command 'right)
6700 (throw 'exit nil))
6701 (error "Not on a heading")))
6703 (defun org-goto-quit ()
6704 "Finish `org-goto' without cursor motion."
6705 (interactive)
6706 (setq org-goto-selected-point nil)
6707 (setq org-goto-exit-command 'quit)
6708 (throw 'exit nil))
6710 ;;; Indirect buffer display of subtrees
6712 (defvar org-indirect-dedicated-frame nil
6713 "This is the frame being used for indirect tree display.")
6714 (defvar org-last-indirect-buffer nil)
6716 (defun org-tree-to-indirect-buffer (&optional arg)
6717 "Create indirect buffer and narrow it to current subtree.
6718 With numerical prefix ARG, go up to this level and then take that tree.
6719 If ARG is negative, go up that many levels.
6720 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6721 indirect buffer previously made with this command, to avoid proliferation of
6722 indirect buffers. However, when you call the command with a \
6724 when `org-indirect-buffer-display' is `new-frame', the last buffer
6725 is kept so that you can work with several indirect buffers at the same time.
6726 If `org-indirect-buffer-display' is `dedicated-frame', the \
6728 requests that a new frame be made for the new buffer, so that the dedicated
6729 frame is not changed."
6730 (interactive "P")
6731 (let ((cbuf (current-buffer))
6732 (cwin (selected-window))
6733 (pos (point))
6734 beg end level heading ibuf)
6735 (save-excursion
6736 (org-back-to-heading t)
6737 (when (numberp arg)
6738 (setq level (org-outline-level))
6739 (if (< arg 0) (setq arg (+ level arg)))
6740 (while (> (setq level (org-outline-level)) arg)
6741 (outline-up-heading 1 t)))
6742 (setq beg (point)
6743 heading (org-get-heading))
6744 (org-end-of-subtree t t)
6745 (if (org-on-heading-p) (backward-char 1))
6746 (setq end (point)))
6747 (if (and (buffer-live-p org-last-indirect-buffer)
6748 (not (eq org-indirect-buffer-display 'new-frame))
6749 (not arg))
6750 (kill-buffer org-last-indirect-buffer))
6751 (setq ibuf (org-get-indirect-buffer cbuf)
6752 org-last-indirect-buffer ibuf)
6753 (cond
6754 ((or (eq org-indirect-buffer-display 'new-frame)
6755 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6756 (select-frame (make-frame))
6757 (delete-other-windows)
6758 (switch-to-buffer ibuf)
6759 (org-set-frame-title heading))
6760 ((eq org-indirect-buffer-display 'dedicated-frame)
6761 (raise-frame
6762 (select-frame (or (and org-indirect-dedicated-frame
6763 (frame-live-p org-indirect-dedicated-frame)
6764 org-indirect-dedicated-frame)
6765 (setq org-indirect-dedicated-frame (make-frame)))))
6766 (delete-other-windows)
6767 (switch-to-buffer ibuf)
6768 (org-set-frame-title (concat "Indirect: " heading)))
6769 ((eq org-indirect-buffer-display 'current-window)
6770 (switch-to-buffer ibuf))
6771 ((eq org-indirect-buffer-display 'other-window)
6772 (pop-to-buffer ibuf))
6773 (t (error "Invalid value")))
6774 (if (featurep 'xemacs)
6775 (save-excursion (org-mode) (turn-on-font-lock)))
6776 (narrow-to-region beg end)
6777 (show-all)
6778 (goto-char pos)
6779 (and (window-live-p cwin) (select-window cwin))))
6781 (defun org-get-indirect-buffer (&optional buffer)
6782 (setq buffer (or buffer (current-buffer)))
6783 (let ((n 1) (base (buffer-name buffer)) bname)
6784 (while (buffer-live-p
6785 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6786 (setq n (1+ n)))
6787 (condition-case nil
6788 (make-indirect-buffer buffer bname 'clone)
6789 (error (make-indirect-buffer buffer bname)))))
6791 (defun org-set-frame-title (title)
6792 "Set the title of the current frame to the string TITLE."
6793 ;; FIXME: how to name a single frame in XEmacs???
6794 (unless (featurep 'xemacs)
6795 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6797 ;;;; Structure editing
6799 ;;; Inserting headlines
6801 (defun org-previous-line-empty-p ()
6802 (save-excursion
6803 (and (not (bobp))
6804 (or (beginning-of-line 0) t)
6805 (save-match-data
6808 (defun org-insert-heading (&optional force-heading invisible-ok)
6809 "Insert a new heading or item with same depth at point.
6810 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6811 If point is at the beginning of a headline, insert a sibling before the
6812 current headline. If point is not at the beginning, split the line,
6813 create the new headline with the text in the current line after point
6814 \(but see also the variable `org-M-RET-may-split-line').
6816 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6817 This is important for non-interactive uses of the command."
6818 (interactive "P")
6819 (if (or (= (buffer-size) 0)
6820 (and (not (save-excursion
6821 (and (ignore-errors (org-back-to-heading invisible-ok))
6822 (org-on-heading-p))))
6823 (not (org-in-item-p))))
6824 (progn
6826 (run-hooks 'org-insert-heading-hook))
6827 (when (or force-heading (not (org-insert-item)))
6828 (let* ((empty-line-p nil)
6829 (level nil)
6830 (on-heading (org-on-heading-p))
6831 (head (save-excursion
6832 (condition-case nil
6833 (progn
6834 (org-back-to-heading invisible-ok)
6835 (when (and (not on-heading)
6836 (featurep 'org-inlinetask)
6837 (integerp org-inlinetask-min-level)
6838 (>= (length (match-string 0))
6839 org-inlinetask-min-level))
6840 ;; Find a heading level before the inline task
6841 (while (and (setq level (org-up-heading-safe))
6842 (>= level org-inlinetask-min-level)))
6843 (if (org-on-heading-p)
6844 (org-back-to-heading invisible-ok)
6845 (error "This should not happen")))
6846 (setq empty-line-p (org-previous-line-empty-p))
6847 (match-string 0))
6848 (error "*"))))
6849 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6850 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6851 pos hide-previous previous-pos)
6852 (cond
6853 ((and (org-on-heading-p) (bolp)
6854 (or (bobp)
6855 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6856 ;; insert before the current line
6857 (open-line (if blank 2 1)))
6858 ((and (bolp)
6859 (not org-insert-heading-respect-content)
6860 (or (bobp)
6861 (save-excursion
6862 (backward-char 1) (not (outline-invisible-p)))))
6863 ;; insert right here
6864 nil)
6865 (t
6866 ;; somewhere in the line
6867 (save-excursion
6868 (setq previous-pos (point-at-bol))
6869 (end-of-line)
6870 (setq hide-previous (outline-invisible-p)))
6871 (and org-insert-heading-respect-content (org-show-subtree))
6872 (let ((split
6873 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6874 (save-excursion
6875 (let ((p (point)))
6876 (goto-char (point-at-bol))
6877 (and (looking-at org-complex-heading-regexp)
6878 (> p (match-beginning 4)))))))
6879 tags pos)
6880 (cond
6881 (org-insert-heading-respect-content
6882 (org-end-of-subtree nil t)
6883 (when (featurep 'org-inlinetask)
6884 (while (and (not (eobp))
6886 (>= (length (match-string 1))
6887 org-inlinetask-min-level))
6888 (org-end-of-subtree nil t)))
6889 (or (bolp) (newline))
6890 (or (org-previous-line-empty-p)
6891 (and blank (newline)))
6892 (open-line 1))
6893 ((org-on-heading-p)
6894 (when hide-previous
6895 (show-children)
6896 (org-show-entry))
6898 (setq tags (and (match-end 2) (match-string 2)))
6899 (and (match-end 1)
6900 (delete-region (match-beginning 1) (match-end 1)))
6901 (setq pos (point-at-bol))
6902 (or split (end-of-line 1))
6903 (delete-horizontal-space)
6905 (buffer-substring (point-at-bol) (point)))
6906 (insert " "))
6907 (newline (if blank 2 1))
6908 (when tags
6909 (save-excursion
6910 (goto-char pos)
6911 (end-of-line 1)
6912 (insert " " tags)
6913 (org-set-tags nil 'align))))
6914 (t
6915 (or split (end-of-line 1))
6916 (newline (if blank 2 1)))))))
6917 (insert head) (just-one-space)
6918 (setq pos (point))
6919 (end-of-line 1)
6920 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6921 (when (and org-insert-heading-respect-content hide-previous)
6922 (save-excursion
6923 (goto-char previous-pos)
6924 (hide-subtree)))
6925 (run-hooks 'org-insert-heading-hook)))))
6927 (defun org-get-heading (&optional no-tags)
6928 "Return the heading of the current entry, without the stars."
6929 (save-excursion
6930 (org-back-to-heading t)
6931 (if (looking-at
6932 (if no-tags
6935 (match-string 1) "")))
6937 (defun org-heading-components ()
6938 "Return the components of the current heading.
6939 This is a list with the following elements:
6940 - the level as an integer
6941 - the reduced level, different if `org-odd-levels-only' is set.
6942 - the TODO keyword, or nil
6943 - the priority character, like ?A, or nil if no priority is given
6944 - the headline text itself, or the tags string if no headline text
6945 - the tags string, or nil."
6946 (save-excursion
6947 (org-back-to-heading t)
6948 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6949 (list (length (match-string 1))
6950 (org-reduced-level (length (match-string 1)))
6951 (org-match-string-no-properties 2)
6952 (and (match-end 3) (aref (match-string 3) 2))
6953 (org-match-string-no-properties 4)
6954 (org-match-string-no-properties 5)))))
6956 (defun org-get-entry ()
6957 "Get the entry text, after heading, entire subtree."
6958 (save-excursion
6959 (org-back-to-heading t)
6960 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6962 (defun org-insert-heading-after-current ()
6963 "Insert a new heading with same level as current, after current subtree."
6964 (interactive)
6965 (org-back-to-heading)
6966 (org-insert-heading)
6967 (org-move-subtree-down)
6968 (end-of-line 1))
6970 (defun org-insert-heading-respect-content ()
6971 (interactive)
6972 (let ((org-insert-heading-respect-content t))
6973 (org-insert-heading t)))
6975 (defun org-insert-todo-heading-respect-content (&optional force-state)
6976 (interactive "P")
6977 (let ((org-insert-heading-respect-content t))
6978 (org-insert-todo-heading force-state t)))
6980 (defun org-insert-todo-heading (arg &optional force-heading)
6981 "Insert a new heading with the same level and TODO state as current heading.
6982 If the heading has no TODO state, or if the state is DONE, use the first
6983 state (TODO by default). Also with prefix arg, force first state."
6984 (interactive "P")
6985 (when (or force-heading (not (org-insert-item 'checkbox)))
6986 (org-insert-heading force-heading)
6987 (save-excursion
6988 (org-back-to-heading)
6989 (outline-previous-heading)
6990 (looking-at org-todo-line-regexp))
6991 (let*
6992 ((new-mark-x
6993 (if (or arg
6994 (not (match-beginning 2))
6995 (member (match-string 2) org-done-keywords))
6996 (car org-todo-keywords-1)
6997 (match-string 2)))
6998 (new-mark
6999 (or
7000 (run-hook-with-args-until-success
7001 'org-todo-get-default-hook new-mark-x nil)
7002 new-mark-x)))
7003 (beginning-of-line 1)
7005 (if org-treat-insert-todo-heading-as-state-change
7006 (org-todo new-mark)
7007 (insert new-mark " "))))
7008 (when org-provide-todo-statistics
7009 (org-update-parent-todo-statistics))))
7011 (defun org-insert-subheading (arg)
7012 "Insert a new subheading and demote it.
7013 Works for outline headings and for plain lists alike."
7014 (interactive "P")
7015 (org-insert-heading arg)
7016 (cond
7017 ((org-on-heading-p) (org-do-demote))
7018 ((org-at-item-p) (org-indent-item))))
7020 (defun org-insert-todo-subheading (arg)
7021 "Insert a new subheading with TODO keyword or checkbox and demote it.
7022 Works for outline headings and for plain lists alike."
7023 (interactive "P")
7024 (org-insert-todo-heading arg)
7025 (cond
7026 ((org-on-heading-p) (org-do-demote))
7027 ((org-at-item-p) (org-indent-item))))
7029 ;;; Promotion and Demotion
7031 (defvar org-after-demote-entry-hook nil
7032 "Hook run after an entry has been demoted.
7033 The cursor will be at the beginning of the entry.
7034 When a subtree is being demoted, the hook will be called for each node.")
7036 (defvar org-after-promote-entry-hook nil
7037 "Hook run after an entry has been promoted.
7038 The cursor will be at the beginning of the entry.
7039 When a subtree is being promoted, the hook will be called for each node.")
7041 (defun org-promote-subtree ()
7042 "Promote the entire subtree.
7043 See also `org-promote'."
7044 (interactive)
7045 (save-excursion
7046 (org-with-limited-levels (org-map-tree 'org-promote)))
7047 (org-fix-position-after-promote))
7049 (defun org-demote-subtree ()
7050 "Demote the entire subtree. See `org-demote'.
7051 See also `org-promote'."
7052 (interactive)
7053 (save-excursion
7054 (org-with-limited-levels (org-map-tree 'org-demote)))
7055 (org-fix-position-after-promote))
7058 (defun org-do-promote ()
7059 "Promote the current heading higher up the tree.
7060 If the region is active in `transient-mark-mode', promote all headings
7061 in the region."
7062 (interactive)
7063 (save-excursion
7064 (if (org-region-active-p)
7065 (org-map-region 'org-promote (region-beginning) (region-end))
7066 (org-promote)))
7067 (org-fix-position-after-promote))
7069 (defun org-do-demote ()
7070 "Demote the current heading lower down the tree.
7071 If the region is active in `transient-mark-mode', demote all headings
7072 in the region."
7073 (interactive)
7074 (save-excursion
7075 (if (org-region-active-p)
7076 (org-map-region 'org-demote (region-beginning) (region-end))
7077 (org-demote)))
7078 (org-fix-position-after-promote))
7080 (defun org-fix-position-after-promote ()
7081 "Make sure that after pro/demotion cursor position is right."
7082 (let ((pos (point)))
7083 (when (save-excursion
7084 (beginning-of-line 1)
7085 (looking-at org-todo-line-regexp)
7086 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7087 (cond ((eobp) (insert " "))
7088 ((eolp) (insert " "))
7089 ((equal (char-after) ?\ ) (forward-char 1))))))
7091 (defun org-current-level ()
7092 "Return the level of the current entry, or nil if before the first headline.
7093 The level is the number of stars at the beginning of the headline."
7094 (save-excursion
7095 (org-with-limited-levels
7096 (ignore-errors
7097 (org-back-to-heading t)
7098 (funcall outline-level)))))
7100 (defun org-get-previous-line-level ()
7101 "Return the outline depth of the last headline before the current line.
7102 Returns 0 for the first headline in the buffer, and nil if before the
7103 first headline."
7104 (let ((current-level (org-current-level))
7105 (prev-level (when (> (line-number-at-pos) 1)
7106 (save-excursion
7107 (beginning-of-line 0)
7108 (org-current-level)))))
7109 (cond ((null current-level) nil) ; Before first headline
7110 ((null prev-level) 0) ; At first headline
7111 (prev-level))))
7113 (defun org-reduced-level (l)
7114 "Compute the effective level of a heading.
7115 This takes into account the setting of `org-odd-levels-only'."
7116 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7118 (defun org-level-increment ()
7119 "Return the number of stars that will be added or removed at a
7120 time to headlines when structure editing, based on the value of
7121 `org-odd-levels-only'."
7122 (if org-odd-levels-only 2 1))
7124 (defun org-get-valid-level (level &optional change)
7125 "Rectify a level change under the influence of `org-odd-levels-only'
7126 LEVEL is a current level, CHANGE is by how much the level should be
7127 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7128 even level numbers will become the next higher odd number."
7129 (if org-odd-levels-only
7130 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7131 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7132 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7133 (max 1 (+ level (or change 0)))))
7135 (if (boundp 'define-obsolete-function-alias)
7136 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7137 (define-obsolete-function-alias 'org-get-legal-level
7138 'org-get-valid-level)
7139 (define-obsolete-function-alias 'org-get-legal-level
7140 'org-get-valid-level "23.1")))
7142 (defun org-promote ()
7143 "Promote the current heading higher up the tree.
7144 If the region is active in `transient-mark-mode', promote all headings
7145 in the region."
7146 (org-back-to-heading t)
7147 (let* ((level (save-match-data (funcall outline-level)))
7148 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7149 (diff (abs (- level (length up-head) -1))))
7150 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7151 (replace-match up-head nil t)
7152 ;; Fixup tag positioning
7153 (and org-auto-align-tags (org-set-tags nil t))
7154 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7155 (run-hooks 'org-after-promote-entry-hook)))
7157 (defun org-demote ()
7158 "Demote the current heading lower down the tree.
7159 If the region is active in `transient-mark-mode', demote all headings
7160 in the region."
7161 (org-back-to-heading t)
7162 (let* ((level (save-match-data (funcall outline-level)))
7163 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7164 (diff (abs (- level (length down-head) -1))))
7165 (replace-match down-head nil t)
7166 ;; Fixup tag positioning
7167 (and org-auto-align-tags (org-set-tags nil t))
7168 (if org-adapt-indentation (org-fixup-indentation diff))
7169 (run-hooks 'org-after-demote-entry-hook)))
7171 (defun org-cycle-level ()
7172 "Cycle the level of an empty headline through possible states.
7173 This goes first to child, then to parent, level, then up the hierarchy.
7174 After top level, it switches back to sibling level."
7175 (interactive)
7176 (let ((org-adapt-indentation nil))
7177 (when (org-point-at-end-of-empty-headline)
7178 (setq this-command 'org-cycle-level) ; Only needed for caching
7179 (let ((cur-level (org-current-level))
7180 (prev-level (org-get-previous-line-level)))
7181 (cond
7182 ;; If first headline in file, promote to top-level.
7183 ((= prev-level 0)
7184 (loop repeat (/ (- cur-level 1) (org-level-increment))
7185 do (org-do-promote)))
7186 ;; If same level as prev, demote one.
7187 ((= prev-level cur-level)
7188 (org-do-demote))
7189 ;; If parent is top-level, promote to top level if not already.
7190 ((= prev-level 1)
7191 (loop repeat (/ (- cur-level 1) (org-level-increment))
7192 do (org-do-promote)))
7193 ;; If top-level, return to prev-level.
7194 ((= cur-level 1)
7195 (loop repeat (/ (- prev-level 1) (org-level-increment))
7196 do (org-do-demote)))
7197 ;; If less than prev-level, promote one.
7198 ((< cur-level prev-level)
7199 (org-do-promote))
7200 ;; If deeper than prev-level, promote until higher than
7201 ;; prev-level.
7202 ((> cur-level prev-level)
7203 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7204 do (org-do-promote))))
7205 t))))
7207 (defun org-map-tree (fun)
7208 "Call FUN for every heading underneath the current one."
7209 (org-back-to-heading)
7210 (let ((level (funcall outline-level)))
7211 (save-excursion
7212 (funcall fun)
7213 (while (and (progn
7214 (outline-next-heading)
7215 (> (funcall outline-level) level))
7216 (not (eobp)))
7217 (funcall fun)))))
7219 (defun org-map-region (fun beg end)
7220 "Call FUN for every heading between BEG and END."
7221 (let ((org-ignore-region t))
7222 (save-excursion
7223 (setq end (copy-marker end))
7224 (goto-char beg)
7225 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7226 (< (point) end))
7227 (funcall fun))
7228 (while (and (progn
7229 (outline-next-heading)
7230 (< (point) end))
7231 (not (eobp)))
7232 (funcall fun)))))
7234 (defun org-fixup-indentation (diff)
7235 "Change the indentation in the current entry by DIFF.
7236 However, if any line in the current entry has no indentation, or if it
7237 would end up with no indentation after the change, nothing at all is done."
7238 (save-excursion
7239 (let ((end (save-excursion (outline-next-heading)
7240 (point-marker)))
7241 (prohibit (if (> diff 0)
7244 col)
7245 (unless (save-excursion (end-of-line 1)
7246 (re-search-forward prohibit end t))
7247 (while (and (< (point) end)
7249 (goto-char (match-end 0))
7250 (setq col (current-column))
7251 (if (< diff 0) (replace-match ""))
7252 (org-indent-to-column (+ diff col))))
7253 (move-marker end nil))))
7255 (defun org-convert-to-odd-levels ()
7256 "Convert an org-mode file with all levels allowed to one with odd levels.
7257 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7258 level 5 etc."
7259 (interactive)
7260 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7261 (let ((outline-regexp org-outline-regexp)
7262 (outline-level 'org-outline-level)
7263 (org-odd-levels-only nil) n)
7264 (save-excursion
7265 (goto-char (point-min))
7267 (setq n (- (length (match-string 0)) 2))
7268 (while (>= (setq n (1- n)) 0)
7269 (org-demote))
7270 (end-of-line 1))))))
7272 (defun org-convert-to-oddeven-levels ()
7273 "Convert an org-mode file with only odd levels to one with odd/even levels.
7274 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7275 file contains a section with an even level, conversion would
7276 destroy the structure of the file. An error is signaled in this
7277 case."
7278 (interactive)
7279 (goto-char (point-min))
7280 ;; First check if there are no even levels
7282 (org-show-context t)
7283 (error "Not all levels are odd in this file. Conversion not possible"))
7284 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7285 (let ((outline-regexp org-outline-regexp)
7286 (outline-level 'org-outline-level)
7287 (org-odd-levels-only nil) n)
7288 (save-excursion
7289 (goto-char (point-min))
7291 (setq n (/ (1- (length (match-string 0))) 2))
7292 (while (>= (setq n (1- n)) 0)
7293 (org-promote))
7294 (end-of-line 1))))))
7296 (defun org-tr-level (n)
7297 "Make N odd if required."
7298 (if org-odd-levels-only (1+ (/ n 2)) n))
7300 ;;; Vertical tree motion, cutting and pasting of subtrees
7302 (defun org-move-subtree-up (&optional arg)
7303 "Move the current subtree up past ARG headlines of the same level."
7304 (interactive "p")
7305 (org-move-subtree-down (- (prefix-numeric-value arg))))
7307 (defun org-move-subtree-down (&optional arg)
7308 "Move the current subtree down past ARG headlines of the same level."
7309 (interactive "p")
7310 (setq arg (prefix-numeric-value arg))
7311 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7312 'org-get-last-sibling))
7313 (ins-point (make-marker))
7314 (cnt (abs arg))
7315 (col (current-column))
7316 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7317 ;; Select the tree
7318 (org-back-to-heading)
7319 (setq beg0 (point))
7320 (save-excursion
7321 (setq ne-beg (org-back-over-empty-lines))
7322 (setq beg (point)))
7323 (save-match-data
7324 (save-excursion (outline-end-of-heading)
7325 (setq folded (outline-invisible-p)))
7326 (outline-end-of-subtree))
7327 (outline-next-heading)
7328 (setq ne-end (org-back-over-empty-lines))
7329 (setq end (point))
7330 (goto-char beg0)
7331 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7332 ;; include less whitespace
7333 (save-excursion
7334 (goto-char beg)
7335 (forward-line (- ne-beg ne-end))
7336 (setq beg (point))))
7337 ;; Find insertion point, with error handling
7338 (while (> cnt 0)
7339 (or (and (funcall movfunc) (looking-at outline-regexp))
7340 (progn (goto-char beg0)
7341 (error "Cannot move past superior level or buffer limit")))
7342 (setq cnt (1- cnt)))
7343 (if (> arg 0)
7344 ;; Moving forward - still need to move over subtree
7345 (progn (org-end-of-subtree t t)
7346 (save-excursion
7347 (org-back-over-empty-lines)
7348 (or (bolp) (newline)))))
7349 (setq ne-ins (org-back-over-empty-lines))
7350 (move-marker ins-point (point))
7351 (setq txt (buffer-substring beg end))
7352 (org-save-markers-in-region beg end)
7353 (delete-region beg end)
7354 (org-remove-empty-overlays-at beg)
7355 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7356 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7358 (let ((bbb (point)))
7359 (insert-before-markers txt)
7360 (org-reinstall-markers-in-region bbb)
7361 (move-marker ins-point bbb))
7363 (setq ins-end (point))
7364 (goto-char ins-point)
7365 (org-skip-whitespace)
7366 (when (and (< arg 0)
7367 (org-first-sibling-p)
7368 (> ne-ins ne-beg))
7369 ;; Move whitespace back to beginning
7370 (save-excursion
7371 (goto-char ins-end)
7372 (let ((kill-whole-line t))
7373 (kill-line (- ne-ins ne-beg)) (point)))
7375 (move-marker ins-point nil)
7376 (if folded
7377 (hide-subtree)
7378 (org-show-entry)
7379 (show-children)
7380 (org-cycle-hide-drawers 'children))
7381 (org-clean-visibility-after-subtree-move)
7382 ;; move back to the initial column we were at
7383 (move-to-column col)))
7385 (defvar org-subtree-clip ""
7386 "Clipboard for cut and paste of subtrees.
7387 This is actually only a copy of the kill, because we use the normal kill
7388 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7390 (defvar org-subtree-clip-folded nil
7391 "Was the last copied subtree folded?
7392 This is used to fold the tree back after pasting.")
7394 (defun org-cut-subtree (&optional n)
7395 "Cut the current subtree into the clipboard.
7396 With prefix arg N, cut this many sequential subtrees.
7397 This is a short-hand for marking the subtree and then cutting it."
7398 (interactive "p")
7399 (org-copy-subtree n 'cut))
7401 (defun org-copy-subtree (&optional n cut force-store-markers)
7402 "Cut the current subtree into the clipboard.
7403 With prefix arg N, cut this many sequential subtrees.
7404 This is a short-hand for marking the subtree and then copying it.
7405 If CUT is non-nil, actually cut the subtree.
7406 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7407 of some markers in the region, even if CUT is non-nil. This is
7408 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7409 (interactive "p")
7410 (let (beg end folded (beg0 (point)))
7411 (if (interactive-p)
7412 (org-back-to-heading nil) ; take what looks like a subtree
7413 (org-back-to-heading t)) ; take what is really there
7414 (org-back-over-empty-lines)
7415 (setq beg (point))
7417 (save-match-data
7418 (save-excursion (outline-end-of-heading)
7419 (setq folded (outline-invisible-p)))
7420 (condition-case nil
7421 (org-forward-same-level (1- n) t)
7422 (error nil))
7423 (org-end-of-subtree t t))
7424 (org-back-over-empty-lines)
7425 (setq end (point))
7426 (goto-char beg0)
7427 (when (> end beg)
7428 (setq org-subtree-clip-folded folded)
7429 (when (or cut force-store-markers)
7430 (org-save-markers-in-region beg end))
7431 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7432 (setq org-subtree-clip (current-kill 0))
7433 (message "%s: Subtree(s) with %d characters"
7434 (if cut "Cut" "Copied")
7435 (length org-subtree-clip)))))
7437 (defun org-paste-subtree (&optional level tree for-yank)
7438 "Paste the clipboard as a subtree, with modification of headline level.
7439 The entire subtree is promoted or demoted in order to match a new headline
7440 level.
7442 If the cursor is at the beginning of a headline, the same level as
7443 that headline is used to paste the tree
7445 If not, the new level is derived from the *visible* headings
7446 before and after the insertion point, and taken to be the inferior headline
7447 level of the two. So if the previous visible heading is level 3 and the
7448 next is level 4 (or vice versa), level 4 will be used for insertion.
7449 This makes sure that the subtree remains an independent subtree and does
7450 not swallow low level entries.
7452 You can also force a different level, either by using a numeric prefix
7453 argument, or by inserting the heading marker by hand. For example, if the
7456 If optional TREE is given, use this text instead of the kill ring.
7458 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7459 move back over whitespace before inserting, and move point to the end of
7460 the inserted text when done."
7461 (interactive "P")
7462 (setq tree (or tree (and kill-ring (current-kill 0))))
7463 (unless (org-kill-is-subtree-p tree)
7464 (error "%s"
7465 (substitute-command-keys
7467 (let* ((visp (not (outline-invisible-p)))
7468 (txt tree)
7473 (old-level (if (string-match ^re txt)
7474 (- (match-end 0) (match-beginning 0) 1)
7475 -1))
7476 (force-level (cond (level (prefix-numeric-value level))
7478 (string-match
7479 ^re_ (buffer-substring
7480 (point-at-bol) (point))))
7481 (- (match-end 1) (match-beginning 1)))
7482 ((and (bolp)
7483 (looking-at org-outline-regexp))
7484 (- (match-end 0) (point) 1))
7485 (t nil)))
7486 (previous-level (save-excursion
7487 (condition-case nil
7488 (progn
7489 (outline-previous-visible-heading 1)
7490 (if (looking-at re)
7491 (- (match-end 0) (match-beginning 0) 1)
7492 1))
7493 (error 1))))
7494 (next-level (save-excursion
7495 (condition-case nil
7496 (progn
7497 (or (looking-at outline-regexp)
7498 (outline-next-visible-heading 1))
7499 (if (looking-at re)
7500 (- (match-end 0) (match-beginning 0) 1)
7501 1))
7502 (error 1))))
7503 (new-level (or force-level (max previous-level next-level)))
7504 (shift (if (or (= old-level -1)
7505 (= new-level -1)
7506 (= old-level new-level))
7507 0
7508 (- new-level old-level)))
7509 (delta (if (> shift 0) -1 1))
7510 (func (if (> shift 0) 'org-demote 'org-promote))
7511 (org-odd-levels-only nil)
7512 beg end newend)
7513 ;; Remove the forced level indicator
7514 (if force-level
7515 (delete-region (point-at-bol) (point)))
7516 ;; Paste
7517 (beginning-of-line 1)
7518 (unless for-yank (org-back-over-empty-lines))
7519 (setq beg (point))
7520 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7521 (insert-before-markers txt)
7523 (setq newend (point))
7524 (org-reinstall-markers-in-region beg)
7525 (setq end (point))
7526 (goto-char beg)
7528 (setq beg (point))
7529 (if (and (outline-invisible-p) visp)
7530 (save-excursion (outline-show-heading)))
7531 ;; Shift if necessary
7532 (unless (= shift 0)
7533 (save-restriction
7534 (narrow-to-region beg end)
7535 (while (not (= shift 0))
7536 (org-map-region func (point-min) (point-max))
7537 (setq shift (+ delta shift)))
7538 (goto-char (point-min))
7539 (setq newend (point-max))))
7540 (when (or (interactive-p) for-yank)
7541 (message "Clipboard pasted as level %d subtree" new-level))
7542 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7543 kill-ring
7544 (eq org-subtree-clip (current-kill 0))
7545 org-subtree-clip-folded)
7546 ;; The tree was folded before it was killed/copied
7547 (hide-subtree))
7548 (and for-yank (goto-char newend))))
7550 (defun org-kill-is-subtree-p (&optional txt)
7551 "Check if the current kill is an outline subtree, or a set of trees.
7552 Returns nil if kill does not start with a headline, or if the first
7553 headline level is not the largest headline level in the tree.
7554 So this will actually accept several entries of equal levels as well,
7555 which is OK for `org-paste-subtree'.
7556 If optional TXT is given, check this string instead of the current kill."
7557 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7558 (start-level (and kill
7561 kill)
7562 (- (match-end 2) (match-beginning 2) 1)))
7563 (re (concat "^" org-outline-regexp))
7564 (start (1+ (or (match-beginning 2) -1))))
7565 (if (not start-level)
7566 (progn
7567 nil) ;; does not even start with a heading
7568 (catch 'exit
7569 (while (setq start (string-match re kill (1+ start)))
7570 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7571 (throw 'exit nil)))
7572 t))))
7574 (defvar org-markers-to-move nil
7575 "Markers that should be moved with a cut-and-paste operation.
7576 Those markers are stored together with their positions relative to
7577 the start of the region.")
7579 (defun org-save-markers-in-region (beg end)
7580 "Check markers in region.
7581 If these markers are between BEG and END, record their position relative
7582 to BEG, so that after moving the block of text, we can put the markers back
7583 into place.
7584 This function gets called just before an entry or tree gets cut from the
7585 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7586 called immediately, to move the markers with the entries."
7587 (setq org-markers-to-move nil)
7588 (when (featurep 'org-clock)
7589 (org-clock-save-markers-for-cut-and-paste beg end))
7590 (when (featurep 'org-agenda)
7591 (org-agenda-save-markers-for-cut-and-paste beg end)))
7593 (defun org-check-and-save-marker (marker beg end)
7594 "Check if MARKER is between BEG and END.
7595 If yes, remember the marker and the distance to BEG."
7596 (when (and (marker-buffer marker)
7597 (equal (marker-buffer marker) (current-buffer)))
7598 (if (and (>= marker beg) (< marker end))
7599 (push (cons marker (- marker beg)) org-markers-to-move))))
7601 (defun org-reinstall-markers-in-region (beg)
7602 "Move all remembered markers to their position relative to BEG."
7603 (mapc (lambda (x)
7604 (move-marker (car x) (+ beg (cdr x))))
7605 org-markers-to-move)
7606 (setq org-markers-to-move nil))
7608 (defun org-narrow-to-subtree ()
7609 "Narrow buffer to the current subtree."
7610 (interactive)
7611 (save-excursion
7612 (save-match-data
7613 (org-with-limited-levels
7614 (narrow-to-region
7615 (progn (org-back-to-heading t) (point))
7616 (progn (org-end-of-subtree t t)
7617 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7618 (point)))))))
7620 (defun org-narrow-to-block ()
7621 "Narrow buffer to the current block."
7622 (interactive)
7625 (case-fold-search t) ;; allow #+BEGIN
7626 b_start b_end)
7627 (if (org-in-regexps-block-p bstart bend)
7628 (progn
7629 (save-excursion (re-search-backward bstart nil t)
7630 (setq b_start (match-beginning 0)))
7631 (save-excursion (re-search-forward bend nil t)
7632 (setq b_end (match-end 0)))
7633 (narrow-to-region b_start b_end))
7634 (error "Not in a block"))))
7636 (eval-when-compile
7637 (defvar org-property-drawer-re))
7639 (defvar org-property-start-re) ;; defined below
7640 (defun org-clone-subtree-with-time-shift (n &optional shift)
7641 "Clone the task (subtree) at point N times.
7642 The clones will be inserted as siblings.
7644 In interactive use, the user will be prompted for the number of
7645 clones to be produced, and for a time SHIFT, which may be a
7646 repeater as used in time stamps, for example `+3d'.
7648 When a valid repeater is given and the entry contains any time
7649 stamps, the clones will become a sequence in time, with time
7650 stamps in the subtree shifted for each clone produced. If SHIFT
7651 is nil or the empty string, time stamps will be left alone. The
7652 ID property of the original subtree is removed.
7654 If the original subtree did contain time stamps with a repeater,
7655 the following will happen:
7656 - the repeater will be removed in each clone
7657 - an additional clone will be produced, with the current, unshifted
7658 date(s) in the entry.
7659 - the original entry will be placed *after* all the clones, with
7660 repeater intact.
7661 - the start days in the repeater in the original entry will be shifted
7662 to past the last clone.
7663 I this way you can spell out a number of instances of a repeating task,
7664 and still retain the repeater to cover future instances of the task."
7665 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7666 (let (beg end template task idprop
7667 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7668 (if (not (and (integerp n) (> n 0)))
7669 (error "Invalid number of replications %s" n))
7672 shift)))
7673 (error "Invalid shift specification %s" shift))
7674 (when doshift
7675 (setq shift-n (string-to-number (match-string 1 shift))
7676 shift-what (cdr (assoc (match-string 2 shift)
7677 '(("d" . day) ("w" . week)
7678 ("m" . month) ("y" . year))))))
7679 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7680 (setq nmin 1 nmax n)
7681 (org-back-to-heading t)
7682 (setq beg (point))
7683 (setq idprop (org-entry-get nil "ID"))
7684 (org-end-of-subtree t t)
7686 (setq end (point))
7687 (setq template (buffer-substring beg end))
7688 (when (and doshift
7690 (delete-region beg end)
7691 (setq end beg)
7692 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7693 (goto-char end)
7694 (loop for n from nmin to nmax do
7695 ;; prepare clone
7696 (with-temp-buffer
7697 (insert template)
7698 (org-mode)
7699 (goto-char (point-min))
7700 (and idprop (if org-clone-delete-id
7701 (org-entry-delete nil "ID")
7702 (org-id-get-create t)))
7703 (while (re-search-forward org-property-start-re nil t)
7704 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7705 (goto-char (point-min))
7706 (when doshift
7707 (while (re-search-forward org-ts-regexp-both nil t)
7708 (org-timestamp-change (* n shift-n) shift-what))
7709 (unless (= n n-no-remove)
7710 (goto-char (point-min))
7711 (while (re-search-forward org-ts-regexp nil t)
7712 (save-excursion
7713 (goto-char (match-beginning 0))
7715 (delete-region (match-beginning 1) (match-end 1)))))))
7716 (setq task (buffer-string)))
7717 (insert task))
7718 (goto-char beg)))
7720 ;;; Outline Sorting
7722 (defun org-sort (with-case)
7723 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7724 Optional argument WITH-CASE means sort case-sensitively.
7725 With a double prefix argument, also remove duplicate entries."
7726 (interactive "P")
7727 (cond
7728 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7729 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7730 (t
7731 (org-call-with-arg 'org-sort-entries with-case))))
7733 (defun org-sort-remove-invisible (s)
7734 (remove-text-properties 0 (length s) org-rm-props s)
7735 (while (string-match org-bracket-link-regexp s)
7736 (setq s (replace-match (if (match-end 2)
7737 (match-string 3 s)
7738 (match-string 1 s)) t t s)))
7739 s)
7741 (defvar org-priority-regexp) ; defined later in the file
7743 (defvar org-after-sorting-entries-or-items-hook nil
7744 "Hook that is run after a bunch of entries or items have been sorted.
7745 When children are sorted, the cursor is in the parent line when this
7746 hook gets called. When a region or a plain list is sorted, the cursor
7747 will be in the first entry of the sorted region/list.")
7749 (defun org-sort-entries
7750 (&optional with-case sorting-type getkey-func compare-func property)
7751 "Sort entries on a certain level of an outline tree.
7752 If there is an active region, the entries in the region are sorted.
7753 Else, if the cursor is before the first entry, sort the top-level items.
7754 Else, the children of the entry at point are sorted.
7756 Sorting can be alphabetically, numerically, by date/time as given by
7757 a time stamp, by a property or by priority.
7759 The command prompts for the sorting type unless it has been given to the
7760 function through the SORTING-TYPE argument, which needs to be a character,
7761 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7762 precise meaning of each character:
7764 n Numerically, by converting the beginning of the entry/item to a number.
7765 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7766 t By date/time, either the first active time stamp in the entry, or, if
7767 none exist, by the first inactive one.
7768 s By the scheduled date/time.
7769 d By deadline date/time.
7770 c By creation time, which is assumed to be the first inactive time stamp
7771 at the beginning of a line.
7772 p By priority according to the cookie.
7773 r By the value of a property.
7775 Capital letters will reverse the sort order.
7777 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7778 called with point at the beginning of the record. It must return either
7779 a string or a number that should serve as the sorting key for that record.
7781 Comparing entries ignores case by default. However, with an optional argument
7782 WITH-CASE, the sorting considers case as well."
7783 (interactive "P")
7784 (let ((case-func (if with-case 'identity 'downcase))
7785 start beg end stars re re2
7786 txt what tmp)
7787 ;; Find beginning and end of region to sort
7788 (cond
7789 ((org-region-active-p)
7790 ;; we will sort the region
7791 (setq end (region-end)
7792 what "region")
7793 (goto-char (region-beginning))
7794 (if (not (org-on-heading-p)) (outline-next-heading))
7795 (setq start (point)))
7796 ((or (org-on-heading-p)
7797 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7798 ;; we will sort the children of the current headline
7799 (org-back-to-heading)
7800 (setq start (point)
7801 end (progn (org-end-of-subtree t t)
7803 (org-back-over-empty-lines)
7804 (point))
7805 what "children")
7806 (goto-char start)
7807 (show-subtree)
7808 (outline-next-heading))
7809 (t
7810 ;; we will sort the top-level entries in this file
7811 (goto-char (point-min))
7812 (or (org-on-heading-p) (outline-next-heading))
7813 (setq start (point))
7814 (goto-char (point-max))
7815 (beginning-of-line 1)
7817 ;; File ends in a non-white line
7818 (end-of-line 1)
7820 (setq end (point-max))
7821 (setq what "top-level")
7822 (goto-char start)
7823 (show-all)))
7825 (setq beg (point))
7826 (if (>= beg end) (error "Nothing to sort"))
7829 (setq stars (match-string 1)
7830 re (concat "^" (regexp-quote stars) " +")
7832 txt (buffer-substring beg end))
7834 (if (and (not (equal stars "*")) (string-match re2 txt))
7835 (error "Region to sort contains a level above the first entry"))
7837 (unless sorting-type
7838 (message
7839 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7841 A/N/T/S/D/C/P/O/F means reversed:"
7842 what)
7843 (setq sorting-type (read-char-exclusive))
7845 (and (= (downcase sorting-type) ?f)
7846 (setq getkey-func
7847 (org-icompleting-read "Sort using function: "
7848 obarray 'fboundp t nil nil))
7849 (setq getkey-func (intern getkey-func)))
7851 (and (= (downcase sorting-type) ?r)
7852 (setq property
7853 (org-icompleting-read "Property: "
7854 (mapcar 'list (org-buffer-property-keys t))
7855 nil t))))
7857 (message "Sorting entries...")
7859 (save-restriction
7860 (narrow-to-region start end)
7861 (let ((dcst (downcase sorting-type))
7862 (case-fold-search nil)
7863 (now (current-time)))
7864 (sort-subr
7865 (/= dcst sorting-type)
7866 ;; This function moves to the beginning character of the "record" to
7867 ;; be sorted.
7868 (lambda nil
7869 (if (re-search-forward re nil t)
7870 (goto-char (match-beginning 0))
7871 (goto-char (point-max))))
7872 ;; This function moves to the last character of the "record" being
7873 ;; sorted.
7874 (lambda nil
7875 (save-match-data
7876 (condition-case nil
7877 (outline-forward-same-level 1)
7878 (error
7879 (goto-char (point-max))))))
7880 ;; This function returns the value that gets sorted against.
7881 (lambda nil
7882 (cond
7883 ((= dcst ?n)
7884 (if (looking-at org-complex-heading-regexp)
7885 (string-to-number (match-string 4))
7886 nil))
7887 ((= dcst ?a)
7888 (if (looking-at org-complex-heading-regexp)
7889 (funcall case-func (match-string 4))
7890 nil))
7891 ((= dcst ?t)
7892 (let ((end (save-excursion (outline-next-heading) (point))))
7893 (if (or (re-search-forward org-ts-regexp end t)
7894 (re-search-forward org-ts-regexp-both end t))
7895 (org-time-string-to-seconds (match-string 0))
7896 (org-float-time now))))
7897 ((= dcst ?c)
7898 (let ((end (save-excursion (outline-next-heading) (point))))
7899 (if (re-search-forward
7901 end t)
7902 (org-time-string-to-seconds (match-string 0))
7903 (org-float-time now))))
7904 ((= dcst ?s)
7905 (let ((end (save-excursion (outline-next-heading) (point))))
7906 (if (re-search-forward org-scheduled-time-regexp end t)
7907 (org-time-string-to-seconds (match-string 1))
7908 (org-float-time now))))
7909 ((= dcst ?d)
7910 (let ((end (save-excursion (outline-next-heading) (point))))
7911 (if (re-search-forward org-deadline-time-regexp end t)
7912 (org-time-string-to-seconds (match-string 1))
7913 (org-float-time now))))
7914 ((= dcst ?p)
7915 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7916 (string-to-char (match-string 2))
7917 org-default-priority))
7918 ((= dcst ?r)
7919 (or (org-entry-get nil property) ""))
7920 ((= dcst ?o)
7921 (if (looking-at org-complex-heading-regexp)
7922 (- 9999 (length (member (match-string 2)
7923 org-todo-keywords-1)))))
7924 ((= dcst ?f)
7925 (if getkey-func
7926 (progn
7927 (setq tmp (funcall getkey-func))
7928 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7929 tmp)
7930 (error "Invalid key function `%s'" getkey-func)))
7931 (t (error "Invalid sorting type `%c'" sorting-type))))
7932 nil
7933 (cond
7934 ((= dcst ?a) 'string<)
7935 ((= dcst ?f) compare-func)
7936 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7937 (t nil)))))
7938 (run-hooks 'org-after-sorting-entries-or-items-hook)
7939 (message "Sorting entries...done")))
7941 (defun org-do-sort (table what &optional with-case sorting-type)
7942 "Sort TABLE of WHAT according to SORTING-TYPE.
7943 The user will be prompted for the SORTING-TYPE if the call to this
7944 function does not specify it. WHAT is only for the prompt, to indicate
7945 what is being sorted. The sorting key will be extracted from
7946 the car of the elements of the table.
7947 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7948 (unless sorting-type
7949 (message
7950 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7951 what)
7952 (setq sorting-type (read-char-exclusive)))
7953 (let ((dcst (downcase sorting-type))
7954 extractfun comparefun)
7955 ;; Define the appropriate functions
7956 (cond
7957 ((= dcst ?n)
7958 (setq extractfun 'string-to-number
7959 comparefun (if (= dcst sorting-type) '< '>)))
7960 ((= dcst ?a)
7961 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7962 (lambda(x) (downcase (org-sort-remove-invisible x))))
7963 comparefun (if (= dcst sorting-type)
7964 'string<
7965 (lambda (a b) (and (not (string< a b))
7966 (not (string= a b)))))))
7967 ((= dcst ?t)
7968 (setq extractfun
7969 (lambda (x)
7970 (if (or (string-match org-ts-regexp x)
7971 (string-match org-ts-regexp-both x))
7972 (org-float-time
7973 (org-time-string-to-time (match-string 0 x)))
7974 0))
7975 comparefun (if (= dcst sorting-type) '< '>)))
7976 (t (error "Invalid sorting type `%c'" sorting-type)))
7978 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7979 table)
7980 (lambda (a b) (funcall comparefun (car a) (car b))))))
7983 ;;; The orgstruct minor mode
7985 ;; Define a minor mode which can be used in other modes in order to
7986 ;; integrate the org-mode structure editing commands.
7988 ;; This is really a hack, because the org-mode structure commands use
7989 ;; keys which normally belong to the major mode. Here is how it
7990 ;; works: The minor mode defines all the keys necessary to operate the
7991 ;; structure commands, but wraps the commands into a function which
7992 ;; tests if the cursor is currently at a headline or a plain list
7993 ;; item. If that is the case, the structure command is used,
7994 ;; temporarily setting many Org-mode variables like regular
7995 ;; expressions for filling etc. However, when any of those keys is
7996 ;; used at a different location, function uses `key-binding' to look
7997 ;; up if the key has an associated command in another currently active
7998 ;; keymap (minor modes, major mode, global), and executes that
7999 ;; command. There might be problems if any of the keys is otherwise
8000 ;; used as a prefix key.
8002 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8003 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8004 ;; addresses this by checking explicitly for both bindings.
8006 (defvar orgstruct-mode-map (make-sparse-keymap)
8007 "Keymap for the minor `orgstruct-mode'.")
8009 (defvar org-local-vars nil
8010 "List of local variables, for use by `orgstruct-mode'.")
8012 ;;;###autoload
8013 (define-minor-mode orgstruct-mode
8014 "Toggle the minor mode `orgstruct-mode'.
8015 This mode is for using Org-mode structure commands in other
8016 modes. The following keys behave as if Org-mode were active, if
8017 the cursor is on a headline, or on a plain list item (both as
8018 defined by Org-mode).
8020 M-up Move entry/item up
8021 M-down Move entry/item down
8022 M-left Promote
8023 M-right Demote
8024 M-S-up Move entry/item up
8025 M-S-down Move entry/item down
8026 M-S-left Promote subtree
8027 M-S-right Demote subtree
8028 M-q Fill paragraph and items like in Org-mode
8029 C-c ^ Sort entries
8030 C-c - Cycle list bullet
8031 TAB Cycle item visibility
8032 M-RET Insert new heading/item
8033 S-M-RET Insert new TODO heading / Checkbox item
8034 C-c C-c Set tags / toggle checkbox"
8035 nil " OrgStruct" nil
8036 (org-load-modules-maybe)
8037 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8039 ;;;###autoload
8040 (defun turn-on-orgstruct ()
8041 "Unconditionally turn on `orgstruct-mode'."
8042 (orgstruct-mode 1))
8044 (defun orgstruct++-mode (&optional arg)
8045 "Toggle `orgstruct-mode', the enhanced version of it.
8046 In addition to setting orgstruct-mode, this also exports all indentation
8047 and autofilling variables from org-mode into the buffer. It will also
8048 recognize item context in multiline items.
8049 Note that turning off orgstruct-mode will *not* remove the
8050 indentation/paragraph settings. This can only be done by refreshing the
8052 (interactive "P")
8053 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8054 (if (< arg 1)
8055 (orgstruct-mode -1)
8056 (orgstruct-mode 1)
8057 (let (var val)
8058 (mapc
8059 (lambda (x)
8060 (when (string-match
8062 (symbol-name (car x)))
8063 (setq var (car x) val (nth 1 x))
8064 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8065 org-local-vars)
8066 (org-set-local 'orgstruct-is-++ t))))
8068 (defvar orgstruct-is-++ nil
8069 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8070 (make-variable-buffer-local 'orgstruct-is-++)
8072 ;;;###autoload
8073 (defun turn-on-orgstruct++ ()
8074 "Unconditionally turn on `orgstruct++-mode'."
8075 (orgstruct++-mode 1))
8077 (defun orgstruct-error ()
8078 "Error when there is no default binding for a structure key."
8079 (interactive)
8080 (error "This key has no function outside structure elements"))
8082 (defun orgstruct-setup ()
8083 "Setup orgstruct keymaps."
8084 (let ((nfunc 0)
8085 (bindings
8086 (list
8087 '([(meta up)] org-metaup)
8088 '([(meta down)] org-metadown)
8089 '([(meta left)] org-metaleft)
8090 '([(meta right)] org-metaright)
8091 '([(meta shift up)] org-shiftmetaup)
8092 '([(meta shift down)] org-shiftmetadown)
8093 '([(meta shift left)] org-shiftmetaleft)
8094 '([(meta shift right)] org-shiftmetaright)
8095 '([?\e (up)] org-metaup)
8096 '([?\e (down)] org-metadown)
8097 '([?\e (left)] org-metaleft)
8098 '([?\e (right)] org-metaright)
8099 '([?\e (shift up)] org-shiftmetaup)
8100 '([?\e (shift down)] org-shiftmetadown)
8101 '([?\e (shift left)] org-shiftmetaleft)
8102 '([?\e (shift right)] org-shiftmetaright)
8103 '([(shift up)] org-shiftup)
8104 '([(shift down)] org-shiftdown)
8105 '([(shift left)] org-shiftleft)
8106 '([(shift right)] org-shiftright)
8107 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8108 '("\M-q" fill-paragraph)
8109 '("\C-c^" org-sort)
8110 '("\C-c-" org-cycle-list-bullet)))
8111 elt key fun cmd)
8112 (while (setq elt (pop bindings))
8113 (setq nfunc (1+ nfunc))
8114 (setq key (org-key (car elt))
8115 fun (nth 1 elt)
8116 cmd (orgstruct-make-binding fun nfunc key))
8117 (org-defkey orgstruct-mode-map key cmd))
8119 ;; Special treatment needed for TAB and RET
8120 (org-defkey orgstruct-mode-map [(tab)]
8121 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8122 (org-defkey orgstruct-mode-map "\C-i"
8123 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8125 (org-defkey orgstruct-mode-map "\M-\C-m"
8126 (orgstruct-make-binding 'org-insert-heading 105
8127 "\M-\C-m" [(meta return)]))
8128 (org-defkey orgstruct-mode-map [(meta return)]
8129 (orgstruct-make-binding 'org-insert-heading 106
8130 [(meta return)] "\M-\C-m"))
8132 (org-defkey orgstruct-mode-map [(shift meta return)]
8133 (orgstruct-make-binding 'org-insert-todo-heading 107
8134 [(meta return)] "\M-\C-m"))
8136 (org-defkey orgstruct-mode-map "\e\C-m"
8137 (orgstruct-make-binding 'org-insert-heading 108
8138 "\e\C-m" [?\e (return)]))
8139 (org-defkey orgstruct-mode-map [?\e (return)]
8140 (orgstruct-make-binding 'org-insert-heading 109
8141 [?\e (return)] "\e\C-m"))
8142 (org-defkey orgstruct-mode-map [?\e (shift return)]
8143 (orgstruct-make-binding 'org-insert-todo-heading 110
8144 [?\e (return)] "\e\C-m"))
8146 (unless org-local-vars
8147 (setq org-local-vars (org-get-local-variables)))
8149 t))
8151 (defun orgstruct-make-binding (fun n &rest keys)
8152 "Create a function for binding in the structure minor mode.
8153 FUN is the command to call inside a table. N is used to create a unique
8154 command name. KEYS are keys that should be checked in for a command
8155 to execute outside of tables."
8156 (eval
8157 (list 'defun
8158 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8159 '(arg)
8161 "Outside of structure, run the binding of `"
8162 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8163 "'.")
8164 '(interactive "p")
8165 (list 'if
8166 `(org-context-p 'headline 'item
8167 (and orgstruct-is-++
8168 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8169 'item-body))
8170 (list 'org-run-like-in-org-mode (list 'quote fun))
8171 (list 'let '(orgstruct-mode)
8172 (list 'call-interactively
8173 (append '(or)
8174 (mapcar (lambda (k)
8175 (list 'key-binding k))
8176 keys)
8177 '('orgstruct-error))))))))
8179 (defun org-context-p (&rest contexts)
8180 "Check if local context is any of CONTEXTS.
8181 Possible values in the list of contexts are `table', `headline', and `item'."
8182 (let ((pos (point)))
8183 (goto-char (point-at-bol))
8184 (prog1 (or (and (memq 'table contexts)
8186 (and (memq 'headline contexts)
8188 (looking-at outline-regexp))
8189 (and (memq 'item contexts)
8191 (and (memq 'item-body contexts)
8192 (org-in-item-p)))
8193 (goto-char pos))))
8195 (defun org-get-local-variables ()
8196 "Return a list of all local variables in an org-mode buffer."
8197 (let (varlist)
8198 (with-current-buffer (get-buffer-create "*Org tmp*")
8199 (erase-buffer)
8200 (org-mode)
8201 (setq varlist (buffer-local-variables)))
8202 (kill-buffer "*Org tmp*")
8203 (delq nil
8204 (mapcar
8205 (lambda (x)
8206 (setq x
8207 (if (symbolp x)
8208 (list x)
8209 (list (car x) (list 'quote (cdr x)))))
8210 (if (string-match
8211 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8212 (symbol-name (car x)))
8213 x nil))
8214 varlist))))
8216 (defun org-clone-local-variables (from-buffer &optional regexp)
8217 "Clone local variables from FROM-BUFFER.
8218 Optional argument REGEXP selects variables to clone."
8219 (mapc
8220 (lambda (pair)
8221 (and (symbolp (car pair))
8222 (or (null regexp)
8223 (string-match regexp (symbol-name (car pair))))
8224 (set (make-local-variable (car pair))
8225 (cdr pair))))
8226 (buffer-local-variables from-buffer)))
8228 ;;;###autoload
8229 (defun org-run-like-in-org-mode (cmd)
8230 "Run a command, pretending that the current buffer is in Org-mode.
8231 This will temporarily bind local variables that are typically bound in
8232 Org-mode to the values they have in Org-mode, and then interactively
8233 call CMD."
8234 (org-load-modules-maybe)
8235 (unless org-local-vars
8236 (setq org-local-vars (org-get-local-variables)))
8237 (eval (list 'let org-local-vars
8238 (list 'call-interactively (list 'quote cmd)))))
8240 ;;;; Archiving
8242 (defun org-get-category (&optional pos force-refresh)
8243 "Get the category applying to position POS."
8244 (if force-refresh (org-refresh-category-properties))
8245 (let ((pos (or pos (point))))
8246 (or (get-text-property pos 'org-category)
8247 (progn (org-refresh-category-properties)
8248 (get-text-property pos 'org-category)))))
8250 (defun org-refresh-category-properties ()
8251 "Refresh category text properties in the buffer."
8252 (let ((def-cat (cond
8253 ((null org-category)
8254 (if buffer-file-name
8255 (file-name-sans-extension
8256 (file-name-nondirectory buffer-file-name))
8257 "???"))
8258 ((symbolp org-category) (symbol-name org-category))
8259 (t org-category)))
8260 beg end cat pos optionp)
8261 (org-unmodified
8262 (save-excursion
8263 (save-restriction
8264 (widen)
8265 (goto-char (point-min))
8266 (put-text-property (point) (point-max) 'org-category def-cat)
8267 (while (re-search-forward
8269 (setq pos (match-end 0)
8270 optionp (equal (char-after (match-beginning 0)) ?#)
8271 cat (org-trim (match-string 2)))
8272 (if optionp
8273 (setq beg (point-at-bol) end (point-max))
8274 (org-back-to-heading t)
8275 (setq beg (point) end (org-end-of-subtree t t)))
8276 (put-text-property beg end 'org-category cat)
8277 (goto-char pos)))))))
8280 ;;;; Link Stuff
8282 ;;; Link abbreviations
8284 (defun org-link-expand-abbrev (link)
8285 "Apply replacements as defined in `org-link-abbrev-alist."
8287 (let* ((key (match-string 1 link))
8288 (as (or (assoc key org-link-abbrev-alist-local)
8289 (assoc key org-link-abbrev-alist)))
8290 (tag (and (match-end 2) (match-string 3 link)))
8291 rpl)
8292 (if (not as)
8293 link
8294 (setq rpl (cdr as))
8295 (cond
8296 ((symbolp rpl) (funcall rpl tag))
8297 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8298 ((string-match "%h" rpl)
8299 (replace-match (url-hexify-string (or tag "")) t t rpl))
8300 (t (concat rpl tag)))))
8301 link))
8303 ;;; Storing and inserting links
8305 (defvar org-insert-link-history nil
8306 "Minibuffer history for links inserted with `org-insert-link'.")
8308 (defvar org-stored-links nil
8309 "Contains the links stored with `org-store-link'.")
8311 (defvar org-store-link-plist nil
8312 "Plist with info about the most recently link created with `org-store-link'.")
8314 (defvar org-link-protocols nil
8315 "Link protocols added to Org-mode using `org-add-link-type'.")
8317 (defvar org-store-link-functions nil
8318 "List of functions that are called to create and store a link.
8319 Each function will be called in turn until one returns a non-nil
8320 value. Each function should check if it is responsible for creating
8321 this link (for example by looking at the major mode).
8322 If not, it must exit and return nil.
8323 If yes, it should return a non-nil value after a calling
8324 `org-store-link-props' with a list of properties and values.
8325 Special properties are:
8329 This is obligatory as well.
8330 :description Optional default description for the second pair
8331 of brackets in an Org-mode link. The user can still change
8332 this when inserting this link into an Org-mode buffer.
8334 In addition to these, any additional properties can be specified
8335 and then used in remember templates.")
8337 (defun org-add-link-type (type &optional follow export)
8338 "Add TYPE to the list of `org-link-types'.
8339 Re-compute all regular expressions depending on `org-link-types'
8341 FOLLOW and EXPORT are two functions.
8343 FOLLOW should take the link path as the single argument and do whatever
8344 is necessary to follow the link, for example find a file or display
8345 a mail message.
8347 EXPORT should format the link path for export to one of the export formats.
8348 It should be a function accepting three arguments:
8351 desc the description of the link, if any, or a description added by
8352 org-export-normalize-links if there is none
8353 format the export format, a symbol like `html' or `latex' or `ascii'..
8355 The function may use the FORMAT information to return different values
8356 depending on the format. The return value will be put literally into
8357 the exported file. If the return value is nil, this means Org should
8358 do what it normally does with links which do not have EXPORT defined.
8360 Org-mode has a built-in default for exporting links. If you are happy with
8361 this default, there is no need to define an export function for the link
8362 type. For a simple example of an export function, see `org-bbdb.el'."
8363 (add-to-list 'org-link-types type t)
8364 (org-make-link-regexps)
8365 (if (assoc type org-link-protocols)
8366 (setcdr (assoc type org-link-protocols) (list follow export))
8367 (push (list type follow export) org-link-protocols)))
8369 (defvar org-agenda-buffer-name)
8371 ;;;###autoload
8372 (defun org-store-link (arg)
8374 This link is added to `org-stored-links' and can later be inserted
8377 For some link types, a prefix arg is interpreted:
8378 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8379 For file links, arg negates `org-context-in-file-links'."
8380 (interactive "P")
8381 (org-load-modules-maybe)
8382 (setq org-store-link-plist nil) ; reset
8383 (org-with-limited-levels
8384 (let (link cpltxt desc description search txt custom-id agenda-link)
8385 (cond
8387 ((run-hook-with-args-until-success 'org-store-link-functions)
8388 (setq link (plist-get org-store-link-plist :link)
8389 desc (or (plist-get org-store-link-plist :description) link)))
8391 ((equal (buffer-name) "*Org Edit Src Example*")
8392 (let (label gc)
8393 (while (or (not label)
8394 (save-excursion
8395 (save-restriction
8396 (widen)
8397 (goto-char (point-min))
8398 (re-search-forward
8399 (regexp-quote (format org-coderef-label-format label))
8400 nil t))))
8401 (when label (message "Label exists already") (sit-for 2))
8402 (setq label (read-string "Code line label: " label)))
8403 (end-of-line 1)
8404 (setq link (format org-coderef-label-format label))
8405 (setq gc (- 79 (length link)))
8406 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8407 (insert link)
8408 (setq link (concat "(" label ")") desc nil)))
8410 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8411 ;; We are in the agenda, link to referenced location
8412 (let ((m (or (get-text-property (point) 'org-hd-marker)
8413 (get-text-property (point) 'org-marker))))
8414 (when m
8415 (org-with-point-at m
8416 (setq agenda-link
8417 (if (interactive-p)
8418 (call-interactively 'org-store-link)
8419 (org-store-link nil)))))))
8421 ((eq major-mode 'calendar-mode)
8422 (let ((cd (calendar-cursor-to-date)))
8423 (setq link
8424 (format-time-string
8425 (car org-time-stamp-formats)
8426 (apply 'encode-time
8427 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8428 nil nil nil))))
8429 (org-store-link-props :type "calendar" :date cd)))
8431 ((eq major-mode 'w3-mode)
8432 (setq cpltxt (if (and (buffer-name)
8433 (not (string-match "Untitled" (buffer-name))))
8434 (buffer-name)
8435 (url-view-url t))
8436 link (org-make-link (url-view-url t)))
8437 (org-store-link-props :type "w3" :url (url-view-url t)))
8439 ((eq major-mode 'w3m-mode)
8440 (setq cpltxt (or w3m-current-title w3m-current-url)
8441 link (org-make-link w3m-current-url))
8442 (org-store-link-props :type "w3m" :url (url-view-url t)))
8444 ((setq search (run-hook-with-args-until-success
8445 'org-create-file-search-functions))
8446 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8447 "::" search))
8448 (setq cpltxt (or description link)))
8450 ((eq major-mode 'image-mode)
8451 (setq cpltxt (concat "file:"
8452 (abbreviate-file-name buffer-file-name))
8453 link (org-make-link cpltxt))
8454 (org-store-link-props :type "image" :file buffer-file-name))
8456 ((eq major-mode 'dired-mode)
8457 ;; link to the file in the current line
8458 (let ((file (dired-get-filename nil t)))
8459 (setq file (if file
8460 (abbreviate-file-name
8461 (expand-file-name (dired-get-filename nil t)))
8462 ;; otherwise, no file so use current directory.
8463 default-directory))
8464 (setq cpltxt (concat "file:" file)
8465 link (org-make-link cpltxt))))
8467 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8468 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8469 (cond
8471 (setq cpltxt
8472 (concat "file:"
8473 (abbreviate-file-name
8474 (buffer-file-name (buffer-base-buffer)))
8475 "::" (match-string 1))
8476 link (org-make-link cpltxt)))
8477 ((and (featurep 'org-id)
8478 (or (eq org-link-to-org-use-id t)
8479 (and (eq org-link-to-org-use-id 'create-if-interactive)
8480 (interactive-p))
8481 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8482 (interactive-p)
8483 (not custom-id))
8484 (and org-link-to-org-use-id
8485 (org-entry-get nil "ID"))))
8486 ;; We can make a link using the ID.
8487 (setq link (condition-case nil
8488 (prog1 (org-id-store-link)
8489 (setq desc (plist-get org-store-link-plist
8490 :description)))
8491 (error
8492 ;; probably before first headline, link to file only
8493 (concat "file:"
8494 (abbreviate-file-name
8495 (buffer-file-name (buffer-base-buffer))))))))
8496 (t
8497 ;; Just link to current headline
8498 (setq cpltxt (concat "file:"
8499 (abbreviate-file-name
8500 (buffer-file-name (buffer-base-buffer)))))
8501 ;; Add a context search string
8502 (when (org-xor org-context-in-file-links arg)
8503 (setq txt (cond
8504 ((org-on-heading-p) nil)
8505 ((org-region-active-p)
8506 (buffer-substring (region-beginning) (region-end)))
8507 (t nil)))
8509 (setq cpltxt
8510 (concat cpltxt "::"
8511 (condition-case nil
8512 (org-make-org-heading-search-string txt)
8513 (error "")))
8514 desc (or (nth 4 (ignore-errors
8515 (org-heading-components))) "NONE"))))
8517 (setq cpltxt (substring cpltxt 0 -2)))
8518 (setq link (org-make-link cpltxt)))))
8520 ((buffer-file-name (buffer-base-buffer))
8521 ;; Just link to this file here.
8522 (setq cpltxt (concat "file:"
8523 (abbreviate-file-name
8524 (buffer-file-name (buffer-base-buffer)))))
8525 ;; Add a context string
8526 (when (org-xor org-context-in-file-links arg)
8527 (setq txt (if (org-region-active-p)
8528 (buffer-substring (region-beginning) (region-end))
8529 (buffer-substring (point-at-bol) (point-at-eol))))
8530 ;; Only use search option if there is some text.
8532 (setq cpltxt
8533 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8534 desc "NONE")))
8535 (setq link (org-make-link cpltxt)))
8537 ((interactive-p)
8538 (error "Cannot link to a buffer which is not visiting a file"))
8540 (t (setq link nil)))
8542 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8543 (setq link (or link cpltxt)
8544 desc (or desc cpltxt))
8545 (if (equal desc "NONE") (setq desc nil))
8547 (if (and (or (interactive-p) executing-kbd-macro) link)
8548 (progn
8549 (setq org-stored-links
8550 (cons (list link desc) org-stored-links))
8551 (message "Stored: %s" (or desc link))
8552 (when custom-id
8553 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8554 "::#" custom-id))
8555 (setq org-stored-links
8556 (cons (list link desc) org-stored-links))))
8557 (or agenda-link (and link (org-make-link-string link desc)))))))
8559 (defun org-store-link-props (&rest plist)
8560 "Store link properties, extract names and addresses."
8561 (let (x adr)
8562 (when (setq x (plist-get plist :from))
8563 (setq adr (mail-extract-address-components x))
8564 (setq plist (plist-put plist :fromname (car adr)))
8565 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8566 (when (setq x (plist-get plist :to))
8567 (setq adr (mail-extract-address-components x))
8568 (setq plist (plist-put plist :toname (car adr)))
8569 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8570 (let ((from (plist-get plist :from))
8571 (to (plist-get plist :to)))
8572 (when (and from to org-from-is-user-regexp)
8573 (setq plist
8574 (plist-put plist :fromto
8575 (if (string-match org-from-is-user-regexp from)
8576 (concat "to %t")
8577 (concat "from %f"))))))
8578 (setq org-store-link-plist plist))
8580 (defun org-add-link-props (&rest plist)
8581 "Add these properties to the link property list."
8582 (let (key value)
8583 (while plist
8584 (setq key (pop plist) value (pop plist))
8585 (setq org-store-link-plist
8586 (plist-put org-store-link-plist key value)))))
8588 (defun org-email-link-description (&optional fmt)
8589 "Return the description part of an email link.
8590 This takes information from `org-store-link-plist' and formats it
8591 according to FMT (default from `org-email-link-description-format')."
8592 (setq fmt (or fmt org-email-link-description-format))
8593 (let* ((p org-store-link-plist)
8594 (to (plist-get p :toaddress))
8595 (from (plist-get p :fromaddress))
8596 (table
8597 (list
8598 (cons "%c" (plist-get p :fromto))
8599 (cons "%F" (plist-get p :from))
8600 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8601 (cons "%T" (plist-get p :to))
8602 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8603 (cons "%s" (plist-get p :subject))
8604 (cons "%d" (plist-get p :date))
8605 (cons "%m" (plist-get p :message-id)))))
8606 (when (string-match "%c" fmt)
8607 ;; Check if the user wrote this message
8608 (if (and org-from-is-user-regexp from to
8609 (save-match-data (string-match org-from-is-user-regexp from)))
8610 (setq fmt (replace-match "to %t" t t fmt))
8611 (setq fmt (replace-match "from %f" t t fmt))))
8612 (org-replace-escapes fmt table)))
8614 (defun org-make-org-heading-search-string (&optional string heading)
8615 "Make search string for STRING or current headline."
8616 (interactive)
8617 (let ((s (or string (org-get-heading)))
8618 (lines org-context-in-file-links))
8619 (unless (and string (not heading))
8620 ;; We are using a headline, clean up garbage in there.
8621 (if (string-match org-todo-regexp s)
8622 (setq s (replace-match "" t t s)))
8624 (setq s (replace-match "" t t s)))
8625 (setq s (org-trim s))
8628 (setq s (replace-match "" t t s)))
8629 (while (string-match org-ts-regexp s)
8630 (setq s (replace-match "" t t s))))
8631 (or string (setq s (concat "*" s))) ; Add * for headlines
8632 (when (and string (integerp lines) (> lines 0))
8634 (when (< lines (length slines))
8635 (setq s (mapconcat
8636 'identity
8637 (reverse (nthcdr (- (length slines) lines)
8641 (defun org-make-link (&rest strings)
8642 "Concatenate STRINGS."
8643 (apply 'concat strings))
8645 (defun org-make-link-string (link &optional description)
8646 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8648 (error "Empty link"))
8649 (when (and description
8650 (stringp description)
8652 (setq description nil))
8653 (when (stringp description)
8654 ;; Remove brackets from the description, they are fatal.
8656 (setq description (replace-match "{" t t description)))
8658 (setq description (replace-match "}" t t description))))
8659 (when (equal (org-link-escape link) description)
8660 ;; No description needed, it is identical
8661 (setq description nil))
8662 (when (and (not description)
8663 (not (equal link (org-link-escape link))))
8664 (setq description (org-extract-attributes link)))
8665 (setq link (if (string-match org-link-types-re link)
8666 (concat (match-string 1 link)
8667 (org-link-escape (substring link (match-end 1))))
8668 (org-link-escape link)))
8669 (concat "[[" link "]"
8670 (if description (concat "[" description "]") "")
8671 "]"))
8673 (defconst org-link-escape-chars
8674 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8675 "List of characters that should be escaped in link.
8676 This is the list that is used for internal purposes.")
8678 (defvar org-url-encoding-use-url-hexify nil)
8680 (defconst org-link-escape-chars-browser
8681 '(?\ )
8682 "List of escapes for characters that are problematic in links.
8683 This is the list that is used before handing over to the browser.")
8685 (defun org-link-escape (text &optional table merge)
8686 "Return percent escaped representation of TEXT.
8687 TEXT is a string with the text to escape.
8688 Optional argument TABLE is a list with characters that should be
8689 escaped. When nil, `org-link-escape-chars' is used.
8690 If optional argument MERGE is set, merge TABLE into
8691 `org-link-escape-chars'."
8692 (if (and org-url-encoding-use-url-hexify (not table))
8693 (url-hexify-string text)
8694 (cond
8695 ((and table merge)
8696 (mapc (lambda (defchr)
8697 (unless (member defchr table)
8698 (setq table (cons defchr table)))) org-link-escape-chars))
8699 ((null table)
8700 (setq table org-link-escape-chars)))
8701 (mapconcat
8702 (lambda (char)
8703 (if (or (member char table)
8704 (< char 32) (= char 37) (> char 126))
8705 (mapconcat (lambda (sequence-element)
8706 (format "%%%.2X" sequence-element))
8707 (or (encode-coding-char char 'utf-8)
8708 (error "Unable to percent escape character: %s"
8709 (char-to-string char))) "")
8710 (char-to-string char))) text "")))
8712 (defun org-link-unescape (str)
8713 "Unhex hexified unicode strings as returned from the JavaScript function
8714 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8715 (unless (and (null str) (string= "" str))
8716 (let ((pos 0) (case-fold-search t) unhexed)
8718 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8719 (setq str (replace-match unhexed t t str))
8720 (setq pos (+ pos (length unhexed))))))
8721 str)
8723 (defun org-link-unescape-compound (hex)
8724 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8725 Note: this function also decodes single byte encodings like
8727 (save-match-data
8728 (let* ((bytes (cdr (split-string hex "%")))
8729 (ret "")
8730 (eat 0)
8731 (sum 0))
8732 (while bytes
8733 (let* ((val (string-to-number (pop bytes) 16))
8734 (shift-xor
8735 (if (= 0 eat)
8736 (cond
8737 ((>= val 252) (cons 6 252))
8738 ((>= val 248) (cons 5 248))
8739 ((>= val 240) (cons 4 240))
8740 ((>= val 224) (cons 3 224))
8741 ((>= val 192) (cons 2 192))
8742 (t (cons 0 0)))
8743 (cons 6 128))))
8744 (if (>= val 192) (setq eat (car shift-xor)))
8745 (setq val (logxor val (cdr shift-xor)))
8746 (setq sum (+ (lsh sum (car shift-xor)) val))
8747 (if (> eat 0) (setq eat (- eat 1)))
8748 (cond
8749 ((= 0 eat) ;multi byte
8750 (setq ret (concat ret (org-char-to-string sum)))
8751 (setq sum 0))
8752 ((not bytes) ; single byte(s)
8753 (setq ret (org-link-unescape-single-byte-sequence hex))))
8754 )) ;; end (while bytes
8755 ret )))
8757 (defun org-link-unescape-single-byte-sequence (hex)
8758 "Unhexify hex-encoded single byte character sequences."
8759 (mapconcat (lambda (byte)
8760 (char-to-string (string-to-number byte 16)))
8761 (cdr (split-string hex "%")) ""))
8763 (defun org-xor (a b)
8764 "Exclusive or."
8765 (if a (not b) b))
8767 (defun org-fixup-message-id-for-http (s)
8768 "Replace special characters in a message id, so it can be used in an http query."
8769 (when (string-match "%" s)
8770 (setq s (mapconcat (lambda (c)
8771 (if (eq c ?%)
8772 "%25"
8773 (char-to-string c)))
8774 s "")))
8775 (while (string-match "<" s)
8776 (setq s (replace-match "%3C" t t s)))
8777 (while (string-match ">" s)
8778 (setq s (replace-match "%3E" t t s)))
8779 (while (string-match "@" s)
8780 (setq s (replace-match "%40" t t s)))
8781 s)
8783 ;;;###autoload
8784 (defun org-insert-link-global ()
8785 "Insert a link like Org-mode does.
8786 This command can be called in any mode to insert a link in Org-mode syntax."
8787 (interactive)
8788 (org-load-modules-maybe)
8789 (org-run-like-in-org-mode 'org-insert-link))
8791 (defun org-insert-link (&optional complete-file link-location)
8792 "Insert a link. At the prompt, enter the link.
8794 Completion can be used to insert any of the link protocol prefixes like
8795 http or ftp in use.
8797 The history can be used to select a link previously stored with
8798 `org-store-link'. When the empty string is entered (i.e. if you just
8799 press RET at the prompt), the link defaults to the most recently
8800 stored link. As SPC triggers completion in the minibuffer, you need to
8801 use M-SPC or C-q SPC to force the insertion of a space character.
8803 You will also be prompted for a description, and if one is given, it will
8804 be displayed in the buffer instead of the link.
8806 If there is already a link at point, this command will allow you to edit link
8807 and description parts.
8810 be selected using completion. The path to the file will be relative to the
8811 current directory if the file is in the current directory or a subdirectory.
8812 Otherwise, the link will be the absolute path as completed in the minibuffer
8813 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8814 option `org-link-file-path-type'.
8817 the current directory or below.
8820 `org-keep-stored-link-after-insertion'.
8822 If `org-make-link-description-function' is non-nil, this function will be
8823 called with the link target, and the result will be the default
8824 link description.
8826 If the LINK-LOCATION parameter is non-nil, this value will be
8827 used as the link location instead of reading one interactively."
8828 (interactive "P")
8829 (let* ((wcf (current-window-configuration))
8830 (region (if (org-region-active-p)
8831 (buffer-substring (region-beginning) (region-end))))
8832 (remove (and region (list (region-beginning) (region-end))))
8833 (desc region)
8834 tmphist ; byte-compile incorrectly complains about this
8835 (link link-location)
8836 entry file all-prefixes)
8837 (cond
8838 (link-location) ; specified by arg, just use it.
8839 ((org-in-regexp org-bracket-link-regexp 1)
8840 ;; We do have a link at point, and we are going to edit it.
8841 (setq remove (list (match-beginning 0) (match-end 0)))
8842 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8843 (setq link (read-string "Link: "
8844 (org-link-unescape
8845 (org-match-string-no-properties 1)))))
8846 ((or (org-in-regexp org-angle-link-re)
8847 (org-in-regexp org-plain-link-re))
8848 ;; Convert to bracket link
8849 (setq remove (list (match-beginning 0) (match-end 0))
8850 link (read-string "Link: "
8851 (org-remove-angle-brackets (match-string 0)))))
8852 ((member complete-file '((4) (16)))
8853 ;; Completing read for file names.
8854 (setq link (org-file-complete-link complete-file)))
8855 (t
8856 ;; Read link, with completion for stored links.
8857 (with-output-to-temp-buffer "*Org Links*"
8858 (princ "Insert a link.
8860 (when org-stored-links
8862 (princ (mapconcat
8863 (lambda (x)
8864 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8866 (let ((cw (selected-window)))
8867 (select-window (get-buffer-window "*Org Links*" 'visible))
8868 (setq truncate-lines t)
8869 (unless (pos-visible-in-window-p (point-max))
8870 (org-fit-window-to-buffer))
8871 (and (window-live-p cw) (select-window cw)))
8872 ;; Fake a link history, containing the stored links.
8873 (setq tmphist (append (mapcar 'car org-stored-links)
8874 org-insert-link-history))
8875 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8876 (mapcar 'car org-link-abbrev-alist)
8877 org-link-types))
8878 (unwind-protect
8879 (progn
8880 (setq link
8881 (let ((org-completion-use-ido nil)
8882 (org-completion-use-iswitchb nil))
8883 (org-completing-read
8884 "Link: "
8885 (append
8886 (mapcar (lambda (x) (list (concat x ":")))
8887 all-prefixes)
8888 (mapcar 'car org-stored-links))
8889 nil nil nil
8890 'tmphist
8891 (car (car org-stored-links)))))
8893 (error "No link selected"))
8894 (if (or (member link all-prefixes)
8895 (and (equal ":" (substring link -1))
8896 (member (substring link 0 -1) all-prefixes)
8897 (setq link (substring link 0 -1))))
8898 (setq link (org-link-try-special-completion link))))
8899 (set-window-configuration wcf)
8900 (kill-buffer "*Org Links*"))
8901 (setq entry (assoc link org-stored-links))
8902 (or entry (push link org-insert-link-history))
8903 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8904 (not org-keep-stored-link-after-insertion))
8905 (setq org-stored-links (delq (assoc link org-stored-links)
8906 org-stored-links)))
8907 (setq desc (or desc (nth 1 entry)))))
8909 (if (string-match org-plain-link-re link)
8910 ;; URL-like link, normalize the use of angular brackets.
8911 (setq link (org-make-link (org-remove-angle-brackets link))))
8913 ;; Check if we are linking to the current file with a search option
8914 ;; If yes, simplify the link by using only the search option.
8915 (when (and buffer-file-name
8917 (let* ((path (match-string 1 link))
8918 (case-fold-search nil)
8919 (search (match-string 2 link)))
8920 (save-match-data
8921 (if (equal (file-truename buffer-file-name) (file-truename path))
8922 ;; We are linking to this same file, with a search option
8923 (setq link search)))))
8925 ;; Check if we can/should use a relative path. If yes, simplify the link
8927 (let* ((type (match-string 1 link))
8928 (path (match-string 2 link))
8929 (origpath path)
8930 (case-fold-search nil))
8931 (cond
8932 ((or (eq org-link-file-path-type 'absolute)
8933 (equal complete-file '(16)))
8934 (setq path (abbreviate-file-name (expand-file-name path))))
8935 ((eq org-link-file-path-type 'noabbrev)
8936 (setq path (expand-file-name path)))
8937 ((eq org-link-file-path-type 'relative)
8938 (setq path (file-relative-name path)))
8939 (t
8940 (save-match-data
8941 (if (string-match (concat "^" (regexp-quote
8942 (expand-file-name
8943 (file-name-as-directory
8944 default-directory))))
8945 (expand-file-name path))
8946 ;; We are linking a file with relative path name.
8947 (setq path (substring (expand-file-name path)
8948 (match-end 0)))
8949 (setq path (abbreviate-file-name (expand-file-name path)))))))
8950 (setq link (concat type path))
8951 (if (equal desc origpath)
8952 (setq desc path))))
8954 (if org-make-link-description-function
8955 (setq desc (funcall org-make-link-description-function link desc)))
8957 (setq desc (read-string "Description: " desc))
8959 (if remove (apply 'delete-region remove))
8960 (insert (org-make-link-string link desc))))
8962 (defun org-link-try-special-completion (type)
8963 "If there is completion support for link type TYPE, offer it."
8964 (let ((fun (intern (concat "org-" type "-complete-link"))))
8965 (if (functionp fun)
8966 (funcall fun)
8967 (read-string "Link (no completion support): " (concat type ":")))))
8969 (defun org-file-complete-link (&optional arg)
8970 "Create a file link using completion."
8971 (let (file link)
8972 (setq file (read-file-name "File: "))
8973 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8974 (pwd1 (file-name-as-directory (abbreviate-file-name
8975 (expand-file-name ".")))))
8976 (cond
8977 ((equal arg '(16))
8978 (setq link (org-make-link
8979 "file:"
8980 (abbreviate-file-name (expand-file-name file)))))
8982 (setq link (org-make-link "file:" (match-string 1 file))))
8984 (expand-file-name file))
8985 (setq link (org-make-link
8986 "file:" (match-string 1 (expand-file-name file)))))
8987 (t (setq link (org-make-link "file:" file)))))
8988 link))
8990 (defun org-completing-read (&rest args)
8991 "Completing-read with SPACE being a normal character."
8992 (let ((minibuffer-local-completion-map
8993 (copy-keymap minibuffer-local-completion-map)))
8994 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8995 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8996 (apply 'org-icompleting-read args)))
8998 (defun org-completing-read-no-i (&rest args)
8999 (let (org-completion-use-ido org-completion-use-iswitchb)
9000 (apply 'org-completing-read args)))
9002 (defun org-iswitchb-completing-read (prompt choices &rest args)
9003 "Use iswitch as a completing-read replacement to choose from choices.
9004 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9005 from."
9006 (let* ((iswitchb-use-virtual-buffers nil)
9007 (iswitchb-make-buflist-hook
9008 (lambda ()
9009 (setq iswitchb-temp-buflist choices))))
9010 (iswitchb-read-buffer prompt)))
9012 (defun org-icompleting-read (&rest args)
9013 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9014 (org-without-partial-completion
9015 (if (and org-completion-use-ido
9016 (fboundp 'ido-completing-read)
9017 (boundp 'ido-mode) ido-mode
9018 (listp (second args)))
9019 (let ((ido-enter-matching-directory nil))
9020 (apply 'ido-completing-read (concat (car args))
9021 (if (consp (car (nth 1 args)))
9022 (mapcar 'car (nth 1 args))
9023 (nth 1 args))
9024 (cddr args)))
9025 (if (and org-completion-use-iswitchb
9026 (boundp 'iswitchb-mode) iswitchb-mode
9027 (listp (second args)))
9028 (apply 'org-iswitchb-completing-read (concat (car args))
9029 (if (consp (car (nth 1 args)))
9030 (mapcar 'car (nth 1 args))
9031 (nth 1 args))
9032 (cddr args))
9033 (apply 'completing-read args)))))
9035 (defun org-extract-attributes (s)
9036 "Extract the attributes cookie from a string and set as text property."
9037 (let (a attr (start 0) key value)
9038 (save-match-data
9040 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9042 (setq key (match-string 1 a) value (match-string 2 a)
9043 start (match-end 0)
9044 attr (plist-put attr (intern key) value))))
9045 (org-add-props s nil 'org-attr attr))
9046 s))
9048 (defun org-extract-attributes-from-string (tag)
9049 (let (key value attr)
9051 (setq key (match-string 1 tag) value (match-string 2 tag)
9052 tag (replace-match "" t t tag)
9053 attr (plist-put attr (intern key) value)))
9054 (cons tag attr)))
9056 (defun org-attributes-to-string (plist)
9057 "Format a property list into an HTML attribute list."
9058 (let ((s "") key value)
9059 (while plist
9060 (setq key (pop plist) value (pop plist))
9061 (and value
9063 s))
9065 ;;; Opening/following a link
9067 (defvar org-link-search-failed nil)
9069 (defvar org-open-link-functions nil
9070 "Hook for functions finding a plain text link.
9071 These functions must take a single argument, the link content.
9072 They will be called for links that look like [[link text][description]]
9076 These functions will be called *before* Org attempts to resolve the
9077 link by doing text searches in the current buffer - so if you want a
9079 handle this as a special case.
9081 When the function does handle the link, it must return a non-nil value.
9082 If it decides that it is not responsible for this link, it must return
9083 nil to indicate that that Org-mode can continue with other options
9084 like exact and fuzzy text search.")
9086 (defun org-next-link ()
9087 "Move forward to the next link.
9088 If the link is in hidden text, expose it."
9089 (interactive)
9090 (when (and org-link-search-failed (eq this-command last-command))
9091 (goto-char (point-min))
9092 (message "Link search wrapped back to beginning of buffer"))
9093 (setq org-link-search-failed nil)
9094 (let* ((pos (point))
9095 (ct (org-context))
9096 (a (assoc :link ct)))
9097 (if a (goto-char (nth 2 a)))
9098 (if (re-search-forward org-any-link-re nil t)
9099 (progn
9100 (goto-char (match-beginning 0))
9101 (if (outline-invisible-p) (org-show-context)))
9102 (goto-char pos)
9103 (setq org-link-search-failed t)
9104 (error "No further link found"))))
9106 (defun org-previous-link ()
9107 "Move backward to the previous link.
9108 If the link is in hidden text, expose it."
9109 (interactive)
9110 (when (and org-link-search-failed (eq this-command last-command))
9111 (goto-char (point-max))
9112 (message "Link search wrapped back to end of buffer"))
9113 (setq org-link-search-failed nil)
9114 (let* ((pos (point))
9115 (ct (org-context))
9116 (a (assoc :link ct)))
9117 (if a (goto-char (nth 1 a)))
9118 (if (re-search-backward org-any-link-re nil t)
9119 (progn
9120 (goto-char (match-beginning 0))
9121 (if (outline-invisible-p) (org-show-context)))
9122 (goto-char pos)
9123 (setq org-link-search-failed t)
9124 (error "No further link found"))))
9126 (defun org-translate-link (s)
9127 "Translate a link string if a translation function has been defined."
9128 (if (and org-link-translation-function
9129 (fboundp org-link-translation-function)
9131 (progn
9132 (setq s (funcall org-link-translation-function
9133 (match-string 1) (match-string 2)))
9134 (concat (car s) ":" (cdr s)))
9135 s))
9137 (defun org-translate-link-from-planner (type path)
9138 "Translate a link from Emacs Planner syntax so that Org can follow it.
9139 This is still an experimental function, your mileage may vary."
9140 (cond
9141 ((member type '("http" "https" "news" "ftp"))
9142 ;; standard Internet links are the same.
9143 nil)
9144 ((and (equal type "irc") (string-match "^//" path))
9145 ;; Planner has two / at the beginning of an irc link, we have 1.
9146 ;; We should have zero, actually....
9147 (setq path (substring path 1)))
9148 ((and (equal type "lisp") (string-match "^/" path))
9149 ;; Planner has a slash, we do not.
9150 (setq type "elisp" path (substring path 1)))
9152 ;; A typical message link. Planner has the id after the final slash,
9153 ;; we separate it with a hash mark
9154 (setq path (concat (match-string 1 path) "#"
9155 (org-remove-angle-brackets (match-string 2 path)))))
9156 )
9157 (cons type path))
9159 (defun org-find-file-at-mouse (ev)
9160 "Open file link or URL at mouse."
9161 (interactive "e")
9162 (mouse-set-point ev)
9163 (org-open-at-point 'in-emacs))
9165 (defun org-open-at-mouse (ev)
9166 "Open file link or URL at mouse."
9167 (interactive "e")
9168 (mouse-set-point ev)
9169 (if (eq major-mode 'org-agenda-mode)
9170 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9171 (org-open-at-point))
9173 (defvar org-window-config-before-follow-link nil
9174 "The window configuration before following a link.
9175 This is saved in case the need arises to restore it.")
9177 (defvar org-open-link-marker (make-marker)
9178 "Marker pointing to the location where `org-open-at-point; was called.")
9180 ;;;###autoload
9181 (defun org-open-at-point-global ()
9182 "Follow a link like Org-mode does.
9183 This command can be called in any mode to follow a link that has
9184 Org-mode syntax."
9185 (interactive)
9186 (org-run-like-in-org-mode 'org-open-at-point))
9188 ;;;###autoload
9189 (defun org-open-link-from-string (s &optional arg reference-buffer)
9190 "Open a link in the string S, as if it was in Org-mode."
9192 (let ((reference-buffer (or reference-buffer (current-buffer))))
9193 (with-temp-buffer
9194 (let ((org-inhibit-startup t))
9195 (org-mode)
9196 (insert s)
9197 (goto-char (point-min))
9198 (when reference-buffer
9199 (setq org-link-abbrev-alist-local
9200 (with-current-buffer reference-buffer
9201 org-link-abbrev-alist-local)))
9202 (org-open-at-point arg reference-buffer)))))
9204 (defvar org-open-at-point-functions nil
9205 "Hook that is run when following a link at point.
9207 Functions in this hook must return t if they identify and follow
9208 a link at point. If they don't find anything interesting at point,
9209 they must return nil.")
9211 (defun org-open-at-point (&optional arg reference-buffer)
9212 "Open link at or after point.
9213 If there is no link at point, this function will search forward up to
9214 the end of the current line.
9215 Normally, files will be opened by an appropriate application. If the
9216 optional prefix argument ARG is non-nil, Emacs will visit the file.
9217 With a double prefix argument, try to open outside of Emacs, in the
9218 application the system uses for this file type."
9219 (interactive "P")
9220 ;; if in a code block, then open the block's results
9221 (unless (call-interactively #'org-babel-open-src-block-result)
9222 (org-load-modules-maybe)
9223 (move-marker org-open-link-marker (point))
9224 (setq org-window-config-before-follow-link (current-window-configuration))
9225 (org-remove-occur-highlights nil nil t)
9226 (cond
9227 ((and (org-on-heading-p)
9228 (not (org-in-regexp
9233 (not (get-text-property (point) 'org-linked-text)))
9234 (or (org-offer-links-in-entry arg)
9235 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9236 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9237 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9238 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9239 (not (org-in-regexp org-bracket-link-regexp)))
9240 (org-footnote-action))
9241 (t
9242 (let (type path link line search (pos (point)))
9243 (catch 'match
9244 (save-excursion
9246 (when (org-in-regexp org-bracket-link-regexp 1)
9247 (setq link (org-extract-attributes
9248 (org-link-unescape (org-match-string-no-properties 1))))
9250 (setq link (replace-match " " t t link)))
9251 (setq link (org-link-expand-abbrev link))
9252 (cond
9253 ((or (file-name-absolute-p link)
9255 (setq type "file" path link))
9256 ((string-match org-link-re-with-space3 link)
9257 (setq type (match-string 1 link) path (match-string 2 link)))
9258 (t (setq type "thisfile" path link)))
9259 (throw 'match t)))
9261 (when (get-text-property (point) 'org-linked-text)
9262 (setq type "thisfile"
9263 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9264 (1+ (point)) (point))
9265 path (buffer-substring
9266 (or (previous-single-property-change pos 'org-linked-text)
9267 (point-min))
9268 (or (next-single-property-change pos 'org-linked-text)
9269 (point-max))))
9270 (throw 'match t))
9272 (save-excursion
9273 (when (or (org-in-regexp org-angle-link-re)
9274 (org-in-regexp org-plain-link-re))
9275 (setq type (match-string 1) path (match-string 2))
9276 (throw 'match t)))
9277 (save-excursion
9279 (setq type "tags"
9280 path (match-string 1))
9281 (while (string-match ":" path)
9282 (setq path (replace-match "+" t t path)))
9283 (throw 'match t)))
9285 (setq type "tree-match"
9286 path (match-string 1))
9287 (throw 'match t)))
9288 (unless path
9289 (error "No link found"))
9291 ;; switch back to reference buffer
9292 ;; needed when if called in a temporary buffer through
9293 ;; org-open-link-from-string
9294 (with-current-buffer (or reference-buffer (current-buffer))
9296 ;; Remove any trailing spaces in path
9298 (setq path (replace-match "" t t path)))
9299 (if (and org-link-translation-function
9300 (fboundp org-link-translation-function))
9301 ;; Check if we need to translate the link
9302 (let ((tmp (funcall org-link-translation-function type path)))
9303 (setq type (car tmp) path (cdr tmp))))
9305 (cond
9307 ((assoc type org-link-protocols)
9308 (funcall (nth 1 (assoc type org-link-protocols)) path))
9310 ((equal type "mailto")
9311 (let ((cmd (car org-link-mailto-program))
9312 (args (cdr org-link-mailto-program)) args1
9313 (address path) (subject "") a)
9315 (setq address (match-string 1 path)
9316 subject (org-link-escape (match-string 2 path))))
9317 (while args
9318 (cond
9319 ((not (stringp (car args))) (push (pop args) args1))
9320 (t (setq a (pop args))
9321 (if (string-match "%a" a)
9322 (setq a (replace-match address t t a)))
9323 (if (string-match "%s" a)
9324 (setq a (replace-match subject t t a)))
9325 (push a args1))))
9326 (apply cmd (nreverse args1))))
9328 ((member type '("http" "https" "ftp" "news"))
9329 (browse-url (concat type ":" (org-link-escape
9330 path org-link-escape-chars-browser))))
9332 ((string= type "doi")
9333 (browse-url (concat "http://dx.doi.org/"
9334 (org-link-escape
9335 path org-link-escape-chars-browser))))
9337 ((member type '("message"))
9338 (browse-url (concat type ":" path)))
9340 ((string= type "tags")
9341 (org-tags-view arg path))
9343 ((string= type "tree-match")
9346 ((string= type "file")
9348 (setq line (string-to-number (match-string 1 path))
9349 path (substring path 0 (match-beginning 0)))
9351 (setq search (match-string 1 path)
9352 path (substring path 0 (match-beginning 0)))))
9353 (if (string-match "[*?{]" (file-name-nondirectory path))
9354 (dired path)
9355 (org-open-file path arg line search)))
9357 ((string= type "shell")
9358 (let ((cmd path))
9359 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9360 (string-match org-confirm-shell-link-not-regexp cmd))
9361 (not org-confirm-shell-link-function)
9362 (funcall org-confirm-shell-link-function
9364 (org-add-props cmd nil
9365 'face 'org-warning))))
9366 (progn
9367 (message "Executing %s" cmd)
9368 (shell-command cmd))
9369 (error "Abort"))))
9371 ((string= type "elisp")
9372 (let ((cmd path))
9373 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9374 (string-match org-confirm-elisp-link-not-regexp cmd))
9375 (not org-confirm-elisp-link-function)
9376 (funcall org-confirm-elisp-link-function
9378 (org-add-props cmd nil
9379 'face 'org-warning))))
9380 (message "%s => %s" cmd
9381 (if (equal (string-to-char cmd) ?\()
9382 (eval (read cmd))
9383 (call-interactively (read cmd))))
9384 (error "Abort"))))
9386 ((and (string= type "thisfile")
9387 (run-hook-with-args-until-success
9388 'org-open-link-functions path)))
9390 ((string= type "thisfile")
9391 (if arg
9392 (switch-to-buffer-other-window
9393 (org-get-buffer-for-internal-link (current-buffer)))
9394 (org-mark-ring-push))
9395 (let ((cmd `(org-link-search
9396 ,path
9397 ,(cond ((equal arg '(4)) ''occur)
9398 ((equal arg '(16)) ''org-occur)
9399 (t nil))
9400 ,pos)))
9401 (condition-case nil (eval cmd)
9402 (error (progn (widen) (eval cmd))))))
9404 (t
9405 (browse-url-at-point)))))))
9406 (move-marker org-open-link-marker nil)
9407 (run-hook-with-args 'org-follow-link-hook)))
9409 (defun org-offer-links-in-entry (&optional nth zero)
9410 "Offer links in the current entry and follow the selected link.
9411 If there is only one link, follow it immediately as well.
9412 If NTH is an integer, immediately pick the NTH link found.
9413 If ZERO is a string, check also this string for a link, and if
9414 there is one, offer it as link number zero."
9418 (cnt ?0)
9419 (in-emacs (if (integerp nth) nil nth))
9420 have-zero end links link c)
9421 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9422 (push (match-string 0 zero) links)
9423 (setq cnt (1- cnt) have-zero t))
9424 (save-excursion
9425 (org-back-to-heading t)
9426 (setq end (save-excursion (outline-next-heading) (point)))
9427 (while (re-search-forward re end t)
9428 (push (match-string 0) links))
9429 (setq links (org-uniquify (reverse links))))
9431 (cond
9432 ((null links)
9433 (message "No links"))
9434 ((equal (length links) 1)
9435 (setq link (list (car links))))
9436 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9437 (setq link (nth (if have-zero nth (1- nth)) links)))
9438 (t ; we have to select a link
9439 (save-excursion
9440 (save-window-excursion
9441 (delete-other-windows)
9442 (with-output-to-temp-buffer "*Select Link*"
9443 (mapc (lambda (l)
9444 (if (not (string-match org-bracket-link-regexp l))
9446 (org-remove-angle-brackets l)))
9447 (if (match-end 3)
9449 (match-string 3 l) (match-string 1 l)))
9451 (match-string 1 l))))))
9452 links))
9453 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9454 (message "Select link to open, RET to open all:")
9455 (setq c (read-char-exclusive))
9456 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9457 (when (equal c ?q) (error "Abort"))
9458 (if (equal c ?\C-m)
9459 (setq link links)
9460 (setq nth (- c ?0))
9461 (if have-zero (setq nth (1+ nth)))
9462 (unless (and (integerp nth) (>= (length links) nth))
9463 (error "Invalid link selection"))
9464 (setq link (list (nth (1- nth) links))))))
9465 (if link
9466 (let ((buf (current-buffer)))
9467 (dolist (l link)
9468 (org-open-link-from-string l in-emacs buf))
9469 t)
9470 nil)))
9472 ;; Add special file links that specify the way of opening
9474 (org-add-link-type "file+sys" 'org-open-file-with-system)
9475 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9476 (defun org-open-file-with-system (path)
9477 "Open file at PATH using the system way of opening it."
9478 (org-open-file path 'system))
9479 (defun org-open-file-with-emacs (path)
9480 "Open file at PATH in Emacs."
9481 (org-open-file path 'emacs))
9482 (defun org-remove-file-link-modifiers ()
9483 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9484 (goto-char (point-min))
9486 (org-if-unprotected
9487 (replace-match "file:" t t))))
9488 (eval-after-load "org-exp"
9489 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9490 'org-remove-file-link-modifiers))
9492 ;;;; Time estimates
9494 (defun org-get-effort (&optional pom)
9495 "Get the effort estimate for the current entry."
9496 (org-entry-get pom org-effort-property))
9498 ;;; File search
9500 (defvar org-create-file-search-functions nil
9501 "List of functions to construct the right search string for a file link.
9502 These functions are called in turn with point at the location to
9503 which the link should point.
9505 A function in the hook should first test if it would like to
9506 handle this file type, for example by checking the `major-mode'
9507 or the file extension. If it decides not to handle this file, it
9508 should just return nil to give other functions a chance. If it
9509 does handle the file, it must return the search string to be used
9510 when following the link. The search string will be part of the
9511 file link, given after a double colon, and `org-open-at-point'
9512 will automatically search for it. If special measures must be
9513 taken to make the search successful, another function should be
9514 added to the companion hook `org-execute-file-search-functions',
9515 which see.
9517 A function in this hook may also use `setq' to set the variable
9518 `description' to provide a suggestion for the descriptive text to
9519 be used for this link when it gets inserted into an Org-mode
9522 (defvar org-execute-file-search-functions nil
9523 "List of functions to execute a file search triggered by a link.
9525 Functions added to this hook must accept a single argument, the
9526 search string that was part of the file link, the part after the
9527 double colon. The function must first check if it would like to
9528 handle this search, for example by checking the `major-mode' or
9529 the file extension. If it decides not to handle this search, it
9530 should just return nil to give other functions a chance. If it
9531 does handle the search, it must return a non-nil value to keep
9532 other functions from trying.
9534 Each function can access the current prefix argument through the
9535 variable `current-prefix-argument'. Note that a single prefix is
9536 used to force opening a link in Emacs, so it may be good to only
9537 use a numeric or double prefix to guide the search function.
9539 In case this is needed, a function in this hook can also restore
9540 the window configuration before `org-open-at-point' was called using:
9542 (set-window-configuration org-window-config-before-follow-link)")
9544 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9545 (defun org-link-search (s &optional type avoid-pos)
9546 "Search for a link search option.
9547 If S is surrounded by forward slashes, it is interpreted as a
9548 regular expression. In org-mode files, this will create an `org-occur'
9549 sparse tree. In ordinary files, `occur' will be used to list matches.
9550 If the current buffer is in `dired-mode', grep will be used to search
9551 in all files. If AVOID-POS is given, ignore matches near that position."
9552 (let ((case-fold-search t)
9556 org-emphasis-alist)
9558 (pos (point))
9559 (pre nil) (post nil)
9560 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9561 (cond
9562 ;; First check if there are any special search functions
9563 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9564 ;; Now try the builtin stuff
9565 ((and (equal (string-to-char s0) ?#)
9566 (> (length s0) 1)
9567 (save-excursion
9568 (goto-char (point-min))
9569 (and
9570 (re-search-forward
9572 (setq type 'dedicated
9573 pos (match-beginning 0))))
9574 ;; There is an exact target for this
9575 (goto-char pos)
9576 (org-back-to-heading t)))
9577 ((save-excursion
9578 (goto-char (point-min))
9579 (and
9580 (re-search-forward
9581 (concat "<<" (regexp-quote s0) ">>") nil t)
9582 (setq type 'dedicated
9583 pos (match-beginning 0))))
9584 ;; There is an exact target for this
9585 (goto-char pos))
9587 (save-excursion
9588 (goto-char (point-min))
9589 (and
9590 (re-search-forward
9591 (concat "[^[]" (regexp-quote
9592 (format org-coderef-label-format
9593 (match-string 1 s0))))
9594 nil t)
9595 (setq type 'dedicated
9596 pos (1+ (match-beginning 0))))))
9597 ;; There is a coderef target for this
9598 (goto-char pos))
9600 ;; A regular expression
9601 (cond
9602 ((org-mode-p)
9603 (org-occur (match-string 1 s)))
9604 ;;((eq major-mode 'dired-mode)
9605 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9606 (t (org-do-occur (match-string 1 s)))))
9607 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9608 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9609 (goto-char (point-min))
9610 (cond
9611 ((let (case-fold-search)
9612 (re-search-forward (format org-complex-heading-regexp-format
9613 (regexp-quote s))
9614 nil t))
9615 ;; OK, found a match
9616 (setq type 'dedicated)
9617 (goto-char (match-beginning 0)))
9618 ((and (not org-link-search-inhibit-query)
9619 (eq org-link-search-must-match-exact-headline 'query-to-create)
9620 (y-or-n-p "No match - create this as a new heading? "))
9621 (goto-char (point-max))
9622 (or (bolp) (newline))
9624 (beginning-of-line 0))
9625 (t
9626 (goto-char pos)
9627 (error "No match"))))
9628 (t
9629 ;; A normal search string
9630 (when (equal (string-to-char s) ?*)
9631 ;; Anchor on headlines, post may include tags.
9634 s (substring s 1)))
9635 (remove-text-properties
9636 0 (length s)
9637 '(face nil mouse-face nil keymap nil fontified nil) s)
9638 ;; Make a series of regular expressions to find a match
9647 re4 (concat "[^a-zA-Z_]" re4_)
9649 re1 (concat pre re2 post)
9650 re3 (concat pre (if pre re4_ re4) post)
9651 re5 (concat pre ".*" re4)
9652 re2 (concat pre re2)
9653 re2a (concat pre (if pre re2a_ re2a))
9654 re4 (concat pre (if pre re4_ re4))
9658 ))
9659 (cond
9660 ((eq type 'org-occur) (org-occur reall))
9661 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9662 (t (goto-char (point-min))
9663 (setq type 'fuzzy)
9664 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9665 (org-search-not-self 1 re1 nil t)
9666 (org-search-not-self 1 re2 nil t)
9667 (org-search-not-self 1 re2a nil t)
9668 (org-search-not-self 1 re3 nil t)
9669 (org-search-not-self 1 re4 nil t)
9670 (org-search-not-self 1 re5 nil t)
9671 )
9672 (goto-char (match-beginning 1))
9673 (goto-char pos)
9674 (error "No match"))))))
9675 (and (org-mode-p) (org-show-context 'link-search))
9676 type))
9678 (defun org-search-not-self (group &rest args)
9679 "Execute `re-search-forward', but only accept matches that do not
9680 enclose the position of `org-open-link-marker'."
9681 (let ((m org-open-link-marker))
9682 (catch 'exit
9683 (while (apply 're-search-forward args)
9684 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9685 (goto-char (match-end group))
9686 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9687 (> (match-beginning 0) (marker-position m))
9688 (< (match-end 0) (marker-position m)))
9689 (save-match-data
9690 (or (not (org-in-regexp
9691 org-bracket-link-analytic-regexp 1))
9692 (not (match-end 4)) ; no description
9693 (and (<= (match-beginning 4) (point))
9694 (>= (match-end 4) (point))))))
9695 (throw 'exit (point))))))))
9697 (defun org-get-buffer-for-internal-link (buffer)
9698 "Return a buffer to be used for displaying the link target of internal links."
9699 (cond
9700 ((not org-display-internal-link-with-indirect-buffer)
9701 buffer)
9702 ((string-match "(Clone)$" (buffer-name buffer))
9703 (message "Buffer is already a clone, not making another one")
9704 ;; we also do not modify visibility in this case
9705 buffer)
9706 (t ; make a new indirect buffer for displaying the link
9707 (let* ((bn (buffer-name buffer))
9708 (ibn (concat bn "(Clone)"))
9709 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9710 (with-current-buffer ib (org-overview))
9711 ib))))
9713 (defun org-do-occur (regexp &optional cleanup)
9714 "Call the Emacs command `occur'.
9715 If CLEANUP is non-nil, remove the printout of the regular expression
9716 in the *Occur* buffer. This is useful if the regex is long and not useful
9717 to read."
9718 (occur regexp)
9719 (when cleanup
9720 (let ((cwin (selected-window)) win beg end)
9721 (when (setq win (get-buffer-window "*Occur*"))
9722 (select-window win))
9723 (goto-char (point-min))
9724 (when (re-search-forward "match[a-z]+" nil t)
9725 (setq beg (match-end 0))
9727 (setq end (1- (match-beginning 0)))))
9728 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9729 (goto-char (point-min))
9730 (select-window cwin))))
9732 ;;; The mark ring for links jumps
9734 (defvar org-mark-ring nil
9735 "Mark ring for positions before jumps in Org-mode.")
9736 (defvar org-mark-ring-last-goto nil
9737 "Last position in the mark ring used to go back.")
9738 ;; Fill and close the ring
9739 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9740 (loop for i from 1 to org-mark-ring-length do
9741 (push (make-marker) org-mark-ring))
9742 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9743 org-mark-ring)
9745 (defun org-mark-ring-push (&optional pos buffer)
9746 "Put the current position or POS into the mark ring and rotate it."
9747 (interactive)
9748 (setq pos (or pos (point)))
9749 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9750 (move-marker (car org-mark-ring)
9751 (or pos (point))
9752 (or buffer (current-buffer)))
9753 (message "%s"
9754 (substitute-command-keys
9757 (defun org-mark-ring-goto (&optional n)
9758 "Jump to the previous position in the mark ring.
9759 With prefix arg N, jump back that many stored positions. When
9760 called several times in succession, walk through the entire ring.
9761 Org-mode commands jumping to a different position in the current file,
9762 or to another Org-mode file, automatically push the old position
9763 onto the ring."
9764 (interactive "p")
9765 (let (p m)
9766 (if (eq last-command this-command)
9767 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9768 (setq p org-mark-ring))
9769 (setq org-mark-ring-last-goto p)
9770 (setq m (car p))
9771 (switch-to-buffer (marker-buffer m))
9772 (goto-char m)
9773 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9775 (defun org-remove-angle-brackets (s)
9776 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9777 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9778 s)
9779 (defun org-add-angle-brackets (s)
9780 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9781 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9782 s)
9783 (defun org-remove-double-quotes (s)
9786 s)
9788 ;;; Following specific links
9790 (defun org-follow-timestamp-link ()
9791 (cond
9792 ((org-at-date-range-p t)
9793 (let ((org-agenda-start-on-weekday)
9794 (t1 (match-string 1))
9795 (t2 (match-string 2)))
9796 (setq t1 (time-to-days (org-time-string-to-time t1))
9797 t2 (time-to-days (org-time-string-to-time t2)))
9798 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9799 ((org-at-timestamp-p t)
9800 (org-agenda-list nil (time-to-days (org-time-string-to-time
9801 (substring (match-string 1) 0 10)))
9802 1))
9803 (t (error "This should not happen"))))
9806 ;;; Following file links
9807 (defvar org-wait nil)
9808 (defun org-open-file (path &optional in-emacs line search)
9809 "Open the file at PATH.
9810 First, this expands any special file name abbreviations. Then the
9811 configuration variable `org-file-apps' is checked if it contains an
9812 entry for this file type, and if yes, the corresponding command is launched.
9814 If no application is found, Emacs simply visits the file.
9816 With optional prefix argument IN-EMACS, Emacs will visit the file.
9818 prefix arg, Org tries to avoid opening in Emacs
9819 and to use an external application to visit the file.
9821 Optional LINE specifies a line to go to, optional SEARCH a string
9822 to search for. If LINE or SEARCH is given, the file will be
9823 opened in Emacs, unless an entry from org-file-apps that makes
9824 use of groups in a regexp matches.
9825 If the file does not exist, an error is thrown."
9826 (let* ((file (if (equal path "")
9827 buffer-file-name
9828 (substitute-in-file-name (expand-file-name path))))
9829 (file-apps (append org-file-apps (org-default-apps)))
9830 (apps (org-remove-if
9831 'org-file-apps-entry-match-against-dlink-p file-apps))
9832 (apps-dlink (org-remove-if-not
9833 'org-file-apps-entry-match-against-dlink-p file-apps))
9834 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9835 (dirp (if remp nil (file-directory-p file)))
9836 (file (if (and dirp org-open-directory-means-index-dot-org)
9837 (concat (file-name-as-directory file) "index.org")
9838 file))
9839 (a-m-a-p (assq 'auto-mode apps))
9840 (dfile (downcase file))
9841 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9842 (link (cond ((and (eq line nil)
9843 (eq search nil))
9844 file)
9845 (line
9846 (concat file "::" (number-to-string line)))
9847 (search
9848 (concat file "::" search))))
9849 (dlink (downcase link))
9850 (old-buffer (current-buffer))
9851 (old-pos (point))
9852 (old-mode major-mode)
9853 ext cmd link-match-data)
9855 (setq ext (match-string 1 dfile))
9857 (setq ext (match-string 1 dfile))))
9858 (cond
9859 ((member in-emacs '((16) system))
9860 (setq cmd (cdr (assoc 'system apps))))
9861 (in-emacs (setq cmd 'emacs))
9862 (t
9863 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9864 (and dirp (cdr (assoc 'directory apps)))
9865 ; first, try matching against apps-dlink
9866 ; if we get a match here, store the match data for later
9867 (let ((match (assoc-default dlink apps-dlink
9868 'string-match)))
9869 (if match
9870 (progn (setq link-match-data (match-data))
9871 match)
9872 (progn (setq in-emacs (or in-emacs line search))
9873 nil))) ; if we have no match in apps-dlink,
9874 ; always open the file in emacs if line or search
9875 ; is given (for backwards compatibility)
9876 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9877 'string-match)
9878 (cdr (assoc ext apps))
9879 (cdr (assoc t apps))))))
9880 (when (eq cmd 'system)
9881 (setq cmd (cdr (assoc 'system apps))))
9882 (when (eq cmd 'default)
9883 (setq cmd (cdr (assoc t apps))))
9884 (when (eq cmd 'mailcap)
9885 (require 'mailcap)
9886 (mailcap-parse-mailcaps)
9887 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9888 (command (mailcap-mime-info mime-type)))
9889 (if (stringp command)
9890 (setq cmd command)
9891 (setq cmd 'emacs))))
9892 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9893 (not (file-exists-p file))
9894 (not org-open-non-existing-files))
9895 (error "No such file: %s" file))
9896 (cond
9898 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9900 (setq cmd (replace-match "%s" t t cmd)))
9901 (while (string-match "%s" cmd)
9902 (setq cmd (replace-match
9903 (save-match-data
9904 (shell-quote-argument
9905 (convert-standard-filename file)))
9906 t t cmd)))
9908 ;; Replace "%1", "%2" etc. in command with group matches from regex
9909 (save-match-data
9910 (let ((match-index 1)
9911 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9912 (set-match-data link-match-data)
9913 (while (<= match-index number-of-groups)
9914 (let ((regex (concat "%" (number-to-string match-index)))
9915 (replace-with (match-string match-index dlink)))
9916 (while (string-match regex cmd)
9917 (setq cmd (replace-match replace-with t t cmd))))
9918 (setq match-index (+ match-index 1)))))
9920 (save-window-excursion
9921 (start-process-shell-command cmd nil cmd)
9922 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9923 ))
9924 ((or (stringp cmd)
9925 (eq cmd 'emacs))
9926 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9927 (widen)
9928 (if line (org-goto-line line)
9929 (if search (org-link-search search))))
9930 ((consp cmd)
9931 (let ((file (convert-standard-filename file)))
9932 (save-match-data
9933 (set-match-data link-match-data)
9934 (eval cmd))))
9935 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9936 (and (org-mode-p) (eq old-mode 'org-mode)
9937 (or (not (equal old-buffer (current-buffer)))
9938 (not (equal old-pos (point))))
9939 (org-mark-ring-push old-pos old-buffer))))
9941 (defun org-file-apps-entry-match-against-dlink-p (entry)
9942 "This function returns non-nil if `entry' uses a regular
9943 expression which should be matched against the whole link by
9944 org-open-file.
9946 It assumes that is the case when the entry uses a regular
9947 expression which has at least one grouping construct and the
9948 action is either a lisp form or a command string containing
9949 '%1', i.e. using at least one subexpression match as a
9950 parameter."
9951 (let ((selector (car entry))
9952 (action (cdr entry)))
9953 (if (stringp selector)
9954 (and (> (regexp-opt-depth selector) 0)
9955 (or (and (stringp action)
9956 (string-match "%[0-9]" action))
9957 (consp action)))
9958 nil)))
9960 (defun org-default-apps ()
9961 "Return the default applications for this operating system."
9962 (cond
9963 ((eq system-type 'darwin)
9964 org-file-apps-defaults-macosx)
9965 ((eq system-type 'windows-nt)
9966 org-file-apps-defaults-windowsnt)
9967 (t org-file-apps-defaults-gnu)))
9969 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9970 "Convert extensions to regular expressions in the cars of LIST.
9971 Also, weed out any non-string entries, because the return value is used
9972 only for regexp matching.
9973 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9974 point to the symbol `emacs', indicating that the file should
9975 be opened in Emacs."
9976 (append
9977 (delq nil
9978 (mapcar (lambda (x)
9979 (if (not (stringp (car x)))
9980 nil
9982 x
9984 list))
9985 (if add-auto-mode
9986 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9988 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9989 (defun org-file-remote-p (file)
9990 "Test whether FILE specifies a location on a remote system.
9991 Return non-nil if the location is indeed remote.
9995 (cond ((fboundp 'file-remote-p)
9996 (file-remote-p file))
9997 ((fboundp 'tramp-handle-file-remote-p)
9998 (tramp-handle-file-remote-p file))
9999 ((and (boundp 'ange-ftp-name-format)
10000 (string-match (car ange-ftp-name-format) file))
10001 t)
10002 (t nil)))
10005 ;;;; Refiling
10007 (defun org-get-org-file ()
10008 "Read a filename, with default directory `org-directory'."
10009 (let ((default (or org-default-notes-file remember-data-file)))
10010 (read-file-name (format "File name [%s]: " default)
10011 (file-name-as-directory org-directory)
10012 default)))
10014 (defun org-notes-order-reversed-p ()
10015 "Check if the current file should receive notes in reversed order."
10016 (cond
10017 ((not org-reverse-note-order) nil)
10018 ((eq t org-reverse-note-order) t)
10019 ((not (listp org-reverse-note-order)) nil)
10020 (t (catch 'exit
10021 (let ((all org-reverse-note-order)
10022 entry)
10023 (while (setq entry (pop all))
10024 (if (string-match (car entry) buffer-file-name)
10025 (throw 'exit (cdr entry))))
10026 nil)))))
10028 (defvar org-refile-target-table nil
10029 "The list of refile targets, created by `org-refile'.")
10031 (defvar org-agenda-new-buffers nil
10032 "Buffers created to visit agenda files.")
10034 (defvar org-refile-cache nil
10035 "Cache for refile targets.")
10037 (defvar org-refile-markers nil
10038 "All the markers used for caching refile locations.")
10040 (defun org-refile-marker (pos)
10041 "Get a new refile marker, but only if caching is in use."
10042 (if (not org-refile-use-cache)
10043 pos
10044 (let ((m (make-marker)))
10045 (move-marker m pos)
10046 (push m org-refile-markers)
10047 m)))
10049 (defun org-refile-cache-clear ()
10050 "Clear the refile cache and disable all the markers."
10051 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10052 (setq org-refile-markers nil)
10053 (setq org-refile-cache nil)
10054 (message "Refile cache has been cleared"))
10056 (defun org-refile-cache-check-set (set)
10057 "Check if all the markers in the cache still have live buffers."
10058 (let (marker)
10059 (catch 'exit
10060 (while (and set (setq marker (nth 3 (pop set))))
10061 ;; if org-refile-use-outline-path is 'file, marker may be nil
10062 (when (and marker (null (marker-buffer marker)))
10063 (message "not found") (sit-for 3)
10064 (throw 'exit nil)))
10065 t)))
10067 (defun org-refile-cache-put (set &rest identifiers)
10068 "Push the refile targets SET into the cache, under IDENTIFIERS."
10069 (let* ((key (sha1 (prin1-to-string identifiers)))
10070 (entry (assoc key org-refile-cache)))
10071 (if entry
10072 (setcdr entry set)
10073 (push (cons key set) org-refile-cache))))
10075 (defun org-refile-cache-get (&rest identifiers)
10076 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10077 (cond
10078 ((not org-refile-cache) nil)
10079 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10080 (t
10081 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10082 org-refile-cache))))
10083 (and set (org-refile-cache-check-set set) set)))))
10085 (defun org-refile-get-targets (&optional default-buffer)
10086 "Produce a table with refile targets."
10087 (let ((case-fold-search nil)
10088 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10089 (entries (or org-refile-targets '((nil . (:level . 1)))))
10090 targets tgs txt re files f desc descre fast-path-p level pos0)
10091 (message "Getting targets...")
10092 (with-current-buffer (or default-buffer (current-buffer))
10093 (while (setq entry (pop entries))
10094 (setq files (car entry) desc (cdr entry))
10095 (setq fast-path-p nil)
10096 (cond
10097 ((null files) (setq files (list (current-buffer))))
10098 ((eq files 'org-agenda-files)
10099 (setq files (org-agenda-files 'unrestricted)))
10100 ((and (symbolp files) (fboundp files))
10101 (setq files (funcall files)))
10102 ((and (symbolp files) (boundp files))
10103 (setq files (symbol-value files))))
10104 (if (stringp files) (setq files (list files)))
10105 (cond
10106 ((eq (car desc) :tag)
10108 ((eq (car desc) :todo)
10110 ((eq (car desc) :regexp)
10111 (setq descre (cdr desc)))
10112 ((eq (car desc) :level)
10114 (if org-odd-levels-only
10115 (1- (* 2 (cdr desc)))
10116 (cdr desc)))
10118 ((eq (car desc) :maxlevel)
10119 (setq fast-path-p t)
10121 (if org-odd-levels-only
10122 (1- (* 2 (cdr desc)))
10123 (cdr desc)))
10125 (t (error "Bad refiling target description %s" desc)))
10126 (while (setq f (pop files))
10127 (with-current-buffer
10128 (if (bufferp f) f (org-get-agenda-file-buffer f))
10129 (or
10130 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10131 (progn
10132 (if (bufferp f) (setq f (buffer-file-name
10133 (buffer-base-buffer f))))
10134 (setq f (and f (expand-file-name f)))
10135 (if (eq org-refile-use-outline-path 'file)
10136 (push (list (file-name-nondirectory f) f nil nil) tgs))
10137 (save-excursion
10138 (save-restriction
10139 (widen)
10140 (goto-char (point-min))
10141 (while (re-search-forward descre nil t)
10142 (goto-char (setq pos0 (point-at-bol)))
10143 (catch 'next
10144 (when org-refile-target-verify-function
10145 (save-match-data
10146 (or (funcall org-refile-target-verify-function)
10147 (throw 'next t))))
10148 (when (looking-at org-complex-heading-regexp)
10149 (setq level (org-reduced-level
10150 (- (match-end 1) (match-beginning 1)))
10151 txt (org-link-display-format (match-string 4))
10153 re (format org-complex-heading-regexp-format
10154 (regexp-quote (match-string 4))))
10155 (when org-refile-use-outline-path
10156 (setq txt (mapconcat
10157 'org-protect-slash
10158 (append
10159 (if (eq org-refile-use-outline-path
10160 'file)
10161 (list (file-name-nondirectory
10162 (buffer-file-name
10163 (buffer-base-buffer))))
10164 (if (eq org-refile-use-outline-path
10165 'full-file-path)
10166 (list (buffer-file-name
10167 (buffer-base-buffer)))))
10168 (org-get-outline-path fast-path-p
10169 level txt)
10170 (list txt))
10171 "/")))
10172 (push (list txt f re (org-refile-marker (point)))
10173 tgs)))
10174 (when (= (point) pos0)
10175 ;; verification function has not moved point
10176 (goto-char (point-at-eol))))))))
10177 (when org-refile-use-cache
10178 (org-refile-cache-put tgs (buffer-file-name) descre))
10179 (setq targets (append tgs targets))
10180 ))))
10181 (message "Getting targets...done")
10182 (nreverse targets)))
10184 (defun org-protect-slash (s)
10185 (while (string-match "/" s)
10187 s)
10189 (defvar org-olpa (make-vector 20 nil))
10191 (defun org-get-outline-path (&optional fastp level heading)
10192 "Return the outline path to the current entry, as a list.
10194 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10195 routine which makes outline path derivations for an entire file,
10196 avoiding backtracing. Refile target collection makes use of that."
10197 (if fastp
10198 (progn
10199 (if (> level 19)
10200 (error "Outline path failure, more than 19 levels"))
10201 (loop for i from level upto 19 do
10202 (aset org-olpa i nil))
10203 (prog1
10204 (delq nil (append org-olpa nil))
10205 (aset org-olpa level heading)))
10206 (let (rtn case-fold-search)
10207 (save-excursion
10208 (save-restriction
10209 (widen)
10210 (while (org-up-heading-safe)
10211 (when (looking-at org-complex-heading-regexp)
10212 (push (org-match-string-no-properties 4) rtn)))
10213 rtn)))))
10215 (defun org-format-outline-path (path &optional width prefix)
10216 "Format the outline path PATH for display.
10217 Width is the maximum number of characters that is available.
10218 Prefix is a prefix to be included in the returned string,
10219 such as the file name."
10220 (setq width (or width 79))
10221 (if prefix (setq width (- width (length prefix))))
10222 (if (not path)
10223 (or prefix "")
10224 (let* ((nsteps (length path))
10225 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10226 (maxwidth (if (<= total-width width)
10227 10000 ;; everything fits
10228 ;; we need to shorten the level headings
10229 (/ (- width nsteps) nsteps)))
10230 (org-odd-levels-only nil)
10231 (n 0)
10232 (total (1+ (length prefix))))
10233 (setq maxwidth (max maxwidth 10))
10234 (concat prefix
10235 (mapconcat
10236 (lambda (h)
10237 (setq n (1+ n))
10238 (if (and (= n nsteps) (< maxwidth 10000))
10239 (setq maxwidth (- total-width total)))
10240 (if (< (length h) maxwidth)
10241 (progn (setq total (+ total (length h) 1)) h)
10242 (setq h (substring h 0 (- maxwidth 2))
10243 total (+ total maxwidth 1))
10245 (setq h (substring h 0 (match-beginning 0))))
10246 (setq h (concat h "..")))
10247 (org-add-props h nil 'face
10248 (nth (% (1- n) org-n-level-faces)
10249 org-level-faces))
10250 h)
10251 path "/")))))
10253 (defun org-display-outline-path (&optional file current)
10254 "Display the current outline path in the echo area."
10255 (interactive "P")
10256 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10257 (case-fold-search nil)
10258 (path (and (org-mode-p) (org-get-outline-path))))
10259 (if current (setq path (append path
10260 (save-excursion
10261 (org-back-to-heading t)
10262 (if (looking-at org-complex-heading-regexp)
10263 (list (match-string 4)))))))
10264 (message "%s"
10265 (org-format-outline-path
10266 path
10267 (1- (frame-width))
10268 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10270 (defvar org-refile-history nil
10271 "History for refiling operations.")
10273 (defvar org-after-refile-insert-hook nil
10274 "Hook run after `org-refile' has inserted its stuff at the new location.
10275 Note that this is still *before* the stuff will be removed from
10276 the *old* location.")
10278 (defvar org-capture-last-stored-marker)
10279 (defun org-refile (&optional goto default-buffer rfloc)
10280 "Move the entry at point to another heading.
10281 The list of target headings is compiled using the information in
10282 `org-refile-targets', which see. This list is created before each use
10283 and will therefore always be up-to-date.
10285 At the target location, the entry is filed as a subitem of the target heading.
10286 Depending on `org-reverse-note-order', the new subitem will either be the
10287 first or the last subitem.
10289 If there is an active region, all entries in that region will be moved.
10290 However, the region must fulfill the requirement that the first heading
10291 is the first one sets the top-level of the moved text - at most siblings
10292 below it are allowed.
10294 With prefix arg GOTO, the command will only visit the target location,
10295 not actually move anything.
10297 go to the location where the last refiling
10298 operation has put the subtree.
10299 With a prefix argument of `2', refile to the running clock.
10301 RFLOC can be a refile location obtained in a different way.
10303 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10305 If you are using target caching (see `org-refile-use-cache'),
10306 You have to clear the target cache in order to find new targets.
10307 This can be done with a 0 prefix: `C-0 C-c C-w'"
10308 (interactive "P")
10309 (if (member goto '(0 (64)))
10310 (org-refile-cache-clear)
10311 (let* ((cbuf (current-buffer))
10312 (regionp (org-region-active-p))
10313 (region-start (and regionp (region-beginning)))
10314 (region-end (and regionp (region-end)))
10315 (region-length (and regionp (- region-end region-start)))
10316 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10317 pos it nbuf file re level reversed)
10318 (setq last-command nil)
10319 (when regionp
10320 (goto-char region-start)
10321 (or (bolp) (goto-char (point-at-bol)))
10322 (setq region-start (point))
10323 (unless (org-kill-is-subtree-p
10324 (buffer-substring region-start region-end))
10325 (error "The region is not a (sequence of) subtree(s)")))
10326 (if (equal goto '(16))
10327 (org-refile-goto-last-stored)
10328 (when (or
10329 (and (equal goto 2)
10330 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10331 (prog1
10332 (setq it (list (or org-clock-heading "running clock")
10333 (buffer-file-name
10334 (marker-buffer org-clock-hd-marker))
10335 ""
10336 (marker-position org-clock-hd-marker)))
10337 (setq goto nil)))
10338 (setq it (or rfloc
10339 (save-excursion
10340 (org-refile-get-location
10341 (if goto "Goto" "Refile to") default-buffer
10342 org-refile-allow-creating-parent-nodes)))))
10343 (setq file (nth 1 it)
10344 re (nth 2 it)
10345 pos (nth 3 it))
10346 (if (and (not goto)
10347 pos
10348 (equal (buffer-file-name) file)
10349 (if regionp
10350 (and (>= pos region-start)
10351 (<= pos region-end))
10352 (and (>= pos (point))
10353 (< pos (save-excursion
10354 (org-end-of-subtree t t))))))
10355 (error "Cannot refile to position inside the tree or region"))
10357 (setq nbuf (or (find-buffer-visiting file)
10358 (find-file-noselect file)))
10359 (if goto
10360 (progn
10361 (switch-to-buffer nbuf)
10362 (goto-char pos)
10363 (org-show-context 'org-goto))
10364 (if regionp
10365 (progn
10366 (org-kill-new (buffer-substring region-start region-end))
10367 (org-save-markers-in-region region-start region-end))
10368 (org-copy-subtree 1 nil t))
10369 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10370 (find-file-noselect file)))
10371 (setq reversed (org-notes-order-reversed-p))
10372 (save-excursion
10373 (save-restriction
10374 (widen)
10375 (if pos
10376 (progn
10377 (goto-char pos)
10378 (looking-at outline-regexp)
10379 (setq level (org-get-valid-level (funcall outline-level) 1))
10380 (goto-char
10381 (if reversed
10382 (or (outline-next-heading) (point-max))
10383 (or (save-excursion (org-get-next-sibling))
10384 (org-end-of-subtree t t)
10385 (point-max)))))
10386 (setq level 1)
10387 (if (not reversed)
10388 (goto-char (point-max))
10389 (goto-char (point-min))
10390 (or (outline-next-heading) (goto-char (point-max)))))
10391 (if (not (bolp)) (newline))
10392 (org-paste-subtree level)
10393 (when org-log-refile
10394 (org-add-log-setup 'refile nil nil 'findpos
10395 org-log-refile)
10396 (unless (eq org-log-refile 'note)
10397 (save-excursion (org-add-log-note))))
10398 (and org-auto-align-tags (org-set-tags nil t))
10399 (bookmark-set "org-refile-last-stored")
10400 ;; If we are refiling for capture, make sure that the
10401 ;; last-capture pointers point here
10402 (when (org-bound-and-true-p org-refile-for-capture)
10403 (bookmark-set "org-capture-last-stored-marker")
10404 (move-marker org-capture-last-stored-marker (point)))
10405 (if (fboundp 'deactivate-mark) (deactivate-mark))
10406 (run-hooks 'org-after-refile-insert-hook))))
10407 (if regionp
10408 (delete-region (point) (+ (point) region-length))
10409 (org-cut-subtree))
10410 (when (featurep 'org-inlinetask)
10411 (org-inlinetask-remove-END-maybe))
10412 (setq org-markers-to-move nil)
10415 (defun org-refile-goto-last-stored ()
10416 "Go to the location where the last refile was stored."
10417 (interactive)
10418 (bookmark-jump "org-refile-last-stored")
10419 (message "This is the location of the last refile"))
10421 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10422 "Prompt the user for a refile location, using PROMPT.
10423 PROMPT should not be suffixed with a colon and a space, because
10424 this function appends the default value from
10425 `org-refile-history' automatically, if that is not empty."
10426 (let ((org-refile-targets org-refile-targets)
10427 (org-refile-use-outline-path org-refile-use-outline-path))
10428 (setq org-refile-target-table (org-refile-get-targets default-buffer)))
10429 (unless org-refile-target-table
10430 (error "No refile targets"))
10431 (let* ((prompt (concat prompt
10432 (and (car org-refile-history)
10433 (concat " (default " (car org-refile-history) ")"))
10434 ": "))
10435 (cbuf (current-buffer))
10436 (partial-completion-mode nil)
10437 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10438 (cfunc (if (and org-refile-use-outline-path
10439 org-outline-path-complete-in-steps)
10440 'org-olpath-completing-read
10441 'org-icompleting-read))
10442 (extra (if org-refile-use-outline-path "/" ""))
10443 (filename (and cfn (expand-file-name cfn)))
10444 (tbl (mapcar
10445 (lambda (x)
10446 (if (and (not (member org-refile-use-outline-path
10447 '(file full-file-path)))
10448 (not (equal filename (nth 1 x))))
10449 (cons (concat (car x) extra " ("
10450 (file-name-nondirectory (nth 1 x)) ")")
10451 (cdr x))
10452 (cons (concat (car x) extra) (cdr x))))
10453 org-refile-target-table))
10454 (completion-ignore-case t)
10455 pa answ parent-target child parent old-hist)
10456 (setq old-hist org-refile-history)
10457 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10458 nil 'org-refile-history (car org-refile-history)))
10459 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10460 (org-refile-check-position pa)
10461 (if pa
10462 (progn
10463 (when (or (not org-refile-history)
10464 (not (eq old-hist org-refile-history))
10465 (not (equal (car pa) (car org-refile-history))))
10466 (setq org-refile-history
10467 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10468 org-refile-history
10469 (cdr org-refile-history))))
10470 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10471 (pop org-refile-history)))
10472 pa)
10474 (progn
10475 (setq parent (match-string 1 answ)
10476 child (match-string 2 answ))
10477 (setq parent-target (or (assoc parent tbl)
10478 (assoc (concat parent "/") tbl)))
10479 (when (and parent-target
10480 (or (eq new-nodes t)
10481 (and (eq new-nodes 'confirm)
10483 child)))))
10484 (org-refile-new-child parent-target child)))
10485 (error "Invalid target location")))))
10487 (defun org-refile-check-position (refile-pointer)
10488 "Check if the refile pointer matches the readline to which it points."
10489 (let* ((file (nth 1 refile-pointer))
10490 (re (nth 2 refile-pointer))
10491 (pos (nth 3 refile-pointer))
10492 buffer)
10493 (when (org-string-nw-p re)
10494 (setq buffer (if (markerp pos)
10495 (marker-buffer pos)
10496 (or (find-buffer-visiting file)
10497 (find-file-noselect file))))
10498 (with-current-buffer buffer
10499 (save-excursion
10500 (save-restriction
10501 (widen)
10502 (goto-char pos)
10503 (beginning-of-line 1)
10504 (unless (org-looking-at-p re)
10505 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10507 (defun org-refile-new-child (parent-target child)
10508 "Use refile target PARENT-TARGET to add new CHILD below it."
10509 (unless parent-target
10510 (error "Cannot find parent for new node"))
10511 (let ((file (nth 1 parent-target))
10512 (pos (nth 3 parent-target))
10513 level)
10514 (with-current-buffer (or (find-buffer-visiting file)
10515 (find-file-noselect file))
10516 (save-excursion
10517 (save-restriction
10518 (widen)
10519 (if pos
10520 (goto-char pos)
10521 (goto-char (point-max))
10522 (if (not (bolp)) (newline)))
10523 (when (looking-at outline-regexp)
10524 (setq level (funcall outline-level))
10525 (org-end-of-subtree t t))
10526 (org-back-over-empty-lines)
10528 (if pos (org-get-valid-level level 1) 1) ?*)
10530 (beginning-of-line 0)
10531 (list (concat (car parent-target) "/" child) file "" (point)))))))
10533 (defun org-olpath-completing-read (prompt collection &rest args)
10534 "Read an outline path like a file name."
10535 (let ((thetable collection)
10536 (org-completion-use-ido nil) ; does not work with ido.
10537 (org-completion-use-iswitchb nil)) ; or iswitchb
10538 (apply
10539 'org-icompleting-read prompt
10540 (lambda (string predicate &optional flag)
10541 (let (rtn r f (l (length string)))
10542 (cond
10543 ((eq flag nil)
10544 ;; try completion
10545 (try-completion string thetable))
10546 ((eq flag t)
10547 ;; all-completions
10548 (setq rtn (all-completions string thetable predicate))
10549 (mapcar
10550 (lambda (x)
10551 (setq r (substring x l))
10552 (if (string-match " ([^)]*)$" x)
10553 (setq f (match-string 0 x))
10554 (setq f ""))
10555 (if (string-match "/" r)
10556 (concat string (substring r 0 (match-end 0)) f)
10557 x))
10558 rtn))
10559 ((eq flag 'lambda)
10560 ;; exact match?
10561 (assoc string thetable)))
10562 ))
10563 args)))
10565 ;;;; Dynamic blocks
10567 (defun org-find-dblock (name)
10568 "Find the first dynamic block with name NAME in the buffer.
10569 If not found, stay at current position and return nil."
10570 (let (pos)
10571 (save-excursion
10572 (goto-char (point-min))
10574 nil t)
10575 (match-beginning 0))))
10576 (if pos (goto-char pos))
10577 pos))
10579 (defconst org-dblock-start-re
10581 "Matches the start line of a dynamic block, with parameters.")
10584 "Matches the end of a dynamic block.")
10586 (defun org-create-dblock (plist)
10587 "Create a dynamic block section, with parameters taken from PLIST.
10588 PLIST must contain a :name entry which is used as name of the block."
10590 (end-of-line 1)
10591 (newline))
10592 (let ((col (current-column))
10593 (name (plist-get plist :name)))
10594 (insert "#+BEGIN: " name)
10595 (while plist
10596 (if (eq (car plist) :name)
10597 (setq plist (cddr plist))
10598 (insert " " (prin1-to-string (pop plist)))))
10600 (beginning-of-line -2)))
10602 (defun org-prepare-dblock ()
10603 "Prepare dynamic block for refresh.
10604 This empties the block, puts the cursor at the insert position and returns
10605 the property list including an extra property :name with the block name."
10606 (unless (looking-at org-dblock-start-re)
10607 (error "Not at a dynamic block"))
10608 (let* ((begdel (1+ (match-end 0)))
10609 (name (org-no-properties (match-string 1)))
10610 (params (append (list :name name)
10611 (read (concat "(" (match-string 3) ")")))))
10612 (save-excursion
10613 (beginning-of-line 1)
10615 (setq params (plist-put params :indentation-column (current-column))))
10616 (unless (re-search-forward org-dblock-end-re nil t)
10617 (error "Dynamic block not terminated"))
10618 (setq params
10619 (append params
10620 (list :content (buffer-substring
10621 begdel (match-beginning 0)))))
10622 (delete-region begdel (match-beginning 0))
10623 (goto-char begdel)
10624 (open-line 1)
10625 params))
10627 (defun org-map-dblocks (&optional command)
10628 "Apply COMMAND to all dynamic blocks in the current buffer.
10629 If COMMAND is not given, use `org-update-dblock'."
10630 (let ((cmd (or command 'org-update-dblock)))
10631 (save-excursion
10632 (goto-char (point-min))
10633 (while (re-search-forward org-dblock-start-re nil t)
10634 (goto-char (match-beginning 0))
10635 (save-excursion
10636 (condition-case nil
10637 (funcall cmd)
10638 (error (message "Error during update of dynamic block"))))
10639 (unless (re-search-forward org-dblock-end-re nil t)
10640 (error "Dynamic block not terminated"))))))
10642 (defun org-dblock-update (&optional arg)
10643 "User command for updating dynamic blocks.
10644 Update the dynamic block at point. With prefix ARG, update all dynamic
10645 blocks in the buffer."
10646 (interactive "P")
10647 (if arg
10648 (org-update-all-dblocks)
10649 (or (looking-at org-dblock-start-re)
10650 (org-beginning-of-dblock))
10651 (org-update-dblock)))
10653 (defun org-update-dblock ()
10654 "Update the dynamic block at point.
10655 This means to empty the block, parse for parameters and then call
10656 the correct writing function."
10657 (interactive)
10658 (save-window-excursion
10659 (let* ((pos (point))
10660 (line (org-current-line))
10661 (params (org-prepare-dblock))
10662 (name (plist-get params :name))
10663 (indent (plist-get params :indentation-column))
10664 (cmd (intern (concat "org-dblock-write:" name))))
10665 (message "Updating dynamic block `%s' at line %d..." name line)
10666 (funcall cmd params)
10667 (message "Updating dynamic block `%s' at line %d...done" name line)
10668 (goto-char pos)
10669 (when (and indent (> indent 0))
10670 (setq indent (make-string indent ?\ ))
10671 (save-excursion
10672 (org-beginning-of-dblock)
10673 (forward-line 1)
10674 (while (not (looking-at org-dblock-end-re))
10675 (insert indent)
10676 (beginning-of-line 2))
10677 (when (looking-at org-dblock-end-re)
10679 (replace-match ""))
10680 (insert indent)))))))
10682 (defun org-beginning-of-dblock ()
10683 "Find the beginning of the dynamic block at point.
10684 Error if there is no such block at point."
10685 (let ((pos (point))
10686 beg)
10687 (end-of-line 1)
10688 (if (and (re-search-backward org-dblock-start-re nil t)
10689 (setq beg (match-beginning 0))
10690 (re-search-forward org-dblock-end-re nil t)
10691 (> (match-end 0) pos))
10692 (goto-char beg)
10693 (goto-char pos)
10694 (error "Not in a dynamic block"))))
10696 (defun org-update-all-dblocks ()
10697 "Update all dynamic blocks in the buffer.
10698 This function can be used in a hook."
10699 (interactive)
10700 (when (org-mode-p)
10701 (org-map-dblocks 'org-update-dblock)))
10704 ;;;; Completion
10706 (defconst org-additional-option-like-keywords
10707 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10708 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10709 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10710 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10711 "BEGIN:" "END:"
10712 "ORGTBL" "TBLFM:" "TBLNAME:"
10713 "BEGIN_EXAMPLE" "END_EXAMPLE"
10714 "BEGIN_QUOTE" "END_QUOTE"
10715 "BEGIN_VERSE" "END_VERSE"
10716 "BEGIN_CENTER" "END_CENTER"
10717 "BEGIN_SRC" "END_SRC"
10718 "BEGIN_RESULT" "END_RESULT"
10719 "SOURCE:" "SRCNAME:" "FUNCTION:"
10720 "RESULTS:"
10721 "HEADER:" "HEADERS:"
10722 "BABEL:"
10723 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10724 "CAPTION:" "LABEL:"
10725 "SETUPFILE:"
10726 "INCLUDE:"
10727 "BIND:"
10728 "MACRO:"))
10730 (defcustom org-structure-template-alist
10731 '(
10744 ("L" "#+latex: "
10748 ("H" "#+html: "
10751 ("A" "#+ascii: ")
10752 ("i" "#+include %file ?"
10754 )
10755 "Structure completion elements.
10756 This is a list of abbreviation keys and values. The value gets inserted
10757 if you type `<' followed by the key and then press the completion key,
10758 usually `M-TAB'. %file will be replaced by a file name after prompting
10759 for the file using completion.
10760 There are two templates for each key, the first uses the original Org syntax,
10761 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10762 the default when the /org-mtags.el/ module has been loaded. See also the
10763 variable `org-mtags-prefer-muse-templates'.
10764 This is an experimental feature, it is undecided if it is going to stay in."
10765 :group 'org-completion
10766 :type '(repeat
10767 (string :tag "Key")
10768 (string :tag "Template")
10769 (string :tag "Muse Template")))
10771 (defun org-try-structure-completion ()
10772 "Try to complete a structure template before point.
10774 expands them."
10775 (let ((l (buffer-substring (point-at-bol) (point)))
10776 a)
10779 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10780 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10781 (match-beginning 1)) a)
10782 t)))
10784 (defun org-complete-expand-structure-template (start cell)
10785 "Expand a structure template."
10786 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10787 (rpl (nth (if musep 2 1) cell))
10788 (ind ""))
10789 (delete-region start (point))
10791 (cond
10792 ((bolp))
10794 (setq ind (buffer-substring (point-at-bol) (point))))
10795 (t (newline))))
10796 (setq start (point))
10797 (if (string-match "%file" rpl)
10798 (setq rpl (replace-match
10799 (concat
10801 (save-match-data
10802 (abbreviate-file-name (read-file-name "Include file: ")))
10804 t t rpl)))
10807 (insert rpl)
10810 ;;;; TODO, DEADLINE, Comments
10812 (defun org-toggle-comment ()
10813 "Change the COMMENT state of an entry."
10814 (interactive)
10815 (save-excursion
10816 (org-back-to-heading)
10817 (let (case-fold-search)
10818 (if (looking-at (concat outline-regexp
10820 (replace-match "" t t nil 1)
10821 (if (looking-at outline-regexp)
10822 (progn
10823 (goto-char (match-end 0))
10824 (insert org-comment-string " ")))))))
10826 (defvar org-last-todo-state-is-todo nil
10827 "This is non-nil when the last TODO state change led to a TODO state.
10828 If the last change removed the TODO tag or switched to DONE, then
10829 this is nil.")
10831 (defvar org-setting-tags nil) ; dynamically skipped
10833 (defvar org-todo-setup-filter-hook nil
10834 "Hook for functions that pre-filter todo specs.
10835 Each function takes a todo spec and returns either nil or the spec
10836 transformed into canonical form." )
10838 (defvar org-todo-get-default-hook nil
10839 "Hook for functions that get a default item for todo.
10840 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10841 nil or a string to be used for the todo mark." )
10843 (defvar org-agenda-headline-snapshot-before-repeat)
10845 (defun org-todo (&optional arg)
10846 "Change the TODO state of an item.
10847 The state of an item is given by a keyword at the start of the heading,
10848 like
10849 *** TODO Write paper
10850 *** DONE Call mom
10852 The different keywords are specified in the variable `org-todo-keywords'.
10854 So for this example: when the item starts with TODO, it is changed to DONE.
10855 When it starts with DONE, the DONE is removed. And when neither TODO nor
10856 DONE are present, add TODO at the beginning of the heading.
10859 state.
10860 With numeric prefix arg, switch to that state.
10862 keywords (nextset).
10865 For calling through lisp, arg is also interpreted in the following way:
10866 'none -> empty state
10868 'done -> switch to DONE
10869 'nextset -> switch to the next set of keywords
10870 'previousset -> switch to the previous set of keywords
10872 really is a member of `org-todo-keywords'."
10873 (interactive "P")
10874 (if (equal arg '(16)) (setq arg 'nextset))
10875 (let ((org-blocker-hook org-blocker-hook)
10876 (case-fold-search nil))
10877 (when (equal arg '(64))
10878 (setq arg nil org-blocker-hook nil))
10879 (when (and org-blocker-hook
10880 (or org-inhibit-blocking
10881 (org-entry-get nil "NOBLOCKING")))
10882 (setq org-blocker-hook nil))
10883 (save-excursion
10884 (catch 'exit
10885 (org-back-to-heading t)
10886 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10888 (looking-at " *"))
10889 (let* ((match-data (match-data))
10890 (startpos (point-at-bol))
10891 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10892 (org-log-done org-log-done)
10893 (org-log-repeat org-log-repeat)
10894 (org-todo-log-states org-todo-log-states)
10895 (this (match-string 1))
10896 (hl-pos (match-beginning 0))
10897 (head (org-get-todo-sequence-head this))
10898 (ass (assoc head org-todo-kwd-alist))
10899 (interpret (nth 1 ass))
10900 (done-word (nth 3 ass))
10901 (final-done-word (nth 4 ass))
10902 (last-state (or this ""))
10903 (completion-ignore-case t)
10904 (member (member this org-todo-keywords-1))
10905 (tail (cdr member))
10906 (state (cond
10907 ((and org-todo-key-trigger
10908 (or (and (equal arg '(4))
10909 (eq org-use-fast-todo-selection 'prefix))
10910 (and (not arg) org-use-fast-todo-selection
10911 (not (eq org-use-fast-todo-selection
10912 'prefix)))))
10913 ;; Use fast selection
10914 (org-fast-todo-selection))
10915 ((and (equal arg '(4))
10916 (or (not org-use-fast-todo-selection)
10917 (not org-todo-key-trigger)))
10918 ;; Read a state with completion
10919 (org-icompleting-read
10920 "State: " (mapcar (lambda(x) (list x))
10921 org-todo-keywords-1)
10922 nil t))
10923 ((eq arg 'right)
10924 (if this
10925 (if tail (car tail) nil)
10926 (car org-todo-keywords-1)))
10927 ((eq arg 'left)
10928 (if (equal member org-todo-keywords-1)
10929 nil
10930 (if this
10931 (nth (- (length org-todo-keywords-1)
10932 (length tail) 2)
10933 org-todo-keywords-1)
10934 (org-last org-todo-keywords-1))))
10935 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10936 (setq arg nil))) ; hack to fall back to cycling
10937 (arg
10938 ;; user or caller requests a specific state
10939 (cond
10940 ((equal arg "") nil)
10941 ((eq arg 'none) nil)
10942 ((eq arg 'done) (or done-word (car org-done-keywords)))
10943 ((eq arg 'nextset)
10944 (or (car (cdr (member head org-todo-heads)))
10945 (car org-todo-heads)))
10946 ((eq arg 'previousset)
10947 (let ((org-todo-heads (reverse org-todo-heads)))
10948 (or (car (cdr (member head org-todo-heads)))
10949 (car org-todo-heads))))
10950 ((car (member arg org-todo-keywords-1)))
10951 ((stringp arg)
10952 (error "State `%s' not valid in this file" arg))
10953 ((nth (1- (prefix-numeric-value arg))
10954 org-todo-keywords-1))))
10955 ((null member) (or head (car org-todo-keywords-1)))
10956 ((equal this final-done-word) nil) ;; -> make empty
10957 ((null tail) nil) ;; -> first entry
10958 ((memq interpret '(type priority))
10959 (if (eq this-command last-command)
10960 (car tail)
10961 (if (> (length tail) 0)
10962 (or done-word (car org-done-keywords))
10963 nil)))
10964 (t
10965 (car tail))))
10966 (state (or
10967 (run-hook-with-args-until-success
10968 'org-todo-get-default-hook state last-state)
10969 state))
10970 (next (if state (concat " " state " ") " "))
10971 (change-plist (list :type 'todo-state-change :from this :to state
10972 :position startpos))
10973 dolog now-done-p)
10974 (when org-blocker-hook
10975 (setq org-last-todo-state-is-todo
10976 (not (member this org-done-keywords)))
10977 (unless (save-excursion
10978 (save-match-data
10979 (org-with-wide-buffer
10980 (run-hook-with-args-until-failure
10981 'org-blocker-hook change-plist))))
10982 (if (interactive-p)
10983 (error "TODO state change from %s to %s blocked" this state)
10984 ;; fail silently
10985 (message "TODO state change from %s to %s blocked" this state)
10986 (throw 'exit nil))))
10987 (store-match-data match-data)
10988 (replace-match next t t)
10989 (unless (pos-visible-in-window-p hl-pos)
10990 (message "TODO state changed to %s" (org-trim next)))
10991 (unless head
10992 (setq head (org-get-todo-sequence-head state)
10993 ass (assoc head org-todo-kwd-alist)
10994 interpret (nth 1 ass)
10995 done-word (nth 3 ass)
10996 final-done-word (nth 4 ass)))
10997 (when (memq arg '(nextset previousset))
10998 (message "Keyword-Set %d/%d: %s"
10999 (- (length org-todo-sets) -1
11000 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11001 (length org-todo-sets)
11002 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11003 (setq org-last-todo-state-is-todo
11004 (not (member state org-done-keywords)))
11005 (setq now-done-p (and (member state org-done-keywords)
11006 (not (member this org-done-keywords))))
11007 (and logging (org-local-logging logging))
11008 (when (and (or org-todo-log-states org-log-done)
11009 (not (eq org-inhibit-logging t))
11010 (not (memq arg '(nextset previousset))))
11011 ;; we need to look at recording a time and note
11012 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11013 (nth 2 (assoc this org-todo-log-states))))
11014 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11015 (setq dolog 'time))
11016 (when (and state
11017 (member state org-not-done-keywords)
11018 (not (member this org-not-done-keywords)))
11019 ;; This is now a todo state and was not one before
11020 ;; If there was a CLOSED time stamp, get rid of it.
11021 (org-add-planning-info nil nil 'closed))
11022 (when (and now-done-p org-log-done)
11023 ;; It is now done, and it was not done before
11024 (org-add-planning-info 'closed (org-current-time))
11025 (if (and (not dolog) (eq 'note org-log-done))
11026 (org-add-log-setup 'done state this 'findpos 'note)))
11027 (when (and state dolog)
11028 ;; This is a non-nil state, and we need to log it
11029 (org-add-log-setup 'state state this 'findpos dolog)))
11030 ;; Fixup tag positioning
11031 (org-todo-trigger-tag-changes state)
11032 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11033 (when org-provide-todo-statistics
11034 (org-update-parent-todo-statistics))
11035 (run-hooks 'org-after-todo-state-change-hook)
11036 (if (and arg (not (member state org-done-keywords)))
11037 (setq head (org-get-todo-sequence-head state)))
11038 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11039 ;; Do we need to trigger a repeat?
11040 (when now-done-p
11041 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11042 ;; This is for the agenda, take a snapshot of the headline.
11043 (save-match-data
11044 (setq org-agenda-headline-snapshot-before-repeat
11045 (org-get-heading))))
11046 (org-auto-repeat-maybe state))
11047 ;; Fixup cursor location if close to the keyword
11048 (if (and (outline-on-heading-p)
11049 (not (bolp))
11050 (save-excursion (beginning-of-line 1)
11051 (looking-at org-todo-line-regexp))
11052 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11053 (progn
11054 (goto-char (or (match-end 2) (match-end 1)))
11055 (and (looking-at " ") (just-one-space))))
11056 (when org-trigger-hook
11057 (save-excursion
11058 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11060 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11061 "Block turning an entry into a TODO, using the hierarchy.
11062 This checks whether the current task should be blocked from state
11063 changes. Such blocking occurs when:
11065 1. The task has children which are not all in a completed state.
11067 2. A task has a parent with the property :ORDERED:, and there
11068 are siblings prior to the current task with incomplete
11069 status.
11071 3. The parent of the task is blocked because it has siblings that should
11072 be done first, or is child of a block grandparent TODO entry."
11074 (if (not org-enforce-todo-dependencies)
11075 t ; if locally turned off don't block
11076 (catch 'dont-block
11077 ;; If this is not a todo state change, or if this entry is already DONE,
11078 ;; do not block
11079 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11080 (member (plist-get change-plist :from)
11081 (cons 'done org-done-keywords))
11082 (member (plist-get change-plist :to)
11083 (cons 'todo org-not-done-keywords))
11084 (not (plist-get change-plist :to)))
11085 (throw 'dont-block t))
11086 ;; If this task has children, and any are undone, it's blocked
11087 (save-excursion
11088 (org-back-to-heading t)
11089 (let ((this-level (funcall outline-level)))
11090 (outline-next-heading)
11091 (let ((child-level (funcall outline-level)))
11092 (while (and (not (eobp))
11093 (> child-level this-level))
11094 ;; this todo has children, check whether they are all
11095 ;; completed
11096 (if (and (not (org-entry-is-done-p))
11097 (org-entry-is-todo-p))
11098 (throw 'dont-block nil))
11099 (outline-next-heading)
11100 (setq child-level (funcall outline-level))))))
11101 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11102 ;; any previous siblings are undone, it's blocked
11103 (save-excursion
11104 (org-back-to-heading t)
11105 (let* ((pos (point))
11106 (parent-pos (and (org-up-heading-safe) (point))))
11107 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11108 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11109 (forward-line 1)
11110 (re-search-forward org-not-done-heading-regexp pos t))
11111 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11112 ;; Search further up the hierarchy, to see if an anchestor is blocked
11113 (while t
11114 (goto-char parent-pos)
11115 (if (not (looking-at org-not-done-heading-regexp))
11116 (throw 'dont-block t)) ; do not block, parent is not a TODO
11117 (setq pos (point))
11118 (setq parent-pos (and (org-up-heading-safe) (point)))
11119 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11120 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11121 (forward-line 1)
11122 (re-search-forward org-not-done-heading-regexp pos t))
11123 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11125 (defcustom org-track-ordered-property-with-tag nil
11126 "Should the ORDERED property also be shown as a tag?
11127 The ORDERED property decides if an entry should require subtasks to be
11128 completed in sequence. Since a property is not very visible, setting
11129 this option means that toggling the ORDERED property with the command
11130 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11131 not relevant for the behavior, but it makes things more visible.
11133 Note that toggling the tag with tags commands will not change the property
11134 and therefore not influence behavior!
11136 This can be t, meaning the tag ORDERED should be used, It can also be a
11137 string to select a different tag for this task."
11138 :group 'org-todo
11139 :type '(choice
11140 (const :tag "No tracking" nil)
11141 (const :tag "Track with ORDERED tag" t)
11142 (string :tag "Use other tag")))
11144 (defun org-toggle-ordered-property ()
11145 "Toggle the ORDERED property of the current entry.
11146 For better visibility, you can track the value of this property with a tag.
11147 See variable `org-track-ordered-property-with-tag'."
11148 (interactive)
11149 (let* ((t1 org-track-ordered-property-with-tag)
11150 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11151 (save-excursion
11152 (org-back-to-heading)
11153 (if (org-entry-get nil "ORDERED")
11154 (progn
11155 (org-delete-property "ORDERED")
11156 (and tag (org-toggle-tag tag 'off))
11157 (message "Subtasks can be completed in arbitrary order"))
11158 (org-entry-put nil "ORDERED" "t")
11159 (and tag (org-toggle-tag tag 'on))
11160 (message "Subtasks must be completed in sequence")))))
11162 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11163 (defun org-block-todo-from-checkboxes (change-plist)
11164 "Block turning an entry into a TODO, using checkboxes.
11165 This checks whether the current task should be blocked from state
11166 changes because there are unchecked boxes in this entry."
11167 (if (not org-enforce-todo-checkbox-dependencies)
11168 t ; if locally turned off don't block
11169 (catch 'dont-block
11170 ;; If this is not a todo state change, or if this entry is already DONE,
11171 ;; do not block
11172 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11173 (member (plist-get change-plist :from)
11174 (cons 'done org-done-keywords))
11175 (member (plist-get change-plist :to)
11176 (cons 'todo org-not-done-keywords))
11177 (not (plist-get change-plist :to)))
11178 (throw 'dont-block t))
11179 ;; If this task has checkboxes that are not checked, it's blocked
11180 (save-excursion
11181 (org-back-to-heading t)
11182 (let ((beg (point)) end)
11183 (outline-next-heading)
11184 (setq end (point))
11185 (goto-char beg)
11187 end t)
11188 (progn
11189 (if (boundp 'org-blocked-by-checkboxes)
11190 (setq org-blocked-by-checkboxes t))
11191 (throw 'dont-block nil)))))
11192 t))) ; do not block
11194 (defun org-entry-blocked-p ()
11195 "Is the current entry blocked?"
11196 (if (org-entry-get nil "NOBLOCKING")
11197 nil ;; Never block this entry
11198 (not
11199 (run-hook-with-args-until-failure
11200 'org-blocker-hook
11201 (list :type 'todo-state-change
11202 :position (point)
11203 :from 'todo
11204 :to 'done)))))
11206 (defun org-update-statistics-cookies (all)
11207 "Update the statistics cookie, either from TODO or from checkboxes.
11208 This should be called with the cursor in a line with a statistics cookie."
11209 (interactive "P")
11210 (if all
11211 (progn
11212 (org-update-checkbox-count 'all)
11213 (org-map-entries 'org-update-parent-todo-statistics))
11214 (if (not (org-on-heading-p))
11215 (org-update-checkbox-count)
11216 (let ((pos (move-marker (make-marker) (point)))
11217 end l1 l2)
11218 (ignore-errors (org-back-to-heading t))
11219 (if (not (org-on-heading-p))
11220 (org-update-checkbox-count)
11221 (setq l1 (org-outline-level))
11222 (setq end (save-excursion
11223 (outline-next-heading)
11224 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11225 (point)))
11226 (if (and (save-excursion
11227 (re-search-forward
11229 (not (save-excursion (re-search-forward
11231 (org-update-checkbox-count)
11232 (if (and l2 (> l2 l1))
11233 (progn
11234 (goto-char end)
11235 (org-update-parent-todo-statistics))
11236 (goto-char pos)
11237 (beginning-of-line 1)
11238 (while (re-search-forward
11240 (point-at-eol) t)
11241 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11242 (goto-char pos)
11243 (move-marker pos nil)))))
11245 (defvar org-entry-property-inherited-from) ;; defined below
11246 (defun org-update-parent-todo-statistics ()
11247 "Update any statistics cookie in the parent of the current headline.
11248 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11249 the entire subtree and this will travel up the hierarchy and update
11250 statistics everywhere."
11251 (interactive)
11252 (let* ((lim 0) prop
11253 (recursive (or (not org-hierarchical-todo-statistics)
11254 (string-match
11256 (or (setq prop (org-entry-get
11257 nil "COOKIE_DATA" 'inherit)) ""))))
11258 (lim (or (and prop (marker-position
11259 org-entry-property-inherited-from))
11260 lim))
11261 (first t)
11263 level ltoggle l1 new ndel
11264 (cnt-all 0) (cnt-done 0) is-percent kwd
11265 checkbox-beg ov ovs ove cookie-present)
11266 (catch 'exit
11267 (save-excursion
11268 (beginning-of-line 1)
11269 (if (org-at-heading-p)
11270 (setq ltoggle (funcall outline-level))
11271 (error "This should not happen"))
11272 (while (and (setq level (org-up-heading-safe))
11273 (or recursive first)
11274 (>= (point) lim))
11275 (setq first nil cookie-present nil)
11276 (unless (and level
11277 (not (string-match
11279 (downcase
11280 (or (org-entry-get
11281 nil "COOKIE_DATA")
11282 "")))))
11283 (throw 'exit nil))
11284 (while (re-search-forward box-re (point-at-eol) t)
11285 (setq cnt-all 0 cnt-done 0 cookie-present t)
11286 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11287 (save-match-data
11288 (unless (outline-next-heading) (throw 'exit nil))
11289 (while (and (looking-at org-complex-heading-regexp)
11290 (> (setq l1 (length (match-string 1))) level))
11291 (setq kwd (and (or recursive (= l1 ltoggle))
11292 (match-string 2)))
11293 (if (or (eq org-provide-todo-statistics 'all-headlines)
11294 (and (listp org-provide-todo-statistics)
11295 (or (member kwd org-provide-todo-statistics)
11296 (member kwd org-done-keywords))))
11297 (setq cnt-all (1+ cnt-all))
11298 (if (eq org-provide-todo-statistics t)
11299 (and kwd (setq cnt-all (1+ cnt-all)))))
11300 (and (member kwd org-done-keywords)
11301 (setq cnt-done (1+ cnt-done)))
11302 (outline-next-heading)))
11303 (setq new
11304 (if is-percent
11305 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11306 (format "[%d/%d]" cnt-done cnt-all))
11307 ndel (- (match-end 0) checkbox-beg))
11308 ;; handle overlays when updating cookie from column view
11309 (when (setq ov (car (overlays-at checkbox-beg)))
11310 (setq ovs (overlay-start ov) ove (overlay-end ov))
11311 (delete-overlay ov))
11312 (goto-char checkbox-beg)
11313 (insert new)
11314 (delete-region (point) (+ (point) ndel))
11315 (when ov (move-overlay ov ovs ove)))
11316 (when cookie-present
11317 (run-hook-with-args 'org-after-todo-statistics-hook
11318 cnt-done (- cnt-all cnt-done))))))
11319 (run-hooks 'org-todo-statistics-hook)))
11321 (defvar org-after-todo-statistics-hook nil
11322 "Hook that is called after a TODO statistics cookie has been updated.
11323 Each function is called with two arguments: the number of not-done entries
11324 and the number of done entries.
11326 For example, the following function, when added to this hook, will switch
11327 an entry to DONE when all children are done, and back to TODO when new
11328 entries are set to a TODO status. Note that this hook is only called
11329 when there is a statistics cookie in the headline!
11331 (defun org-summary-todo (n-done n-not-done)
11333 (let (org-log-done org-log-states) ; turn off logging
11335 ")
11337 (defvar org-todo-statistics-hook nil
11338 "Hook that is run whenever Org thinks TODO statistics should be updated.
11339 This hook runs even if there is no statistics cookie present, in which case
11340 `org-after-todo-statistics-hook' would not run.")
11342 (defun org-todo-trigger-tag-changes (state)
11343 "Apply the changes defined in `org-todo-state-tags-triggers'."
11344 (let ((l org-todo-state-tags-triggers)
11345 changes)
11346 (when (or (not state) (equal state ""))
11347 (setq changes (append changes (cdr (assoc "" l)))))
11348 (when (and (stringp state) (> (length state) 0))
11349 (setq changes (append changes (cdr (assoc state l)))))
11350 (when (member state org-not-done-keywords)
11351 (setq changes (append changes (cdr (assoc 'todo l)))))
11352 (when (member state org-done-keywords)
11353 (setq changes (append changes (cdr (assoc 'done l)))))
11354 (dolist (c changes)
11355 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11357 (defun org-local-logging (value)
11358 "Get logging settings from a property VALUE."
11359 (let* (words w a)
11360 ;; directly set the variables, they are already local.
11361 (setq org-log-done nil
11362 org-log-repeat nil
11363 org-todo-log-states nil)
11364 (setq words (org-split-string value))
11365 (while (setq w (pop words))
11366 (cond
11367 ((setq a (assoc w org-startup-options))
11368 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11369 (set (nth 1 a) (nth 2 a))))
11370 ((setq a (org-extract-log-state-settings w))
11371 (and (member (car a) org-todo-keywords-1)
11372 (push a org-todo-log-states)))))))
11374 (defun org-get-todo-sequence-head (kwd)
11375 "Return the head of the TODO sequence to which KWD belongs.
11376 If KWD is not set, check if there is a text property remembering the
11377 right sequence."
11378 (let (p)
11379 (cond
11380 ((not kwd)
11381 (or (get-text-property (point-at-bol) 'org-todo-head)
11382 (progn
11383 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11384 nil (point-at-eol)))
11385 (get-text-property p 'org-todo-head))))
11386 ((not (member kwd org-todo-keywords-1))
11387 (car org-todo-keywords-1))
11388 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11390 (defun org-fast-todo-selection ()
11391 "Fast TODO keyword selection with single keys.
11392 Returns the new TODO keyword, or nil if no state change should occur."
11393 (let* ((fulltable org-todo-key-alist)
11394 (done-keywords org-done-keywords) ;; needed for the faces.
11395 (maxlen (apply 'max (mapcar
11396 (lambda (x)
11397 (if (stringp (car x)) (string-width (car x)) 0))
11398 fulltable)))
11399 (expert nil)
11400 (fwidth (+ maxlen 3 1 3))
11401 (ncol (/ (- (window-width) 4) fwidth))
11402 tg cnt e c tbl
11403 groups ingroup)
11404 (save-excursion
11405 (save-window-excursion
11406 (if expert
11407 (set-buffer (get-buffer-create " *Org todo*"))
11408 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11409 (erase-buffer)
11410 (org-set-local 'org-done-keywords done-keywords)
11411 (setq tbl fulltable cnt 0)
11412 (while (setq e (pop tbl))
11413 (cond
11414 ((equal e '(:startgroup))
11415 (push '() groups) (setq ingroup t)
11416 (when (not (= cnt 0))
11417 (setq cnt 0)
11419 (insert "{ "))
11420 ((equal e '(:endgroup))
11421 (setq ingroup nil cnt 0)
11423 ((equal e '(:newline))
11424 (when (not (= cnt 0))
11425 (setq cnt 0)
11427 (setq e (car tbl))
11428 (while (equal (car tbl) '(:newline))
11430 (setq tbl (cdr tbl)))))
11431 (t
11432 (setq tg (car e) c (cdr e))
11433 (if ingroup (push tg (car groups)))
11434 (setq tg (org-add-props tg nil 'face
11435 (org-get-todo-face tg)))
11436 (if (and (= cnt 0) (not ingroup)) (insert " "))
11437 (insert "[" c "] " tg (make-string
11438 (- fwidth 4 (length tg)) ?\ ))
11439 (when (= (setq cnt (1+ cnt)) ncol)
11441 (if ingroup (insert " "))
11442 (setq cnt 0)))))
11444 (goto-char (point-min))
11445 (if (not expert) (org-fit-window-to-buffer))
11446 (message "[a-z..]:Set [SPC]:clear")
11447 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11448 (cond
11449 ((or (= c ?\C-g)
11450 (and (= c ?q) (not (rassoc c fulltable))))
11451 (setq quit-flag t))
11452 ((= c ?\ ) nil)
11453 ((setq e (rassoc c fulltable) tg (car e))
11454 tg)
11455 (t (setq quit-flag t)))))))
11457 (defun org-entry-is-todo-p ()
11458 (member (org-get-todo-state) org-not-done-keywords))
11460 (defun org-entry-is-done-p ()
11461 (member (org-get-todo-state) org-done-keywords))
11463 (defun org-get-todo-state ()
11464 (save-excursion
11465 (org-back-to-heading t)
11466 (and (looking-at org-todo-line-regexp)
11467 (match-end 2)
11468 (match-string 2))))
11470 (defun org-at-date-range-p (&optional inactive-ok)
11471 "Is the cursor inside a date range?"
11472 (interactive)
11473 (save-excursion
11474 (catch 'exit
11475 (let ((pos (point)))
11477 (skip-chars-backward "<[")
11478 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11479 (>= (match-end 0) pos)
11480 (throw 'exit t))
11482 (skip-chars-backward "<[")
11483 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11484 (>= (match-end 0) pos)
11485 (throw 'exit t)))
11486 nil)))
11488 (defun org-get-repeat (&optional tagline)
11489 "Check if there is a deadline/schedule with repeater in this entry."
11490 (save-match-data
11491 (save-excursion
11492 (org-back-to-heading t)
11493 (and (re-search-forward (if tagline
11495 org-repeat-re)
11496 (org-entry-end-position) t)
11497 (match-string-no-properties 1)))))
11499 (defvar org-last-changed-timestamp)
11500 (defvar org-last-inserted-timestamp)
11501 (defvar org-log-post-message)
11502 (defvar org-log-note-purpose)
11503 (defvar org-log-note-how)
11504 (defvar org-log-note-extra)
11505 (defun org-auto-repeat-maybe (done-word)
11506 "Check if the current headline contains a repeated deadline/schedule.
11507 If yes, set TODO state back to what it was and change the base date
11508 of repeating deadline/scheduled time stamps to new date.
11509 This function is run automatically after each state change to a DONE state."
11510 ;; last-state is dynamically scoped into this function
11511 (let* ((repeat (org-get-repeat))
11512 (aa (assoc last-state org-todo-kwd-alist))
11513 (interpret (nth 1 aa))
11514 (head (nth 2 aa))
11515 (whata '(("d" . day) ("m" . month) ("y" . year)))
11516 (msg "Entry repeats: ")
11517 (org-log-done nil)
11518 (org-todo-log-states nil)
11519 re type n what ts time to-state)
11520 (when repeat
11521 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11522 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11523 org-todo-repeat-to-state))
11524 (unless (and to-state (member to-state org-todo-keywords-1))
11525 (setq to-state (if (eq interpret 'type) last-state head)))
11526 (org-todo to-state)
11527 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11528 (org-entry-put nil "LAST_REPEAT" (format-time-string
11529 (org-time-stamp-format t t))))
11530 (when org-log-repeat
11531 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11532 (memq 'org-add-log-note post-command-hook))
11533 ;; OK, we are already setup for some record
11534 (if (eq org-log-repeat 'note)
11535 ;; make sure we take a note, not only a time stamp
11536 (setq org-log-note-how 'note))
11537 ;; Set up for taking a record
11538 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11539 last-state
11540 'findpos org-log-repeat)))
11541 (org-back-to-heading t)
11542 (org-add-planning-info nil nil 'closed)
11546 (while (re-search-forward
11547 re (save-excursion (outline-next-heading) (point)) t)
11548 (setq type (if (match-end 1) org-scheduled-string
11549 (if (match-end 3) org-deadline-string "Plain:"))
11550 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11552 (setq n (string-to-number (match-string 2 ts))
11553 what (match-string 3 ts))
11554 (if (equal what "w") (setq n (* n 7) what "d"))
11555 ;; Preparation, see if we need to modify the start date for the change
11556 (when (match-end 1)
11557 (setq time (save-match-data (org-time-string-to-time ts)))
11558 (cond
11559 ((equal (match-string 1 ts) ".")
11560 ;; Shift starting date to today
11561 (org-timestamp-change
11562 (- (time-to-days (current-time)) (time-to-days time))
11563 'day))
11564 ((equal (match-string 1 ts) "+")
11565 (let ((nshiftmax 10) (nshift 0))
11566 (while (or (= nshift 0)
11567 (<= (time-to-days time)
11568 (time-to-days (current-time))))
11569 (when (= (incf nshift) nshiftmax)
11570 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11571 (error "Abort")))
11572 (org-timestamp-change n (cdr (assoc what whata)))
11573 (org-at-timestamp-p t)
11574 (setq ts (match-string 1))
11575 (setq time (save-match-data (org-time-string-to-time ts)))))
11576 (org-timestamp-change (- n) (cdr (assoc what whata)))
11577 ;; rematch, so that we have everything in place for the real shift
11578 (org-at-timestamp-p t)
11579 (setq ts (match-string 1))
11581 (org-timestamp-change n (cdr (assoc what whata)))
11582 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11583 (setq org-log-post-message msg)
11584 (message "%s" msg))))
11586 (defun org-show-todo-tree (arg)
11587 "Make a compact tree which shows all headlines marked with TODO.
11588 The tree will show the lines where the regexp matches, and all higher
11589 headlines above the match.
11591 With a numeric prefix N, construct a sparse tree for the Nth element
11592 of `org-todo-keywords-1'."
11593 (interactive "P")
11594 (let ((case-fold-search nil)
11595 (kwd-re
11596 (cond ((null arg) org-not-done-regexp)
11597 ((equal arg '(4))
11598 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11599 (mapcar 'list org-todo-keywords-1))))
11603 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11604 (regexp-quote (nth (1- (prefix-numeric-value arg))
11605 org-todo-keywords-1)))
11606 (t (error "Invalid prefix argument: %s" arg)))))
11607 (message "%d TODO entries found"
11608 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11610 (defun org-deadline (&optional remove time)
11612 With argument REMOVE, remove any deadline from the item.
11613 When TIME is set, it should be an internal time specification, and the
11614 scheduling will use the corresponding date."
11615 (interactive "P")
11616 (let* ((old-date (org-entry-get nil "DEADLINE"))
11617 (repeater (and old-date
11618 (string-match
11620 old-date)
11621 (match-string 1 old-date))))
11622 (if remove
11623 (progn
11624 (when (and old-date org-log-redeadline)
11625 (org-add-log-setup 'deldeadline nil old-date 'findpos
11626 org-log-redeadline))
11627 (org-remove-timestamp-with-keyword org-deadline-string)
11628 (message "Item no longer has a deadline."))
11629 (org-add-planning-info 'deadline time 'closed)
11630 (when (and old-date org-log-redeadline
11631 (not (equal old-date
11632 (substring org-last-inserted-timestamp 1 -1))))
11633 (org-add-log-setup 'redeadline nil old-date 'findpos
11634 org-log-redeadline))
11635 (when repeater
11636 (save-excursion
11637 (org-back-to-heading t)
11638 (when (re-search-forward (concat org-deadline-string " "
11639 org-last-inserted-timestamp)
11640 (save-excursion
11641 (outline-next-heading) (point)) t)
11642 (goto-char (1- (match-end 0)))
11643 (insert " " repeater)
11644 (setq org-last-inserted-timestamp
11645 (concat (substring org-last-inserted-timestamp 0 -1)
11646 " " repeater
11647 (substring org-last-inserted-timestamp -1))))))
11648 (message "Deadline on %s" org-last-inserted-timestamp))))
11650 (defun org-schedule (&optional remove time)
11651 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11652 With argument REMOVE, remove any scheduling date from the item.
11653 When TIME is set, it should be an internal time specification, and the
11654 scheduling will use the corresponding date."
11655 (interactive "P")
11656 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11657 (repeater (and old-date
11658 (string-match
11660 old-date)
11661 (match-string 1 old-date))))
11662 (if remove
11663 (progn
11664 (when (and old-date org-log-reschedule)
11665 (org-add-log-setup 'delschedule nil old-date 'findpos
11666 org-log-reschedule))
11667 (org-remove-timestamp-with-keyword org-scheduled-string)
11668 (message "Item is no longer scheduled."))
11669 (org-add-planning-info 'scheduled time 'closed)
11670 (when (and old-date org-log-reschedule
11671 (not (equal old-date
11672 (substring org-last-inserted-timestamp 1 -1))))
11673 (org-add-log-setup 'reschedule nil old-date 'findpos
11674 org-log-reschedule))
11675 (when repeater
11676 (save-excursion
11677 (org-back-to-heading t)
11678 (when (re-search-forward (concat org-scheduled-string " "
11679 org-last-inserted-timestamp)
11680 (save-excursion
11681 (outline-next-heading) (point)) t)
11682 (goto-char (1- (match-end 0)))
11683 (insert " " repeater)
11684 (setq org-last-inserted-timestamp
11685 (concat (substring org-last-inserted-timestamp 0 -1)
11686 " " repeater
11687 (substring org-last-inserted-timestamp -1))))))
11688 (message "Scheduled to %s" org-last-inserted-timestamp))))
11690 (defun org-get-scheduled-time (pom &optional inherit)
11691 "Get the scheduled time as a time tuple, of a format suitable
11692 for calling org-schedule with, or if there is no scheduling,
11693 returns nil."
11694 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11695 (when time
11696 (apply 'encode-time (org-parse-time-string time)))))
11698 (defun org-get-deadline-time (pom &optional inherit)
11699 "Get the deadline as a time tuple, of a format suitable for
11700 calling org-deadline with, or if there is no scheduling, returns
11701 nil."
11702 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11703 (when time
11704 (apply 'encode-time (org-parse-time-string time)))))
11706 (defun org-remove-timestamp-with-keyword (keyword)
11707 "Remove all time stamps with KEYWORD in the current entry."
11709 beg)
11710 (save-excursion
11711 (org-back-to-heading t)
11712 (setq beg (point))
11713 (outline-next-heading)
11714 (while (re-search-backward re beg t)
11715 (replace-match "")
11717 (equal (char-before) ?\ ))
11718 (backward-delete-char 1)
11720 (point-at-bol) (point-at-eol)))
11721 (delete-region (point-at-bol)
11722 (min (point-max) (1+ (point-at-eol))))))))))
11724 (defun org-add-planning-info (what &optional time &rest remove)
11725 "Insert new timestamp with keyword in the line directly after the headline.
11726 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11727 If non is given, the user is prompted for a date.
11728 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11729 be removed."
11730 (interactive)
11731 (let (org-time-was-given org-end-time-was-given ts
11732 end default-time default-input)
11734 (catch 'exit
11735 (when (and (not time) (memq what '(scheduled deadline)))
11736 ;; Try to get a default date/time from existing timestamp
11737 (save-excursion
11738 (org-back-to-heading t)
11739 (setq end (save-excursion (outline-next-heading) (point)))
11740 (when (re-search-forward (if (eq what 'scheduled)
11741 org-scheduled-time-regexp
11742 org-deadline-time-regexp)
11743 end t)
11744 (setq ts (match-string 1)
11745 default-time
11746 (apply 'encode-time (org-parse-time-string ts))
11747 default-input (and ts (org-get-compact-tod ts))))))
11748 (when what
11749 ;; If necessary, get the time from the user
11750 (setq time (or time (org-read-date nil 'to-time nil nil
11751 default-time default-input))))
11753 (when (and org-insert-labeled-timestamps-at-point
11754 (member what '(scheduled deadline)))
11755 (insert
11756 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11757 (org-insert-time-stamp time org-time-was-given
11758 nil nil nil (list org-end-time-was-given))
11759 (setq what nil))
11760 (save-excursion
11761 (save-restriction
11762 (let (col list elt ts buffer-invisibility-spec)
11763 (org-back-to-heading t)
11765 (goto-char (match-end 1))
11766 (setq col (current-column))
11767 (goto-char (match-end 0))
11769 (when (and (not what)
11770 (not (looking-at
11772 org-keyword-time-not-clock-regexp))))
11773 ;; Nothing to add, nothing to remove...... :-)
11774 (throw 'exit nil))
11775 (if (and (not (looking-at outline-regexp))
11778 (not (equal (match-string 1) org-clock-string)))
11779 (narrow-to-region (match-beginning 0) (match-end 0))
11781 (backward-char 1)
11782 (narrow-to-region (point) (point))
11783 (and org-adapt-indentation (org-indent-to-column col)))
11784 ;; Check if we have to remove something.
11785 (setq list (cons what remove))
11786 (while list
11787 (setq elt (pop list))
11788 (goto-char (point-min))
11789 (when (or (and (eq elt 'scheduled)
11790 (re-search-forward org-scheduled-time-regexp nil t))
11791 (and (eq elt 'deadline)
11792 (re-search-forward org-deadline-time-regexp nil t))
11793 (and (eq elt 'closed)
11794 (re-search-forward org-closed-time-regexp nil t)))
11795 (replace-match "")
11796 (if (looking-at "--+<[^>]+>") (replace-match ""))
11797 (skip-chars-backward " ")
11798 (if (looking-at " +") (replace-match ""))))
11799 (goto-char (point-max))
11800 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11801 (when what
11802 (insert
11803 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11804 (cond ((eq what 'scheduled) org-scheduled-string)
11805 ((eq what 'deadline) org-deadline-string)
11806 ((eq what 'closed) org-closed-string))
11807 " ")
11808 (setq ts (org-insert-time-stamp
11809 time
11810 (or org-time-was-given
11811 (and (eq what 'closed) org-log-done-with-time))
11812 (eq what 'closed)
11813 nil nil (list org-end-time-was-given)))
11814 (end-of-line 1))
11815 (goto-char (point-min))
11816 (widen)
11819 (delete-region (1- (point)) (point-at-eol)))
11820 ts))))))
11822 (defvar org-log-note-marker (make-marker))
11823 (defvar org-log-note-purpose nil)
11824 (defvar org-log-note-state nil)
11825 (defvar org-log-note-previous-state nil)
11826 (defvar org-log-note-how nil)
11827 (defvar org-log-note-extra nil)
11828 (defvar org-log-note-window-configuration nil)
11829 (defvar org-log-note-return-to (make-marker))
11830 (defvar org-log-post-message nil
11831 "Message to be displayed after a log note has been stored.
11832 The auto-repeater uses this.")
11834 (defun org-add-note ()
11835 "Add a note to the current entry.
11836 This is done in the same way as adding a state change note."
11837 (interactive)
11838 (org-add-log-setup 'note nil nil 'findpos nil))
11840 (defvar org-property-end-re)
11841 (defun org-add-log-setup (&optional purpose state prev-state
11842 findpos how extra)
11843 "Set up the post command hook to take a note.
11844 If this is about to TODO state change, the new state is expected in STATE.
11845 When FINDPOS is non-nil, find the correct position for the note in
11846 the current entry. If not, assume that it can be inserted at point.
11847 HOW is an indicator what kind of note should be created.
11848 EXTRA is additional text that will be inserted into the notes buffer."
11849 (let* ((org-log-into-drawer (org-log-into-drawer))
11850 (drawer (cond ((stringp org-log-into-drawer)
11851 org-log-into-drawer)
11852 (org-log-into-drawer "LOGBOOK")
11853 (t nil))))
11854 (save-restriction
11855 (save-excursion
11856 (when findpos
11857 (org-back-to-heading t)
11858 (narrow-to-region (point) (save-excursion
11859 (outline-next-heading) (point)))
11863 (goto-char (match-end 0))
11864 (cond
11865 (drawer
11867 nil t)
11868 (progn
11869 (goto-char (match-end 0))
11870 (or org-log-states-order-reversed
11871 (and (re-search-forward org-property-end-re nil t)
11872 (goto-char (1- (match-beginning 0))))))
11874 (beginning-of-line 0)
11875 (org-indent-line-function)
11876 (beginning-of-line 2)
11877 (org-indent-line-function)
11878 (end-of-line 0)))
11879 ((and org-log-state-notes-insert-after-drawers
11880 (save-excursion
11881 (forward-line) (looking-at org-drawer-regexp)))
11882 (forward-line)
11883 (while (looking-at org-drawer-regexp)
11884 (goto-char (match-end 0))
11885 (re-search-forward org-property-end-re (point-max) t)
11886 (forward-line))
11887 (forward-line -1)))
11888 (unless org-log-states-order-reversed
11890 (org-skip-over-state-notes)
11892 (move-marker org-log-note-marker (point))
11893 (setq org-log-note-purpose purpose
11894 org-log-note-state state
11895 org-log-note-previous-state prev-state
11896 org-log-note-how how
11897 org-log-note-extra extra)
11898 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11900 (defun org-skip-over-state-notes ()
11901 "Skip past the list of State notes in an entry."
11903 (when (ignore-errors (goto-char (org-in-item-p)))
11904 (let* ((struct (org-list-struct))
11905 (prevs (org-list-prevs-alist struct)))
11907 (goto-char (or (org-list-get-next-item (point) struct prevs)
11908 (org-list-get-item-end (point) struct)))))))
11910 (defun org-add-log-note (&optional purpose)
11911 "Pop up a window for taking a note, and add this note later at point."
11912 (remove-hook 'post-command-hook 'org-add-log-note)
11913 (setq org-log-note-window-configuration (current-window-configuration))
11914 (delete-other-windows)
11915 (move-marker org-log-note-return-to (point))
11916 (switch-to-buffer (marker-buffer org-log-note-marker))
11917 (goto-char org-log-note-marker)
11918 (org-switch-to-buffer-other-window "*Org Note*")
11919 (erase-buffer)
11920 (if (memq org-log-note-how '(time state))
11921 (let (current-prefix-arg) (org-store-log-note))
11922 (let ((org-inhibit-startup t)) (org-mode))
11923 (insert (format "# Insert note for %s.
11925 (cond
11926 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11927 ((eq org-log-note-purpose 'done) "closed todo item")
11928 ((eq org-log-note-purpose 'state)
11930 (or org-log-note-previous-state "")
11931 (or org-log-note-state "")))
11932 ((eq org-log-note-purpose 'reschedule)
11933 "rescheduling")
11934 ((eq org-log-note-purpose 'delschedule)
11935 "no longer scheduled")
11936 ((eq org-log-note-purpose 'redeadline)
11937 "changing deadline")
11938 ((eq org-log-note-purpose 'deldeadline)
11939 "removing deadline")
11940 ((eq org-log-note-purpose 'refile)
11941 "refiling")
11942 ((eq org-log-note-purpose 'note)
11943 "this entry")
11944 (t (error "This should not happen")))))
11945 (if org-log-note-extra (insert org-log-note-extra))
11946 (org-set-local 'org-finish-function 'org-store-log-note)))
11948 (defvar org-note-abort nil) ; dynamically scoped
11949 (defun org-store-log-note ()
11950 "Finish taking a log note, and insert it to where it belongs."
11951 (let ((txt (buffer-string))
11952 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11953 lines ind bul)
11954 (kill-buffer (current-buffer))
11956 (setq txt (replace-match "" t t txt)))
11958 (setq txt (replace-match "" t t txt)))
11961 (setq note
11962 (org-replace-escapes
11963 note
11964 (list (cons "%u" (user-login-name))
11965 (cons "%U" user-full-name)
11966 (cons "%t" (format-time-string
11967 (org-time-stamp-format 'long 'inactive)
11968 (current-time)))
11969 (cons "%T" (format-time-string
11970 (org-time-stamp-format 'long nil)
11971 (current-time)))
11972 (cons "%s" (if org-log-note-state
11974 ""))
11975 (cons "%S" (if org-log-note-previous-state
11979 (push note lines))
11980 (when (or current-prefix-arg org-note-abort)
11981 (when org-log-into-drawer
11982 (org-remove-empty-drawer-at
11983 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11984 org-log-note-marker))
11985 (setq lines nil))
11986 (when lines
11987 (with-current-buffer (marker-buffer org-log-note-marker)
11988 (save-excursion
11989 (goto-char org-log-note-marker)
11990 (move-marker org-log-note-marker nil)
11991 (end-of-line 1)
11993 (setq ind (save-excursion
11994 (if (ignore-errors (goto-char (org-in-item-p)))
11995 (let ((struct (org-list-struct)))
11996 (org-list-get-ind
11997 (org-list-get-top-point struct) struct))
11999 (cond
12000 ((and (org-at-heading-p)
12001 org-adapt-indentation)
12002 (1+ (org-current-level)))
12003 ((org-at-heading-p) 0)
12004 (t (org-get-indentation))))))
12005 (setq bul (org-list-bullet-string "-"))
12006 (org-indent-line-to ind)
12007 (insert bul (pop lines))
12008 (let ((ind-body (+ (length bul) ind)))
12009 (while lines
12011 (org-indent-line-to ind-body)
12012 (insert (pop lines))))
12013 (message "Note stored")
12014 (org-back-to-heading t)
12015 (org-cycle-hide-drawers 'children)))))
12016 (set-window-configuration org-log-note-window-configuration)
12017 (with-current-buffer (marker-buffer org-log-note-return-to)
12018 (goto-char org-log-note-return-to))
12019 (move-marker org-log-note-return-to nil)
12020 (and org-log-post-message (message "%s" org-log-post-message)))
12022 (defun org-remove-empty-drawer-at (drawer pos)
12023 "Remove an empty drawer DRAWER at position POS.
12024 POS may also be a marker."
12025 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12026 (save-excursion
12027 (save-restriction
12028 (widen)
12029 (goto-char pos)
12030 (if (org-in-regexp
12032 (replace-match ""))))))
12034 (defun org-sparse-tree (&optional arg)
12035 "Create a sparse tree, prompt for the details.
12036 This command can create sparse trees. You first need to select the type
12037 of match used to create the tree:
12039 t Show all TODO entries.
12040 T Show entries with a specific TODO keyword.
12041 m Show entries selected by a tags/property match.
12042 p Enter a property name and its value (both with completion on existing
12043 names/values) and show entries with that property.
12044 r Show entries matching a regular expression (`/' can be used as well)
12045 d Show deadlines due within `org-deadline-warning-days'.
12046 b Show deadlines and scheduled items before a date.
12047 a Show deadlines and scheduled items after a date."
12048 (interactive "P")
12049 (let (ans kwd value)
12050 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12051 (setq ans (read-char-exclusive))
12052 (cond
12053 ((equal ans ?d)
12054 (call-interactively 'org-check-deadlines))
12055 ((equal ans ?b)
12056 (call-interactively 'org-check-before-date))
12057 ((equal ans ?a)
12058 (call-interactively 'org-check-after-date))
12059 ((equal ans ?t)
12060 (org-show-todo-tree nil))
12061 ((equal ans ?T)
12062 (org-show-todo-tree '(4)))
12063 ((member ans '(?T ?m))
12064 (call-interactively 'org-match-sparse-tree))
12065 ((member ans '(?p ?P))
12066 (setq kwd (org-icompleting-read "Property: "
12067 (mapcar 'list (org-buffer-property-keys))))
12068 (setq value (org-icompleting-read "Value: "
12069 (mapcar 'list (org-property-values kwd))))
12072 (org-match-sparse-tree arg (concat kwd "=" value)))
12073 ((member ans '(?r ?R ?/))
12074 (call-interactively 'org-occur))
12077 (defvar org-occur-highlights nil
12078 "List of overlays used for occur matches.")
12079 (make-variable-buffer-local 'org-occur-highlights)
12080 (defvar org-occur-parameters nil
12081 "Parameters of the active org-occur calls.
12082 This is a list, each call to org-occur pushes as cons cell,
12083 containing the regular expression and the callback, onto the list.
12084 The list can contain several entries if `org-occur' has been called
12085 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12086 will only contain one set of parameters. When the highlights are
12087 removed (for example with `C-c C-c', or with the next edit (depending
12088 on `org-remove-highlights-with-change'), this variable is emptied
12089 as well.")
12090 (make-variable-buffer-local 'org-occur-parameters)
12092 (defun org-occur (regexp &optional keep-previous callback)
12093 "Make a compact tree which shows all matches of REGEXP.
12094 The tree will show the lines where the regexp matches, and all higher
12095 headlines above the match. It will also show the heading after the match,
12096 to make sure editing the matching entry is easy.
12097 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12098 call to `org-occur' will be kept, to allow stacking of calls to this
12099 command.
12100 If CALLBACK is non-nil, it is a function which is called to confirm
12101 that the match should indeed be shown."
12103 (when (equal regexp "")
12104 (error "Regexp cannot be empty"))
12105 (unless keep-previous
12106 (org-remove-occur-highlights nil nil t))
12107 (push (cons regexp callback) org-occur-parameters)
12108 (let ((cnt 0))
12109 (save-excursion
12110 (goto-char (point-min))
12111 (if (or (not keep-previous) ; do not want to keep
12112 (not org-occur-highlights)) ; no previous matches
12113 ;; hide everything
12114 (org-overview))
12115 (while (re-search-forward regexp nil t)
12116 (when (or (not callback)
12117 (save-match-data (funcall callback)))
12118 (setq cnt (1+ cnt))
12119 (when org-highlight-sparse-tree-matches
12120 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12121 (org-show-context 'occur-tree))))
12122 (when org-remove-highlights-with-change
12123 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12124 nil 'local))
12125 (unless org-sparse-tree-open-archived-trees
12126 (org-hide-archived-subtrees (point-min) (point-max)))
12127 (run-hooks 'org-occur-hook)
12128 (if (interactive-p)
12129 (message "%d match(es) for regexp %s" cnt regexp))
12130 cnt))
12132 (defun org-occur-next-match (&optional n reset)
12133 "Function for `next-error-function' to find sparse tree matches.
12134 N is the number of matches to move, when negative move backwards.
12135 RESET is entirely ignored - this function always goes back to the
12136 starting point when no match is found."
12137 (let* ((limit (if (< n 0) (point-min) (point-max)))
12138 (search-func (if (< n 0)
12139 'previous-single-char-property-change
12140 'next-single-char-property-change))
12141 (n (abs n))
12142 (pos (point))
12143 p1)
12144 (catch 'exit
12145 (while (setq p1 (funcall search-func (point) 'org-type))
12146 (when (equal p1 limit)
12147 (goto-char pos)
12148 (error "No more matches"))
12149 (when (equal (get-char-property p1 'org-type) 'org-occur)
12150 (setq n (1- n))
12151 (when (= n 0)
12152 (goto-char p1)
12153 (throw 'exit (point))))
12154 (goto-char p1))
12155 (goto-char p1)
12156 (error "No more matches"))))
12158 (defun org-show-context (&optional key)
12159 "Make sure point and context are visible.
12160 How much context is shown depends upon the variables
12161 `org-show-hierarchy-above', `org-show-following-heading'. and
12162 `org-show-siblings'."
12163 (let ((heading-p (org-on-heading-p t))
12164 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12165 (following-p (org-get-alist-option org-show-following-heading key))
12166 (entry-p (org-get-alist-option org-show-entry-below key))
12167 (siblings-p (org-get-alist-option org-show-siblings key)))
12168 (catch 'exit
12169 ;; Show heading or entry text
12170 (if (and heading-p (not entry-p))
12171 (org-flag-heading nil) ; only show the heading
12172 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12173 (org-show-hidden-entry))) ; show entire entry
12174 (when following-p
12175 ;; Show next sibling, or heading below text
12176 (save-excursion
12177 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12178 (org-flag-heading nil))))
12179 (when siblings-p (org-show-siblings))
12180 (when hierarchy-p
12181 ;; show all higher headings, possibly with siblings
12182 (save-excursion
12183 (while (and (condition-case nil
12184 (progn (org-up-heading-all 1) t)
12185 (error nil))
12186 (not (bobp)))
12187 (org-flag-heading nil)
12188 (when siblings-p (org-show-siblings))))))))
12190 (defvar org-reveal-start-hook nil
12191 "Hook run before revealing a location.")
12193 (defun org-reveal (&optional siblings)
12194 "Show current entry, hierarchy above it, and the following headline.
12195 This can be used to show a consistent set of context around locations
12196 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12197 not t for the search context.
12199 With optional argument SIBLINGS, on each level of the hierarchy all
12200 siblings are shown. This repairs the tree structure to what it would
12201 look like when opened with hierarchical calls to `org-cycle'.
12203 go to the parent and show the
12204 entire tree."
12205 (interactive "P")
12206 (run-hooks 'org-reveal-start-hook)
12207 (let ((org-show-hierarchy-above t)
12208 (org-show-following-heading t)
12209 (org-show-siblings (if siblings t org-show-siblings)))
12210 (org-show-context nil))
12211 (when (equal siblings '(16))
12212 (save-excursion
12213 (when (org-up-heading-safe)
12214 (org-show-subtree)
12215 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12217 (defun org-highlight-new-match (beg end)
12218 "Highlight from BEG to END and mark the highlight is an occur headline."
12219 (let ((ov (make-overlay beg end)))
12220 (overlay-put ov 'face 'secondary-selection)
12221 (overlay-put ov 'org-type 'org-occur)
12222 (push ov org-occur-highlights)))
12224 (defun org-remove-occur-highlights (&optional beg end noremove)
12225 "Remove the occur highlights from the buffer.
12226 BEG and END are ignored. If NOREMOVE is nil, remove this function
12227 from the `before-change-functions' in the current buffer."
12228 (interactive)
12229 (unless org-inhibit-highlight-removal
12230 (mapc 'delete-overlay org-occur-highlights)
12231 (setq org-occur-highlights nil)
12232 (setq org-occur-parameters nil)
12233 (unless noremove
12234 (remove-hook 'before-change-functions
12235 'org-remove-occur-highlights 'local))))
12237 ;;;; Priorities
12240 "Regular expression matching the priority indicator.")
12242 (defvar org-remove-priority-next-time nil)
12244 (defun org-priority-up ()
12245 "Increase the priority of the current item."
12246 (interactive)
12247 (org-priority 'up))
12249 (defun org-priority-down ()
12250 "Decrease the priority of the current item."
12251 (interactive)
12252 (org-priority 'down))
12254 (defun org-priority (&optional action)
12255 "Change the priority of an item by ARG.
12256 ACTION can be `set', `up', `down', or a character."
12257 (interactive)
12258 (unless org-enable-priority-commands
12259 (error "Priority commands are disabled"))
12260 (setq action (or action 'set))
12261 (let (current new news have remove)
12262 (save-excursion
12263 (org-back-to-heading t)
12264 (if (looking-at org-priority-regexp)
12265 (setq current (string-to-char (match-string 2))
12266 have t)
12267 (setq current org-default-priority))
12268 (cond
12269 ((eq action 'remove)
12270 (setq remove t new ?\ ))
12271 ((or (eq action 'set)
12272 (if (featurep 'xemacs) (characterp action) (integerp action)))
12273 (if (not (eq action 'set))
12274 (setq new action)
12275 (message "Priority %c-%c, SPC to remove: "
12276 org-highest-priority org-lowest-priority)
12277 (save-match-data
12278 (setq new (read-char-exclusive))))
12279 (if (and (= (upcase org-highest-priority) org-highest-priority)
12280 (= (upcase org-lowest-priority) org-lowest-priority))
12281 (setq new (upcase new)))
12282 (cond ((equal new ?\ ) (setq remove t))
12283 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12284 (error "Priority must be between `%c' and `%c'"
12285 org-highest-priority org-lowest-priority))))
12286 ((eq action 'up)
12287 (if (and (not have) (eq last-command this-command))
12288 (setq new org-lowest-priority)
12289 (setq new (if (and org-priority-start-cycle-with-default (not have))
12290 org-default-priority (1- current)))))
12291 ((eq action 'down)
12292 (if (and (not have) (eq last-command this-command))
12293 (setq new org-highest-priority)
12294 (setq new (if (and org-priority-start-cycle-with-default (not have))
12295 org-default-priority (1+ current)))))
12296 (t (error "Invalid action")))
12297 (if (or (< (upcase new) org-highest-priority)
12298 (> (upcase new) org-lowest-priority))
12299 (setq remove t))
12300 (setq news (format "%c" new))
12301 (if have
12302 (if remove
12303 (replace-match "" t t nil 1)
12304 (replace-match news t t nil 2))
12305 (if remove
12306 (error "No priority cookie found in line")
12307 (let ((case-fold-search nil))
12308 (looking-at org-todo-line-regexp))
12309 (if (match-end 2)
12310 (progn
12311 (goto-char (match-end 2))
12312 (insert " [#" news "]"))
12313 (goto-char (match-beginning 3))
12314 (insert "[#" news "] "))))
12315 (org-preserve-lc (org-set-tags nil 'align)))
12316 (if remove
12317 (message "Priority removed")
12318 (message "Priority of current item set to %s" news))))
12320 (defun org-get-priority (s)
12321 "Find priority cookie and return priority."
12322 (if (functionp org-get-priority-function)
12323 (funcall org-get-priority-function)
12324 (save-match-data
12325 (if (not (string-match org-priority-regexp s))
12326 (* 1000 (- org-lowest-priority org-default-priority))
12327 (* 1000 (- org-lowest-priority
12328 (string-to-char (match-string 2 s))))))))
12330 ;;;; Tags
12332 (defvar org-agenda-archives-mode)
12333 (defvar org-map-continue-from nil
12334 "Position from where mapping should continue.
12335 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12337 (defvar org-scanner-tags nil
12338 "The current tag list while the tags scanner is running.")
12339 (defvar org-trust-scanner-tags nil
12340 "Should `org-get-tags-at' use the tags for the scanner.
12341 This is for internal dynamical scoping only.
12342 When this is non-nil, the function `org-get-tags-at' will return the value
12343 of `org-scanner-tags' instead of building the list by itself. This
12344 can lead to large speed-ups when the tags scanner is used in a file with
12345 many entries, and when the list of tags is retrieved, for example to
12346 obtain a list of properties. Building the tags list for each entry in such
12347 a file becomes an N^2 operation - but with this variable set, it scales
12348 as N.")
12350 (defun org-scan-tags (action matcher &optional todo-only)
12351 "Scan headline tags with inheritance and produce output ACTION.
12353 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12354 or `agenda' to produce an entry list for an agenda view. It can also be
12355 a Lisp form or a function that should be called at each matched headline, in
12356 this case the return value is a list of all return values from these calls.
12358 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12359 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12360 only lines with a TODO keyword are included in the output."
12361 (require 'org-agenda)
12364 (org-re
12366 (props (list 'face 'default
12367 'done-face 'org-agenda-done
12368 'undone-face 'default
12369 'mouse-face 'highlight
12370 'org-not-done-regexp org-not-done-regexp
12371 'org-todo-regexp org-todo-regexp
12372 'help-echo
12373 (format "mouse-2 or RET jump to org file %s"
12374 (abbreviate-file-name
12375 (or (buffer-file-name (buffer-base-buffer))
12376 (buffer-name (buffer-base-buffer)))))))
12377 (case-fold-search nil)
12378 (org-map-continue-from nil)
12379 lspos tags tags-list
12380 (tags-alist (list (cons 0 org-file-tags)))
12381 (llast 0) rtn rtn1 level category i txt
12382 todo marker entry priority)
12383 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12384 (setq action (list 'lambda nil action)))
12385 (save-excursion
12386 (goto-char (point-min))
12387 (when (eq action 'sparse-tree)
12388 (org-overview)
12389 (org-remove-occur-highlights))
12390 (while (re-search-forward re nil t)
12391 (catch :skip
12392 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12393 tags (if (match-end 4) (org-match-string-no-properties 4)))
12394 (goto-char (setq lspos (match-beginning 0)))
12395 (setq level (org-reduced-level (funcall outline-level))
12396 category (org-get-category))
12397 (setq i llast llast level)
12398 ;; remove tag lists from same and sublevels
12399 (while (>= i level)
12400 (when (setq entry (assoc i tags-alist))
12401 (setq tags-alist (delete entry tags-alist)))
12402 (setq i (1- i)))
12403 ;; add the next tags
12404 (when tags
12405 (setq tags (org-split-string tags ":")
12406 tags-alist
12407 (cons (cons level tags) tags-alist)))
12408 ;; compile tags for current headline
12409 (setq tags-list
12410 (if org-use-tag-inheritance
12411 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12412 tags)
12413 org-scanner-tags tags-list)
12414 (when org-use-tag-inheritance
12415 (setcdr (car tags-alist)
12416 (mapcar (lambda (x)
12417 (setq x (copy-sequence x))
12418 (org-add-prop-inherited x))
12419 (cdar tags-alist))))
12420 (when (and tags org-use-tag-inheritance
12421 (or (not (eq t org-use-tag-inheritance))
12422 org-tags-exclude-from-inheritance))
12423 ;; selective inheritance, remove uninherited ones
12424 (setcdr (car tags-alist)
12425 (org-remove-uniherited-tags (cdar tags-alist))))
12426 (when (and (or (not todo-only)
12427 (and (member todo org-not-done-keywords)
12428 (or (not org-agenda-tags-todo-honor-ignore-options)
12429 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12430 (let ((case-fold-search t)) (eval matcher))
12431 (or
12432 (not (member org-archive-tag tags-list))
12433 ;; we have an archive tag, should we use this anyway?
12434 (or (not org-agenda-skip-archived-trees)
12435 (and (eq action 'agenda) org-agenda-archives-mode))))
12436 (unless (eq action 'sparse-tree) (org-agenda-skip))
12438 ;; select this headline
12440 (cond
12441 ((eq action 'sparse-tree)
12442 (and org-highlight-sparse-tree-matches
12443 (org-get-heading) (match-end 0)
12444 (org-highlight-new-match
12445 (match-beginning 0) (match-beginning 1)))
12446 (org-show-context 'tags-tree))
12447 ((eq action 'agenda)
12448 (setq txt (org-format-agenda-item
12449 ""
12450 (concat
12451 (if (eq org-tags-match-list-sublevels 'indented)
12452 (make-string (1- level) ?.) "")
12453 (org-get-heading))
12454 category
12455 tags-list
12456 )
12457 priority (org-get-priority txt))
12458 (goto-char lspos)
12459 (setq marker (org-agenda-new-marker))
12460 (org-add-props txt props
12461 'org-marker marker 'org-hd-marker marker 'org-category category
12462 'todo-state todo
12463 'priority priority 'type "tagsmatch")
12464 (push txt rtn))
12465 ((functionp action)
12466 (setq org-map-continue-from nil)
12467 (save-excursion
12468 (setq rtn1 (funcall action))
12469 (push rtn1 rtn)))
12470 (t (error "Invalid action")))
12472 ;; if we are to skip sublevels, jump to end of subtree
12473 (unless org-tags-match-list-sublevels
12474 (org-end-of-subtree t)
12475 (backward-char 1))))
12476 ;; Get the correct position from where to continue
12477 (if org-map-continue-from
12478 (goto-char org-map-continue-from)
12479 (and (= (point) lspos) (end-of-line 1)))))
12480 (when (and (eq action 'sparse-tree)
12481 (not org-sparse-tree-open-archived-trees))
12482 (org-hide-archived-subtrees (point-min) (point-max)))
12483 (nreverse rtn)))
12485 (defun org-remove-uniherited-tags (tags)
12486 "Remove all tags that are not inherited from the list TAGS."
12487 (cond
12488 ((eq org-use-tag-inheritance t)
12489 (if org-tags-exclude-from-inheritance
12490 (org-delete-all org-tags-exclude-from-inheritance tags)
12491 tags))
12492 ((not org-use-tag-inheritance) nil)
12493 ((stringp org-use-tag-inheritance)
12494 (delq nil (mapcar
12495 (lambda (x)
12496 (if (and (string-match org-use-tag-inheritance x)
12497 (not (member x org-tags-exclude-from-inheritance)))
12498 x nil))
12499 tags)))
12500 ((listp org-use-tag-inheritance)
12501 (delq nil (mapcar
12502 (lambda (x)
12503 (if (member x org-use-tag-inheritance) x nil))
12504 tags)))))
12506 (defvar todo-only) ;; dynamically scoped
12508 (defun org-match-sparse-tree (&optional todo-only match)
12509 "Create a sparse tree according to tags string MATCH.
12510 MATCH can contain positive and negative selection of tags, like
12512 If optional argument TODO-ONLY is non-nil, only select lines that are
12513 also TODO lines."
12514 (interactive "P")
12515 (org-prepare-agenda-buffers (list (current-buffer)))
12516 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12518 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12520 (defvar org-cached-props nil)
12521 (defun org-cached-entry-get (pom property)
12522 (if (or (eq t org-use-property-inheritance)
12523 (and (stringp org-use-property-inheritance)
12524 (string-match org-use-property-inheritance property))
12525 (and (listp org-use-property-inheritance)
12526 (member property org-use-property-inheritance)))
12527 ;; Caching is not possible, check it directly
12528 (org-entry-get pom property 'inherit)
12529 ;; Get all properties, so that we can do complicated checks easily
12530 (cdr (assoc property (or org-cached-props
12531 (setq org-cached-props
12532 (org-entry-properties pom)))))))
12534 (defun org-global-tags-completion-table (&optional files)
12535 "Return the list of all tags in all agenda buffer/files.
12536 Optional FILES argument is a list of files to which can be used
12537 instead of the agenda files."
12538 (save-excursion
12539 (org-uniquify
12540 (delq nil
12541 (apply 'append
12542 (mapcar
12543 (lambda (file)
12544 (set-buffer (find-file-noselect file))
12545 (append (org-get-buffer-tags)
12546 (mapcar (lambda (x) (if (stringp (car-safe x))
12547 (list (car-safe x)) nil))
12548 org-tag-alist)))
12549 (if (and files (car files))
12550 files
12551 (org-agenda-files))))))))
12553 (defun org-make-tags-matcher (match)
12554 "Create the TAGS/TODO matcher form for the selection string MATCH."
12555 ;; todo-only is scoped dynamically into this function, and the function
12556 ;; may change it if the matcher asks for it.
12557 (unless match
12558 ;; Get a new match request, with completion
12559 (let ((org-last-tags-completion-table
12560 (org-global-tags-completion-table)))
12561 (setq match (org-completing-read-no-i
12562 "Match: " 'org-tags-completion-function nil nil nil
12563 'org-tags-history))))
12565 ;; Parse the string and create a lisp form
12566 (let ((match0 match)
12567 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12568 minus tag mm
12569 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12570 orterms term orlist re-p str-p level-p level-op time-p
12571 prop-p pn pv po gv rest)
12572 (if (string-match "/+" match)
12573 ;; match contains also a todo-matching request
12574 (progn
12575 (setq tagsmatch (substring match 0 (match-beginning 0))
12576 todomatch (substring match (match-end 0)))
12577 (if (string-match "^!" todomatch)
12578 (setq todo-only t todomatch (substring todomatch 1)))
12580 (setq todomatch nil)))
12581 ;; only matching tags
12582 (setq tagsmatch match todomatch nil))
12584 ;; Make the tags matcher
12586 (setq tagsmatcher t)
12587 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12588 (while (setq term (pop orterms))
12590 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12591 (while (string-match re term)
12592 (setq rest (substring term (match-end 0))
12593 minus (and (match-end 1)
12594 (equal (match-string 1 term) "-"))
12595 tag (save-match-data (replace-regexp-in-string
12597 (match-string 2 term)))
12598 re-p (equal (string-to-char tag) ?{)
12599 level-p (match-end 4)
12600 prop-p (match-end 5)
12601 mm (cond
12602 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12603 (level-p
12604 (setq level-op (org-op-to-function (match-string 3 term)))
12605 `(,level-op level ,(string-to-number
12606 (match-string 4 term))))
12607 (prop-p
12608 (setq pn (match-string 5 term)
12609 po (match-string 6 term)
12610 pv (match-string 7 term)
12611 re-p (equal (string-to-char pv) ?{)
12613 time-p (save-match-data
12615 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12616 (if time-p (setq pv (org-matcher-time pv)))
12617 (setq po (org-op-to-function po (if time-p 'time str-p)))
12618 (cond
12619 ((equal pn "CATEGORY")
12620 (setq gv '(get-text-property (point) 'org-category)))
12621 ((equal pn "TODO")
12622 (setq gv 'todo))
12623 (t
12624 (setq gv `(org-cached-entry-get nil ,pn))))
12625 (if re-p
12626 (if (eq po 'org<>)
12627 `(not (string-match ,pv (or ,gv "")))
12628 `(string-match ,pv (or ,gv "")))
12629 (if str-p
12630 `(,po (or ,gv "") ,pv)
12631 `(,po (string-to-number (or ,gv ""))
12632 ,(string-to-number pv) ))))
12633 (t `(member ,tag tags-list)))
12634 mm (if minus (list 'not mm) mm)
12635 term rest)
12636 (push mm tagsmatcher))
12637 (push (if (> (length tagsmatcher) 1)
12638 (cons 'and tagsmatcher)
12639 (car tagsmatcher))
12640 orlist)
12641 (setq tagsmatcher nil))
12642 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12643 (setq tagsmatcher
12644 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12645 ;; Make the todo matcher
12647 (setq todomatcher t)
12648 (setq orterms (org-split-string todomatch "|") orlist nil)
12649 (while (setq term (pop orterms))
12650 (while (string-match re term)
12651 (setq minus (and (match-end 1)
12652 (equal (match-string 1 term) "-"))
12653 kwd (match-string 2 term)
12654 re-p (equal (string-to-char kwd) ?{)
12655 term (substring term (match-end 0))
12656 mm (if re-p
12657 `(string-match ,(substring kwd 1 -1) todo)
12658 (list 'equal 'todo kwd))
12659 mm (if minus (list 'not mm) mm))
12660 (push mm todomatcher))
12661 (push (if (> (length todomatcher) 1)
12662 (cons 'and todomatcher)
12663 (car todomatcher))
12664 orlist)
12665 (setq todomatcher nil))
12666 (setq todomatcher (if (> (length orlist) 1)
12667 (cons 'or orlist) (car orlist))))
12669 ;; Return the string and lisp forms of the matcher
12670 (setq matcher (if todomatcher
12671 (list 'and tagsmatcher todomatcher)
12672 tagsmatcher))
12673 (cons match0 matcher)))
12675 (defun org-op-to-function (op &optional stringp)
12676 "Turn an operator into the appropriate function."
12677 (setq op
12678 (cond
12679 ((equal op "<" ) '(< string< org-time<))
12680 ((equal op ">" ) '(> org-string> org-time>))
12681 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12682 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12683 ((member op '("=" "==")) '(= string= org-time=))
12684 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12685 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12687 (defun org<> (a b) (not (= a b)))
12688 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12689 (defun org-string>= (a b) (not (string< a b)))
12690 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12691 (defun org-string<> (a b) (not (string= a b)))
12692 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12693 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12694 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12695 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12696 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12697 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12698 (defun org-2ft (s)
12699 "Convert S to a floating point time.
12700 If S is already a number, just return it. If it is a string, parse
12701 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12702 (cond
12703 ((numberp s) s)
12704 ((stringp s)
12705 (condition-case nil
12706 (float-time (apply 'encode-time (org-parse-time-string s)))
12707 (error 0.)))
12708 (t 0.)))
12710 (defun org-time-today ()
12711 "Time in seconds today at 0:00.
12712 Returns the float number of seconds since the beginning of the
12713 epoch to the beginning of today (00:00)."
12714 (float-time (apply 'encode-time
12715 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12717 (defun org-matcher-time (s)
12718 "Interpret a time comparison value."
12719 (save-match-data
12720 (cond
12721 ((string= s "<now>") (float-time))
12722 ((string= s "<today>") (org-time-today))
12723 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12724 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12726 (+ (org-time-today)
12727 (* (string-to-number (match-string 1 s))
12728 (cdr (assoc (match-string 2 s)
12729 '(("d" . 86400.0) ("w" . 604800.0)
12730 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12731 (t (org-2ft s)))))
12733 (defun org-match-any-p (re list)
12734 "Does re match any element of list?"
12735 (setq list (mapcar (lambda (x) (string-match re x)) list))
12736 (delq nil list))
12738 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12739 (defvar org-tags-overlay (make-overlay 1 1))
12740 (org-detach-overlay org-tags-overlay)
12742 (defun org-get-local-tags-at (&optional pos)
12743 "Get a list of tags defined in the current headline."
12744 (org-get-tags-at pos 'local))
12746 (defun org-get-local-tags ()
12747 "Get a list of tags defined in the current headline."
12748 (org-get-tags-at nil 'local))
12750 (defun org-get-tags-at (&optional pos local)
12751 "Get a list of all headline tags applicable at POS.
12752 POS defaults to point. If tags are inherited, the list contains
12753 the targets in the same sequence as the headlines appear, i.e.
12754 the tags of the current headline come last.
12755 When LOCAL is non-nil, only return tags from the current headline,
12756 ignore inherited ones."
12757 (interactive)
12758 (if (and org-trust-scanner-tags
12759 (or (not pos) (equal pos (point)))
12760 (not local))
12761 org-scanner-tags
12762 (let (tags ltags lastpos parent)
12763 (save-excursion
12764 (save-restriction
12765 (widen)
12766 (goto-char (or pos (point)))
12767 (save-match-data
12768 (catch 'done
12769 (condition-case nil
12770 (progn
12771 (org-back-to-heading t)
12772 (while (not (equal lastpos (point)))
12773 (setq lastpos (point))
12774 (when (looking-at
12776 (setq ltags (org-split-string
12777 (org-match-string-no-properties 1) ":"))
12778 (when parent
12779 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12780 (setq tags (append
12781 (if parent
12782 (org-remove-uniherited-tags ltags)
12783 ltags)
12784 tags)))
12785 (or org-use-tag-inheritance (throw 'done t))
12786 (if local (throw 'done t))
12787 (or (org-up-heading-safe) (error nil))
12788 (setq parent t)))
12789 (error nil)))))
12790 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12792 (defun org-add-prop-inherited (s)
12793 (add-text-properties 0 (length s) '(inherited t) s)
12794 s)
12796 (defun org-toggle-tag (tag &optional onoff)
12797 "Toggle the tag TAG for the current line.
12798 If ONOFF is `on' or `off', don't toggle but set to this state."
12799 (let (res current)
12800 (save-excursion
12801 (org-back-to-heading t)
12803 (point-at-eol) t)
12804 (progn
12805 (setq current (match-string 1))
12806 (replace-match ""))
12807 (setq current ""))
12808 (setq current (nreverse (org-split-string current ":")))
12809 (cond
12810 ((eq onoff 'on)
12811 (setq res t)
12812 (or (member tag current) (push tag current)))
12813 ((eq onoff 'off)
12814 (or (not (member tag current)) (setq current (delete tag current))))
12815 (t (if (member tag current)
12816 (setq current (delete tag current))
12817 (setq res t)
12818 (push tag current))))
12819 (end-of-line 1)
12820 (if current
12821 (progn
12822 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12823 (org-set-tags nil t))
12824 (delete-horizontal-space))
12825 (run-hooks 'org-after-tags-change-hook))
12826 res))
12828 (defun org-align-tags-here (to-col)
12829 ;; Assumes that this is a headline
12830 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12831 (beginning-of-line 1)
12833 (< pos (match-beginning 2)))
12834 (progn
12835 (setq tags-l (- (match-end 2) (match-beginning 2)))
12836 (goto-char (match-beginning 1))
12837 (insert " ")
12838 (delete-region (point) (1+ (match-beginning 2)))
12839 (setq ncol (max (1+ (current-column))
12840 (1+ col)
12841 (if (> to-col 0)
12842 to-col
12843 (- (abs to-col) tags-l))))
12844 (setq p (point))
12845 (insert (make-string (- ncol (current-column)) ?\ ))
12846 (setq ncol (current-column))
12847 (when indent-tabs-mode (tabify p (point-at-eol)))
12848 (org-move-to-column (min ncol col) t))
12849 (goto-char pos))))
12851 (defun org-set-tags-command (&optional arg just-align)
12852 "Call the set-tags command for the current entry."
12853 (interactive "P")
12854 (if (org-on-heading-p)
12855 (org-set-tags arg just-align)
12856 (save-excursion
12857 (org-back-to-heading t)
12858 (org-set-tags arg just-align))))
12860 (defun org-set-tags-to (data)
12861 "Set the tags of the current entry to DATA, replacing the current tags.
12862 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12863 If DATA is nil or the empty string, any tags will be removed."
12864 (interactive "sTags: ")
12865 (setq data
12866 (cond
12867 ((eq data nil) "")
12868 ((equal data "") "")
12869 ((stringp data)
12870 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12871 ":"))
12872 ((listp data)
12873 (concat ":" (mapconcat 'identity data ":") ":"))
12874 (t nil)))
12875 (when data
12876 (save-excursion
12877 (org-back-to-heading t)
12878 (when (looking-at org-complex-heading-regexp)
12879 (if (match-end 5)
12880 (progn
12881 (goto-char (match-beginning 5))
12882 (insert data)
12883 (delete-region (point) (point-at-eol))
12884 (org-set-tags nil 'align))
12885 (goto-char (point-at-eol))
12886 (insert " " data)
12887 (org-set-tags nil 'align)))
12888 (beginning-of-line 1)
12890 (delete-region (match-beginning 1) (match-end 1))))))
12892 (defun org-align-all-tags ()
12893 "Align the tags i all headings."
12894 (interactive)
12895 (save-excursion
12896 (or (ignore-errors (org-back-to-heading t))
12897 (outline-next-heading))
12898 (if (org-on-heading-p)
12899 (org-set-tags t)
12900 (message "No headings"))))
12902 (defvar org-indent-indentation-per-level)
12903 (defun org-set-tags (&optional arg just-align)
12904 "Set the tags for the current headline.
12905 With prefix ARG, realign all tags in headings in the current buffer."
12906 (interactive "P")
12907 (let* ((re (concat "^" outline-regexp))
12908 (current (org-get-tags-string))
12909 (col (current-column))
12910 (org-setting-tags t)
12911 table current-tags inherited-tags ; computed below when needed
12912 tags p0 c0 c1 rpl di tc level)
12913 (if arg
12914 (save-excursion
12915 (goto-char (point-min))
12916 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12917 (while (re-search-forward re nil t)
12918 (org-set-tags nil t)
12919 (end-of-line 1)))
12920 (message "All tags realigned to column %d" org-tags-column))
12921 (if just-align
12922 (setq tags current)
12923 ;; Get a new set of tags from the user
12924 (save-excursion
12925 (setq table (append org-tag-persistent-alist
12926 (or org-tag-alist (org-get-buffer-tags))
12927 (and
12928 org-complete-tags-always-offer-all-agenda-tags
12929 (org-global-tags-completion-table
12930 (org-agenda-files))))
12931 org-last-tags-completion-table table
12932 current-tags (org-split-string current ":")
12933 inherited-tags (nreverse
12934 (nthcdr (length current-tags)
12935 (nreverse (org-get-tags-at))))
12936 tags
12937 (if (or (eq t org-use-fast-tag-selection)
12938 (and org-use-fast-tag-selection
12939 (delq nil (mapcar 'cdr table))))
12940 (org-fast-tag-selection
12941 current-tags inherited-tags table
12942 (if org-fast-tag-selection-include-todo
12943 org-todo-key-alist))
12944 (let ((org-add-colon-after-tag-completion t))
12945 (org-trim
12946 (org-without-partial-completion
12947 (org-icompleting-read "Tags: "
12948 'org-tags-completion-function
12949 nil nil current 'org-tags-history)))))))
12950 (while (string-match "[-+&]+" tags)
12951 ;; No boolean logic, just a list
12952 (setq tags (replace-match ":" t t tags))))
12954 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12956 (if org-tags-sort-function
12957 (setq tags (mapconcat 'identity
12958 (sort (org-split-string
12959 tags (org-re "[^[:alnum:]_@#%]+"))
12960 org-tags-sort-function) ":")))
12963 (setq tags "")
12964 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12965 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12967 ;; Insert new tags at the correct column
12968 (beginning-of-line 1)
12969 (setq level (or (and (looking-at org-outline-regexp)
12970 (- (match-end 0) (point) 1))
12971 1))
12972 (cond
12973 ((and (equal current "") (equal tags "")))
12974 ((re-search-forward
12976 (point-at-eol) t)
12977 (if (equal tags "")
12978 (setq rpl "")
12979 (goto-char (match-beginning 0))
12980 (setq c0 (current-column)
12981 ;; compute offset for the case of org-indent-mode active
12982 di (if org-indent-mode
12983 (* (1- org-indent-indentation-per-level) (1- level))
12984 0)
12985 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12986 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12987 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12988 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12989 (replace-match rpl t t)
12990 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12991 tags)
12992 (t (error "Tags alignment failed")))
12993 (org-move-to-column col)
12994 (unless just-align
12995 (run-hooks 'org-after-tags-change-hook)))))
12997 (defun org-change-tag-in-region (beg end tag off)
12998 "Add or remove TAG for each entry in the region.
12999 This works in the agenda, and also in an org-mode buffer."
13000 (interactive
13001 (list (region-beginning) (region-end)
13002 (let ((org-last-tags-completion-table
13003 (if (org-mode-p)
13004 (org-get-buffer-tags)
13005 (org-global-tags-completion-table))))
13006 (org-icompleting-read
13007 "Tag: " 'org-tags-completion-function nil nil nil
13008 'org-tags-history))
13009 (progn
13011 (equal (read-char-exclusive) ?r))))
13012 (if (fboundp 'deactivate-mark) (deactivate-mark))
13013 (let ((agendap (equal major-mode 'org-agenda-mode))
13014 l1 l2 m buf pos newhead (cnt 0))
13015 (goto-char end)
13016 (setq l2 (1- (org-current-line)))
13017 (goto-char beg)
13018 (setq l1 (org-current-line))
13019 (loop for l from l1 to l2 do
13020 (org-goto-line l)
13021 (setq m (get-text-property (point) 'org-hd-marker))
13022 (when (or (and (org-mode-p) (org-on-heading-p))
13023 (and agendap m))
13024 (setq buf (if agendap (marker-buffer m) (current-buffer))
13025 pos (if agendap m (point)))
13026 (with-current-buffer buf
13027 (save-excursion
13028 (save-restriction
13029 (goto-char pos)
13030 (setq cnt (1+ cnt))
13031 (org-toggle-tag tag (if off 'off 'on))
13032 (setq newhead (org-get-heading)))))
13033 (and agendap (org-agenda-change-all-lines newhead m))))
13034 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13036 (defun org-tags-completion-function (string predicate &optional flag)
13037 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13038 (confirm (lambda (x) (stringp (car x)))))
13040 (setq s1 (match-string 1 string)
13041 s2 (match-string 2 string))
13042 (setq s1 "" s2 string))
13043 (cond
13044 ((eq flag nil)
13045 ;; try completion
13046 (setq rtn (try-completion s2 ctable confirm))
13047 (if (stringp rtn)
13048 (setq rtn
13049 (concat s1 s2 (substring rtn (length s2))
13050 (if (and org-add-colon-after-tag-completion
13051 (assoc rtn ctable))
13052 ":" ""))))
13053 rtn)
13054 ((eq flag t)
13055 ;; all-completions
13056 (all-completions s2 ctable confirm)
13057 )
13058 ((eq flag 'lambda)
13059 ;; exact match?
13060 (assoc s2 ctable)))
13061 ))
13063 (defun org-fast-tag-insert (kwd tags face &optional end)
13064 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13065 (insert (format "%-12s" (concat kwd ":"))
13066 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13067 (or end "")))
13069 (defun org-fast-tag-show-exit (flag)
13070 (save-excursion
13071 (org-goto-line 3)
13073 (replace-match ""))
13074 (when flag
13075 (end-of-line 1)
13076 (org-move-to-column (- (window-width) 19) t)
13077 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13079 (defun org-set-current-tags-overlay (current prefix)
13080 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13081 (if (featurep 'xemacs)
13082 (org-overlay-display org-tags-overlay (concat prefix s)
13083 'secondary-selection)
13084 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13085 (org-overlay-display org-tags-overlay (concat prefix s)))))
13087 (defvar org-last-tag-selection-key nil)
13088 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13089 "Fast tag selection with single keys.
13090 CURRENT is the current list of tags in the headline, INHERITED is the
13091 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13092 possibly with grouping information. TODO-TABLE is a similar table with
13093 TODO keywords, should these have keys assigned to them.
13094 If the keys are nil, a-z are automatically assigned.
13095 Returns the new tags string, or nil to not change the current settings."
13096 (let* ((fulltable (append table todo-table))
13097 (maxlen (apply 'max (mapcar
13098 (lambda (x)
13099 (if (stringp (car x)) (string-width (car x)) 0))
13100 fulltable)))
13101 (buf (current-buffer))
13102 (expert (eq org-fast-tag-selection-single-key 'expert))
13103 (buffer-tags nil)
13104 (fwidth (+ maxlen 3 1 3))
13105 (ncol (/ (- (window-width) 4) fwidth))
13106 (i-face 'org-done)
13107 (c-face 'org-todo)
13108 tg cnt e c char c1 c2 ntable tbl rtn
13109 ov-start ov-end ov-prefix
13110 (exit-after-next org-fast-tag-selection-single-key)
13111 (done-keywords org-done-keywords)
13112 groups ingroup)
13113 (save-excursion
13114 (beginning-of-line 1)
13115 (if (looking-at
13117 (setq ov-start (match-beginning 1)
13118 ov-end (match-end 1)
13119 ov-prefix "")
13120 (setq ov-start (1- (point-at-eol))
13121 ov-end (1+ ov-start))
13123 (setq ov-prefix
13124 (concat
13125 (buffer-substring (1- (point)) (point))
13126 (if (> (current-column) org-tags-column)
13127 " "
13128 (make-string (- org-tags-column (current-column)) ?\ ))))))
13129 (move-overlay org-tags-overlay ov-start ov-end)
13130 (save-window-excursion
13131 (if expert
13132 (set-buffer (get-buffer-create " *Org tags*"))
13133 (delete-other-windows)
13134 (split-window-vertically)
13135 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13136 (erase-buffer)
13137 (org-set-local 'org-done-keywords done-keywords)
13140 (org-fast-tag-show-exit exit-after-next)
13141 (org-set-current-tags-overlay current ov-prefix)
13142 (setq tbl fulltable char ?a cnt 0)
13143 (while (setq e (pop tbl))
13144 (cond
13145 ((equal (car e) :startgroup)
13146 (push '() groups) (setq ingroup t)
13147 (when (not (= cnt 0))
13148 (setq cnt 0)
13150 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13151 ((equal (car e) :endgroup)
13152 (setq ingroup nil cnt 0)
13154 ((equal e '(:newline))
13155 (when (not (= cnt 0))
13156 (setq cnt 0)
13158 (setq e (car tbl))
13159 (while (equal (car tbl) '(:newline))
13161 (setq tbl (cdr tbl)))))
13162 (t
13163 (setq tg (copy-sequence (car e)) c2 nil)
13164 (if (cdr e)
13165 (setq c (cdr e))
13166 ;; automatically assign a character.
13167 (setq c1 (string-to-char
13168 (downcase (substring
13169 tg (if (= (string-to-char tg) ?@) 1 0)))))
13170 (if (or (rassoc c1 ntable) (rassoc c1 table))
13171 (while (or (rassoc char ntable) (rassoc char table))
13172 (setq char (1+ char)))
13173 (setq c2 c1))
13174 (setq c (or c2 char)))
13175 (if ingroup (push tg (car groups)))
13176 (setq tg (org-add-props tg nil 'face
13177 (cond
13178 ((not (assoc tg table))
13179 (org-get-todo-face tg))
13180 ((member tg current) c-face)
13181 ((member tg inherited) i-face)
13182 (t nil))))
13183 (if (and (= cnt 0) (not ingroup)) (insert " "))
13184 (insert "[" c "] " tg (make-string
13185 (- fwidth 4 (length tg)) ?\ ))
13186 (push (cons tg c) ntable)
13187 (when (= (setq cnt (1+ cnt)) ncol)
13189 (if ingroup (insert " "))
13190 (setq cnt 0)))))
13191 (setq ntable (nreverse ntable))
13193 (goto-char (point-min))
13194 (if (not expert) (org-fit-window-to-buffer))
13195 (setq rtn
13196 (catch 'exit
13197 (while t
13198 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13199 (if (not groups) "no " "")
13200 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13201 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13202 (setq org-last-tag-selection-key c)
13203 (cond
13205 ((= c ?!)
13206 (setq groups (not groups))
13207 (goto-char (point-min))
13208 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13209 ((= c ?\C-c)
13210 (if (not expert)
13211 (org-fast-tag-show-exit
13212 (setq exit-after-next (not exit-after-next)))
13213 (setq expert nil)
13214 (delete-other-windows)
13215 (set-window-buffer (split-window-vertically) " *Org tags*")
13216 (org-switch-to-buffer-other-window " *Org tags*")
13217 (org-fit-window-to-buffer)))
13218 ((or (= c ?\C-g)
13219 (and (= c ?q) (not (rassoc c ntable))))
13220 (org-detach-overlay org-tags-overlay)
13221 (setq quit-flag t))
13222 ((= c ?\ )
13223 (setq current nil)
13224 (if exit-after-next (setq exit-after-next 'now)))
13226 (condition-case nil
13227 (setq tg (org-icompleting-read
13228 "Tag: "
13229 (or buffer-tags
13230 (with-current-buffer buf
13231 (org-get-buffer-tags)))))
13232 (quit (setq tg "")))
13234 (add-to-list 'buffer-tags (list tg))
13235 (if (member tg current)
13236 (setq current (delete tg current))
13237 (push tg current)))
13238 (if exit-after-next (setq exit-after-next 'now)))
13239 ((setq e (rassoc c todo-table) tg (car e))
13240 (with-current-buffer buf
13241 (save-excursion (org-todo tg)))
13242 (if exit-after-next (setq exit-after-next 'now)))
13243 ((setq e (rassoc c ntable) tg (car e))
13244 (if (member tg current)
13245 (setq current (delete tg current))
13246 (loop for g in groups do
13247 (if (member tg g)
13248 (mapc (lambda (x)
13249 (setq current (delete x current)))
13250 g)))
13251 (push tg current))
13252 (if exit-after-next (setq exit-after-next 'now))))
13254 ;; Create a sorted list
13255 (setq current
13256 (sort current
13257 (lambda (a b)
13258 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13259 (if (eq exit-after-next 'now) (throw 'exit t))
13260 (goto-char (point-min))
13261 (beginning-of-line 2)
13262 (delete-region (point) (point-at-eol))
13263 (org-fast-tag-insert "Current" current c-face)
13264 (org-set-current-tags-overlay current ov-prefix)
13265 (while (re-search-forward
13267 (setq tg (match-string 1))
13268 (add-text-properties
13269 (match-beginning 1) (match-end 1)
13270 (list 'face
13271 (cond
13272 ((member tg current) c-face)
13273 ((member tg inherited) i-face)
13274 (t (get-text-property (match-beginning 1) 'face))))))
13275 (goto-char (point-min)))))
13276 (org-detach-overlay org-tags-overlay)
13277 (if rtn
13278 (mapconcat 'identity current ":")
13279 nil))))
13281 (defun org-get-tags-string ()
13282 "Get the TAGS string in the current headline."
13283 (unless (org-on-heading-p t)
13284 (error "Not on a heading"))
13285 (save-excursion
13286 (beginning-of-line 1)
13288 (org-match-string-no-properties 1)
13289 "")))
13291 (defun org-get-tags ()
13292 "Get the list of tags specified in the current headline."
13293 (org-split-string (org-get-tags-string) ":"))
13295 (defun org-get-buffer-tags ()
13296 "Get a table of all tags used in the buffer, for completion."
13297 (let (tags)
13298 (save-excursion
13299 (goto-char (point-min))
13300 (while (re-search-forward
13302 (when (equal (char-after (point-at-bol 0)) ?*)
13303 (mapc (lambda (x) (add-to-list 'tags x))
13304 (org-split-string (org-match-string-no-properties 1) ":")))))
13305 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13306 (mapcar 'list tags)))
13308 ;;;; The mapping API
13310 ;;;###autoload
13311 (defun org-map-entries (func &optional match scope &rest skip)
13312 "Call FUNC at each headline selected by MATCH in SCOPE.
13314 FUNC is a function or a lisp form. The function will be called without
13315 arguments, with the cursor positioned at the beginning of the headline.
13316 The return values of all calls to the function will be collected and
13317 returned as a list.
13319 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13320 does not need to preserve point. After evaluation, the cursor will be
13321 moved to the end of the line (presumably of the headline of the
13322 processed entry) and search continues from there. Under some
13323 circumstances, this may not produce the wanted results. For example,
13324 if you have removed (e.g. archived) the current (sub)tree it could
13325 mean that the next entry will be skipped entirely. In such cases, you
13326 can specify the position from where search should continue by making
13327 FUNC set the variable `org-map-continue-from' to the desired buffer
13328 position.
13330 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13331 Only headlines that are matched by this query will be considered during
13332 the iteration. When MATCH is nil or t, all headlines will be
13333 visited by the iteration.
13335 SCOPE determines the scope of this command. It can be any of:
13337 nil The current buffer, respecting the restriction if any
13338 tree The subtree started with the entry at point
13339 file The current buffer, without restriction
13340 file-with-archives
13341 The current buffer, and any archives associated with it
13342 agenda All agenda files
13343 agenda-with-archives
13344 All agenda files with any archive files associated with them
13345 \(file1 file2 ...)
13346 If this is a list, all files in the list will be scanned
13348 The remaining args are treated as settings for the skipping facilities of
13349 the scanner. The following items can be given here:
13351 archive skip trees with the archive tag.
13352 comment skip trees with the COMMENT keyword
13353 function or Emacs Lisp form:
13354 will be used as value for `org-agenda-skip-function', so whenever
13355 the function returns t, FUNC will not be called for that
13356 entry and search will continue from the point where the
13357 function leaves it.
13359 If your function needs to retrieve the tags including inherited tags
13360 at the *current* entry, you can use the value of the variable
13361 `org-scanner-tags' which will be much faster than getting the value
13362 with `org-get-tags-at'. If your function gets properties with
13363 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13364 to t around the call to `org-entry-properties' to get the same speedup.
13365 Note that if your function moves around to retrieve tags and properties at
13366 a *different* entry, you cannot use these techniques."
13367 (let* ((org-agenda-archives-mode nil) ; just to make sure
13368 (org-agenda-skip-archived-trees (memq 'archive skip))
13369 (org-agenda-skip-comment-trees (memq 'comment skip))
13370 (org-agenda-skip-function
13371 (car (org-delete-all '(comment archive) skip)))
13372 (org-tags-match-list-sublevels t)
13373 matcher file res
13374 org-todo-keywords-for-agenda
13375 org-done-keywords-for-agenda
13376 org-todo-keyword-alist-for-agenda
13377 org-drawers-for-agenda
13378 org-tag-alist-for-agenda)
13380 (cond
13381 ((eq match t) (setq matcher t))
13382 ((eq match nil) (setq matcher t))
13383 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13385 (save-excursion
13386 (save-restriction
13387 (when (eq scope 'tree)
13388 (org-back-to-heading t)
13389 (org-narrow-to-subtree)
13390 (setq scope nil))
13392 (if (not scope)
13393 (progn
13394 (org-prepare-agenda-buffers
13395 (list (buffer-file-name (current-buffer))))
13396 (setq res (org-scan-tags func matcher)))
13397 ;; Get the right scope
13398 (cond
13399 ((and scope (listp scope) (symbolp (car scope)))
13400 (setq scope (eval scope)))
13401 ((eq scope 'agenda)
13402 (setq scope (org-agenda-files t)))
13403 ((eq scope 'agenda-with-archives)
13404 (setq scope (org-agenda-files t))
13405 (setq scope (org-add-archive-files scope)))
13406 ((eq scope 'file)
13407 (setq scope (list (buffer-file-name))))
13408 ((eq scope 'file-with-archives)
13409 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13410 (org-prepare-agenda-buffers scope)
13411 (while (setq file (pop scope))
13412 (with-current-buffer (org-find-base-buffer-visiting file)
13413 (save-excursion
13414 (save-restriction
13415 (widen)
13416 (goto-char (point-min))
13417 (setq res (append res (org-scan-tags func matcher))))))))))
13418 res))
13420 ;;;; Properties
13422 ;;; Setting and retrieving properties
13424 (defconst org-special-properties
13425 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13426 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13427 "The special properties valid in Org-mode.
13429 These are properties that are not defined in the property drawer,
13430 but in some other way.")
13432 (defconst org-default-properties
13433 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13434 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13435 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13436 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13437 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13438 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13439 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13440 "Some properties that are used by Org-mode for various purposes.
13441 Being in this list makes sure that they are offered for completion.")
13444 "Regular expression matching the first line of a property drawer.")
13447 "Regular expression matching the last line of a property drawer.")
13450 "Regular expression matching the first line of a property drawer.")
13453 "Regular expression matching the first line of a property drawer.")
13455 (defconst org-property-drawer-re
13458 "Matches an entire property drawer.")
13460 (defconst org-clock-drawer-re
13463 "Matches an entire clock drawer.")
13465 (defun org-property-action ()
13466 "Do an action on properties."
13467 (interactive)
13468 (let (c)
13469 (org-at-property-p)
13470 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13471 (setq c (read-char-exclusive))
13472 (cond
13473 ((equal c ?s)
13474 (call-interactively 'org-set-property))
13475 ((equal c ?d)
13476 (call-interactively 'org-delete-property))
13477 ((equal c ?D)
13478 (call-interactively 'org-delete-property-globally))
13479 ((equal c ?c)
13480 (call-interactively 'org-compute-property-at-point))
13481 (t (error "No such property action %c" c)))))
13483 (defun org-set-effort (&optional value)
13484 "Set the effort property of the current entry.
13485 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13486 allowed value."
13487 (interactive "P")
13488 (if (equal value 0) (setq value 10))
13489 (let* ((completion-ignore-case t)
13490 (prop org-effort-property)
13491 (cur (org-entry-get nil prop))
13492 (allowed (org-property-get-allowed-values nil prop 'table))
13493 (existing (mapcar 'list (org-property-values prop)))
13494 rpl
13495 (val (cond
13496 ((stringp value) value)
13497 ((and allowed (integerp value))
13498 (or (car (nth (1- value) allowed))
13499 (car (org-last allowed))))
13500 (allowed
13501 (message "Select 1-9,0, [RET%s]: %s"
13502 (if cur (concat "=" cur) "")
13503 (mapconcat 'car allowed " "))
13504 (setq rpl (read-char-exclusive))
13506 cur
13507 (setq rpl (- rpl ?0))
13508 (if (equal rpl 0) (setq rpl 10))
13509 (if (and (> rpl 0) (<= rpl (length allowed)))
13510 (car (nth (1- rpl) allowed))
13511 (org-completing-read "Effort: " allowed nil))))
13512 (t
13513 (let (org-completion-use-ido org-completion-use-iswitchb)
13514 (org-completing-read
13516 (concat "[" cur "]") "")
13517 ": ")
13518 existing nil nil "" nil cur))))))
13519 (unless (equal (org-entry-get nil prop) val)
13520 (org-entry-put nil prop val))
13521 (message "%s is now %s" prop val)))
13523 (defun org-at-property-p ()
13524 "Is cursor inside a property drawer?"
13525 (save-excursion
13526 (beginning-of-line 1)
13528 (save-match-data ;; Used by calling procedures
13529 (let ((p (point))
13530 (range (unless (org-before-first-heading-p)
13531 (org-get-property-block))))
13532 (and range (<= (car range) p) (< p (cdr range))))))))
13534 (defun org-get-property-block (&optional beg end force)
13535 "Return the (beg . end) range of the body of the property drawer.
13536 BEG and END can be beginning and end of subtree, if not given
13537 they will be found.
13538 If the drawer does not exist and FORCE is non-nil, create the drawer."
13539 (catch 'exit
13540 (save-excursion
13541 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13542 (end (or end (progn (outline-next-heading) (point)))))
13543 (goto-char beg)
13544 (if (re-search-forward org-property-start-re end t)
13545 (setq beg (1+ (match-end 0)))
13546 (if force
13547 (save-excursion
13548 (org-insert-property-drawer)
13549 (setq end (progn (outline-next-heading) (point))))
13550 (throw 'exit nil))
13551 (goto-char beg)
13552 (if (re-search-forward org-property-start-re end t)
13553 (setq beg (1+ (match-end 0)))))
13554 (if (re-search-forward org-property-end-re end t)
13555 (setq end (match-beginning 0))
13556 (or force (throw 'exit nil))
13557 (goto-char beg)
13558 (setq end beg)
13559 (org-indent-line-function)
13561 (cons beg end)))))
13563 (defun org-entry-properties (&optional pom which specific)
13564 "Get all properties of the entry at point-or-marker POM.
13565 This includes the TODO keyword, the tags, time strings for deadline,
13566 scheduled, and clocking, and any additional properties defined in the
13567 entry. The return value is an alist, keys may occur multiple times
13568 if the property key was used several times.
13569 POM may also be nil, in which case the current entry is used.
13570 If WHICH is nil or `all', get all properties. If WHICH is
13571 `special' or `standard', only get that subclass. If WHICH
13572 is a string only get exactly this property. SPECIFIC can be a string, the
13573 specific property we are interested in. Specifying it can speed
13574 things up because then unnecessary parsing is avoided."
13575 (setq which (or which 'all))
13576 (org-with-point-at pom
13577 (let ((clockstr (substring org-clock-string 0 -1))
13578 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13579 (case-fold-search nil)
13580 beg end range props sum-props key key1 value string clocksum)
13581 (save-excursion
13582 (when (condition-case nil
13583 (and (org-mode-p) (org-back-to-heading t))
13584 (error nil))
13585 (setq beg (point))
13586 (setq sum-props (get-text-property (point) 'org-summaries))
13587 (setq clocksum (get-text-property (point) :org-clock-minutes))
13588 (outline-next-heading)
13589 (setq end (point))
13590 (when (memq which '(all special))
13591 ;; Get the special properties, like TODO and tags
13592 (goto-char beg)
13593 (when (and (or (not specific) (string= specific "TODO"))
13594 (looking-at org-todo-line-regexp) (match-end 2))
13595 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13596 (when (and (or (not specific) (string= specific "PRIORITY"))
13597 (looking-at org-priority-regexp))
13598 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13599 (when (or (not specific) (string= specific "FILE"))
13600 (push (cons "FILE" buffer-file-name) props))
13601 (when (and (or (not specific) (string= specific "TAGS"))
13602 (setq value (org-get-tags-string))
13604 (push (cons "TAGS" value) props))
13605 (when (and (or (not specific) (string= specific "ALLTAGS"))
13606 (setq value (org-get-tags-at)))
13607 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13608 ":"))
13609 props))
13610 (when (or (not specific) (string= specific "BLOCKED"))
13611 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13612 (when (or (not specific)
13613 (member specific
13614 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13615 "TIMESTAMP" "TIMESTAMP_IA")))
13616 (catch 'match
13617 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13618 (setq key (if (match-end 1)
13619 (substring (org-match-string-no-properties 1)
13620 0 -1))
13621 string (if (equal key clockstr)
13622 (org-no-properties
13623 (org-trim
13624 (buffer-substring
13625 (match-beginning 3) (goto-char
13626 (point-at-eol)))))
13627 (substring (org-match-string-no-properties 3)
13628 1 -1)))
13629 ;; Get the correct property name from the key. This is
13630 ;; necessary if the user has configured time keywords.
13631 (setq key1 (concat key ":"))
13632 (cond
13633 ((not key)
13634 (setq key
13635 (if (= (char-after (match-beginning 3)) ?\[)
13636 "TIMESTAMP_IA" "TIMESTAMP")))
13637 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13638 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13639 ((equal key1 org-closed-string) (setq key "CLOSED"))
13640 ((equal key1 org-clock-string) (setq key "CLOCK")))
13641 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13642 (progn
13643 (push (cons key string) props)
13644 ;; no need to search further if match is found
13645 (throw 'match t))
13646 (when (or (equal key "CLOCK") (not (assoc key props)))
13647 (push (cons key string) props))))))
13648 )
13650 (when (memq which '(all standard))
13651 ;; Get the standard properties, like :PROP: ...
13652 (setq range (org-get-property-block beg end))
13653 (when range
13654 (goto-char (car range))
13655 (while (re-search-forward
13657 (cdr range) t)
13658 (setq key (org-match-string-no-properties 1)
13659 value (org-trim (or (org-match-string-no-properties 2) "")))
13660 (unless (member key excluded)
13661 (push (cons key (or value "")) props)))))
13662 (if clocksum
13663 (push (cons "CLOCKSUM"
13664 (org-columns-number-to-string (/ (float clocksum) 60.)
13665 'add_times))
13666 props))
13667 (unless (assoc "CATEGORY" props)
13668 (push (cons "CATEGORY" (org-get-category)) props))
13669 (append sum-props (nreverse props)))))))
13671 (defun org-entry-get (pom property &optional inherit literal-nil)
13672 "Get value of PROPERTY for entry at point-or-marker POM.
13673 If INHERIT is non-nil and the entry does not have the property,
13674 then also check higher levels of the hierarchy.
13675 If INHERIT is the symbol `selective', use inheritance only if the setting
13676 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13677 If the property is present but empty, the return value is the empty string.
13678 If the property is not present at all, nil is returned.
13681 do not interpret it as the list atom nil. This is used for inheritance
13683 (org-with-point-at pom
13684 (if (and inherit (if (eq inherit 'selective)
13685 (org-property-inherit-p property)
13686 t))
13687 (org-entry-get-with-inheritance property literal-nil)
13688 (if (member property org-special-properties)
13689 ;; We need a special property. Use `org-entry-properties' to
13690 ;; retrieve it, but specify the wanted property
13691 (cdr (assoc property (org-entry-properties nil 'special property)))
13692 (let ((range (unless (org-before-first-heading-p)
13693 (org-get-property-block))))
13694 (if (and range
13695 (goto-char (car range))
13696 (re-search-forward
13698 (cdr range) t))
13699 ;; Found the property, return it.
13700 (if (match-end 1)
13701 (if literal-nil
13702 (org-match-string-no-properties 1)
13703 (org-not-nil (org-match-string-no-properties 1)))
13704 "")))))))
13706 (defun org-property-or-variable-value (var &optional inherit)
13707 "Check if there is a property fixing the value of VAR.
13708 If yes, return this value. If not, return the current value of the variable."
13709 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13711 (read prop)
13712 (symbol-value var))))
13714 (defun org-entry-delete (pom property)
13715 "Delete the property PROPERTY from entry at point-or-marker POM."
13716 (org-with-point-at pom
13717 (if (member property org-special-properties)
13718 nil ; cannot delete these properties.
13719 (let ((range (org-get-property-block)))
13720 (if (and range
13721 (goto-char (car range))
13722 (re-search-forward
13724 (cdr range) t))
13725 (progn
13726 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13727 t)
13728 nil)))))
13730 ;; Multi-values properties are properties that contain multiple values
13731 ;; These values are assumed to be single words, separated by whitespace.
13732 (defun org-entry-add-to-multivalued-property (pom property value)
13733 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13734 (let* ((old (org-entry-get pom property))
13736 (setq value (org-entry-protect-space value))
13737 (unless (member value values)
13738 (setq values (cons value values))
13739 (org-entry-put pom property
13740 (mapconcat 'identity values " ")))))
13742 (defun org-entry-remove-from-multivalued-property (pom property value)
13743 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13744 (let* ((old (org-entry-get pom property))
13746 (setq value (org-entry-protect-space value))
13747 (when (member value values)
13748 (setq values (delete value values))
13749 (org-entry-put pom property
13750 (mapconcat 'identity values " ")))))
13752 (defun org-entry-member-in-multivalued-property (pom property value)
13753 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13754 (let* ((old (org-entry-get pom property))
13756 (setq value (org-entry-protect-space value))
13757 (member value values)))
13759 (defun org-entry-get-multivalued-property (pom property)
13760 "Return a list of values in a multivalued property."
13761 (let* ((value (org-entry-get pom property))
13763 (mapcar 'org-entry-restore-space values)))
13765 (defun org-entry-put-multivalued-property (pom property &rest values)
13766 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13767 VALUES should be a list of strings. Spaces will be protected."
13768 (org-entry-put pom property
13769 (mapconcat 'org-entry-protect-space values " "))
13770 (let* ((value (org-entry-get pom property))
13772 (mapcar 'org-entry-restore-space values)))
13774 (defun org-entry-protect-space (s)
13775 "Protect spaces and newline in string S."
13776 (while (string-match " " s)
13777 (setq s (replace-match "%20" t t s)))
13779 (setq s (replace-match "%0A" t t s)))
13780 s)
13782 (defun org-entry-restore-space (s)
13783 "Restore spaces and newline in string S."
13784 (while (string-match "%20" s)
13785 (setq s (replace-match " " t t s)))
13786 (while (string-match "%0A" s)
13788 s)
13790 (defvar org-entry-property-inherited-from (make-marker)
13791 "Marker pointing to the entry from where a property was inherited.
13792 Each call to `org-entry-get-with-inheritance' will set this marker to the
13793 location of the entry where the inheritance search matched. If there was
13794 no match, the marker will point nowhere.
13795 Note that also `org-entry-get' calls this function, if the INHERIT flag
13796 is set.")
13798 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13799 "Get entry property, and search higher levels if not present.
13800 The search will stop at the first ancestor which has the property defined.
13802 should be considered as undefined (this is the meaning of nil here).
13804 (move-marker org-entry-property-inherited-from nil)
13805 (let (tmp)
13806 (unless (org-before-first-heading-p)
13807 (save-excursion
13808 (save-restriction
13809 (widen)
13810 (catch 'ex
13811 (while t
13812 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13813 (org-back-to-heading t)
13814 (move-marker org-entry-property-inherited-from (point))
13815 (throw 'ex tmp))
13816 (or (org-up-heading-safe) (throw 'ex nil)))))))
13817 (setq tmp (or tmp
13818 (cdr (assoc property org-file-properties))
13819 (cdr (assoc property org-global-properties))
13820 (cdr (assoc property org-global-properties-fixed))))
13821 (if literal-nil tmp (org-not-nil tmp))))
13823 (defvar org-property-changed-functions nil
13824 "Hook called when the value of a property has changed.
13825 Each hook function should accept two arguments, the name of the property
13826 and the new value.")
13828 (defun org-entry-put (pom property value)
13829 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13830 (org-with-point-at pom
13831 (org-back-to-heading t)
13832 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13833 range)
13834 (cond
13835 ((equal property "TODO")
13837 (not (member value org-todo-keywords-1)))
13839 (if (or (not value)
13841 (setq value 'none))
13842 (org-todo value)
13843 (org-set-tags nil 'align))
13844 ((equal property "PRIORITY")
13846 (string-to-char value) ?\ ))
13847 (org-set-tags nil 'align))
13848 ((equal property "SCHEDULED")
13849 (if (re-search-forward org-scheduled-time-regexp end t)
13850 (cond
13851 ((eq value 'earlier) (org-timestamp-change -1 'day))
13852 ((eq value 'later) (org-timestamp-change 1 'day))
13853 (t (call-interactively 'org-schedule)))
13854 (call-interactively 'org-schedule)))
13855 ((equal property "DEADLINE")
13856 (if (re-search-forward org-deadline-time-regexp end t)
13857 (cond
13858 ((eq value 'earlier) (org-timestamp-change -1 'day))
13859 ((eq value 'later) (org-timestamp-change 1 'day))
13860 (t (call-interactively 'org-deadline)))
13861 (call-interactively 'org-deadline)))
13862 ((member property org-special-properties)
13863 (error "The %s property can not yet be set with `org-entry-put'"
13864 property))
13865 (t ; a non-special property
13866 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13867 (setq range (org-get-property-block beg end 'force))
13868 (goto-char (car range))
13869 (if (re-search-forward
13871 (progn
13872 (delete-region (match-beginning 1) (match-end 1))
13873 (goto-char (match-beginning 1)))
13874 (goto-char (cdr range))
13876 (backward-char 1)
13877 (org-indent-line-function)
13878 (insert ":" property ":"))
13879 (and value (insert " " value))
13880 (org-indent-line-function)))))
13881 (run-hook-with-args 'org-property-changed-functions property value)))
13883 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13884 "Get all property keys in the current buffer.
13885 With INCLUDE-SPECIALS, also list the special properties that reflect things
13886 like tags and TODO state.
13887 With INCLUDE-DEFAULTS, also include properties that has special meaning
13888 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
13889 and others.
13890 With INCLUDE-COLUMNS, also include property names given in COLUMN
13891 formats in the current buffer."
13892 (let (rtn range cfmt s p)
13893 (save-excursion
13894 (save-restriction
13895 (widen)
13896 (goto-char (point-min))
13897 (while (re-search-forward org-property-start-re nil t)
13898 (setq range (org-get-property-block))
13899 (goto-char (car range))
13900 (while (re-search-forward
13902 (cdr range) t)
13903 (add-to-list 'rtn (org-match-string-no-properties 1)))
13904 (outline-next-heading))))
13906 (when include-specials
13907 (setq rtn (append org-special-properties rtn)))
13909 (when include-defaults
13910 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13911 (add-to-list 'rtn org-effort-property))
13913 (when include-columns
13914 (save-excursion
13915 (save-restriction
13916 (widen)
13917 (goto-char (point-min))
13918 (while (re-search-forward
13920 nil t)
13921 (setq cfmt (match-string 2) s 0)
13923 cfmt s)
13924 (setq s (match-end 0)
13925 p (match-string 1 cfmt))
13926 (unless (or (equal p "ITEM")
13927 (member p org-special-properties))
13928 (add-to-list 'rtn (match-string 1 cfmt))))))))
13930 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13932 (defun org-property-values (key)
13933 "Return a list of all values of property KEY."
13934 (save-excursion
13935 (save-restriction
13936 (widen)
13937 (goto-char (point-min))
13939 values)
13940 (while (re-search-forward re nil t)
13941 (add-to-list 'values (org-trim (match-string 1))))
13942 (delete "" values)))))
13944 (defun org-insert-property-drawer ()
13945 "Insert a property drawer into the current entry."
13946 (interactive)
13947 (org-back-to-heading t)
13948 (looking-at outline-regexp)
13949 (let ((indent (if org-adapt-indentation
13950 (- (match-end 0)(match-beginning 0))
13951 0))
13952 (beg (point))
13954 end hiddenp)
13955 (outline-next-heading)
13956 (setq end (point))
13957 (goto-char beg)
13958 (while (re-search-forward re end t))
13959 (setq hiddenp (outline-invisible-p))
13960 (end-of-line 1)
13963 (if (member (match-string 1) '("CLOCK:" ":END:"))
13964 ;; just skip this line
13965 (beginning-of-line 2)
13966 ;; Drawer start, find the end
13968 (beginning-of-line 1)))
13969 (org-skip-over-state-notes)
13971 (if (eq (char-before) ?*) (forward-char 1))
13973 (beginning-of-line 0)
13974 (org-indent-to-column indent)
13975 (beginning-of-line 2)
13976 (org-indent-to-column indent)
13977 (beginning-of-line 0)
13978 (if hiddenp
13979 (save-excursion
13980 (org-back-to-heading t)
13981 (hide-entry))
13982 (org-flag-drawer t))))
13984 (defvar org-property-set-functions-alist nil
13985 "Property set function alist.
13986 Each entry should have the following format:
13988 (PROPERTY . READ-FUNCTION)
13990 The read function will be called with the same argument as
13991 `org-completing-read'.")
13993 (defun org-set-property-function (property)
13994 "Get the function that should be used to set PROPERTY.
13995 This is computed according to `org-property-set-functions-alist'."
13996 (or (cdr (assoc property org-property-set-functions-alist))
13997 'org-completing-read))
13999 (defun org-read-property-value (property)
14000 "Read PROPERTY value from user."
14001 (let* ((completion-ignore-case t)
14002 (allowed (org-property-get-allowed-values nil property 'table))
14003 (cur (org-entry-get nil property))
14004 (prompt (concat property " value"
14006 (concat " [" cur "]") "") ": "))
14007 (set-function (org-set-property-function property))
14008 (val (if allowed
14009 (funcall set-function prompt allowed nil
14010 (not (get-text-property 0 'org-unrestricted
14011 (caar allowed))))
14012 (let (org-completion-use-ido org-completion-use-iswitchb)
14013 (funcall set-function prompt
14014 (mapcar 'list (org-property-values property))
14015 nil nil "" nil cur)))))
14016 (if (equal val "")
14017 cur
14018 val)))
14020 (defun org-read-property-name ()
14021 "Read a property name."
14022 (let* ((completion-ignore-case t)
14023 (keys (org-buffer-property-keys nil t t))
14024 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
14025 (if (member property keys)
14026 property
14027 (or (cdr (assoc (downcase property)
14028 (mapcar (lambda (x) (cons (downcase x) x))
14029 keys)))
14030 property))))
14032 (defun org-set-property (property value)
14033 "In the current entry, set PROPERTY to VALUE.
14034 When called interactively, this will prompt for a property name, offering
14035 completion on existing and default properties. And then it will prompt
14036 for a value, offering completion either on allowed values (via an inherited
14037 xxx_ALL property) or on existing values in other instances of this property
14038 in the current file."
14039 (interactive (list nil nil))
14040 (let* ((property (or property (org-read-property-name)))
14041 (value (or value (org-read-property-value property))))
14042 (unless (equal (org-entry-get nil property) value)
14043 (org-entry-put nil property value))))
14045 (defun org-delete-property (property)
14046 "In the current entry, delete PROPERTY."
14047 (interactive
14048 (let* ((completion-ignore-case t)
14049 (prop (org-icompleting-read "Property: "
14050 (org-entry-properties nil 'standard))))
14051 (list prop)))
14052 (message "Property %s %s" property
14053 (if (org-entry-delete nil property)
14054 "deleted"
14055 "was not present in the entry")))
14057 (defun org-delete-property-globally (property)
14058 "Remove PROPERTY globally, from all entries."
14059 (interactive
14060 (let* ((completion-ignore-case t)
14061 (prop (org-icompleting-read
14062 "Globally remove property: "
14063 (mapcar 'list (org-buffer-property-keys)))))
14064 (list prop)))
14065 (save-excursion
14066 (save-restriction
14067 (widen)
14068 (goto-char (point-min))
14069 (let ((cnt 0))
14070 (while (re-search-forward
14072 nil t)
14073 (setq cnt (1+ cnt))
14074 (replace-match ""))
14077 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14079 (defun org-compute-property-at-point ()
14080 "Compute the property at point.
14081 This looks for an enclosing column format, extracts the operator and
14082 then applies it to the property in the column format's scope."
14083 (interactive)
14084 (unless (org-at-property-p)
14085 (error "Not at a property"))
14086 (let ((prop (org-match-string-no-properties 2)))
14087 (org-columns-get-format-and-top-level)
14088 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14089 (error "No operator defined for property %s" prop))
14090 (org-columns-compute prop)))
14092 (defvar org-property-allowed-value-functions nil
14093 "Hook for functions supplying allowed values for a specific property.
14094 The functions must take a single argument, the name of the property, and
14096 the values, this means that these values are intended as defaults for
14097 completion, but that other values should be allowed too.
14098 The functions must return nil if they are not responsible for this
14099 property.")
14101 (defun org-property-get-allowed-values (pom property &optional table)
14102 "Get allowed values for the property PROPERTY.
14103 When TABLE is non-nil, return an alist that can directly be used for
14104 completion."
14105 (let (vals)
14106 (cond
14107 ((equal property "TODO")
14108 (setq vals (org-with-point-at pom
14109 (append org-todo-keywords-1 '("")))))
14110 ((equal property "PRIORITY")
14111 (let ((n org-lowest-priority))
14112 (while (>= n org-highest-priority)
14113 (push (char-to-string n) vals)
14114 (setq n (1- n)))))
14115 ((member property org-special-properties))
14116 ((setq vals (run-hook-with-args-until-success
14117 'org-property-allowed-value-functions property)))
14118 (t
14119 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14121 (setq vals (car (read-from-string (concat "(" vals ")"))))
14122 (setq vals (mapcar (lambda (x)
14123 (cond ((stringp x) x)
14124 ((numberp x) (number-to-string x))
14125 ((symbolp x) (symbol-name x))
14126 (t "???")))
14127 vals)))))
14128 (when (member ":ETC" vals)
14129 (setq vals (remove ":ETC" vals))
14130 (org-add-props (car vals) '(org-unrestricted t)))
14131 (if table (mapcar 'list vals) vals)))
14133 (defun org-property-previous-allowed-value (&optional previous)
14134 "Switch to the next allowed value for this property."
14135 (interactive)
14136 (org-property-next-allowed-value t))
14138 (defun org-property-next-allowed-value (&optional previous)
14139 "Switch to the next allowed value for this property."
14140 (interactive)
14141 (unless (org-at-property-p)
14142 (error "Not at a property"))
14143 (let* ((key (match-string 2))
14144 (value (match-string 3))
14145 (allowed (or (org-property-get-allowed-values (point) key)
14146 (and (member value '("[ ]" "[-]" "[X]"))
14147 '("[ ]" "[X]"))))
14148 nval)
14149 (unless allowed
14150 (error "Allowed values for this property have not been defined"))
14151 (if previous (setq allowed (reverse allowed)))
14152 (if (member value allowed)
14153 (setq nval (car (cdr (member value allowed)))))
14154 (setq nval (or nval (car allowed)))
14155 (if (equal nval value)
14156 (error "Only one allowed value for this property"))
14157 (org-at-property-p)
14158 (replace-match (concat " :" key ": " nval) t t)
14159 (org-indent-line-function)
14160 (beginning-of-line 1)
14162 (run-hook-with-args 'org-property-changed-functions key nval)))
14164 (defun org-find-olp (path &optional this-buffer)
14165 "Return a marker pointing to the entry at outline path OLP.
14166 If anything goes wrong, throw an error.
14167 You can wrap this call to catch the error like this:
14169 (condition-case msg
14170 (org-mobile-locate-entry (match-string 4))
14171 (error (nth 1 msg)))
14173 The return value will then be either a string with the error message,
14174 or a marker if everything is OK.
14176 If THIS-BUFFER is set, the outline path does not contain a file,
14177 only headings."
14178 (let* ((file (if this-buffer buffer-file-name (pop path)))
14179 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14180 (level 1)
14181 (lmin 1)
14182 (lmax 1)
14183 limit re end found pos heading cnt)
14184 (unless buffer (error "File not found :%s" file))
14185 (with-current-buffer buffer
14186 (save-excursion
14187 (save-restriction
14188 (widen)
14189 (setq limit (point-max))
14190 (goto-char (point-min))
14191 (while (setq heading (pop path))
14192 (setq re (format org-complex-heading-regexp-format
14193 (regexp-quote heading)))
14194 (setq cnt 0 pos (point))
14195 (while (re-search-forward re end t)
14196 (setq level (- (match-end 1) (match-beginning 1)))
14197 (if (and (>= level lmin) (<= level lmax))
14198 (setq found (match-beginning 0) cnt (1+ cnt))))
14199 (when (= cnt 0) (error "Heading not found on level %d: %s"
14200 lmax heading))
14201 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14202 lmax heading))
14203 (goto-char found)
14204 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14205 (setq end (save-excursion (org-end-of-subtree t t))))
14206 (when (org-on-heading-p)
14207 (move-marker (make-marker) (point))))))))
14209 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14210 "Find node HEADING in BUFFER.
14211 Return a marker to the heading if it was found, or nil if not.
14212 If POS-ONLY is set, return just the position instead of a marker.
14214 The heading text must match exact, but it may have a TODO keyword,
14215 a priority cookie and tags in the standard locations."
14216 (with-current-buffer (or buffer (current-buffer))
14217 (save-excursion
14218 (save-restriction
14219 (widen)
14220 (goto-char (point-min))
14221 (let (case-fold-search)
14222 (if (re-search-forward
14223 (format org-complex-heading-regexp-format
14224 (regexp-quote heading)) nil t)
14225 (if pos-only
14226 (match-beginning 0)
14227 (move-marker (make-marker) (match-beginning 0)))))))))
14229 (defun org-find-exact-heading-in-directory (heading &optional dir)
14230 "Find Org node headline HEADING in all .org files in directory DIR.
14231 When the target headline is found, return a marker to this location."
14232 (let ((files (directory-files (or dir default-directory)
14234 file visiting m buffer)
14235 (catch 'found
14236 (while (setq file (pop files))
14237 (message "trying %s" file)
14238 (setq visiting (org-find-base-buffer-visiting file))
14239 (setq buffer (or visiting (find-file-noselect file)))
14240 (setq m (org-find-exact-headline-in-buffer
14241 heading buffer))
14242 (when (and (not m) (not visiting)) (kill-buffer buffer))
14243 (and m (throw 'found m))))))
14245 (defun org-find-entry-with-id (ident)
14246 "Locate the entry that contains the ID property with exact value IDENT.
14247 IDENT can be a string, a symbol or a number, this function will search for
14248 the string representation of it.
14249 Return the position where this entry starts, or nil if there is no such entry."
14250 (interactive "sID: ")
14251 (let ((id (cond
14252 ((stringp ident) ident)
14253 ((symbol-name ident) (symbol-name ident))
14254 ((numberp ident) (number-to-string ident))
14255 (t (error "IDENT %s must be a string, symbol or number" ident))))
14256 (case-fold-search nil))
14257 (save-excursion
14258 (save-restriction
14259 (widen)
14260 (goto-char (point-min))
14261 (when (re-search-forward
14263 nil t)
14264 (org-back-to-heading t)
14265 (point))))))
14267 ;;;; Timestamps
14269 (defvar org-last-changed-timestamp nil)
14270 (defvar org-last-inserted-timestamp nil
14271 "The last time stamp inserted with `org-insert-time-stamp'.")
14272 (defvar org-time-was-given) ; dynamically scoped parameter
14273 (defvar org-end-time-was-given) ; dynamically scoped parameter
14274 (defvar org-ts-what) ; dynamically scoped parameter
14276 (defun org-time-stamp (arg &optional inactive)
14277 "Prompt for a date/time and insert a time stamp.
14278 If the user specifies a time like HH:MM, or if this command is called
14279 with a prefix argument, the time stamp will contain date and time.
14280 Otherwise, only the date will be included. All parts of a date not
14281 specified by the user will be filled in from the current date/time.
14282 So if you press just return without typing anything, the time stamp
14283 will represent the current date/time. If there is already a timestamp
14284 at the cursor, it will be modified."
14285 (interactive "P")
14286 (let* ((ts nil)
14287 (default-time
14288 ;; Default time is either today, or, when entering a range,
14289 ;; the range start.
14290 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14291 (save-excursion
14292 (re-search-backward
14294 (- (point) 20) t)))
14295 (apply 'encode-time (org-parse-time-string (match-string 1)))
14296 (current-time)))
14297 (default-input (and ts (org-get-compact-tod ts)))
14298 org-time-was-given org-end-time-was-given time)
14299 (cond
14300 ((and (org-at-timestamp-p t)
14301 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14302 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14303 (insert "--")
14304 (setq time (let ((this-command this-command))
14305 (org-read-date arg 'totime nil nil
14306 default-time default-input)))
14307 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14308 ((org-at-timestamp-p t)
14309 (setq time (let ((this-command this-command))
14310 (org-read-date arg 'totime nil nil default-time default-input)))
14311 (when (org-at-timestamp-p t) ; just to get the match data
14312 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14313 (replace-match "")
14314 (setq org-last-changed-timestamp
14315 (org-insert-time-stamp
14316 time (or org-time-was-given arg)
14317 inactive nil nil (list org-end-time-was-given))))
14318 (message "Timestamp updated"))
14319 (t
14320 (setq time (let ((this-command this-command))
14321 (org-read-date arg 'totime nil nil default-time default-input)))
14322 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14323 nil nil (list org-end-time-was-given))))))
14325 ;; FIXME: can we use this for something else, like computing time differences?
14326 (defun org-get-compact-tod (s)
14327 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14328 (let* ((t1 (match-string 1 s))
14329 (h1 (string-to-number (match-string 2 s)))
14330 (m1 (string-to-number (match-string 3 s)))
14331 (t2 (and (match-end 4) (match-string 5 s)))
14332 (h2 (and t2 (string-to-number (match-string 6 s))))
14333 (m2 (and t2 (string-to-number (match-string 7 s))))
14334 dh dm)
14335 (if (not t2)
14336 t1
14337 (setq dh (- h2 h1) dm (- m2 m1))
14338 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14339 (concat t1 "+" (number-to-string dh)
14340 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14342 (defun org-time-stamp-inactive (&optional arg)
14343 "Insert an inactive time stamp.
14344 An inactive time stamp is enclosed in square brackets instead of angle
14345 brackets. It is inactive in the sense that it does not trigger agenda entries,
14346 does not link to the calendar and cannot be changed with the S-cursor keys.
14347 So these are more for recording a certain time/date."
14348 (interactive "P")
14349 (org-time-stamp arg 'inactive))
14351 (defvar org-date-ovl (make-overlay 1 1))
14352 (overlay-put org-date-ovl 'face 'org-warning)
14353 (org-detach-overlay org-date-ovl)
14355 (defvar org-ans1) ; dynamically scoped parameter
14356 (defvar org-ans2) ; dynamically scoped parameter
14358 (defvar org-plain-time-of-day-regexp) ; defined below
14360 (defvar org-overriding-default-time nil) ; dynamically scoped
14361 (defvar org-read-date-overlay nil)
14362 (defvar org-dcst nil) ; dynamically scoped
14363 (defvar org-read-date-history nil)
14364 (defvar org-read-date-final-answer nil)
14365 (defvar org-read-date-analyze-futurep nil)
14366 (defvar org-read-date-analyze-forced-year nil)
14368 (defun org-read-date (&optional with-time to-time from-string prompt
14369 default-time default-input)
14370 "Read a date, possibly a time, and make things smooth for the user.
14371 The prompt will suggest to enter an ISO date, but you can also enter anything
14372 which will at least partially be understood by `parse-time-string'.
14373 Unrecognized parts of the date will default to the current day, month, year,
14374 hour and minute. If this command is called to replace a timestamp at point,
14375 of to enter the second timestamp of a range, the default time is taken
14376 from the existing stamp. Furthermore, the command prefers the future,
14377 so if you are giving a date where the year is not given, and the day-month
14378 combination is already past in the current year, it will assume you
14379 mean next year. For details, see the manual. A few examples:
14381 3-2-5 --> 2003-02-05
14382 feb 15 --> currentyear-02-15
14383 2/15 --> currentyear-02-15
14384 sep 12 9 --> 2009-09-12
14385 12:45 --> today 12:45
14386 22 sept 0:34 --> currentyear-09-22 0:34
14387 12 --> currentyear-currentmonth-12
14388 Fri --> nearest Friday (today or later)
14389 etc.
14391 Furthermore you can specify a relative date by giving, as the *first* thing
14392 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14393 change in days weeks, months, years.
14394 With a single plus or minus, the date is relative to today. With a double
14395 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14396 +4d --> four days from today
14397 +4 --> same as above
14398 +2w --> two weeks from today
14399 ++5 --> five days from default date
14401 The function understands only English month and weekday abbreviations,
14402 but this can be configured with the variables `parse-time-months' and
14403 `parse-time-weekdays'.
14405 While prompting, a calendar is popped up - you can also select the
14406 date with the mouse (button 1). The calendar shows a period of three
14407 months. To scroll it to other months, use the keys `>' and `<'.
14408 If you don't like the calendar, turn it off with
14409 \(setq org-read-date-popup-calendar nil)
14411 With optional argument TO-TIME, the date will immediately be converted
14412 to an internal time.
14413 With an optional argument WITH-TIME, the prompt will suggest to also
14414 insert a time. Note that when WITH-TIME is not set, you can still
14415 enter a time, and this function will inform the calling routine about
14416 this change. The calling routine may then choose to change the format
14417 used to insert the time stamp into the buffer to include the time.
14418 With optional argument FROM-STRING, read from this string instead from
14419 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14420 the time/date that is used for everything that is not specified by the
14421 user."
14422 (require 'parse-time)
14423 (let* ((org-time-stamp-rounding-minutes
14424 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14425 (org-dcst org-display-custom-times)
14426 (ct (org-current-time))
14427 (def (or org-overriding-default-time default-time ct))
14428 (defdecode (decode-time def))
14429 (dummy (progn
14430 (when (< (nth 2 defdecode) org-extend-today-until)
14431 (setcar (nthcdr 2 defdecode) -1)
14432 (setcar (nthcdr 1 defdecode) 59)
14433 (setq def (apply 'encode-time defdecode)
14434 defdecode (decode-time def)))))
14435 (calendar-frame-setup nil)
14436 (calendar-setup nil)
14437 (calendar-move-hook nil)
14438 (calendar-view-diary-initially-flag nil)
14439 (calendar-view-holidays-initially-flag nil)
14440 (timestr (format-time-string
14441 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14442 (prompt (concat (if prompt (concat prompt " ") "")
14443 (format "Date+time [%s]: " timestr)))
14444 ans (org-ans0 "") org-ans1 org-ans2 final)
14446 (cond
14447 (from-string (setq ans from-string))
14448 (org-read-date-popup-calendar
14449 (save-excursion
14450 (save-window-excursion
14451 (calendar)
14452 (calendar-forward-day (- (time-to-days def)
14453 (calendar-absolute-from-gregorian
14454 (calendar-current-date))))
14455 (org-eval-in-calendar nil t)
14456 (let* ((old-map (current-local-map))
14457 (map (copy-keymap calendar-mode-map))
14458 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14459 (org-defkey map (kbd "RET") 'org-calendar-select)
14460 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14461 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14462 (org-defkey minibuffer-local-map [(meta shift left)]
14463 (lambda () (interactive)
14464 (org-eval-in-calendar '(calendar-backward-month 1))))
14465 (org-defkey minibuffer-local-map [(meta shift right)]
14466 (lambda () (interactive)
14467 (org-eval-in-calendar '(calendar-forward-month 1))))
14468 (org-defkey minibuffer-local-map [(meta shift up)]
14469 (lambda () (interactive)
14470 (org-eval-in-calendar '(calendar-backward-year 1))))
14471 (org-defkey minibuffer-local-map [(meta shift down)]
14472 (lambda () (interactive)
14473 (org-eval-in-calendar '(calendar-forward-year 1))))
14474 (org-defkey minibuffer-local-map [?\e (shift left)]
14475 (lambda () (interactive)
14476 (org-eval-in-calendar '(calendar-backward-month 1))))
14477 (org-defkey minibuffer-local-map [?\e (shift right)]
14478 (lambda () (interactive)
14479 (org-eval-in-calendar '(calendar-forward-month 1))))
14480 (org-defkey minibuffer-local-map [?\e (shift up)]
14481 (lambda () (interactive)
14482 (org-eval-in-calendar '(calendar-backward-year 1))))
14483 (org-defkey minibuffer-local-map [?\e (shift down)]
14484 (lambda () (interactive)
14485 (org-eval-in-calendar '(calendar-forward-year 1))))
14486 (org-defkey minibuffer-local-map [(shift up)]
14487 (lambda () (interactive)
14488 (org-eval-in-calendar '(calendar-backward-week 1))))
14489 (org-defkey minibuffer-local-map [(shift down)]
14490 (lambda () (interactive)
14491 (org-eval-in-calendar '(calendar-forward-week 1))))
14492 (org-defkey minibuffer-local-map [(shift left)]
14493 (lambda () (interactive)
14494 (org-eval-in-calendar '(calendar-backward-day 1))))
14495 (org-defkey minibuffer-local-map [(shift right)]
14496 (lambda () (interactive)
14497 (org-eval-in-calendar '(calendar-forward-day 1))))
14498 (org-defkey minibuffer-local-map ">"
14499 (lambda () (interactive)
14500 (org-eval-in-calendar '(scroll-calendar-left 1))))
14501 (org-defkey minibuffer-local-map "<"
14502 (lambda () (interactive)
14503 (org-eval-in-calendar '(scroll-calendar-right 1))))
14504 (org-defkey minibuffer-local-map "\C-v"
14505 (lambda () (interactive)
14506 (org-eval-in-calendar
14507 '(calendar-scroll-left-three-months 1))))
14508 (org-defkey minibuffer-local-map "\M-v"
14509 (lambda () (interactive)
14510 (org-eval-in-calendar
14511 '(calendar-scroll-right-three-months 1))))
14512 (run-hooks 'org-read-date-minibuffer-setup-hook)
14513 (unwind-protect
14514 (progn
14515 (use-local-map map)
14516 (add-hook 'post-command-hook 'org-read-date-display)
14517 (setq org-ans0 (read-string prompt default-input
14518 'org-read-date-history nil))
14519 ;; org-ans0: from prompt
14520 ;; org-ans1: from mouse click
14521 ;; org-ans2: from calendar motion
14522 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14523 (remove-hook 'post-command-hook 'org-read-date-display)
14524 (use-local-map old-map)
14525 (when org-read-date-overlay
14526 (delete-overlay org-read-date-overlay)
14527 (setq org-read-date-overlay nil)))))))
14529 (t ; Naked prompt only
14530 (unwind-protect
14531 (setq ans (read-string prompt default-input
14532 'org-read-date-history timestr))
14533 (when org-read-date-overlay
14534 (delete-overlay org-read-date-overlay)
14535 (setq org-read-date-overlay nil)))))
14537 (setq final (org-read-date-analyze ans def defdecode))
14539 (when org-read-date-analyze-forced-year
14540 (message "Year was forced into %s"
14541 (if org-read-date-force-compatible-dates
14542 "compatible range (1970-2037)"
14543 "range representable on this machine"))
14544 (ding))
14546 ;; One round trip to get rid of 34th of August and stuff like that....
14547 (setq final (decode-time (apply 'encode-time final)))
14549 (setq org-read-date-final-answer ans)
14551 (if to-time
14552 (apply 'encode-time final)
14553 (if (and (boundp 'org-time-was-given) org-time-was-given)
14554 (format "%04d-%02d-%02d %02d:%02d"
14555 (nth 5 final) (nth 4 final) (nth 3 final)
14556 (nth 2 final) (nth 1 final))
14557 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14559 (defvar def)
14560 (defvar defdecode)
14561 (defvar with-time)
14562 (defun org-read-date-display ()
14563 "Display the current date prompt interpretation in the minibuffer."
14564 (when org-read-date-display-live
14565 (when org-read-date-overlay
14566 (delete-overlay org-read-date-overlay))
14567 (let ((p (point)))
14568 (end-of-line 1)
14569 (while (not (equal (buffer-substring
14570 (max (point-min) (- (point) 4)) (point))
14571 " "))
14572 (insert " "))
14573 (goto-char p))
14574 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14575 " " (or org-ans1 org-ans2)))
14576 (org-end-time-was-given nil)
14577 (f (org-read-date-analyze ans def defdecode))
14578 (fmts (if org-dcst
14579 org-time-stamp-custom-formats
14580 org-time-stamp-formats))
14581 (fmt (if (or with-time
14582 (and (boundp 'org-time-was-given) org-time-was-given))
14583 (cdr fmts)
14584 (car fmts)))
14585 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14586 (when (and org-end-time-was-given
14587 (string-match org-plain-time-of-day-regexp txt))
14588 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14589 org-end-time-was-given
14590 (substring txt (match-end 0)))))
14591 (when org-read-date-analyze-futurep
14592 (setq txt (concat txt " (=>F)")))
14593 (setq org-read-date-overlay
14594 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14595 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14597 (defun org-read-date-analyze (ans def defdecode)
14598 "Analyze the combined answer of the date prompt."
14599 ;; FIXME: cleanup and comment
14600 (let ((nowdecode (decode-time (current-time)))
14601 delta deltan deltaw deltadef year month day
14602 hour minute second wday pm h2 m2 tl wday1
14603 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14604 (setq org-read-date-analyze-futurep nil
14605 org-read-date-analyze-forced-year nil)
14607 (setq ans "+0"))
14609 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14610 (setq ans (replace-match "" t t ans)
14611 deltan (car delta)
14612 deltaw (nth 1 delta)
14613 deltadef (nth 2 delta)))
14615 ;; Check if there is an iso week date in there
14616 ;; If yes, store the info and postpone interpreting it until the rest
14617 ;; of the parsing is done
14618 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14619 (setq iso-year (if (match-end 1)
14620 (org-small-year-to-year
14621 (string-to-number (match-string 1 ans))))
14622 iso-weekday (if (match-end 3)
14623 (string-to-number (match-string 3 ans)))
14624 iso-week (string-to-number (match-string 2 ans)))
14625 (setq ans (replace-match "" t t ans)))
14627 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14628 (when (string-match
14630 (setq year (if (match-end 2)
14631 (string-to-number (match-string 2 ans))
14632 (progn (setq kill-year t)
14633 (string-to-number (format-time-string "%Y"))))
14634 month (string-to-number (match-string 3 ans))
14635 day (string-to-number (match-string 4 ans)))
14636 (if (< year 100) (setq year (+ 2000 year)))
14638 t nil ans)))
14639 ;; Help matching american dates, like 5/30 or 5/30/7
14640 (when (string-match
14641 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14642 (setq year (if (match-end 4)
14643 (string-to-number (match-string 4 ans))
14644 (progn (setq kill-year t)
14645 (string-to-number (format-time-string "%Y"))))
14646 month (string-to-number (match-string 1 ans))
14647 day (string-to-number (match-string 2 ans)))
14648 (if (< year 100) (setq year (+ 2000 year)))
14650 t nil ans)))
14651 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14652 ;; If there is a time with am/pm, and *no* time without it, we convert
14653 ;; so that matching will be successful.
14654 (loop for i from 1 to 2 do ; twice, for end time as well
14657 (setq hour (string-to-number (match-string 1 ans))
14658 minute (if (match-end 3)
14659 (string-to-number (match-string 3 ans))
14660 0)
14661 pm (equal ?p
14662 (string-to-char (downcase (match-string 4 ans)))))
14663 (if (and (= hour 12) (not pm))
14664 (setq hour 0)
14665 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14666 (setq ans (replace-match (format "%02d:%02d" hour minute)
14667 t t ans))))
14669 ;; Check if a time range is given as a duration
14670 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14671 (setq hour (string-to-number (match-string 1 ans))
14672 h2 (+ hour (string-to-number (match-string 3 ans)))
14673 minute (string-to-number (match-string 2 ans))
14674 m2 (+ minute (if (match-end 5) (string-to-number
14675 (match-string 5 ans))0)))
14676 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14677 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14678 t t ans)))
14680 ;; Check if there is a time range
14681 (when (boundp 'org-end-time-was-given)
14682 (setq org-time-was-given nil)
14683 (when (and (string-match org-plain-time-of-day-regexp ans)
14684 (match-end 8))
14685 (setq org-end-time-was-given (match-string 8 ans))
14686 (setq ans (concat (substring ans 0 (match-beginning 7))
14687 (substring ans (match-end 7))))))
14689 (setq tl (parse-time-string ans)
14690 day (or (nth 3 tl) (nth 3 defdecode))
14691 month (or (nth 4 tl)
14692 (if (and org-read-date-prefer-future
14693 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14694 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14695 (nth 4 defdecode)))
14696 year (or (and (not kill-year) (nth 5 tl))
14697 (if (and org-read-date-prefer-future
14698 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14699 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14700 (nth 5 defdecode)))
14701 hour (or (nth 2 tl) (nth 2 defdecode))
14702 minute (or (nth 1 tl) (nth 1 defdecode))
14703 second (or (nth 0 tl) 0)
14704 wday (nth 6 tl))
14706 (when (and (eq org-read-date-prefer-future 'time)
14707 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14708 (equal day (nth 3 nowdecode))
14709 (equal month (nth 4 nowdecode))
14710 (equal year (nth 5 nowdecode))
14711 (nth 2 tl)
14712 (or (< (nth 2 tl) (nth 2 nowdecode))
14713 (and (= (nth 2 tl) (nth 2 nowdecode))
14714 (nth 1 tl)
14715 (< (nth 1 tl) (nth 1 nowdecode)))))
14716 (setq day (1+ day)
14717 futurep t))
14719 ;; Special date definitions below
14720 (cond
14721 (iso-week
14722 ;; There was an iso week
14723 (require 'cal-iso)
14724 (setq futurep nil)
14725 (setq year (or iso-year year)
14726 day (or iso-weekday wday 1)
14727 wday nil ; to make sure that the trigger below does not match
14728 iso-date (calendar-gregorian-from-absolute
14729 (calendar-absolute-from-iso
14730 (list iso-week day year))))
14731 ; FIXME: Should we also push ISO weeks into the future?
14732 ; (when (and org-read-date-prefer-future
14733 ; (not iso-year)
14734 ; (< (calendar-absolute-from-gregorian iso-date)
14735 ; (time-to-days (current-time))))
14736 ; (setq year (1+ year)
14737 ; iso-date (calendar-gregorian-from-absolute
14738 ; (calendar-absolute-from-iso
14739 ; (list iso-week day year)))))
14740 (setq month (car iso-date)
14741 year (nth 2 iso-date)
14742 day (nth 1 iso-date)))
14743 (deltan
14744 (setq futurep nil)
14745 (unless deltadef
14746 (let ((now (decode-time (current-time))))
14747 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14748 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14749 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14750 ((equal deltaw "m") (setq month (+ month deltan)))
14751 ((equal deltaw "y") (setq year (+ year deltan)))))
14752 ((and wday (not (nth 3 tl)))
14753 (setq futurep nil)
14754 ;; Weekday was given, but no day, so pick that day in the week
14755 ;; on or after the derived date.
14756 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14757 (unless (equal wday wday1)
14758 (setq day (+ day (% (- wday wday1 -7) 7))))))
14759 (if (and (boundp 'org-time-was-given)
14760 (nth 2 tl))
14761 (setq org-time-was-given t))
14762 (if (< year 100) (setq year (+ 2000 year)))
14763 ;; Check of the date is representable
14764 (if org-read-date-force-compatible-dates
14765 (progn
14766 (if (< year 1970)
14767 (setq year 1970 org-read-date-analyze-forced-year t))
14768 (if (> year 2037)
14769 (setq year 2037 org-read-date-analyze-forced-year t)))
14770 (condition-case nil
14771 (encode-time second minute hour day month year)
14772 (error
14773 (setq year (nth 5 defdecode))
14774 (setq org-read-date-analyze-forced-year t))))
14775 (setq org-read-date-analyze-futurep futurep)
14776 (list second minute hour day month year)))
14778 (defvar parse-time-weekdays)
14780 (defun org-read-date-get-relative (s today default)
14781 "Check string S for special relative date string.
14782 TODAY and DEFAULT are internal times, for today and for a default.
14783 Return shift list (N what def-flag)
14785 N is the number of WHATs to shift.
14786 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14787 the DEFAULT date rather than TODAY."
14788 (when (and
14789 (string-match
14790 (concat
14795 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14796 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14797 (string-to-char (substring (match-string 1 s) -1))
14798 ?+))
14799 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14800 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14801 (what (if (match-end 3) (match-string 3 s) "d"))
14802 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14803 (date (if rel default today))
14804 (wday (nth 6 (decode-time date)))
14805 delta)
14806 (if wday1
14807 (progn
14808 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14809 (if (= dir ?-) (setq delta (- delta 7)))
14810 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14811 (list delta "d" rel))
14812 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14814 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14815 "Turn a user-specified date into the internal representation.
14816 The internal representation needed by the calendar is (month day year).
14817 This is a wrapper to handle the brain-dead convention in calendar that
14818 user function argument order change dependent on argument order."
14819 (if (boundp 'calendar-date-style)
14820 (cond
14821 ((eq calendar-date-style 'american)
14822 (list arg1 arg2 arg3))
14823 ((eq calendar-date-style 'european)
14824 (list arg2 arg1 arg3))
14825 ((eq calendar-date-style 'iso)
14826 (list arg2 arg3 arg1)))
14827 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14828 (if (org-bound-and-true-p european-calendar-style)
14829 (list arg2 arg1 arg3)
14830 (list arg1 arg2 arg3)))))
14832 (defun org-eval-in-calendar (form &optional keepdate)
14833 "Eval FORM in the calendar window and return to current window.
14834 Also, store the cursor date in variable org-ans2."
14835 (let ((sf (selected-frame))
14836 (sw (selected-window)))
14837 (select-window (get-buffer-window "*Calendar*" t))
14838 (eval form)
14839 (when (and (not keepdate) (calendar-cursor-to-date))
14840 (let* ((date (calendar-cursor-to-date))
14841 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14842 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14843 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14844 (select-window sw)
14845 (org-select-frame-set-input-focus sf)))
14847 (defun org-calendar-select ()
14848 "Return to `org-read-date' with the date currently selected.
14849 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14850 (interactive)
14851 (when (calendar-cursor-to-date)
14852 (let* ((date (calendar-cursor-to-date))
14853 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14854 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14855 (if (active-minibuffer-window) (exit-minibuffer))))
14857 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14858 "Insert a date stamp for the date given by the internal TIME.
14859 WITH-HM means use the stamp format that includes the time of the day.
14860 INACTIVE means use square brackets instead of angular ones, so that the
14861 stamp will not contribute to the agenda.
14862 PRE and POST are optional strings to be inserted before and after the
14863 stamp.
14864 The command returns the inserted time stamp."
14865 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14866 stamp)
14867 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14868 (insert-before-markers (or pre ""))
14869 (when (listp extra)
14870 (setq extra (car extra))
14871 (if (and (stringp extra)
14873 (setq extra (format "-%02d:%02d"
14874 (string-to-number (match-string 1 extra))
14875 (string-to-number (match-string 2 extra))))
14876 (setq extra nil)))
14877 (when extra
14878 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14879 (insert-before-markers (setq stamp (format-time-string fmt time)))
14880 (insert-before-markers (or post ""))
14881 (setq org-last-inserted-timestamp stamp)))
14883 (defun org-toggle-time-stamp-overlays ()
14884 "Toggle the use of custom time stamp formats."
14885 (interactive)
14886 (setq org-display-custom-times (not org-display-custom-times))
14887 (unless org-display-custom-times
14888 (let ((p (point-min)) (bmp (buffer-modified-p)))
14889 (while (setq p (next-single-property-change p 'display))
14890 (if (and (get-text-property p 'display)
14891 (eq (get-text-property p 'face) 'org-date))
14892 (remove-text-properties
14893 p (setq p (next-single-property-change p 'display))
14894 '(display t))))
14895 (set-buffer-modified-p bmp)))
14896 (if (featurep 'xemacs)
14897 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14898 (org-restart-font-lock)
14899 (setq org-table-may-need-update t)
14900 (if org-display-custom-times
14901 (message "Time stamps are overlayed with custom format")
14902 (message "Time stamp overlays removed")))
14904 (defun org-display-custom-time (beg end)
14905 "Overlay modified time stamp format over timestamp between BEG and END."
14906 (let* ((ts (buffer-substring beg end))
14907 t1 w1 with-hm tf time str w2 (off 0))
14908 (save-match-data
14909 (setq t1 (org-parse-time-string ts t))
14910 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14911 (setq off (- (match-end 0) (match-beginning 0)))))
14912 (setq end (- end off))
14913 (setq w1 (- end beg)
14914 with-hm (and (nth 1 t1) (nth 2 t1))
14915 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14916 time (org-fix-decoded-time t1)
14917 str (org-add-props
14918 (format-time-string
14919 (substring tf 1 -1) (apply 'encode-time time))
14920 nil 'mouse-face 'highlight)
14921 w2 (length str))
14922 (if (not (= w2 w1))
14923 (add-text-properties (1+ beg) (+ 2 beg)
14924 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14925 (if (featurep 'xemacs)
14926 (progn
14927 (put-text-property beg end 'invisible t)
14928 (put-text-property beg end 'end-glyph (make-glyph str)))
14929 (put-text-property beg end 'display str))))
14931 (defun org-translate-time (string)
14932 "Translate all timestamps in STRING to custom format.
14933 But do this only if the variable `org-display-custom-times' is set."
14934 (when org-display-custom-times
14935 (save-match-data
14936 (let* ((start 0)
14937 (re org-ts-regexp-both)
14938 t1 with-hm inactive tf time str beg end)
14939 (while (setq start (string-match re string start))
14940 (setq beg (match-beginning 0)
14941 end (match-end 0)
14942 t1 (save-match-data
14943 (org-parse-time-string (substring string beg end) t))
14944 with-hm (and (nth 1 t1) (nth 2 t1))
14945 inactive (equal (substring string beg (1+ beg)) "[")
14946 tf (funcall (if with-hm 'cdr 'car)
14947 org-time-stamp-custom-formats)
14948 time (org-fix-decoded-time t1)
14949 str (format-time-string
14950 (concat
14951 (if inactive "[" "<") (substring tf 1 -1)
14952 (if inactive "]" ">"))
14953 (apply 'encode-time time))
14954 string (replace-match str t t string)
14955 start (+ start (length str)))))))
14956 string)
14958 (defun org-fix-decoded-time (time)
14959 "Set 0 instead of nil for the first 6 elements of time.
14960 Don't touch the rest."
14961 (let ((n 0))
14962 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14964 (defun org-days-to-time (timestamp-string)
14965 "Difference between TIMESTAMP-STRING and now in days."
14966 (- (time-to-days (org-time-string-to-time timestamp-string))
14967 (time-to-days (current-time))))
14969 (defun org-deadline-close (timestamp-string &optional ndays)
14970 "Is the time in TIMESTAMP-STRING close to the current date?"
14971 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14972 (and (< (org-days-to-time timestamp-string) ndays)
14973 (not (org-entry-is-done-p))))
14975 (defun org-get-wdays (ts)
14976 "Get the deadline lead time appropriate for timestring TS."
14977 (cond
14978 ((<= org-deadline-warning-days 0)
14979 ;; 0 or negative, enforce this value no matter what
14980 (- org-deadline-warning-days))
14982 ;; lead time is specified.
14983 (floor (* (string-to-number (match-string 1 ts))
14984 (cdr (assoc (match-string 2 ts)
14985 '(("d" . 1) ("w" . 7)
14986 ("m" . 30.4) ("y" . 365.25)))))))
14987 ;; go for the default.
14988 (t org-deadline-warning-days)))
14990 (defun org-calendar-select-mouse (ev)
14991 "Return to `org-read-date' with the date currently selected.
14992 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14993 (interactive "e")
14994 (mouse-set-point ev)
14995 (when (calendar-cursor-to-date)
14996 (let* ((date (calendar-cursor-to-date))
14997 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14998 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14999 (if (active-minibuffer-window) (exit-minibuffer))))
15001 (defun org-check-deadlines (ndays)
15002 "Check if there are any deadlines due or past due.
15003 A deadline is considered due if it happens within `org-deadline-warning-days'
15004 days from today's date. If the deadline appears in an entry marked DONE,
15005 it is not shown. The prefix arg NDAYS can be used to test that many
15007 (interactive "P")
15008 (let* ((org-warn-days
15009 (cond
15010 ((equal ndays '(4)) 100000)
15011 (ndays (prefix-numeric-value ndays))
15012 (t (abs org-deadline-warning-days))))
15013 (case-fold-search nil)
15015 (callback
15016 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15018 (message "%d deadlines past-due or due within %d days"
15019 (org-occur regexp nil callback)
15020 org-warn-days)))
15022 (defun org-check-before-date (date)
15023 "Check if there are deadlines or scheduled entries before DATE."
15024 (interactive (list (org-read-date)))
15025 (let ((case-fold-search nil)
15029 (callback
15030 (lambda () (time-less-p
15031 (org-time-string-to-time (match-string 2))
15032 (org-time-string-to-time date)))))
15033 (message "%d entries before %s"
15034 (org-occur regexp nil callback) date)))
15036 (defun org-check-after-date (date)
15037 "Check if there are deadlines or scheduled entries after DATE."
15038 (interactive (list (org-read-date)))
15039 (let ((case-fold-search nil)
15043 (callback
15044 (lambda () (not
15045 (time-less-p
15046 (org-time-string-to-time (match-string 2))
15047 (org-time-string-to-time date))))))
15048 (message "%d entries after %s"
15049 (org-occur regexp nil callback) date)))
15051 (defun org-evaluate-time-range (&optional to-buffer)
15052 "Evaluate a time range by computing the difference between start and end.
15053 Normally the result is just printed in the echo area, but with prefix arg
15054 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15055 If the time range is actually in a table, the result is inserted into the
15056 next column.
15057 For time difference computation, a year is assumed to be exactly 365
15058 days in order to avoid rounding problems."
15059 (interactive "P")
15060 (or
15061 (org-clock-update-time-maybe)
15062 (save-excursion
15063 (unless (org-at-date-range-p t)
15064 (goto-char (point-at-bol))
15065 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15066 (if (not (org-at-date-range-p t))
15067 (error "Not at a time-stamp range, and none found in current line")))
15068 (let* ((ts1 (match-string 1))
15069 (ts2 (match-string 2))
15070 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15071 (match-end (match-end 0))
15072 (time1 (org-time-string-to-time ts1))
15073 (time2 (org-time-string-to-time ts2))
15074 (t1 (org-float-time time1))
15075 (t2 (org-float-time time2))
15076 (diff (abs (- t2 t1)))
15077 (negative (< (- t2 t1) 0))
15078 ;; (ys (floor (* 365 24 60 60)))
15079 (ds (* 24 60 60))
15080 (hs (* 60 60))
15081 (fy "%dy %dd %02d:%02d")
15082 (fy1 "%dy %dd")
15083 (fd "%dd %02d:%02d")
15084 (fd1 "%dd")
15085 (fh "%02d:%02d")
15086 y d h m align)
15087 (if havetime
15088 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15089 y 0
15090 d (floor (/ diff ds)) diff (mod diff ds)
15091 h (floor (/ diff hs)) diff (mod diff hs)
15092 m (floor (/ diff 60)))
15093 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15094 y 0
15095 d (floor (+ (/ diff ds) 0.5))
15096 h 0 m 0))
15097 (if (not to-buffer)
15098 (message "%s" (org-make-tdiff-string y d h m))
15099 (if (org-at-table-p)
15100 (progn
15101 (goto-char match-end)
15102 (setq align t)
15103 (and (looking-at " *|") (goto-char (match-end 0))))
15104 (goto-char match-end))
15105 (if (looking-at
15107 (replace-match ""))
15108 (if negative (insert " -"))
15109 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15110 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15111 (insert " " (format fh h m))))
15112 (if align (org-table-align))
15113 (message "Time difference inserted")))))
15115 (defun org-make-tdiff-string (y d h m)
15116 (let ((fmt "")
15117 (l nil))
15118 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15119 l (push y l)))
15120 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15121 l (push d l)))
15122 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15123 l (push h l)))
15124 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15125 l (push m l)))
15126 (apply 'format fmt (nreverse l))))
15128 (defun org-time-string-to-time (s)
15129 (apply 'encode-time (org-parse-time-string s)))
15130 (defun org-time-string-to-seconds (s)
15131 (org-float-time (org-time-string-to-time s)))
15133 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15134 "Convert a time stamp to an absolute day number.
15135 If there is a specifier for a cyclic time stamp, get the closest date to
15136 DAYNR.
15137 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15138 The variable date is bound by the calendar when this is called."
15139 (cond
15141 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15142 daynr
15143 (+ daynr 1000)))
15145 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15146 (time-to-days (current-time))) (match-string 0 s)
15147 prefer show-all))
15148 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15150 (defun org-days-to-iso-week (days)
15151 "Return the iso week number."
15152 (require 'cal-iso)
15153 (car (calendar-iso-from-absolute days)))
15155 (defun org-small-year-to-year (year)
15156 "Convert 2-digit years into 4-digit years.
15157 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15158 The year 2000 cannot be abbreviated. Any year larger than 99
15159 is returned unchanged."
15160 (if (< year 38)
15161 (setq year (+ 2000 year))
15162 (if (< year 100)
15163 (setq year (+ 1900 year))))
15164 year)
15166 (defun org-time-from-absolute (d)
15167 "Return the time corresponding to date D.
15168 D may be an absolute day number, or a calendar-type list (month day year)."
15169 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15170 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15172 (defun org-calendar-holiday ()
15173 "List of holidays, for Diary display in Org-mode."
15174 (require 'holidays)
15175 (let ((hl (funcall
15176 (if (fboundp 'calendar-check-holidays)
15177 'calendar-check-holidays 'check-calendar-holidays) date)))
15178 (if hl (mapconcat 'identity hl "; "))))
15180 (defun org-diary-sexp-entry (sexp entry date)
15181 "Process a SEXP diary ENTRY for DATE."
15182 (require 'diary-lib)
15183 (let ((result (if calendar-debug-sexp
15184 (let ((stack-trace-on-error t))
15185 (eval (car (read-from-string sexp))))
15186 (condition-case nil
15187 (eval (car (read-from-string sexp)))
15188 (error
15189 (beep)
15190 (message "Bad sexp at line %d in %s: %s"
15191 (org-current-line)
15192 (buffer-file-name) sexp)
15193 (sleep-for 2))))))
15194 (cond ((stringp result) (split-string result "; "))
15195 ((and (consp result)
15196 (not (consp (cdr result)))
15197 (stringp (cdr result))) (cdr result))
15198 ((and (consp result)
15199 (stringp (car result))) result)
15200 (result entry)
15201 (t nil))))
15203 (defun org-diary-to-ical-string (frombuf)
15204 "Get iCalendar entries from diary entries in buffer FROMBUF.
15205 This uses the icalendar.el library."
15206 (let* ((tmpdir (if (featurep 'xemacs)
15207 (temp-directory)
15208 temporary-file-directory))
15209 (tmpfile (make-temp-name
15210 (expand-file-name "orgics" tmpdir)))
15211 buf rtn b e)
15212 (with-current-buffer frombuf
15213 (icalendar-export-region (point-min) (point-max) tmpfile)
15214 (setq buf (find-buffer-visiting tmpfile))
15215 (set-buffer buf)
15216 (goto-char (point-min))
15217 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15218 (setq b (match-beginning 0)))
15219 (goto-char (point-max))
15220 (if (re-search-backward "^END:VEVENT" nil t)
15221 (setq e (match-end 0)))
15223 (kill-buffer buf)
15224 (delete-file tmpfile)
15225 rtn))
15227 (defun org-closest-date (start current change prefer show-all)
15228 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15229 When PREFER is `past', return a date that is either CURRENT or past.
15230 When PREFER is `future', return a date that is either CURRENT or future.
15231 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15232 ;; Make the proper lists from the dates
15233 (catch 'exit
15234 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15235 dn dw sday cday n1 n2 n0
15236 d m y y1 y2 date1 date2 nmonths nm ny m2)
15238 (setq start (org-date-to-gregorian start)
15239 current (org-date-to-gregorian
15240 (if show-all
15241 current
15242 (time-to-days (current-time))))
15243 sday (calendar-absolute-from-gregorian start)
15244 cday (calendar-absolute-from-gregorian current))
15246 (if (<= cday sday) (throw 'exit sday))
15249 (setq dn (string-to-number (match-string 1 change))
15250 dw (cdr (assoc (match-string 2 change) a1)))
15251 (error "Invalid change specifier: %s" change))
15252 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15253 (cond
15254 ((eq dw 'day)
15255 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15256 n2 (+ n1 dn)))
15257 ((eq dw 'year)
15258 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15259 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15260 (setq date1 (list m d y1)
15261 n1 (calendar-absolute-from-gregorian date1)
15262 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15263 n2 (calendar-absolute-from-gregorian date2)))
15264 ((eq dw 'month)
15265 ;; approx number of month between the two dates
15266 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15267 ;; How often does dn fit in there?
15268 (setq d (nth 1 start) m (car start) y (nth 2 start)
15269 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15270 m (+ m nm)
15271 ny (floor (/ m 12))
15272 y (+ y ny)
15273 m (- m (* ny 12)))
15274 (while (> m 12) (setq m (- m 12) y (1+ y)))
15275 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15276 (setq m2 (+ m dn) y2 y)
15277 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15278 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15279 (while (<= n2 cday)
15280 (setq n1 n2 m m2 y y2)
15281 (setq m2 (+ m dn) y2 y)
15282 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15283 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15284 ;; Make sure n1 is the earlier date
15285 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15286 (if show-all
15287 (cond
15288 ((eq prefer 'past) (if (= cday n2) n2 n1))
15289 ((eq prefer 'future) (if (= cday n1) n1 n2))
15290 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15291 (cond
15292 ((eq prefer 'past) (if (= cday n2) n2 n1))
15293 ((eq prefer 'future) (if (= cday n1) n1 n2))
15294 (t (if (= cday n1) n1 n2)))))))
15296 (defun org-date-to-gregorian (date)
15297 "Turn any specification of DATE into a Gregorian date for the calendar."
15298 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15299 ((and (listp date) (= (length date) 3)) date)
15300 ((stringp date)
15301 (setq date (org-parse-time-string date))
15302 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15303 ((listp date)
15304 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15306 (defun org-parse-time-string (s &optional nodefault)
15307 "Parse the standard Org-mode time string.
15308 This should be a lot faster than the normal `parse-time-string'.
15309 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15310 hour and minute fields will be nil if not given."
15311 (if (string-match org-ts-regexp0 s)
15312 (list 0
15313 (if (or (match-beginning 8) (not nodefault))
15314 (string-to-number (or (match-string 8 s) "0")))
15315 (if (or (match-beginning 7) (not nodefault))
15316 (string-to-number (or (match-string 7 s) "0")))
15317 (string-to-number (match-string 4 s))
15318 (string-to-number (match-string 3 s))
15319 (string-to-number (match-string 2 s))
15320 nil nil nil)
15321 (error "Not a standard Org-mode time string: %s" s)))
15323 (defun org-timestamp-up (&optional arg)
15324 "Increase the date item at the cursor by one.
15325 If the cursor is on the year, change the year. If it is on the month or
15326 the day, change that.
15327 With prefix ARG, change by that many units."
15328 (interactive "p")
15329 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15331 (defun org-timestamp-down (&optional arg)
15332 "Decrease the date item at the cursor by one.
15333 If the cursor is on the year, change the year. If it is on the month or
15334 the day, change that.
15335 With prefix ARG, change by that many units."
15336 (interactive "p")
15337 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15339 (defun org-timestamp-up-day (&optional arg)
15340 "Increase the date in the time stamp by one day.
15341 With prefix ARG, change that many days."
15342 (interactive "p")
15343 (if (and (not (org-at-timestamp-p t))
15344 (org-on-heading-p))
15345 (org-todo 'up)
15346 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15348 (defun org-timestamp-down-day (&optional arg)
15349 "Decrease the date in the time stamp by one day.
15350 With prefix ARG, change that many days."
15351 (interactive "p")
15352 (if (and (not (org-at-timestamp-p t))
15353 (org-on-heading-p))
15354 (org-todo 'down)
15355 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15357 (defun org-at-timestamp-p (&optional inactive-ok)
15358 "Determine if the cursor is in or at a timestamp."
15359 (interactive)
15360 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15361 (pos (point))
15362 (ans (or (looking-at tsr)
15363 (save-excursion
15365 (if (> (point) (point-min)) (backward-char 1))
15366 (and (looking-at tsr)
15367 (> (- (match-end 0) pos) -1))))))
15368 (and ans
15369 (boundp 'org-ts-what)
15370 (setq org-ts-what
15371 (cond
15372 ((= pos (match-beginning 0)) 'bracket)
15373 ((= pos (1- (match-end 0))) 'bracket)
15374 ((org-pos-in-match-range pos 2) 'year)
15375 ((org-pos-in-match-range pos 3) 'month)
15376 ((org-pos-in-match-range pos 7) 'hour)
15377 ((org-pos-in-match-range pos 8) 'minute)
15378 ((or (org-pos-in-match-range pos 4)
15379 (org-pos-in-match-range pos 5)) 'day)
15380 ((and (> pos (or (match-end 8) (match-end 5)))
15381 (< pos (match-end 0)))
15382 (- pos (or (match-end 8) (match-end 5))))
15383 (t 'day))))
15384 ans))
15386 (defun org-toggle-timestamp-type ()
15387 "Toggle the type (<active> or [inactive]) of a time stamp."
15388 (interactive)
15389 (when (org-at-timestamp-p t)
15390 (let ((beg (match-beginning 0)) (end (match-end 0))
15391 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15392 (save-excursion
15393 (goto-char beg)
15394 (while (re-search-forward "[][<>]" end t)
15395 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15396 t t)))
15397 (message "Timestamp is now %sactive"
15398 (if (equal (char-after beg) ?<) "" "in")))))
15400 (defun org-timestamp-change (n &optional what updown)
15401 "Change the date in the time stamp at point.
15402 The date will be changed by N times WHAT. WHAT can be `day', `month',
15403 `year', `minute', `second'. If WHAT is not given, the cursor position
15404 in the timestamp determines what will be changed."
15405 (let ((pos (point))
15406 with-hm inactive
15407 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15408 org-ts-what
15409 extra rem
15410 ts time time0)
15411 (if (not (org-at-timestamp-p t))
15412 (error "Not at a timestamp"))
15413 (if (and (not what) (eq org-ts-what 'bracket))
15414 (org-toggle-timestamp-type)
15415 (if (and (not what) (not (eq org-ts-what 'day))
15416 org-display-custom-times
15417 (get-text-property (point) 'display)
15418 (not (get-text-property (1- (point)) 'display)))
15419 (setq org-ts-what 'day))
15420 (setq org-ts-what (or what org-ts-what)
15421 inactive (= (char-after (match-beginning 0)) ?\[)
15422 ts (match-string 0))
15423 (replace-match "")
15424 (if (string-match
15426 ts)
15427 (setq extra (match-string 1 ts)))
15429 (setq with-hm t))
15430 (setq time0 (org-parse-time-string ts))
15431 (when (and updown
15432 (eq org-ts-what 'minute)
15433 (not current-prefix-arg))
15434 ;; This looks like s-up and s-down. Change by one rounding step.
15435 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15436 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15437 (setcar (cdr time0) (+ (nth 1 time0)
15438 (if (> n 0) (- rem) (- dm rem))))))
15439 (setq time
15440 (encode-time (or (car time0) 0)
15441 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15442 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15443 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15444 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15445 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15446 (nthcdr 6 time0)))
15447 (when (and (member org-ts-what '(hour minute))
15448 extra
15450 (setq extra (org-modify-ts-extra
15451 extra
15452 (if (eq org-ts-what 'hour) 2 5)
15453 n dm)))
15454 (when (integerp org-ts-what)
15455 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15456 (if (eq what 'calendar)
15457 (let ((cal-date (org-get-date-from-calendar)))
15458 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15459 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15460 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15461 (setcar time0 (or (car time0) 0))
15462 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15463 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15464 (setq time (apply 'encode-time time0))))
15465 (setq org-last-changed-timestamp
15466 (org-insert-time-stamp time with-hm inactive nil nil extra))
15467 (org-clock-update-time-maybe)
15468 (goto-char pos)
15469 ;; Try to recenter the calendar window, if any
15470 (if (and org-calendar-follow-timestamp-change
15471 (get-buffer-window "*Calendar*" t)
15472 (memq org-ts-what '(day month year)))
15473 (org-recenter-calendar (time-to-days time))))))
15475 (defun org-modify-ts-extra (s pos n dm)
15476 "Change the different parts of the lead-time and repeat fields in timestamp."
15477 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15478 ng h m new rem)
15479 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15480 (cond
15481 ((or (org-pos-in-match-range pos 2)
15482 (org-pos-in-match-range pos 3))
15483 (setq m (string-to-number (match-string 3 s))
15484 h (string-to-number (match-string 2 s)))
15485 (if (org-pos-in-match-range pos 2)
15486 (setq h (+ h n))
15487 (setq n (* dm (org-no-warnings (signum n))))
15488 (when (not (= 0 (setq rem (% m dm))))
15489 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15490 (setq m (+ m n)))
15491 (if (< m 0) (setq m (+ m 60) h (1- h)))
15492 (if (> m 59) (setq m (- m 60) h (1+ h)))
15493 (setq h (min 24 (max 0 h)))
15494 (setq ng 1 new (format "-%02d:%02d" h m)))
15495 ((org-pos-in-match-range pos 6)
15496 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15497 ((org-pos-in-match-range pos 5)
15498 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15500 ((org-pos-in-match-range pos 9)
15501 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15502 ((org-pos-in-match-range pos 8)
15503 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15505 (when ng
15506 (setq s (concat
15507 (substring s 0 (match-beginning ng))
15508 new
15509 (substring s (match-end ng))))))
15510 s))
15512 (defun org-recenter-calendar (date)
15513 "If the calendar is visible, recenter it to DATE."
15514 (let* ((win (selected-window))
15515 (cwin (get-buffer-window "*Calendar*" t))
15516 (calendar-move-hook nil))
15517 (when cwin
15518 (select-window cwin)
15519 (calendar-goto-date (if (listp date) date
15520 (calendar-gregorian-from-absolute date)))
15521 (select-window win))))
15523 (defun org-goto-calendar (&optional arg)
15524 "Go to the Emacs calendar at the current date.
15525 If there is a time stamp in the current line, go to that date.
15526 A prefix ARG can be used to force the current date."
15527 (interactive "P")
15528 (let ((tsr org-ts-regexp) diff
15529 (calendar-move-hook nil)
15530 (calendar-view-holidays-initially-flag nil)
15531 (calendar-view-diary-initially-flag nil))
15532 (if (or (org-at-timestamp-p)
15533 (save-excursion
15534 (beginning-of-line 1)
15535 (looking-at (concat ".*" tsr))))
15536 (let ((d1 (time-to-days (current-time)))
15537 (d2 (time-to-days
15538 (org-time-string-to-time (match-string 1)))))
15539 (setq diff (- d2 d1))))
15540 (calendar)
15541 (calendar-goto-today)
15542 (if (and diff (not arg)) (calendar-forward-day diff))))
15544 (defun org-get-date-from-calendar ()
15545 "Return a list (month day year) of date at point in calendar."
15546 (with-current-buffer "*Calendar*"
15547 (save-match-data
15548 (calendar-cursor-to-date))))
15550 (defun org-date-from-calendar ()
15551 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15552 If there is already a time stamp at the cursor position, update it."
15553 (interactive)
15554 (if (org-at-timestamp-p t)
15555 (org-timestamp-change 0 'calendar)
15556 (let ((cal-date (org-get-date-from-calendar)))
15557 (org-insert-time-stamp
15558 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15560 (defun org-minutes-to-hh:mm-string (m)
15561 "Compute H:MM from a number of minutes."
15562 (let ((h (/ m 60)))
15563 (setq m (- m (* 60 h)))
15564 (format org-time-clocksum-format h m)))
15566 (defun org-hh:mm-string-to-minutes (s)
15567 "Convert a string H:MM to a number of minutes.
15568 If the string is just a number, interpret it as minutes.
15569 In fact, the first hh:mm or number in the string will be taken,
15570 there can be extra stuff in the string.
15571 If no number is found, the return value is 0."
15572 (cond
15574 (+ (* (string-to-number (match-string 1 s)) 60)
15575 (string-to-number (match-string 2 s))))
15577 (string-to-number (match-string 1 s)))
15578 (t 0)))
15580 (defcustom org-effort-durations
15581 `(("h" . 60)
15582 ("d" . ,(* 60 8))
15583 ("w" . ,(* 60 8 5))
15584 ("m" . ,(* 60 8 5 4))
15585 ("y" . ,(* 60 8 5 40)))
15586 "Conversion factor to minutes for an effort modifier.
15588 Each entry has the form (MODIFIER . MINUTES).
15590 In an effort string, a number followed by MODIFIER is multiplied
15591 by the specified number of MINUTES to obtain an effort in
15592 minutes.
15596 :group 'org-agenda
15597 :type '(alist :key-type (string :tag "Modifier")
15598 :value-type (number :tag "Minutes")))
15600 (defun org-duration-string-to-minutes (s)
15601 "Convert a duration string S to minutes.
15603 A bare number is interpreted as minutes, modifiers can be set by
15604 customizing `org-effort-durations' (which see).
15606 Entries containing a colon are interpreted as H:MM by
15607 `org-hh:mm-string-to-minutes'."
15608 (let ((result 0)
15610 (regexp-opt (mapcar 'car org-effort-durations))
15612 (while (string-match re s)
15613 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15614 (string-to-number (match-string 1 s))))
15615 (setq s (replace-match "" nil t s)))
15616 (incf result (org-hh:mm-string-to-minutes s))
15617 result))
15619 ;;;; Files
15621 (defun org-save-all-org-buffers ()
15622 "Save all Org-mode buffers without user confirmation."
15623 (interactive)
15624 (message "Saving all Org-mode buffers...")
15625 (save-some-buffers t 'org-mode-p)
15626 (when (featurep 'org-id) (org-id-locations-save))
15627 (message "Saving all Org-mode buffers... done"))
15629 (defun org-revert-all-org-buffers ()
15630 "Revert all Org-mode buffers.
15631 Prompt for confirmation when there are unsaved changes.
15632 Be sure you know what you are doing before letting this function
15633 overwrite your changes.
15635 This function is useful in a setup where one tracks org files
15636 with a version control system, to revert on one machine after pulling
15637 changes from another. I believe the procedure must be like this:
15639 1. M-x org-save-all-org-buffers
15640 2. Pull changes from the other machine, resolve conflicts
15641 3. M-x org-revert-all-org-buffers"
15642 (interactive)
15643 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15644 (error "Abort"))
15645 (save-excursion
15646 (save-window-excursion
15647 (mapc
15648 (lambda (b)
15649 (when (and (with-current-buffer b (org-mode-p))
15650 (with-current-buffer b buffer-file-name))
15651 (switch-to-buffer b)
15652 (revert-buffer t 'no-confirm)))
15653 (buffer-list))
15654 (when (and (featurep 'org-id) org-id-track-globally)
15655 (org-id-locations-load)))))
15657 ;;;; Agenda files
15659 ;;;###autoload
15660 (defun org-switchb (&optional arg)
15661 "Switch between Org buffers.
15662 With a prefix argument, restrict available to files.
15663 With two prefix arguments, restrict available buffers to agenda files.
15665 Defaults to `iswitchb' for buffer name completion.
15666 Set `org-completion-use-ido' to make it use ido instead."
15667 (interactive "P")
15668 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15669 ((equal arg '(16)) (org-buffer-list 'agenda))
15670 (t (org-buffer-list))))
15671 (org-completion-use-iswitchb org-completion-use-iswitchb)
15672 (org-completion-use-ido org-completion-use-ido))
15673 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15674 (setq org-completion-use-iswitchb t))
15675 (switch-to-buffer
15676 (org-icompleting-read "Org buffer: "
15677 (mapcar 'list (mapcar 'buffer-name blist))
15678 nil t))))
15680 ;;; Define some older names previously used for this functionality
15681 ;;;###autoload
15682 (defalias 'org-ido-switchb 'org-switchb)
15683 ;;;###autoload
15684 (defalias 'org-iswitchb 'org-switchb)
15686 (defun org-buffer-list (&optional predicate exclude-tmp)
15687 "Return a list of Org buffers.
15688 PREDICATE can be `export', `files' or `agenda'.
15690 export restrict the list to Export buffers.
15691 files restrict the list to buffers visiting Org files.
15692 agenda restrict the list to buffers visiting agenda files.
15694 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15695 (let* ((bfn nil)
15696 (agenda-files (and (eq predicate 'agenda)
15697 (mapcar 'file-truename (org-agenda-files t))))
15698 (filter
15699 (cond
15700 ((eq predicate 'files)
15701 (lambda (b) (with-current-buffer b (org-mode-p))))
15702 ((eq predicate 'export)
15703 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15704 ((eq predicate 'agenda)
15705 (lambda (b)
15706 (with-current-buffer b
15707 (and (org-mode-p)
15708 (setq bfn (buffer-file-name b))
15709 (member (file-truename bfn) agenda-files)))))
15710 (t (lambda (b) (with-current-buffer b
15711 (or (org-mode-p)
15712 (string-match "\*Org .*Export"
15713 (buffer-name b)))))))))
15714 (delq nil
15715 (mapcar
15716 (lambda(b)
15717 (if (and (funcall filter b)
15718 (or (not exclude-tmp)
15719 (not (string-match "tmp" (buffer-name b)))))
15720 b
15721 nil))
15722 (buffer-list)))))
15724 (defun org-agenda-files (&optional unrestricted archives)
15725 "Get the list of agenda files.
15726 Optional UNRESTRICTED means return the full list even if a restriction
15727 is currently in place.
15728 When ARCHIVES is t, include all archive files that are really being
15729 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15730 `org-agenda-archives-mode' is t."
15731 (let ((files
15732 (cond
15733 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15734 ((stringp org-agenda-files) (org-read-agenda-file-list))
15735 ((listp org-agenda-files) org-agenda-files)
15736 (t (error "Invalid value of `org-agenda-files'")))))
15737 (setq files (apply 'append
15738 (mapcar (lambda (f)
15739 (if (file-directory-p f)
15740 (directory-files
15741 f t org-agenda-file-regexp)
15742 (list f)))
15743 files)))
15744 (when org-agenda-skip-unavailable-files
15745 (setq files (delq nil
15746 (mapcar (function
15747 (lambda (file)
15748 (and (file-readable-p file) file)))
15749 files))))
15750 (when (or (eq archives t)
15751 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15752 (setq files (org-add-archive-files files)))
15753 files))
15755 (defun org-agenda-file-p (&optional file)
15756 "Return non-nil, if FILE is an agenda file.
15757 If FILE is omitted, use the file associated with the current
15758 buffer."
15759 (member (or file (buffer-file-name))
15760 (org-agenda-files t)))
15762 (defun org-edit-agenda-file-list ()
15763 "Edit the list of agenda files.
15764 Depending on setup, this either uses customize to edit the variable
15765 `org-agenda-files', or it visits the file that is holding the list. In the
15766 latter case, the buffer is set up in a way that saving it automatically kills
15767 the buffer and restores the previous window configuration."
15768 (interactive)
15769 (if (stringp org-agenda-files)
15770 (let ((cw (current-window-configuration)))
15771 (find-file org-agenda-files)
15772 (org-set-local 'org-window-configuration cw)
15773 (org-add-hook 'after-save-hook
15774 (lambda ()
15775 (set-window-configuration
15776 (prog1 org-window-configuration
15777 (kill-buffer (current-buffer))))
15778 (org-install-agenda-files-menu)
15779 (message "New agenda file list installed"))
15780 nil 'local)
15781 (message "%s" (substitute-command-keys
15783 (customize-variable 'org-agenda-files)))
15785 (defun org-store-new-agenda-file-list (list)
15786 "Set new value for the agenda file list and save it correctly."
15787 (if (stringp org-agenda-files)
15788 (let ((fe (org-read-agenda-file-list t)) b u)
15789 (while (setq b (find-buffer-visiting org-agenda-files))
15790 (kill-buffer b))
15791 (with-temp-file org-agenda-files
15792 (insert
15793 (mapconcat
15794 (lambda (f) ;; Keep un-expanded entries.
15795 (if (setq u (assoc f fe))
15796 (cdr u)
15797 f))
15800 (let ((org-mode-hook nil) (org-inhibit-startup t)
15801 (org-insert-mode-line-in-empty-file nil))
15802 (setq org-agenda-files list)
15803 (customize-save-variable 'org-agenda-files org-agenda-files))))
15805 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15806 "Read the list of agenda files from a file.
15807 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15808 filenames, used by `org-store-new-agenda-file-list' to write back
15809 un-expanded file names."
15810 (when (file-directory-p org-agenda-files)
15811 (error "`org-agenda-files' cannot be a single directory"))
15812 (when (stringp org-agenda-files)
15813 (with-temp-buffer
15814 (insert-file-contents org-agenda-files)
15815 (mapcar
15816 (lambda (f)
15817 (let ((e (expand-file-name (substitute-in-file-name f)
15818 org-directory)))
15819 (if pair-with-expansion
15820 (cons e f)
15821 e)))
15824 ;;;###autoload
15825 (defun org-cycle-agenda-files ()
15826 "Cycle through the files in `org-agenda-files'.
15827 If the current buffer visits an agenda file, find the next one in the list.
15828 If the current buffer does not, find the first agenda file."
15829 (interactive)
15830 (let* ((fs (org-agenda-files t))
15831 (files (append fs (list (car fs))))
15832 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15833 file)
15834 (unless files (error "No agenda files"))
15835 (catch 'exit
15836 (while (setq file (pop files))
15837 (if (equal (file-truename file) tcf)
15838 (when (car files)
15839 (find-file (car files))
15840 (throw 'exit t))))
15841 (find-file (car fs)))
15842 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15844 (defun org-agenda-file-to-front (&optional to-end)
15845 "Move/add the current file to the top of the agenda file list.
15846 If the file is not present in the list, it is added to the front. If it is
15847 present, it is moved there. With optional argument TO-END, add/move to the
15848 end of the list."
15849 (interactive "P")
15850 (let ((org-agenda-skip-unavailable-files nil)
15851 (file-alist (mapcar (lambda (x)
15852 (cons (file-truename x) x))
15853 (org-agenda-files t)))
15854 (ctf (file-truename buffer-file-name))
15855 x had)
15856 (setq x (assoc ctf file-alist) had x)
15858 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15859 (if to-end
15860 (setq file-alist (append (delq x file-alist) (list x)))
15861 (setq file-alist (cons x (delq x file-alist))))
15862 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15863 (org-install-agenda-files-menu)
15864 (message "File %s to %s of agenda file list"
15865 (if had "moved" "added") (if to-end "end" "front"))))
15867 (defun org-remove-file (&optional file)
15868 "Remove current file from the list of files in variable `org-agenda-files'.
15869 These are the files which are being checked for agenda entries.
15870 Optional argument FILE means use this file instead of the current."
15871 (interactive)
15872 (let* ((org-agenda-skip-unavailable-files nil)
15873 (file (or file buffer-file-name))
15874 (true-file (file-truename file))
15875 (afile (abbreviate-file-name file))
15876 (files (delq nil (mapcar
15877 (lambda (x)
15878 (if (equal true-file
15879 (file-truename x))
15880 nil x))
15881 (org-agenda-files t)))))
15882 (if (not (= (length files) (length (org-agenda-files t))))
15883 (progn
15884 (org-store-new-agenda-file-list files)
15885 (org-install-agenda-files-menu)
15886 (message "Removed file: %s" afile))
15887 (message "File was not in list: %s (not removed)" afile))))
15889 (defun org-file-menu-entry (file)
15890 (vector file (list 'find-file file) t))
15892 (defun org-check-agenda-file (file)
15893 "Make sure FILE exists. If not, ask user what to do."
15894 (when (not (file-exists-p file))
15895 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15896 (abbreviate-file-name file))
15897 (let ((r (downcase (read-char-exclusive))))
15898 (cond
15899 ((equal r ?r)
15900 (org-remove-file file)
15901 (throw 'nextfile t))
15902 (t (error "Abort"))))))
15904 (defun org-get-agenda-file-buffer (file)
15905 "Get a buffer visiting FILE. If the buffer needs to be created, add
15906 it to the list of buffers which might be released later."
15907 (let ((buf (org-find-base-buffer-visiting file)))
15908 (if buf
15909 buf ; just return it
15910 ;; Make a new buffer and remember it
15911 (setq buf (find-file-noselect file))
15912 (if buf (push buf org-agenda-new-buffers))
15913 buf)))
15915 (defun org-release-buffers (blist)
15916 "Release all buffers in list, asking the user for confirmation when needed.
15917 When a buffer is unmodified, it is just killed. When modified, it is saved
15918 \(if the user agrees) and then killed."
15919 (let (buf file)
15920 (while (setq buf (pop blist))
15921 (setq file (buffer-file-name buf))
15922 (when (and (buffer-modified-p buf)
15923 file
15924 (y-or-n-p (format "Save file %s? " file)))
15925 (with-current-buffer buf (save-buffer)))
15926 (kill-buffer buf))))
15928 (defun org-prepare-agenda-buffers (files)
15929 "Create buffers for all agenda files, protect archived trees and comments."
15930 (interactive)
15931 (let ((pa '(:org-archived t))
15932 (pc '(:org-comment t))
15933 (pall '(:org-archived t :org-comment t))
15934 (inhibit-read-only t)
15935 (rea (concat ":" org-archive-tag ":"))
15936 bmp file re)
15937 (save-excursion
15938 (save-restriction
15939 (while (setq file (pop files))
15940 (catch 'nextfile
15941 (if (bufferp file)
15942 (set-buffer file)
15943 (org-check-agenda-file file)
15944 (set-buffer (org-get-agenda-file-buffer file)))
15945 (widen)
15946 (setq bmp (buffer-modified-p))
15947 (org-refresh-category-properties)
15948 (setq org-todo-keywords-for-agenda
15949 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15950 (setq org-done-keywords-for-agenda
15951 (append org-done-keywords-for-agenda org-done-keywords))
15952 (setq org-todo-keyword-alist-for-agenda
15953 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15954 (setq org-drawers-for-agenda
15955 (append org-drawers-for-agenda org-drawers))
15956 (setq org-tag-alist-for-agenda
15957 (append org-tag-alist-for-agenda org-tag-alist))
15959 (save-excursion
15960 (remove-text-properties (point-min) (point-max) pall)
15961 (when org-agenda-skip-archived-trees
15962 (goto-char (point-min))
15963 (while (re-search-forward rea nil t)
15964 (if (org-on-heading-p t)
15965 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15966 (goto-char (point-min))
15968 (while (re-search-forward re nil t)
15969 (add-text-properties
15970 (match-beginning 0) (org-end-of-subtree t) pc)))
15971 (set-buffer-modified-p bmp)))))
15972 (setq org-todo-keywords-for-agenda
15973 (org-uniquify org-todo-keywords-for-agenda))
15974 (setq org-todo-keyword-alist-for-agenda
15975 (org-uniquify org-todo-keyword-alist-for-agenda)
15976 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15978 ;;;; Embedded LaTeX
15980 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15981 "Keymap for the minor `org-cdlatex-mode'.")
15983 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15984 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15985 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15986 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15987 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15989 (defvar org-cdlatex-texmathp-advice-is-done nil
15990 "Flag remembering if we have applied the advice to texmathp already.")
15992 (define-minor-mode org-cdlatex-mode
15993 "Toggle the minor `org-cdlatex-mode'.
15994 This mode supports entering LaTeX environment and math in LaTeX fragments
15995 in Org-mode.
15997 nil " OCDL" nil
15998 (when org-cdlatex-mode (require 'cdlatex))
15999 (unless org-cdlatex-texmathp-advice-is-done
16000 (setq org-cdlatex-texmathp-advice-is-done t)
16001 (defadvice texmathp (around org-math-always-on activate)
16002 "Always return t in org-mode buffers.
16003 This is because we want to insert math symbols without dollars even outside
16004 the LaTeX math segments. If Orgmode thinks that point is actually inside
16005 an embedded LaTeX fragment, let texmathp do its job.
16007 (interactive)
16008 (let (p)
16009 (cond
16010 ((not (org-mode-p)) ad-do-it)
16011 ((eq this-command 'cdlatex-math-symbol)
16012 (setq ad-return-value t
16013 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16014 (t
16015 (let ((p (org-inside-LaTeX-fragment-p)))
16016 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16017 (setq ad-return-value t
16018 texmathp-why '("Org-mode embedded math" . 0))
16019 (if p ad-do-it)))))))))
16021 (defun turn-on-org-cdlatex ()
16022 "Unconditionally turn on `org-cdlatex-mode'."
16023 (org-cdlatex-mode 1))
16025 (defun org-inside-LaTeX-fragment-p ()
16026 "Test if point is inside a LaTeX fragment.
16028 sequence appearing also before point.
16029 Even though the matchers for math are configurable, this function assumes
16031 delimiters are skipped when they have been removed by customization.
16032 The return value is nil, or a cons cell with the delimiter and
16033 and the position of this delimiter.
16035 This function does a reasonably good job, but can locally be fooled by
16036 for example currency specifications. For example it will assume being in
16038 fragments that are properly closed, but during editing, we have to live
16039 with the uncertainty caused by missing closing delimiters. This function
16040 looks only before point, not after."
16041 (catch 'exit
16042 (let ((pos (point))
16043 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16044 (lim (progn
16046 (point)))
16047 dd-on str (start 0) m re)
16048 (goto-char pos)
16049 (when dodollar
16051 re (nth 1 (assoc "$" org-latex-regexps)))
16052 (while (string-match re str start)
16053 (cond
16054 ((= (match-end 0) (length str))
16055 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16056 ((= (match-end 0) (- (length str) 5))
16057 (throw 'exit nil))
16058 (t (setq start (match-end 0))))))
16059 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16060 (goto-char pos)
16061 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16062 (and (match-beginning 2) (throw 'exit nil))
16063 ;; count $$
16065 (setq dd-on (not dd-on)))
16066 (goto-char pos)
16067 (if dd-on (cons "$$" m))))))
16069 (defun org-inside-latex-macro-p ()
16070 "Is point inside a LaTeX macro or its arguments?"
16071 (save-match-data
16072 (org-in-regexp
16075 (defun org-try-cdlatex-tab ()
16076 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16077 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16078 - inside a LaTeX fragment, or
16079 - after the first word in a line, where an abbreviation expansion could
16080 insert a LaTeX environment."
16081 (when org-cdlatex-mode
16082 (cond
16083 ((save-excursion
16084 (skip-chars-backward "a-zA-Z0-9*")
16086 (bolp))
16087 (cdlatex-tab) t)
16088 ((org-inside-LaTeX-fragment-p)
16089 (cdlatex-tab) t)
16090 (t nil))))
16092 (defun org-cdlatex-underscore-caret (&optional arg)
16093 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16094 Revert to the normal definition outside of these fragments."
16095 (interactive "P")
16096 (if (org-inside-LaTeX-fragment-p)
16097 (call-interactively 'cdlatex-sub-superscript)
16098 (let (org-cdlatex-mode)
16099 (call-interactively (key-binding (vector last-input-event))))))
16101 (defun org-cdlatex-math-modify (&optional arg)
16102 "Execute `cdlatex-math-modify' in LaTeX fragments.
16103 Revert to the normal definition outside of these fragments."
16104 (interactive "P")
16105 (if (org-inside-LaTeX-fragment-p)
16106 (call-interactively 'cdlatex-math-modify)
16107 (let (org-cdlatex-mode)
16108 (call-interactively (key-binding (vector last-input-event))))))
16110 (defvar org-latex-fragment-image-overlays nil
16111 "List of overlays carrying the images of latex fragments.")
16112 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16114 (defun org-remove-latex-fragment-image-overlays ()
16115 "Remove all overlays with LaTeX fragment images in current buffer."
16116 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16117 (setq org-latex-fragment-image-overlays nil))
16119 (defun org-preview-latex-fragment (&optional subtree)
16120 "Preview the LaTeX fragment at point, or all locally or globally.
16121 If the cursor is in a LaTeX fragment, create the image and overlay
16122 it over the source code. If there is no fragment at point, display
16123 all fragments in the current text, from one headline to the next. With
16124 prefix SUBTREE, display all fragments in the current subtree. With a
16126 the cursor is before the first headline,
16127 display all fragments in the buffer.
16129 (interactive "P")
16130 (org-remove-latex-fragment-image-overlays)
16131 (save-excursion
16132 (save-restriction
16133 (let (beg end at msg)
16134 (cond
16135 ((or (equal subtree '(16))
16136 (not (save-excursion
16137 (re-search-backward (concat "^" outline-regexp) nil t))))
16138 (setq beg (point-min) end (point-max)
16139 msg "Creating images for buffer...%s"))
16140 ((equal subtree '(4))
16141 (org-back-to-heading)
16142 (setq beg (point) end (org-end-of-subtree t)
16143 msg "Creating images for subtree...%s"))
16144 (t
16145 (if (setq at (org-inside-LaTeX-fragment-p))
16146 (goto-char (max (point-min) (- (cdr at) 2)))
16147 (org-back-to-heading))
16148 (setq beg (point) end (progn (outline-next-heading) (point))
16149 msg (if at "Creating image...%s"
16150 "Creating images for entry...%s"))))
16151 (message msg "")
16152 (narrow-to-region beg end)
16153 (goto-char beg)
16154 (org-format-latex
16155 (concat "ltxpng/" (file-name-sans-extension
16156 (file-name-nondirectory
16157 buffer-file-name)))
16158 default-directory 'overlays msg at 'forbuffer 'dvipng)
16159 (message msg "done. Use `C-c C-c' to remove images.")))))
16161 (defvar org-latex-regexps
16163 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16166 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16170 "Regular expressions for matching embedded LaTeX.")
16172 (defvar org-export-have-math nil) ;; dynamic scoping
16173 (defun org-format-latex (prefix &optional dir overlays msg at
16174 forbuffer processing-type)
16175 "Replace LaTeX fragments with links to an image, and produce images.
16176 Some of the options can be changed using the variable
16177 `org-format-latex-options'."
16178 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16179 (let* ((prefixnodir (file-name-nondirectory prefix))
16180 (absprefix (expand-file-name prefix dir))
16181 (todir (file-name-directory absprefix))
16182 (opt org-format-latex-options)
16183 (matchers (plist-get opt :matchers))
16184 (re-list org-latex-regexps)
16185 (org-format-latex-header-extra
16186 (plist-get (org-infile-export-plist) :latex-header-extra))
16187 (cnt 0) txt hash link beg end re e checkdir
16188 executables-checked string
16189 m n block linkfile movefile ov)
16190 ;; Check the different regular expressions
16191 (while (setq e (pop re-list))
16192 (setq m (car e) re (nth 1 e) n (nth 2 e)
16194 (when (member m matchers)
16195 (goto-char (point-min))
16196 (while (re-search-forward re nil t)
16197 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16198 (not (get-text-property (match-beginning n)
16199 'org-protected))
16200 (or (not overlays)
16201 (not (eq (get-char-property (match-beginning n)
16202 'org-overlay-type)
16203 'org-latex-overlay))))
16204 (setq org-export-have-math t)
16205 (cond
16206 ((eq processing-type 'verbatim)
16207 ;; Leave the text verbatim, just protect it
16208 (add-text-properties (match-beginning n) (match-end n)
16209 '(org-protected t)))
16210 ((eq processing-type 'mathjax)
16211 ;; Prepare for MathJax processing
16212 (setq string (match-string n))
16213 (if (member m '("$" "$1"))
16214 (save-excursion
16215 (delete-region (match-beginning n) (match-end n))
16216 (goto-char (match-beginning n))
16219 '(org-protected t))))
16220 (add-text-properties (match-beginning n) (match-end n)
16221 '(org-protected t))))
16222 ((or (eq processing-type 'dvipng) t)
16223 ;; Process to an image
16224 (setq txt (match-string n)
16225 beg (match-beginning n) end (match-end n)
16226 cnt (1+ cnt))
16227 (let (print-length print-level) ; make sure full list is printed
16228 (setq hash (sha1 (prin1-to-string
16229 (list org-format-latex-header
16230 org-format-latex-header-extra
16231 org-export-latex-default-packages-alist
16232 org-export-latex-packages-alist
16233 org-format-latex-options
16234 forbuffer txt)))
16235 linkfile (format "%s_%s.png" prefix hash)
16236 movefile (format "%s_%s.png" absprefix hash)))
16237 (setq link (concat block "[[file:" linkfile "]]" block))
16238 (if msg (message msg cnt))
16239 (goto-char beg)
16240 (unless checkdir ; make sure the directory exists
16241 (setq checkdir t)
16242 (or (file-directory-p todir) (make-directory todir t)))
16244 (unless executables-checked
16245 (org-check-external-command
16246 "latex" "needed to convert LaTeX fragments to images")
16247 (org-check-external-command
16248 "dvipng" "needed to convert LaTeX fragments to images")
16249 (setq executables-checked t))
16251 (unless (file-exists-p movefile)
16252 (org-create-formula-image
16253 txt movefile opt forbuffer))
16254 (if overlays
16255 (progn
16256 (mapc (lambda (o)
16257 (if (eq (overlay-get o 'org-overlay-type)
16258 'org-latex-overlay)
16259 (delete-overlay o)))
16260 (overlays-in beg end))
16261 (setq ov (make-overlay beg end))
16262 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16263 (if (featurep 'xemacs)
16264 (progn
16265 (overlay-put ov 'invisible t)
16266 (overlay-put
16267 ov 'end-glyph
16268 (make-glyph (vector 'png :file movefile))))
16269 (overlay-put
16270 ov 'display
16271 (list 'image :type 'png :file movefile :ascent 'center)))
16272 (push ov org-latex-fragment-image-overlays)
16273 (goto-char end))
16274 (delete-region beg end)
16275 (insert (org-add-props link
16276 (list 'org-latex-src
16277 (replace-regexp-in-string
16280 ;; This function borrows from Ganesh Swami's latex2png.el
16281 (defun org-create-formula-image (string tofile options buffer)
16282 "This calls dvipng."
16283 (require 'org-latex)
16284 (let* ((tmpdir (if (featurep 'xemacs)
16285 (temp-directory)
16286 temporary-file-directory))
16287 (texfilebase (make-temp-name
16288 (expand-file-name "orgtex" tmpdir)))
16289 (texfile (concat texfilebase ".tex"))
16290 (dvifile (concat texfilebase ".dvi"))
16291 (pngfile (concat texfilebase ".png"))
16292 (fnh (if (featurep 'xemacs)
16293 (font-height (get-face-font 'default))
16294 (face-attribute 'default :height nil)))
16295 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16296 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16297 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16298 "Black"))
16299 (bg (or (plist-get options (if buffer :background :html-background))
16300 "Transparent")))
16301 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16302 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16303 (with-temp-file texfile
16304 (insert (org-splice-latex-header
16305 org-format-latex-header
16306 org-export-latex-default-packages-alist
16307 org-export-latex-packages-alist t
16308 org-format-latex-header-extra))
16310 (require 'org-latex)
16311 (org-export-latex-fix-inputenc))
16312 (let ((dir default-directory))
16313 (condition-case nil
16314 (progn
16315 (cd tmpdir)
16316 (call-process "latex" nil nil nil texfile))
16317 (error nil))
16318 (cd dir))
16319 (if (not (file-exists-p dvifile))
16320 (progn (message "Failed to create dvi file from %s" texfile) nil)
16321 (condition-case nil
16322 (call-process "dvipng" nil nil nil
16323 "-fg" fg "-bg" bg
16324 "-D" dpi
16325 ;;"-x" scale "-y" scale
16326 "-T" "tight"
16327 "-o" pngfile
16328 dvifile)
16329 (error nil))
16330 (if (not (file-exists-p pngfile))
16331 (if org-format-latex-signal-error
16332 (error "Failed to create png file from %s" texfile)
16333 (message "Failed to create png file from %s" texfile)
16334 nil)
16335 ;; Use the requested file name and clean up
16336 (copy-file pngfile tofile 'replace)
16337 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16338 (delete-file (concat texfilebase e)))
16339 pngfile))))
16341 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16342 "Fill a LaTeX header template TPL.
16343 In the template, the following place holders will be recognized:
16346 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16348 [NO-PACKAGES] do not include PKG
16349 [EXTRA] the string EXTRA
16350 [NO-EXTRA] do not include EXTRA
16352 For backward compatibility, if both the positive and the negative place
16354 assumed to be present at the end of the template.
16355 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16356 EXTRA is a string.
16357 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16358 (let (rpl (end ""))
16360 (setq rpl (if (or (match-end 1) (not def-pkg))
16361 "" (org-latex-packages-to-string def-pkg snippets-p t))
16362 tpl (replace-match rpl t t tpl))
16363 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16366 (setq rpl (if (or (match-end 1) (not pkg))
16367 "" (org-latex-packages-to-string pkg snippets-p t))
16368 tpl (replace-match rpl t t tpl))
16369 (if pkg (setq end
16371 (org-latex-packages-to-string pkg snippets-p)))))
16374 (setq rpl (if (or (match-end 1) (not extra))
16376 tpl (replace-match rpl t t tpl))
16382 tpl)))
16384 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16386 (setq pkg (mapconcat (lambda(p)
16387 (cond
16388 ((stringp p) p)
16389 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16390 (format "%% Package %s omitted" (cadr p)))
16391 ((equal "" (car p))
16393 (t
16395 (car p) (cadr p)))))
16396 pkg
16400 (defun org-dvipng-color (attr)
16401 "Return an rgb color specification for dvipng."
16402 (apply 'format "rgb %s %s %s"
16403 (mapcar 'org-normalize-color
16404 (color-values (face-attribute 'default attr nil)))))
16406 (defun org-normalize-color (value)
16407 "Return string to be used as color value for an RGB component."
16408 (format "%g" (/ value 65535.0)))
16410 ;; Image display
16413 (defvar org-inline-image-overlays nil)
16414 (make-variable-buffer-local 'org-inline-image-overlays)
16416 (defun org-toggle-inline-images (&optional include-linked)
16417 "Toggle the display of inline images.
16418 INCLUDE-LINKED is passed to `org-display-inline-images'."
16419 (interactive "P")
16420 (if org-inline-image-overlays
16421 (progn
16422 (org-remove-inline-images)
16423 (message "Inline image display turned off"))
16424 (org-display-inline-images include-linked)
16425 (if org-inline-image-overlays
16426 (message "%d images displayed inline"
16427 (length org-inline-image-overlays))
16428 (message "No images to display inline"))))
16430 (defun org-display-inline-images (&optional include-linked refresh beg end)
16431 "Display inline images.
16432 Normally only links without a description part are inlined, because this
16433 is how it will work for export. When INCLUDE-LINKED is set, also links
16434 with a description part will be inlined. This can be nice for a quick
16435 look at those images, but it does not reflect what exported files will look
16436 like.
16437 When REFRESH is set, refresh existing images between BEG and END.
16438 This will create new image displays only if necessary.
16439 BEG and END default to the buffer boundaries."
16440 (interactive "P")
16441 (unless refresh
16442 (org-remove-inline-images)
16443 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16444 (save-excursion
16445 (save-restriction
16446 (widen)
16447 (setq beg (or beg (point-min)) end (or end (point-max)))
16448 (goto-char (point-min))
16450 (substring (org-image-file-name-regexp) 0 -2)
16452 old file ov img)
16453 (while (re-search-forward re end t)
16454 (setq old (get-char-property-and-overlay (match-beginning 1)
16455 'org-image-overlay))
16456 (setq file (expand-file-name
16457 (concat (or (match-string 3) "") (match-string 4))))
16458 (when (file-exists-p file)
16459 (if (and (car-safe old) refresh)
16460 (image-refresh (overlay-get (cdr old) 'display))
16461 (setq img (save-match-data (create-image file)))
16462 (when img
16463 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16464 (overlay-put ov 'display img)
16465 (overlay-put ov 'face 'default)
16466 (overlay-put ov 'org-image-overlay t)
16467 (overlay-put ov 'modification-hooks
16468 (list 'org-display-inline-modification-hook))
16469 (push ov org-inline-image-overlays)))))))))
16471 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16472 "Remove inline-display overlay if a corresponding region is modified."
16473 (let ((inhibit-modification-hooks t))
16474 (when (and ov after)
16475 (delete ov org-inline-image-overlays)
16476 (delete-overlay ov))))
16478 (defun org-remove-inline-images ()
16479 "Remove inline display of images."
16480 (interactive)
16481 (mapc 'delete-overlay org-inline-image-overlays)
16482 (setq org-inline-image-overlays nil))
16484 ;;;; Key bindings
16486 ;; Make `C-c C-x' a prefix key
16487 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16489 ;; TAB key with modifiers
16490 (org-defkey org-mode-map "\C-i" 'org-cycle)
16491 (org-defkey org-mode-map [(tab)] 'org-cycle)
16492 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16493 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16495 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16496 ;; The following line is necessary under Suse GNU/Linux
16497 (unless (featurep 'xemacs)
16498 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16499 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16500 (define-key org-mode-map [backtab] 'org-shifttab)
16502 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16503 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16504 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16506 ;; Cursor keys with modifiers
16507 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16508 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16509 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16510 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16512 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16513 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16514 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16515 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16517 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16518 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16519 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16520 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16522 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16523 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16525 ;; Babel keys
16526 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16527 (mapc (lambda (pair)
16528 (define-key org-babel-map (car pair) (cdr pair)))
16529 org-babel-key-bindings)
16531 ;;; Extra keys for tty access.
16532 ;; We only set them when really needed because otherwise the
16533 ;; menus don't show the simple keys
16535 (when (or org-use-extra-keys
16536 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16537 (not window-system))
16538 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16539 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16540 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16541 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16542 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16543 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16544 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16545 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16546 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16547 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16548 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16549 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16550 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16551 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16552 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16553 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16554 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16555 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16556 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16557 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16558 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16559 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16560 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16561 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16562 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16563 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16564 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16565 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16567 ;; All the other keys
16569 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16570 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16571 (if (boundp 'narrow-map)
16572 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16573 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16574 (if (boundp 'narrow-map)
16575 (org-defkey narrow-map "b" 'org-narrow-to-block)
16576 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16577 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16578 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16579 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16580 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16581 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16582 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16583 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16584 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16585 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16586 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16587 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16588 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16589 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16590 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16591 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16592 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16594 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16595 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16596 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16597 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16598 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16599 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16600 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16601 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16602 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16603 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16604 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16605 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16606 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16607 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16608 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16609 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16610 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16611 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16612 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16614 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16615 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16616 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16617 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16618 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16619 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16620 (org-defkey org-mode-map "\C-c^" 'org-sort)
16621 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16622 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16623 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16624 (org-defkey org-mode-map "\C-m" 'org-return)
16625 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16626 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16627 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16628 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16629 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16630 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16631 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16632 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16633 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16634 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16635 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16636 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16637 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16638 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16639 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16640 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16641 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16642 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16643 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16644 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16645 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16646 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16648 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16649 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16650 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16651 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16653 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16654 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16655 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16656 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16657 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16658 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16659 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16660 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16661 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16662 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16664 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16665 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16666 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16667 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16668 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16669 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16670 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16672 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16673 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16674 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16675 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16676 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16678 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16680 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16682 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16683 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16685 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16688 (when (featurep 'xemacs)
16689 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16692 (defconst org-speed-commands-default
16693 '(
16694 ("Outline Navigation")
16695 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16696 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16697 ("f" . (org-speed-move-safe 'org-forward-same-level))
16698 ("b" . (org-speed-move-safe 'org-backward-same-level))
16699 ("u" . (org-speed-move-safe 'outline-up-heading))
16700 ("j" . org-goto)
16701 ("g" . (org-refile t))
16702 ("Outline Visibility")
16703 ("c" . org-cycle)
16704 ("C" . org-shifttab)
16705 (" " . org-display-outline-path)
16706 ("Outline Structure Editing")
16707 ("U" . org-shiftmetaup)
16708 ("D" . org-shiftmetadown)
16709 ("r" . org-metaright)
16710 ("l" . org-metaleft)
16711 ("R" . org-shiftmetaright)
16712 ("L" . org-shiftmetaleft)
16713 ("i" . (progn (forward-char 1) (call-interactively
16714 'org-insert-heading-respect-content)))
16715 ("^" . org-sort)
16716 ("w" . org-refile)
16717 ("a" . org-archive-subtree-default-with-confirmation)
16718 ("." . org-mark-subtree)
16719 ("Clock Commands")
16720 ("I" . org-clock-in)
16721 ("O" . org-clock-out)
16722 ("Meta Data Editing")
16723 ("t" . org-todo)
16724 ("0" . (org-priority ?\ ))
16725 ("1" . (org-priority ?A))
16726 ("2" . (org-priority ?B))
16727 ("3" . (org-priority ?C))
16728 (";" . org-set-tags-command)
16729 ("e" . org-set-effort)
16730 ("Agenda Views etc")
16731 ("v" . org-agenda)
16732 ("/" . org-sparse-tree)
16733 ("Misc")
16734 ("o" . org-open-at-point)
16735 ("?" . org-speed-command-help)
16736 ("<" . (org-agenda-set-restriction-lock 'subtree))
16737 (">" . (org-agenda-remove-restriction-lock))
16738 )
16739 "The default speed commands.")
16741 (defun org-print-speed-command (e)
16742 (if (> (length (car e)) 1)
16743 (progn
16745 (princ (car e))
16747 (princ (make-string (length (car e)) ?-))
16749 (princ (car e))
16750 (princ " ")
16751 (if (symbolp (cdr e))
16752 (princ (symbol-name (cdr e)))
16753 (prin1 (cdr e)))
16756 (defun org-speed-command-help ()
16757 "Show the available speed commands."
16758 (interactive)
16759 (if (not org-use-speed-commands)
16760 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16761 (with-output-to-temp-buffer "*Help*"
16763 (mapc 'org-print-speed-command org-speed-commands-user)
16766 (mapc 'org-print-speed-command org-speed-commands-default))
16767 (with-current-buffer "*Help*"
16768 (setq truncate-lines t))))
16770 (defun org-speed-move-safe (cmd)
16771 "Execute CMD, but make sure that the cursor always ends up in a headline.
16772 If not, return to the original position and throw an error."
16773 (interactive)
16774 (let ((pos (point)))
16775 (call-interactively cmd)
16776 (unless (and (bolp) (org-on-heading-p))
16777 (goto-char pos)
16778 (error "Boundary reached while executing %s" cmd))))
16780 (defvar org-self-insert-command-undo-counter 0)
16782 (defvar org-table-auto-blank-field) ; defined in org-table.el
16783 (defvar org-speed-command nil)
16785 (defun org-speed-command-default-hook (keys)
16786 "Hook for activating single-letter speed commands.
16787 `org-speed-commands-default' specifies a minimal command set. Use
16788 `org-speed-commands-user' for further customization."
16789 (when (or (and (bolp) (looking-at outline-regexp))
16790 (and (functionp org-use-speed-commands)
16791 (funcall org-use-speed-commands)))
16792 (cdr (assoc keys (append org-speed-commands-user
16793 org-speed-commands-default)))))
16795 (defun org-babel-speed-command-hook (keys)
16796 "Hook for activating single-letter code block commands."
16797 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16798 (cdr (assoc keys org-babel-key-bindings))))
16800 (defcustom org-speed-command-hook
16801 '(org-speed-command-default-hook org-babel-speed-command-hook)
16802 "Hook for activating speed commands at strategic locations.
16803 Hook functions are called in sequence until a valid handler is
16804 found.
16806 Each hook takes a single argument, a user-pressed command key
16807 which is also a `self-insert-command' from the global map.
16809 Within the hook, examine the cursor position and the command key
16810 and return nil or a valid handler as appropriate. Handler could
16811 be one of an interactive command, a function, or a form.
16813 Set `org-use-speed-commands' to non-nil value to enable this
16814 hook. The default setting is `org-speed-command-default-hook'."
16815 :group 'org-structure
16816 :type 'hook)
16818 (defun org-self-insert-command (N)
16819 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16820 If the cursor is in a table looking at whitespace, the whitespace is
16821 overwritten, and the table is not marked as requiring realignment."
16822 (interactive "p")
16823 (cond
16824 ((and org-use-speed-commands
16825 (setq org-speed-command
16826 (run-hook-with-args-until-success
16827 'org-speed-command-hook (this-command-keys))))
16828 (cond
16829 ((commandp org-speed-command)
16830 (setq this-command org-speed-command)
16831 (call-interactively org-speed-command))
16832 ((functionp org-speed-command)
16833 (funcall org-speed-command))
16834 ((and org-speed-command (listp org-speed-command))
16835 (eval org-speed-command))
16836 (t (let (org-use-speed-commands)
16837 (call-interactively 'org-self-insert-command)))))
16838 ((and
16839 (org-table-p)
16840 (progn
16841 ;; check if we blank the field, and if that triggers align
16842 (and (featurep 'org-table) org-table-auto-blank-field
16843 (member last-command
16844 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16846 ;; got extra space, this field does not determine column width
16847 (let (org-table-may-need-update) (org-table-blank-field))
16848 ;; no extra space, this field may determine column width
16849 (org-table-blank-field)))
16850 t)
16851 (eq N 1)
16853 (let (org-table-may-need-update)
16854 (goto-char (1- (match-end 0)))
16855 (delete-backward-char 1)
16856 (goto-char (match-beginning 0))
16857 (self-insert-command N)))
16858 (t
16859 (setq org-table-may-need-update t)
16860 (self-insert-command N)
16861 (org-fix-tags-on-the-fly)
16862 (if org-self-insert-cluster-for-undo
16863 (if (not (eq last-command 'org-self-insert-command))
16864 (setq org-self-insert-command-undo-counter 1)
16865 (if (>= org-self-insert-command-undo-counter 20)
16866 (setq org-self-insert-command-undo-counter 1)
16867 (and (> org-self-insert-command-undo-counter 0)
16868 buffer-undo-list
16869 (not (cadr buffer-undo-list)) ; remove nil entry
16870 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16871 (setq org-self-insert-command-undo-counter
16872 (1+ org-self-insert-command-undo-counter))))))))
16874 (defun org-fix-tags-on-the-fly ()
16875 (when (and (equal (char-after (point-at-bol)) ?*)
16876 (org-on-heading-p))
16877 (org-align-tags-here org-tags-column)))
16879 (defun org-delete-backward-char (N)
16880 "Like `delete-backward-char', insert whitespace at field end in tables.
16881 When deleting backwards, in tables this function will insert whitespace in
16883 still be marked for re-alignment if the field did fill the entire column,
16884 because, in this case the deletion might narrow the column."
16885 (interactive "p")
16886 (if (and (org-table-p)
16887 (eq N 1)
16888 (string-match "|" (buffer-substring (point-at-bol) (point)))
16889 (looking-at ".*?|"))
16890 (let ((pos (point))
16892 (c org-table-may-need-update))
16893 (backward-delete-char N)
16894 (if (not overwrite-mode)
16895 (progn
16896 (skip-chars-forward "^|")
16897 (insert " ")
16898 (goto-char (1- pos))))
16899 ;; noalign: if there were two spaces at the end, this field
16900 ;; does not determine the width of the column.
16901 (if noalign (setq org-table-may-need-update c)))
16902 (backward-delete-char N)
16903 (org-fix-tags-on-the-fly)))
16905 (defun org-delete-char (N)
16906 "Like `delete-char', but insert whitespace at field end in tables.
16907 When deleting characters, in tables this function will insert whitespace in
16909 still be marked for re-alignment if the field did fill the entire column,
16910 because, in this case the deletion might narrow the column."
16911 (interactive "p")
16912 (if (and (org-table-p)
16913 (not (bolp))
16914 (not (= (char-after) ?|))
16915 (eq N 1))
16916 (if (looking-at ".*?|")
16917 (let ((pos (point))
16919 (c org-table-may-need-update))
16920 (replace-match (concat
16921 (substring (match-string 0) 1 -1)
16922 " |"))
16923 (goto-char pos)
16924 ;; noalign: if there were two spaces at the end, this field
16925 ;; does not determine the width of the column.
16926 (if noalign (setq org-table-may-need-update c)))
16927 (delete-char N))
16928 (delete-char N)
16929 (org-fix-tags-on-the-fly)))
16931 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16932 (put 'org-self-insert-command 'delete-selection t)
16933 (put 'orgtbl-self-insert-command 'delete-selection t)
16934 (put 'org-delete-char 'delete-selection 'supersede)
16935 (put 'org-delete-backward-char 'delete-selection 'supersede)
16936 (put 'org-yank 'delete-selection 'yank)
16938 ;; Make `flyspell-mode' delay after some commands
16939 (put 'org-self-insert-command 'flyspell-delayed t)
16940 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16941 (put 'org-delete-char 'flyspell-delayed t)
16942 (put 'org-delete-backward-char 'flyspell-delayed t)
16944 ;; Make pabbrev-mode expand after org-mode commands
16945 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16946 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16948 ;; How to do this: Measure non-white length of current string
16949 ;; If equal to column width, we should realign.
16951 (defun org-remap (map &rest commands)
16952 "In MAP, remap the functions given in COMMANDS.
16953 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16954 (let (new old)
16955 (while commands
16956 (setq old (pop commands) new (pop commands))
16957 (if (fboundp 'command-remapping)
16958 (org-defkey map (vector 'remap old) new)
16959 (substitute-key-definition old new map global-map)))))
16961 (when (eq org-enable-table-editor 'optimized)
16962 ;; If the user wants maximum table support, we need to hijack
16963 ;; some standard editing functions
16964 (org-remap org-mode-map
16965 'self-insert-command 'org-self-insert-command
16966 'delete-char 'org-delete-char
16967 'delete-backward-char 'org-delete-backward-char)
16968 (org-defkey org-mode-map "|" 'org-force-self-insert))
16970 (defvar org-ctrl-c-ctrl-c-hook nil
16971 "Hook for functions attaching themselves to `C-c C-c'.
16972 This can be used to add additional functionality to the C-c C-c key which
16973 executes context-dependent commands.
16974 Each function will be called with no arguments. The function must check
16975 if the context is appropriate for it to act. If yes, it should do its
16976 thing and then return a non-nil value. If the context is wrong,
16977 just do nothing and return nil.")
16979 (defvar org-tab-first-hook nil
16980 "Hook for functions to attach themselves to TAB.
16981 See `org-ctrl-c-ctrl-c-hook' for more information.
16982 This hook runs as the first action when TAB is pressed, even before
16983 `org-cycle' messes around with the `outline-regexp' to cater for
16984 inline tasks and plain list item folding.
16985 If any function in this hook returns t, any other actions that
16986 would have been caused by TAB (such as table field motion or visibility
16987 cycling) will not occur.")
16989 (defvar org-tab-after-check-for-table-hook nil
16990 "Hook for functions to attach themselves to TAB.
16991 See `org-ctrl-c-ctrl-c-hook' for more information.
16992 This hook runs after it has been established that the cursor is not in a
16993 table, but before checking if the cursor is in a headline or if global cycling
16994 should be done.
16995 If any function in this hook returns t, not other actions like visibility
16996 cycling will be done.")
16998 (defvar org-tab-after-check-for-cycling-hook nil
16999 "Hook for functions to attach themselves to TAB.
17000 See `org-ctrl-c-ctrl-c-hook' for more information.
17001 This hook runs after it has been established that not table field motion and
17002 not visibility should be done because of current context. This is probably
17003 the place where a package like yasnippets can hook in.")
17005 (defvar org-tab-before-tab-emulation-hook nil
17006 "Hook for functions to attach themselves to TAB.
17007 See `org-ctrl-c-ctrl-c-hook' for more information.
17008 This hook runs after every other options for TAB have been exhausted, but
17011 (defvar org-metaleft-hook nil
17012 "Hook for functions attaching themselves to `M-left'.
17013 See `org-ctrl-c-ctrl-c-hook' for more information.")
17014 (defvar org-metaright-hook nil
17015 "Hook for functions attaching themselves to `M-right'.
17016 See `org-ctrl-c-ctrl-c-hook' for more information.")
17017 (defvar org-metaup-hook nil
17018 "Hook for functions attaching themselves to `M-up'.
17019 See `org-ctrl-c-ctrl-c-hook' for more information.")
17020 (defvar org-metadown-hook nil
17021 "Hook for functions attaching themselves to `M-down'.
17022 See `org-ctrl-c-ctrl-c-hook' for more information.")
17023 (defvar org-shiftmetaleft-hook nil
17024 "Hook for functions attaching themselves to `M-S-left'.
17025 See `org-ctrl-c-ctrl-c-hook' for more information.")
17026 (defvar org-shiftmetaright-hook nil
17027 "Hook for functions attaching themselves to `M-S-right'.
17028 See `org-ctrl-c-ctrl-c-hook' for more information.")
17029 (defvar org-shiftmetaup-hook nil
17030 "Hook for functions attaching themselves to `M-S-up'.
17031 See `org-ctrl-c-ctrl-c-hook' for more information.")
17032 (defvar org-shiftmetadown-hook nil
17033 "Hook for functions attaching themselves to `M-S-down'.
17034 See `org-ctrl-c-ctrl-c-hook' for more information.")
17035 (defvar org-metareturn-hook nil
17036 "Hook for functions attaching themselves to `M-RET'.
17037 See `org-ctrl-c-ctrl-c-hook' for more information.")
17038 (defvar org-shiftup-hook nil
17039 "Hook for functions attaching themselves to `S-up'.
17040 See `org-ctrl-c-ctrl-c-hook' for more information.")
17041 (defvar org-shiftup-final-hook nil
17042 "Hook for functions attaching themselves to `S-up'.
17043 This one runs after all other options except shift-select have been excluded.
17044 See `org-ctrl-c-ctrl-c-hook' for more information.")
17045 (defvar org-shiftdown-hook nil
17046 "Hook for functions attaching themselves to `S-down'.
17047 See `org-ctrl-c-ctrl-c-hook' for more information.")
17048 (defvar org-shiftdown-final-hook nil
17049 "Hook for functions attaching themselves to `S-down'.
17050 This one runs after all other options except shift-select have been excluded.
17051 See `org-ctrl-c-ctrl-c-hook' for more information.")
17052 (defvar org-shiftleft-hook nil
17053 "Hook for functions attaching themselves to `S-left'.
17054 See `org-ctrl-c-ctrl-c-hook' for more information.")
17055 (defvar org-shiftleft-final-hook nil
17056 "Hook for functions attaching themselves to `S-left'.
17057 This one runs after all other options except shift-select have been excluded.
17058 See `org-ctrl-c-ctrl-c-hook' for more information.")
17059 (defvar org-shiftright-hook nil
17060 "Hook for functions attaching themselves to `S-right'.
17061 See `org-ctrl-c-ctrl-c-hook' for more information.")
17062 (defvar org-shiftright-final-hook nil
17063 "Hook for functions attaching themselves to `S-right'.
17064 This one runs after all other options except shift-select have been excluded.
17065 See `org-ctrl-c-ctrl-c-hook' for more information.")
17067 (defun org-modifier-cursor-error ()
17068 "Throw an error, a modified cursor command was applied in wrong context."
17069 (error "This command is active in special context like tables, headlines or items"))
17071 (defun org-shiftselect-error ()
17072 "Throw an error because Shift-Cursor command was applied in wrong context."
17073 (if (and (boundp 'shift-select-mode) shift-select-mode)
17074 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17075 (error "This command works only in special context like headlines or timestamps")))
17077 (defun org-call-for-shift-select (cmd)
17078 (let ((this-command-keys-shift-translated t))
17079 (call-interactively cmd)))
17081 (defun org-shifttab (&optional arg)
17082 "Global visibility cycling or move to previous table field.
17083 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17084 on context.
17085 See the individual commands for more information."
17086 (interactive "P")
17087 (cond
17088 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17089 ((integerp arg)
17090 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17091 (message "Content view to level: %d" arg)
17092 (org-content (prefix-numeric-value arg2))
17093 (setq org-cycle-global-status 'overview)))
17094 (t (call-interactively 'org-global-cycle))))
17096 (defun org-shiftmetaleft ()
17097 "Promote subtree or delete table column.
17098 Calls `org-promote-subtree', `org-outdent-item',
17099 or `org-table-delete-column', depending on context.
17100 See the individual commands for more information."
17101 (interactive)
17102 (cond
17103 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17104 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17105 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17106 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17107 (t (org-modifier-cursor-error))))
17109 (defun org-shiftmetaright ()
17110 "Demote subtree or insert table column.
17111 Calls `org-demote-subtree', `org-indent-item',
17112 or `org-table-insert-column', depending on context.
17113 See the individual commands for more information."
17114 (interactive)
17115 (cond
17116 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17117 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17118 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17119 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17120 (t (org-modifier-cursor-error))))
17122 (defun org-shiftmetaup (&optional arg)
17123 "Move subtree up or kill table row.
17124 Calls `org-move-subtree-up' or `org-table-kill-row' or
17125 `org-move-item-up' depending on context. See the individual commands
17126 for more information."
17127 (interactive "P")
17128 (cond
17129 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17130 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17131 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17132 ((org-at-item-p) (call-interactively 'org-move-item-up))
17133 (t (org-modifier-cursor-error))))
17135 (defun org-shiftmetadown (&optional arg)
17136 "Move subtree down or insert table row.
17137 Calls `org-move-subtree-down' or `org-table-insert-row' or
17138 `org-move-item-down', depending on context. See the individual
17139 commands for more information."
17140 (interactive "P")
17141 (cond
17142 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17143 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17144 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17145 ((org-at-item-p) (call-interactively 'org-move-item-down))
17146 (t (org-modifier-cursor-error))))
17148 (defsubst org-hidden-tree-error ()
17149 (error
17150 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17152 (defun org-metaleft (&optional arg)
17153 "Promote heading or move table column to left.
17154 Calls `org-do-promote' or `org-table-move-column', depending on context.
17155 With no specific context, calls the Emacs default `backward-word'.
17156 See the individual commands for more information."
17157 (interactive "P")
17158 (cond
17159 ((run-hook-with-args-until-success 'org-metaleft-hook))
17160 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17161 ((org-with-limited-levels
17162 (or (org-on-heading-p)
17163 (and (org-region-active-p)
17164 (save-excursion
17165 (goto-char (region-beginning))
17166 (org-on-heading-p)))))
17167 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17168 (call-interactively 'org-do-promote))
17169 ;; At an inline task.
17170 ((org-on-heading-p)
17171 (call-interactively 'org-inlinetask-promote))
17172 ((or (org-at-item-p)
17173 (and (org-region-active-p)
17174 (save-excursion
17175 (goto-char (region-beginning))
17176 (org-at-item-p))))
17177 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17178 (call-interactively 'org-outdent-item))
17179 (t (call-interactively 'backward-word))))
17181 (defun org-metaright (&optional arg)
17182 "Demote subtree or move table column to right.
17183 Calls `org-do-demote' or `org-table-move-column', depending on context.
17184 With no specific context, calls the Emacs default `forward-word'.
17185 See the individual commands for more information."
17186 (interactive "P")
17187 (cond
17188 ((run-hook-with-args-until-success 'org-metaright-hook))
17189 ((org-at-table-p) (call-interactively 'org-table-move-column))
17190 ((org-with-limited-levels
17191 (or (org-on-heading-p)
17192 (and (org-region-active-p)
17193 (save-excursion
17194 (goto-char (region-beginning))
17195 (org-on-heading-p)))))
17196 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17197 (call-interactively 'org-do-demote))
17198 ;; At an inline task.
17199 ((org-on-heading-p)
17200 (call-interactively 'org-inlinetask-demote))
17201 ((or (org-at-item-p)
17202 (and (org-region-active-p)
17203 (save-excursion
17204 (goto-char (region-beginning))
17205 (org-at-item-p))))
17206 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17207 (call-interactively 'org-indent-item))
17208 (t (call-interactively 'forward-word))))
17210 (defun org-check-for-hidden (what)
17211 "Check if there are hidden headlines/items in the current visual line.
17212 WHAT can be either `headlines' or `items'. If the current line is
17213 an outline or item heading and it has a folded subtree below it,
17214 this function returns t, nil otherwise."
17215 (let ((re (cond
17216 ((eq what 'headlines) (concat "^" org-outline-regexp))
17217 ((eq what 'items) (org-item-beginning-re))
17218 (t (error "This should not happen"))))
17219 beg end)
17220 (save-excursion
17221 (catch 'exit
17222 (unless (org-region-active-p)
17223 (setq beg (point-at-bol))
17224 (beginning-of-line 2)
17225 (while (and (not (eobp)) ;; this is like `next-line'
17226 (get-char-property (1- (point)) 'invisible))
17227 (beginning-of-line 2))
17228 (setq end (point))
17229 (goto-char beg)
17230 (goto-char (point-at-eol))
17231 (setq end (max end (point)))
17232 (while (re-search-forward re end t)
17233 (if (get-char-property (match-beginning 0) 'invisible)
17234 (throw 'exit t))))
17235 nil))))
17237 (defun org-metaup (&optional arg)
17238 "Move subtree up or move table row up.
17239 Calls `org-move-subtree-up' or `org-table-move-row' or
17240 `org-move-item-up', depending on context. See the individual commands
17241 for more information."
17242 (interactive "P")
17243 (cond
17244 ((run-hook-with-args-until-success 'org-metaup-hook))
17245 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17246 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17247 ((org-at-item-p) (call-interactively 'org-move-item-up))
17248 (t (transpose-lines 1) (beginning-of-line -1))))
17250 (defun org-metadown (&optional arg)
17251 "Move subtree down or move table row down.
17252 Calls `org-move-subtree-down' or `org-table-move-row' or
17253 `org-move-item-down', depending on context. See the individual
17254 commands for more information."
17255 (interactive "P")
17256 (cond
17257 ((run-hook-with-args-until-success 'org-metadown-hook))
17258 ((org-at-table-p) (call-interactively 'org-table-move-row))
17259 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17260 ((org-at-item-p) (call-interactively 'org-move-item-down))
17261 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17263 (defun org-shiftup (&optional arg)
17264 "Increase item in timestamp or increase priority of current headline.
17265 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17266 depending on context. See the individual commands for more information."
17267 (interactive "P")
17268 (cond
17269 ((run-hook-with-args-until-success 'org-shiftup-hook))
17270 ((and org-support-shift-select (org-region-active-p))
17271 (org-call-for-shift-select 'previous-line))
17272 ((org-at-timestamp-p t)
17273 (call-interactively (if org-edit-timestamp-down-means-later
17274 'org-timestamp-down 'org-timestamp-up)))
17275 ((and (not (eq org-support-shift-select 'always))
17276 org-enable-priority-commands
17277 (org-on-heading-p))
17278 (call-interactively 'org-priority-up))
17279 ((and (not org-support-shift-select) (org-at-item-p))
17280 (call-interactively 'org-previous-item))
17281 ((org-clocktable-try-shift 'up arg))
17282 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17283 (org-support-shift-select
17284 (org-call-for-shift-select 'previous-line))
17285 (t (org-shiftselect-error))))
17287 (defun org-shiftdown (&optional arg)
17288 "Decrease item in timestamp or decrease priority of current headline.
17289 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17290 depending on context. See the individual commands for more information."
17291 (interactive "P")
17292 (cond
17293 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17294 ((and org-support-shift-select (org-region-active-p))
17295 (org-call-for-shift-select 'next-line))
17296 ((org-at-timestamp-p t)
17297 (call-interactively (if org-edit-timestamp-down-means-later
17298 'org-timestamp-up 'org-timestamp-down)))
17299 ((and (not (eq org-support-shift-select 'always))
17300 org-enable-priority-commands
17301 (org-on-heading-p))
17302 (call-interactively 'org-priority-down))
17303 ((and (not org-support-shift-select) (org-at-item-p))
17304 (call-interactively 'org-next-item))
17305 ((org-clocktable-try-shift 'down arg))
17306 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17307 (org-support-shift-select
17308 (org-call-for-shift-select 'next-line))
17309 (t (org-shiftselect-error))))
17311 (defun org-shiftright (&optional arg)
17312 "Cycle the thing at point or in the current line, depending on context.
17313 Depending on context, this does one of the following:
17315 - switch a timestamp at point one day into the future
17316 - on a headline, switch to the next TODO keyword.
17317 - on an item, switch entire list to the next bullet type
17318 - on a property line, switch to the next allowed value
17319 - on a clocktable definition line, move time block into the future"
17320 (interactive "P")
17321 (cond
17322 ((run-hook-with-args-until-success 'org-shiftright-hook))
17323 ((and org-support-shift-select (org-region-active-p))
17324 (org-call-for-shift-select 'forward-char))
17325 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17326 ((and (not (eq org-support-shift-select 'always))
17327 (org-on-heading-p))
17328 (let ((org-inhibit-logging
17329 (not org-treat-S-cursor-todo-selection-as-state-change))
17330 (org-inhibit-blocking
17331 (not org-treat-S-cursor-todo-selection-as-state-change)))
17332 (org-call-with-arg 'org-todo 'right)))
17333 ((or (and org-support-shift-select
17334 (not (eq org-support-shift-select 'always))
17335 (org-at-item-bullet-p))
17336 (and (not org-support-shift-select) (org-at-item-p)))
17337 (org-call-with-arg 'org-cycle-list-bullet nil))
17338 ((and (not (eq org-support-shift-select 'always))
17339 (org-at-property-p))
17340 (call-interactively 'org-property-next-allowed-value))
17341 ((org-clocktable-try-shift 'right arg))
17342 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17343 (org-support-shift-select
17344 (org-call-for-shift-select 'forward-char))
17345 (t (org-shiftselect-error))))
17347 (defun org-shiftleft (&optional arg)
17348 "Cycle the thing at point or in the current line, depending on context.
17349 Depending on context, this does one of the following:
17351 - switch a timestamp at point one day into the past
17352 - on a headline, switch to the previous TODO keyword.
17353 - on an item, switch entire list to the previous bullet type
17354 - on a property line, switch to the previous allowed value
17355 - on a clocktable definition line, move time block into the past"
17356 (interactive "P")
17357 (cond
17358 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17359 ((and org-support-shift-select (org-region-active-p))
17360 (org-call-for-shift-select 'backward-char))
17361 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17362 ((and (not (eq org-support-shift-select 'always))
17363 (org-on-heading-p))
17364 (let ((org-inhibit-logging
17365 (not org-treat-S-cursor-todo-selection-as-state-change))
17366 (org-inhibit-blocking
17367 (not org-treat-S-cursor-todo-selection-as-state-change)))
17368 (org-call-with-arg 'org-todo 'left)))
17369 ((or (and org-support-shift-select
17370 (not (eq org-support-shift-select 'always))
17371 (org-at-item-bullet-p))
17372 (and (not org-support-shift-select) (org-at-item-p)))
17373 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17374 ((and (not (eq org-support-shift-select 'always))
17375 (org-at-property-p))
17376 (call-interactively 'org-property-previous-allowed-value))
17377 ((org-clocktable-try-shift 'left arg))
17378 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17379 (org-support-shift-select
17380 (org-call-for-shift-select 'backward-char))
17381 (t (org-shiftselect-error))))
17383 (defun org-shiftcontrolright ()
17384 "Switch to next TODO set."
17385 (interactive)
17386 (cond
17387 ((and org-support-shift-select (org-region-active-p))
17388 (org-call-for-shift-select 'forward-word))
17389 ((and (not (eq org-support-shift-select 'always))
17390 (org-on-heading-p))
17391 (org-call-with-arg 'org-todo 'nextset))
17392 (org-support-shift-select
17393 (org-call-for-shift-select 'forward-word))
17394 (t (org-shiftselect-error))))
17396 (defun org-shiftcontrolleft ()
17397 "Switch to previous TODO set."
17398 (interactive)
17399 (cond
17400 ((and org-support-shift-select (org-region-active-p))
17401 (org-call-for-shift-select 'backward-word))
17402 ((and (not (eq org-support-shift-select 'always))
17403 (org-on-heading-p))
17404 (org-call-with-arg 'org-todo 'previousset))
17405 (org-support-shift-select
17406 (org-call-for-shift-select 'backward-word))
17407 (t (org-shiftselect-error))))
17409 (defun org-ctrl-c-ret ()
17410 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17411 (interactive)
17412 (cond
17413 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17414 (t (call-interactively 'org-insert-heading))))
17416 (defun org-copy-special ()
17417 "Copy region in table or copy current subtree.
17418 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17419 See the individual commands for more information."
17420 (interactive)
17421 (call-interactively
17422 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17424 (defun org-cut-special ()
17425 "Cut region in table or cut current subtree.
17426 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17427 See the individual commands for more information."
17428 (interactive)
17429 (call-interactively
17430 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17432 (defun org-paste-special (arg)
17433 "Paste rectangular region into table, or past subtree relative to level.
17434 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17435 See the individual commands for more information."
17436 (interactive "P")
17437 (if (org-at-table-p)
17438 (org-table-paste-rectangle)
17439 (org-paste-subtree arg)))
17441 (defun org-edit-special (&optional arg)
17442 "Call a special editor for the stuff at point.
17443 When at a table, call the formula editor with `org-table-edit-formulas'.
17444 When at the first line of an src example, call `org-edit-src-code'.
17445 When in an #+include line, visit the include file. Otherwise call
17446 `ffap' to visit the file at point."
17447 (interactive)
17448 ;; possibly prep session before editing source
17449 (when arg
17450 (let* ((info (org-babel-get-src-block-info))
17451 (lang (nth 0 info))
17452 (params (nth 2 info))
17453 (session (cdr (assoc :session params))))
17454 (when (and info session) ;; we are in a source-code block with a session
17455 (funcall
17456 (intern (concat "org-babel-prep-session:" lang)) session params))))
17457 (cond ;; proceed with `org-edit-special'
17458 ((save-excursion
17459 (beginning-of-line 1)
17460 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17461 (find-file (org-trim (match-string 1))))
17462 ((org-edit-src-code))
17463 ((org-edit-fixed-width-region))
17464 ((org-at-table.el-p)
17465 (org-edit-src-code))
17466 ((or (org-at-table-p)
17467 (save-excursion
17468 (beginning-of-line 1)
17470 (call-interactively 'org-table-edit-formulas))
17471 (t (call-interactively 'ffap))))
17473 (defun org-ctrl-c-ctrl-c (&optional arg)
17474 "Set tags in headline, or update according to changed information at point.
17476 This command does many different things, depending on context:
17478 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17479 this is what we do.
17481 - If the cursor is on a statistics cookie, update it.
17483 - If the cursor is in a headline, prompt for tags and insert them
17484 into the current line, aligned to `org-tags-column'. When called
17485 with prefix arg, realign all tags in the current buffer.
17487 - If the cursor is in one of the special #+KEYWORD lines, this
17488 triggers scanning the buffer for these lines and updating the
17489 information.
17491 - If the cursor is inside a table, realign the table. This command
17492 works even if the automatic table editor has been turned off.
17494 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17495 the entire table.
17497 - If the cursor is at a footnote reference or definition, jump to
17498 the corresponding definition or references, respectively.
17500 - If the cursor is a the beginning of a dynamic block, update it.
17502 - If the current buffer is a capture buffer, close note and file it.
17504 - If the cursor is on a <<<target>>>, update radio targets and
17505 corresponding links in this buffer.
17507 - If the cursor is on a numbered item in a plain list, renumber the
17508 ordered list.
17510 - If the cursor is on a checkbox, toggle it.
17512 - If the cursor is on a code block, evaluate it. The variable
17513 `org-confirm-babel-evaluate' can be used to control prompting
17514 before code block evaluation, by default every code block
17515 evaluation requires confirmation. Code block evaluation can be
17516 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17517 (interactive "P")
17518 (let ((org-enable-table-editor t))
17519 (cond
17520 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17521 org-occur-highlights
17522 org-latex-fragment-image-overlays)
17523 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17524 (org-remove-occur-highlights)
17525 (org-remove-latex-fragment-image-overlays)
17526 (message "Temporary highlights/overlays removed from current buffer"))
17527 ((and (local-variable-p 'org-finish-function (current-buffer))
17528 (fboundp org-finish-function))
17529 (funcall org-finish-function))
17530 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17531 ((or (looking-at org-property-start-re)
17532 (org-at-property-p))
17533 (call-interactively 'org-property-action))
17534 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17536 (or (org-on-heading-p) (org-at-item-p)))
17537 (call-interactively 'org-update-statistics-cookies))
17538 ((org-on-heading-p) (call-interactively 'org-set-tags))
17539 ((org-at-table.el-p)
17540 (message "Use C-c ' to edit table.el tables"))
17541 ((org-at-table-p)
17542 (org-table-maybe-eval-formula)
17543 (if arg
17544 (call-interactively 'org-table-recalculate)
17545 (org-table-maybe-recalculate-line))
17546 (call-interactively 'org-table-align)
17547 (orgtbl-send-table 'maybe))
17548 ((or (org-footnote-at-reference-p)
17549 (org-footnote-at-definition-p))
17550 (call-interactively 'org-footnote-action))
17551 ((org-at-item-checkbox-p)
17552 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17553 ;; list only if at top item.
17554 (let* ((cbox (match-string 1))
17555 (struct (org-list-struct))
17556 (old-struct (copy-tree struct))
17557 (parents (org-list-parents-alist struct))
17558 (prevs (org-list-prevs-alist struct))
17559 (orderedp (org-entry-get nil "ORDERED"))
17560 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17561 block-item)
17562 ;; Use a light version of `org-toggle-checkbox' to avoid
17563 ;; computing list structure twice.
17564 (org-list-set-checkbox (point-at-bol) struct
17565 (cond
17566 ((equal arg '(16)) "[-]")
17567 ((equal arg '(4)) nil)
17568 ((equal "[X]" cbox) "[ ]")
17569 (t "[X]")))
17570 (org-list-struct-fix-ind struct parents)
17571 (org-list-struct-fix-bul struct prevs)
17572 (setq block-item
17573 (org-list-struct-fix-box struct parents prevs orderedp))
17574 (when block-item
17575 (message
17576 "Checkboxes were removed due to unchecked box at line %d"
17577 (org-current-line block-item)))
17578 (org-list-struct-apply-struct struct old-struct)
17579 (org-update-checkbox-count-maybe)
17580 (when firstp (org-list-send-list 'maybe))))
17581 ((org-at-item-p)
17582 ;; Cursor at an item: repair list. Do checkbox related actions
17583 ;; only if function was called with an argument. Send list only
17584 ;; if at top item.
17585 (let* ((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 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17590 (org-list-struct-fix-ind struct parents)
17591 (org-list-struct-fix-bul struct prevs)
17592 (when arg
17593 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17594 (org-list-struct-fix-box struct parents prevs))
17595 (org-list-struct-apply-struct struct old-struct)
17596 (when arg (org-update-checkbox-count-maybe))
17597 (when firstp (org-list-send-list 'maybe))))
17598 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17599 ;; Dynamic block
17600 (beginning-of-line 1)
17601 (save-excursion (org-update-dblock)))
17602 ((save-excursion
17603 (beginning-of-line 1)
17605 (cond
17606 ((equal (match-string 1) "TBLFM")
17607 ;; Recalculate the table before this line
17608 (save-excursion
17609 (beginning-of-line 1)
17611 (if (org-at-table-p)
17612 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17613 (t
17614 (let ((org-inhibit-startup-visibility-stuff t)
17615 (org-startup-align-all-tables nil))
17616 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17617 (message "Local setup has been refreshed"))))
17618 ((org-clock-update-time-maybe))
17619 (t (error "C-c C-c can do nothing useful at this location")))))
17621 (defun org-mode-restart ()
17622 "Restart Org-mode, to scan again for special lines.
17623 Also updates the keyword regular expressions."
17624 (interactive)
17625 (org-mode)
17626 (message "Org-mode restarted"))
17628 (defun org-kill-note-or-show-branches ()
17629 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17630 (interactive)
17631 (if (not org-finish-function)
17632 (progn
17633 (hide-subtree)
17634 (call-interactively 'show-branches))
17635 (let ((org-note-abort t))
17636 (funcall org-finish-function))))
17638 (defun org-return (&optional indent)
17639 "Goto next table row or insert a newline.
17640 Calls `org-table-next-row' or `newline', depending on context.
17641 See the individual commands for more information."
17642 (interactive)
17643 (cond
17644 ((bobp) (if indent (newline-and-indent) (newline)))
17645 ((org-at-table-p)
17646 (org-table-justify-field-maybe)
17647 (call-interactively 'org-table-next-row))
17648 ;; when `newline-and-indent' is called within a list, make sure
17649 ;; text moved stays inside the item.
17650 ((and (org-in-item-p) indent)
17651 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17652 (progn
17653 (newline)
17654 (org-indent-line-to (length (match-string 0))))
17655 (let ((ind (org-get-indentation)))
17656 (newline)
17657 (if (org-looking-back org-list-end-re)
17658 (org-indent-line-function)
17659 (org-indent-line-to ind)))))
17660 ((and org-return-follows-link
17661 (eq (get-text-property (point) 'face) 'org-link))
17662 (call-interactively 'org-open-at-point))
17663 ((and (org-at-heading-p)
17664 (looking-at
17666 (org-show-entry)
17667 (end-of-line 1)
17668 (newline))
17669 (t (if indent (newline-and-indent) (newline)))))
17671 (defun org-return-indent ()
17672 "Goto next table row or insert a newline and indent.
17673 Calls `org-table-next-row' or `newline-and-indent', depending on
17674 context. See the individual commands for more information."
17675 (interactive)
17676 (org-return t))
17678 (defun org-ctrl-c-star ()
17679 "Compute table, or change heading status of lines.
17680 Calls `org-table-recalculate' or `org-toggle-heading',
17681 depending on context."
17682 (interactive)
17683 (cond
17684 ((org-at-table-p)
17685 (call-interactively 'org-table-recalculate))
17686 (t
17687 ;; Convert all lines in region to list items
17688 (call-interactively 'org-toggle-heading))))
17690 (defun org-ctrl-c-minus ()
17691 "Insert separator line in table or modify bullet status of line.
17692 Also turns a plain line or a region of lines into list items.
17693 Calls `org-table-insert-hline', `org-toggle-item', or
17694 `org-cycle-list-bullet', depending on context."
17695 (interactive)
17696 (cond
17697 ((org-at-table-p)
17698 (call-interactively 'org-table-insert-hline))
17699 ((org-region-active-p)
17700 (call-interactively 'org-toggle-item))
17701 ((org-in-item-p)
17702 (call-interactively 'org-cycle-list-bullet))
17703 (t
17704 (call-interactively 'org-toggle-item))))
17706 (defun org-toggle-item (arg)
17707 "Convert headings or normal lines to items, items to normal lines.
17708 If there is no active region, only the current line is considered.
17710 If the first non blank line in the region is an headline, convert
17711 all headlines to items.
17713 If it is an item, convert all items to normal lines.
17715 If it is normal text, change region into an item. With a prefix
17716 argument ARG, change each line in region into an item."
17717 (interactive "P")
17718 (let (l2 l beg end)
17719 (if (org-region-active-p)
17720 (setq beg (region-beginning) end (region-end))
17721 (setq beg (point-at-bol)
17722 end (min (1+ (point-at-eol)) (point-max))))
17723 (org-with-limited-levels
17724 (save-excursion
17725 (goto-char end)
17726 (setq l2 (org-current-line))
17727 (goto-char beg)
17728 (beginning-of-line 1)
17729 ;; Ignore blank lines at beginning of region
17731 (beginning-of-line 1)
17732 (setq l (1- (org-current-line)))
17733 (cond
17734 ;; Case 1. Start at an item: de-itemize.
17735 ((org-at-item-p)
17736 (while (< (setq l (1+ l)) l2)
17737 (when (org-at-item-p)
17739 (delete-region (point) (match-end 0)))
17740 (beginning-of-line 2)))
17741 ;; Case 2. Start an an heading: convert to items.
17742 ((org-on-heading-p)
17743 (let* ((bul (org-list-bullet-string "-"))
17744 (len (length bul))
17745 (ind 0) (level 0))
17746 (while (< (setq l (1+ l)) l2)
17747 (cond
17748 ((looking-at outline-regexp)
17749 (let* ((lvl (org-reduced-level
17750 (- (length (match-string 0)) 2)))
17751 (s (concat (make-string (* len lvl) ? ) bul)))
17752 (replace-match s t t)
17753 (setq ind (length s) level lvl)))
17754 ;; Ignore blank lines and inline tasks.
17757 ;; Ensure normal text belongs to the new item.
17758 (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
17759 ind))))
17760 (beginning-of-line 2))))
17761 ;; Case 3. Normal line with ARG: turn each of them into items
17762 ;; unless they are already one.
17763 (arg
17764 (while (< (setq l (1+ l)) l2)
17765 (unless (or (org-on-heading-p) (org-at-item-p))
17767 (replace-match
17769 (beginning-of-line 2)))
17770 ;; Case 4. Normal line without ARG: make the first line of
17771 ;; region an item, and shift indentation of others
17772 ;; lines to set them as item's body.
17773 (t (let* ((bul (org-list-bullet-string "-"))
17774 (bul-len (length bul))
17775 (ref-ind (org-get-indentation)))
17777 (insert bul)
17778 (beginning-of-line 2)
17779 (while (and (< (setq l (1+ l)) l2) (< (point) end))
17780 ;; Ensure that lines less indented than first one
17781 ;; still get included in item body.
17782 (org-indent-line-to (+ (max ref-ind (org-get-indentation))
17783 bul-len))
17784 (beginning-of-line 2)))))))))
17786 (defun org-toggle-heading (&optional nstars)
17787 "Convert headings to normal text, or items or text to headings.
17788 If there is no active region, only the current line is considered.
17790 If the first non blank line is an headline, remove the stars from
17791 all headlines in the region.
17793 If it is a plain list item, turn all plain list items into headings.
17795 If it is a normal line, turn each and every normal line (i.e. not
17796 an heading or an item) in the region into a heading.
17798 When converting a line into a heading, the number of stars is chosen
17799 such that the lines become children of the current entry. However,
17800 when a prefix argument is given, its value determines the number of
17801 stars to add."
17802 (interactive "P")
17803 (let (l2 l itemp beg end)
17804 (if (org-region-active-p)
17805 (setq beg (region-beginning) end (copy-marker (region-end)))
17806 (setq beg (point-at-bol)
17807 end (min (1+ (point-at-eol)) (point-max))))
17808 ;; Ensure inline tasks don't count as headings.
17809 (org-with-limited-levels
17810 (save-excursion
17811 (goto-char end)
17812 (setq l2 (org-current-line))
17813 (goto-char beg)
17814 (beginning-of-line 1)
17815 ;; Ignore blank lines at beginning of region
17817 (beginning-of-line 1)
17818 (setq l (1- (org-current-line)))
17819 (cond
17820 ;; Case 1. Started at an heading: de-star headings.
17821 ((org-on-heading-p)
17822 (while (< (setq l (1+ l)) l2)
17823 (when (org-on-heading-p t)
17824 (looking-at outline-regexp) (replace-match ""))
17825 (beginning-of-line 2)))
17826 ;; Case 2. Started at an item: change items into headlines.
17827 ((org-at-item-p)
17828 (let ((stars (make-string
17829 (if nstars
17830 (prefix-numeric-value current-prefix-arg)
17831 (or (org-current-level) 0))
17832 ?*)))
17833 (while (< (point) end)
17834 (when (org-at-item-p)
17835 ;; Pay attention to cases when region ends before list.
17836 (let* ((struct (org-list-struct))
17837 (list-end (min (org-list-get-bottom-point struct) end)))
17838 (save-restriction
17839 (narrow-to-region (point) list-end)
17840 (insert
17841 (org-list-to-subtree
17842 (org-list-parse-list t)
17843 '(:istart (concat stars (funcall get-stars depth))
17844 :icount (concat stars
17845 (funcall get-stars depth))))))))
17846 (beginning-of-line 2))))
17847 ;; Case 3. Started at normal text: make every line an heading,
17848 ;; skipping headlines and items.
17849 (t (let* ((stars (make-string
17850 (if nstars
17851 (prefix-numeric-value current-prefix-arg)
17852 (or (org-current-level) 0))
17853 ?*))
17854 (add-stars (cond (nstars "")
17855 ((equal stars "") "*")
17856 (org-odd-levels-only "**")
17857 (t "*")))
17858 (rpl (concat stars add-stars " ")))
17859 (while (< (setq l (1+ l)) l2)
17860 (unless (or (org-on-heading-p) (org-at-item-p))
17862 (replace-match (concat rpl (match-string 2)))))
17863 (beginning-of-line 2)))))))))
17865 (defun org-meta-return (&optional arg)
17866 "Insert a new heading or wrap a region in a table.
17867 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17868 See the individual commands for more information."
17869 (interactive "P")
17870 (cond
17871 ((run-hook-with-args-until-success 'org-metareturn-hook))
17872 ((org-at-table-p)
17873 (call-interactively 'org-table-wrap-region))
17874 (t (call-interactively 'org-insert-heading))))
17876 ;;; Menu entries
17878 ;; Define the Org-mode menus
17879 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17880 '("Tbl"
17881 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17882 ["Next Field" org-cycle (org-at-table-p)]
17883 ["Previous Field" org-shifttab (org-at-table-p)]
17884 ["Next Row" org-return (org-at-table-p)]
17885 "--"
17886 ["Blank Field" org-table-blank-field (org-at-table-p)]
17887 ["Edit Field" org-table-edit-field (org-at-table-p)]
17888 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17889 "--"
17890 ("Column"
17891 ["Move Column Left" org-metaleft (org-at-table-p)]
17892 ["Move Column Right" org-metaright (org-at-table-p)]
17893 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17894 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17895 ("Row"
17896 ["Move Row Up" org-metaup (org-at-table-p)]
17897 ["Move Row Down" org-metadown (org-at-table-p)]
17898 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17899 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17900 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17901 "--"
17902 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17903 ("Rectangle"
17904 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17905 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17906 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17907 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17908 "--"
17909 ("Calculate"
17910 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17911 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17912 ["Edit Formulas" org-edit-special (org-at-table-p)]
17913 "--"
17914 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17915 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17916 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17917 "--"
17918 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17919 "--"
17920 ["Sum Column/Rectangle" org-table-sum
17921 (or (org-at-table-p) (org-region-active-p))]
17922 ["Which Column?" org-table-current-column (org-at-table-p)])
17923 ["Debug Formulas"
17924 org-table-toggle-formula-debugger
17925 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17926 ["Show Col/Row Numbers"
17927 org-table-toggle-coordinate-overlays
17928 :style toggle
17929 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17930 "--"
17931 ["Create" org-table-create (and (not (org-at-table-p))
17932 org-enable-table-editor)]
17933 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17934 ["Import from File" org-table-import (not (org-at-table-p))]
17935 ["Export to File" org-table-export (org-at-table-p)]
17936 "--"
17937 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17939 (easy-menu-define org-org-menu org-mode-map "Org menu"
17940 '("Org"
17941 ("Show/Hide"
17942 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17943 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17944 ["Sparse Tree..." org-sparse-tree t]
17945 ["Reveal Context" org-reveal t]
17946 ["Show All" show-all t]
17947 "--"
17948 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17949 "--"
17950 ["New Heading" org-insert-heading t]
17951 ("Navigate Headings"
17952 ["Up" outline-up-heading t]
17953 ["Next" outline-next-visible-heading t]
17954 ["Previous" outline-previous-visible-heading t]
17955 ["Next Same Level" outline-forward-same-level t]
17956 ["Previous Same Level" outline-backward-same-level t]
17957 "--"
17958 ["Jump" org-goto t])
17959 ("Edit Structure"
17960 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17961 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17962 "--"
17963 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17964 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17965 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17966 "--"
17967 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17968 "--"
17969 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17970 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17971 ["Demote Heading" org-metaright (not (org-at-table-p))]
17972 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17973 "--"
17974 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17975 "--"
17976 ["Convert to odd levels" org-convert-to-odd-levels t]
17977 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17978 ("Editing"
17979 ["Emphasis..." org-emphasize t]
17980 ["Edit Source Example" org-edit-special t]
17981 "--"
17982 ["Footnote new/jump" org-footnote-action t]
17983 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17984 ("Archive"
17985 ["Archive (default method)" org-archive-subtree-default t]
17986 "--"
17987 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17988 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17989 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17990 )
17991 "--"
17992 ("Hyperlinks"
17993 ["Store Link (Global)" org-store-link t]
17994 ["Find existing link to here" org-occur-link-in-agenda-files t]
17995 ["Insert Link" org-insert-link t]
17996 ["Follow Link" org-open-at-point t]
17997 "--"
17998 ["Next link" org-next-link t]
17999 ["Previous link" org-previous-link t]
18000 "--"
18001 ["Descriptive Links"
18002 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18003 :style radio
18004 :selected (member '(org-link) buffer-invisibility-spec)]
18005 ["Literal Links"
18006 (progn
18007 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18008 :style radio
18009 :selected (not (member '(org-link) buffer-invisibility-spec))])
18010 "--"
18011 ("TODO Lists"
18012 ["TODO/DONE/-" org-todo t]
18013 ("Select keyword"
18014 ["Next keyword" org-shiftright (org-on-heading-p)]
18015 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18016 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18017 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18018 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18019 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18020 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18021 "--"
18022 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18023 :selected org-enforce-todo-dependencies :style toggle :active t]
18024 "Settings for tree at point"
18025 ["Do Children sequentially" org-toggle-ordered-property :style radio
18026 :selected (org-entry-get nil "ORDERED")
18027 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18028 ["Do Children parallel" org-toggle-ordered-property :style radio
18029 :selected (not (org-entry-get nil "ORDERED"))
18030 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18031 "--"
18032 ["Set Priority" org-priority t]
18033 ["Priority Up" org-shiftup t]
18034 ["Priority Down" org-shiftdown t]
18035 "--"
18036 ["Get news from all feeds" org-feed-update-all t]
18037 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18038 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18039 ("TAGS and Properties"
18040 ["Set Tags" org-set-tags-command t]
18041 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18042 "--"
18043 ["Set property" org-set-property t]
18044 ["Column view of properties" org-columns t]
18045 ["Insert Column View DBlock" org-insert-columns-dblock t])
18046 ("Dates and Scheduling"
18047 ["Timestamp" org-time-stamp t]
18048 ["Timestamp (inactive)" org-time-stamp-inactive t]
18049 ("Change Date"
18050 ["1 Day Later" org-shiftright t]
18051 ["1 Day Earlier" org-shiftleft t]
18052 ["1 ... Later" org-shiftup t]
18053 ["1 ... Earlier" org-shiftdown t])
18054 ["Compute Time Range" org-evaluate-time-range t]
18055 ["Schedule Item" org-schedule t]
18056 ["Deadline" org-deadline t]
18057 "--"
18058 ["Custom time format" org-toggle-time-stamp-overlays
18059 :style radio :selected org-display-custom-times]
18060 "--"
18061 ["Goto Calendar" org-goto-calendar t]
18062 ["Date from Calendar" org-date-from-calendar t]
18063 "--"
18064 ["Start/Restart Timer" org-timer-start t]
18065 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18066 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18067 ["Insert Timer String" org-timer t]
18068 ["Insert Timer Item" org-timer-item t])
18069 ("Logging work"
18070 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18071 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18072 ["Clock out" org-clock-out t]
18073 ["Clock cancel" org-clock-cancel t]
18074 "--"
18075 ["Mark as default task" org-clock-mark-default-task t]
18076 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18077 ["Goto running clock" org-clock-goto t]
18078 "--"
18079 ["Display times" org-clock-display t]
18080 ["Create clock table" org-clock-report t]
18081 "--"
18082 ["Record DONE time"
18083 (progn (setq org-log-done (not org-log-done))
18084 (message "Switching to %s will %s record a timestamp"
18085 (car org-done-keywords)
18086 (if org-log-done "automatically" "not")))
18087 :style toggle :selected org-log-done])
18088 "--"
18089 ["Agenda Command..." org-agenda t]
18090 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18091 ("File List for Agenda")
18092 ("Special views current file"
18093 ["TODO Tree" org-show-todo-tree t]
18094 ["Check Deadlines" org-check-deadlines t]
18095 ["Timeline" org-timeline t]
18096 ["Tags/Property tree" org-match-sparse-tree t])
18097 "--"
18098 ["Export/Publish..." org-export t]
18099 ("LaTeX"
18100 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18101 :selected org-cdlatex-mode]
18102 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18103 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18104 ["Modify math symbol" org-cdlatex-math-modify
18105 (org-inside-LaTeX-fragment-p)]
18106 ["Insert citation" org-reftex-citation t]
18107 "--"
18108 ["Template for BEAMER" org-insert-beamer-options-template t])
18109 "--"
18110 ("MobileOrg"
18111 ["Push Files and Views" org-mobile-push t]
18112 ["Get Captured and Flagged" org-mobile-pull t]
18113 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18114 "--"
18115 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18116 "--"
18117 ("Documentation"
18118 ["Show Version" org-version t]
18119 ["Info Documentation" org-info t])
18120 ("Customize"
18121 ["Browse Org Group" org-customize t]
18122 "--"
18123 ["Expand This Menu" org-create-customize-menu
18124 (fboundp 'customize-menu-create)])
18125 ["Send bug report" org-submit-bug-report t]
18126 "--"
18127 ("Refresh/Reload"
18128 ["Refresh setup current buffer" org-mode-restart t]
18129 ["Reload Org (after update)" org-reload t]
18130 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18131 ))
18133 (defun org-info (&optional node)
18134 "Read documentation for Org-mode in the info system.
18135 With optional NODE, go directly to that node."
18136 (interactive)
18137 (info (format "(org)%s" (or node ""))))
18139 ;;;###autoload
18140 (defun org-submit-bug-report ()
18141 "Submit a bug report on Org-mode via mail.
18143 Don't hesitate to report any problems or inaccurate documentation.
18145 If you don't have setup sending mail from (X)Emacs, please copy the
18146 output buffer into your mail program, as it gives us important
18147 information about your Org-mode version and configuration."
18148 (interactive)
18149 (require 'reporter)
18150 (org-load-modules-maybe)
18151 (org-require-autoloaded-modules)
18152 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18153 (reporter-submit-bug-report
18154 "emacs-orgmode@gnu.org"
18155 (org-version)
18156 (let (list)
18157 (save-window-excursion
18158 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
18159 (delete-other-windows)
18160 (erase-buffer)
18161 (insert "You are about to submit a bug report to the Org-mode mailing list.
18163 We would like to add your full Org-mode and Outline configuration to the
18164 bug report. This greatly simplifies the work of the maintainer and
18165 other experts on the mailing list.
18167 HOWEVER, some variables you have customized may contain private
18168 information. The names of customers, colleagues, or friends, might
18169 appear in the form of file names, tags, todo states, or search strings.
18170 If you answer yes to the prompt, you might want to check and remove
18171 such private information before sending the email.")
18172 (add-text-properties (point-min) (point-max) '(face org-warning))
18173 (when (yes-or-no-p "Include your Org-mode configuration ")
18174 (mapatoms
18175 (lambda (v)
18176 (and (boundp v)
18178 (or (and (symbol-value v)
18180 (and
18181 (get v 'custom-type) (get v 'standard-value)
18182 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18183 (push v list)))))
18184 (kill-buffer (get-buffer "*Warn about privacy*"))
18185 list))
18186 nil nil
18187 "Remember to cover the basics, that is, what you expected to happen and
18188 what in fact did happen. You don't know how to make a good report? See
18190 http://orgmode.org/manual/Feedback.html#Feedback
18192 Your bug report will be posted to the Org-mode mailing list.
18193 ------------------------------------------------------------------------")
18194 (save-excursion
18199 (defun org-install-agenda-files-menu ()
18200 (let ((bl (buffer-list)))
18201 (save-excursion
18202 (while bl
18203 (set-buffer (pop bl))
18204 (if (org-mode-p) (setq bl nil)))
18205 (when (org-mode-p)
18206 (easy-menu-change
18207 '("Org") "File List for Agenda"
18208 (append
18209 (list
18210 ["Edit File List" (org-edit-agenda-file-list) t]
18211 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18212 ["Remove Current File from List" org-remove-file t]
18213 ["Cycle through agenda files" org-cycle-agenda-files t]
18214 ["Occur in all agenda files" org-occur-in-agenda-files t]
18215 "--")
18216 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18218 ;;;; Documentation
18220 ;;;###autoload
18221 (defun org-require-autoloaded-modules ()
18222 (interactive)
18223 (mapc 'require
18224 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18225 org-docbook org-exp org-html org-icalendar
18226 org-id org-latex
18227 org-publish org-remember org-table
18228 org-timer org-xoxo)))
18230 ;;;###autoload
18231 (defun org-reload (&optional uncompiled)
18232 "Reload all org lisp files.
18233 With prefix arg UNCOMPILED, load the uncompiled versions."
18234 (interactive "P")
18235 (require 'find-func)
18237 (dir-org (file-name-directory (org-find-library-name "org")))
18238 (dir-org-contrib (ignore-errors
18239 (file-name-directory
18240 (org-find-library-name "org-contribdir"))))
18241 (babel-files
18242 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18243 (append (list nil "comint" "eval" "exp" "keys"
18244 "lob" "ref" "table" "tangle")
18245 (delq nil
18246 (mapcar
18247 (lambda (lang)
18248 (when (cdr lang) (symbol-name (car lang))))
18249 org-babel-load-languages)))))
18250 (files
18251 (append (directory-files dir-org t file-re)
18252 babel-files
18253 (and dir-org-contrib
18254 (directory-files dir-org-contrib t file-re))))
18255 (remove-re (concat (if (featurep 'xemacs)
18256 "org-colview" "org-colview-xemacs")
18258 (setq files (mapcar 'file-name-sans-extension files))
18259 (setq files (mapcar
18260 (lambda (x) (if (string-match remove-re x) nil x))
18261 files))
18262 (setq files (delq nil files))
18263 (mapc
18264 (lambda (f)
18265 (when (featurep (intern (file-name-nondirectory f)))
18266 (if (and (not uncompiled)
18267 (file-exists-p (concat f ".elc")))
18268 (load (concat f ".elc") nil nil t)
18269 (load (concat f ".el") nil nil t))))
18270 files))
18271 (org-version))
18273 ;;;###autoload
18274 (defun org-customize ()
18275 "Call the customize function with org as argument."
18276 (interactive)
18277 (org-load-modules-maybe)
18278 (org-require-autoloaded-modules)
18279 (customize-browse 'org))
18281 (defun org-create-customize-menu ()
18282 "Create a full customization menu for Org-mode, insert it into the menu."
18283 (interactive)
18284 (org-load-modules-maybe)
18285 (org-require-autoloaded-modules)
18286 (if (fboundp 'customize-menu-create)
18287 (progn
18288 (easy-menu-change
18289 '("Org") "Customize"
18290 `(["Browse Org group" org-customize t]
18291 "--"
18292 ,(customize-menu-create 'org)
18293 ["Set" Custom-set t]
18294 ["Save" Custom-save t]
18295 ["Reset to Current" Custom-reset-current t]
18296 ["Reset to Saved" Custom-reset-saved t]
18297 ["Reset to Standard Settings" Custom-reset-standard t]))
18299 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18301 ;;;; Miscellaneous stuff
18303 ;;; Generally useful functions
18305 (defun org-get-at-bol (property)
18306 "Get text property PROPERTY at beginning of line."
18307 (get-text-property (point-at-bol) property))
18309 (defun org-find-text-property-in-string (prop s)
18310 "Return the first non-nil value of property PROP in string S."
18311 (or (get-text-property 0 prop s)
18312 (get-text-property (or (next-single-property-change 0 prop s) 0)
18313 prop s)))
18315 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18316 "Display the given MESSAGE as a warning."
18317 (if (fboundp 'display-warning)
18318 (display-warning 'org message
18319 (if (featurep 'xemacs) 'warning :warning))
18320 (let ((buf (get-buffer-create "*Org warnings*")))
18321 (with-current-buffer buf
18322 (goto-char (point-max))
18323 (insert "Warning (Org): " message)
18324 (unless (bolp)
18325 (newline)))
18326 (display-buffer buf)
18327 (sit-for 0))))
18329 (defun org-eval (form)
18330 "Eval FORM and return result."
18331 (condition-case error
18332 (eval form)
18333 (error (format "%%![Error: %s]" error))))
18335 (defun org-in-commented-line ()
18336 "Is point in a line starting with `#'?"
18337 (equal (char-after (point-at-bol)) ?#))
18339 (defun org-in-indented-comment-line ()
18340 "Is point in a line starting with `#' after some white space?"
18341 (save-excursion
18342 (save-match-data
18343 (goto-char (point-at-bol))
18346 (defun org-in-verbatim-emphasis ()
18347 (save-match-data
18348 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18350 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18351 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18352 (if (and marker (marker-buffer marker)
18353 (buffer-live-p (marker-buffer marker)))
18354 (progn
18355 (switch-to-buffer (marker-buffer marker))
18356 (if (or (> marker (point-max)) (< marker (point-min)))
18357 (widen))
18358 (goto-char marker)
18359 (org-show-context 'org-goto))
18360 (if bookmark
18361 (bookmark-jump bookmark)
18362 (error "Cannot find location"))))
18364 (defun org-quote-csv-field (s)
18365 "Quote field for inclusion in CSV material."
18368 s))
18370 (defun org-force-self-insert (N)
18371 "Needed to enforce self-insert under remapping."
18372 (interactive "p")
18373 (self-insert-command N))
18375 (defun org-string-width (s)
18376 "Compute width of string, ignoring invisible characters.
18377 This ignores character with invisibility property `org-link', and also
18378 characters with property `org-cwidth', because these will become invisible
18379 upon the next fontification round."
18380 (let (b l)
18381 (when (or (eq t buffer-invisibility-spec)
18382 (assq 'org-link buffer-invisibility-spec))
18383 (while (setq b (text-property-any 0 (length s)
18384 'invisible 'org-link s))
18385 (setq s (concat (substring s 0 b)
18386 (substring s (or (next-single-property-change
18387 b 'invisible s) (length s)))))))
18388 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18389 (setq s (concat (substring s 0 b)
18390 (substring s (or (next-single-property-change
18391 b 'org-cwidth s) (length s))))))
18392 (setq l (string-width s) b -1)
18393 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18394 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18395 l))
18397 (defun org-shorten-string (s maxlength)
18398 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18399 If the string is shorter or has length MAXLENGTH, just return the
18400 original string. If it is longer, the functions finds a space in the
18401 string, breaks this string off at that locations and adds three dots
18402 as ellipsis. Including the ellipsis, the string will not be longer
18403 than MAXLENGTH. If finding a good breaking point in the string does
18404 not work, the string is just chopped off in the middle of a word
18405 if necessary."
18406 (if (<= (length s) maxlength)
18407 s
18408 (let* ((n (max (- maxlength 4) 1))
18410 (if (string-match re s)
18411 (concat (match-string 1 s) "...")
18412 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18414 (defun org-get-indentation (&optional line)
18415 "Get the indentation of the current line, interpreting tabs.
18416 When LINE is given, assume it represents a line and compute its indentation."
18417 (if line
18418 (if (string-match "^ *" (org-remove-tabs line))
18419 (match-end 0))
18420 (save-excursion
18421 (beginning-of-line 1)
18423 (current-column))))
18425 (defun org-get-string-indentation (s)
18426 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18427 (let ((n -1) (i 0) (w tab-width) c)
18428 (catch 'exit
18429 (while (< (setq n (1+ n)) (length s))
18430 (setq c (aref s n))
18431 (cond ((= c ?\ ) (setq i (1+ i)))
18433 (t (throw 'exit t)))))
18434 i))
18436 (defun org-remove-tabs (s &optional width)
18437 "Replace tabulators in S with spaces.
18438 Assumes that s is a single line, starting in column 0."
18439 (setq width (or width tab-width))
18441 (setq s (replace-match
18442 (make-string
18443 (- (* width (/ (+ (match-beginning 0) width) width))
18444 (match-beginning 0)) ?\ )
18445 t t s)))
18446 s)
18448 (defun org-fix-indentation (line ind)
18449 "Fix indentation in LINE.
18450 IND is a cons cell with target and minimum indentation.
18451 If the current indentation in LINE is smaller than the minimum,
18452 leave it alone. If it is larger than ind, set it to the target."
18453 (let* ((l (org-remove-tabs line))
18454 (i (org-get-indentation l))
18455 (i1 (car ind)) (i2 (cdr ind)))
18456 (if (>= i i2) (setq l (substring line i2)))
18457 (if (> i1 0)
18458 (concat (make-string i1 ?\ ) l)
18459 l)))
18461 (defun org-remove-indentation (code &optional n)
18462 "Remove the maximum common indentation from the lines in CODE.
18463 N may optionally be the number of spaces to remove."
18464 (with-temp-buffer
18465 (insert code)
18466 (org-do-remove-indentation n)
18467 (buffer-string)))
18469 (defun org-do-remove-indentation (&optional n)
18470 "Remove the maximum common indentation from the buffer."
18471 (untabify (point-min) (point-max))
18472 (let ((min 10000) re)
18473 (if n
18474 (setq min n)
18475 (goto-char (point-min))
18477 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18478 (unless (or (= min 0) (= min 10000))
18480 (goto-char (point-min))
18481 (while (re-search-forward re nil t)
18482 (replace-match "")
18483 (end-of-line 1))
18484 min)))
18486 (defun org-fill-template (template alist)
18487 "Find each %key of ALIST in TEMPLATE and replace it."
18488 (let ((case-fold-search nil)
18489 entry key value)
18490 (setq alist (sort (copy-sequence alist)
18491 (lambda (a b) (< (length (car a)) (length (car b))))))
18492 (while (setq entry (pop alist))
18493 (setq template
18494 (replace-regexp-in-string
18495 (concat "%" (regexp-quote (car entry)))
18496 (cdr entry) template t t)))
18497 template))
18499 (defun org-base-buffer (buffer)
18500 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18501 (if (not buffer)
18502 buffer
18503 (or (buffer-base-buffer buffer)
18504 buffer)))
18506 (defun org-trim (s)
18507 "Remove whitespace at beginning and end of string."
18510 s)
18512 (defun org-wrap (string &optional width lines)
18513 "Wrap string to either a number of lines, or a width in characters.
18514 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18515 that costs. If there is a word longer than WIDTH, the text is actually
18516 wrapped to the length of that word.
18517 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18518 many lines, whatever width that takes.
18519 The return value is a list of lines, without newlines at the end."
18521 (maxword (apply 'max (mapcar 'org-string-width words)))
18522 w ll)
18523 (cond (width
18524 (org-do-wrap words (max maxword width)))
18525 (lines
18526 (setq w maxword)
18527 (setq ll (org-do-wrap words maxword))
18528 (if (<= (length ll) lines)
18529 ll
18530 (setq ll words)
18531 (while (> (length ll) lines)
18532 (setq w (1+ w))
18533 (setq ll (org-do-wrap words w)))
18534 ll))
18535 (t (error "Cannot wrap this")))))
18537 (defun org-do-wrap (words width)
18538 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18539 (let (lines line)
18540 (while words
18541 (setq line (pop words))
18542 (while (and words (< (+ (length line) (length (car words))) width))
18543 (setq line (concat line " " (pop words))))
18544 (setq lines (push line lines)))
18545 (nreverse lines)))
18547 (defun org-split-string (string &optional separators)
18548 "Splits STRING into substrings at SEPARATORS.
18549 No empty strings are returned if there are matches at the beginning
18550 and end of string."
18552 (start 0)
18553 notfirst
18554 (list nil))
18555 (while (and (string-match rexp string
18556 (if (and notfirst
18557 (= start (match-beginning 0))
18558 (< start (length string)))
18559 (1+ start) start))
18560 (< (match-beginning 0) (length string)))
18561 (setq notfirst t)
18562 (or (eq (match-beginning 0) 0)
18563 (and (eq (match-beginning 0) (match-end 0))
18564 (eq (match-beginning 0) start))
18565 (setq list
18566 (cons (substring string start (match-beginning 0))
18567 list)))
18568 (setq start (match-end 0)))
18569 (or (eq start (length string))
18570 (setq list
18571 (cons (substring string start)
18572 list)))
18573 (nreverse list)))
18575 (defun org-quote-vert (s)
18577 (while (string-match "|" s)
18579 s)
18581 (defun org-uuidgen-p (s)
18582 "Is S an ID created by UUIDGEN?"
18583 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18585 (defun org-context ()
18586 "Return a list of contexts of the current cursor position.
18587 If several contexts apply, all are returned.
18588 Each context entry is a list with a symbol naming the context, and
18589 two positions indicating start and end of the context. Possible
18590 contexts are:
18592 :headline anywhere in a headline
18593 :headline-stars on the leading stars in a headline
18594 :todo-keyword on a TODO keyword (including DONE) in a headline
18595 :tags on the TAGS in a headline
18596 :priority on the priority cookie in a headline
18597 :item on the first line of a plain list item
18598 :item-bullet on the bullet/number of a plain list item
18599 :checkbox on the checkbox in a plain list item
18600 :table in an org-mode table
18601 :table-special on a special filed in a table
18602 :table-table in a table.el table
18603 :link on a hyperlink
18604 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18605 :target on a <<target>>
18606 :radio-target on a <<<radio-target>>>
18607 :latex-fragment on a LaTeX fragment
18608 :latex-preview on a LaTeX fragment with overlayed preview image
18610 This function expects the position to be visible because it uses font-lock
18611 faces as a help to recognize the following contexts: :table-special, :link,
18612 and :keyword."
18613 (let* ((f (get-text-property (point) 'face))
18614 (faces (if (listp f) f (list f)))
18615 (p (point)) clist o)
18616 ;; First the large context
18617 (cond
18618 ((org-on-heading-p t)
18619 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18620 (when (progn
18621 (beginning-of-line 1)
18622 (looking-at org-todo-line-tags-regexp))
18623 (push (org-point-in-group p 1 :headline-stars) clist)
18624 (push (org-point-in-group p 2 :todo-keyword) clist)
18625 (push (org-point-in-group p 4 :tags) clist))
18626 (goto-char p)
18629 (push (org-point-in-group p 0 :priority) clist)))
18631 ((org-at-item-p)
18632 (push (org-point-in-group p 2 :item-bullet) clist)
18633 (push (list :item (point-at-bol)
18634 (save-excursion (org-end-of-item) (point)))
18635 clist)
18636 (and (org-at-item-checkbox-p)
18637 (push (org-point-in-group p 0 :checkbox) clist)))
18639 ((org-at-table-p)
18640 (push (list :table (org-table-begin) (org-table-end)) clist)
18641 (if (memq 'org-formula faces)
18642 (push (list :table-special
18643 (previous-single-property-change p 'face)
18644 (next-single-property-change p 'face)) clist)))
18645 ((org-at-table-p 'any)
18646 (push (list :table-table) clist)))
18647 (goto-char p)
18649 ;; Now the small context
18650 (cond
18651 ((org-at-timestamp-p)
18652 (push (org-point-in-group p 0 :timestamp) clist))
18653 ((memq 'org-link faces)
18654 (push (list :link
18655 (previous-single-property-change p 'face)
18656 (next-single-property-change p 'face)) clist))
18657 ((memq 'org-special-keyword faces)
18658 (push (list :keyword
18659 (previous-single-property-change p 'face)
18660 (next-single-property-change p 'face)) clist))
18661 ((org-on-target-p)
18662 (push (org-point-in-group p 0 :target) clist)
18663 (goto-char (1- (match-beginning 0)))
18664 (if (looking-at org-radio-target-regexp)
18665 (push (org-point-in-group p 0 :radio-target) clist))
18666 (goto-char p))
18667 ((setq o (car (delq nil
18668 (mapcar
18669 (lambda (x)
18670 (if (memq x org-latex-fragment-image-overlays) x))
18671 (overlays-at (point))))))
18672 (push (list :latex-fragment
18673 (overlay-start o) (overlay-end o)) clist)
18674 (push (list :latex-preview
18675 (overlay-start o) (overlay-end o)) clist))
18676 ((org-inside-LaTeX-fragment-p)
18677 ;; FIXME: positions wrong.
18678 (push (list :latex-fragment (point) (point)) clist)))
18680 (setq clist (nreverse (delq nil clist)))
18681 clist))
18683 ;; FIXME: Compare with at-regexp-p Do we need both?
18684 (defun org-in-regexp (re &optional nlines visually)
18685 "Check if point is inside a match of regexp.
18686 Normally only the current line is checked, but you can include NLINES extra
18687 lines both before and after point into the search.
18688 If VISUALLY is set, require that the cursor is not after the match but
18689 really on, so that the block visually is on the match."
18690 (catch 'exit
18691 (let ((pos (point))
18692 (eol (point-at-eol (+ 1 (or nlines 0))))
18693 (inc (if visually 1 0)))
18694 (save-excursion
18695 (beginning-of-line (- 1 (or nlines 0)))
18696 (while (re-search-forward re eol t)
18697 (if (and (<= (match-beginning 0) pos)
18698 (>= (+ inc (match-end 0)) pos))
18699 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18701 (defun org-at-regexp-p (regexp)
18702 "Is point inside a match of REGEXP in the current line?"
18703 (catch 'exit
18704 (save-excursion
18705 (let ((pos (point)) (end (point-at-eol)))
18706 (beginning-of-line 1)
18707 (while (re-search-forward regexp end t)
18708 (if (and (<= (match-beginning 0) pos)
18709 (>= (match-end 0) pos))
18710 (throw 'exit t)))
18711 nil))))
18713 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18714 "Return t if the current point is between matches of START-RE and END-RE.
18715 This will also return t if point is on one of the two matches or
18716 in an unfinished block. END-RE can be a string or a form
18717 returning a string.
18719 An optional third argument bounds the search for START-RE. It
18720 defaults to previous heading or `point-min'."
18721 (let ((pos (point))
18722 (limit (or bound (save-excursion (outline-previous-heading)))))
18723 (save-excursion
18724 ;; we're on a block when point is on start-re...
18725 (or (org-at-regexp-p start-re)
18726 ;; ... or start-re can be found above...
18727 (and (re-search-backward start-re limit t)
18728 ;; ... but no end-re between start-re and point.
18729 (not (re-search-forward (eval end-re) pos t)))))))
18731 (defun org-occur-in-agenda-files (regexp &optional nlines)
18732 "Call `multi-occur' with buffers for all agenda files."
18734 (let* ((files (org-agenda-files))
18735 (tnames (mapcar 'file-truename files))
18736 (extra org-agenda-text-search-extra-files)
18737 f)
18738 (when (eq (car extra) 'agenda-archives)
18739 (setq extra (cdr extra))
18740 (setq files (org-add-archive-files files)))
18741 (while (setq f (pop extra))
18742 (unless (member (file-truename f) tnames)
18743 (add-to-list 'files f 'append)
18744 (add-to-list 'tnames (file-truename f) 'append)))
18745 (multi-occur
18746 (mapcar (lambda (x)
18747 (with-current-buffer
18748 (or (get-file-buffer x) (find-file-noselect x))
18749 (widen)
18750 (current-buffer)))
18751 files)
18752 regexp)))
18754 (if (boundp 'occur-mode-find-occurrence-hook)
18755 ;; Emacs 23
18756 (add-hook 'occur-mode-find-occurrence-hook
18757 (lambda ()
18758 (when (org-mode-p)
18759 (org-reveal))))
18760 ;; Emacs 22
18761 (defadvice occur-mode-goto-occurrence
18762 (after org-occur-reveal activate)
18763 (and (org-mode-p) (org-reveal)))
18764 (defadvice occur-mode-goto-occurrence-other-window
18765 (after org-occur-reveal activate)
18766 (and (org-mode-p) (org-reveal)))
18767 (defadvice occur-mode-display-occurrence
18768 (after org-occur-reveal activate)
18769 (when (org-mode-p)
18770 (let ((pos (occur-mode-find-occurrence)))
18771 (with-current-buffer (marker-buffer pos)
18772 (save-excursion
18773 (goto-char pos)
18774 (org-reveal)))))))
18776 (defun org-occur-link-in-agenda-files ()
18777 "Create a link and search for it in the agendas.
18778 The link is not stored in `org-stored-links', it is just created
18779 for the search purpose."
18780 (interactive)
18781 (let ((link (condition-case nil
18782 (org-store-link nil)
18783 (error "Unable to create a link to here"))))
18784 (org-occur-in-agenda-files (regexp-quote link))))
18786 (defun org-uniquify (list)
18787 "Remove duplicate elements from LIST."
18788 (let (res)
18789 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18790 res))
18792 (defun org-delete-all (elts list)
18793 "Remove all elements in ELTS from LIST."
18794 (while elts
18795 (setq list (delete (pop elts) list)))
18796 list)
18798 (defun org-count (cl-item cl-seq)
18799 "Count the number of occurrences of ITEM in SEQ.
18800 Taken from `count' in cl-seq.el with all keyword arguments removed."
18801 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18802 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18803 (while (< cl-start cl-end)
18804 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18805 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18806 (setq cl-start (1+ cl-start)))
18807 cl-count))
18809 (defun org-remove-if (predicate seq)
18810 "Remove everything from SEQ that fulfills PREDICATE."
18811 (let (res e)
18812 (while seq
18813 (setq e (pop seq))
18814 (if (not (funcall predicate e)) (push e res)))
18815 (nreverse res)))
18817 (defun org-remove-if-not (predicate seq)
18818 "Remove everything from SEQ that does not fulfill PREDICATE."
18819 (let (res e)
18820 (while seq
18821 (setq e (pop seq))
18822 (if (funcall predicate e) (push e res)))
18823 (nreverse res)))
18825 (defun org-back-over-empty-lines ()
18826 "Move backwards over whitespace, to the beginning of the first empty line.
18827 Returns the number of empty lines passed."
18828 (let ((pos (point)))
18829 (if (cdr (assoc 'heading org-blank-before-new-entry))
18831 (forward-line -1))
18832 (beginning-of-line 2)
18833 (goto-char (min (point) pos))
18834 (count-lines (point) pos)))
18836 (defun org-skip-whitespace ()
18839 (defun org-point-in-group (point group &optional context)
18840 "Check if POINT is in match-group GROUP.
18841 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18842 match. If the match group does not exist or point is not inside it,
18843 return nil."
18844 (and (match-beginning group)
18845 (>= point (match-beginning group))
18846 (<= point (match-end group))
18847 (if context
18848 (list context (match-beginning group) (match-end group))
18849 t)))
18851 (defun org-switch-to-buffer-other-window (&rest args)
18852 "Switch to buffer in a second window on the current frame.
18853 In particular, do not allow pop-up frames.
18854 Returns the newly created buffer."
18855 (let (pop-up-frames special-display-buffer-names special-display-regexps
18856 special-display-function)
18857 (apply 'switch-to-buffer-other-window args)))
18859 (defun org-combine-plists (&rest plists)
18860 "Create a single property list from all plists in PLISTS.
18861 The process starts by copying the first list, and then setting properties
18862 from the other lists. Settings in the last list are the most significant
18863 ones and overrule settings in the other lists."
18864 (let ((rtn (copy-sequence (pop plists)))
18865 p v ls)
18866 (while plists
18867 (setq ls (pop plists))
18868 (while ls
18869 (setq p (pop ls) v (pop ls))
18870 (setq rtn (plist-put rtn p v))))
18871 rtn))
18873 (defun org-move-line-down (arg)
18874 "Move the current line down. With prefix argument, move it past ARG lines."
18875 (interactive "p")
18876 (let ((col (current-column))
18877 beg end pos)
18878 (beginning-of-line 1) (setq beg (point))
18879 (beginning-of-line 2) (setq end (point))
18880 (beginning-of-line (+ 1 arg))
18881 (setq pos (move-marker (make-marker) (point)))
18882 (insert (delete-and-extract-region beg end))
18883 (goto-char pos)
18884 (org-move-to-column col)))
18886 (defun org-move-line-up (arg)
18887 "Move the current line up. With prefix argument, move it past ARG lines."
18888 (interactive "p")
18889 (let ((col (current-column))
18890 beg end pos)
18891 (beginning-of-line 1) (setq beg (point))
18892 (beginning-of-line 2) (setq end (point))
18893 (beginning-of-line (- arg))
18894 (setq pos (move-marker (make-marker) (point)))
18895 (insert (delete-and-extract-region beg end))
18896 (goto-char pos)
18897 (org-move-to-column col)))
18899 (defun org-replace-escapes (string table)
18900 "Replace %-escapes in STRING with values in TABLE.
18902 The sequences in STRING may contain normal field width and padding information,
18904 so values can contain further %-escapes if they are define later in TABLE."
18905 (let ((tbl (copy-alist table))
18906 (case-fold-search nil)
18907 (pchg 0)
18908 e re rpl)
18909 (while (setq e (pop tbl))
18910 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18911 (when (and (cdr e) (string-match re (cdr e)))
18912 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18913 (safe "SREF"))
18914 (add-text-properties 0 3 (list 'sref sref) safe)
18915 (setcdr e (replace-match safe t t (cdr e)))))
18916 (while (string-match re string)
18917 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18918 (cdr e)))
18919 (setq string (replace-match rpl t t string))))
18920 (while (setq pchg (next-property-change pchg string))
18921 (let ((sref (get-text-property pchg 'sref string)))
18922 (when (and sref (string-match "SREF" string pchg))
18923 (setq string (replace-match sref t t string)))))
18924 string))
18926 (defun org-sublist (list start end)
18927 "Return a section of LIST, from START to END.
18928 Counting starts at 1."
18929 (let (rtn (c start))
18930 (setq list (nthcdr (1- start) list))
18931 (while (and list (<= c end))
18932 (push (pop list) rtn)
18933 (setq c (1+ c)))
18934 (nreverse rtn)))
18936 (defun org-find-base-buffer-visiting (file)
18937 "Like `find-buffer-visiting' but always return the base buffer and
18938 not an indirect buffer."
18939 (let ((buf (or (get-file-buffer file)
18940 (find-buffer-visiting file))))
18941 (if buf
18942 (or (buffer-base-buffer buf) buf)
18943 nil)))
18945 (defun org-image-file-name-regexp (&optional extensions)
18946 "Return regexp matching the file names of images.
18947 If EXTENSIONS is given, only match these."
18948 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18949 (image-file-name-regexp)
18950 (let ((image-file-name-extensions
18951 (or extensions
18952 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18953 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18955 (regexp-opt (nconc (mapcar 'upcase
18956 image-file-name-extensions)
18957 image-file-name-extensions)
18958 t)
18961 (defun org-file-image-p (file &optional extensions)
18962 "Return non-nil if FILE is an image."
18963 (save-match-data
18964 (string-match (org-image-file-name-regexp extensions) file)))
18966 (defun org-get-cursor-date ()
18967 "Return the date at cursor in as a time.
18968 This works in the calendar and in the agenda, anywhere else it just
18969 returns the current time."
18970 (let (date day defd)
18971 (cond
18972 ((eq major-mode 'calendar-mode)
18973 (setq date (calendar-cursor-to-date)
18974 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18975 ((eq major-mode 'org-agenda-mode)
18976 (setq day (get-text-property (point) 'day))
18977 (if day
18978 (setq date (calendar-gregorian-from-absolute day)
18979 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18980 (nth 2 date))))))
18981 (or defd (current-time))))
18983 (defvar org-agenda-action-marker (make-marker)
18984 "Marker pointing to the entry for the next agenda action.")
18986 (defun org-mark-entry-for-agenda-action ()
18987 "Mark the current entry as target of an agenda action.
18988 Agenda actions are actions executed from the agenda with the key `k',
18989 which make use of the date at the cursor."
18990 (interactive)
18991 (move-marker org-agenda-action-marker
18992 (save-excursion (org-back-to-heading t) (point))
18993 (current-buffer))
18994 (message
18995 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18997 (defun org-mark-subtree ()
18998 "Mark the current subtree.
18999 This puts point at the start of the current subtree, and mark at the end.
19001 If point is in an inline task, mark that task instead."
19002 (interactive)
19003 (let ((inline-task-p
19004 (and (featurep 'org-inlinetask)
19005 (org-inlinetask-in-task-p)))
19006 (beg))
19007 ;; Get beginning of subtree
19008 (cond
19009 (inline-task-p (org-inlinetask-goto-beginning))
19010 ((org-at-heading-p) (beginning-of-line))
19011 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19012 (setq beg (point))
19013 ;; Get end of it
19014 (if inline-task-p
19015 (org-inlinetask-goto-end)
19016 (org-end-of-subtree))
19017 ;; Mark zone
19018 (push-mark (point) nil t)
19019 (goto-char beg)))
19021 ;;; Paragraph filling stuff.
19022 ;; We want this to be just right, so use the full arsenal.
19024 (defun org-indent-line-function ()
19025 "Indent line depending on context."
19026 (interactive)
19027 (let* ((pos (point))
19028 (itemp (org-at-item-p))
19029 (case-fold-search t)
19031 (inline-task-p (and (featurep 'org-inlinetask)
19032 (org-inlinetask-in-task-p)))
19033 (inline-re (and inline-task-p
19034 (org-inlinetask-outline-regexp)))
19035 column)
19036 (beginning-of-line 1)
19037 (cond
19038 ;; Comments
19039 ((looking-at "# ") (setq column 0))
19040 ;; Headings
19042 ;; Literal examples
19044 (setq column (org-get-indentation))) ; do nothing
19045 ;; Lists
19046 ((ignore-errors (goto-char (org-in-item-p)))
19047 (setq column (if itemp
19048 (org-get-indentation)
19049 (org-list-item-body-column (point))))
19050 (goto-char pos))
19051 ;; Drawers
19053 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19054 (save-excursion
19055 (goto-char (1- (match-beginning 1)))
19056 (setq column (current-column))))
19057 ;; Special blocks
19059 (save-excursion
19060 (re-search-backward
19062 (setq column (org-get-indentation (match-string 0))))
19065 (save-excursion
19067 (setq column
19068 (if (equal (downcase (match-string 1)) "src")
19069 ;; src blocks: let `org-edit-src-exit' handle them
19070 (org-get-indentation)
19071 (org-get-indentation (match-string 0)))))
19072 ;; This line has nothing special, look at the previous relevant
19073 ;; line to compute indentation
19074 (t
19075 (beginning-of-line 0)
19076 (while (and (not (bobp))
19077 (not (looking-at org-drawer-regexp))
19078 ;; When point started in an inline task, do not move
19079 ;; above task starting line.
19080 (not (and inline-task-p
19081 (looking-at inline-re)))
19082 ;; Skip comments, verbatim, empty lines, tables,
19083 ;; inline tasks, lists, drawers and blocks.
19085 (re-search-backward org-drawer-regexp nil t))
19089 (and (ignore-errors (goto-char (org-in-item-p)))
19090 (goto-char
19091 (org-list-get-top-point (org-list-struct))))
19092 (and (not inline-task-p)
19093 (featurep 'org-inlinetask)
19094 (org-inlinetask-in-task-p)
19095 (or (org-inlinetask-goto-beginning) t))))
19096 (beginning-of-line 0))
19097 (cond
19098 ;; There was an heading above.
19100 (if (not org-adapt-indentation)
19101 (setq column 0)
19102 (goto-char (match-end 0))
19103 (setq column (current-column))))
19104 ;; A drawer had started and is unfinished
19105 ((looking-at org-drawer-regexp)
19106 (goto-char (1- (match-beginning 1)))
19107 (setq column (current-column)))
19108 ;; Else, nothing noticeable found: get indentation and go on.
19109 (t (setq column (org-get-indentation))))))
19110 ;; Now apply indentation and move cursor accordingly
19111 (goto-char pos)
19112 (if (<= (current-column) (current-indentation))
19113 (org-indent-line-to column)
19114 (save-excursion (org-indent-line-to column)))
19115 ;; Special polishing for properties, see `org-property-format'
19116 (setq column (current-column))
19117 (beginning-of-line 1)
19118 (if (looking-at
19120 (replace-match (concat (match-string 1)
19121 (format org-property-format
19122 (match-string 2) (match-string 3)))
19123 t t))
19124 (org-move-to-column column)))
19126 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19127 "Variable to store copy of `adaptive-fill-regexp'.
19128 Since `adaptive-fill-regexp' is set to never match, we need to
19129 store a backup of its value before entering `org-mode' so that
19130 the functionality can be provided as a fall-back.")
19132 (defun org-set-autofill-regexps ()
19133 (interactive)
19134 ;; In the paragraph separator we include headlines, because filling
19135 ;; text in a line directly attached to a headline would otherwise
19136 ;; fill the headline as well.
19139 ;; The paragraph starter includes hand-formatted lists.
19140 (org-set-local
19141 'paragraph-start
19142 (concat
19151 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19152 ;; But only if the user has not turned off tables or fixed-width regions
19153 (org-set-local
19154 'auto-fill-inhibit-regexp
19157 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19158 (concat
19160 (if org-enable-table-editor "|" "")
19161 (if org-enable-fixed-width-editor ":" "")
19162 "]"))))
19163 ;; We use our own fill-paragraph function, to make sure that tables
19164 ;; and fixed-width regions are not wrapped. That function will pass
19165 ;; through to `fill-paragraph' when appropriate.
19166 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19167 ;; Adaptive filling: To get full control, first make sure that
19168 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19169 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19170 (org-set-local 'org-adaptive-fill-regexp-backup
19171 adaptive-fill-regexp))
19173 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19174 (org-set-local 'adaptive-fill-function
19175 'org-adaptive-fill-function)
19176 (org-set-local
19177 'align-mode-rules-list
19178 '((org-in-buffer-settings
19180 (modes . '(org-mode))))))
19182 (defun org-fill-paragraph (&optional justify)
19183 "Re-align a table, pass through to fill-paragraph if no table."
19184 (let ((table-p (org-at-table-p))
19185 (table.el-p (org-at-table.el-p))
19186 (itemp (org-in-item-p)))
19187 (cond ((and (equal (char-after (point-at-bol)) ?*)
19188 (save-excursion (goto-char (point-at-bol))
19189 (looking-at outline-regexp)))
19190 t) ; skip headlines
19191 (table.el-p t) ; skip table.el tables
19192 (table-p (org-table-align) t) ; align Org tables
19193 (itemp ; align text in items
19194 (let* ((struct (save-excursion (goto-char itemp)
19195 (org-list-struct)))
19196 (parents (org-list-parents-alist struct))
19197 (children (org-list-get-children itemp struct parents))
19198 beg end prev next prefix)
19199 ;; Determine in which part of item point is: before
19200 ;; first child, after last child, between two
19201 ;; sub-lists, or simply in item if there's no child.
19202 (cond
19203 ((not children)
19204 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19205 beg itemp
19206 end (org-list-get-item-end itemp struct)))
19207 ((< (point) (setq next (car children)))
19208 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19209 beg itemp
19210 end next))
19211 ((> (point) (setq prev (car (last children))))
19212 (setq beg (org-list-get-item-end prev struct)
19213 end (org-list-get-item-end itemp struct)
19214 prefix (save-excursion
19215 (goto-char beg)
19217 (make-string (current-column) ?\ ))))
19218 (t (catch 'exit
19219 (while (setq next (pop children))
19220 (if (> (point) next)
19221 (setq prev next)
19222 (setq beg (org-list-get-item-end prev struct)
19223 end next
19224 prefix (save-excursion
19225 (goto-char beg)
19227 (make-string (current-column) ?\ )))
19228 (throw 'exit nil))))))
19229 ;; Use `fill-paragraph' with buffer narrowed to item
19230 ;; without any child, and with our computed PREFIX.
19231 (flet ((fill-context-prefix (from to &optional flr) prefix))
19232 (save-restriction
19233 (narrow-to-region beg end)
19234 (save-excursion (fill-paragraph justify)))) t))
19235 ;; Special case where point is not in a list but is on
19236 ;; a paragraph adjacent to a list: make sure this paragraph
19237 ;; doesn't get merged with the end of the list by narrowing
19238 ;; buffer first.
19239 ((save-excursion (forward-paragraph -1)
19240 (setq itemp (org-in-item-p)))
19241 (let ((struct (save-excursion (goto-char itemp)
19242 (org-list-struct))))
19243 (save-restriction
19244 (narrow-to-region (org-list-get-bottom-point struct)
19245 (save-excursion (forward-paragraph 1)
19246 (point)))
19247 (fill-paragraph justify) t)))
19248 ;; Else simply call `fill-paragraph'.
19249 (t nil))))
19251 ;; For reference, this is the default value of adaptive-fill-regexp
19254 (defun org-adaptive-fill-function ()
19255 "Return a fill prefix for org-mode files."
19256 (let (itemp)
19257 (save-excursion
19258 (cond
19259 ;; Comment line
19261 (match-string-no-properties 0))
19262 ;; Plain list item
19263 ((org-at-item-p)
19264 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19265 ;; Point is in a list after `backward-paragraph': original
19266 ;; point wasn't in the list, or filling would have been taken
19267 ;; care of by `org-auto-fill-function', but the list and the
19268 ;; real paragraph are not separated by a blank line. Thus, move
19269 ;; point after the list to go back to real paragraph and
19270 ;; determine fill-prefix.
19271 ((setq itemp (org-in-item-p))
19272 (goto-char itemp)
19273 (let* ((struct (org-list-struct))
19274 (bottom (org-list-get-bottom-point struct)))
19275 (goto-char bottom)
19276 (make-string (org-get-indentation) ?\ )))
19277 ;; Other text
19278 ((looking-at org-adaptive-fill-regexp-backup)
19279 (match-string-no-properties 0))))))
19281 (defun org-auto-fill-function ()
19282 "Auto-fill function."
19283 (let (itemp prefix)
19284 ;; When in a list, compute an appropriate fill-prefix and make
19285 ;; sure it will be used by `do-auto-fill'.
19286 (if (setq itemp (org-in-item-p))
19287 (progn
19288 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19289 (flet ((fill-context-prefix (from to &optional flr) prefix))
19290 (do-auto-fill)))
19291 ;; Else just use `do-auto-fill'.
19292 (do-auto-fill))))
19294 ;;; Other stuff.
19296 (defun org-toggle-fixed-width-section (arg)
19297 "Toggle the fixed-width export.
19298 If there is no active region, the QUOTE keyword at the current headline is
19299 inserted or removed. When present, it causes the text between this headline
19300 and the next to be exported as fixed-width text, and unmodified.
19301 If there is an active region, this command adds or removes a colon as the
19302 first character of this line. If the first character of a line is a colon,
19303 this line is also exported in fixed-width font."
19304 (interactive "P")
19305 (let* ((cc 0)
19306 (regionp (org-region-active-p))
19307 (beg (if regionp (region-beginning) (point)))
19308 (end (if regionp (region-end)))
19309 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19310 (case-fold-search nil)
19312 off)
19313 (if regionp
19314 (save-excursion
19315 (goto-char beg)
19316 (setq cc (current-column))
19317 (beginning-of-line 1)
19318 (setq off (looking-at re))
19319 (while (> nlines 0)
19320 (setq nlines (1- nlines))
19321 (beginning-of-line 1)
19322 (cond
19323 (arg
19324 (org-move-to-column cc t)
19326 (forward-line -1))
19327 ((and off (looking-at re))
19328 (replace-match "" t t nil 1))
19329 ((not off) (org-move-to-column cc t) (insert ": ")))
19330 (forward-line 1)))
19331 (save-excursion
19332 (org-back-to-heading)
19333 (if (looking-at (concat outline-regexp
19335 (replace-match "" t t nil 1)
19336 (if (looking-at outline-regexp)
19337 (progn
19338 (goto-char (match-end 0))
19339 (insert org-quote-string " "))))))))
19341 (defun org-reftex-citation ()
19342 "Use reftex-citation to insert a citation into the buffer.
19343 This looks for a line like
19345 #+BIBLIOGRAPHY: foo plain option:-d
19347 and derives from it that foo.bib is the bibliography file relevant
19348 for this document. It then installs the necessary environment for RefTeX
19349 to work in this buffer and calls `reftex-citation' to insert a citation
19350 into the buffer.
19352 Export of such citations to both LaTeX and HTML is handled by the contributed
19353 package org-exp-bibtex by Taru Karttunen."
19354 (interactive)
19355 (let ((reftex-docstruct-symbol 'rds)
19357 rds bib)
19358 (save-excursion
19359 (save-restriction
19360 (widen)
19361 (let ((case-fold-search t)
19363 (if (not (save-excursion
19364 (or (re-search-forward re nil t)
19365 (re-search-backward re nil t))))
19366 (error "No bibliography defined in file")
19367 (setq bib (concat (match-string 1) ".bib")
19368 rds (list (list 'bib bib)))))))
19369 (call-interactively 'reftex-citation)))
19371 ;;;; Functions extending outline functionality
19373 (defun org-beginning-of-line (&optional arg)
19374 "Go to the beginning of the current line. If that is invisible, continue
19375 to a visible line beginning. This makes the function of C-a more intuitive.
19376 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19377 first attempt, and only move to after the tags when the cursor is already
19378 beyond the end of the headline."
19379 (interactive "P")
19380 (let ((pos (point))
19381 (special (if (consp org-special-ctrl-a/e)
19382 (car org-special-ctrl-a/e)
19383 org-special-ctrl-a/e))
19384 refpos)
19385 (if (org-bound-and-true-p line-move-visual)
19386 (beginning-of-visual-line 1)
19387 (beginning-of-line 1))
19388 (if (and arg (fboundp 'move-beginning-of-line))
19389 (call-interactively 'move-beginning-of-line)
19390 (if (bobp)
19391 nil
19392 (backward-char 1)
19393 (if (org-truely-invisible-p)
19394 (while (and (not (bobp)) (org-truely-invisible-p))
19395 (backward-char 1)
19396 (beginning-of-line 1))
19397 (forward-char 1))))
19398 (when special
19399 (cond
19400 ((and (looking-at org-complex-heading-regexp)
19401 (= (char-after (match-end 1)) ?\ ))
19402 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19403 (point-at-eol)))
19404 (goto-char
19405 (if (eq special t)
19406 (cond ((> pos refpos) refpos)
19407 ((= pos (point)) refpos)
19408 (t (point)))
19409 (cond ((> pos (point)) (point))
19410 ((not (eq last-command this-command)) (point))
19411 (t refpos)))))
19412 ((org-at-item-p)
19413 (goto-char
19414 (if (eq special t)
19415 (cond ((> pos (match-end 0)) (match-end 0))
19416 ((= pos (point)) (match-end 0))
19417 (t (point)))
19418 (cond ((> pos (point)) (point))
19419 ((not (eq last-command this-command)) (point))
19420 (t (match-end 0))))))))
19421 (org-no-warnings
19422 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19424 (defun org-end-of-line (&optional arg)
19425 "Go to the end of the line.
19426 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19427 first attempt, and only move to after the tags when the cursor is already
19428 beyond the end of the headline."
19429 (interactive "P")
19430 (let ((special (if (consp org-special-ctrl-a/e)
19431 (cdr org-special-ctrl-a/e)
19432 org-special-ctrl-a/e)))
19433 (if (or (not special)
19434 (not (org-on-heading-p))
19435 arg)
19436 (call-interactively
19437 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19438 ((fboundp 'move-end-of-line) 'move-end-of-line)
19439 (t 'end-of-line)))
19440 (let ((pos (point)))
19441 (beginning-of-line 1)
19443 (if (eq special t)
19444 (if (or (< pos (match-beginning 1))
19445 (= pos (match-end 0)))
19446 (goto-char (match-beginning 1))
19447 (goto-char (match-end 0)))
19448 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19449 (goto-char (match-end 0))
19450 (goto-char (match-beginning 1))))
19451 (call-interactively (if (fboundp 'move-end-of-line)
19452 'move-end-of-line
19453 'end-of-line)))))
19454 (org-no-warnings
19455 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19457 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19458 (define-key org-mode-map "\C-e" 'org-end-of-line)
19460 (defun org-backward-sentence (&optional arg)
19461 "Go to beginning of sentence, or beginning of table field.
19462 This will call `backward-sentence' or `org-table-beginning-of-field',
19463 depending on context."
19464 (interactive "P")
19465 (cond
19466 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19467 (t (call-interactively 'backward-sentence))))
19469 (defun org-forward-sentence (&optional arg)
19470 "Go to end of sentence, or end of table field.
19471 This will call `forward-sentence' or `org-table-end-of-field',
19472 depending on context."
19473 (interactive "P")
19474 (cond
19475 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19476 (t (call-interactively 'forward-sentence))))
19478 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19479 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19481 (defun org-kill-line (&optional arg)
19482 "Kill line, to tags or end of line."
19483 (interactive "P")
19484 (cond
19485 ((or (not org-special-ctrl-k)
19486 (bolp)
19487 (not (org-on-heading-p)))
19488 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19489 org-ctrl-k-protect-subtree)
19490 (if (or (eq org-ctrl-k-protect-subtree 'error)
19491 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19492 (error "C-k aborted - would kill hidden subtree")))
19493 (call-interactively 'kill-line))
19495 (kill-region (point) (match-beginning 1))
19496 (org-set-tags nil t))
19497 (t (kill-region (point) (point-at-eol)))))
19499 (define-key org-mode-map "\C-k" 'org-kill-line)
19501 (defun org-yank (&optional arg)
19502 "Yank. If the kill is a subtree, treat it specially.
19503 This command will look at the current kill and check if is a single
19504 subtree, or a series of subtrees[1]. If it passes the test, and if the
19505 cursor is at the beginning of a line or after the stars of a currently
19506 empty headline, then the yank is handled specially. How exactly depends
19507 on the value of the following variables, both set by default.
19509 org-yank-folded-subtrees
19510 When set, the subtree(s) will be folded after insertion, but only
19511 if doing so would now swallow text after the yanked text.
19513 org-yank-adjusted-subtrees
19514 When set, the subtree will be promoted or demoted in order to
19515 fit into the local outline tree structure, which means that the level
19516 will be adjusted so that it becomes the smaller one of the two
19517 *visible* surrounding headings.
19519 Any prefix to this command will cause `yank' to be called directly with
19521 will just
19522 plainly yank the text as it is.
19524 \[1] The test checks if the first non-white line is a heading
19525 and if there are no other headings with fewer stars."
19526 (interactive "P")
19527 (org-yank-generic 'yank arg))
19529 (defun org-yank-generic (command arg)
19530 "Perform some yank-like command.
19532 This function implements the behavior described in the `org-yank'
19533 documentation. However, it has been generalized to work for any
19534 interactive command with similar behavior."
19536 ;; pretend to be command COMMAND
19537 (setq this-command command)
19539 (if arg
19540 (call-interactively command)
19542 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19543 (and (org-kill-is-subtree-p)
19544 (or (bolp)
19546 (string-match
19548 (buffer-substring (point-at-bol) (point)))))))
19549 swallowp)
19550 (cond
19551 ((and subtreep org-yank-folded-subtrees)
19552 (let ((beg (point))
19553 end)
19554 (if (and subtreep org-yank-adjusted-subtrees)
19555 (org-paste-subtree nil nil 'for-yank)
19556 (call-interactively command))
19558 (setq end (point))
19559 (goto-char beg)
19560 (when (and (bolp) subtreep
19561 (not (setq swallowp
19562 (org-yank-folding-would-swallow-text beg end))))
19563 (or (looking-at outline-regexp)
19564 (re-search-forward (concat "^" outline-regexp) end t))
19565 (while (and (< (point) end) (looking-at outline-regexp))
19566 (hide-subtree)
19567 (org-cycle-show-empty-lines 'folded)
19568 (condition-case nil
19569 (outline-forward-same-level 1)
19570 (error (goto-char end)))))
19571 (when swallowp
19572 (message
19573 "Inserted text not folded because that would swallow text"))
19575 (goto-char end)
19577 (beginning-of-line 1)
19578 (push-mark beg 'nomsg)))
19579 ((and subtreep org-yank-adjusted-subtrees)
19580 (let ((beg (point-at-bol)))
19581 (org-paste-subtree nil nil 'for-yank)
19582 (push-mark beg 'nomsg)))
19583 (t
19584 (call-interactively command))))))
19586 (defun org-yank-folding-would-swallow-text (beg end)
19587 "Would hide-subtree at BEG swallow any text after END?"
19588 (let (level)
19589 (save-excursion
19590 (goto-char beg)
19591 (when (or (looking-at outline-regexp)
19592 (re-search-forward (concat "^" outline-regexp) end t))
19593 (setq level (org-outline-level)))
19594 (goto-char end)
19596 (if (or (eobp)
19597 (and (bolp) (looking-at org-outline-regexp)
19598 (<= (org-outline-level) level)))
19599 nil ; Nothing would be swallowed
19600 t)))) ; something would swallow
19602 (define-key org-mode-map "\C-y" 'org-yank)
19604 (defun org-truely-invisible-p ()
19605 "Check if point is at a character currently not visible.
19606 This version does not only check the character property, but also
19607 `visible-mode'."
19608 ;; Early versions of noutline don't have `outline-invisible-p'.
19609 (if (org-bound-and-true-p visible-mode)
19610 nil
19611 (outline-invisible-p)))
19613 (defun org-invisible-p2 ()
19614 "Check if point is at a character currently not visible."
19615 (save-excursion
19616 (if (and (eolp) (not (bobp))) (backward-char 1))
19617 ;; Early versions of noutline don't have `outline-invisible-p'.
19618 (outline-invisible-p)))
19620 (defun org-back-to-heading (&optional invisible-ok)
19621 "Call `outline-back-to-heading', but provide a better error message."
19622 (condition-case nil
19623 (outline-back-to-heading invisible-ok)
19624 (error (error "Before first headline at position %d in buffer %s"
19625 (point) (current-buffer)))))
19627 (defun org-beginning-of-defun ()
19628 "Go to the beginning of the subtree, i.e. back to the heading."
19629 (org-back-to-heading))
19630 (defun org-end-of-defun ()
19631 "Go to the end of the subtree."
19632 (org-end-of-subtree nil t))
19634 (defun org-before-first-heading-p ()
19635 "Before first heading?"
19636 (save-excursion
19637 (end-of-line)
19640 (defun org-on-heading-p (&optional ignored)
19641 (outline-on-heading-p t))
19642 (defun org-at-heading-p (&optional ignored)
19643 (outline-on-heading-p t))
19645 (defun org-point-at-end-of-empty-headline ()
19646 "If point is at the end of an empty headline, return t, else nil.
19647 If the heading only contains a TODO keyword, it is still still considered
19648 empty."
19650 (save-excursion
19651 (beginning-of-line 1)
19654 (defun org-at-heading-or-item-p ()
19655 (or (org-on-heading-p) (org-at-item-p)))
19657 (defun org-on-target-p ()
19658 (or (org-in-regexp org-radio-target-regexp)
19659 (org-in-regexp org-target-regexp)))
19661 (defun org-up-heading-all (arg)
19662 "Move to the heading line of which the present line is a subheading.
19663 This function considers both visible and invisible heading lines.
19664 With argument, move up ARG levels."
19665 (if (fboundp 'outline-up-heading-all)
19666 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19667 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19669 (defun org-up-heading-safe ()
19670 "Move to the heading line of which the present line is a subheading.
19671 This version will not throw an error. It will return the level of the
19672 headline found, or nil if no higher level is found.
19674 Also, this function will be a lot faster than `outline-up-heading',
19675 because it relies on stars being the outline starters. This can really
19676 make a significant difference in outlines with very many siblings."
19677 (let (start-level re)
19678 (org-back-to-heading t)
19679 (setq start-level (funcall outline-level))
19680 (if (equal start-level 1)
19681 nil
19683 (if (re-search-backward re nil t)
19684 (funcall outline-level)))))
19686 (defun org-first-sibling-p ()
19687 "Is this heading the first child of its parents?"
19688 (interactive)
19689 (let ((re (concat "^" outline-regexp))
19690 level l)
19691 (unless (org-at-heading-p t)
19692 (error "Not at a heading"))
19693 (setq level (funcall outline-level))
19694 (save-excursion
19695 (if (not (re-search-backward re nil t))
19696 t
19697 (setq l (funcall outline-level))
19698 (< l level)))))
19700 (defun org-goto-sibling (&optional previous)
19701 "Goto the next sibling, even if it is invisible.
19702 When PREVIOUS is set, go to the previous sibling instead. Returns t
19703 when a sibling was found. When none is found, return nil and don't
19704 move point."
19705 (let ((fun (if previous 're-search-backward 're-search-forward))
19706 (pos (point))
19707 (re (concat "^" outline-regexp))
19708 level l)
19709 (when (condition-case nil (org-back-to-heading t) (error nil))
19710 (setq level (funcall outline-level))
19711 (catch 'exit
19712 (or previous (forward-char 1))
19713 (while (funcall fun re nil t)
19714 (setq l (funcall outline-level))
19715 (when (< l level) (goto-char pos) (throw 'exit nil))
19716 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19717 (goto-char pos)
19718 nil))))
19720 (defun org-show-siblings ()
19721 "Show all siblings of the current headline."
19722 (save-excursion
19723 (while (org-goto-sibling) (org-flag-heading nil)))
19724 (save-excursion
19725 (while (org-goto-sibling 'previous)
19726 (org-flag-heading nil))))
19728 (defun org-goto-first-child ()
19729 "Goto the first child, even if it is invisible.
19730 Return t when a child was found. Otherwise don't move point and
19731 return nil."
19732 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19733 (when (condition-case nil (org-back-to-heading t) (error nil))
19734 (setq level (outline-level))
19735 (forward-char 1)
19736 (if (and (re-search-forward re nil t) (> (outline-level) level))
19737 (progn (goto-char (match-beginning 0)) t)
19738 (goto-char pos) nil))))
19740 (defun org-show-hidden-entry ()
19741 "Show an entry where even the heading is hidden."
19742 (save-excursion
19743 (org-show-entry)))
19745 (defun org-flag-heading (flag &optional entry)
19746 "Flag the current heading. FLAG non-nil means make invisible.
19747 When ENTRY is non-nil, show the entire entry."
19748 (save-excursion
19749 (org-back-to-heading t)
19750 ;; Check if we should show the entire entry
19751 (if entry
19752 (progn
19753 (org-show-entry)
19754 (save-excursion
19755 (and (outline-next-heading)
19756 (org-flag-heading nil))))
19757 (outline-flag-region (max (point-min) (1- (point)))
19758 (save-excursion (outline-end-of-heading) (point))
19759 flag))))
19761 (defun org-get-next-sibling ()
19762 "Move to next heading of the same level, and return point.
19763 If there is no such heading, return nil.
19764 This is like outline-next-sibling, but invisible headings are ok."
19765 (let ((level (funcall outline-level)))
19766 (outline-next-heading)
19767 (while (and (not (eobp)) (> (funcall outline-level) level))
19768 (outline-next-heading))
19769 (if (or (eobp) (< (funcall outline-level) level))
19770 nil
19771 (point))))
19773 (defun org-get-last-sibling ()
19774 "Move to previous heading of the same level, and return point.
19775 If there is no such heading, return nil."
19776 (let ((opoint (point))
19777 (level (funcall outline-level)))
19778 (outline-previous-heading)
19779 (when (and (/= (point) opoint) (outline-on-heading-p t))
19780 (while (and (> (funcall outline-level) level)
19781 (not (bobp)))
19782 (outline-previous-heading))
19783 (if (< (funcall outline-level) level)
19784 nil
19785 (point)))))
19787 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19788 ;; This contains an exact copy of the original function, but it uses
19789 ;; `org-back-to-heading', to make it work also in invisible
19790 ;; trees. And is uses an invisible-OK argument.
19791 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19792 ;; Furthermore, when used inside Org, finding the end of a large subtree
19793 ;; with many children and grandchildren etc, this can be much faster
19794 ;; than the outline version.
19795 (org-back-to-heading invisible-OK)
19796 (let ((first t)
19797 (level (funcall outline-level)))
19798 (if (and (org-mode-p) (< level 1000))
19799 ;; A true heading (not a plain list item), in Org-mode
19800 ;; This means we can easily find the end by looking
19801 ;; only for the right number of stars. Using a regexp to do
19802 ;; this is so much faster than using a Lisp loop.
19804 (forward-char 1)
19805 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19806 ;; something else, do it the slow way
19807 (while (and (not (eobp))
19808 (or first (> (funcall outline-level) level)))
19809 (setq first nil)
19810 (outline-next-heading)))
19811 (unless to-heading
19813 (progn
19814 ;; Go to end of line before heading
19815 (forward-char -1)
19817 ;; leave blank line before heading
19818 (forward-char -1))))))
19819 (point))
19821 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19822 "Use Org version in org-mode, for dramatic speed-up."
19823 (if (org-mode-p)
19824 (progn
19825 (org-end-of-subtree nil t)
19826 (unless (eobp) (backward-char 1)))
19827 ad-do-it))
19829 (defun org-forward-same-level (arg &optional invisible-ok)
19830 "Move forward to the arg'th subheading at same level as this one.
19831 Stop at the first and last subheadings of a superior heading.
19832 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19833 it wil also look at invisible ones."
19834 (interactive "p")
19835 (org-back-to-heading invisible-ok)
19836 (org-on-heading-p)
19837 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19839 l)
19840 (forward-char 1)
19841 (while (> arg 0)
19842 (while (and (re-search-forward re nil 'move)
19843 (setq l (- (match-end 0) (match-beginning 0) 1))
19844 (= l level)
19845 (not invisible-ok)
19846 (progn (backward-char 1) (outline-invisible-p)))
19847 (if (< l level) (setq arg 1)))
19848 (setq arg (1- arg)))
19849 (beginning-of-line 1)))
19851 (defun org-backward-same-level (arg &optional invisible-ok)
19852 "Move backward to the arg'th subheading at same level as this one.
19853 Stop at the first and last subheadings of a superior heading."
19854 (interactive "p")
19855 (org-back-to-heading)
19856 (org-on-heading-p)
19857 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19859 l)
19860 (while (> arg 0)
19861 (while (and (re-search-backward re nil 'move)
19862 (setq l (- (match-end 0) (match-beginning 0) 1))
19863 (= l level)
19864 (not invisible-ok)
19865 (outline-invisible-p))
19866 (if (< l level) (setq arg 1)))
19867 (setq arg (1- arg)))))
19869 (defun org-show-subtree ()
19870 "Show everything after this heading at deeper levels."
19871 (outline-flag-region
19872 (point)
19873 (save-excursion
19874 (org-end-of-subtree t t))
19875 nil))
19877 (defun org-show-entry ()
19878 "Show the body directly following this heading.
19879 Show the heading too, if it is currently invisible."
19880 (interactive)
19881 (save-excursion
19882 (condition-case nil
19883 (progn
19884 (org-back-to-heading t)
19885 (outline-flag-region
19886 (max (point-min) (1- (point)))
19887 (save-excursion
19888 (if (re-search-forward
19890 (match-beginning 1)
19891 (point-max)))
19892 nil)
19893 (org-cycle-hide-drawers 'children))
19894 (error nil))))
19896 (defun org-make-options-regexp (kwds &optional extra)
19897 "Make a regular expression for keyword lines."
19898 (concat
19899 "^"
19906 ;; Make isearch reveal the necessary context
19907 (defun org-isearch-end ()
19908 "Reveal context after isearch exits."
19909 (when isearch-success ; only if search was successful
19910 (if (featurep 'xemacs)
19911 ;; Under XEmacs, the hook is run in the correct place,
19912 ;; we directly show the context.
19913 (org-show-context 'isearch)
19914 ;; In Emacs the hook runs *before* restoring the overlays.
19915 ;; So we have to use a one-time post-command-hook to do this.
19916 ;; (Emacs 22 has a special variable, see function `org-mode')
19917 (unless (and (boundp 'isearch-mode-end-hook-quit)
19918 isearch-mode-end-hook-quit)
19919 ;; Only when the isearch was not quitted.
19920 (org-add-hook 'post-command-hook 'org-isearch-post-command
19921 'append 'local)))))
19923 (defun org-isearch-post-command ()
19924 "Remove self from hook, and show context."
19925 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19926 (org-show-context 'isearch))
19929 ;;;; Integration with and fixes for other packages
19931 ;;; Imenu support
19933 (defvar org-imenu-markers nil
19934 "All markers currently used by Imenu.")
19935 (make-variable-buffer-local 'org-imenu-markers)
19937 (defun org-imenu-new-marker (&optional pos)
19938 "Return a new marker for use by Imenu, and remember the marker."
19939 (let ((m (make-marker)))
19940 (move-marker m (or pos (point)))
19941 (push m org-imenu-markers)
19942 m))
19944 (defun org-imenu-get-tree ()
19945 "Produce the index for Imenu."
19946 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19947 (setq org-imenu-markers nil)
19948 (let* ((n org-imenu-depth)
19949 (re (concat "^" outline-regexp))
19950 (subs (make-vector (1+ n) nil))
19951 (last-level 0)
19952 m level head)
19953 (save-excursion
19954 (save-restriction
19955 (widen)
19956 (goto-char (point-max))
19957 (while (re-search-backward re nil t)
19958 (setq level (org-reduced-level (funcall outline-level)))
19959 (when (<= level n)
19960 (looking-at org-complex-heading-regexp)
19961 (setq head (org-link-display-format
19962 (org-match-string-no-properties 4))
19963 m (org-imenu-new-marker))
19964 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19965 (if (>= level last-level)
19966 (push (cons head m) (aref subs level))
19967 (push (cons head (aref subs (1+ level))) (aref subs level))
19968 (loop for i from (1+ level) to n do (aset subs i nil)))
19969 (setq last-level level)))))
19970 (aref subs 1)))
19972 (eval-after-load "imenu"
19973 '(progn
19974 (add-hook 'imenu-after-jump-hook
19975 (lambda ()
19976 (if (org-mode-p)
19977 (org-show-context 'org-goto))))))
19979 (defun org-link-display-format (link)
19980 "Replace a link with either the description, or the link target
19981 if no description is present"
19982 (save-match-data
19983 (if (string-match org-bracket-link-analytic-regexp link)
19984 (replace-match (if (match-end 5)
19985 (match-string 5 link)
19986 (concat (match-string 1 link)
19987 (match-string 3 link)))
19988 nil t link)
19989 link)))
19991 ;; Speedbar support
19993 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19994 "Overlay marking the agenda restriction line in speedbar.")
19995 (overlay-put org-speedbar-restriction-lock-overlay
19996 'face 'org-agenda-restriction-lock)
19997 (overlay-put org-speedbar-restriction-lock-overlay
19998 'help-echo "Agendas are currently limited to this item.")
19999 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20001 (defun org-speedbar-set-agenda-restriction ()
20002 "Restrict future agenda commands to the location at point in speedbar.
20004 (interactive)
20005 (require 'org-agenda)
20006 (let (p m tp np dir txt)
20007 (cond
20008 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20009 'org-imenu t))
20010 (setq m (get-text-property p 'org-imenu-marker))
20011 (with-current-buffer (marker-buffer m)
20012 (goto-char m)
20013 (org-agenda-set-restriction-lock 'subtree)))
20014 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20015 'speedbar-function 'speedbar-find-file))
20016 (setq tp (previous-single-property-change
20017 (1+ p) 'speedbar-function)
20018 np (next-single-property-change
20019 tp 'speedbar-function)
20020 dir (speedbar-line-directory)
20021 txt (buffer-substring-no-properties (or tp (point-min))
20022 (or np (point-max))))
20023 (with-current-buffer (find-file-noselect
20024 (let ((default-directory dir))
20025 (expand-file-name txt)))
20026 (unless (org-mode-p)
20027 (error "Cannot restrict to non-Org-mode file"))
20028 (org-agenda-set-restriction-lock 'file)))
20029 (t (error "Don't know how to restrict Org-mode's agenda")))
20030 (move-overlay org-speedbar-restriction-lock-overlay
20031 (point-at-bol) (point-at-eol))
20032 (setq current-prefix-arg nil)
20033 (org-agenda-maybe-redo)))
20035 (eval-after-load "speedbar"
20036 '(progn
20037 (speedbar-add-supported-extension ".org")
20038 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20039 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20040 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20041 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20042 (add-hook 'speedbar-visiting-tag-hook
20043 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20045 ;;; Fixes and Hacks for problems with other packages
20047 ;; Make flyspell not check words in links, to not mess up our keymap
20048 (defun org-mode-flyspell-verify ()
20049 "Don't let flyspell put overlays at active buttons."
20050 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
20051 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
20053 (defun org-remove-flyspell-overlays-in (beg end)
20054 "Remove flyspell overlays in region."
20055 (and (org-bound-and-true-p flyspell-mode)
20056 (fboundp 'flyspell-delete-region-overlays)
20057 (flyspell-delete-region-overlays beg end))
20058 (add-text-properties beg end '(org-no-flyspell t)))
20060 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20061 (eval-after-load "bookmark"
20062 '(if (boundp 'bookmark-after-jump-hook)
20063 ;; We can use the hook
20064 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20065 ;; Hook not available, use advice
20066 (defadvice bookmark-jump (after org-make-visible activate)
20067 "Make the position visible."
20068 (org-bookmark-jump-unhide))))
20070 ;; Make sure saveplace shows the location if it was hidden
20071 (eval-after-load "saveplace"
20072 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20073 "Make the position visible."
20074 (org-bookmark-jump-unhide)))
20076 ;; Make sure ecb shows the location if it was hidden
20077 (eval-after-load "ecb"
20078 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20079 "Make hierarchy visible when jumping into location from ECB tree buffer."
20080 (if (org-mode-p)
20081 (org-show-context))))
20083 (defun org-bookmark-jump-unhide ()
20084 "Unhide the current position, to show the bookmark location."
20085 (and (org-mode-p)
20086 (or (outline-invisible-p)
20087 (save-excursion (goto-char (max (point-min) (1- (point))))
20088 (outline-invisible-p)))
20089 (org-show-context 'bookmark-jump)))
20091 ;; Make session.el ignore our circular variable
20092 (eval-after-load "session"
20093 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20095 ;;;; Experimental code
20097 (defun org-closed-in-range ()
20098 "Sparse tree of items closed in a certain time range.
20099 Still experimental, may disappear in the future."
20100 (interactive)
20101 ;; Get the time interval from the user.
20102 (let* ((time1 (org-float-time
20103 (org-read-date nil 'to-time nil "Starting date: ")))
20104 (time2 (org-float-time
20105 (org-read-date nil 'to-time nil "End date:")))
20106 ;; callback function
20107 (callback (lambda ()
20108 (let ((time
20109 (org-float-time
20110 (apply 'encode-time
20111 (org-parse-time-string
20112 (match-string 1))))))
20113 ;; check if time in interval
20114 (and (>= time time1) (<= time time2))))))
20115 ;; make tree, check each match with the callback
20118 ;;;; Finish up
20120 (provide 'org)
20122 (run-hooks 'org-load-hook)
20124 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20126 ;;; org.el ends here