| blob | 6a32bbf9ae8e9ee6442039294d9f49b6c8929185 |
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.6
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.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
192 ;;;; Customization variables
194 "Remove ID property of clones of a subtree.
195 When non-nil, clones of a subtree don't inherit the ID property.
196 Otherwise they inherit the ID property with a new unique
197 identifier."
201 ;;; Version
207 "Show the org-mode version in the echo area.
208 With prefix arg HERE, insert it at point."
234 ;;; Compatibility constants
236 ;;; The custom variables
239 "Outline-based notes management and organizer."
245 "Mode hook for Org-mode, run after the mode was turned on."
250 "Hook that is run after org.el has been loaded."
259 "Load all extensions listed in `org-modules'."
264 org-modules)
268 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
277 (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)
278 "Modules that should always be loaded together with org.el.
279 If a description starts with <C>, the file is not part of Emacs
280 and loading it will require that you have downloaded and properly installed
281 the org-mode distribution.
283 You can also use this system to load external packages (i.e. neither Org
284 core modules, nor modules from the CONTRIB directory). Just add symbols
285 to the end of the list. If the package is called org-xyz.el, then you need
286 to add the symbol `xyz', and the package must have a call to
288 (provide 'org-xyz)"
291 :type
322 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
331 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
340 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
357 "Non-nil means make shift-cursor commands select text when possible.
359 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
360 selecting a region, or enlarge regions started in this way.
361 In Org-mode, in special contexts, these same keys are used for other
362 purposes, important enough to compete with shift selection. Org tries
363 to balance these needs by supporting `shift-select-mode' outside these
364 special contexts, under control of this variable.
366 The default of this variable is nil, to avoid confusing behavior. Shifted
367 cursor keys will then execute Org commands in the following contexts:
368 - on a headline, changing TODO state (left/right) and priority (up/down)
369 - on a time stamp, changing the time
370 - in a plain list item, changing the bullet type
371 - in a property definition line, switching between allowed values
372 - in the BEGIN line of a clock table (changing the time block).
373 Outside these contexts, the commands will throw an error.
375 When this variable is t and the cursor is not in a special context,
376 Org-mode will support shift-selection for making and enlarging regions.
377 To make this more effective, the bullet cycling will no longer happen
378 anywhere in an item line, but only if the cursor is exactly on the bullet.
380 If you set this variable to the symbol `always', then the keys
381 will not be special in headlines, property lines, and item lines, to make
382 shift selection work there as well. If this is what you want, you can
383 use the following alternative commands: `C-c C-t' and `C-c ,' to
384 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
385 TODO sets, `C-c -' to cycle item bullet types, and properties can be
386 edited by hand or in column view.
388 However, when the cursor is on a timestamp, shift-cursor commands
389 will still edit the time stamp - this is just too good to give up.
391 XEmacs user should have this variable set to nil, because shift-select-mode
392 is Emacs 23 only."
400 "Options concerning startup of Org-mode."
405 "Non-nil means entering Org-mode will switch to OVERVIEW.
406 This can also be configured on a per-file basis by adding one of
407 the following lines anywhere in the buffer:
409 #+STARTUP: fold (or `overview', this is equivalent)
410 #+STARTUP: nofold (or `showall', this is equivalent)
411 #+STARTUP: content
412 #+STARTUP: showeverything"
421 "Non-nil means entering Org-mode will set `truncate-lines'.
422 This is useful since some lines containing links can be very long and
423 uninteresting. Also tables look terrible when wrapped."
428 "Non-nil means turn on `org-indent-mode' on startup.
429 This can also be configured on a per-file basis by adding one of
430 the following lines anywhere in the buffer:
432 #+STARTUP: indent
433 #+STARTUP: noindent"
441 When this option is turned on, you can use TeX-like syntax for sub- and
443 considered as a single item - so grouping with {} is normally not
444 needed. For example, the following things will be parsed as single
445 sub- or superscripts.
447 10^24 or 10^tau several digits will be considered 1 item.
448 10^-12 or 10^-tau a leading sign with digits or a word
449 x^2-y^3 will be read as x^2 - y^3, because items are
450 terminated by almost any nonword/nondigit char.
451 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
453 Still, ambiguity is possible - so when in doubt use {} to enclose the
454 sub/superscript. If you set this variable to the symbol `{}',
455 the braces are *required* in order to trigger interpretations as
457 frequently in plain text.
459 Not all export backends support this, but HTML does.
474 "Non-nil means turn on `org-beamer-mode' on startup.
475 This can also be configured on a per-file basis by adding one of
476 the following lines anywhere in the buffer:
478 #+STARTUP: beamer"
483 "Non-nil means align all tables when visiting a file.
484 This is useful when the column width in tables is forced with <N> cookies
485 in table fields. Such tables will look correct only after the first re-align.
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: align
489 #+STARTUP: noalign"
494 "Non-nil means show inline images when loading a new Org file.
495 This can also be configured on a per-file basis by adding one of
496 the following lines anywhere in the buffer:
497 #+STARTUP: inlineimages
498 #+STARTUP: noinlineimages"
503 "Non-nil means insert the first line setting Org-mode in empty files.
504 When the function `org-mode' is called interactively in an empty file, this
505 normally means that the file name does not automatically trigger Org-mode.
506 To ensure that the file will always be in Org-mode in the future, a
507 line enforcing Org-mode will be inserted into the buffer, if this option
508 has been set."
513 "Non-nil means use alternative key bindings for some keys.
514 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
515 These keys are also used by other packages like shift-selection-mode'
516 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
517 If you want to use Org-mode together with one of these other modes,
518 or more generally if you would like to move some Org-mode commands to
519 other keys, set this variable and configure the keys with the variable
520 `org-disputed-keys'.
522 This option is only relevant at load-time of Org-mode, and must be set
523 *before* org.el is loaded. Changing it requires a restart of Emacs to
524 become effective."
529 "Non-nil means use extra key sequence definitions for certain commands.
530 This happens automatically if you run XEmacs or if `window-system'
531 is nil. This variable lets you do the same manually. You must
532 set it before loading org.
534 Example: on Carbon Emacs 22 running graphically, with an external
535 keyboard on a Powerbook, the default way of setting M-left might
536 not work for either Alt or ESC. Setting this variable will make
537 it work for ESC."
551 "Keys for which Org-mode and other modes compete.
552 This is an alist, cars are the default keys, second element specifies
553 the alternative to use when `org-replace-disputed-keys' is t.
555 Keys can be specified in any syntax supported by `define-key'.
556 The value of this option takes effect only at Org-mode's startup,
557 therefore you'll have to restart Emacs to apply it after changing."
562 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
563 Or return the original if not disputed.
564 Also apply the translations defined in `org-xemacs-key-equivalents'."
569 org-disputed-keys)))
573 key)
583 "Define a key, possibly translated, as returned by `org-key'."
587 "The ellipsis to use in the Org-mode outline.
588 When nil, just use the standard three dots. When a string, use that instead,
589 When a face, use the standard 3 dots, but with the specified face.
590 The change affects only Org-mode (which will then use its own display table).
591 Changing this requires executing `M-x org-mode' in a buffer to become
592 effective."
602 "Keywords in Org-mode."
607 "String to mark deadline entries.
608 A deadline 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 to mark scheduled TODO entries.
617 A schedule is this string, followed by a time stamp. Should be a word,
618 terminated by a colon. You can insert a schedule keyword and
620 Changes become only effective after restarting Emacs."
625 "String used as the prefix for timestamps logging closing a TODO entry."
630 "String used as prefix for timestamps clocking work hours on an item."
635 "Entries starting with this keyword will never be exported.
636 An entry can be toggled between COMMENT and normal with
638 Changes become only effective after restarting Emacs."
643 "Entries starting with this keyword will be exported in fixed-width font.
644 Quoting applies only to the text in the entry following the headline, and does
645 not extend beyond the next headline, even if that is lower level.
646 An entry can be toggled between QUOTE and normal with
653 "Regular expression for specifying repeated events.
657 "Options concerning the general structure of Org-mode files."
662 "Options about how to make context of a location visible."
686 "Non-nil means show full hierarchy when revealing a location.
687 Org-mode often shows locations in an org-mode file which might have
688 been invisible before. When this is set, the hierarchy of headings
689 above the exposed location is shown.
690 Turning this off for example for sparse trees makes them very compact.
691 Instead of t, this can also be an alist specifying this option for different
692 contexts. Valid contexts are
693 agenda when exposing an entry from the agenda
694 org-goto when using the command `org-goto' on key C-c C-j
695 occur-tree when using the command `org-occur' on key C-c /
696 tags-tree when constructing a sparse tree based on tags matches
697 link-search when exposing search matches associated with a link
698 mark-goto when exposing the jump goal of a mark
699 bookmark-jump when exposing a bookmark location
700 isearch when exiting from an incremental search
701 default default for all contexts not set explicitly"
706 "Non-nil means show following heading when revealing a location.
707 Org-mode often shows locations in an org-mode file which might have
708 been invisible before. When this is set, the heading following the
709 match is shown.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show all sibling heading when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the sibling of the current entry
722 heading are all made visible. If `org-show-hierarchy-above' is t,
723 the same happens on each level of the hierarchy above the current entry.
725 By default this is on for the isearch context, off for all other contexts.
726 Turning this off for example for sparse trees makes them very compact,
727 but makes it harder to edit the location of the match. In such a case,
729 Instead of t, this can also be an alist specifying this option for different
730 contexts. See `org-show-hierarchy-above' for valid contexts."
735 "Non-nil means show the entry below a headline when revealing a location.
736 Org-mode often shows locations in an org-mode file which might have
737 been invisible before. When this is set, the text below the headline that is
738 exposed is also shown.
740 By default this is off for all contexts.
741 Instead of t, this can also be an alist specifying this option for different
742 contexts. See `org-show-hierarchy-above' for valid contexts."
747 "How should indirect tree buffers be displayed?
748 This applies to indirect buffers created with the commands
750 Valid values are:
751 current-window Display in the current window
752 other-window Just display in another window.
753 dedicated-frame Create one new frame, and re-use it each time.
754 new-frame Make a new frame each time. Note that in this case
755 previously-made indirect buffers are kept, and you need to
756 kill these buffers yourself."
766 "Non-nil means activate single letter commands at beginning of a headline.
767 This may also be a function to test for appropriate locations where speed
768 commands should be active."
776 "Alist of additional speed commands.
777 This list will be checked before `org-speed-commands-default'
778 when the variable `org-use-speed-commands' is non-nil
779 and when the cursor is at the beginning of a headline.
780 The car if each entry is a string with a single letter, which must
781 be assigned to `self-insert-command' in the global map.
782 The cdr is either a command to be called interactively, a function
783 to be called, or a form to be evaluated.
784 An entry that is just a list with a single string will be interpreted
785 as a descriptive headline that will be added when listing the speed
786 commands in the Help buffer using the `?' speed command."
798 "Options concerning visibility cycling in Org-mode."
803 "Non-nil means skip CHILDREN state in entries that don't have any."
808 "Maximum level which should still be subject to visibility cycling.
809 Levels higher than this will, for cycling, be treated as text, not a headline.
810 When `org-odd-levels-only' is set, a value of N in this variable actually
811 means 2N-1 stars as the limiting headline.
812 When nil, cycle all levels.
813 Note that the limiting level of cycling is also influenced by
814 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
815 `org-inlinetask-min-level' is, cycling will be limited to levels one less
816 than its value."
823 "Names of drawers. Drawers are not opened by cycling on the headline above.
824 Drawers only open with a TAB on the drawer line itself. A drawer looks like
825 this:
826 :DRAWERNAME:
827 .....
828 :END:
830 the property API.
832 Drawers can be defined on the per-file basis with a line like:
834 #+DRAWERS: HIDDEN STATE PROPERTIES"
840 "Non-nil means entering Org-mode will fold all blocks.
841 This can also be set in on a per-file basis with
843 #+STARTUP: hideblocks
844 #+STARTUP: showblocks"
850 "Cycle globally if cursor is at beginning of buffer and not at a headline.
851 This makes it possible to do global cycling without having to use S-TAB or
853 of the buffer
854 must not be a headline - it may be empty or some other text. When used in
855 this way, `org-cycle-hook' is disables temporarily, to make sure the
856 cursor stays at the beginning of the buffer.
857 When this option is nil, don't do anything special at the beginning
858 of the buffer."
863 "Non-nil means cycle entry level or item indentation in new empty entries.
865 When the cursor is at the end of an empty headline, i.e with only stars
866 and maybe a TODO keyword, TAB will then switch the entry to become a child,
867 and then all possible ancestor states, before returning to the original state.
868 This makes data entry extremely fast: M-RET to create a new headline,
869 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
871 When the cursor is at the end of an empty plain list item, one TAB will
872 make it a subitem, two or more tabs will back up to make this an item
873 higher up in the item hierarchy."
878 "Where should `org-cycle' emulate TAB.
879 nil Never
880 white Only in completely white lines
881 whitestart Only at the beginning of lines, before the first non-white char
882 t Everywhere except in headlines
883 exc-hl-bol Everywhere except at the start of a headline
884 If TAB is used in a place where it does not emulate TAB, the current subtree
885 visibility is cycled."
892 ))
895 "Number of empty lines needed to keep an empty line between collapsed trees.
896 If you leave an empty line between the end of a subtree and the following
897 headline, this empty line is hidden when the subtree is folded.
898 Org-mode will leave (exactly) one empty line visible if the number of
899 empty lines is equal or larger to the number given in this variable.
900 So the default 2 means at least 2 empty lines after the end of a subtree
901 are needed to produce free space between a collapsed subtree and the
902 following headline.
904 If the number is negative, and the number of empty lines is at least -N,
905 all empty lines are shown.
907 Special case: when 0, never leave empty lines in collapsed view."
913 "Hook that is run before visibility cycling is happening.
914 The function(s) in this hook must accept a single argument which indicates
915 the new state that will be set right after running this hook. The
916 argument is a symbol. Before a global state change, it can have the values
917 `overview', `content', or `all'. Before a local state change, it can have
918 the values `folded', `children', or `subtree'."
923 org-cycle-hide-drawers
924 org-cycle-show-empty-lines
925 org-optimize-window-after-visibility-change)
926 "Hook that is run after `org-cycle' has changed the buffer visibility.
927 The function(s) in this hook must accept a single argument which indicates
928 the new state that was set by the most recent `org-cycle' command. The
929 argument is a symbol. After a global state change, it can have the values
930 `overview', `content', or `all'. After a local state change, it can have
931 the values `folded', `children', or `subtree'."
936 "Options concerning structure editing in Org-mode."
941 "Non-nil means skip even levels and only use odd levels for the outline.
942 This has the effect that two stars are being added/taken away in
943 promotion/demotion commands. It also influences how levels are
944 handled by the exporters.
945 Changing it requires restart of `font-lock-mode' to become effective
946 for fontification also in regions already fontified.
947 You may also set this on a per-file basis by adding one of the following
948 lines to the buffer:
950 #+STARTUP: odd
951 #+STARTUP: oddeven"
957 "Non-nil means adapt indentation to outline node level.
959 When this variable is set, Org assumes that you write outlines by
960 indenting text in each node to align with the headline (after the stars).
961 The following issues are influenced by this variable:
963 - When this is set and the *entire* text in an entry is indented, the
964 indentation is increased by one space in a demotion command, and
965 decreased by one in a promotion command. If any line in the entry
966 body starts with text at column 0, indentation is not changed at all.
968 - Property drawers and planning information is inserted indented when
969 this variable s set. When nil, they will not be indented.
971 - TAB indents a line relative to context. The lines below a headline
972 will be indented when this variable is set.
974 Note that this is all about true indentation, by adding and removing
975 space characters. See also `org-indent.el' which does level-dependent
976 indentation in a virtual way, i.e. at display time in Emacs."
981 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
983 When t, `C-a' will bring back the cursor to the beginning of the
984 headline text, i.e. after the stars and after a possible TODO keyword.
985 In an item, this will be the position after the bullet.
986 When the cursor is already at that position, another `C-a' will bring
987 it to the beginning of the line.
989 `C-e' will jump to the end of the headline, ignoring the presence of tags
990 in the headline. A second `C-e' will then jump to the true end of the
991 line, after any tags. This also means that, when this variable is
992 non-nil, `C-e' also will never jump beyond the end of the heading of a
993 folded section, i.e. not after the ellipses.
995 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
996 going to the true line boundary first. Only a directly following, identical
997 keypress will bring the cursor to the special positions.
999 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1000 set separately."
1019 "Non-nil means `C-k' will behave specially in headlines.
1020 When nil, `C-k' will call the default `kill-line' command.
1021 When t, the following will happen while the cursor is in the headline:
1023 - When the cursor is at the beginning of a headline, kill the entire
1024 line and possible the folded subtree below the line.
1025 - When in the middle of the headline text, kill the headline up to the tags.
1026 - When after the headline text, kill the tags."
1031 "Non-nil means, do not delete a hidden subtree with C-k.
1032 When set to the symbol `error', simply throw an error when C-k is
1033 used to kill (part-of) a headline that has hidden text behind it.
1034 Any other non-nil value will result in a query to the user, if it is
1035 OK to kill that hidden subtree. When nil, kill without remorse."
1043 "Non-nil means when yanking subtrees, fold them.
1044 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1045 it starts with a heading and all other headings in it are either children
1046 or siblings, then fold all the subtrees. However, do this only if no
1047 text after the yank would be swallowed into a folded tree by this action."
1052 "Non-nil means when yanking subtrees, adjust the level.
1053 With this setting, `org-paste-subtree' is used to insert the subtree, see
1054 this function for details."
1059 "Non-nil means M-RET will split the line at the cursor position.
1060 When nil, it will go to the end of the line before making a
1061 new line.
1062 You may also set this option in a different way for different
1063 contexts. Valid contexts are:
1065 headline when creating a new headline
1066 item when creating a new item
1067 table in a table field
1068 default the value to be used for all contexts not explicitly
1069 customized"
1086 "Non-nil means insert new headings after the current subtree.
1087 When nil, the new heading is created directly after the current line.
1090 for the duration of the command."
1096 "Should `org-insert-heading' leave a blank line before new heading/item?
1097 The value is an alist, with `heading' and `plain-list-item' as CAR,
1098 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1099 which case Org will look at the surrounding headings/items and try to
1100 make an intelligent decision whether to insert a blank line or not.
1102 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1103 set, the setting here is ignored and no empty line is inserted, to avoid
1104 breaking the list structure."
1117 "Hook being run after inserting a new heading."
1123 This currently only means they are never auto-wrapped.
1124 When nil, such lines will be treated like ordinary lines.
1125 See also the QUOTE keyword."
1130 "Non-nil means typing characters in `org-goto' starts incremental search."
1135 "Options concerning sparse trees in Org-mode."
1140 "Non-nil means highlight all matches that define a sparse tree.
1141 The highlights will automatically disappear the next time the buffer is
1142 changed by an edit command."
1147 "Non-nil means any change to the buffer will remove temporary highlights.
1148 Such highlights are created by `org-occur' and `org-clock-display'.
1149 When nil, `C-c C-c needs to be used to get rid of the highlights.
1150 The highlights created by `org-preview-latex-fragment' always need
1151 `C-c C-c' to be removed."
1158 "Hook that is run after `org-occur' has constructed a sparse tree.
1159 This can be used to recenter the window to show as much of the structure
1160 as possible."
1165 "Options concerning imenu and speedbar in Org-mode."
1170 "The maximum level for Imenu access to Org-mode headlines.
1171 This also applied for speedbar access."
1176 "Options concerning tables in Org-mode."
1182 When nil, such lines will be treated like ordinary lines.
1184 When equal to the symbol `optimized', the table editor will be optimized to
1185 do the following:
1186 - Automatic overwrite mode in front of whitespace in table fields.
1187 This makes the structure of the table stay in tact as long as the edited
1188 field does not exceed the column width.
1189 - Minimize the number of realigns. Normally, the table is aligned each time
1190 TAB or RET are pressed to move to another field. With optimization this
1191 happens only if changes to a field might have changed the column width.
1192 Optimization requires replacing the functions `self-insert-command',
1193 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1194 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1195 very good at guessing when a re-align will be necessary, but you can always
1198 If you would like to use the optimized version in Org-mode, but the
1199 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1201 This variable can be used to turn on and off the table editor during a session,
1202 but in order to toggle optimization, a restart is required.
1204 See also the variable `org-table-auto-blank-field'."
1212 "Non-nil means cluster self-insert commands for undo when possible.
1213 If this is set, then, like in the Emacs command loop, 20 consecutive
1214 characters will be undone together.
1215 This is configurable, because there is some impact on typing performance."
1220 "Non-nil means TAB will automatically notice a table.el table.
1221 When it sees such a table, it moves point into it and - if necessary -
1222 calls `table-recognize-table'."
1227 "Options concerning links in Org-mode."
1232 "Buffer-local version of `org-link-abbrev-alist', which see.
1237 "Alist of link abbreviations.
1238 The car of each element is a string, to be replaced at the start of a link.
1240 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1242 [[linkkey:tag][description]]
1244 The 'linkkey' must be a word word, starting with a letter, followed
1245 by letters, numbers, '-' or '_'.
1247 If REPLACE is a string, the tag will simply be appended to create the link.
1250 be inserted at that point (see the function `url-hexify-string').
1252 REPLACE may also be a function that will be called with the tag as the
1253 only argument to create the link, which should be returned as a string.
1255 See the manual for examples."
1265 "Non-nil means hide link part and only show description of bracket links.
1266 Bracket links are like [[link][description]]. This variable sets the initial
1267 state in new org-mode buffers. The setting can then be toggled on a
1268 per-buffer basis from the Org->Hyperlinks menu."
1273 "How the path name in file links should be stored.
1274 Valid values are:
1276 relative Relative to the current directory, i.e. the directory of the file
1277 into which the link is being inserted.
1278 absolute Absolute path, if possible with ~ for home directory.
1279 noabbrev Absolute path, no abbreviation of home directory.
1280 adaptive Use relative path for files in the current directory and sub-
1281 directories of it. For other files, use an absolute path."
1290 "Types of links that should be activated in Org-mode files.
1291 This is a list of symbols, each leading to the activation of a certain link
1292 type. In principle, it does not hurt to turn on most link types - there may
1293 be a small gain when turning off unused link types. The types are:
1295 bracket The recommended [[link][description]] or [[link]] links with hiding.
1296 angle Links in angular brackets that may contain whitespace like
1297 <bbdb:Carsten Dominik>.
1298 plain Plain links in normal text, no whitespace, like http://google.com.
1299 radio Text that is matched by a radio target, see manual for details.
1300 tag Tag settings in a headline (link to tag search).
1301 date Time stamps (link to calendar).
1302 footnote Footnote labels.
1304 Changing this variable requires a restart of Emacs to become effective."
1316 "Function to use to generate link descriptions from links.
1317 If nil the link location will be used. This function must take
1318 two parameters; the first is the link and the second the
1319 description `org-insert-link' has generated, and should return the
1320 description to use."
1325 "Options concerning storing links in Org-mode."
1330 "Format of the description part of a link to an email or usenet message.
1331 The following %-escapes will be replaced by corresponding information:
1339 %s subject
1340 %d date
1341 %m message-id.
1343 You may use normal field width specification between the % and the letter.
1344 This is for example useful to limit the length of the subject.
1358 It should match if the message is from the user him/herself."
1363 "Non-nil means storing a link to an Org file will use entry IDs.
1365 Note that before this variable is even considered, org-id must be loaded,
1366 so please customize `org-modules' and turn it on.
1368 The variable can have the following values:
1370 t Create an ID if needed to make a link to the current entry.
1372 create-if-interactive
1373 If `org-store-link' is called directly (interactively, as a user
1374 command), do create an ID to support the link. But when doing the
1375 job for remember, only use the ID if it already exists. The
1376 purpose of this setting is to avoid proliferation of unwanted
1377 IDs, just because you happen to be in an Org file when you
1378 call `org-remember' that automatically and preemptively
1379 creates a link. If you do want to get an ID link in a remember
1380 template to an entry not having an ID, create it first by
1381 explicitly creating a link to it, using `C-c C-l' first.
1383 create-if-interactive-and-no-custom-id
1384 Like create-if-interactive, but do not create an ID if there is
1385 a CUSTOM_ID property defined in the entry. This is the default.
1387 use-existing
1388 Use existing ID, do not create one.
1390 nil Never use an ID to make a link, instead link using a text search for
1391 the headline text."
1396 create-if-interactive)
1398 create-if-interactive-and-no-custom-id)
1403 "Non-nil means file links from `org-store-link' contain context.
1404 A search string will be added to the file name with :: as separator and
1405 used to find the context when the link is activated by the command
1406 `org-open-at-point'. When this option is t, the entire active region
1407 will be placed in the search string of the file link. If set to a
1408 positive integer, only the first n lines of context will be stored.
1411 negates this setting for the duration of the command."
1416 "Non-nil means keep link in list for entire session.
1418 The command `org-store-link' adds a link pointing to the current
1419 location to an internal list. These links accumulate during a session.
1420 The command `org-insert-link' can be used to insert links into any
1421 Org-mode file (offering completion for all stored links). When this
1423 will be removed from the list, to make completing the unused links
1424 more efficient."
1429 "Options concerning following links in Org-mode."
1434 "Function to translate links with different syntax to Org syntax.
1435 This can be used to translate links created for example by the Planner
1436 or emacs-wiki packages to Org syntax.
1437 The function must accept two parameters, a TYPE containing the link
1439 which is everything after the link protocol. It should return a cons
1440 with possibly modified values of type and path.
1441 Org contains a function for this, so if you set this variable to
1442 `org-translate-link-from-planner', you should be able follow many
1443 links created by planner."
1448 "Hook that is run after a link has been followed."
1453 "Non-nil means on links TAB will follow the link.
1454 Needs to be set before org.el is loaded.
1455 This really should not be used, it does not make sense, and the
1456 implementation is bad."
1461 "Non-nil means on links RET will follow the link."
1467 "Non-nil means mouse-1 on a link will follow the link.
1468 A longer mouse click will still set point. Does not work on XEmacs.
1469 Needs to be set before org.el is loaded."
1474 "Number of different positions to be recorded in the ring.
1475 Changing this requires a restart of Emacs to work correctly."
1480 "Non-nil means internal links in Org files must exactly match a headline.
1481 When nil, the link search tries to match a phrase with all words
1482 in the search text."
1488 query-to-create)))
1495 "Setup the frame configuration for following links.
1496 When following a link with Emacs, it may often be useful to display
1497 this link in another window or frame. This variable can be used to
1498 set this up for the different types of links.
1499 For VM, use any of
1500 `vm-visit-folder'
1501 `vm-visit-folder-other-window'
1502 `vm-visit-folder-other-frame'
1503 For Gnus, use any of
1504 `gnus'
1505 `gnus-other-frame'
1506 `org-gnus-no-new-news'
1507 For FILE, use any of
1508 `find-file'
1509 `find-file-other-window'
1510 `find-file-other-frame'
1511 For Wanderlust use any of
1512 `wl'
1513 `wl-other-frame'
1514 For the calendar, use the variable `calendar-setup'.
1515 For BBDB, it is currently only possible to display the matches in
1516 another window."
1540 "Non-nil means use indirect buffer to display infile links.
1541 Activating internal links (from one location in a file to another location
1542 in the same file) normally just jumps to the location. When the link is
1544 is displayed in
1545 another window. When this option is set, the other window actually displays
1546 an indirect buffer clone of the current buffer, to avoid any visibility
1547 changes to the current buffer."
1552 "Non-nil means `org-open-file' will open non-existing files.
1553 When nil, an error will be generated.
1554 This variable applies only to external applications because they
1555 might choke on non-existing files. If the link is to a file that
1556 will be opened in Emacs, the variable is ignored."
1561 "Non-nil means a link to a directory really means to index.org.
1562 When nil, following a directory link will run dired or open a finder/explorer
1563 window on that directory."
1568 "Function and arguments to call for following mailto links.
1569 This is a list with the first element being a Lisp function, and the
1570 remaining elements being arguments to the function. In string arguments,
1571 %a will be replaced by the address, and %s will be replaced by the subject
1572 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1581 "Non-nil means ask for confirmation before executing shell links.
1582 Shell links can be dangerous: just think about a link
1584 [[shell:rm -rf ~/*][Google Search]]
1587 but really it would remove your entire home directory.
1588 Therefore we advise against setting this variable to nil.
1589 Just change it to `y-or-n-p' if you want to confirm with a
1597 'safe-local-variable
1601 "A regexp to skip confirmation for shell links."
1606 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1607 Elisp links can be dangerous: just think about a link
1612 but really it would remove your entire home directory.
1613 Therefore we advise against setting this variable to nil.
1614 Just change it to `y-or-n-p' if you want to confirm with a
1622 'safe-local-variable
1626 "A regexp to skip confirmation for Elisp links."
1634 "Default file applications on a UNIX or GNU/Linux system.
1645 "Default file applications on a MacOS X system.
1647 for some files for which the OS does not have a good default.
1655 'mswindows-shell-execute
1660 'mswindows-shell-execute
1663 "Default file applications on a Windows NT system.
1668 '(
1673 )
1674 "External applications for opening `file:path' items in a document.
1675 Org-mode uses system defaults for different file types, but
1676 you can use this variable to set the application for a given file
1677 extension. The entries in this list are cons cells where the car identifies
1678 files and the cdr the corresponding command. Possible values for the
1679 file identifier are
1681 ways, depending on its contents:
1683 - Alphanumeric characters only:
1684 Match links with this file extension.
1686 to open PDFs with evince.
1688 - Regular expression: Match links where the
1689 filename matches the regexp. If you want to
1690 use groups here, use shy groups.
1694 to open *.html and *.xhtml with firefox.
1696 - Regular expression which contains (non-shy) groups:
1698 anything after that, matches the regexp.
1699 In a custom command string, %1, %2, etc. are replaced with
1700 the parts of the link that were matched by the groups.
1701 For backwards compatibility, if a command string is given
1702 that does not use any of the group matches, this case is
1703 handled identically to the second one (i.e. match against
1704 file name only).
1705 In a custom lisp form, you can access the group matches with
1706 (match-string n link).
1709 to open [[file:document.pdf::5]] with evince at page 5.
1711 `directory' Matches a directory
1712 `remote' Matches a remote file, accessible through tramp or efs.
1713 Remote files most likely should be visited through Emacs
1714 because external applications cannot handle such paths.
1715 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1716 so all files Emacs knows how to handle. Using this with
1717 command `emacs' will open most files in Emacs. Beware that this
1718 will also open html files inside Emacs, unless you add
1720 t Default for files not matched by any of the other options.
1721 `system' The system command to open files, like `open' on Windows
1722 and Mac OS X, and mailcap under GNU/Linux. This is the command
1723 that will be selected if you call `C-c C-o' with a double
1726 Possible values for the command are:
1727 `emacs' The file will be visited by the current Emacs process.
1728 `default' Use the default application for this file type, which is the
1729 association for t in the list, most likely in the system-specific
1730 part.
1731 This can be used to overrule an unwanted setting in the
1732 system-specific variable.
1734 This command is specified by the entry whose car is `system'.
1735 Most likely, the system-specific version of this variable
1736 does define this command, but you can overrule/replace it
1737 here.
1738 string A command to be executed by a shell; %s will be replaced
1739 by the path to the file.
1740 sexp A Lisp form which will be evaluated. The file path will
1741 be available in the Lisp variable `file'.
1742 For more examples, see the system specific constants
1743 `org-file-apps-defaults-macosx'
1744 `org-file-apps-defaults-windowsnt'
1745 `org-file-apps-defaults-gnu'."
1755 auto-mode))
1766 "Options concerning refiling entries in Org-mode."
1771 "Directory with org files.
1772 This is just a default location to look for Org files. There is no need
1773 at all to put your files into this directory. It is only used in the
1774 following situations:
1776 1. When a remember template specifies a target file that is not an
1777 absolute path. The path will then be interpreted relative to
1778 `org-directory'
1779 2. When a remember note is filed away in an interactive way (when exiting the
1780 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1781 with `org-directory' as the default path."
1787 "Default target for storing notes.
1788 Used as a fall back file for org-remember.el and org-capture.el, for
1789 templates that do not specify a target file."
1794 file))
1797 "The default interface to be used for `org-goto'.
1798 Allowed values are:
1799 outline The interface shows an outline of the relevant file
1800 and the correct heading is found by moving through
1801 the outline or by searching with incremental search.
1802 outline-path-completion Headlines in the current buffer are offered via
1803 completion. This is the interface also used by
1804 the refile command."
1811 "Maximum target level when running `org-goto' with refile interface."
1816 "Non-nil means store new notes at the beginning of a file or entry.
1817 When nil, new notes will be filed to the end of a file or entry.
1818 This can also be a list with cons cells of regular expressions that
1819 are matched against file names, and values."
1829 "Information to record when a task is refiled.
1831 Possible values are:
1833 nil Don't add anything
1834 time Add a time stamp to the task
1835 note Prompt for a note and add it with template `org-log-note-headings'
1837 This option can also be set with on a per-file-basis with
1839 #+STARTUP: nologrefile
1840 #+STARTUP: logrefile
1841 #+STARTUP: lognoterefile
1843 You can have local logging settings for a subtree by setting the LOGGING
1844 property to one or more of these keywords.
1846 When bulk-refiling from the agenda, the value `note' is forbidden and
1847 will temporarily be changed to `time'."
1857 This is list of cons cells. Each cell contains:
1858 - a specification of the files to be considered, either a list of files,
1859 or a symbol whose function or variable value will be used to retrieve
1860 a file name or a list of file names. If you use `org-agenda-files' for
1861 that, all agenda files will be scanned for targets. Nil means consider
1862 headings in the current buffer.
1863 - A specification of how to find candidate refile targets. This may be
1864 any of:
1866 This tag has to be present in all target headlines, inheritance will
1867 not be considered.
1869 todo keyword.
1871 headlines that are refiling targets.
1872 - a cons cell (:level . N). Any headline of level N is considered a target.
1873 Note that, when `org-odd-levels-only' is set, level corresponds to
1874 order in hierarchy, not to the number of stars.
1875 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1876 Note that, when `org-odd-levels-only' is set, level corresponds to
1877 order in hierarchy, not to the number of stars.
1879 You can set the variable `org-refile-target-verify-function' to a function
1880 to verify each headline found by the simple criteria above.
1882 When this variable is nil, all top-level headlines in the current buffer
1883 are used, equivalent to the value `((nil . (:level . 1))'."
1899 "Function to verify if the headline at point should be a refile target.
1900 The function will be called without arguments, with point at the
1901 beginning of the headline. It should return t and leave point
1902 where it is if the headline is a valid target for refiling.
1904 If the target should not be selected, the function must return nil.
1905 In addition to this, it may move point to a place from where the search
1906 should be continued. For example, the function may decide that the entire
1907 subtree of the current entry should be excluded and move point to the end
1908 of the subtree."
1913 "Non-nil means cache refile targets to speed up the process.
1914 The cache for a particular file will be updated automatically when
1915 the buffer has been killed, or when any of the marker used for flagging
1916 refile targets no longer points at a live buffer.
1917 If you have added new entries to a buffer that might themselves be targets,
1918 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1919 find that easier, `C-u C-u C-u C-c C-w'."
1924 "Non-nil means provide refile targets as paths.
1925 So a level 3 headline will be available as level1/level2/level3.
1927 When the value is `file', also include the file name (without directory)
1928 into the path. In this case, you can also stop the completion after
1929 the file name, to get entries inserted as top level in the file.
1931 When `full-file-path', include the full file path."
1940 "Non-nil means complete the outline path in hierarchical steps.
1941 When Org-mode uses the refile interface to select an outline path
1942 \(see variable `org-refile-use-outline-path'), the completion of
1943 the path can be done is a single go, or if can be done in steps down
1944 the headline hierarchy. Going in steps is probably the best if you
1945 do not use a special completion package like `ido' or `icicles'.
1946 However, when using these packages, going in one step can be very
1947 fast, while still showing the whole path to the entry."
1952 "Non-nil means allow to create new nodes as refile targets.
1954 of an existing node. When the value of this variable is `confirm',
1955 new node creation must be confirmed by the user (recommended)
1956 When nil, the completion must match an existing entry.
1958 Note that, if the new heading is not seen by the criteria
1959 listed in `org-refile-targets', multiple instances of the same
1960 heading would be created by trying again to file under the new
1961 heading."
1969 "Options concerning TODO items in Org-mode."
1974 "Options concerning Progress logging in Org-mode."
1981 "The available interpretation symbols for customizing `org-todo-keywords'.
1985 "Shall some commands act upon siblings in the active region?
1986 The list of commands is:
1987 - `org-schedule'
1988 - `org-deadline'
1989 - `org-archive-subtree'
1990 - `org-archive-to-archive-sibling'
1991 - `org-archive-set-tag'
1992 - `org-toggle-archive-tag'"
1997 "List of TODO entry keyword sequences and their interpretation.
2000 Each sequence starts with a symbol, either `sequence' or `type',
2001 indicating if the keywords should be interpreted as a sequence of
2002 action steps, or as different types of TODO items. The first
2003 keywords are states requiring action - these states will select a headline
2004 for inclusion into the global TODO list Org-mode produces. If one of
2007 the last keyword is treated as the only DONE state of the sequence.
2010 additional state where no keyword is present. For details about this
2011 cycling, see the manual.
2013 TODO keywords and interpretation can also be set on a per-file basis with
2014 the special #+SEQ_TODO and #+TYP_TODO lines.
2016 Each keyword can optionally specify a character for fast state selection
2017 \(in combination with the variable `org-use-fast-todo-selection')
2018 and specifiers for state change logging, using the same syntax
2021 indicates to record a time stamp each time this state is selected.
2023 Each keyword may also specify if a timestamp or a note should be
2024 recorded when entering or leaving the state, by adding additional
2025 characters in the parenthesis after the keyword. This looks like this:
2027 record only the time of the state change. With X and Y being either
2029 Y when leaving the state if and only if the *target* state does not
2030 define X. You may omit any of the fast-selection key or X or /Y,
2031 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2033 For backward compatibility, this variable may also be just a list
2034 of keywords - in this case the interpretation (sequence or type) will be
2035 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2045 ;;Quick and dirty way to see
2046 ;;`org-todo-interpretations'. This takes the
2047 ;;place of item arguments
2048 :convert-widget
2055 org-todo-interpretation-widgets))
2056 widget))
2087 "Controls how TODO keywords are interpreted.
2088 This variable is in principle obsolete and is only used for
2089 backward compatibility, if the interpretation of todo keywords is
2090 not given already in `org-todo-keywords'. See that variable for
2091 more information."
2098 "Non-nil means use the fast todo selection scheme with C-c C-t.
2099 This variable describes if and under what circumstances the cycling
2100 mechanism for TODO keywords will be replaced by a single-key, direct
2101 selection scheme.
2103 When nil, fast selection is never used.
2105 When the symbol `prefix', it will be used when `org-todo' is called with
2106 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2107 in an agenda buffer.
2109 When t, fast selection is used by default. In this case, the prefix
2110 argument forces cycling instead.
2112 In all cases, the special interface is only used if access keys have actually
2113 been assigned by the user, i.e. if keywords in the configuration are followed
2114 by a letter in parenthesis, like TODO(t)."
2122 "Non-nil means update todo statistics after insert and toggle.
2123 ALL-HEADLINES means update todo statistics by including headlines
2124 with no TODO keyword as well, counting them as not done.
2125 A list of TODO keywords means the same, but skip keywords that are
2126 not in this list.
2128 When this is set, todo statistics is updated in the parent of the
2129 current entry each time a todo state is changed."
2139 "Non-nil means TODO statistics covers just direct children.
2140 When nil, all entries in the subtree are considered.
2141 This has only an effect if `org-provide-todo-statistics' is set.
2142 To set this to nil for only a single subtree, use a COOKIE_DATA
2148 "Hook which is run after the state of a TODO item was changed.
2149 The new state (a string with a TODO keyword, or nil) is available in the
2150 Lisp variable `state'."
2155 "Hook for functions that are allowed to block a state change.
2157 Each function gets as its single argument a property list, see
2158 `org-trigger-hook' for more information about this list.
2160 If any of the functions in this hook returns nil, the state change
2164 "Hook for functions that are triggered by a state change.
2166 Each function gets as its single argument a property list with at least
2167 the following elements:
2169 (:type type-of-change :position pos-at-entry-start
2170 :from old-state :to new-state)
2172 Depending on the type, more properties may be present.
2174 This mechanism is currently implemented for:
2176 TODO state changes
2177 ------------------
2178 :type todo-state-change
2179 :from previous state (keyword as a string), or nil, or a symbol
2180 'todo' or 'done', to indicate the general type of state.
2184 "Non-nil means undone TODO entries will block switching the parent to DONE.
2185 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2186 be blocked if any prior sibling is not yet done.
2187 Finally, if the parent is blocked because of ordered siblings of its own,
2188 the child will also be blocked.
2189 This variable needs to be set before org.el is loaded, and you need to
2190 restart Emacs after a change to make the change effective. The only way
2191 to change is while Emacs is running is through the customize interface."
2203 "Non-nil means unchecked boxes will block switching the parent to DONE.
2204 When this is nil, checkboxes have no influence on switching TODO states.
2205 When non-nil, you first need to check off all check boxes before the TODO
2206 entry can be switched to DONE.
2207 This variable needs to be set before org.el is loaded, and you need to
2208 restart Emacs after a change to make the change effective. The only way
2209 to change is while Emacs is running is through the customize interface."
2221 "Non-nil means inserting a TODO heading is treated as state change.
2223 logging will apply if appropriate. When nil, the new TODO item will
2224 be inserted directly, and no logging will take place."
2229 "Non-nil means switching TODO states with S-cursor counts as state change.
2230 This is the default behavior. However, setting this to nil allows a
2231 convenient way to select a TODO state and bypass any logging associated
2232 with that."
2237 "Tag changes that should be triggered by TODO state changes.
2238 This is a list. Each entry is
2240 (state-change (tag . flag) .......)
2242 State-change can be a string with a state, and empty string to indicate the
2243 state that has no TODO keyword, or it can be one of the symbols `todo'
2244 or `done', meaning any not-done or done state, respectively."
2258 "Information to record when a task moves to the DONE state.
2260 Possible values are:
2262 nil Don't add anything, just change the keyword
2263 time Add a time stamp to the task
2264 note Prompt for a note and add it with template `org-log-note-headings'
2266 This option can also be set with on a per-file-basis with
2268 #+STARTUP: nologdone
2269 #+STARTUP: logdone
2270 #+STARTUP: lognotedone
2272 You can have local logging settings for a subtree by setting the LOGGING
2273 property to one or more of these keywords."
2281 ;; Normalize old uses of org-log-done.
2288 "Information to record when the scheduling date of a tasks is modified.
2290 Possible values are:
2292 nil Don't add anything, just change the date
2293 time Add a time stamp to the task
2294 note Prompt for a note and add it with template `org-log-note-headings'
2296 This option can also be set with on a per-file-basis with
2298 #+STARTUP: nologreschedule
2299 #+STARTUP: logreschedule
2300 #+STARTUP: lognotereschedule"
2309 "Information to record when the deadline date of a tasks is modified.
2311 Possible values are:
2313 nil Don't add anything, just change the date
2314 time Add a time stamp to the task
2315 note Prompt for a note and add it with template `org-log-note-headings'
2317 This option can also be set with on a per-file-basis with
2319 #+STARTUP: nologredeadline
2320 #+STARTUP: logredeadline
2321 #+STARTUP: lognoteredeadline
2323 You can have local logging settings for a subtree by setting the LOGGING
2324 property to one or more of these keywords."
2333 "Non-nil means record a note when clocking out of an item.
2334 This can also be configured on a per-file basis by adding one of
2335 the following lines anywhere in the buffer:
2337 #+STARTUP: lognoteclock-out
2338 #+STARTUP: nolognoteclock-out"
2344 "Non-nil means the CLOSED time stamp will contain date and time.
2345 When nil, only the date will be recorded."
2359 "Headings for notes added to entries.
2360 The value is an alist, with the car being a symbol indicating the note
2361 context, and the cdr is the heading to be used. The heading may also be the
2362 empty string.
2363 %t in the heading will be replaced by a time stamp.
2364 %T will be an active time stamp instead the default inactive one
2365 %s will be replaced by the new TODO state, in double quotes.
2366 %S will be replaced by the old TODO state, in double quotes.
2367 %u will be replaced by the user name.
2368 %U will be replaced by the full user name.
2370 In fact, it is not a good idea to change the `state' entry, because
2371 agenda log mode depends on the format of these entries."
2377 "Heading when changing todo state (todo sequence only)"
2391 "Non-nil means insert state change notes and time stamps into a drawer.
2392 When nil, state changes notes will be inserted after the headline and
2393 any scheduling and clock lines, but not inside a drawer.
2395 The value of this variable should be the name of the drawer to use.
2396 LOGBOOK is proposed as the default drawer for this purpose, you can
2397 also set this to a string to define the drawer of your choice.
2401 If this variable is set, `org-log-state-notes-insert-after-drawers'
2402 will be ignored.
2404 You can set the property LOG_INTO_DRAWER to overrule this setting for
2405 a subtree."
2417 "Return the value of `org-log-into-drawer', but let properties overrule.
2418 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2419 used instead of the default value."
2427 "Non-nil means insert state change notes after any drawers in entry.
2428 Only the drawers that *immediately* follow the headline and the
2429 deadline/scheduled line are skipped.
2430 When nil, insert notes right after the heading and perhaps the line
2431 with deadline/scheduling if present.
2433 This variable will have no effect if `org-log-into-drawer' is
2434 set."
2440 "Non-nil means the latest state note will be directly after heading.
2441 When nil, the state change notes will be ordered according to time."
2447 "The TODO state to which a repeater should return the repeating task.
2448 By default this is the first task in a TODO sequence, or the previous state
2449 in a TODO_TYP set. But you can specify another task here.
2450 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2456 "Non-nil means record moving through the DONE state when triggering repeat.
2457 An auto-repeating task is immediately switched back to TODO when
2460 record a closing note, there will be no record of the task moving
2461 through DONE. This variable forces taking a note anyway.
2463 nil Don't force a record
2464 time Record a time stamp
2465 note Record a note
2467 This option can also be set with on a per-file-basis with
2469 #+STARTUP: logrepeat
2470 #+STARTUP: lognoterepeat
2471 #+STARTUP: nologrepeat
2473 You can have local logging settings for a subtree by setting the LOGGING
2474 property to one or more of these keywords."
2484 "Priorities in Org-mode."
2489 "Non-nil means priority commands are active.
2490 When nil, these commands will be disabled, so that you never accidentally
2491 set a priority."
2496 "The highest priority of TODO items. A character like ?A, ?B etc.
2497 Must have a smaller ASCII number than `org-lowest-priority'."
2502 "The lowest priority of TODO items. A character like ?A, ?B etc.
2503 Must have a larger ASCII number than `org-highest-priority'."
2508 "The default priority of TODO items.
2509 This is the priority an item gets if no explicit priority is given.
2510 When starting to cycle on an empty priority the first step in the cycle
2511 depends on `org-priority-start-cycle-with-default'. The resulting first
2512 step priority must not exceed the range from `org-highest-priority' to
2513 `org-lowest-priority' which means that `org-default-priority' has to be
2514 in this range exclusive or inclusive the range boundaries. Else the
2515 first step refuses to set the default and the second will fall back
2516 to (depending on the command used) the highest or lowest priority."
2521 "Non-nil means start with default priority when starting to cycle.
2522 When this is nil, the first step in the cycle will be (depending on the
2523 command used) one higher or lower than the default priority.
2524 See also `org-default-priority'."
2529 "Function to extract the priority from a string.
2530 The string is normally the headline. If this is nil Org computes the
2531 priority from the priority cookie like [#A] in the headline. It returns
2532 an integer, increasing by 1000 for each priority level.
2533 The user can set a different function here, which should take a string
2534 as an argument and return the numeric priority."
2539 "Options concerning time stamps and deadlines in Org-mode."
2544 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2545 When nil, these labeled time stamps are forces into the second line of an
2546 entry, just after the headline. When scheduling from the global TODO list,
2547 the time stamp will always be forced into the second line."
2552 "Formats for `format-time-string' which are used for time stamps.
2556 "Number of minutes to round time stamps to.
2557 These are two values, the first applies when first creating a time stamp.
2558 The second applies when changing it with the commands `S-up' and `S-down'.
2559 When changing the time stamp, this means that it will change in steps
2560 of N minutes, as given by the second value.
2562 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2563 numbers should be factors of 60, so for example 5, 10, 15.
2565 When this is larger than 1, you can still force an exact time stamp by using
2566 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2567 and by using a prefix arg to `S-up/down' to specify the exact number
2568 of minutes to shift."
2578 ;; Normalize old customizations of this variable.
2582 org-time-stamp-rounding-minutes)))
2585 "Non-nil means overlay custom formats over all time stamps.
2586 The formats are defined through the variable `org-time-stamp-custom-formats'.
2587 To turn this on on a per-file basis, insert anywhere in the file:
2588 #+STARTUP: customtime"
2596 "Custom formats for time stamps. See `format-time-string' for the syntax.
2597 These are overlayed over the default ISO format if the variable
2598 `org-display-custom-times' is set. Time like %H:%M should be at the
2599 end of the second format. The custom formats are also honored by export
2600 commands, if custom time display is turned on at the time of export."
2605 "Get the right format for a time string."
2610 f)))
2613 "The format string used when creating CLOCKSUM lines.
2614 This is also used when org-mode generates a time duration."
2620 org-mode generates a time duration."
2625 "The format string used when creating CLOCKSUM lines, or when
2626 org-mode generates a time duration."
2631 "No. of days before expiration during which a deadline becomes active.
2632 This variable governs the display in sparse trees and in the agenda.
2633 When 0 or negative, it means use this number (the absolute value of it)
2634 even if a deadline has a different individual lead time specified.
2636 Custom commands can set this variable in the options section."
2642 "Non-nil means assume future for incomplete date input from user.
2643 This affects the following situations:
2644 1. The user gives a month but not a year.
2647 2. The user gives a day, but no month.
2650 it will be considered as *this* month.
2652 If you set this variable to the symbol `time', then also the following
2653 will work:
2655 3. If the user gives a time, but no day. If the time is before now,
2656 to will be interpreted as tomorrow.
2658 Currently none of this works for ISO week specifications.
2660 When this option is nil, the current day, month and year will always be
2661 used as defaults.
2663 See also `org-agenda-jump-prefer-future'."
2671 "Should the agenda jump command prefer the future for incomplete dates?
2672 The default is to do the same as configured in `org-read-date-prefer-future'.
2673 But you can also set a deviating value here.
2674 This may t or nil, or the symbol `org-read-date-prefer-future'."
2679 org-read-date-prefer-future)
2684 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2686 Depending on the system Emacs is running on, certain dates cannot
2687 be represented with the type used internally to represent time.
2688 Dates between 1970-1-1 and 2038-1-1 can always be represented
2689 correctly. Some systems allow for earlier dates, some for later,
2690 some for both. One way to find out it to insert any date into an
2691 Org buffer, putting the cursor on the year and hitting S-up and
2692 S-down to test the range.
2694 When this variable is set to t, the date/time prompt will not let
2695 you specify dates outside the 1970-2037 range, so it is certain that
2696 these dates will work in whatever version of Emacs you are
2697 running, and also that you can move a file from one Emacs implementation
2698 to another. WHenever Org is forcing the year for you, it will display
2699 a message and beep.
2701 When this variable is nil, Org will check if the date is
2702 representable in the specific Emacs implementation you are using.
2703 If not, it will force a year, usually the current year, and beep
2704 to remind you. Currently this setting is not recommended because
2705 the likelihood that you will open your Org files in an Emacs that
2706 has limited date range is not negligible.
2708 A workaround for this problem is to use diary sexp dates for time
2709 stamps outside of this range."
2714 "Non-nil means display current interpretation of date prompt live.
2715 This display will be in an overlay, in the minibuffer."
2720 "Non-nil means pop up a calendar when prompting for a date.
2721 In the calendar, the date can be selected with mouse-1. However, the
2722 minibuffer will also be active, and you can simply enter the date as well.
2723 When nil, only the minibuffer will be available."
2731 "Hook to be used to set up keys for the date/time interface.
2732 Add key definitions to `minibuffer-local-map', which will be a temporary
2733 copy."
2738 "The hour when your day really ends. Must be an integer.
2739 This has influence for the following applications:
2741 the time given here, the day recognized as TODAY is actually yesterday.
2742 - When a date is read from the user and it is still before the time given
2743 here, the current date and time will be assumed to be yesterday, 23:59.
2744 Also, timestamps inserted in remember templates follow this rule.
2746 IMPORTANT: This is a feature whose implementation is and likely will
2747 remain incomplete. Really, it is only here because past midnight seems to
2748 be the favorite working time of John Wiegley :-)"
2753 "Non-nil means S-down will increase the time in a time stamp.
2754 When nil, S-up will increase."
2759 "Non-nil means make the calendar window follow timestamp changes.
2760 When a timestamp is modified and the calendar window is visible, it will be
2761 moved to the new date."
2766 "Options concerning tags in Org-mode."
2771 "List of tags allowed in Org-mode files.
2772 When this list is nil, Org-mode will base TAG input on what is already in the
2773 buffer.
2774 The value of this variable is an alist, the car of each entry must be a
2775 keyword as a string, the cdr may be a character that is used to select
2776 that tag through the fast-tag-selection interface.
2777 See the manual for details."
2792 "List of tags that will always appear in all Org-mode files.
2793 This is in addition to any in buffer settings or customizations
2794 of `org-tag-alist'.
2795 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2796 The value of this variable is an alist, the car of each entry must be a
2797 keyword as a string, the cdr may be a character that is used to select
2798 that tag through the fast-tag-selection interface.
2799 See the manual for details.
2800 To disable these tags on a per-file basis, insert anywhere in the file:
2801 #+STARTUP: noptag"
2812 "If non-nil, always offer completion for all tags of all agenda files.
2813 Instead of customizing this variable directly, you might want to
2814 set it locally for capture buffers, because there no list of
2815 tags in that file can be created dynamically (there are none).
2817 (add-hook 'org-capture-mode-hook
2818 (lambda ()
2819 (set (make-local-variable
2820 'org-complete-tags-always-offer-all-agenda-tags)
2821 t)))"
2826 "List of tags that can be inherited by all entries in the file.
2827 The tags will be inherited if the variable `org-use-tag-inheritance'
2828 says they should be.
2832 "Non-nil means use fast tag selection scheme.
2833 This is a special interface to select and deselect tags with single keys.
2834 When nil, fast selection is never used.
2835 When the symbol `auto', fast selection is used if and only if selection
2836 characters for tags have been configured, either through the variable
2837 `org-tag-alist' or through a #+TAGS line in the buffer.
2838 When t, fast selection is always used and selection keys are assigned
2839 automatically if necessary."
2847 "Non-nil means fast tag selection exits after first change.
2848 When nil, you have to press RET to exit it.
2849 During fast tag selection, you can toggle this flag with `C-c'.
2850 This variable can also have the value `expert'. In this case, the window
2851 displaying the tags menu is not even shown, until you press C-c again."
2859 "Non-nil means fast tags selection interface will also offer TODO states.
2863 "The column to which tags should be indented in a headline.
2864 If this number is positive, it specifies the column. If it is negative,
2865 it means that the tags should be flushright to that column. For example,
2866 -80 works well for a normal 80 character screen."
2871 "Non-nil keeps tags aligned when modifying headlines.
2872 Some operations (i.e. demoting) change the length of a headline and
2873 therefore shift the tags around. With this option turned on, after
2874 each such operation the tags are again aligned to `org-tags-column'."
2879 "Non-nil means tags in levels apply also for sublevels.
2880 When nil, only the tags directly given in a specific line apply there.
2881 This may also be a list of tags that should be inherited, or a regexp that
2882 matches tags that should be inherited. Additional control is possible
2883 with the variable `org-tags-exclude-from-inheritance' which gives an
2884 explicit list of tags to be excluded from inheritance., even if the value of
2885 `org-use-tag-inheritance' would select it for inheritance.
2887 If this option is t, a match early-on in a tree can lead to a large
2888 number of matches in the subtree when constructing the agenda or creating
2889 a sparse tree. If you only want to see the first match in a tree during
2890 a search, check out the variable `org-tags-match-list-sublevels'."
2899 "List of tags that should never be inherited.
2900 This is a way to exclude a few tags from inheritance. For way to do
2901 the opposite, to actively allow inheritance for selected tags,
2902 see the variable `org-use-tag-inheritance'."
2907 "Check if TAG is one that should be inherited."
2919 "Non-nil means list also sublevels of headlines matching a search.
2920 This variable applies to tags/property searches, and also to stuck
2921 projects because this search is based on a tags match as well.
2923 When set to the symbol `indented', sublevels are indented with
2924 leading dots.
2926 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2927 the sublevels of a headline matching a tag search often also match
2928 the same search. Listing all of them can create very long lists.
2929 Setting this variable to nil causes subtrees of a match to be skipped.
2931 This variable is semi-obsolete and probably should always be true. It
2932 is better to limit inheritance to certain tags using the variables
2933 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2941 "When set, tags are sorted using this function as a comparator."
2957 "Options concerning properties in Org-mode."
2962 "How property key/value pairs should be formatted by `indent-line'.
2963 When `indent-line' hits a property definition, it will format the line
2964 according to this format, mainly to make sure that the values are
2965 lined-up with respect to each other."
2970 "Non-nil means properties apply also for sublevels.
2972 This setting is chiefly used during property searches. Turning it on can
2973 cause significant overhead when doing a search, which is why it is not
2974 on by default.
2976 When nil, only the properties directly given in the current entry count.
2977 When t, every property is inherited. The value may also be a list of
2978 properties that should have inheritance, or a regular expression matching
2979 properties that should be inherited.
2981 However, note that some special properties use inheritance under special
2982 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2984 for valid values of a property.
2986 Note for programmers:
2987 When querying an entry with `org-entry-get', you can control if inheritance
2988 should be used. By default, `org-entry-get' looks only at the local
2989 properties. You can request inheritance by setting the inherit argument
2990 to t (to force inheritance) or to `selective' (to respect the setting
2991 in this variable)."
3000 "Check if PROPERTY is one that should be inherited."
3011 "The default column format, if no other format has been defined.
3012 This variable can be set on the per-file basis by inserting a line
3014 #+COLUMNS: %25ITEM ....."
3019 "The ellipses to be used when a field in column view is truncated.
3020 When this is the empty string, as many characters as possible are shown,
3021 but then there will be no visual indication that the field has been truncated.
3022 When this is a string of length N, the last N characters of a truncated
3023 field are replaced by this string. If the column is narrower than the
3024 ellipses string, only part of the ellipses string will be shown."
3029 "Function that modifies values for display in column view.
3030 For example, it can be used to cut out a certain part from a time stamp.
3031 The function must take 2 arguments:
3033 column-title The title of the column (*not* the property name)
3034 value The value that should be modified.
3036 The function should return the value that should be displayed,
3037 or nil if the normal value should be used."
3042 "The property that is being used to keep track of effort estimates.
3043 Effort estimates given in this property need to have the format H:MM."
3051 "List of property/value pairs that can be inherited by any entry.
3053 These are fixed values, for the preset properties. The user variable
3054 that can be used to add to this list is `org-global-properties'.
3056 The entries in this list are cons cells where the car is a property
3057 name and cdr is a string with the value. If the value represents
3062 "List of property/value pairs that can be inherited by any entry.
3064 This list will be combined with the constant `org-global-properties-fixed'.
3066 The entries in this list are cons cells where the car is a property
3067 name and cdr is a string with the value.
3069 You can set buffer-local values for the same purpose in the variable
3070 `org-file-properties' this by adding lines like
3072 #+PROPERTY: NAME VALUE"
3079 "List of property/value pairs that can be inherited by any entry.
3080 Valid for the current buffer.
3085 "Options concerning agenda views in Org-mode."
3090 "Variable used by org files to set a category for agenda display.
3091 Such files should use a file variable to set it, for example
3095 or contain a special line
3097 #+CATEGORY: ELisp
3099 If the file does not specify a category, then file's base name
3105 "The files to be used for agenda display.
3109 If an entry is a directory, all files in that directory that are matched by
3110 `org-agenda-file-regexp' will be part of the file list.
3112 If the value of the variable is not a list but a single file name, then
3113 the list of agenda files is actually stored and maintained in that file, one
3114 agenda file per line. In this file paths can be given relative to
3115 `org-directory'. Tilde expansion and environment variable substitution
3116 are also made."
3123 "Regular expression to match files for `org-agenda-files'.
3124 If any element in the list in that variable contains a directory instead
3125 of a normal file, all files in that directory that are matched by this
3126 regular expression will be included."
3131 "List of extra files to be searched by text search commands.
3132 These files will be search in addition to the agenda files by the
3133 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3134 Note that these files will only be searched for text search commands,
3135 not for the other agenda views like todo lists, tag searches or the weekly
3136 agenda. This variable is intended to list notes and possibly archive files
3137 that should also be searched by these two commands.
3138 In fact, if the first element in the list is the symbol `agenda-archives',
3139 than all archive files of all agenda files will be added to the search
3140 scope."
3151 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3152 A nil value means to remove them, after a query, from the list."
3157 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3158 The command `org-calendar-goto-agenda' will be bound to this key. The
3159 default is the character `c' because then `c' can be used to switch back and
3160 forth between agenda and calendar."
3165 "The key to be installed in `calendar-mode-map' for agenda-action.
3166 The command `org-agenda-action' will be bound to this key. The
3167 default is the character `k' because we use the same key in the agenda."
3172 "The key to be installed in `calendar-mode-map' for adding diary entries.
3173 This option is irrelevant until `org-agenda-diary-file' has been configured
3174 to point to an Org-mode file. When that is the case, the command
3175 `org-agenda-diary-entry' will be bound to the key given here, by default
3176 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3177 if you want to continue doing this, you need to change this to a different
3178 key."
3183 "File to which to add new entries with the `i' key in agenda and calendar.
3184 When this is the symbol `diary-file', the functionality in the Emacs
3185 calendar will be used to add entries to the `diary-file'. But when this
3186 points to a file, `org-agenda-diary-entry' will be used instead."
3202 org-calendar-insert-diary-entry-key
3206 "Options for embedding LaTeX code into Org-mode."
3214 "Options for creating images from LaTeX fragments.
3215 This is a property list with the following properties:
3217 `default' means use the foreground of the default face.
3219 `default' means use the background of the default face.
3220 :scale a scaling factor for the size of the images, to get more pixels
3221 :html-foreground, :html-background, :html-scale
3222 the same numbers for HTML export.
3223 :matchers a list indicating which matchers should be used to
3224 find LaTeX fragments. Valid members of this list are:
3235 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3236 When nil, just push out a message."
3245 \[PACKAGES]
3246 \[DEFAULT-PACKAGES]
3247 % The settings below are copied from fullpage.sty
3260 "The document header used for processing LaTeX fragments.
3261 It is imperative that this header make sure that no page number
3262 appears on the page. The package defined in the variables
3263 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3265 will be appended."
3272 "Set the packages alist and make sure it has 3 elements per entry."
3276 x))
3277 val)))
3281 "Get the packages alist and make sure it has 3 elements per entry."
3285 x))
3288 ;; The following variables are defined here because is it also used
3289 ;; when formatting latex fragments. Originally it was part of the
3290 ;; LaTeX exporter, which is why the name includes "export".
3307 )
3308 "Alist of default packages to be inserted in the header.
3309 Change this only if one of the packages here causes an incompatibility
3310 with another package you are using.
3311 The packages in this list are needed by one part or another of Org-mode
3312 to function properly.
3314 - inputenc, fontenc: for basic font and character selection
3315 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3316 for interpreting the entities in `org-entities'. You can skip some of these
3317 packages if you don't use any of the symbols in it.
3318 - graphicx: for including images
3319 - float, wrapfig: for figure placement
3320 - longtable: for long tables
3321 - hyperref: for cross references
3323 Therefore you should not modify this variable unless you know what you
3324 are doing. The one reason to change it anyway is that you might be loading
3325 some other package that conflicts with one of the default packages.
3327 If SNIPPET-FLAG is t, the package also needs to be included when
3328 compiling LaTeX snippets into images for inclusion into HTML."
3341 "Alist of packages to be inserted in every LaTeX header.
3342 These will be inserted after `org-export-latex-default-packages-alist'.
3344 SNIPPET-FLAG, when t, indicates that this package is also needed when
3345 turning LaTeX snippets into images for inclusion into HTML.
3346 Make sure that you only list packages here which:
3347 - you want in every file
3348 - do not conflict with the default packages in
3349 `org-export-latex-default-packages-alist'
3350 - do not conflict with the setup in `org-format-latex-header'."
3364 "Settings for Org-mode appearance."
3369 "Non-nil means fontify only the stars in each headline.
3370 When nil, the entire headline is fontified.
3371 Changing it requires restart of `font-lock-mode' to become effective
3372 also in regions already fontified."
3377 "Non-nil means hide the first N-1 stars in a headline.
3378 This works by using the face `org-hide' for these stars. This
3379 face is white for a light background, and black for a dark
3380 background. You may have to customize the face `org-hide' to
3381 make this work.
3382 Changing it requires restart of `font-lock-mode' to become effective
3383 also in regions already fontified.
3384 You may also set this on a per-file basis by adding one of the following
3385 lines to the buffer:
3387 #+STARTUP: hidestars
3388 #+STARTUP: showstars"
3393 "List of symbols corresponding to keywords to be hidden the org buffer.
3394 For example, a value '(title) for this list will make the document's title
3395 appear in the buffer without the initial #+TITLE: keyword."
3403 "Non-nil means change the face of a headline if it is marked DONE.
3404 Normally, only the TODO/DONE keyword indicates the state of a headline.
3405 When this is non-nil, the headline after the keyword is set to the
3406 `org-headline-done' as an additional indication."
3411 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3412 Changing this variable requires a restart of Emacs to take effect."
3417 "Non-nil means fontify the whole line for headings.
3418 This is useful when setting a background color for the
3419 org-level-* faces."
3424 "Non-nil means fontify what is treated specially by the exporters."
3429 "Non-nil mean font-lock should hide the emphasis marker characters."
3434 "Non-nil means show entities as UTF8 characters.
3440 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3445 "Regular expression for matching emphasis.
3446 After a match, the match groups contain these elements:
3447 0 The match of the full regular expression, including the characters
3448 before and after the proper match
3449 1 The character before the proper match, or empty at beginning of line
3450 2 The proper match, including the leading and trailing markers
3451 3 The leading marker like * or /, indicating the type of highlighting
3452 4 The text between the emphasis markers, not including the markers
3459 "Set variable and compute the emphasis regular expression."
3463 org-emphasis-alist org-emphasis-regexp-components)
3475 ;; make sure special characters appear at the right position in the class
3487 ;; Make the regexp
3495 body1
3507 body1
3515 "Components used to build the regular expression for emphasis.
3516 This is a list with five entries. Terminology: In an emphasis string
3520 specify what is allowed/forbidden in each part:
3522 pre Chars allowed as prematch. Beginning of line will be allowed too.
3523 post Chars allowed as postmatch. End of line will be allowed too.
3524 border The chars *forbidden* as border characters.
3526 non-shy groups here, and don't allow newline here.
3527 newline The maximum number of newlines allowed in an emphasis exp.
3529 Use customize to modify this, or restart Emacs after changing it."
3548 )
3549 "Special syntax for emphasized text.
3550 Text starting and ending with a special character will be emphasized, for
3551 example *bold*, _underlined_ and /italic/. This variable sets the marker
3552 characters, the face to be used by font-lock for highlighting in Org-mode
3553 Emacs buffers, and the HTML tags to be used for this.
3554 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3555 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3556 Use customize to modify this, or restart Emacs after changing it."
3571 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3574 ;;; Miscellaneous options
3577 "Completion in Org-mode."
3582 "Non-nil means use ido completion wherever possible.
3583 Note that `ido-mode' must be active for this variable to be relevant.
3584 If you decide to turn this variable on, you might well want to turn off
3585 `org-outline-path-complete-in-steps'.
3586 See also `org-completion-use-iswitchb'."
3591 "Non-nil means use iswitchb completion wherever possible.
3592 Note that `iswitchb-mode' must be active for this variable to be relevant.
3593 If you decide to turn this variable on, you might well want to turn off
3594 `org-outline-path-complete-in-steps'.
3595 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3601 Normal means, no org-mode-specific context."
3605 ;;; Functions and variables from their packages
3606 ;; Declared here to avoid compiler warnings
3608 ;; XEmacs only
3614 ;; Emacs only
3617 ;; Various packages
3635 org-format-agenda-item "org-agenda"
3666 ;;; Autoload and prepare some org modules
3668 ;; Some table stuff that needs to be defined here, because it is used
3669 ;; by the functions setting up org-mode or checking for table context.
3682 "Detect the first line outside a table when searching from within it.
3685 ;; Autoload the functions in org-table.el that are needed by functions here.
3690 org-table-convert org-table-convert-region org-table-copy-down
3691 org-table-copy-region org-table-create
3692 org-table-create-or-convert-from-region
3693 org-table-create-with-table.el org-table-current-dline
3694 org-table-cut-region org-table-delete-column org-table-edit-field
3695 org-table-edit-formulas org-table-end org-table-eval-formula
3696 org-table-export org-table-field-info
3697 org-table-get-stored-formulas org-table-goto-column
3698 org-table-hline-and-move org-table-import org-table-insert-column
3699 org-table-insert-hline org-table-insert-row org-table-iterate
3700 org-table-justify-field-maybe org-table-kill-row
3701 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3702 org-table-move-column org-table-move-column-left
3703 org-table-move-column-right org-table-move-row
3704 org-table-move-row-down org-table-move-row-up
3705 org-table-next-field org-table-next-row org-table-paste-rectangle
3706 org-table-previous-field org-table-recalculate
3707 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3708 org-table-toggle-coordinate-overlays
3709 org-table-toggle-formula-debugger org-table-wrap-region
3710 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3711 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3712 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3715 "Return t if the cursor is inside an org-type table.
3716 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3721 org-table-line-regexp)))
3722 nil))
3726 "Return t if and only if we are at a table.el table."
3732 "If there is a table.el table nearby, recognize it and move into it."
3738 nil
3748 t
3753 t)
3754 nil)
3755 nil))
3758 "Return t if the cursor is inside a hline in a table."
3763 nil))
3768 "Apply FUNCTION to the start of all tables in the buffer."
3784 ;; Declare and autoload functions from org-exp.el & Co
3792 org-insert-export-options-template
3793 org-table-clean-before-export))
3796 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3797 org-export-region-as-ascii))
3800 org-replace-region-by-latex org-export-region-as-latex
3801 org-export-as-latex org-export-as-pdf
3802 org-export-as-pdf-and-open))
3805 org-export-as-html-batch org-export-as-html-to-buffer
3806 org-replace-region-by-html org-export-region-as-html
3807 org-export-as-html))
3810 org-replace-region-by-docbook org-export-region-as-docbook
3811 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3812 org-export-as-docbook))
3815 org-export-icalendar-all-agenda-files
3816 org-export-icalendar-combine-agenda-files))
3820 ;; Declare and autoload functions from org-agenda.el
3825 org-todo-list org-tags-view org-agenda-list-stuck-projects
3826 org-diary org-agenda-to-appt
3827 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3829 ;; Autoload org-remember
3834 org-remember-apply-template org-remember org-remember-handler)))
3839 org-capture-import-remember-templates)))
3841 ;; Autoload org-clock.el
3856 "Return non-nil if clock is currently running.
3857 The return value is actually the clock marker."
3862 "org-clock"
3864 org-clock-goto org-clock-sum org-clock-display
3865 org-clock-remove-overlays org-clock-report
3866 org-clocktable-shift org-dblock-write:clocktable
3867 org-get-clocktable org-resolve-clocks)))
3870 "If this is a CLOCK line, update it and return t.
3871 Otherwise, return nil."
3880 ts te h m s neg)
3883 nil)
3888 ;; The clock is running here
3909 t))))))
3912 "Check if the current buffer contains the running clock.
3913 If yes, offer to stop it and to save the buffer with the changes."
3922 "Check if this line starts a clock table, if yes, shift the time block."
3926 ;; Autoload org-timer.el
3930 "org-timer"
3932 org-timer-change-times-in-region
3933 org-timer-set-timer
3934 org-timer-reset-timers
3935 org-timer-show-remaining-time)))
3937 ;; Autoload org-feed.el
3941 "org-feed"
3945 ;; Autoload org-indent.el
3947 ;; Define the variable already here, to make sure we have it.
3949 "Non-nil if Org-Indent mode is enabled.
3954 "org-indent"
3957 ;; Autoload org-mobile.el
3961 "org-mobile"
3964 ;; Autoload archiving code
3965 ;; The stuff that is needed for cycling and tags has to be defined here.
3968 "Options concerning archiving in Org-mode."
3973 "The location where subtrees should be archived.
3975 The value of this variable is a string, consisting of two parts,
3976 separated by a double-colon. The first part is a filename and
3977 the second part is a headline.
3979 When the filename is omitted, archiving happens in the same file.
3980 %s in the filename will be replaced by the current file
3981 name (without the directory part). Archiving to a different file
3982 is useful to keep archived entries from contributing to the
3983 Org-mode Agenda.
3985 The archived entries will be filed as subtrees of the specified
3986 headline. When the headline is omitted, the subtrees are simply
3987 filed away at the end of the file, as top-level entries. Also in
3988 the heading you can use %s to represent the file name, this can be
3989 useful when using the same archive for a number of different files.
3991 Here are a few examples:
3993 If the current file is Projects.org, archive in file
3994 Projects.org_archive, as top-level trees. This is the default.
3997 Archive in the current file, under the top-level headline
4001 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4004 Archive in file ~/org/archive.org (absolute path), under headlines
4008 Archive in file ./basement (relative path), as level 3 trees
4011 You may set this option on a per-file basis by adding to the buffer a
4012 line like
4014 #+ARCHIVE: basement::** Finished Tasks
4016 You may also define it locally for a subtree by setting an ARCHIVE property
4017 in the entry. If such a property is found in an entry, or anywhere up
4018 the hierarchy, it will be used."
4023 "The tag that marks a subtree as archived.
4024 An archived subtree does not open during visibility cycling, and does
4025 not contribute to the agenda listings.
4026 After changing this, font-lock must be restarted in the relevant buffers to
4027 get the proper fontification."
4033 "Non-nil means the agenda will skip any items located in archived trees.
4034 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4035 variable is no longer recommended, you should leave it at the value t.
4036 Instead, use the key `v' to cycle the archives-mode in the agenda."
4042 "Non-nil means ignore archived trees when creating column view."
4048 "Non-nil means `org-cycle' will open archived trees.
4049 An archived tree is a tree marked with the tag ARCHIVE.
4050 When nil, archived trees will stay folded. You can still open them with
4051 normal outline commands like `show-all', but not with the cycling commands."
4057 "Non-nil means sparse tree construction shows matches in archived trees.
4058 When nil, matches in these trees are highlighted, but the trees are kept in
4059 collapsed state."
4065 "Re-hide all archived subtrees after a visibility state change."
4076 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4079 "Cycle subtree even if it is archived."
4086 "Re-hide all archived subtrees after a visibility state change."
4101 flag)))
4108 org-archive-to-archive-sibling org-toggle-archive-tag
4109 org-archive-subtree-default
4110 org-archive-subtree-default-with-confirmation)))
4112 ;; Autoload Column View Code
4120 org-columns-compute org-agenda-columns org-columns-remove-overlays
4123 ;; Autoload ID code
4131 org-id-get-with-outline-path-completion
4132 org-id-get-with-outline-drilling org-id-store-link
4133 org-id-goto org-id-find org-id-store-link))
4135 ;; Autoload Plotting Code
4140 ;;; Variables for pre-computed regular expressions, all buffer local
4158 "Matches a headline and puts everything into groups:
4159 group 1: the stars
4160 group 2: The todo keyword, maybe
4161 group 3: Priority cookie
4162 group 4: True headline
4166 "Printf format to make regexp to match an exact headline.
4167 This regexp will match the headline of any node which hase the exact
4168 headline text that is put into the format, but may have any TODO state,
4172 "Matches a headline and puts TODO state into group 2 if present.
4227 "Regular expression to match a plain time or time range.
4228 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4229 groups carry important information:
4230 0 the full match
4231 1 the first time, range or not
4239 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4240 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4241 groups carry important information:
4242 0 the full match
4243 7 hours of duration
4252 "Regular expression to match a timestamp time or time range.
4253 After a match, the following groups carry important information:
4254 0 the full match
4255 1 date plus weekday, for back referencing to make sure both times are on the same day
4256 2 the first time, range or not
4311 "Variable associated with STARTUP options for org-mode.
4312 Each element is a list of three items: The startup options as written
4313 in the #+STARTUP line, the corresponding variable, and the value to
4314 set this variable to if the option is found. An optional forth element PUSH
4318 "Precompute regular expressions for current buffer."
4338 kwds kws0 kwsa key log value cat arch tags const links hw dws
4339 tail sep kws1 prio props ftags drawers beamer-p
4361 ;; general TODO-like setup
4373 links)))
4379 props)))
4384 ftags
4394 l var val)
4424 ))))
4441 ;; Process the TODO keywords
4443 ;; Use the global values as if they had been given locally.
4455 kws)))
4458 kwsa nil
4461 ;; 1 2
4469 kw)
4471 kws0)
4488 ;; Process the constants
4496 ;; Process the tags.
4507 tgs))
4515 ;; Compute the regular expressions and other local variables
4523 org-drawer-regexp
4527 org-not-done-keywords
4529 org-todo-regexp
4532 org-not-done-regexp
4536 org-not-done-heading-regexp
4540 org-todo-line-regexp
4544 org-complex-heading-regexp
4549 org-complex-heading-regexp-format
4558 org-nl-done-regexp
4562 org-todo-line-tags-regexp
4567 org-looking-at-done-regexp
4572 org-deadline-time-regexp
4574 org-deadline-line-regexp
4576 org-scheduled-regexp
4578 org-scheduled-time-regexp
4580 org-closed-time-regexp
4582 org-keyword-time-regexp
4588 org-keyword-time-not-clock-regexp
4594 org-maybe-keyword-time-regexp
4600 org-planning-or-clock-line-re
4605 org-all-time-keywords
4608 org-clock-string org-closed-string))
4609 )
4614 "Return the contents of FILE, as a string."
4628 "Extract the log state setting from a TODO keyword string.
4642 "Remove a pair of parenthesis at the end of each string in LIST."
4646 x))
4647 list))
4650 "Assign fast keys to a keyword-key alist.
4651 Respect keys that are already there."
4669 ;;; Some variables used in various places
4676 "Function to be called when `C-c C-c' is used.
4680 ;; FIXME: Occasionally check by commenting these, to make sure
4681 ;; no other functions uses these, forgetting to let-bind them.
4686 ;; Defined somewhere in this file, but used before definition.
4692 ;;;; Define the Org-mode
4695 (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"))
4698 ;; We use a before-change function to check if a table might need
4699 ;; an update.
4701 "Indicates that a table might need an update.
4702 This variable is set by `org-before-change-function'.
4705 "Every change indicates that a table might need an update."
4715 ;; org-outline-regexp ought to be a defconst but is let-binding
4716 ;; in some places -- e.g. see the macro org-with-limited-levels
4720 ;;;###autoload
4722 "Outline-based notes management and organizer, alias
4725 Org-mode develops organizational tasks around a NOTES file which
4726 contains information about projects as plain text. Org-mode is
4727 implemented on top of outline-mode, which is ideal to keep the content
4728 of large files well structured. It supports ToDo items, deadlines and
4729 time stamps, which magically appear in the diary listing of the Emacs
4730 calendar. Tables are easily created with a built-in table editor.
4731 Plain text URL-like links connect to websites, emails (VM), Usenet
4732 messages (Gnus), BBDB entries, and any files related to the project.
4733 For printing and sharing of notes, an Org-mode file (or a part of it)
4734 can be exported as a structured ASCII or HTML file.
4736 The following commands are available:
4740 ;; Get rid of Outline menus, they are not needed
4741 ;; Need to do this here because define-derived-mode sets up
4742 ;; the keymap so late. Still, it is a waste to call this each time
4743 ;; we switch another buffer into org-mode.
4746 ;; Assume this is Greg's port, it uses easymenu
4771 org-display-table 4
4774 org-ellipsis)))
4779 ;; tag faces set outside customize.... force initialization.
4781 ;; Calc embedded
4787 ;; Activate before-change-function
4791 ;; Check for running clock before killing a buffer
4793 ;; Paragraphs and auto-filling
4797 ;; Beginning/end of defun
4800 ;; Next error for sparse trees
4802 ;; Make sure dependence stuff works reliably, even for users who set it
4803 ;; too late :-(
4815 ;; Comment characters
4819 ;; Align options lines
4821 'align-mode-rules-list
4826 ;; Imenu
4830 ;; Make isearch reveal context
4833 ;; Emacs 21 and XEmacs make use of the hook
4835 ;; Emacs 22 deals with this through a special variable
4839 ;; Turn on org-beamer-mode?
4842 ;; Setup the pcomplete hooks
4855 ;; If empty file that did not turn on org-mode automatically, make it to.
4880 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4890 "Return today date, considering `org-extend-today-until'."
4895 ;;;; Font-Lock stuff, including the activators
4926 "Regular expression used to analyze links.
4927 Here is what the match groups contain after a match:
4928 1: http:
4929 2: http
4930 3: path
4931 4: [desc]
4939 "Number of stacked braces for sub/superscript matching.
4940 This has to be set before loading org.el to be effective."
4945 "Create a regular expression which will match a balanced sexp.
4946 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4947 as single character strings.
4948 The regexp returned will match the entire expression including the
4949 delimiters. It will also define a single group which contains the
4950 match except for the outermost delimiters. The maximum depth of
4951 stacked delimiters is N. Escaping delimiters is not possible."
4980 "Update the link regular expressions.
4981 This should be called after the variable `org-link-types' has changed."
4985 org-link-re-with-space
4991 org-link-re-with-space2
4997 org-link-re-with-space3
5002 org-angle-link-re
5008 org-plain-link-re
5012 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5013 org-bracket-link-regexp
5015 org-bracket-link-analytic-regexp
5023 org-bracket-link-analytic-regexp++
5031 org-any-link-re
5040 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5042 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5043 "Regular expression matching time strings for analysis.
5044 This one does not require the space after the date, so it can be used
5046 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5062 "Regular expression matching a time stamp or time stamp range.
5068 "Run through the buffer and add overlays to emphasised strings."
5077 'face
5090 rtn))
5093 "Insert or change an emphasis, i.e. a font like bold or italic.
5094 If there is an active region, change that region to a new emphasis.
5095 If there is no region, just insert the marker characters and position
5096 the cursor between them.
5097 CHAR should be either the marker character, or the first character of the
5098 HTML tag associated with that emphasis. If CHAR is a space, the means
5099 to remove the emphasis of the selected region.
5100 If char is not given (for example in an interactive call) it
5101 will be prompted for."
5152 "Run through the buffer and add overlays to links."
5161 nil
5167 t)))))
5175 t)))
5178 "When non-nil, fontify code in code blocks."
5189 "Fontify #+ lines and blocks, in the correct ways."
5192 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5193 limit t)
5201 end end1 quoting block-type ovl)
5204 ;; a single line of backend-specific content
5212 ; for backend-specific code
5213 t)
5215 ;; Truly a block
5227 beg end
5235 ;; remove old background overlays
5240 ;; add a background overlay
5254 t))
5267 ;; just any other in-buffer setting, but not indented
5271 t)
5280 t)
5288 "Run through the buffer and add overlays to links."
5296 t)))
5299 "Run through the buffer and add overlays to footnotes."
5306 'keymap org-mouse-map
5307 'help-echo
5309 "Footnote definition"
5311 'font-lock-fontified t
5312 'font-lock-multiline t
5316 "Run through the buffer and add overlays to bracketed links."
5320 ;; FIXME: above we should remove the escapes.
5321 ;; but that requires another match, protecting match data,
5322 ;; a lot of overhead for font-lock.
5329 ;; We need to remove the invisible property here. Table narrowing
5330 ;; may have made some of this invisible.
5348 t)))
5351 "Run through the buffer and add overlays to dates."
5363 t)))
5372 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5376 "Run through the buffer and add overlays to target matches."
5384 'keymap org-mouse-map
5388 t)))))
5391 "Find all radio targets in this file and update the regular expression."
5406 t)))
5413 ;; This should be with the exporter code, but we also use if for font-locking
5423 "Compute regular expression for stuff treated specially by exporters."
5430 org-latex-regexps)))
5458 org-entities)))
5462 org-latex-entities)
5463 nil))
5465 ))
5466 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5469 org-export-html-special-string-regexps)))
5474 ))))
5476 'org-latex-and-specials-regexp
5481 "Run through the buffer and add overlays to links."
5485 limit t))
5499 rtn)))
5502 "Restart `font-lock-mode', to force refontification."
5508 "Return a list of all targets in this file.
5509 With optional argument RADIO, only find radio targets."
5511 rtn)
5516 rtn)))
5519 "Make regular expression matching all strings in TARGETS.
5520 The regular expression finds the targets also if there is a line break
5521 between words."
5530 x)
5531 targets
5543 t)))
5546 "Compute the outline level of the heading at point.
5547 This function assumes that the cursor is at the beginning of a line matched
5548 by `outline-regexp'. Otherwise it returns garbage.
5549 If this is called at a normal headline, the level is the number of stars.
5550 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5557 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5564 "Functions that can manipulate `org-font-lock-extra-keywords'.
5565 This is calles after `org-font-lock-extra-keywords' is defined, but before
5566 it is installed to be used by font lock. This can be useful if something
5577 ;; Call the hook
5579 ;; Headlines
5586 ;; Table lines
5589 ;; Table internals
5594 ;; Drawers
5597 ;; Properties
5601 ;; Links
5611 ;; TODO lines
5614 ;; DONE
5620 nil)
5621 ;; Priorities
5623 ;; Tags
5625 ;; Special keywords
5630 ;; Emphasis
5635 ;; Checkboxes
5636 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5641 ;; Description list items
5644 ;; ARCHIVEd headings
5646 org-outline-regexp-bol
5649 ;; Specials
5653 ;; Code
5655 ;; COMMENT
5660 ;; Blocks and meta lines
5662 )))
5665 ;; Now set the full font-lock-keywords
5672 "Toggle the composition display of entities as UTF8 characters."
5684 "Find an entity to fontify."
5690 limit t)
5702 nil))))
5705 "Fontify string S like in Org-mode."
5717 "Get the right face for match N in font-lock matching of headlines."
5730 "Get the right face for a TODO keyword KWD.
5731 If KWD is a number, get the corresponding match group."
5739 "Create a face list that inherits INHERIT, but sets the foreground color.
5740 When FACE-OR-COLOR is not a string, just return it."
5744 face-or-color)
5745 face-or-color))
5748 "Add the special tag faces."
5757 "Add the special priority faces."
5764 org-priority-faces)))
5769 "Get the right face for a TODO keyword KWD.
5770 If KWD is a number, get the corresponding match group."
5777 "Remove fontification and activation overlays from links."
5782 deactivate-mark buffer-file-name buffer-file-truename)
5785 beg end
5787 ;; also remove line-prefix and wrap-prefix properties
5789 invisible t intangible t
5790 line-prefix t wrap-prefix t
5791 org-no-flyspell t org-emphasis t)
5793 invisible t intangible t
5794 org-no-flyspell t org-emphasis t)))
5804 "Remove specific display properties that have been added by font lock.
5805 The will remove the raise properties that are used to show superscripts
5806 and subscripts."
5816 "Add raise properties to sub/superscripts."
5820 org-match-substring-regexp
5821 org-match-substring-with-braces-regexp)
5822 limit t)
5832 ;; FIXME: Should we go back one character here, for a_b^c
5833 ;; (goto-char (1- pos)) ;????????????????????
5835 t
5837 'display
5853 t)))))
5855 ;;;; Visibility cycling, including org-goto and indirect buffer
5857 ;;; Cycling
5864 ;;;###autoload
5869 "TAB-action and visibility cycling for Org-mode.
5871 This is the command invoked in Org-mode by the TAB key. Its main purpose
5872 is outline visibility cycling, but it also invokes other actions
5873 in special contexts.
5875 - When this function is called with a prefix argument, rotate the entire
5876 buffer through 3 states (global cycling)
5877 1. OVERVIEW: Show only top-level headlines.
5878 2. CONTENTS: Show all headlines of all levels, but no body text.
5879 3. SHOW ALL: Show everything.
5880 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5881 determined by the variable `org-startup-folded', and by any VISIBILITY
5882 properties in the buffer.
5883 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5884 including any drawers.
5886 - When inside a table, re-align the table and move to the next field.
5888 - When point is at the beginning of a headline, rotate the subtree started
5889 by this line through 3 different states (local cycling)
5890 1. FOLDED: Only the main headline is shown.
5891 2. CHILDREN: The main headline and the direct children are shown.
5892 From this state, you can move to one of the children
5893 and zoom in further.
5894 3. SUBTREE: Show the entire subtree, including body text.
5895 If there is no subtree, switch directly from CHILDREN to FOLDED.
5897 - When point is at the beginning of an empty headline and the variable
5898 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5899 of the headline by demoting and promoting it to likely levels. This
5900 speeds up creation document structure by pressing TAB once or several
5901 times right after creating a new headline.
5903 - When there is a numeric prefix, go up to a heading with level ARG, do
5904 a `show-subtree' and return to the previous cursor position. If ARG
5905 is negative, go up that many levels.
5907 - When point is not at the beginning of a headline, execute the global
5908 binding for TAB, which is re-indenting the line. See the option
5909 `org-cycle-emulate-tab' for details.
5911 - Special case: if point is at the beginning of the buffer and there is
5912 no headline in line 1, this function will act as if called with prefix arg
5913 (C-u TAB, same as S-TAB) also when called without prefix arg.
5914 But only if also the variable `org-cycle-global-at-bob' is t."
5924 org-inlinetask-min-level
5929 limit-level)))
5932 outline-regexp
5940 org-cycle-hook))
5944 ;; special case: use global cycling
5958 ;; Table: enter it or move to the next field.
5969 ;; Global cycling: delegate to `org-cycle-internal-global'.
5972 ;; Drawers: delegate to `org-flag-drawer'.
5980 ;; Show-subtree, ARG levels up from here.
5988 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5994 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6001 ;; From there: TAB emulation and template completion.
6025 t
6034 "Do the global cycling action."
6038 ;; We just created the overview - now do table of contents
6039 ;; This can be slow in very large buffers, so indicate action
6049 ;; We just showed the table of contents - now show everything
6057 ;; Default action: go to overview
6065 "Do the local cycling action."
6067 ;; First, determine end of headline (EOH), end of subtree or item
6068 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6092 ;; Determine end invisible part of buffer (EOL)
6094 ;; XEmacs doesn't have `next-single-char-property-change'
6104 ;; Find out what to do next and set `this-command'
6107 ;; Nothing is hidden behind this heading
6119 org-cycle-skip-children-state-if-no-children))))
6120 ;; Entire subtree is hidden in one line: children view
6126 ;; Fold every list in subtree to top-level items.
6148 ;; We just showed the children, or no children are there,
6149 ;; now show everything.
6156 ;; Default action: hide the subtree.
6163 ;;;###autoload
6165 "Cycle the global visibility. For details see `org-cycle'.
6167 With a numeric prefix, show all headlines up to that level."
6183 "Set the visibility required by startup options and properties."
6198 "Switch subtree visibilities according to :VISIBILITY: property."
6205 nil t)
6230 "Switch to overview mode, showing only top-level headlines.
6231 Really, this shows all headlines with level equal or greater than the level
6232 of the first headline in the buffer. This is important, because if the
6233 first headline is not level one, then (hide-sublevels 1) gives confusing
6234 results."
6245 "Show all headlines in the buffer, like a table of contents.
6246 With numerical argument N, show content up to level N."
6249 ;; Visit all headings and show their offspring
6256 t)
6265 "Adjust the window after a change in outline visibility.
6266 This function is the default value of the hook `org-cycle-hook'."
6276 "Remove outline overlays that do not contain non-white stuff."
6286 "Fix visibility issues after moving a subtree."
6287 ;; First, find a reasonable region to look at:
6288 ;; Start two siblings above, end three below
6306 ;; Properly fold already folded siblings
6317 "Show empty lines above all visible headlines.
6318 The region to be covered depends on STATE when called through
6319 `org-cycle-hook'. Lisp program can use t for STATE to get the
6320 entire buffer covered. Note that an empty line is only shown if there
6321 are at least `org-cycle-separator-lines' empty lines before the headline."
6331 beg end b e)
6355 ;; Never hide empty lines at the end of the file.
6365 "Move to the parent and re-show empty lines before visible headlines."
6371 "Return `org-agenda-files' list, plus all open org-mode files.
6372 This is useful for operations that need to scan all of a user's
6373 open and agenda-wise Org files."
6381 files))
6384 "Return the beginning position of the current entry."
6388 "Return the end position of the current entry."
6392 "Re-hide all drawers after a visibility state change."
6418 "Is the end of the current subtree visible?"
6423 "Move cursor to the first headline and recenter the headline.
6424 Optional argument N means put the headline into the Nth line of the window."
6430 ;;; Saving and restoring visibility
6433 "Return a list of the locations of all outline overlays.
6434 These are overlays with the `invisible' property value `outline'.
6435 The return value is a list of cons cells, with start and stop
6436 positions for each overlay.
6437 If USE-MARKERS is set, return the positions as markers."
6455 "Create visibility overlays for all positions in DATA.
6456 DATA should have been made by `org-outline-overlay-data'."
6465 data)))))
6467 ;;; Folding of blocks
6478 "Call FUNCTION at the head of all source blocks in the current buffer.
6479 Optional arguments START and END can be used to limit the range."
6491 "Toggle the visibility of all blocks in the current buffer."
6495 "Fold all blocks in the current buffer."
6501 "Unfold all blocks in the current buffer."
6507 "Toggle visibility of block at point."
6518 "Toggle the visibility of the current block."
6525 ov)
6541 ;; make the block accessible to isearch
6543 ov 'isearch-open-invisible
6554 ;; org-tab-after-check-for-cycling-hook
6556 ;; Remove overlays when changing major mode
6561 ;;; Org-goto
6567 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6583 nil)
6584 (org-defkey map "q" 'org-goto-quit)
6585 (org-defkey map "n" 'outline-next-visible-heading)
6586 (org-defkey map "p" 'outline-previous-visible-heading)
6587 (org-defkey map "f" 'outline-forward-same-level)
6588 (org-defkey map "b" 'outline-backward-same-level)
6589 (org-defkey map "u" 'outline-up-heading))
6590 (org-defkey map "/" 'org-occur)
6591 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6592 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6593 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6594 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6595 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6596 map))
6598 (defconst org-goto-help
6599 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6600 RET=jump to location [Q]uit and return to previous location
6601 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6603 (defvar org-goto-start-pos) ; dynamically scoped parameter
6605 ;; FIXME: Docstring does not mention both interfaces
6606 (defun org-goto (&optional alternative-interface)
6607 "Look up a different location in the current file, keeping current visibility.
6609 When you want look-up or go to a different location in a document, the
6610 fastest way is often to fold the entire buffer and then dive into the tree.
6611 This method has the disadvantage, that the previous location will be folded,
6612 which may not be what you want.
6614 This command works around this by showing a copy of the current buffer
6615 in an indirect buffer, in overview mode. You can dive into the tree in
6616 that copy, use org-occur and incremental search to find a location.
6617 When pressing RET or `Q', the command returns to the original buffer in
6618 which the visibility is still unchanged. After RET is will also jump to
6619 the location selected in the indirect buffer and expose the headline
6620 hierarchy above."
6621 (interactive "P")
6622 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6623 (org-refile-use-outline-path t)
6624 (org-refile-target-verify-function nil)
6625 (interface
6626 (if (not alternative-interface)
6627 org-goto-interface
6628 (if (eq org-goto-interface 'outline)
6629 'outline-path-completion
6630 'outline)))
6631 (org-goto-start-pos (point))
6632 (selected-point
6633 (if (eq interface 'outline)
6634 (car (org-get-location (current-buffer) org-goto-help))
6635 (let ((pa (org-refile-get-location "Goto")))
6636 (org-refile-check-position pa)
6637 (nth 3 pa)))))
6638 (if selected-point
6639 (progn
6640 (org-mark-ring-push org-goto-start-pos)
6641 (goto-char selected-point)
6642 (if (or (outline-invisible-p) (org-invisible-p2))
6643 (org-show-context 'org-goto)))
6644 (message "Quit"))))
6646 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6647 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6648 (defvar org-goto-local-auto-isearch-map) ; defined below
6650 (defun org-get-location (buf help)
6651 "Let the user select a location in the Org-mode buffer BUF.
6652 This function uses a recursive edit. It returns the selected position
6653 or nil."
6654 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6655 (isearch-hide-immediately nil)
6656 (isearch-search-fun-function
6657 (lambda () 'org-goto-local-search-headings))
6658 (org-goto-selected-point org-goto-exit-command)
6659 (pop-up-frames nil)
6660 (special-display-buffer-names nil)
6661 (special-display-regexps nil)
6662 (special-display-function nil))
6663 (save-excursion
6664 (save-window-excursion
6665 (delete-other-windows)
6666 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6667 (org-pop-to-buffer-same-window
6668 (condition-case nil
6669 (make-indirect-buffer (current-buffer) "*org-goto*")
6670 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6671 (with-output-to-temp-buffer "*Help*"
6672 (princ help))
6673 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6674 (setq buffer-read-only nil)
6675 (let ((org-startup-truncated t)
6676 (org-startup-folded nil)
6677 (org-startup-align-all-tables nil))
6678 (org-mode)
6679 (org-overview))
6680 (setq buffer-read-only t)
6681 (if (and (boundp 'org-goto-start-pos)
6682 (integer-or-marker-p org-goto-start-pos))
6683 (let ((org-show-hierarchy-above t)
6684 (org-show-siblings t)
6685 (org-show-following-heading t))
6686 (goto-char org-goto-start-pos)
6687 (and (outline-invisible-p) (org-show-context)))
6688 (goto-char (point-min)))
6689 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6690 (message "Select location and press RET")
6691 (use-local-map org-goto-map)
6692 (recursive-edit)
6693 ))
6694 (kill-buffer "*org-goto*")
6695 (cons org-goto-selected-point org-goto-exit-command)))
6697 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6698 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6699 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6700 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6702 (defun org-goto-local-search-headings (string bound noerror)
6703 "Search and make sure that any matches are in headlines."
6704 (catch 'return
6705 (while (if isearch-forward
6706 (search-forward string bound noerror)
6707 (search-backward string bound noerror))
6708 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6709 (and (member :headline context)
6710 (not (member :tags context))))
6711 (throw 'return (point))))))
6713 (defun org-goto-local-auto-isearch ()
6714 "Start isearch."
6715 (interactive)
6716 (goto-char (point-min))
6717 (let ((keys (this-command-keys)))
6718 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6719 (isearch-mode t)
6720 (isearch-process-search-char (string-to-char keys)))))
6722 (defun org-goto-ret (&optional arg)
6723 "Finish `org-goto' by going to the new location."
6724 (interactive "P")
6725 (setq org-goto-selected-point (point)
6726 org-goto-exit-command 'return)
6727 (throw 'exit nil))
6729 (defun org-goto-left ()
6730 "Finish `org-goto' by going to the new location."
6731 (interactive)
6732 (if (org-on-heading-p)
6733 (progn
6734 (beginning-of-line 1)
6735 (setq org-goto-selected-point (point)
6736 org-goto-exit-command 'left)
6737 (throw 'exit nil))
6738 (error "Not on a heading")))
6740 (defun org-goto-right ()
6741 "Finish `org-goto' by going to the new location."
6742 (interactive)
6743 (if (org-on-heading-p)
6744 (progn
6745 (setq org-goto-selected-point (point)
6746 org-goto-exit-command 'right)
6747 (throw 'exit nil))
6748 (error "Not on a heading")))
6750 (defun org-goto-quit ()
6751 "Finish `org-goto' without cursor motion."
6752 (interactive)
6753 (setq org-goto-selected-point nil)
6754 (setq org-goto-exit-command 'quit)
6755 (throw 'exit nil))
6757 ;;; Indirect buffer display of subtrees
6759 (defvar org-indirect-dedicated-frame nil
6760 "This is the frame being used for indirect tree display.")
6761 (defvar org-last-indirect-buffer nil)
6763 (defun org-tree-to-indirect-buffer (&optional arg)
6764 "Create indirect buffer and narrow it to current subtree.
6765 With numerical prefix ARG, go up to this level and then take that tree.
6766 If ARG is negative, go up that many levels.
6767 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6768 indirect buffer previously made with this command, to avoid proliferation of
6769 indirect buffers. However, when you call the command with a \
6771 when `org-indirect-buffer-display' is `new-frame', the last buffer
6772 is kept so that you can work with several indirect buffers at the same time.
6773 If `org-indirect-buffer-display' is `dedicated-frame', the \
6775 requests that a new frame be made for the new buffer, so that the dedicated
6776 frame is not changed."
6777 (interactive "P")
6778 (let ((cbuf (current-buffer))
6779 (cwin (selected-window))
6780 (pos (point))
6781 beg end level heading ibuf)
6782 (save-excursion
6783 (org-back-to-heading t)
6784 (when (numberp arg)
6785 (setq level (org-outline-level))
6786 (if (< arg 0) (setq arg (+ level arg)))
6787 (while (> (setq level (org-outline-level)) arg)
6788 (outline-up-heading 1 t)))
6789 (setq beg (point)
6790 heading (org-get-heading))
6791 (org-end-of-subtree t t)
6792 (if (org-on-heading-p) (backward-char 1))
6793 (setq end (point)))
6794 (if (and (buffer-live-p org-last-indirect-buffer)
6795 (not (eq org-indirect-buffer-display 'new-frame))
6796 (not arg))
6797 (kill-buffer org-last-indirect-buffer))
6798 (setq ibuf (org-get-indirect-buffer cbuf)
6799 org-last-indirect-buffer ibuf)
6800 (cond
6801 ((or (eq org-indirect-buffer-display 'new-frame)
6802 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6803 (select-frame (make-frame))
6804 (delete-other-windows)
6805 (org-pop-to-buffer-same-window ibuf)
6806 (org-set-frame-title heading))
6807 ((eq org-indirect-buffer-display 'dedicated-frame)
6808 (raise-frame
6809 (select-frame (or (and org-indirect-dedicated-frame
6810 (frame-live-p org-indirect-dedicated-frame)
6811 org-indirect-dedicated-frame)
6812 (setq org-indirect-dedicated-frame (make-frame)))))
6813 (delete-other-windows)
6814 (org-pop-to-buffer-same-window ibuf)
6815 (org-set-frame-title (concat "Indirect: " heading)))
6816 ((eq org-indirect-buffer-display 'current-window)
6817 (org-pop-to-buffer-same-window ibuf))
6818 ((eq org-indirect-buffer-display 'other-window)
6819 (pop-to-buffer ibuf))
6820 (t (error "Invalid value")))
6821 (if (featurep 'xemacs)
6822 (save-excursion (org-mode) (turn-on-font-lock)))
6823 (narrow-to-region beg end)
6824 (show-all)
6825 (goto-char pos)
6826 (and (window-live-p cwin) (select-window cwin))))
6828 (defun org-get-indirect-buffer (&optional buffer)
6829 (setq buffer (or buffer (current-buffer)))
6830 (let ((n 1) (base (buffer-name buffer)) bname)
6831 (while (buffer-live-p
6832 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6833 (setq n (1+ n)))
6834 (condition-case nil
6835 (make-indirect-buffer buffer bname 'clone)
6836 (error (make-indirect-buffer buffer bname)))))
6838 (defun org-set-frame-title (title)
6839 "Set the title of the current frame to the string TITLE."
6840 ;; FIXME: how to name a single frame in XEmacs???
6841 (unless (featurep 'xemacs)
6842 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6844 ;;;; Structure editing
6846 ;;; Inserting headlines
6848 (defun org-previous-line-empty-p ()
6849 (save-excursion
6850 (and (not (bobp))
6851 (or (beginning-of-line 0) t)
6852 (save-match-data
6855 (defun org-insert-heading (&optional force-heading invisible-ok)
6856 "Insert a new heading or item with same depth at point.
6857 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6858 If point is at the beginning of a headline, insert a sibling before the
6859 current headline. If point is not at the beginning, split the line,
6860 create the new headline with the text in the current line after point
6861 \(but see also the variable `org-M-RET-may-split-line').
6863 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6864 This is important for non-interactive uses of the command."
6865 (interactive "P")
6866 (if (or (= (buffer-size) 0)
6867 (and (not (save-excursion
6868 (and (ignore-errors (org-back-to-heading invisible-ok))
6869 (org-on-heading-p))))
6870 (not (org-in-item-p))))
6871 (progn
6873 (run-hooks 'org-insert-heading-hook))
6874 (when (or force-heading (not (org-insert-item)))
6875 (let* ((empty-line-p nil)
6876 (level nil)
6877 (on-heading (org-on-heading-p))
6878 (head (save-excursion
6879 (condition-case nil
6880 (progn
6881 (org-back-to-heading invisible-ok)
6882 (when (and (not on-heading)
6883 (featurep 'org-inlinetask)
6884 (integerp org-inlinetask-min-level)
6885 (>= (length (match-string 0))
6886 org-inlinetask-min-level))
6887 ;; Find a heading level before the inline task
6888 (while (and (setq level (org-up-heading-safe))
6889 (>= level org-inlinetask-min-level)))
6890 (if (org-on-heading-p)
6891 (org-back-to-heading invisible-ok)
6892 (error "This should not happen")))
6893 (setq empty-line-p (org-previous-line-empty-p))
6894 (match-string 0))
6895 (error "*"))))
6896 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6897 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6898 pos hide-previous previous-pos)
6899 (cond
6900 ((and (org-on-heading-p) (bolp)
6901 (or (bobp)
6902 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6903 ;; insert before the current line
6904 (open-line (if blank 2 1)))
6905 ((and (bolp)
6906 (not org-insert-heading-respect-content)
6907 (or (bobp)
6908 (save-excursion
6909 (backward-char 1) (not (outline-invisible-p)))))
6910 ;; insert right here
6911 nil)
6912 (t
6913 ;; somewhere in the line
6914 (save-excursion
6915 (setq previous-pos (point-at-bol))
6916 (end-of-line)
6917 (setq hide-previous (outline-invisible-p)))
6918 (and org-insert-heading-respect-content (org-show-subtree))
6919 (let ((split
6920 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6921 (save-excursion
6922 (let ((p (point)))
6923 (goto-char (point-at-bol))
6924 (and (looking-at org-complex-heading-regexp)
6925 (> p (match-beginning 4)))))))
6926 tags pos)
6927 (cond
6928 (org-insert-heading-respect-content
6929 (org-end-of-subtree nil t)
6930 (when (featurep 'org-inlinetask)
6931 (while (and (not (eobp))
6933 (>= (length (match-string 1))
6934 org-inlinetask-min-level))
6935 (org-end-of-subtree nil t)))
6936 (or (bolp) (newline))
6937 (or (org-previous-line-empty-p)
6938 (and blank (newline)))
6939 (open-line 1))
6940 ((org-on-heading-p)
6941 (when hide-previous
6942 (show-children)
6943 (org-show-entry))
6945 (setq tags (and (match-end 2) (match-string 2)))
6946 (and (match-end 1)
6947 (delete-region (match-beginning 1) (match-end 1)))
6948 (setq pos (point-at-bol))
6949 (or split (end-of-line 1))
6950 (delete-horizontal-space)
6952 (buffer-substring (point-at-bol) (point)))
6953 (insert " "))
6954 (newline (if blank 2 1))
6955 (when tags
6956 (save-excursion
6957 (goto-char pos)
6958 (end-of-line 1)
6959 (insert " " tags)
6960 (org-set-tags nil 'align))))
6961 (t
6962 (or split (end-of-line 1))
6963 (newline (if blank 2 1)))))))
6964 (insert head) (just-one-space)
6965 (setq pos (point))
6966 (end-of-line 1)
6967 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6968 (when (and org-insert-heading-respect-content hide-previous)
6969 (save-excursion
6970 (goto-char previous-pos)
6971 (hide-subtree)))
6972 (run-hooks 'org-insert-heading-hook)))))
6974 (defun org-get-heading (&optional no-tags no-todo)
6975 "Return the heading of the current entry, without the stars.
6976 When NO-TAGS is non-nil, don't include tags.
6977 When NO-TODO is non-nil, don't include TODO keywords."
6978 (save-excursion
6979 (org-back-to-heading t)
6980 (cond
6981 ((and no-tags no-todo)
6982 (looking-at org-complex-heading-regexp)
6983 (match-string 4))
6984 (no-tags
6986 (match-string 1))
6987 (no-todo
6990 (match-string 2))
6992 (match-string 1)))))
6994 (defun org-heading-components ()
6995 "Return the components of the current heading.
6996 This is a list with the following elements:
6997 - the level as an integer
6998 - the reduced level, different if `org-odd-levels-only' is set.
6999 - the TODO keyword, or nil
7000 - the priority character, like ?A, or nil if no priority is given
7001 - the headline text itself, or the tags string if no headline text
7002 - the tags string, or nil."
7003 (save-excursion
7004 (org-back-to-heading t)
7005 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7006 (list (length (match-string 1))
7007 (org-reduced-level (length (match-string 1)))
7008 (org-match-string-no-properties 2)
7009 (and (match-end 3) (aref (match-string 3) 2))
7010 (org-match-string-no-properties 4)
7011 (org-match-string-no-properties 5)))))
7013 (defun org-get-entry ()
7014 "Get the entry text, after heading, entire subtree."
7015 (save-excursion
7016 (org-back-to-heading t)
7017 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7019 (defun org-insert-heading-after-current ()
7020 "Insert a new heading with same level as current, after current subtree."
7021 (interactive)
7022 (org-back-to-heading)
7023 (org-insert-heading)
7024 (org-move-subtree-down)
7025 (end-of-line 1))
7027 (defun org-insert-heading-respect-content ()
7028 (interactive)
7029 (let ((org-insert-heading-respect-content t))
7030 (org-insert-heading t)))
7032 (defun org-insert-todo-heading-respect-content (&optional force-state)
7033 (interactive "P")
7034 (let ((org-insert-heading-respect-content t))
7035 (org-insert-todo-heading force-state t)))
7037 (defun org-insert-todo-heading (arg &optional force-heading)
7038 "Insert a new heading with the same level and TODO state as current heading.
7039 If the heading has no TODO state, or if the state is DONE, use the first
7040 state (TODO by default). Also with prefix arg, force first state."
7041 (interactive "P")
7042 (when (or force-heading (not (org-insert-item 'checkbox)))
7043 (org-insert-heading force-heading)
7044 (save-excursion
7045 (org-back-to-heading)
7046 (outline-previous-heading)
7047 (looking-at org-todo-line-regexp))
7048 (let*
7049 ((new-mark-x
7050 (if (or arg
7051 (not (match-beginning 2))
7052 (member (match-string 2) org-done-keywords))
7053 (car org-todo-keywords-1)
7054 (match-string 2)))
7055 (new-mark
7056 (or
7057 (run-hook-with-args-until-success
7058 'org-todo-get-default-hook new-mark-x nil)
7059 new-mark-x)))
7060 (beginning-of-line 1)
7061 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7062 (if org-treat-insert-todo-heading-as-state-change
7063 (org-todo new-mark)
7064 (insert new-mark " "))))
7065 (when org-provide-todo-statistics
7066 (org-update-parent-todo-statistics))))
7068 (defun org-insert-subheading (arg)
7069 "Insert a new subheading and demote it.
7070 Works for outline headings and for plain lists alike."
7071 (interactive "P")
7072 (org-insert-heading arg)
7073 (cond
7074 ((org-on-heading-p) (org-do-demote))
7075 ((org-at-item-p) (org-indent-item))))
7077 (defun org-insert-todo-subheading (arg)
7078 "Insert a new subheading with TODO keyword or checkbox and demote it.
7079 Works for outline headings and for plain lists alike."
7080 (interactive "P")
7081 (org-insert-todo-heading arg)
7082 (cond
7083 ((org-on-heading-p) (org-do-demote))
7084 ((org-at-item-p) (org-indent-item))))
7086 ;;; Promotion and Demotion
7088 (defvar org-after-demote-entry-hook nil
7089 "Hook run after an entry has been demoted.
7090 The cursor will be at the beginning of the entry.
7091 When a subtree is being demoted, the hook will be called for each node.")
7093 (defvar org-after-promote-entry-hook nil
7094 "Hook run after an entry has been promoted.
7095 The cursor will be at the beginning of the entry.
7096 When a subtree is being promoted, the hook will be called for each node.")
7098 (defun org-promote-subtree ()
7099 "Promote the entire subtree.
7100 See also `org-promote'."
7101 (interactive)
7102 (save-excursion
7103 (org-with-limited-levels (org-map-tree 'org-promote)))
7104 (org-fix-position-after-promote))
7106 (defun org-demote-subtree ()
7107 "Demote the entire subtree. See `org-demote'.
7108 See also `org-promote'."
7109 (interactive)
7110 (save-excursion
7111 (org-with-limited-levels (org-map-tree 'org-demote)))
7112 (org-fix-position-after-promote))
7115 (defun org-do-promote ()
7116 "Promote the current heading higher up the tree.
7117 If the region is active in `transient-mark-mode', promote all headings
7118 in the region."
7119 (interactive)
7120 (save-excursion
7121 (if (org-region-active-p)
7122 (org-map-region 'org-promote (region-beginning) (region-end))
7123 (org-promote)))
7124 (org-fix-position-after-promote))
7126 (defun org-do-demote ()
7127 "Demote the current heading lower down the tree.
7128 If the region is active in `transient-mark-mode', demote all headings
7129 in the region."
7130 (interactive)
7131 (save-excursion
7132 (if (org-region-active-p)
7133 (org-map-region 'org-demote (region-beginning) (region-end))
7134 (org-demote)))
7135 (org-fix-position-after-promote))
7137 (defun org-fix-position-after-promote ()
7138 "Make sure that after pro/demotion cursor position is right."
7139 (let ((pos (point)))
7140 (when (save-excursion
7141 (beginning-of-line 1)
7142 (looking-at org-todo-line-regexp)
7143 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7144 (cond ((eobp) (insert " "))
7145 ((eolp) (insert " "))
7146 ((equal (char-after) ?\ ) (forward-char 1))))))
7148 (defun org-current-level ()
7149 "Return the level of the current entry, or nil if before the first headline.
7150 The level is the number of stars at the beginning of the headline."
7151 (save-excursion
7152 (org-with-limited-levels
7153 (ignore-errors
7154 (org-back-to-heading t)
7155 (funcall outline-level)))))
7157 (defun org-get-previous-line-level ()
7158 "Return the outline depth of the last headline before the current line.
7159 Returns 0 for the first headline in the buffer, and nil if before the
7160 first headline."
7161 (let ((current-level (org-current-level))
7162 (prev-level (when (> (line-number-at-pos) 1)
7163 (save-excursion
7164 (beginning-of-line 0)
7165 (org-current-level)))))
7166 (cond ((null current-level) nil) ; Before first headline
7167 ((null prev-level) 0) ; At first headline
7168 (prev-level))))
7170 (defun org-reduced-level (l)
7171 "Compute the effective level of a heading.
7172 This takes into account the setting of `org-odd-levels-only'."
7173 (cond
7174 ((zerop l) 0)
7175 (org-odd-levels-only (1+ (floor (/ l 2))))
7176 (t l)))
7178 (defun org-level-increment ()
7179 "Return the number of stars that will be added or removed at a
7180 time to headlines when structure editing, based on the value of
7181 `org-odd-levels-only'."
7182 (if org-odd-levels-only 2 1))
7184 (defun org-get-valid-level (level &optional change)
7185 "Rectify a level change under the influence of `org-odd-levels-only'
7186 LEVEL is a current level, CHANGE is by how much the level should be
7187 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7188 even level numbers will become the next higher odd number."
7189 (if org-odd-levels-only
7190 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7191 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7192 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7193 (max 1 (+ level (or change 0)))))
7195 (if (boundp 'define-obsolete-function-alias)
7196 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7197 (define-obsolete-function-alias 'org-get-legal-level
7198 'org-get-valid-level)
7199 (define-obsolete-function-alias 'org-get-legal-level
7200 'org-get-valid-level "23.1")))
7202 (defun org-promote ()
7203 "Promote the current heading higher up the tree.
7204 If the region is active in `transient-mark-mode', promote all headings
7205 in the region."
7206 (org-back-to-heading t)
7207 (let* ((level (save-match-data (funcall outline-level)))
7208 (after-change-functions (remove 'flyspell-after-change-function
7209 after-change-functions))
7210 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7211 (diff (abs (- level (length up-head) -1))))
7212 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7213 (replace-match up-head nil t)
7214 ;; Fixup tag positioning
7215 (and org-auto-align-tags (org-set-tags nil t))
7216 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7217 (run-hooks 'org-after-promote-entry-hook)))
7219 (defun org-demote ()
7220 "Demote the current heading lower down the tree.
7221 If the region is active in `transient-mark-mode', demote all headings
7222 in the region."
7223 (org-back-to-heading t)
7224 (let* ((level (save-match-data (funcall outline-level)))
7225 (after-change-functions (remove 'flyspell-after-change-function
7226 after-change-functions))
7227 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7228 (diff (abs (- level (length down-head) -1))))
7229 (replace-match down-head nil t)
7230 ;; Fixup tag positioning
7231 (and org-auto-align-tags (org-set-tags nil t))
7232 (if org-adapt-indentation (org-fixup-indentation diff))
7233 (run-hooks 'org-after-demote-entry-hook)))
7235 (defun org-cycle-level ()
7236 "Cycle the level of an empty headline through possible states.
7237 This goes first to child, then to parent, level, then up the hierarchy.
7238 After top level, it switches back to sibling level."
7239 (interactive)
7240 (let ((org-adapt-indentation nil))
7241 (when (org-point-at-end-of-empty-headline)
7242 (setq this-command 'org-cycle-level) ; Only needed for caching
7243 (let ((cur-level (org-current-level))
7244 (prev-level (org-get-previous-line-level)))
7245 (cond
7246 ;; If first headline in file, promote to top-level.
7247 ((= prev-level 0)
7248 (loop repeat (/ (- cur-level 1) (org-level-increment))
7249 do (org-do-promote)))
7250 ;; If same level as prev, demote one.
7251 ((= prev-level cur-level)
7252 (org-do-demote))
7253 ;; If parent is top-level, promote to top level if not already.
7254 ((= prev-level 1)
7255 (loop repeat (/ (- cur-level 1) (org-level-increment))
7256 do (org-do-promote)))
7257 ;; If top-level, return to prev-level.
7258 ((= cur-level 1)
7259 (loop repeat (/ (- prev-level 1) (org-level-increment))
7260 do (org-do-demote)))
7261 ;; If less than prev-level, promote one.
7262 ((< cur-level prev-level)
7263 (org-do-promote))
7264 ;; If deeper than prev-level, promote until higher than
7265 ;; prev-level.
7266 ((> cur-level prev-level)
7267 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7268 do (org-do-promote))))
7269 t))))
7271 (defun org-map-tree (fun)
7272 "Call FUN for every heading underneath the current one."
7273 (org-back-to-heading)
7274 (let ((level (funcall outline-level)))
7275 (save-excursion
7276 (funcall fun)
7277 (while (and (progn
7278 (outline-next-heading)
7279 (> (funcall outline-level) level))
7280 (not (eobp)))
7281 (funcall fun)))))
7283 (defun org-map-region (fun beg end)
7284 "Call FUN for every heading between BEG and END."
7285 (let ((org-ignore-region t))
7286 (save-excursion
7287 (setq end (copy-marker end))
7288 (goto-char beg)
7289 (if (and (re-search-forward org-outline-regexp-bol nil t)
7290 (< (point) end))
7291 (funcall fun))
7292 (while (and (progn
7293 (outline-next-heading)
7294 (< (point) end))
7295 (not (eobp)))
7296 (funcall fun)))))
7298 (defun org-fixup-indentation (diff)
7299 "Change the indentation in the current entry by DIFF.
7300 However, if any line in the current entry has no indentation, or if it
7301 would end up with no indentation after the change, nothing at all is done."
7302 (save-excursion
7303 (let ((end (save-excursion (outline-next-heading)
7304 (point-marker)))
7305 (prohibit (if (> diff 0)
7308 col)
7309 (unless (save-excursion (end-of-line 1)
7310 (re-search-forward prohibit end t))
7311 (while (and (< (point) end)
7313 (goto-char (match-end 0))
7314 (setq col (current-column))
7315 (if (< diff 0) (replace-match ""))
7316 (org-indent-to-column (+ diff col))))
7317 (move-marker end nil))))
7319 (defun org-convert-to-odd-levels ()
7320 "Convert an org-mode file with all levels allowed to one with odd levels.
7321 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7322 level 5 etc."
7323 (interactive)
7324 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7325 (let ((outline-level 'org-outline-level)
7326 (org-odd-levels-only nil) n)
7327 (save-excursion
7328 (goto-char (point-min))
7330 (setq n (- (length (match-string 0)) 2))
7331 (while (>= (setq n (1- n)) 0)
7332 (org-demote))
7333 (end-of-line 1))))))
7335 (defun org-convert-to-oddeven-levels ()
7336 "Convert an org-mode file with only odd levels to one with odd/even levels.
7337 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7338 file contains a section with an even level, conversion would
7339 destroy the structure of the file. An error is signaled in this
7340 case."
7341 (interactive)
7342 (goto-char (point-min))
7343 ;; First check if there are no even levels
7345 (org-show-context t)
7346 (error "Not all levels are odd in this file. Conversion not possible"))
7347 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7348 (let ((outline-regexp org-outline-regexp)
7349 (outline-level 'org-outline-level)
7350 (org-odd-levels-only nil) n)
7351 (save-excursion
7352 (goto-char (point-min))
7354 (setq n (/ (1- (length (match-string 0))) 2))
7355 (while (>= (setq n (1- n)) 0)
7356 (org-promote))
7357 (end-of-line 1))))))
7359 (defun org-tr-level (n)
7360 "Make N odd if required."
7361 (if org-odd-levels-only (1+ (/ n 2)) n))
7363 ;;; Vertical tree motion, cutting and pasting of subtrees
7365 (defun org-move-subtree-up (&optional arg)
7366 "Move the current subtree up past ARG headlines of the same level."
7367 (interactive "p")
7368 (org-move-subtree-down (- (prefix-numeric-value arg))))
7370 (defun org-move-subtree-down (&optional arg)
7371 "Move the current subtree down past ARG headlines of the same level."
7372 (interactive "p")
7373 (setq arg (prefix-numeric-value arg))
7374 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7375 'org-get-last-sibling))
7376 (ins-point (make-marker))
7377 (cnt (abs arg))
7378 (col (current-column))
7379 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7380 ;; Select the tree
7381 (org-back-to-heading)
7382 (setq beg0 (point))
7383 (save-excursion
7384 (setq ne-beg (org-back-over-empty-lines))
7385 (setq beg (point)))
7386 (save-match-data
7387 (save-excursion (outline-end-of-heading)
7388 (setq folded (outline-invisible-p)))
7389 (outline-end-of-subtree))
7390 (outline-next-heading)
7391 (setq ne-end (org-back-over-empty-lines))
7392 (setq end (point))
7393 (goto-char beg0)
7394 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7395 ;; include less whitespace
7396 (save-excursion
7397 (goto-char beg)
7398 (forward-line (- ne-beg ne-end))
7399 (setq beg (point))))
7400 ;; Find insertion point, with error handling
7401 (while (> cnt 0)
7402 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7403 (progn (goto-char beg0)
7404 (error "Cannot move past superior level or buffer limit")))
7405 (setq cnt (1- cnt)))
7406 (if (> arg 0)
7407 ;; Moving forward - still need to move over subtree
7408 (progn (org-end-of-subtree t t)
7409 (save-excursion
7410 (org-back-over-empty-lines)
7411 (or (bolp) (newline)))))
7412 (setq ne-ins (org-back-over-empty-lines))
7413 (move-marker ins-point (point))
7414 (setq txt (buffer-substring beg end))
7415 (org-save-markers-in-region beg end)
7416 (delete-region beg end)
7417 (org-remove-empty-overlays-at beg)
7418 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7419 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7421 (let ((bbb (point)))
7422 (insert-before-markers txt)
7423 (org-reinstall-markers-in-region bbb)
7424 (move-marker ins-point bbb))
7426 (setq ins-end (point))
7427 (goto-char ins-point)
7428 (org-skip-whitespace)
7429 (when (and (< arg 0)
7430 (org-first-sibling-p)
7431 (> ne-ins ne-beg))
7432 ;; Move whitespace back to beginning
7433 (save-excursion
7434 (goto-char ins-end)
7435 (let ((kill-whole-line t))
7436 (kill-line (- ne-ins ne-beg)) (point)))
7438 (move-marker ins-point nil)
7439 (if folded
7440 (hide-subtree)
7441 (org-show-entry)
7442 (show-children)
7443 (org-cycle-hide-drawers 'children))
7444 (org-clean-visibility-after-subtree-move)
7445 ;; move back to the initial column we were at
7446 (move-to-column col)))
7448 (defvar org-subtree-clip ""
7449 "Clipboard for cut and paste of subtrees.
7450 This is actually only a copy of the kill, because we use the normal kill
7451 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7453 (defvar org-subtree-clip-folded nil
7454 "Was the last copied subtree folded?
7455 This is used to fold the tree back after pasting.")
7457 (defun org-cut-subtree (&optional n)
7458 "Cut the current subtree into the clipboard.
7459 With prefix arg N, cut this many sequential subtrees.
7460 This is a short-hand for marking the subtree and then cutting it."
7461 (interactive "p")
7462 (org-copy-subtree n 'cut))
7464 (defun org-copy-subtree (&optional n cut force-store-markers)
7465 "Cut the current subtree into the clipboard.
7466 With prefix arg N, cut this many sequential subtrees.
7467 This is a short-hand for marking the subtree and then copying it.
7468 If CUT is non-nil, actually cut the subtree.
7469 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7470 of some markers in the region, even if CUT is non-nil. This is
7471 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7472 (interactive "p")
7473 (let (beg end folded (beg0 (point)))
7474 (if (org-called-interactively-p 'any)
7475 (org-back-to-heading nil) ; take what looks like a subtree
7476 (org-back-to-heading t)) ; take what is really there
7477 (org-back-over-empty-lines)
7478 (setq beg (point))
7480 (save-match-data
7481 (save-excursion (outline-end-of-heading)
7482 (setq folded (outline-invisible-p)))
7483 (condition-case nil
7484 (org-forward-same-level (1- n) t)
7485 (error nil))
7486 (org-end-of-subtree t t))
7487 (org-back-over-empty-lines)
7488 (setq end (point))
7489 (goto-char beg0)
7490 (when (> end beg)
7491 (setq org-subtree-clip-folded folded)
7492 (when (or cut force-store-markers)
7493 (org-save-markers-in-region beg end))
7494 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7495 (setq org-subtree-clip (current-kill 0))
7496 (message "%s: Subtree(s) with %d characters"
7497 (if cut "Cut" "Copied")
7498 (length org-subtree-clip)))))
7500 (defun org-paste-subtree (&optional level tree for-yank)
7501 "Paste the clipboard as a subtree, with modification of headline level.
7502 The entire subtree is promoted or demoted in order to match a new headline
7503 level.
7505 If the cursor is at the beginning of a headline, the same level as
7506 that headline is used to paste the tree
7508 If not, the new level is derived from the *visible* headings
7509 before and after the insertion point, and taken to be the inferior headline
7510 level of the two. So if the previous visible heading is level 3 and the
7511 next is level 4 (or vice versa), level 4 will be used for insertion.
7512 This makes sure that the subtree remains an independent subtree and does
7513 not swallow low level entries.
7515 You can also force a different level, either by using a numeric prefix
7516 argument, or by inserting the heading marker by hand. For example, if the
7519 If optional TREE is given, use this text instead of the kill ring.
7521 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7522 move back over whitespace before inserting, and move point to the end of
7523 the inserted text when done."
7524 (interactive "P")
7525 (setq tree (or tree (and kill-ring (current-kill 0))))
7526 (unless (org-kill-is-subtree-p tree)
7527 (error "%s"
7528 (substitute-command-keys
7530 (org-with-limited-levels
7531 (let* ((visp (not (outline-invisible-p)))
7532 (txt tree)
7534 (old-level (if (string-match org-outline-regexp-bol txt)
7535 (- (match-end 0) (match-beginning 0) 1)
7536 -1))
7537 (force-level (cond (level (prefix-numeric-value level))
7539 (string-match
7540 ^re_ (buffer-substring
7541 (point-at-bol) (point))))
7542 (- (match-end 1) (match-beginning 1)))
7543 ((and (bolp)
7544 (looking-at org-outline-regexp))
7545 (- (match-end 0) (point) 1))
7546 (t nil)))
7547 (previous-level (save-excursion
7548 (condition-case nil
7549 (progn
7550 (outline-previous-visible-heading 1)
7551 (if (looking-at re)
7552 (- (match-end 0) (match-beginning 0) 1)
7553 1))
7554 (error 1))))
7555 (next-level (save-excursion
7556 (condition-case nil
7557 (progn
7558 (or (looking-at org-outline-regexp)
7559 (outline-next-visible-heading 1))
7560 (if (looking-at re)
7561 (- (match-end 0) (match-beginning 0) 1)
7562 1))
7563 (error 1))))
7564 (new-level (or force-level (max previous-level next-level)))
7565 (shift (if (or (= old-level -1)
7566 (= new-level -1)
7567 (= old-level new-level))
7568 0
7569 (- new-level old-level)))
7570 (delta (if (> shift 0) -1 1))
7571 (func (if (> shift 0) 'org-demote 'org-promote))
7572 (org-odd-levels-only nil)
7573 beg end newend)
7574 ;; Remove the forced level indicator
7575 (if force-level
7576 (delete-region (point-at-bol) (point)))
7577 ;; Paste
7578 (beginning-of-line 1)
7579 (unless for-yank (org-back-over-empty-lines))
7580 (setq beg (point))
7581 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7582 (insert-before-markers txt)
7584 (setq newend (point))
7585 (org-reinstall-markers-in-region beg)
7586 (setq end (point))
7587 (goto-char beg)
7589 (setq beg (point))
7590 (if (and (outline-invisible-p) visp)
7591 (save-excursion (outline-show-heading)))
7592 ;; Shift if necessary
7593 (unless (= shift 0)
7594 (save-restriction
7595 (narrow-to-region beg end)
7596 (while (not (= shift 0))
7597 (org-map-region func (point-min) (point-max))
7598 (setq shift (+ delta shift)))
7599 (goto-char (point-min))
7600 (setq newend (point-max))))
7601 (when (or (org-called-interactively-p 'interactive) for-yank)
7602 (message "Clipboard pasted as level %d subtree" new-level))
7603 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7604 kill-ring
7605 (eq org-subtree-clip (current-kill 0))
7606 org-subtree-clip-folded)
7607 ;; The tree was folded before it was killed/copied
7608 (hide-subtree))
7609 (and for-yank (goto-char newend)))))
7611 (defun org-kill-is-subtree-p (&optional txt)
7612 "Check if the current kill is an outline subtree, or a set of trees.
7613 Returns nil if kill does not start with a headline, or if the first
7614 headline level is not the largest headline level in the tree.
7615 So this will actually accept several entries of equal levels as well,
7616 which is OK for `org-paste-subtree'.
7617 If optional TXT is given, check this string instead of the current kill."
7618 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7619 (re (org-get-limited-outline-regexp))
7620 (^re (concat "^" re))
7621 (start-level (and kill
7622 (string-match
7624 kill)
7625 (- (match-end 2) (match-beginning 2) 1)))
7626 (start (1+ (or (match-beginning 2) -1))))
7627 (if (not start-level)
7628 (progn
7629 nil) ;; does not even start with a heading
7630 (catch 'exit
7631 (while (setq start (string-match ^re kill (1+ start)))
7632 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7633 (throw 'exit nil)))
7634 t))))
7636 (defvar org-markers-to-move nil
7637 "Markers that should be moved with a cut-and-paste operation.
7638 Those markers are stored together with their positions relative to
7639 the start of the region.")
7641 (defun org-save-markers-in-region (beg end)
7642 "Check markers in region.
7643 If these markers are between BEG and END, record their position relative
7644 to BEG, so that after moving the block of text, we can put the markers back
7645 into place.
7646 This function gets called just before an entry or tree gets cut from the
7647 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7648 called immediately, to move the markers with the entries."
7649 (setq org-markers-to-move nil)
7650 (when (featurep 'org-clock)
7651 (org-clock-save-markers-for-cut-and-paste beg end))
7652 (when (featurep 'org-agenda)
7653 (org-agenda-save-markers-for-cut-and-paste beg end)))
7655 (defun org-check-and-save-marker (marker beg end)
7656 "Check if MARKER is between BEG and END.
7657 If yes, remember the marker and the distance to BEG."
7658 (when (and (marker-buffer marker)
7659 (equal (marker-buffer marker) (current-buffer)))
7660 (if (and (>= marker beg) (< marker end))
7661 (push (cons marker (- marker beg)) org-markers-to-move))))
7663 (defun org-reinstall-markers-in-region (beg)
7664 "Move all remembered markers to their position relative to BEG."
7665 (mapc (lambda (x)
7666 (move-marker (car x) (+ beg (cdr x))))
7667 org-markers-to-move)
7668 (setq org-markers-to-move nil))
7670 (defun org-narrow-to-subtree ()
7671 "Narrow buffer to the current subtree."
7672 (interactive)
7673 (save-excursion
7674 (save-match-data
7675 (org-with-limited-levels
7676 (narrow-to-region
7677 (progn (org-back-to-heading t) (point))
7678 (progn (org-end-of-subtree t t)
7679 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7680 (point)))))))
7682 (defun org-narrow-to-block ()
7683 "Narrow buffer to the current block."
7684 (interactive)
7687 (case-fold-search t) ;; allow #+BEGIN
7688 b_start b_end)
7689 (if (org-in-regexps-block-p bstart bend)
7690 (progn
7691 (save-excursion (re-search-backward bstart nil t)
7692 (setq b_start (match-beginning 0)))
7693 (save-excursion (re-search-forward bend nil t)
7694 (setq b_end (match-end 0)))
7695 (narrow-to-region b_start b_end))
7696 (error "Not in a block"))))
7698 (eval-when-compile
7699 (defvar org-property-drawer-re))
7701 (defvar org-property-start-re) ;; defined below
7702 (defun org-clone-subtree-with-time-shift (n &optional shift)
7703 "Clone the task (subtree) at point N times.
7704 The clones will be inserted as siblings.
7706 In interactive use, the user will be prompted for the number of
7707 clones to be produced, and for a time SHIFT, which may be a
7708 repeater as used in time stamps, for example `+3d'.
7710 When a valid repeater is given and the entry contains any time
7711 stamps, the clones will become a sequence in time, with time
7712 stamps in the subtree shifted for each clone produced. If SHIFT
7713 is nil or the empty string, time stamps will be left alone. The
7714 ID property of the original subtree is removed.
7716 If the original subtree did contain time stamps with a repeater,
7717 the following will happen:
7718 - the repeater will be removed in each clone
7719 - an additional clone will be produced, with the current, unshifted
7720 date(s) in the entry.
7721 - the original entry will be placed *after* all the clones, with
7722 repeater intact.
7723 - the start days in the repeater in the original entry will be shifted
7724 to past the last clone.
7725 I this way you can spell out a number of instances of a repeating task,
7726 and still retain the repeater to cover future instances of the task."
7727 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7728 (let (beg end template task idprop
7729 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7730 (if (not (and (integerp n) (> n 0)))
7731 (error "Invalid number of replications %s" n))
7734 shift)))
7735 (error "Invalid shift specification %s" shift))
7736 (when doshift
7737 (setq shift-n (string-to-number (match-string 1 shift))
7738 shift-what (cdr (assoc (match-string 2 shift)
7739 '(("d" . day) ("w" . week)
7740 ("m" . month) ("y" . year))))))
7741 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7742 (setq nmin 1 nmax n)
7743 (org-back-to-heading t)
7744 (setq beg (point))
7745 (setq idprop (org-entry-get nil "ID"))
7746 (org-end-of-subtree t t)
7748 (setq end (point))
7749 (setq template (buffer-substring beg end))
7750 ;; Remove clocks and empty drawers
7751 (with-temp-buffer
7752 (insert template)
7753 (goto-char (point-min))
7754 (while (re-search-forward
7756 (replace-match "")
7757 (kill-whole-line))
7758 (goto-char (point-min))
7759 (while (re-search-forward
7761 (mapc (lambda(d) (org-remove-empty-drawer-at d (point))) org-drawers))
7762 (setq template (buffer-substring (point-min) (point-max))))
7763 (when (and doshift
7765 (delete-region beg end)
7766 (setq end beg)
7767 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7768 (goto-char end)
7769 (loop for n from nmin to nmax do
7770 ;; prepare clone
7771 (with-temp-buffer
7772 (insert template)
7773 (org-mode)
7774 (goto-char (point-min))
7775 (and idprop (if org-clone-delete-id
7776 (org-entry-delete nil "ID")
7777 (org-id-get-create t)))
7778 (while (re-search-forward org-property-start-re nil t)
7779 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7780 (goto-char (point-min))
7781 (when doshift
7782 (while (re-search-forward org-ts-regexp-both nil t)
7783 (org-timestamp-change (* n shift-n) shift-what))
7784 (unless (= n n-no-remove)
7785 (goto-char (point-min))
7786 (while (re-search-forward org-ts-regexp nil t)
7787 (save-excursion
7788 (goto-char (match-beginning 0))
7790 (delete-region (match-beginning 1) (match-end 1)))))))
7791 (setq task (buffer-string)))
7792 (insert task))
7793 (goto-char beg)))
7795 ;;; Outline Sorting
7797 (defun org-sort (with-case)
7798 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7799 Optional argument WITH-CASE means sort case-sensitively.
7800 With a double prefix argument, also remove duplicate entries."
7801 (interactive "P")
7802 (cond
7803 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7804 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7805 (t
7806 (org-call-with-arg 'org-sort-entries with-case))))
7808 (defun org-sort-remove-invisible (s)
7809 (remove-text-properties 0 (length s) org-rm-props s)
7810 (while (string-match org-bracket-link-regexp s)
7811 (setq s (replace-match (if (match-end 2)
7812 (match-string 3 s)
7813 (match-string 1 s)) t t s)))
7814 s)
7816 (defvar org-priority-regexp) ; defined later in the file
7818 (defvar org-after-sorting-entries-or-items-hook nil
7819 "Hook that is run after a bunch of entries or items have been sorted.
7820 When children are sorted, the cursor is in the parent line when this
7821 hook gets called. When a region or a plain list is sorted, the cursor
7822 will be in the first entry of the sorted region/list.")
7824 (defun org-sort-entries
7825 (&optional with-case sorting-type getkey-func compare-func property)
7826 "Sort entries on a certain level of an outline tree.
7827 If there is an active region, the entries in the region are sorted.
7828 Else, if the cursor is before the first entry, sort the top-level items.
7829 Else, the children of the entry at point are sorted.
7831 Sorting can be alphabetically, numerically, by date/time as given by
7832 a time stamp, by a property or by priority.
7834 The command prompts for the sorting type unless it has been given to the
7835 function through the SORTING-TYPE argument, which needs to be a character,
7836 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7837 precise meaning of each character:
7839 n Numerically, by converting the beginning of the entry/item to a number.
7840 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7841 t By date/time, either the first active time stamp in the entry, or, if
7842 none exist, by the first inactive one.
7843 s By the scheduled date/time.
7844 d By deadline date/time.
7845 c By creation time, which is assumed to be the first inactive time stamp
7846 at the beginning of a line.
7847 p By priority according to the cookie.
7848 r By the value of a property.
7850 Capital letters will reverse the sort order.
7852 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7853 called with point at the beginning of the record. It must return either
7854 a string or a number that should serve as the sorting key for that record.
7856 Comparing entries ignores case by default. However, with an optional argument
7857 WITH-CASE, the sorting considers case as well."
7858 (interactive "P")
7859 (let ((case-func (if with-case 'identity 'downcase))
7860 start beg end stars re re2
7861 txt what tmp)
7862 ;; Find beginning and end of region to sort
7863 (cond
7864 ((org-region-active-p)
7865 ;; we will sort the region
7866 (setq end (region-end)
7867 what "region")
7868 (goto-char (region-beginning))
7869 (if (not (org-on-heading-p)) (outline-next-heading))
7870 (setq start (point)))
7871 ((or (org-on-heading-p)
7872 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7873 ;; we will sort the children of the current headline
7874 (org-back-to-heading)
7875 (setq start (point)
7876 end (progn (org-end-of-subtree t t)
7878 (org-back-over-empty-lines)
7879 (point))
7880 what "children")
7881 (goto-char start)
7882 (show-subtree)
7883 (outline-next-heading))
7884 (t
7885 ;; we will sort the top-level entries in this file
7886 (goto-char (point-min))
7887 (or (org-on-heading-p) (outline-next-heading))
7888 (setq start (point))
7889 (goto-char (point-max))
7890 (beginning-of-line 1)
7892 ;; File ends in a non-white line
7893 (end-of-line 1)
7895 (setq end (point-max))
7896 (setq what "top-level")
7897 (goto-char start)
7898 (show-all)))
7900 (setq beg (point))
7901 (if (>= beg end) (error "Nothing to sort"))
7904 (setq stars (match-string 1)
7905 re (concat "^" (regexp-quote stars) " +")
7907 txt (buffer-substring beg end))
7909 (if (and (not (equal stars "*")) (string-match re2 txt))
7910 (error "Region to sort contains a level above the first entry"))
7912 (unless sorting-type
7913 (message
7914 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7916 A/N/T/S/D/C/P/O/F means reversed:"
7917 what)
7918 (setq sorting-type (read-char-exclusive))
7920 (and (= (downcase sorting-type) ?f)
7921 (setq getkey-func
7922 (org-icompleting-read "Sort using function: "
7923 obarray 'fboundp t nil nil))
7924 (setq getkey-func (intern getkey-func)))
7926 (and (= (downcase sorting-type) ?r)
7927 (setq property
7928 (org-icompleting-read "Property: "
7929 (mapcar 'list (org-buffer-property-keys t))
7930 nil t))))
7932 (message "Sorting entries...")
7934 (save-restriction
7935 (narrow-to-region start end)
7936 (let ((dcst (downcase sorting-type))
7937 (case-fold-search nil)
7938 (now (current-time)))
7939 (sort-subr
7940 (/= dcst sorting-type)
7941 ;; This function moves to the beginning character of the "record" to
7942 ;; be sorted.
7943 (lambda nil
7944 (if (re-search-forward re nil t)
7945 (goto-char (match-beginning 0))
7946 (goto-char (point-max))))
7947 ;; This function moves to the last character of the "record" being
7948 ;; sorted.
7949 (lambda nil
7950 (save-match-data
7951 (condition-case nil
7952 (outline-forward-same-level 1)
7953 (error
7954 (goto-char (point-max))))))
7955 ;; This function returns the value that gets sorted against.
7956 (lambda nil
7957 (cond
7958 ((= dcst ?n)
7959 (if (looking-at org-complex-heading-regexp)
7960 (string-to-number (match-string 4))
7961 nil))
7962 ((= dcst ?a)
7963 (if (looking-at org-complex-heading-regexp)
7964 (funcall case-func (match-string 4))
7965 nil))
7966 ((= dcst ?t)
7967 (let ((end (save-excursion (outline-next-heading) (point))))
7968 (if (or (re-search-forward org-ts-regexp end t)
7969 (re-search-forward org-ts-regexp-both end t))
7970 (org-time-string-to-seconds (match-string 0))
7971 (org-float-time now))))
7972 ((= dcst ?c)
7973 (let ((end (save-excursion (outline-next-heading) (point))))
7974 (if (re-search-forward
7976 end t)
7977 (org-time-string-to-seconds (match-string 0))
7978 (org-float-time now))))
7979 ((= dcst ?s)
7980 (let ((end (save-excursion (outline-next-heading) (point))))
7981 (if (re-search-forward org-scheduled-time-regexp end t)
7982 (org-time-string-to-seconds (match-string 1))
7983 (org-float-time now))))
7984 ((= dcst ?d)
7985 (let ((end (save-excursion (outline-next-heading) (point))))
7986 (if (re-search-forward org-deadline-time-regexp end t)
7987 (org-time-string-to-seconds (match-string 1))
7988 (org-float-time now))))
7989 ((= dcst ?p)
7990 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7991 (string-to-char (match-string 2))
7992 org-default-priority))
7993 ((= dcst ?r)
7994 (or (org-entry-get nil property) ""))
7995 ((= dcst ?o)
7996 (if (looking-at org-complex-heading-regexp)
7997 (- 9999 (length (member (match-string 2)
7998 org-todo-keywords-1)))))
7999 ((= dcst ?f)
8000 (if getkey-func
8001 (progn
8002 (setq tmp (funcall getkey-func))
8003 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8004 tmp)
8005 (error "Invalid key function `%s'" getkey-func)))
8006 (t (error "Invalid sorting type `%c'" sorting-type))))
8007 nil
8008 (cond
8009 ((= dcst ?a) 'string<)
8010 ((= dcst ?f) compare-func)
8011 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8012 (t nil)))))
8013 (run-hooks 'org-after-sorting-entries-or-items-hook)
8014 (message "Sorting entries...done")))
8016 (defun org-do-sort (table what &optional with-case sorting-type)
8017 "Sort TABLE of WHAT according to SORTING-TYPE.
8018 The user will be prompted for the SORTING-TYPE if the call to this
8019 function does not specify it. WHAT is only for the prompt, to indicate
8020 what is being sorted. The sorting key will be extracted from
8021 the car of the elements of the table.
8022 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8023 (unless sorting-type
8024 (message
8025 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8026 what)
8027 (setq sorting-type (read-char-exclusive)))
8028 (let ((dcst (downcase sorting-type))
8029 extractfun comparefun)
8030 ;; Define the appropriate functions
8031 (cond
8032 ((= dcst ?n)
8033 (setq extractfun 'string-to-number
8034 comparefun (if (= dcst sorting-type) '< '>)))
8035 ((= dcst ?a)
8036 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8037 (lambda(x) (downcase (org-sort-remove-invisible x))))
8038 comparefun (if (= dcst sorting-type)
8039 'string<
8040 (lambda (a b) (and (not (string< a b))
8041 (not (string= a b)))))))
8042 ((= dcst ?t)
8043 (setq extractfun
8044 (lambda (x)
8045 (if (or (string-match org-ts-regexp x)
8046 (string-match org-ts-regexp-both x))
8047 (org-float-time
8048 (org-time-string-to-time (match-string 0 x)))
8049 0))
8050 comparefun (if (= dcst sorting-type) '< '>)))
8051 (t (error "Invalid sorting type `%c'" sorting-type)))
8053 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8054 table)
8055 (lambda (a b) (funcall comparefun (car a) (car b))))))
8058 ;;; The orgstruct minor mode
8060 ;; Define a minor mode which can be used in other modes in order to
8061 ;; integrate the org-mode structure editing commands.
8063 ;; This is really a hack, because the org-mode structure commands use
8064 ;; keys which normally belong to the major mode. Here is how it
8065 ;; works: The minor mode defines all the keys necessary to operate the
8066 ;; structure commands, but wraps the commands into a function which
8067 ;; tests if the cursor is currently at a headline or a plain list
8068 ;; item. If that is the case, the structure command is used,
8069 ;; temporarily setting many Org-mode variables like regular
8070 ;; expressions for filling etc. However, when any of those keys is
8071 ;; used at a different location, function uses `key-binding' to look
8072 ;; up if the key has an associated command in another currently active
8073 ;; keymap (minor modes, major mode, global), and executes that
8074 ;; command. There might be problems if any of the keys is otherwise
8075 ;; used as a prefix key.
8077 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8078 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8079 ;; addresses this by checking explicitly for both bindings.
8081 (defvar orgstruct-mode-map (make-sparse-keymap)
8082 "Keymap for the minor `orgstruct-mode'.")
8084 (defvar org-local-vars nil
8085 "List of local variables, for use by `orgstruct-mode'.")
8087 ;;;###autoload
8088 (define-minor-mode orgstruct-mode
8089 "Toggle the minor mode `orgstruct-mode'.
8090 This mode is for using Org-mode structure commands in other
8091 modes. The following keys behave as if Org-mode were active, if
8092 the cursor is on a headline, or on a plain list item (both as
8093 defined by Org-mode).
8095 M-up Move entry/item up
8096 M-down Move entry/item down
8097 M-left Promote
8098 M-right Demote
8099 M-S-up Move entry/item up
8100 M-S-down Move entry/item down
8101 M-S-left Promote subtree
8102 M-S-right Demote subtree
8103 M-q Fill paragraph and items like in Org-mode
8104 C-c ^ Sort entries
8105 C-c - Cycle list bullet
8106 TAB Cycle item visibility
8107 M-RET Insert new heading/item
8108 S-M-RET Insert new TODO heading / Checkbox item
8109 C-c C-c Set tags / toggle checkbox"
8110 nil " OrgStruct" nil
8111 (org-load-modules-maybe)
8112 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8114 ;;;###autoload
8115 (defun turn-on-orgstruct ()
8116 "Unconditionally turn on `orgstruct-mode'."
8117 (orgstruct-mode 1))
8119 (defun orgstruct++-mode (&optional arg)
8120 "Toggle `orgstruct-mode', the enhanced version of it.
8121 In addition to setting orgstruct-mode, this also exports all indentation
8122 and autofilling variables from org-mode into the buffer. It will also
8123 recognize item context in multiline items.
8124 Note that turning off orgstruct-mode will *not* remove the
8125 indentation/paragraph settings. This can only be done by refreshing the
8127 (interactive "P")
8128 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8129 (if (< arg 1)
8130 (orgstruct-mode -1)
8131 (orgstruct-mode 1)
8132 (let (var val)
8133 (mapc
8134 (lambda (x)
8135 (when (string-match
8137 (symbol-name (car x)))
8138 (setq var (car x) val (nth 1 x))
8139 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8140 org-local-vars)
8141 (org-set-local 'orgstruct-is-++ t))))
8143 (defvar orgstruct-is-++ nil
8144 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8145 (make-variable-buffer-local 'orgstruct-is-++)
8147 ;;;###autoload
8148 (defun turn-on-orgstruct++ ()
8149 "Unconditionally turn on `orgstruct++-mode'."
8150 (orgstruct++-mode 1))
8152 (defun orgstruct-error ()
8153 "Error when there is no default binding for a structure key."
8154 (interactive)
8155 (error "This key has no function outside structure elements"))
8157 (defun orgstruct-setup ()
8158 "Setup orgstruct keymaps."
8159 (let ((nfunc 0)
8160 (bindings
8161 (list
8162 '([(meta up)] org-metaup)
8163 '([(meta down)] org-metadown)
8164 '([(meta left)] org-metaleft)
8165 '([(meta right)] org-metaright)
8166 '([(meta shift up)] org-shiftmetaup)
8167 '([(meta shift down)] org-shiftmetadown)
8168 '([(meta shift left)] org-shiftmetaleft)
8169 '([(meta shift right)] org-shiftmetaright)
8170 '([?\e (up)] org-metaup)
8171 '([?\e (down)] org-metadown)
8172 '([?\e (left)] org-metaleft)
8173 '([?\e (right)] org-metaright)
8174 '([?\e (shift up)] org-shiftmetaup)
8175 '([?\e (shift down)] org-shiftmetadown)
8176 '([?\e (shift left)] org-shiftmetaleft)
8177 '([?\e (shift right)] org-shiftmetaright)
8178 '([(shift up)] org-shiftup)
8179 '([(shift down)] org-shiftdown)
8180 '([(shift left)] org-shiftleft)
8181 '([(shift right)] org-shiftright)
8182 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8183 '("\M-q" fill-paragraph)
8184 '("\C-c^" org-sort)
8185 '("\C-c-" org-cycle-list-bullet)))
8186 elt key fun cmd)
8187 (while (setq elt (pop bindings))
8188 (setq nfunc (1+ nfunc))
8189 (setq key (org-key (car elt))
8190 fun (nth 1 elt)
8191 cmd (orgstruct-make-binding fun nfunc key))
8192 (org-defkey orgstruct-mode-map key cmd))
8194 ;; Special treatment needed for TAB and RET
8195 (org-defkey orgstruct-mode-map [(tab)]
8196 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8197 (org-defkey orgstruct-mode-map "\C-i"
8198 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8200 (org-defkey orgstruct-mode-map "\M-\C-m"
8201 (orgstruct-make-binding 'org-insert-heading 105
8202 "\M-\C-m" [(meta return)]))
8203 (org-defkey orgstruct-mode-map [(meta return)]
8204 (orgstruct-make-binding 'org-insert-heading 106
8205 [(meta return)] "\M-\C-m"))
8207 (org-defkey orgstruct-mode-map [(shift meta return)]
8208 (orgstruct-make-binding 'org-insert-todo-heading 107
8209 [(meta return)] "\M-\C-m"))
8211 (org-defkey orgstruct-mode-map "\e\C-m"
8212 (orgstruct-make-binding 'org-insert-heading 108
8213 "\e\C-m" [?\e (return)]))
8214 (org-defkey orgstruct-mode-map [?\e (return)]
8215 (orgstruct-make-binding 'org-insert-heading 109
8216 [?\e (return)] "\e\C-m"))
8217 (org-defkey orgstruct-mode-map [?\e (shift return)]
8218 (orgstruct-make-binding 'org-insert-todo-heading 110
8219 [?\e (return)] "\e\C-m"))
8221 (unless org-local-vars
8222 (setq org-local-vars (org-get-local-variables)))
8224 t))
8226 (defun orgstruct-make-binding (fun n &rest keys)
8227 "Create a function for binding in the structure minor mode.
8228 FUN is the command to call inside a table. N is used to create a unique
8229 command name. KEYS are keys that should be checked in for a command
8230 to execute outside of tables."
8231 (eval
8232 (list 'defun
8233 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8234 '(arg)
8236 "Outside of structure, run the binding of `"
8237 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8238 "'.")
8239 '(interactive "p")
8240 (list 'if
8241 `(org-context-p 'headline 'item
8242 (and orgstruct-is-++
8243 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8244 'item-body))
8245 (list 'org-run-like-in-org-mode (list 'quote fun))
8246 (list 'let '(orgstruct-mode)
8247 (list 'call-interactively
8248 (append '(or)
8249 (mapcar (lambda (k)
8250 (list 'key-binding k))
8251 keys)
8252 '('orgstruct-error))))))))
8254 (defun org-context-p (&rest contexts)
8255 "Check if local context is any of CONTEXTS.
8256 Possible values in the list of contexts are `table', `headline', and `item'."
8257 (let ((pos (point)))
8258 (goto-char (point-at-bol))
8259 (prog1 (or (and (memq 'table contexts)
8261 (and (memq 'headline contexts)
8262 (looking-at org-outline-regexp))
8263 (and (memq 'item contexts)
8265 (and (memq 'item-body contexts)
8266 (org-in-item-p)))
8267 (goto-char pos))))
8269 (defun org-get-local-variables ()
8270 "Return a list of all local variables in an org-mode buffer."
8271 (let (varlist)
8272 (with-current-buffer (get-buffer-create "*Org tmp*")
8273 (erase-buffer)
8274 (org-mode)
8275 (setq varlist (buffer-local-variables)))
8276 (kill-buffer "*Org tmp*")
8277 (delq nil
8278 (mapcar
8279 (lambda (x)
8280 (setq x
8281 (if (symbolp x)
8282 (list x)
8283 (list (car x) (list 'quote (cdr x)))))
8284 (if (string-match
8285 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8286 (symbol-name (car x)))
8287 x nil))
8288 varlist))))
8290 (defun org-clone-local-variables (from-buffer &optional regexp)
8291 "Clone local variables from FROM-BUFFER.
8292 Optional argument REGEXP selects variables to clone."
8293 (mapc
8294 (lambda (pair)
8295 (and (symbolp (car pair))
8296 (or (null regexp)
8297 (string-match regexp (symbol-name (car pair))))
8298 (set (make-local-variable (car pair))
8299 (cdr pair))))
8300 (buffer-local-variables from-buffer)))
8302 ;;;###autoload
8303 (defun org-run-like-in-org-mode (cmd)
8304 "Run a command, pretending that the current buffer is in Org-mode.
8305 This will temporarily bind local variables that are typically bound in
8306 Org-mode to the values they have in Org-mode, and then interactively
8307 call CMD."
8308 (org-load-modules-maybe)
8309 (unless org-local-vars
8310 (setq org-local-vars (org-get-local-variables)))
8311 (eval (list 'let org-local-vars
8312 (list 'call-interactively (list 'quote cmd)))))
8314 ;;;; Archiving
8316 (defun org-get-category (&optional pos force-refresh)
8317 "Get the category applying to position POS."
8318 (if force-refresh (org-refresh-category-properties))
8319 (let ((pos (or pos (point))))
8320 (or (get-text-property pos 'org-category)
8321 (progn (org-refresh-category-properties)
8322 (get-text-property pos 'org-category)))))
8324 (defun org-refresh-category-properties ()
8325 "Refresh category text properties in the buffer."
8326 (let ((def-cat (cond
8327 ((null org-category)
8328 (if buffer-file-name
8329 (file-name-sans-extension
8330 (file-name-nondirectory buffer-file-name))
8331 "???"))
8332 ((symbolp org-category) (symbol-name org-category))
8333 (t org-category)))
8334 beg end cat pos optionp)
8335 (org-unmodified
8336 (save-excursion
8337 (save-restriction
8338 (widen)
8339 (goto-char (point-min))
8340 (put-text-property (point) (point-max) 'org-category def-cat)
8341 (while (re-search-forward
8343 (setq pos (match-end 0)
8344 optionp (equal (char-after (match-beginning 0)) ?#)
8345 cat (org-trim (match-string 2)))
8346 (if optionp
8347 (setq beg (point-at-bol) end (point-max))
8348 (org-back-to-heading t)
8349 (setq beg (point) end (org-end-of-subtree t t)))
8350 (put-text-property beg end 'org-category cat)
8351 (goto-char pos)))))))
8354 ;;;; Link Stuff
8356 ;;; Link abbreviations
8358 (defun org-link-expand-abbrev (link)
8359 "Apply replacements as defined in `org-link-abbrev-alist."
8361 (let* ((key (match-string 1 link))
8362 (as (or (assoc key org-link-abbrev-alist-local)
8363 (assoc key org-link-abbrev-alist)))
8364 (tag (and (match-end 2) (match-string 3 link)))
8365 rpl)
8366 (if (not as)
8367 link
8368 (setq rpl (cdr as))
8369 (cond
8370 ((symbolp rpl) (funcall rpl tag))
8371 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8372 ((string-match "%h" rpl)
8373 (replace-match (url-hexify-string (or tag "")) t t rpl))
8374 (t (concat rpl tag)))))
8375 link))
8377 ;;; Storing and inserting links
8379 (defvar org-insert-link-history nil
8380 "Minibuffer history for links inserted with `org-insert-link'.")
8382 (defvar org-stored-links nil
8383 "Contains the links stored with `org-store-link'.")
8385 (defvar org-store-link-plist nil
8386 "Plist with info about the most recently link created with `org-store-link'.")
8388 (defvar org-link-protocols nil
8389 "Link protocols added to Org-mode using `org-add-link-type'.")
8391 (defvar org-store-link-functions nil
8392 "List of functions that are called to create and store a link.
8393 Each function will be called in turn until one returns a non-nil
8394 value. Each function should check if it is responsible for creating
8395 this link (for example by looking at the major mode).
8396 If not, it must exit and return nil.
8397 If yes, it should return a non-nil value after a calling
8398 `org-store-link-props' with a list of properties and values.
8399 Special properties are:
8403 This is obligatory as well.
8404 :description Optional default description for the second pair
8405 of brackets in an Org-mode link. The user can still change
8406 this when inserting this link into an Org-mode buffer.
8408 In addition to these, any additional properties can be specified
8409 and then used in remember templates.")
8411 (defun org-add-link-type (type &optional follow export)
8412 "Add TYPE to the list of `org-link-types'.
8413 Re-compute all regular expressions depending on `org-link-types'
8415 FOLLOW and EXPORT are two functions.
8417 FOLLOW should take the link path as the single argument and do whatever
8418 is necessary to follow the link, for example find a file or display
8419 a mail message.
8421 EXPORT should format the link path for export to one of the export formats.
8422 It should be a function accepting three arguments:
8425 desc the description of the link, if any, or a description added by
8426 org-export-normalize-links if there is none
8427 format the export format, a symbol like `html' or `latex' or `ascii'..
8429 The function may use the FORMAT information to return different values
8430 depending on the format. The return value will be put literally into
8431 the exported file. If the return value is nil, this means Org should
8432 do what it normally does with links which do not have EXPORT defined.
8434 Org-mode has a built-in default for exporting links. If you are happy with
8435 this default, there is no need to define an export function for the link
8436 type. For a simple example of an export function, see `org-bbdb.el'."
8437 (add-to-list 'org-link-types type t)
8438 (org-make-link-regexps)
8439 (if (assoc type org-link-protocols)
8440 (setcdr (assoc type org-link-protocols) (list follow export))
8441 (push (list type follow export) org-link-protocols)))
8443 (defvar org-agenda-buffer-name)
8445 ;;;###autoload
8446 (defun org-store-link (arg)
8448 This link is added to `org-stored-links' and can later be inserted
8451 For some link types, a prefix arg is interpreted:
8452 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8453 For file links, arg negates `org-context-in-file-links'."
8454 (interactive "P")
8455 (org-load-modules-maybe)
8456 (setq org-store-link-plist nil) ; reset
8457 (org-with-limited-levels
8458 (let (link cpltxt desc description search txt custom-id agenda-link)
8459 (cond
8461 ((run-hook-with-args-until-success 'org-store-link-functions)
8462 (setq link (plist-get org-store-link-plist :link)
8463 desc (or (plist-get org-store-link-plist :description) link)))
8465 ((equal (buffer-name) "*Org Edit Src Example*")
8466 (let (label gc)
8467 (while (or (not label)
8468 (save-excursion
8469 (save-restriction
8470 (widen)
8471 (goto-char (point-min))
8472 (re-search-forward
8473 (regexp-quote (format org-coderef-label-format label))
8474 nil t))))
8475 (when label (message "Label exists already") (sit-for 2))
8476 (setq label (read-string "Code line label: " label)))
8477 (end-of-line 1)
8478 (setq link (format org-coderef-label-format label))
8479 (setq gc (- 79 (length link)))
8480 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8481 (insert link)
8482 (setq link (concat "(" label ")") desc nil)))
8484 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8485 ;; We are in the agenda, link to referenced location
8486 (let ((m (or (get-text-property (point) 'org-hd-marker)
8487 (get-text-property (point) 'org-marker))))
8488 (when m
8489 (org-with-point-at m
8490 (setq agenda-link
8491 (if (org-called-interactively-p 'any)
8492 (call-interactively 'org-store-link)
8493 (org-store-link nil)))))))
8495 ((eq major-mode 'calendar-mode)
8496 (let ((cd (calendar-cursor-to-date)))
8497 (setq link
8498 (format-time-string
8499 (car org-time-stamp-formats)
8500 (apply 'encode-time
8501 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8502 nil nil nil))))
8503 (org-store-link-props :type "calendar" :date cd)))
8505 ((eq major-mode 'w3-mode)
8506 (setq cpltxt (if (and (buffer-name)
8507 (not (string-match "Untitled" (buffer-name))))
8508 (buffer-name)
8509 (url-view-url t))
8510 link (org-make-link (url-view-url t)))
8511 (org-store-link-props :type "w3" :url (url-view-url t)))
8513 ((eq major-mode 'w3m-mode)
8514 (setq cpltxt (or w3m-current-title w3m-current-url)
8515 link (org-make-link w3m-current-url))
8516 (org-store-link-props :type "w3m" :url (url-view-url t)))
8518 ((setq search (run-hook-with-args-until-success
8519 'org-create-file-search-functions))
8520 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8521 "::" search))
8522 (setq cpltxt (or description link)))
8524 ((eq major-mode 'image-mode)
8525 (setq cpltxt (concat "file:"
8526 (abbreviate-file-name buffer-file-name))
8527 link (org-make-link cpltxt))
8528 (org-store-link-props :type "image" :file buffer-file-name))
8530 ((eq major-mode 'dired-mode)
8531 ;; link to the file in the current line
8532 (let ((file (dired-get-filename nil t)))
8533 (setq file (if file
8534 (abbreviate-file-name
8535 (expand-file-name (dired-get-filename nil t)))
8536 ;; otherwise, no file so use current directory.
8537 default-directory))
8538 (setq cpltxt (concat "file:" file)
8539 link (org-make-link cpltxt))))
8541 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8542 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8543 (cond
8545 (setq cpltxt
8546 (concat "file:"
8547 (abbreviate-file-name
8548 (buffer-file-name (buffer-base-buffer)))
8549 "::" (match-string 1))
8550 link (org-make-link cpltxt)))
8551 ((and (featurep 'org-id)
8552 (or (eq org-link-to-org-use-id t)
8553 (and (eq org-link-to-org-use-id 'create-if-interactive)
8554 (org-called-interactively-p 'any))
8555 (and (eq org-link-to-org-use-id
8556 'create-if-interactive-and-no-custom-id)
8557 (org-called-interactively-p 'any)
8558 (not custom-id))
8559 (and org-link-to-org-use-id
8560 (org-entry-get nil "ID"))))
8561 ;; We can make a link using the ID.
8562 (setq link (condition-case nil
8563 (prog1 (org-id-store-link)
8564 (setq desc (plist-get org-store-link-plist
8565 :description)))
8566 (error
8567 ;; probably before first headline, link to file only
8568 (concat "file:"
8569 (abbreviate-file-name
8570 (buffer-file-name (buffer-base-buffer))))))))
8571 (t
8572 ;; Just link to current headline
8573 (setq cpltxt (concat "file:"
8574 (abbreviate-file-name
8575 (buffer-file-name (buffer-base-buffer)))))
8576 ;; Add a context search string
8577 (when (org-xor org-context-in-file-links arg)
8578 (setq txt (cond
8579 ((org-on-heading-p) nil)
8580 ((org-region-active-p)
8581 (buffer-substring (region-beginning) (region-end)))
8582 (t nil)))
8584 (setq cpltxt
8585 (concat cpltxt "::"
8586 (condition-case nil
8587 (org-make-org-heading-search-string txt)
8588 (error "")))
8589 desc (or (nth 4 (ignore-errors
8590 (org-heading-components))) "NONE"))))
8592 (setq cpltxt (substring cpltxt 0 -2)))
8593 (setq link (org-make-link cpltxt)))))
8595 ((buffer-file-name (buffer-base-buffer))
8596 ;; Just link to this file here.
8597 (setq cpltxt (concat "file:"
8598 (abbreviate-file-name
8599 (buffer-file-name (buffer-base-buffer)))))
8600 ;; Add a context string
8601 (when (org-xor org-context-in-file-links arg)
8602 (setq txt (if (org-region-active-p)
8603 (buffer-substring (region-beginning) (region-end))
8604 (buffer-substring (point-at-bol) (point-at-eol))))
8605 ;; Only use search option if there is some text.
8607 (setq cpltxt
8608 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8609 desc "NONE")))
8610 (setq link (org-make-link cpltxt)))
8612 ((org-called-interactively-p 'interactive)
8613 (error "Cannot link to a buffer which is not visiting a file"))
8615 (t (setq link nil)))
8617 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8618 (setq link (or link cpltxt)
8619 desc (or desc cpltxt))
8620 (if (equal desc "NONE") (setq desc nil))
8622 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8623 (progn
8624 (setq org-stored-links
8625 (cons (list link desc) org-stored-links))
8626 (message "Stored: %s" (or desc link))
8627 (when custom-id
8628 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8629 "::#" custom-id))
8630 (setq org-stored-links
8631 (cons (list link desc) org-stored-links))))
8632 (or agenda-link (and link (org-make-link-string link desc)))))))
8634 (defun org-store-link-props (&rest plist)
8635 "Store link properties, extract names and addresses."
8636 (let (x adr)
8637 (when (setq x (plist-get plist :from))
8638 (setq adr (mail-extract-address-components x))
8639 (setq plist (plist-put plist :fromname (car adr)))
8640 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8641 (when (setq x (plist-get plist :to))
8642 (setq adr (mail-extract-address-components x))
8643 (setq plist (plist-put plist :toname (car adr)))
8644 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8645 (let ((from (plist-get plist :from))
8646 (to (plist-get plist :to)))
8647 (when (and from to org-from-is-user-regexp)
8648 (setq plist
8649 (plist-put plist :fromto
8650 (if (string-match org-from-is-user-regexp from)
8651 (concat "to %t")
8652 (concat "from %f"))))))
8653 (setq org-store-link-plist plist))
8655 (defun org-add-link-props (&rest plist)
8656 "Add these properties to the link property list."
8657 (let (key value)
8658 (while plist
8659 (setq key (pop plist) value (pop plist))
8660 (setq org-store-link-plist
8661 (plist-put org-store-link-plist key value)))))
8663 (defun org-email-link-description (&optional fmt)
8664 "Return the description part of an email link.
8665 This takes information from `org-store-link-plist' and formats it
8666 according to FMT (default from `org-email-link-description-format')."
8667 (setq fmt (or fmt org-email-link-description-format))
8668 (let* ((p org-store-link-plist)
8669 (to (plist-get p :toaddress))
8670 (from (plist-get p :fromaddress))
8671 (table
8672 (list
8673 (cons "%c" (plist-get p :fromto))
8674 (cons "%F" (plist-get p :from))
8675 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8676 (cons "%T" (plist-get p :to))
8677 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8678 (cons "%s" (plist-get p :subject))
8679 (cons "%d" (plist-get p :date))
8680 (cons "%m" (plist-get p :message-id)))))
8681 (when (string-match "%c" fmt)
8682 ;; Check if the user wrote this message
8683 (if (and org-from-is-user-regexp from to
8684 (save-match-data (string-match org-from-is-user-regexp from)))
8685 (setq fmt (replace-match "to %t" t t fmt))
8686 (setq fmt (replace-match "from %f" t t fmt))))
8687 (org-replace-escapes fmt table)))
8689 (defun org-make-org-heading-search-string (&optional string heading)
8690 "Make search string for STRING or current headline."
8691 (interactive)
8692 (let ((s (or string (org-get-heading)))
8693 (lines org-context-in-file-links))
8694 (unless (and string (not heading))
8695 ;; We are using a headline, clean up garbage in there.
8696 (if (string-match org-todo-regexp s)
8697 (setq s (replace-match "" t t s)))
8699 (setq s (replace-match "" t t s)))
8700 (setq s (org-trim s))
8703 (setq s (replace-match "" t t s)))
8704 (while (string-match org-ts-regexp s)
8705 (setq s (replace-match "" t t s))))
8706 (or string (setq s (concat "*" s))) ; Add * for headlines
8707 (when (and string (integerp lines) (> lines 0))
8709 (when (< lines (length slines))
8710 (setq s (mapconcat
8711 'identity
8712 (reverse (nthcdr (- (length slines) lines)
8716 (defun org-make-link (&rest strings)
8717 "Concatenate STRINGS."
8718 (apply 'concat strings))
8720 (defun org-make-link-string (link &optional description)
8721 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8723 (error "Empty link"))
8724 (when (and description
8725 (stringp description)
8727 (setq description nil))
8728 (when (stringp description)
8729 ;; Remove brackets from the description, they are fatal.
8731 (setq description (replace-match "{" t t description)))
8733 (setq description (replace-match "}" t t description))))
8734 (when (equal link description)
8735 ;; No description needed, it is identical
8736 (setq description nil))
8737 (when (and (not description)
8738 (not (string-match (org-image-file-name-regexp) link))
8739 (not (equal link (org-link-escape link))))
8740 (setq description (org-extract-attributes link)))
8741 (setq link
8742 (cond ((string-match (org-image-file-name-regexp) link) link)
8743 ((string-match org-link-types-re link)
8744 (concat (match-string 1 link)
8745 (org-link-escape (substring link (match-end 1)))))
8746 (t (org-link-escape link))))
8747 (concat "[[" link "]"
8748 (if description (concat "[" description "]") "")
8749 "]"))
8751 (defconst org-link-escape-chars
8752 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8753 "List of characters that should be escaped in link.
8754 This is the list that is used for internal purposes.")
8756 (defvar org-url-encoding-use-url-hexify nil)
8758 (defconst org-link-escape-chars-browser
8759 '(?\ )
8760 "List of escapes for characters that are problematic in links.
8761 This is the list that is used before handing over to the browser.")
8763 (defun org-link-escape (text &optional table merge)
8764 "Return percent escaped representation of TEXT.
8765 TEXT is a string with the text to escape.
8766 Optional argument TABLE is a list with characters that should be
8767 escaped. When nil, `org-link-escape-chars' is used.
8768 If optional argument MERGE is set, merge TABLE into
8769 `org-link-escape-chars'."
8770 (if (and org-url-encoding-use-url-hexify (not table))
8771 (url-hexify-string text)
8772 (cond
8773 ((and table merge)
8774 (mapc (lambda (defchr)
8775 (unless (member defchr table)
8776 (setq table (cons defchr table)))) org-link-escape-chars))
8777 ((null table)
8778 (setq table org-link-escape-chars)))
8779 (mapconcat
8780 (lambda (char)
8781 (if (or (member char table)
8782 (< char 32) (= char 37) (> char 126))
8783 (mapconcat (lambda (sequence-element)
8784 (format "%%%.2X" sequence-element))
8785 (or (encode-coding-char char 'utf-8)
8786 (error "Unable to percent escape character: %s"
8787 (char-to-string char))) "")
8788 (char-to-string char))) text "")))
8790 (defun org-link-unescape (str)
8791 "Unhex hexified unicode strings as returned from the JavaScript function
8792 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8793 (unless (and (null str) (string= "" str))
8794 (let ((pos 0) (case-fold-search t) unhexed)
8796 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8797 (setq str (replace-match unhexed t t str))
8798 (setq pos (+ pos (length unhexed))))))
8799 str)
8801 (defun org-link-unescape-compound (hex)
8802 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8803 Note: this function also decodes single byte encodings like
8805 (save-match-data
8806 (let* ((bytes (cdr (split-string hex "%")))
8807 (ret "")
8808 (eat 0)
8809 (sum 0))
8810 (while bytes
8811 (let* ((val (string-to-number (pop bytes) 16))
8812 (shift-xor
8813 (if (= 0 eat)
8814 (cond
8815 ((>= val 252) (cons 6 252))
8816 ((>= val 248) (cons 5 248))
8817 ((>= val 240) (cons 4 240))
8818 ((>= val 224) (cons 3 224))
8819 ((>= val 192) (cons 2 192))
8820 (t (cons 0 0)))
8821 (cons 6 128))))
8822 (if (>= val 192) (setq eat (car shift-xor)))
8823 (setq val (logxor val (cdr shift-xor)))
8824 (setq sum (+ (lsh sum (car shift-xor)) val))
8825 (if (> eat 0) (setq eat (- eat 1)))
8826 (cond
8827 ((= 0 eat) ;multi byte
8828 (setq ret (concat ret (org-char-to-string sum)))
8829 (setq sum 0))
8830 ((not bytes) ; single byte(s)
8831 (setq ret (org-link-unescape-single-byte-sequence hex))))
8832 )) ;; end (while bytes
8833 ret )))
8835 (defun org-link-unescape-single-byte-sequence (hex)
8836 "Unhexify hex-encoded single byte character sequences."
8837 (mapconcat (lambda (byte)
8838 (char-to-string (string-to-number byte 16)))
8839 (cdr (split-string hex "%")) ""))
8841 (defun org-xor (a b)
8842 "Exclusive or."
8843 (if a (not b) b))
8845 (defun org-fixup-message-id-for-http (s)
8846 "Replace special characters in a message id, so it can be used in an http query."
8847 (when (string-match "%" s)
8848 (setq s (mapconcat (lambda (c)
8849 (if (eq c ?%)
8850 "%25"
8851 (char-to-string c)))
8852 s "")))
8853 (while (string-match "<" s)
8854 (setq s (replace-match "%3C" t t s)))
8855 (while (string-match ">" s)
8856 (setq s (replace-match "%3E" t t s)))
8857 (while (string-match "@" s)
8858 (setq s (replace-match "%40" t t s)))
8859 s)
8861 ;;;###autoload
8862 (defun org-insert-link-global ()
8863 "Insert a link like Org-mode does.
8864 This command can be called in any mode to insert a link in Org-mode syntax."
8865 (interactive)
8866 (org-load-modules-maybe)
8867 (org-run-like-in-org-mode 'org-insert-link))
8869 (defun org-insert-link (&optional complete-file link-location)
8870 "Insert a link. At the prompt, enter the link.
8872 Completion can be used to insert any of the link protocol prefixes like
8873 http or ftp in use.
8875 The history can be used to select a link previously stored with
8876 `org-store-link'. When the empty string is entered (i.e. if you just
8877 press RET at the prompt), the link defaults to the most recently
8878 stored link. As SPC triggers completion in the minibuffer, you need to
8879 use M-SPC or C-q SPC to force the insertion of a space character.
8881 You will also be prompted for a description, and if one is given, it will
8882 be displayed in the buffer instead of the link.
8884 If there is already a link at point, this command will allow you to edit link
8885 and description parts.
8888 be selected using completion. The path to the file will be relative to the
8889 current directory if the file is in the current directory or a subdirectory.
8890 Otherwise, the link will be the absolute path as completed in the minibuffer
8891 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8892 option `org-link-file-path-type'.
8895 the current directory or below.
8898 `org-keep-stored-link-after-insertion'.
8900 If `org-make-link-description-function' is non-nil, this function will be
8901 called with the link target, and the result will be the default
8902 link description.
8904 If the LINK-LOCATION parameter is non-nil, this value will be
8905 used as the link location instead of reading one interactively."
8906 (interactive "P")
8907 (let* ((wcf (current-window-configuration))
8908 (region (if (org-region-active-p)
8909 (buffer-substring (region-beginning) (region-end))))
8910 (remove (and region (list (region-beginning) (region-end))))
8911 (desc region)
8912 tmphist ; byte-compile incorrectly complains about this
8913 (link link-location)
8914 entry file all-prefixes)
8915 (cond
8916 (link-location) ; specified by arg, just use it.
8917 ((org-in-regexp org-bracket-link-regexp 1)
8918 ;; We do have a link at point, and we are going to edit it.
8919 (setq remove (list (match-beginning 0) (match-end 0)))
8920 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8921 (setq link (read-string "Link: "
8922 (org-link-unescape
8923 (org-match-string-no-properties 1)))))
8924 ((or (org-in-regexp org-angle-link-re)
8925 (org-in-regexp org-plain-link-re))
8926 ;; Convert to bracket link
8927 (setq remove (list (match-beginning 0) (match-end 0))
8928 link (read-string "Link: "
8929 (org-remove-angle-brackets (match-string 0)))))
8930 ((member complete-file '((4) (16)))
8931 ;; Completing read for file names.
8932 (setq link (org-file-complete-link complete-file)))
8933 (t
8934 ;; Read link, with completion for stored links.
8935 (with-output-to-temp-buffer "*Org Links*"
8936 (princ "Insert a link.
8938 (when org-stored-links
8940 (princ (mapconcat
8941 (lambda (x)
8942 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8944 (let ((cw (selected-window)))
8945 (select-window (get-buffer-window "*Org Links*" 'visible))
8946 (with-current-buffer "*Org Links*" (setq truncate-lines) t)
8947 (unless (pos-visible-in-window-p (point-max))
8948 (org-fit-window-to-buffer))
8949 (and (window-live-p cw) (select-window cw)))
8950 ;; Fake a link history, containing the stored links.
8951 (setq tmphist (append (mapcar 'car org-stored-links)
8952 org-insert-link-history))
8953 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8954 (mapcar 'car org-link-abbrev-alist)
8955 org-link-types))
8956 (unwind-protect
8957 (progn
8958 (setq link
8959 (let ((org-completion-use-ido nil)
8960 (org-completion-use-iswitchb nil))
8961 (org-completing-read
8962 "Link: "
8963 (append
8964 (mapcar (lambda (x) (list (concat x ":")))
8965 all-prefixes)
8966 (mapcar 'car org-stored-links))
8967 nil nil nil
8968 'tmphist
8969 (car (car org-stored-links)))))
8971 (error "No link selected"))
8972 (if (or (member link all-prefixes)
8973 (and (equal ":" (substring link -1))
8974 (member (substring link 0 -1) all-prefixes)
8975 (setq link (substring link 0 -1))))
8976 (setq link (org-link-try-special-completion link))))
8977 (set-window-configuration wcf)
8978 (kill-buffer "*Org Links*"))
8979 (setq entry (assoc link org-stored-links))
8980 (or entry (push link org-insert-link-history))
8981 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8982 (not org-keep-stored-link-after-insertion))
8983 (setq org-stored-links (delq (assoc link org-stored-links)
8984 org-stored-links)))
8985 (setq desc (or desc (nth 1 entry)))))
8987 (if (string-match org-plain-link-re link)
8988 ;; URL-like link, normalize the use of angular brackets.
8989 (setq link (org-make-link (org-remove-angle-brackets link))))
8991 ;; Check if we are linking to the current file with a search option
8992 ;; If yes, simplify the link by using only the search option.
8993 (when (and buffer-file-name
8995 (let* ((path (match-string 1 link))
8996 (case-fold-search nil)
8997 (search (match-string 2 link)))
8998 (save-match-data
8999 (if (equal (file-truename buffer-file-name) (file-truename path))
9000 ;; We are linking to this same file, with a search option
9001 (setq link search)))))
9003 ;; Check if we can/should use a relative path. If yes, simplify the link
9005 (let* ((type (match-string 1 link))
9006 (path (match-string 2 link))
9007 (origpath path)
9008 (case-fold-search nil))
9009 (cond
9010 ((or (eq org-link-file-path-type 'absolute)
9011 (equal complete-file '(16)))
9012 (setq path (abbreviate-file-name (expand-file-name path))))
9013 ((eq org-link-file-path-type 'noabbrev)
9014 (setq path (expand-file-name path)))
9015 ((eq org-link-file-path-type 'relative)
9016 (setq path (file-relative-name path)))
9017 (t
9018 (save-match-data
9019 (if (string-match (concat "^" (regexp-quote
9020 (expand-file-name
9021 (file-name-as-directory
9022 default-directory))))
9023 (expand-file-name path))
9024 ;; We are linking a file with relative path name.
9025 (setq path (substring (expand-file-name path)
9026 (match-end 0)))
9027 (setq path (abbreviate-file-name (expand-file-name path)))))))
9028 (setq link (concat type path))
9029 (if (equal desc origpath)
9030 (setq desc path))))
9032 (if org-make-link-description-function
9033 (setq desc (funcall org-make-link-description-function link desc)))
9035 (setq desc (read-string "Description: " desc))
9037 (if remove (apply 'delete-region remove))
9038 (insert (org-make-link-string link desc))))
9040 (defun org-link-try-special-completion (type)
9041 "If there is completion support for link type TYPE, offer it."
9042 (let ((fun (intern (concat "org-" type "-complete-link"))))
9043 (if (functionp fun)
9044 (funcall fun)
9045 (read-string "Link (no completion support): " (concat type ":")))))
9047 (defun org-file-complete-link (&optional arg)
9048 "Create a file link using completion."
9049 (let (file link)
9050 (setq file (read-file-name "File: "))
9051 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9052 (pwd1 (file-name-as-directory (abbreviate-file-name
9053 (expand-file-name ".")))))
9054 (cond
9055 ((equal arg '(16))
9056 (setq link (org-make-link
9057 "file:"
9058 (abbreviate-file-name (expand-file-name file)))))
9060 (setq link (org-make-link "file:" (match-string 1 file))))
9062 (expand-file-name file))
9063 (setq link (org-make-link
9064 "file:" (match-string 1 (expand-file-name file)))))
9065 (t (setq link (org-make-link "file:" file)))))
9066 link))
9068 (defun org-completing-read (&rest args)
9069 "Completing-read with SPACE being a normal character."
9070 (let ((minibuffer-local-completion-map
9071 (copy-keymap minibuffer-local-completion-map)))
9072 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9073 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9074 (apply 'org-icompleting-read args)))
9076 (defun org-completing-read-no-i (&rest args)
9077 (let (org-completion-use-ido org-completion-use-iswitchb)
9078 (apply 'org-completing-read args)))
9080 (defun org-iswitchb-completing-read (prompt choices &rest args)
9081 "Use iswitch as a completing-read replacement to choose from choices.
9082 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9083 from."
9084 (let* ((iswitchb-use-virtual-buffers nil)
9085 (iswitchb-make-buflist-hook
9086 (lambda ()
9087 (setq iswitchb-temp-buflist choices))))
9088 (iswitchb-read-buffer prompt)))
9090 (defun org-icompleting-read (&rest args)
9091 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9092 (org-without-partial-completion
9093 (if (and org-completion-use-ido
9094 (fboundp 'ido-completing-read)
9095 (boundp 'ido-mode) ido-mode
9096 (listp (second args)))
9097 (let ((ido-enter-matching-directory nil))
9098 (apply 'ido-completing-read (concat (car args))
9099 (if (consp (car (nth 1 args)))
9100 (mapcar 'car (nth 1 args))
9101 (nth 1 args))
9102 (cddr args)))
9103 (if (and org-completion-use-iswitchb
9104 (boundp 'iswitchb-mode) iswitchb-mode
9105 (listp (second args)))
9106 (apply 'org-iswitchb-completing-read (concat (car args))
9107 (if (consp (car (nth 1 args)))
9108 (mapcar 'car (nth 1 args))
9109 (nth 1 args))
9110 (cddr args))
9111 (apply 'completing-read args)))))
9113 (defun org-extract-attributes (s)
9114 "Extract the attributes cookie from a string and set as text property."
9115 (let (a attr (start 0) key value)
9116 (save-match-data
9118 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9120 (setq key (match-string 1 a) value (match-string 2 a)
9121 start (match-end 0)
9122 attr (plist-put attr (intern key) value))))
9123 (org-add-props s nil 'org-attr attr))
9124 s))
9126 (defun org-extract-attributes-from-string (tag)
9127 (let (key value attr)
9129 (setq key (match-string 1 tag) value (match-string 2 tag)
9130 tag (replace-match "" t t tag)
9131 attr (plist-put attr (intern key) value)))
9132 (cons tag attr)))
9134 (defun org-attributes-to-string (plist)
9135 "Format a property list into an HTML attribute list."
9136 (let ((s "") key value)
9137 (while plist
9138 (setq key (pop plist) value (pop plist))
9139 (and value
9141 s))
9143 ;;; Opening/following a link
9145 (defvar org-link-search-failed nil)
9147 (defvar org-open-link-functions nil
9148 "Hook for functions finding a plain text link.
9149 These functions must take a single argument, the link content.
9150 They will be called for links that look like [[link text][description]]
9154 These functions will be called *before* Org attempts to resolve the
9155 link by doing text searches in the current buffer - so if you want a
9157 handle this as a special case.
9159 When the function does handle the link, it must return a non-nil value.
9160 If it decides that it is not responsible for this link, it must return
9161 nil to indicate that that Org-mode can continue with other options
9162 like exact and fuzzy text search.")
9164 (defun org-next-link ()
9165 "Move forward to the next link.
9166 If the link is in hidden text, expose it."
9167 (interactive)
9168 (when (and org-link-search-failed (eq this-command last-command))
9169 (goto-char (point-min))
9170 (message "Link search wrapped back to beginning of buffer"))
9171 (setq org-link-search-failed nil)
9172 (let* ((pos (point))
9173 (ct (org-context))
9174 (a (assoc :link ct)))
9175 (if a (goto-char (nth 2 a)))
9176 (if (re-search-forward org-any-link-re nil t)
9177 (progn
9178 (goto-char (match-beginning 0))
9179 (if (outline-invisible-p) (org-show-context)))
9180 (goto-char pos)
9181 (setq org-link-search-failed t)
9182 (error "No further link found"))))
9184 (defun org-previous-link ()
9185 "Move backward to the previous link.
9186 If the link is in hidden text, expose it."
9187 (interactive)
9188 (when (and org-link-search-failed (eq this-command last-command))
9189 (goto-char (point-max))
9190 (message "Link search wrapped back to end of buffer"))
9191 (setq org-link-search-failed nil)
9192 (let* ((pos (point))
9193 (ct (org-context))
9194 (a (assoc :link ct)))
9195 (if a (goto-char (nth 1 a)))
9196 (if (re-search-backward org-any-link-re nil t)
9197 (progn
9198 (goto-char (match-beginning 0))
9199 (if (outline-invisible-p) (org-show-context)))
9200 (goto-char pos)
9201 (setq org-link-search-failed t)
9202 (error "No further link found"))))
9204 (defun org-translate-link (s)
9205 "Translate a link string if a translation function has been defined."
9206 (if (and org-link-translation-function
9207 (fboundp org-link-translation-function)
9209 (progn
9210 (setq s (funcall org-link-translation-function
9211 (match-string 1) (match-string 2)))
9212 (concat (car s) ":" (cdr s)))
9213 s))
9215 (defun org-translate-link-from-planner (type path)
9216 "Translate a link from Emacs Planner syntax so that Org can follow it.
9217 This is still an experimental function, your mileage may vary."
9218 (cond
9219 ((member type '("http" "https" "news" "ftp"))
9220 ;; standard Internet links are the same.
9221 nil)
9222 ((and (equal type "irc") (string-match "^//" path))
9223 ;; Planner has two / at the beginning of an irc link, we have 1.
9224 ;; We should have zero, actually....
9225 (setq path (substring path 1)))
9226 ((and (equal type "lisp") (string-match "^/" path))
9227 ;; Planner has a slash, we do not.
9228 (setq type "elisp" path (substring path 1)))
9230 ;; A typical message link. Planner has the id after the final slash,
9231 ;; we separate it with a hash mark
9232 (setq path (concat (match-string 1 path) "#"
9233 (org-remove-angle-brackets (match-string 2 path)))))
9234 )
9235 (cons type path))
9237 (defun org-find-file-at-mouse (ev)
9238 "Open file link or URL at mouse."
9239 (interactive "e")
9240 (mouse-set-point ev)
9241 (org-open-at-point 'in-emacs))
9243 (defun org-open-at-mouse (ev)
9244 "Open file link or URL at mouse."
9245 (interactive "e")
9246 (mouse-set-point ev)
9247 (if (eq major-mode 'org-agenda-mode)
9248 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9249 (org-open-at-point))
9251 (defvar org-window-config-before-follow-link nil
9252 "The window configuration before following a link.
9253 This is saved in case the need arises to restore it.")
9255 (defvar org-open-link-marker (make-marker)
9256 "Marker pointing to the location where `org-open-at-point; was called.")
9258 ;;;###autoload
9259 (defun org-open-at-point-global ()
9260 "Follow a link like Org-mode does.
9261 This command can be called in any mode to follow a link that has
9262 Org-mode syntax."
9263 (interactive)
9264 (org-run-like-in-org-mode 'org-open-at-point))
9266 ;;;###autoload
9267 (defun org-open-link-from-string (s &optional arg reference-buffer)
9268 "Open a link in the string S, as if it was in Org-mode."
9270 (let ((reference-buffer (or reference-buffer (current-buffer))))
9271 (with-temp-buffer
9272 (let ((org-inhibit-startup t))
9273 (org-mode)
9274 (insert s)
9275 (goto-char (point-min))
9276 (when reference-buffer
9277 (setq org-link-abbrev-alist-local
9278 (with-current-buffer reference-buffer
9279 org-link-abbrev-alist-local)))
9280 (org-open-at-point arg reference-buffer)))))
9282 (defvar org-open-at-point-functions nil
9283 "Hook that is run when following a link at point.
9285 Functions in this hook must return t if they identify and follow
9286 a link at point. If they don't find anything interesting at point,
9287 they must return nil.")
9289 (defun org-open-at-point (&optional arg reference-buffer)
9290 "Open link at or after point.
9291 If there is no link at point, this function will search forward up to
9292 the end of the current line.
9293 Normally, files will be opened by an appropriate application. If the
9294 optional prefix argument ARG is non-nil, Emacs will visit the file.
9295 With a double prefix argument, try to open outside of Emacs, in the
9296 application the system uses for this file type."
9297 (interactive "P")
9298 ;; if in a code block, then open the block's results
9299 (unless (call-interactively #'org-babel-open-src-block-result)
9300 (org-load-modules-maybe)
9301 (move-marker org-open-link-marker (point))
9302 (setq org-window-config-before-follow-link (current-window-configuration))
9303 (org-remove-occur-highlights nil nil t)
9304 (cond
9305 ((and (org-on-heading-p)
9306 (not (org-in-regexp
9311 (not (get-text-property (point) 'org-linked-text)))
9312 (or (org-offer-links-in-entry arg)
9313 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9314 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9315 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9316 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9317 (not (org-in-regexp org-bracket-link-regexp)))
9318 (org-footnote-action))
9319 (t
9320 (let (type path link line search (pos (point)))
9321 (catch 'match
9322 (save-excursion
9324 (when (org-in-regexp org-bracket-link-regexp 1)
9325 (setq link (org-extract-attributes
9326 (org-link-unescape (org-match-string-no-properties 1))))
9328 (setq link (replace-match " " t t link)))
9329 (setq link (org-link-expand-abbrev link))
9330 (cond
9331 ((or (file-name-absolute-p link)
9333 (setq type "file" path link))
9334 ((string-match org-link-re-with-space3 link)
9335 (setq type (match-string 1 link) path (match-string 2 link)))
9336 (t (setq type "thisfile" path link)))
9337 (throw 'match t)))
9339 (when (get-text-property (point) 'org-linked-text)
9340 (setq type "thisfile"
9341 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9342 (1+ (point)) (point))
9343 path (buffer-substring
9344 (or (previous-single-property-change pos 'org-linked-text)
9345 (point-min))
9346 (or (next-single-property-change pos 'org-linked-text)
9347 (point-max))))
9348 (throw 'match t))
9350 (save-excursion
9351 (when (or (org-in-regexp org-angle-link-re)
9352 (org-in-regexp org-plain-link-re))
9353 (setq type (match-string 1) path (match-string 2))
9354 (throw 'match t)))
9355 (save-excursion
9357 (setq type "tags"
9358 path (match-string 1))
9359 (while (string-match ":" path)
9360 (setq path (replace-match "+" t t path)))
9361 (throw 'match t)))
9363 (setq type "tree-match"
9364 path (match-string 1))
9365 (throw 'match t)))
9366 (unless path
9367 (error "No link found"))
9369 ;; switch back to reference buffer
9370 ;; needed when if called in a temporary buffer through
9371 ;; org-open-link-from-string
9372 (with-current-buffer (or reference-buffer (current-buffer))
9374 ;; Remove any trailing spaces in path
9376 (setq path (replace-match "" t t path)))
9377 (if (and org-link-translation-function
9378 (fboundp org-link-translation-function))
9379 ;; Check if we need to translate the link
9380 (let ((tmp (funcall org-link-translation-function type path)))
9381 (setq type (car tmp) path (cdr tmp))))
9383 (cond
9385 ((assoc type org-link-protocols)
9386 (funcall (nth 1 (assoc type org-link-protocols)) path))
9388 ((equal type "mailto")
9389 (let ((cmd (car org-link-mailto-program))
9390 (args (cdr org-link-mailto-program)) args1
9391 (address path) (subject "") a)
9393 (setq address (match-string 1 path)
9394 subject (org-link-escape (match-string 2 path))))
9395 (while args
9396 (cond
9397 ((not (stringp (car args))) (push (pop args) args1))
9398 (t (setq a (pop args))
9399 (if (string-match "%a" a)
9400 (setq a (replace-match address t t a)))
9401 (if (string-match "%s" a)
9402 (setq a (replace-match subject t t a)))
9403 (push a args1))))
9404 (apply cmd (nreverse args1))))
9406 ((member type '("http" "https" "ftp" "news"))
9407 (browse-url (concat type ":" (org-link-escape
9408 path org-link-escape-chars-browser))))
9410 ((string= type "doi")
9411 (browse-url (concat "http://dx.doi.org/"
9412 (org-link-escape
9413 path org-link-escape-chars-browser))))
9415 ((member type '("message"))
9416 (browse-url (concat type ":" path)))
9418 ((string= type "tags")
9419 (org-tags-view arg path))
9421 ((string= type "tree-match")
9424 ((string= type "file")
9426 (setq line (string-to-number (match-string 1 path))
9427 path (substring path 0 (match-beginning 0)))
9429 (setq search (match-string 1 path)
9430 path (substring path 0 (match-beginning 0)))))
9431 (if (string-match "[*?{]" (file-name-nondirectory path))
9432 (dired path)
9433 (org-open-file path arg line search)))
9435 ((string= type "shell")
9436 (let ((cmd path))
9437 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9438 (string-match org-confirm-shell-link-not-regexp cmd))
9439 (not org-confirm-shell-link-function)
9440 (funcall org-confirm-shell-link-function
9442 (org-add-props cmd nil
9443 'face 'org-warning))))
9444 (progn
9445 (message "Executing %s" cmd)
9446 (shell-command cmd))
9447 (error "Abort"))))
9449 ((string= type "elisp")
9450 (let ((cmd path))
9451 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9452 (string-match org-confirm-elisp-link-not-regexp cmd))
9453 (not org-confirm-elisp-link-function)
9454 (funcall org-confirm-elisp-link-function
9456 (org-add-props cmd nil
9457 'face 'org-warning))))
9458 (message "%s => %s" cmd
9459 (if (equal (string-to-char cmd) ?\()
9460 (eval (read cmd))
9461 (call-interactively (read cmd))))
9462 (error "Abort"))))
9464 ((and (string= type "thisfile")
9465 (run-hook-with-args-until-success
9466 'org-open-link-functions path)))
9468 ((string= type "thisfile")
9469 (if arg
9470 (switch-to-buffer-other-window
9471 (org-get-buffer-for-internal-link (current-buffer)))
9472 (org-mark-ring-push))
9473 (let ((cmd `(org-link-search
9474 ,path
9475 ,(cond ((equal arg '(4)) ''occur)
9476 ((equal arg '(16)) ''org-occur)
9477 (t nil))
9478 ,pos)))
9479 (condition-case nil (eval cmd)
9480 (error (progn (widen) (eval cmd))))))
9482 (t
9483 (browse-url-at-point)))))))
9484 (move-marker org-open-link-marker nil)
9485 (run-hook-with-args 'org-follow-link-hook)))
9487 (defun org-offer-links-in-entry (&optional nth zero)
9488 "Offer links in the current entry and follow the selected link.
9489 If there is only one link, follow it immediately as well.
9490 If NTH is an integer, immediately pick the NTH link found.
9491 If ZERO is a string, check also this string for a link, and if
9492 there is one, offer it as link number zero."
9496 (cnt ?0)
9497 (in-emacs (if (integerp nth) nil nth))
9498 have-zero end links link c)
9499 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9500 (push (match-string 0 zero) links)
9501 (setq cnt (1- cnt) have-zero t))
9502 (save-excursion
9503 (org-back-to-heading t)
9504 (setq end (save-excursion (outline-next-heading) (point)))
9505 (while (re-search-forward re end t)
9506 (push (match-string 0) links))
9507 (setq links (org-uniquify (reverse links))))
9509 (cond
9510 ((null links)
9511 (message "No links"))
9512 ((equal (length links) 1)
9513 (setq link (list (car links))))
9514 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9515 (setq link (nth (if have-zero nth (1- nth)) links)))
9516 (t ; we have to select a link
9517 (save-excursion
9518 (save-window-excursion
9519 (delete-other-windows)
9520 (with-output-to-temp-buffer "*Select Link*"
9521 (mapc (lambda (l)
9522 (if (not (string-match org-bracket-link-regexp l))
9524 (org-remove-angle-brackets l)))
9525 (if (match-end 3)
9527 (match-string 3 l) (match-string 1 l)))
9529 (match-string 1 l))))))
9530 links))
9531 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9532 (message "Select link to open, RET to open all:")
9533 (setq c (read-char-exclusive))
9534 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9535 (when (equal c ?q) (error "Abort"))
9536 (if (equal c ?\C-m)
9537 (setq link links)
9538 (setq nth (- c ?0))
9539 (if have-zero (setq nth (1+ nth)))
9540 (unless (and (integerp nth) (>= (length links) nth))
9541 (error "Invalid link selection"))
9542 (setq link (list (nth (1- nth) links))))))
9543 (if link
9544 (let ((buf (current-buffer)))
9545 (dolist (l link)
9546 (org-open-link-from-string l in-emacs buf))
9547 t)
9548 nil)))
9550 ;; Add special file links that specify the way of opening
9552 (org-add-link-type "file+sys" 'org-open-file-with-system)
9553 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9554 (defun org-open-file-with-system (path)
9555 "Open file at PATH using the system way of opening it."
9556 (org-open-file path 'system))
9557 (defun org-open-file-with-emacs (path)
9558 "Open file at PATH in Emacs."
9559 (org-open-file path 'emacs))
9560 (defun org-remove-file-link-modifiers ()
9561 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9562 (goto-char (point-min))
9564 (org-if-unprotected
9565 (replace-match "file:" t t))))
9566 (eval-after-load "org-exp"
9567 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9568 'org-remove-file-link-modifiers))
9570 ;;;; Time estimates
9572 (defun org-get-effort (&optional pom)
9573 "Get the effort estimate for the current entry."
9574 (org-entry-get pom org-effort-property))
9576 ;;; File search
9578 (defvar org-create-file-search-functions nil
9579 "List of functions to construct the right search string for a file link.
9580 These functions are called in turn with point at the location to
9581 which the link should point.
9583 A function in the hook should first test if it would like to
9584 handle this file type, for example by checking the `major-mode'
9585 or the file extension. If it decides not to handle this file, it
9586 should just return nil to give other functions a chance. If it
9587 does handle the file, it must return the search string to be used
9588 when following the link. The search string will be part of the
9589 file link, given after a double colon, and `org-open-at-point'
9590 will automatically search for it. If special measures must be
9591 taken to make the search successful, another function should be
9592 added to the companion hook `org-execute-file-search-functions',
9593 which see.
9595 A function in this hook may also use `setq' to set the variable
9596 `description' to provide a suggestion for the descriptive text to
9597 be used for this link when it gets inserted into an Org-mode
9600 (defvar org-execute-file-search-functions nil
9601 "List of functions to execute a file search triggered by a link.
9603 Functions added to this hook must accept a single argument, the
9604 search string that was part of the file link, the part after the
9605 double colon. The function must first check if it would like to
9606 handle this search, for example by checking the `major-mode' or
9607 the file extension. If it decides not to handle this search, it
9608 should just return nil to give other functions a chance. If it
9609 does handle the search, it must return a non-nil value to keep
9610 other functions from trying.
9612 Each function can access the current prefix argument through the
9613 variable `current-prefix-argument'. Note that a single prefix is
9614 used to force opening a link in Emacs, so it may be good to only
9615 use a numeric or double prefix to guide the search function.
9617 In case this is needed, a function in this hook can also restore
9618 the window configuration before `org-open-at-point' was called using:
9620 (set-window-configuration org-window-config-before-follow-link)")
9622 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9623 (defun org-link-search (s &optional type avoid-pos)
9624 "Search for a link search option.
9625 If S is surrounded by forward slashes, it is interpreted as a
9626 regular expression. In org-mode files, this will create an `org-occur'
9627 sparse tree. In ordinary files, `occur' will be used to list matches.
9628 If the current buffer is in `dired-mode', grep will be used to search
9629 in all files. If AVOID-POS is given, ignore matches near that position."
9630 (let ((case-fold-search t)
9634 org-emphasis-alist)
9636 (pos (point))
9637 (pre nil) (post nil)
9638 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9639 (cond
9640 ;; First check if there are any special search functions
9641 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9642 ;; Now try the builtin stuff
9643 ((and (equal (string-to-char s0) ?#)
9644 (> (length s0) 1)
9645 (save-excursion
9646 (goto-char (point-min))
9647 (and
9648 (re-search-forward
9650 (setq type 'dedicated
9651 pos (match-beginning 0))))
9652 ;; There is an exact target for this
9653 (goto-char pos)
9654 (org-back-to-heading t)))
9655 ((save-excursion
9656 (goto-char (point-min))
9657 (and
9658 (re-search-forward
9659 (concat "<<" (regexp-quote s0) ">>") nil t)
9660 (setq type 'dedicated
9661 pos (match-beginning 0))))
9662 ;; There is an exact target for this
9663 (goto-char pos))
9665 (save-excursion
9666 (goto-char (point-min))
9667 (and
9668 (re-search-forward
9669 (concat "[^[]" (regexp-quote
9670 (format org-coderef-label-format
9671 (match-string 1 s0))))
9672 nil t)
9673 (setq type 'dedicated
9674 pos (1+ (match-beginning 0))))))
9675 ;; There is a coderef target for this
9676 (goto-char pos))
9678 ;; A regular expression
9679 (cond
9680 ((org-mode-p)
9681 (org-occur (match-string 1 s)))
9682 ;;((eq major-mode 'dired-mode)
9683 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9684 (t (org-do-occur (match-string 1 s)))))
9685 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9686 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9687 (goto-char (point-min))
9688 (cond
9689 ((let (case-fold-search)
9690 (re-search-forward (format org-complex-heading-regexp-format
9691 (regexp-quote s))
9692 nil t))
9693 ;; OK, found a match
9694 (setq type 'dedicated)
9695 (goto-char (match-beginning 0)))
9696 ((and (not org-link-search-inhibit-query)
9697 (eq org-link-search-must-match-exact-headline 'query-to-create)
9698 (y-or-n-p "No match - create this as a new heading? "))
9699 (goto-char (point-max))
9700 (or (bolp) (newline))
9702 (beginning-of-line 0))
9703 (t
9704 (goto-char pos)
9705 (error "No match"))))
9706 (t
9707 ;; A normal search string
9708 (when (equal (string-to-char s) ?*)
9709 ;; Anchor on headlines, post may include tags.
9712 s (substring s 1)))
9713 (remove-text-properties
9714 0 (length s)
9715 '(face nil mouse-face nil keymap nil fontified nil) s)
9716 ;; Make a series of regular expressions to find a match
9725 re4 (concat "[^a-zA-Z_]" re4_)
9727 re1 (concat pre re2 post)
9728 re3 (concat pre (if pre re4_ re4) post)
9729 re5 (concat pre ".*" re4)
9730 re2 (concat pre re2)
9731 re2a (concat pre (if pre re2a_ re2a))
9732 re4 (concat pre (if pre re4_ re4))
9736 ))
9737 (cond
9738 ((eq type 'org-occur) (org-occur reall))
9739 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9740 (t (goto-char (point-min))
9741 (setq type 'fuzzy)
9742 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9743 (org-search-not-self 1 re1 nil t)
9744 (org-search-not-self 1 re2 nil t)
9745 (org-search-not-self 1 re2a nil t)
9746 (org-search-not-self 1 re3 nil t)
9747 (org-search-not-self 1 re4 nil t)
9748 (org-search-not-self 1 re5 nil t)
9749 )
9750 (goto-char (match-beginning 1))
9751 (goto-char pos)
9752 (error "No match"))))))
9753 (and (org-mode-p) (org-show-context 'link-search))
9754 type))
9756 (defun org-search-not-self (group &rest args)
9757 "Execute `re-search-forward', but only accept matches that do not
9758 enclose the position of `org-open-link-marker'."
9759 (let ((m org-open-link-marker))
9760 (catch 'exit
9761 (while (apply 're-search-forward args)
9762 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9763 (goto-char (match-end group))
9764 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9765 (> (match-beginning 0) (marker-position m))
9766 (< (match-end 0) (marker-position m)))
9767 (save-match-data
9768 (or (not (org-in-regexp
9769 org-bracket-link-analytic-regexp 1))
9770 (not (match-end 4)) ; no description
9771 (and (<= (match-beginning 4) (point))
9772 (>= (match-end 4) (point))))))
9773 (throw 'exit (point))))))))
9775 (defun org-get-buffer-for-internal-link (buffer)
9776 "Return a buffer to be used for displaying the link target of internal links."
9777 (cond
9778 ((not org-display-internal-link-with-indirect-buffer)
9779 buffer)
9780 ((string-match "(Clone)$" (buffer-name buffer))
9781 (message "Buffer is already a clone, not making another one")
9782 ;; we also do not modify visibility in this case
9783 buffer)
9784 (t ; make a new indirect buffer for displaying the link
9785 (let* ((bn (buffer-name buffer))
9786 (ibn (concat bn "(Clone)"))
9787 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9788 (with-current-buffer ib (org-overview))
9789 ib))))
9791 (defun org-do-occur (regexp &optional cleanup)
9792 "Call the Emacs command `occur'.
9793 If CLEANUP is non-nil, remove the printout of the regular expression
9794 in the *Occur* buffer. This is useful if the regex is long and not useful
9795 to read."
9796 (occur regexp)
9797 (when cleanup
9798 (let ((cwin (selected-window)) win beg end)
9799 (when (setq win (get-buffer-window "*Occur*"))
9800 (select-window win))
9801 (goto-char (point-min))
9802 (when (re-search-forward "match[a-z]+" nil t)
9803 (setq beg (match-end 0))
9805 (setq end (1- (match-beginning 0)))))
9806 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9807 (goto-char (point-min))
9808 (select-window cwin))))
9810 ;;; The mark ring for links jumps
9812 (defvar org-mark-ring nil
9813 "Mark ring for positions before jumps in Org-mode.")
9814 (defvar org-mark-ring-last-goto nil
9815 "Last position in the mark ring used to go back.")
9816 ;; Fill and close the ring
9817 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9818 (loop for i from 1 to org-mark-ring-length do
9819 (push (make-marker) org-mark-ring))
9820 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9821 org-mark-ring)
9823 (defun org-mark-ring-push (&optional pos buffer)
9824 "Put the current position or POS into the mark ring and rotate it."
9825 (interactive)
9826 (setq pos (or pos (point)))
9827 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9828 (move-marker (car org-mark-ring)
9829 (or pos (point))
9830 (or buffer (current-buffer)))
9831 (message "%s"
9832 (substitute-command-keys
9835 (defun org-mark-ring-goto (&optional n)
9836 "Jump to the previous position in the mark ring.
9837 With prefix arg N, jump back that many stored positions. When
9838 called several times in succession, walk through the entire ring.
9839 Org-mode commands jumping to a different position in the current file,
9840 or to another Org-mode file, automatically push the old position
9841 onto the ring."
9842 (interactive "p")
9843 (let (p m)
9844 (if (eq last-command this-command)
9845 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9846 (setq p org-mark-ring))
9847 (setq org-mark-ring-last-goto p)
9848 (setq m (car p))
9849 (org-pop-to-buffer-same-window (marker-buffer m))
9850 (goto-char m)
9851 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9853 (defun org-remove-angle-brackets (s)
9854 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9855 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9856 s)
9857 (defun org-add-angle-brackets (s)
9858 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9859 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9860 s)
9861 (defun org-remove-double-quotes (s)
9864 s)
9866 ;;; Following specific links
9868 (defun org-follow-timestamp-link ()
9869 (cond
9870 ((org-at-date-range-p t)
9871 (let ((org-agenda-start-on-weekday)
9872 (t1 (match-string 1))
9873 (t2 (match-string 2)))
9874 (setq t1 (time-to-days (org-time-string-to-time t1))
9875 t2 (time-to-days (org-time-string-to-time t2)))
9876 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9877 ((org-at-timestamp-p t)
9878 (org-agenda-list nil (time-to-days (org-time-string-to-time
9879 (substring (match-string 1) 0 10)))
9880 1))
9881 (t (error "This should not happen"))))
9884 ;;; Following file links
9885 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
9886 (declare-function mailcap-extension-to-mime "mailcap" (extn))
9887 (declare-function mailcap-mime-info
9888 "mailcap" (string &optional request no-decode))
9889 (defvar org-wait nil)
9890 (defun org-open-file (path &optional in-emacs line search)
9891 "Open the file at PATH.
9892 First, this expands any special file name abbreviations. Then the
9893 configuration variable `org-file-apps' is checked if it contains an
9894 entry for this file type, and if yes, the corresponding command is launched.
9896 If no application is found, Emacs simply visits the file.
9898 With optional prefix argument IN-EMACS, Emacs will visit the file.
9900 prefix arg, Org tries to avoid opening in Emacs
9901 and to use an external application to visit the file.
9903 Optional LINE specifies a line to go to, optional SEARCH a string
9904 to search for. If LINE or SEARCH is given, the file will be
9905 opened in Emacs, unless an entry from org-file-apps that makes
9906 use of groups in a regexp matches.
9907 If the file does not exist, an error is thrown."
9908 (let* ((file (if (equal path "")
9909 buffer-file-name
9910 (substitute-in-file-name (expand-file-name path))))
9911 (file-apps (append org-file-apps (org-default-apps)))
9912 (apps (org-remove-if
9913 'org-file-apps-entry-match-against-dlink-p file-apps))
9914 (apps-dlink (org-remove-if-not
9915 'org-file-apps-entry-match-against-dlink-p file-apps))
9916 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9917 (dirp (if remp nil (file-directory-p file)))
9918 (file (if (and dirp org-open-directory-means-index-dot-org)
9919 (concat (file-name-as-directory file) "index.org")
9920 file))
9921 (a-m-a-p (assq 'auto-mode apps))
9922 (dfile (downcase file))
9923 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9924 (link (cond ((and (eq line nil)
9925 (eq search nil))
9926 file)
9927 (line
9928 (concat file "::" (number-to-string line)))
9929 (search
9930 (concat file "::" search))))
9931 (dlink (downcase link))
9932 (old-buffer (current-buffer))
9933 (old-pos (point))
9934 (old-mode major-mode)
9935 ext cmd link-match-data)
9937 (setq ext (match-string 1 dfile))
9939 (setq ext (match-string 1 dfile))))
9940 (cond
9941 ((member in-emacs '((16) system))
9942 (setq cmd (cdr (assoc 'system apps))))
9943 (in-emacs (setq cmd 'emacs))
9944 (t
9945 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9946 (and dirp (cdr (assoc 'directory apps)))
9947 ; first, try matching against apps-dlink
9948 ; if we get a match here, store the match data for later
9949 (let ((match (assoc-default dlink apps-dlink
9950 'string-match)))
9951 (if match
9952 (progn (setq link-match-data (match-data))
9953 match)
9954 (progn (setq in-emacs (or in-emacs line search))
9955 nil))) ; if we have no match in apps-dlink,
9956 ; always open the file in emacs if line or search
9957 ; is given (for backwards compatibility)
9958 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9959 'string-match)
9960 (cdr (assoc ext apps))
9961 (cdr (assoc t apps))))))
9962 (when (eq cmd 'system)
9963 (setq cmd (cdr (assoc 'system apps))))
9964 (when (eq cmd 'default)
9965 (setq cmd (cdr (assoc t apps))))
9966 (when (eq cmd 'mailcap)
9967 (require 'mailcap)
9968 (mailcap-parse-mailcaps)
9969 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9970 (command (mailcap-mime-info mime-type)))
9971 (if (stringp command)
9972 (setq cmd command)
9973 (setq cmd 'emacs))))
9974 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9975 (not (file-exists-p file))
9976 (not org-open-non-existing-files))
9977 (error "No such file: %s" file))
9978 (cond
9980 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9982 (setq cmd (replace-match "%s" t t cmd)))
9983 (while (string-match "%s" cmd)
9984 (setq cmd (replace-match
9985 (save-match-data
9986 (shell-quote-argument
9987 (convert-standard-filename file)))
9988 t t cmd)))
9990 ;; Replace "%1", "%2" etc. in command with group matches from regex
9991 (save-match-data
9992 (let ((match-index 1)
9993 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9994 (set-match-data link-match-data)
9995 (while (<= match-index number-of-groups)
9996 (let ((regex (concat "%" (number-to-string match-index)))
9997 (replace-with (match-string match-index dlink)))
9998 (while (string-match regex cmd)
9999 (setq cmd (replace-match replace-with t t cmd))))
10000 (setq match-index (+ match-index 1)))))
10002 (save-window-excursion
10003 (start-process-shell-command cmd nil cmd)
10004 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10005 ))
10006 ((or (stringp cmd)
10007 (eq cmd 'emacs))
10008 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10009 (widen)
10010 (if line (org-goto-line line)
10011 (if search (org-link-search search))))
10012 ((consp cmd)
10013 (let ((file (convert-standard-filename file)))
10014 (save-match-data
10015 (set-match-data link-match-data)
10016 (eval cmd))))
10017 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10018 (and (org-mode-p) (eq old-mode 'org-mode)
10019 (or (not (equal old-buffer (current-buffer)))
10020 (not (equal old-pos (point))))
10021 (org-mark-ring-push old-pos old-buffer))))
10023 (defun org-file-apps-entry-match-against-dlink-p (entry)
10024 "This function returns non-nil if `entry' uses a regular
10025 expression which should be matched against the whole link by
10026 org-open-file.
10028 It assumes that is the case when the entry uses a regular
10029 expression which has at least one grouping construct and the
10030 action is either a lisp form or a command string containing
10031 '%1', i.e. using at least one subexpression match as a
10032 parameter."
10033 (let ((selector (car entry))
10034 (action (cdr entry)))
10035 (if (stringp selector)
10036 (and (> (regexp-opt-depth selector) 0)
10037 (or (and (stringp action)
10038 (string-match "%[0-9]" action))
10039 (consp action)))
10040 nil)))
10042 (defun org-default-apps ()
10043 "Return the default applications for this operating system."
10044 (cond
10045 ((eq system-type 'darwin)
10046 org-file-apps-defaults-macosx)
10047 ((eq system-type 'windows-nt)
10048 org-file-apps-defaults-windowsnt)
10049 (t org-file-apps-defaults-gnu)))
10051 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10052 "Convert extensions to regular expressions in the cars of LIST.
10053 Also, weed out any non-string entries, because the return value is used
10054 only for regexp matching.
10055 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10056 point to the symbol `emacs', indicating that the file should
10057 be opened in Emacs."
10058 (append
10059 (delq nil
10060 (mapcar (lambda (x)
10061 (if (not (stringp (car x)))
10062 nil
10064 x
10066 list))
10067 (if add-auto-mode
10068 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10070 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10071 (defun org-file-remote-p (file)
10072 "Test whether FILE specifies a location on a remote system.
10073 Return non-nil if the location is indeed remote.
10077 (cond ((fboundp 'file-remote-p)
10078 (file-remote-p file))
10079 ((fboundp 'tramp-handle-file-remote-p)
10080 (tramp-handle-file-remote-p file))
10081 ((and (boundp 'ange-ftp-name-format)
10082 (string-match (car ange-ftp-name-format) file))
10083 t)
10084 (t nil)))
10087 ;;;; Refiling
10089 (defun org-get-org-file ()
10090 "Read a filename, with default directory `org-directory'."
10091 (let ((default (or org-default-notes-file remember-data-file)))
10092 (read-file-name (format "File name [%s]: " default)
10093 (file-name-as-directory org-directory)
10094 default)))
10096 (defun org-notes-order-reversed-p ()
10097 "Check if the current file should receive notes in reversed order."
10098 (cond
10099 ((not org-reverse-note-order) nil)
10100 ((eq t org-reverse-note-order) t)
10101 ((not (listp org-reverse-note-order)) nil)
10102 (t (catch 'exit
10103 (let ((all org-reverse-note-order)
10104 entry)
10105 (while (setq entry (pop all))
10106 (if (string-match (car entry) buffer-file-name)
10107 (throw 'exit (cdr entry))))
10108 nil)))))
10110 (defvar org-refile-target-table nil
10111 "The list of refile targets, created by `org-refile'.")
10113 (defvar org-agenda-new-buffers nil
10114 "Buffers created to visit agenda files.")
10116 (defvar org-refile-cache nil
10117 "Cache for refile targets.")
10119 (defvar org-refile-markers nil
10120 "All the markers used for caching refile locations.")
10122 (defun org-refile-marker (pos)
10123 "Get a new refile marker, but only if caching is in use."
10124 (if (not org-refile-use-cache)
10125 pos
10126 (let ((m (make-marker)))
10127 (move-marker m pos)
10128 (push m org-refile-markers)
10129 m)))
10131 (defun org-refile-cache-clear ()
10132 "Clear the refile cache and disable all the markers."
10133 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10134 (setq org-refile-markers nil)
10135 (setq org-refile-cache nil)
10136 (message "Refile cache has been cleared"))
10138 (defun org-refile-cache-check-set (set)
10139 "Check if all the markers in the cache still have live buffers."
10140 (let (marker)
10141 (catch 'exit
10142 (while (and set (setq marker (nth 3 (pop set))))
10143 ;; if org-refile-use-outline-path is 'file, marker may be nil
10144 (when (and marker (null (marker-buffer marker)))
10145 (message "not found") (sit-for 3)
10146 (throw 'exit nil)))
10147 t)))
10149 (defun org-refile-cache-put (set &rest identifiers)
10150 "Push the refile targets SET into the cache, under IDENTIFIERS."
10151 (let* ((key (sha1 (prin1-to-string identifiers)))
10152 (entry (assoc key org-refile-cache)))
10153 (if entry
10154 (setcdr entry set)
10155 (push (cons key set) org-refile-cache))))
10157 (defun org-refile-cache-get (&rest identifiers)
10158 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10159 (cond
10160 ((not org-refile-cache) nil)
10161 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10162 (t
10163 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10164 org-refile-cache))))
10165 (and set (org-refile-cache-check-set set) set)))))
10167 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10168 "Produce a table with refile targets."
10169 (let ((case-fold-search nil)
10170 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10171 (entries (or org-refile-targets '((nil . (:level . 1)))))
10172 targets tgs txt re files f desc descre fast-path-p level pos0)
10173 (message "Getting targets...")
10174 (with-current-buffer (or default-buffer (current-buffer))
10175 (while (setq entry (pop entries))
10176 (setq files (car entry) desc (cdr entry))
10177 (setq fast-path-p nil)
10178 (cond
10179 ((null files) (setq files (list (current-buffer))))
10180 ((eq files 'org-agenda-files)
10181 (setq files (org-agenda-files 'unrestricted)))
10182 ((and (symbolp files) (fboundp files))
10183 (setq files (funcall files)))
10184 ((and (symbolp files) (boundp files))
10185 (setq files (symbol-value files))))
10186 (if (stringp files) (setq files (list files)))
10187 (cond
10188 ((eq (car desc) :tag)
10190 ((eq (car desc) :todo)
10192 ((eq (car desc) :regexp)
10193 (setq descre (cdr desc)))
10194 ((eq (car desc) :level)
10196 (if org-odd-levels-only
10197 (1- (* 2 (cdr desc)))
10198 (cdr desc)))
10200 ((eq (car desc) :maxlevel)
10201 (setq fast-path-p t)
10203 (if org-odd-levels-only
10204 (1- (* 2 (cdr desc)))
10205 (cdr desc)))
10207 (t (error "Bad refiling target description %s" desc)))
10208 (while (setq f (pop files))
10209 (with-current-buffer
10210 (if (bufferp f) f (org-get-agenda-file-buffer f))
10211 (or
10212 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10213 (progn
10214 (if (bufferp f) (setq f (buffer-file-name
10215 (buffer-base-buffer f))))
10216 (setq f (and f (expand-file-name f)))
10217 (if (eq org-refile-use-outline-path 'file)
10218 (push (list (file-name-nondirectory f) f nil nil) tgs))
10219 (save-excursion
10220 (save-restriction
10221 (widen)
10222 (goto-char (point-min))
10223 (while (re-search-forward descre nil t)
10224 (goto-char (setq pos0 (point-at-bol)))
10225 (catch 'next
10226 (when org-refile-target-verify-function
10227 (save-match-data
10228 (or (funcall org-refile-target-verify-function)
10229 (throw 'next t))))
10230 (when (and (looking-at org-complex-heading-regexp)
10231 (not (member (match-string 4) excluded-entries)))
10232 (setq level (org-reduced-level
10233 (- (match-end 1) (match-beginning 1)))
10234 txt (org-link-display-format (match-string 4))
10236 re (format org-complex-heading-regexp-format
10237 (regexp-quote (match-string 4))))
10238 (when org-refile-use-outline-path
10239 (setq txt (mapconcat
10240 'org-protect-slash
10241 (append
10242 (if (eq org-refile-use-outline-path
10243 'file)
10244 (list (file-name-nondirectory
10245 (buffer-file-name
10246 (buffer-base-buffer))))
10247 (if (eq org-refile-use-outline-path
10248 'full-file-path)
10249 (list (buffer-file-name
10250 (buffer-base-buffer)))))
10251 (org-get-outline-path fast-path-p
10252 level txt)
10253 (list txt))
10254 "/")))
10255 (push (list txt f re (org-refile-marker (point)))
10256 tgs)))
10257 (when (= (point) pos0)
10258 ;; verification function has not moved point
10259 (goto-char (point-at-eol))))))))
10260 (when org-refile-use-cache
10261 (org-refile-cache-put tgs (buffer-file-name) descre))
10262 (setq targets (append tgs targets))
10263 ))))
10264 (message "Getting targets...done")
10265 (nreverse targets)))
10267 (defun org-protect-slash (s)
10268 (while (string-match "/" s)
10270 s)
10272 (defvar org-olpa (make-vector 20 nil))
10274 (defun org-get-outline-path (&optional fastp level heading)
10275 "Return the outline path to the current entry, as a list.
10277 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10278 routine which makes outline path derivations for an entire file,
10279 avoiding backtracing. Refile target collection makes use of that."
10280 (if fastp
10281 (progn
10282 (if (> level 19)
10283 (error "Outline path failure, more than 19 levels"))
10284 (loop for i from level upto 19 do
10285 (aset org-olpa i nil))
10286 (prog1
10287 (delq nil (append org-olpa nil))
10288 (aset org-olpa level heading)))
10289 (let (rtn case-fold-search)
10290 (save-excursion
10291 (save-restriction
10292 (widen)
10293 (while (org-up-heading-safe)
10294 (when (looking-at org-complex-heading-regexp)
10295 (push (org-match-string-no-properties 4) rtn)))
10296 rtn)))))
10298 (defun org-format-outline-path (path &optional width prefix)
10299 "Format the outline path PATH for display.
10300 Width is the maximum number of characters that is available.
10301 Prefix is a prefix to be included in the returned string,
10302 such as the file name."
10303 (setq width (or width 79))
10304 (if prefix (setq width (- width (length prefix))))
10305 (if (not path)
10306 (or prefix "")
10307 (let* ((nsteps (length path))
10308 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10309 (maxwidth (if (<= total-width width)
10310 10000 ;; everything fits
10311 ;; we need to shorten the level headings
10312 (/ (- width nsteps) nsteps)))
10313 (org-odd-levels-only nil)
10314 (n 0)
10315 (total (1+ (length prefix))))
10316 (setq maxwidth (max maxwidth 10))
10317 (concat prefix
10318 (mapconcat
10319 (lambda (h)
10320 (setq n (1+ n))
10321 (if (and (= n nsteps) (< maxwidth 10000))
10322 (setq maxwidth (- total-width total)))
10323 (if (< (length h) maxwidth)
10324 (progn (setq total (+ total (length h) 1)) h)
10325 (setq h (substring h 0 (- maxwidth 2))
10326 total (+ total maxwidth 1))
10328 (setq h (substring h 0 (match-beginning 0))))
10329 (setq h (concat h "..")))
10330 (org-add-props h nil 'face
10331 (nth (% (1- n) org-n-level-faces)
10332 org-level-faces))
10333 h)
10334 path "/")))))
10336 (defun org-display-outline-path (&optional file current)
10337 "Display the current outline path in the echo area."
10338 (interactive "P")
10339 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10340 (case-fold-search nil)
10341 (path (and (org-mode-p) (org-get-outline-path))))
10342 (if current (setq path (append path
10343 (save-excursion
10344 (org-back-to-heading t)
10345 (if (looking-at org-complex-heading-regexp)
10346 (list (match-string 4)))))))
10347 (message "%s"
10348 (org-format-outline-path
10349 path
10350 (1- (frame-width))
10351 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10353 (defvar org-refile-history nil
10354 "History for refiling operations.")
10356 (defvar org-after-refile-insert-hook nil
10357 "Hook run after `org-refile' has inserted its stuff at the new location.
10358 Note that this is still *before* the stuff will be removed from
10359 the *old* location.")
10361 (defvar org-capture-last-stored-marker)
10362 (defun org-refile (&optional goto default-buffer rfloc)
10363 "Move the entry or entries at point to another heading.
10364 The list of target headings is compiled using the information in
10365 `org-refile-targets', which see.
10367 At the target location, the entry is filed as a subitem of the target
10368 heading. Depending on `org-reverse-note-order', the new subitem will
10369 either be the first or the last subitem.
10371 If there is an active region, all entries in that region will be moved.
10372 However, the region must fulfill the requirement that the first heading
10373 is the first one sets the top-level of the moved text - at most siblings
10374 below it are allowed.
10376 With prefix arg GOTO, the command will only visit the target location
10377 and not actually move anything.
10380 go to the location where the last refiling operation has put the subtree.
10381 With a prefix argument of `2', refile to the running clock.
10383 RFLOC can be a refile location obtained in a different way.
10385 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10387 If you are using target caching (see `org-refile-use-cache'),
10388 You have to clear the target cache in order to find new targets.
10389 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10390 prefix argument (`C-u C-u C-u C-c C-w')."
10392 (interactive "P")
10393 (if (member goto '(0 (64)))
10394 (org-refile-cache-clear)
10395 (let* ((cbuf (current-buffer))
10396 (regionp (org-region-active-p))
10397 (region-start (and regionp (region-beginning)))
10398 (region-end (and regionp (region-end)))
10399 (region-length (and regionp (- region-end region-start)))
10400 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10401 pos it nbuf file re level reversed)
10402 (setq last-command nil)
10403 (when regionp
10404 (goto-char region-start)
10405 (or (bolp) (goto-char (point-at-bol)))
10406 (setq region-start (point))
10407 (unless (org-kill-is-subtree-p
10408 (buffer-substring region-start region-end))
10409 (error "The region is not a (sequence of) subtree(s)")))
10410 (if (equal goto '(16))
10411 (org-refile-goto-last-stored)
10412 (when (or
10413 (and (equal goto 2)
10414 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10415 (prog1
10416 (setq it (list (or org-clock-heading "running clock")
10417 (buffer-file-name
10418 (marker-buffer org-clock-hd-marker))
10419 ""
10420 (marker-position org-clock-hd-marker)))
10421 (setq goto nil)))
10422 (setq it (or rfloc
10423 (save-excursion
10424 (org-refile-get-location
10425 (if goto "Goto" "Refile to") default-buffer
10426 org-refile-allow-creating-parent-nodes)))))
10427 (setq file (nth 1 it)
10428 re (nth 2 it)
10429 pos (nth 3 it))
10430 (if (and (not goto)
10431 pos
10432 (equal (buffer-file-name) file)
10433 (if regionp
10434 (and (>= pos region-start)
10435 (<= pos region-end))
10436 (and (>= pos (point))
10437 (< pos (save-excursion
10438 (org-end-of-subtree t t))))))
10439 (error "Cannot refile to position inside the tree or region"))
10441 (setq nbuf (or (find-buffer-visiting file)
10442 (find-file-noselect file)))
10443 (if goto
10444 (progn
10445 (org-pop-to-buffer-same-window nbuf)
10446 (goto-char pos)
10447 (org-show-context 'org-goto))
10448 (if regionp
10449 (progn
10450 (org-kill-new (buffer-substring region-start region-end))
10451 (org-save-markers-in-region region-start region-end))
10452 (org-copy-subtree 1 nil t))
10453 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10454 (find-file-noselect file)))
10455 (setq reversed (org-notes-order-reversed-p))
10456 (save-excursion
10457 (save-restriction
10458 (widen)
10459 (if pos
10460 (progn
10461 (goto-char pos)
10462 (looking-at org-outline-regexp)
10463 (setq level (org-get-valid-level (funcall outline-level) 1))
10464 (goto-char
10465 (if reversed
10466 (or (outline-next-heading) (point-max))
10467 (or (save-excursion (org-get-next-sibling))
10468 (org-end-of-subtree t t)
10469 (point-max)))))
10470 (setq level 1)
10471 (if (not reversed)
10472 (goto-char (point-max))
10473 (goto-char (point-min))
10474 (or (outline-next-heading) (goto-char (point-max)))))
10475 (if (not (bolp)) (newline))
10476 (org-paste-subtree level)
10477 (when org-log-refile
10478 (org-add-log-setup 'refile nil nil 'findpos
10479 org-log-refile)
10480 (unless (eq org-log-refile 'note)
10481 (save-excursion (org-add-log-note))))
10482 (and org-auto-align-tags (org-set-tags nil t))
10483 (bookmark-set "org-refile-last-stored")
10484 ;; If we are refiling for capture, make sure that the
10485 ;; last-capture pointers point here
10486 (when (org-bound-and-true-p org-refile-for-capture)
10487 (bookmark-set "org-capture-last-stored-marker")
10488 (move-marker org-capture-last-stored-marker (point)))
10489 (if (fboundp 'deactivate-mark) (deactivate-mark))
10490 (run-hooks 'org-after-refile-insert-hook))))
10491 (if regionp
10492 (delete-region (point) (+ (point) region-length))
10493 (org-cut-subtree))
10494 (when (featurep 'org-inlinetask)
10495 (org-inlinetask-remove-END-maybe))
10496 (setq org-markers-to-move nil)
10499 (defun org-refile-goto-last-stored ()
10500 "Go to the location where the last refile was stored."
10501 (interactive)
10502 (bookmark-jump "org-refile-last-stored")
10503 (message "This is the location of the last refile"))
10505 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10506 "Prompt the user for a refile location, using PROMPT.
10507 PROMPT should not be suffixed with a colon and a space, because
10508 this function appends the default value from
10509 `org-refile-history' automatically, if that is not empty."
10510 (let ((org-refile-targets org-refile-targets)
10511 (org-refile-use-outline-path org-refile-use-outline-path)
10512 excluded-entries)
10513 (when (and (eq major-mode 'org-mode)
10514 (not org-refile-use-cache))
10515 (org-map-tree
10516 (lambda()
10517 (setq excluded-entries
10518 (append excluded-entries (list (org-get-heading t t)))))))
10519 (setq org-refile-target-table
10520 (org-refile-get-targets default-buffer excluded-entries)))
10521 (unless org-refile-target-table
10522 (error "No refile targets"))
10523 (let* ((prompt (concat prompt
10524 (and (car org-refile-history)
10525 (concat " (default " (car org-refile-history) ")"))
10526 ": "))
10527 (cbuf (current-buffer))
10528 (partial-completion-mode nil)
10529 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10530 (cfunc (if (and org-refile-use-outline-path
10531 org-outline-path-complete-in-steps)
10532 'org-olpath-completing-read
10533 'org-icompleting-read))
10534 (extra (if org-refile-use-outline-path "/" ""))
10535 (filename (and cfn (expand-file-name cfn)))
10536 (tbl (mapcar
10537 (lambda (x)
10538 (if (and (not (member org-refile-use-outline-path
10539 '(file full-file-path)))
10540 (not (equal filename (nth 1 x))))
10541 (cons (concat (car x) extra " ("
10542 (file-name-nondirectory (nth 1 x)) ")")
10543 (cdr x))
10544 (cons (concat (car x) extra) (cdr x))))
10545 org-refile-target-table))
10546 (completion-ignore-case t)
10547 pa answ parent-target child parent old-hist)
10548 (setq old-hist org-refile-history)
10549 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10550 nil 'org-refile-history (car org-refile-history)))
10551 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10552 (org-refile-check-position pa)
10553 (if pa
10554 (progn
10555 (when (or (not org-refile-history)
10556 (not (eq old-hist org-refile-history))
10557 (not (equal (car pa) (car org-refile-history))))
10558 (setq org-refile-history
10559 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10560 org-refile-history
10561 (cdr org-refile-history))))
10562 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10563 (pop org-refile-history)))
10564 pa)
10566 (progn
10567 (setq parent (match-string 1 answ)
10568 child (match-string 2 answ))
10569 (setq parent-target (or (assoc parent tbl)
10570 (assoc (concat parent "/") tbl)))
10571 (when (and parent-target
10572 (or (eq new-nodes t)
10573 (and (eq new-nodes 'confirm)
10575 child)))))
10576 (org-refile-new-child parent-target child)))
10577 (error "Invalid target location")))))
10579 (defun org-refile-check-position (refile-pointer)
10580 "Check if the refile pointer matches the readline to which it points."
10581 (let* ((file (nth 1 refile-pointer))
10582 (re (nth 2 refile-pointer))
10583 (pos (nth 3 refile-pointer))
10584 buffer)
10585 (when (org-string-nw-p re)
10586 (setq buffer (if (markerp pos)
10587 (marker-buffer pos)
10588 (or (find-buffer-visiting file)
10589 (find-file-noselect file))))
10590 (with-current-buffer buffer
10591 (save-excursion
10592 (save-restriction
10593 (widen)
10594 (goto-char pos)
10595 (beginning-of-line 1)
10596 (unless (org-looking-at-p re)
10597 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10599 (defun org-refile-new-child (parent-target child)
10600 "Use refile target PARENT-TARGET to add new CHILD below it."
10601 (unless parent-target
10602 (error "Cannot find parent for new node"))
10603 (let ((file (nth 1 parent-target))
10604 (pos (nth 3 parent-target))
10605 level)
10606 (with-current-buffer (or (find-buffer-visiting file)
10607 (find-file-noselect file))
10608 (save-excursion
10609 (save-restriction
10610 (widen)
10611 (if pos
10612 (goto-char pos)
10613 (goto-char (point-max))
10614 (if (not (bolp)) (newline)))
10615 (when (looking-at org-outline-regexp)
10616 (setq level (funcall outline-level))
10617 (org-end-of-subtree t t))
10618 (org-back-over-empty-lines)
10620 (if pos (org-get-valid-level level 1) 1) ?*)
10622 (beginning-of-line 0)
10623 (list (concat (car parent-target) "/" child) file "" (point)))))))
10625 (defun org-olpath-completing-read (prompt collection &rest args)
10626 "Read an outline path like a file name."
10627 (let ((thetable collection)
10628 (org-completion-use-ido nil) ; does not work with ido.
10629 (org-completion-use-iswitchb nil)) ; or iswitchb
10630 (apply
10631 'org-icompleting-read prompt
10632 (lambda (string predicate &optional flag)
10633 (let (rtn r f (l (length string)))
10634 (cond
10635 ((eq flag nil)
10636 ;; try completion
10637 (try-completion string thetable))
10638 ((eq flag t)
10639 ;; all-completions
10640 (setq rtn (all-completions string thetable predicate))
10641 (mapcar
10642 (lambda (x)
10643 (setq r (substring x l))
10644 (if (string-match " ([^)]*)$" x)
10645 (setq f (match-string 0 x))
10646 (setq f ""))
10647 (if (string-match "/" r)
10648 (concat string (substring r 0 (match-end 0)) f)
10649 x))
10650 rtn))
10651 ((eq flag 'lambda)
10652 ;; exact match?
10653 (assoc string thetable)))
10654 ))
10655 args)))
10657 ;;;; Dynamic blocks
10659 (defun org-find-dblock (name)
10660 "Find the first dynamic block with name NAME in the buffer.
10661 If not found, stay at current position and return nil."
10662 (let (pos)
10663 (save-excursion
10664 (goto-char (point-min))
10666 nil t)
10667 (match-beginning 0))))
10668 (if pos (goto-char pos))
10669 pos))
10671 (defconst org-dblock-start-re
10673 "Matches the start line of a dynamic block, with parameters.")
10676 "Matches the end of a dynamic block.")
10678 (defun org-create-dblock (plist)
10679 "Create a dynamic block section, with parameters taken from PLIST.
10680 PLIST must contain a :name entry which is used as name of the block."
10682 (end-of-line 1)
10683 (newline))
10684 (let ((col (current-column))
10685 (name (plist-get plist :name)))
10686 (insert "#+BEGIN: " name)
10687 (while plist
10688 (if (eq (car plist) :name)
10689 (setq plist (cddr plist))
10690 (insert " " (prin1-to-string (pop plist)))))
10692 (beginning-of-line -2)))
10694 (defun org-prepare-dblock ()
10695 "Prepare dynamic block for refresh.
10696 This empties the block, puts the cursor at the insert position and returns
10697 the property list including an extra property :name with the block name."
10698 (unless (looking-at org-dblock-start-re)
10699 (error "Not at a dynamic block"))
10700 (let* ((begdel (1+ (match-end 0)))
10701 (name (org-no-properties (match-string 1)))
10702 (params (append (list :name name)
10703 (read (concat "(" (match-string 3) ")")))))
10704 (save-excursion
10705 (beginning-of-line 1)
10707 (setq params (plist-put params :indentation-column (current-column))))
10708 (unless (re-search-forward org-dblock-end-re nil t)
10709 (error "Dynamic block not terminated"))
10710 (setq params
10711 (append params
10712 (list :content (buffer-substring
10713 begdel (match-beginning 0)))))
10714 (delete-region begdel (match-beginning 0))
10715 (goto-char begdel)
10716 (open-line 1)
10717 params))
10719 (defun org-map-dblocks (&optional command)
10720 "Apply COMMAND to all dynamic blocks in the current buffer.
10721 If COMMAND is not given, use `org-update-dblock'."
10722 (let ((cmd (or command 'org-update-dblock)))
10723 (save-excursion
10724 (goto-char (point-min))
10725 (while (re-search-forward org-dblock-start-re nil t)
10726 (goto-char (match-beginning 0))
10727 (save-excursion
10728 (condition-case nil
10729 (funcall cmd)
10730 (error (message "Error during update of dynamic block"))))
10731 (unless (re-search-forward org-dblock-end-re nil t)
10732 (error "Dynamic block not terminated"))))))
10734 (defun org-dblock-update (&optional arg)
10735 "User command for updating dynamic blocks.
10736 Update the dynamic block at point. With prefix ARG, update all dynamic
10737 blocks in the buffer."
10738 (interactive "P")
10739 (if arg
10740 (org-update-all-dblocks)
10741 (or (looking-at org-dblock-start-re)
10742 (org-beginning-of-dblock))
10743 (org-update-dblock)))
10745 (defun org-update-dblock ()
10746 "Update the dynamic block at point.
10747 This means to empty the block, parse for parameters and then call
10748 the correct writing function."
10749 (interactive)
10750 (save-window-excursion
10751 (let* ((pos (point))
10752 (line (org-current-line))
10753 (params (org-prepare-dblock))
10754 (name (plist-get params :name))
10755 (indent (plist-get params :indentation-column))
10756 (cmd (intern (concat "org-dblock-write:" name))))
10757 (message "Updating dynamic block `%s' at line %d..." name line)
10758 (funcall cmd params)
10759 (message "Updating dynamic block `%s' at line %d...done" name line)
10760 (goto-char pos)
10761 (when (and indent (> indent 0))
10762 (setq indent (make-string indent ?\ ))
10763 (save-excursion
10764 (org-beginning-of-dblock)
10765 (forward-line 1)
10766 (while (not (looking-at org-dblock-end-re))
10767 (insert indent)
10768 (beginning-of-line 2))
10769 (when (looking-at org-dblock-end-re)
10771 (replace-match ""))
10772 (insert indent)))))))
10774 (defun org-beginning-of-dblock ()
10775 "Find the beginning of the dynamic block at point.
10776 Error if there is no such block at point."
10777 (let ((pos (point))
10778 beg)
10779 (end-of-line 1)
10780 (if (and (re-search-backward org-dblock-start-re nil t)
10781 (setq beg (match-beginning 0))
10782 (re-search-forward org-dblock-end-re nil t)
10783 (> (match-end 0) pos))
10784 (goto-char beg)
10785 (goto-char pos)
10786 (error "Not in a dynamic block"))))
10788 (defun org-update-all-dblocks ()
10789 "Update all dynamic blocks in the buffer.
10790 This function can be used in a hook."
10791 (interactive)
10792 (when (org-mode-p)
10793 (org-map-dblocks 'org-update-dblock)))
10796 ;;;; Completion
10798 (defconst org-additional-option-like-keywords
10799 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10800 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10801 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10802 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10803 "BEGIN:" "END:"
10804 "ORGTBL" "TBLFM:" "TBLNAME:"
10805 "BEGIN_EXAMPLE" "END_EXAMPLE"
10806 "BEGIN_QUOTE" "END_QUOTE"
10807 "BEGIN_VERSE" "END_VERSE"
10808 "BEGIN_CENTER" "END_CENTER"
10809 "BEGIN_SRC" "END_SRC"
10810 "BEGIN_RESULT" "END_RESULT"
10811 "SOURCE:" "SRCNAME:" "FUNCTION:"
10812 "RESULTS:" "DATA:"
10813 "HEADER:" "HEADERS:"
10814 "BABEL:"
10815 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10816 "CAPTION:" "LABEL:"
10817 "SETUPFILE:"
10818 "INCLUDE:"
10819 "BIND:"
10820 "MACRO:"))
10822 (defcustom org-structure-template-alist
10823 '(
10836 ("L" "#+latex: "
10840 ("H" "#+html: "
10843 ("A" "#+ascii: ")
10844 ("i" "#+index: ?"
10845 "#+index: ?")
10846 ("I" "#+include %file ?"
10848 )
10849 "Structure completion elements.
10850 This is a list of abbreviation keys and values. The value gets inserted
10851 if you type `<' followed by the key and then press the completion key,
10852 usually `M-TAB'. %file will be replaced by a file name after prompting
10853 for the file using completion. The cursor will be placed at the position
10854 of the `?` in the template.
10855 There are two templates for each key, the first uses the original Org syntax,
10856 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10857 the default when the /org-mtags.el/ module has been loaded. See also the
10858 variable `org-mtags-prefer-muse-templates'.
10859 This is an experimental feature, it is undecided if it is going to stay in."
10860 :group 'org-completion
10861 :type '(repeat
10862 (string :tag "Key")
10863 (string :tag "Template")
10864 (string :tag "Muse Template")))
10866 (defun org-try-structure-completion ()
10867 "Try to complete a structure template before point.
10869 expands them."
10870 (let ((l (buffer-substring (point-at-bol) (point)))
10871 a)
10874 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10875 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10876 (match-beginning 1)) a)
10877 t)))
10879 (defun org-complete-expand-structure-template (start cell)
10880 "Expand a structure template."
10881 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10882 (rpl (nth (if musep 2 1) cell))
10883 (ind ""))
10884 (delete-region start (point))
10886 (cond
10887 ((bolp))
10889 (setq ind (buffer-substring (point-at-bol) (point))))
10890 (t (newline))))
10891 (setq start (point))
10892 (if (string-match "%file" rpl)
10893 (setq rpl (replace-match
10894 (concat
10896 (save-match-data
10897 (abbreviate-file-name (read-file-name "Include file: ")))
10899 t t rpl)))
10902 (insert rpl)
10905 ;;;; TODO, DEADLINE, Comments
10907 (defun org-toggle-comment ()
10908 "Change the COMMENT state of an entry."
10909 (interactive)
10910 (save-excursion
10911 (org-back-to-heading)
10912 (let (case-fold-search)
10913 (if (looking-at (concat org-outline-regexp
10915 (replace-match "" t t nil 1)
10916 (if (looking-at org-outline-regexp)
10917 (progn
10918 (goto-char (match-end 0))
10919 (insert org-comment-string " ")))))))
10921 (defvar org-last-todo-state-is-todo nil
10922 "This is non-nil when the last TODO state change led to a TODO state.
10923 If the last change removed the TODO tag or switched to DONE, then
10924 this is nil.")
10926 (defvar org-setting-tags nil) ; dynamically skipped
10928 (defvar org-todo-setup-filter-hook nil
10929 "Hook for functions that pre-filter todo specs.
10930 Each function takes a todo spec and returns either nil or the spec
10931 transformed into canonical form." )
10933 (defvar org-todo-get-default-hook nil
10934 "Hook for functions that get a default item for todo.
10935 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10936 nil or a string to be used for the todo mark." )
10938 (defvar org-agenda-headline-snapshot-before-repeat)
10940 (defun org-current-effective-time ()
10941 "Return current time adjusted for `org-extend-today-until' variable"
10942 (let* ((ct (org-current-time))
10943 (dct (decode-time ct))
10944 (ct1
10945 (if (< (nth 2 dct) org-extend-today-until)
10946 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
10947 ct)))
10948 ct1))
10950 (defun org-todo-yesterday (&optional arg)
10951 "Like `org-todo' but the time of change will be 23:59 of yesterday"
10952 (interactive "P")
10953 (let* ((hour (third (decode-time
10954 (org-current-time))))
10955 (org-extend-today-until (1+ hour)))
10956 (org-todo arg)))
10958 (defun org-agenda-todo-yesterday (&optional arg)
10959 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
10960 (interactive "P")
10961 (let* ((hour (third (decode-time
10962 (org-current-time))))
10963 (org-extend-today-until (1+ hour)))
10964 (org-agenda-todo arg)))
10966 (defun org-todo (&optional arg)
10967 "Change the TODO state of an item.
10968 The state of an item is given by a keyword at the start of the heading,
10969 like
10970 *** TODO Write paper
10971 *** DONE Call mom
10973 The different keywords are specified in the variable `org-todo-keywords'.
10975 So for this example: when the item starts with TODO, it is changed to DONE.
10976 When it starts with DONE, the DONE is removed. And when neither TODO nor
10977 DONE are present, add TODO at the beginning of the heading.
10980 state.
10981 With numeric prefix arg, switch to that state.
10983 keywords (nextset).
10986 For calling through lisp, arg is also interpreted in the following way:
10987 'none -> empty state
10989 'done -> switch to DONE
10990 'nextset -> switch to the next set of keywords
10991 'previousset -> switch to the previous set of keywords
10993 really is a member of `org-todo-keywords'."
10994 (interactive "P")
10995 (if (equal arg '(16)) (setq arg 'nextset))
10996 (let ((org-blocker-hook org-blocker-hook)
10997 (case-fold-search nil))
10998 (when (equal arg '(64))
10999 (setq arg nil org-blocker-hook nil))
11000 (when (and org-blocker-hook
11001 (or org-inhibit-blocking
11002 (org-entry-get nil "NOBLOCKING")))
11003 (setq org-blocker-hook nil))
11004 (save-excursion
11005 (catch 'exit
11006 (org-back-to-heading t)
11007 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11009 (looking-at " *"))
11010 (let* ((match-data (match-data))
11011 (startpos (point-at-bol))
11012 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11013 (org-log-done org-log-done)
11014 (org-log-repeat org-log-repeat)
11015 (org-todo-log-states org-todo-log-states)
11016 (this (match-string 1))
11017 (hl-pos (match-beginning 0))
11018 (head (org-get-todo-sequence-head this))
11019 (ass (assoc head org-todo-kwd-alist))
11020 (interpret (nth 1 ass))
11021 (done-word (nth 3 ass))
11022 (final-done-word (nth 4 ass))
11023 (last-state (or this ""))
11024 (completion-ignore-case t)
11025 (member (member this org-todo-keywords-1))
11026 (tail (cdr member))
11027 (state (cond
11028 ((and org-todo-key-trigger
11029 (or (and (equal arg '(4))
11030 (eq org-use-fast-todo-selection 'prefix))
11031 (and (not arg) org-use-fast-todo-selection
11032 (not (eq org-use-fast-todo-selection
11033 'prefix)))))
11034 ;; Use fast selection
11035 (org-fast-todo-selection))
11036 ((and (equal arg '(4))
11037 (or (not org-use-fast-todo-selection)
11038 (not org-todo-key-trigger)))
11039 ;; Read a state with completion
11040 (org-icompleting-read
11041 "State: " (mapcar (lambda(x) (list x))
11042 org-todo-keywords-1)
11043 nil t))
11044 ((eq arg 'right)
11045 (if this
11046 (if tail (car tail) nil)
11047 (car org-todo-keywords-1)))
11048 ((eq arg 'left)
11049 (if (equal member org-todo-keywords-1)
11050 nil
11051 (if this
11052 (nth (- (length org-todo-keywords-1)
11053 (length tail) 2)
11054 org-todo-keywords-1)
11055 (org-last org-todo-keywords-1))))
11056 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11057 (setq arg nil))) ; hack to fall back to cycling
11058 (arg
11059 ;; user or caller requests a specific state
11060 (cond
11061 ((equal arg "") nil)
11062 ((eq arg 'none) nil)
11063 ((eq arg 'done) (or done-word (car org-done-keywords)))
11064 ((eq arg 'nextset)
11065 (or (car (cdr (member head org-todo-heads)))
11066 (car org-todo-heads)))
11067 ((eq arg 'previousset)
11068 (let ((org-todo-heads (reverse org-todo-heads)))
11069 (or (car (cdr (member head org-todo-heads)))
11070 (car org-todo-heads))))
11071 ((car (member arg org-todo-keywords-1)))
11072 ((stringp arg)
11073 (error "State `%s' not valid in this file" arg))
11074 ((nth (1- (prefix-numeric-value arg))
11075 org-todo-keywords-1))))
11076 ((null member) (or head (car org-todo-keywords-1)))
11077 ((equal this final-done-word) nil) ;; -> make empty
11078 ((null tail) nil) ;; -> first entry
11079 ((memq interpret '(type priority))
11080 (if (eq this-command last-command)
11081 (car tail)
11082 (if (> (length tail) 0)
11083 (or done-word (car org-done-keywords))
11084 nil)))
11085 (t
11086 (car tail))))
11087 (state (or
11088 (run-hook-with-args-until-success
11089 'org-todo-get-default-hook state last-state)
11090 state))
11091 (next (if state (concat " " state " ") " "))
11092 (change-plist (list :type 'todo-state-change :from this :to state
11093 :position startpos))
11094 dolog now-done-p)
11095 (when org-blocker-hook
11096 (setq org-last-todo-state-is-todo
11097 (not (member this org-done-keywords)))
11098 (unless (save-excursion
11099 (save-match-data
11100 (org-with-wide-buffer
11101 (run-hook-with-args-until-failure
11102 'org-blocker-hook change-plist))))
11103 (if (org-called-interactively-p 'interactive)
11104 (error "TODO state change from %s to %s blocked" this state)
11105 ;; fail silently
11106 (message "TODO state change from %s to %s blocked" this state)
11107 (throw 'exit nil))))
11108 (store-match-data match-data)
11109 (replace-match next t t)
11110 (unless (pos-visible-in-window-p hl-pos)
11111 (message "TODO state changed to %s" (org-trim next)))
11112 (unless head
11113 (setq head (org-get-todo-sequence-head state)
11114 ass (assoc head org-todo-kwd-alist)
11115 interpret (nth 1 ass)
11116 done-word (nth 3 ass)
11117 final-done-word (nth 4 ass)))
11118 (when (memq arg '(nextset previousset))
11119 (message "Keyword-Set %d/%d: %s"
11120 (- (length org-todo-sets) -1
11121 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11122 (length org-todo-sets)
11123 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11124 (setq org-last-todo-state-is-todo
11125 (not (member state org-done-keywords)))
11126 (setq now-done-p (and (member state org-done-keywords)
11127 (not (member this org-done-keywords))))
11128 (and logging (org-local-logging logging))
11129 (when (and (or org-todo-log-states org-log-done)
11130 (not (eq org-inhibit-logging t))
11131 (not (memq arg '(nextset previousset))))
11132 ;; we need to look at recording a time and note
11133 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11134 (nth 2 (assoc this org-todo-log-states))))
11135 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11136 (setq dolog 'time))
11137 (when (and state
11138 (member state org-not-done-keywords)
11139 (not (member this org-not-done-keywords)))
11140 ;; This is now a todo state and was not one before
11141 ;; If there was a CLOSED time stamp, get rid of it.
11142 (org-add-planning-info nil nil 'closed))
11143 (when (and now-done-p org-log-done)
11144 ;; It is now done, and it was not done before
11145 (org-add-planning-info 'closed (org-current-effective-time))
11146 (if (and (not dolog) (eq 'note org-log-done))
11147 (org-add-log-setup 'done state this 'findpos 'note)))
11148 (when (and state dolog)
11149 ;; This is a non-nil state, and we need to log it
11150 (org-add-log-setup 'state state this 'findpos dolog)))
11151 ;; Fixup tag positioning
11152 (org-todo-trigger-tag-changes state)
11153 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11154 (when org-provide-todo-statistics
11155 (org-update-parent-todo-statistics))
11156 (run-hooks 'org-after-todo-state-change-hook)
11157 (if (and arg (not (member state org-done-keywords)))
11158 (setq head (org-get-todo-sequence-head state)))
11159 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11160 ;; Do we need to trigger a repeat?
11161 (when now-done-p
11162 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11163 ;; This is for the agenda, take a snapshot of the headline.
11164 (save-match-data
11165 (setq org-agenda-headline-snapshot-before-repeat
11166 (org-get-heading))))
11167 (org-auto-repeat-maybe state))
11168 ;; Fixup cursor location if close to the keyword
11169 (if (and (outline-on-heading-p)
11170 (not (bolp))
11171 (save-excursion (beginning-of-line 1)
11172 (looking-at org-todo-line-regexp))
11173 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11174 (progn
11175 (goto-char (or (match-end 2) (match-end 1)))
11176 (and (looking-at " ") (just-one-space))))
11177 (when org-trigger-hook
11178 (save-excursion
11179 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11181 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11182 "Block turning an entry into a TODO, using the hierarchy.
11183 This checks whether the current task should be blocked from state
11184 changes. Such blocking occurs when:
11186 1. The task has children which are not all in a completed state.
11188 2. A task has a parent with the property :ORDERED:, and there
11189 are siblings prior to the current task with incomplete
11190 status.
11192 3. The parent of the task is blocked because it has siblings that should
11193 be done first, or is child of a block grandparent TODO entry."
11195 (if (not org-enforce-todo-dependencies)
11196 t ; if locally turned off don't block
11197 (catch 'dont-block
11198 ;; If this is not a todo state change, or if this entry is already DONE,
11199 ;; do not block
11200 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11201 (member (plist-get change-plist :from)
11202 (cons 'done org-done-keywords))
11203 (member (plist-get change-plist :to)
11204 (cons 'todo org-not-done-keywords))
11205 (not (plist-get change-plist :to)))
11206 (throw 'dont-block t))
11207 ;; If this task has children, and any are undone, it's blocked
11208 (save-excursion
11209 (org-back-to-heading t)
11210 (let ((this-level (funcall outline-level)))
11211 (outline-next-heading)
11212 (let ((child-level (funcall outline-level)))
11213 (while (and (not (eobp))
11214 (> child-level this-level))
11215 ;; this todo has children, check whether they are all
11216 ;; completed
11217 (if (and (not (org-entry-is-done-p))
11218 (org-entry-is-todo-p))
11219 (throw 'dont-block nil))
11220 (outline-next-heading)
11221 (setq child-level (funcall outline-level))))))
11222 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11223 ;; any previous siblings are undone, it's blocked
11224 (save-excursion
11225 (org-back-to-heading t)
11226 (let* ((pos (point))
11227 (parent-pos (and (org-up-heading-safe) (point))))
11228 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11229 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11230 (forward-line 1)
11231 (re-search-forward org-not-done-heading-regexp pos t))
11232 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11233 ;; Search further up the hierarchy, to see if an anchestor is blocked
11234 (while t
11235 (goto-char parent-pos)
11236 (if (not (looking-at org-not-done-heading-regexp))
11237 (throw 'dont-block t)) ; do not block, parent is not a TODO
11238 (setq pos (point))
11239 (setq parent-pos (and (org-up-heading-safe) (point)))
11240 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11241 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11242 (forward-line 1)
11243 (re-search-forward org-not-done-heading-regexp pos t))
11244 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11246 (defcustom org-track-ordered-property-with-tag nil
11247 "Should the ORDERED property also be shown as a tag?
11248 The ORDERED property decides if an entry should require subtasks to be
11249 completed in sequence. Since a property is not very visible, setting
11250 this option means that toggling the ORDERED property with the command
11251 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11252 not relevant for the behavior, but it makes things more visible.
11254 Note that toggling the tag with tags commands will not change the property
11255 and therefore not influence behavior!
11257 This can be t, meaning the tag ORDERED should be used, It can also be a
11258 string to select a different tag for this task."
11259 :group 'org-todo
11260 :type '(choice
11261 (const :tag "No tracking" nil)
11262 (const :tag "Track with ORDERED tag" t)
11263 (string :tag "Use other tag")))
11265 (defun org-toggle-ordered-property ()
11266 "Toggle the ORDERED property of the current entry.
11267 For better visibility, you can track the value of this property with a tag.
11268 See variable `org-track-ordered-property-with-tag'."
11269 (interactive)
11270 (let* ((t1 org-track-ordered-property-with-tag)
11271 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11272 (save-excursion
11273 (org-back-to-heading)
11274 (if (org-entry-get nil "ORDERED")
11275 (progn
11276 (org-delete-property "ORDERED")
11277 (and tag (org-toggle-tag tag 'off))
11278 (message "Subtasks can be completed in arbitrary order"))
11279 (org-entry-put nil "ORDERED" "t")
11280 (and tag (org-toggle-tag tag 'on))
11281 (message "Subtasks must be completed in sequence")))))
11283 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11284 (defun org-block-todo-from-checkboxes (change-plist)
11285 "Block turning an entry into a TODO, using checkboxes.
11286 This checks whether the current task should be blocked from state
11287 changes because there are unchecked boxes in this entry."
11288 (if (not org-enforce-todo-checkbox-dependencies)
11289 t ; if locally turned off don't block
11290 (catch 'dont-block
11291 ;; If this is not a todo state change, or if this entry is already DONE,
11292 ;; do not block
11293 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11294 (member (plist-get change-plist :from)
11295 (cons 'done org-done-keywords))
11296 (member (plist-get change-plist :to)
11297 (cons 'todo org-not-done-keywords))
11298 (not (plist-get change-plist :to)))
11299 (throw 'dont-block t))
11300 ;; If this task has checkboxes that are not checked, it's blocked
11301 (save-excursion
11302 (org-back-to-heading t)
11303 (let ((beg (point)) end)
11304 (outline-next-heading)
11305 (setq end (point))
11306 (goto-char beg)
11308 end t)
11309 (progn
11310 (if (boundp 'org-blocked-by-checkboxes)
11311 (setq org-blocked-by-checkboxes t))
11312 (throw 'dont-block nil)))))
11313 t))) ; do not block
11315 (defun org-entry-blocked-p ()
11316 "Is the current entry blocked?"
11317 (if (org-entry-get nil "NOBLOCKING")
11318 nil ;; Never block this entry
11319 (not
11320 (run-hook-with-args-until-failure
11321 'org-blocker-hook
11322 (list :type 'todo-state-change
11323 :position (point)
11324 :from 'todo
11325 :to 'done)))))
11327 (defun org-update-statistics-cookies (all)
11328 "Update the statistics cookie, either from TODO or from checkboxes.
11329 This should be called with the cursor in a line with a statistics cookie."
11330 (interactive "P")
11331 (if all
11332 (progn
11333 (org-update-checkbox-count 'all)
11334 (org-map-entries 'org-update-parent-todo-statistics))
11335 (if (not (org-on-heading-p))
11336 (org-update-checkbox-count)
11337 (let ((pos (move-marker (make-marker) (point)))
11338 end l1 l2)
11339 (ignore-errors (org-back-to-heading t))
11340 (if (not (org-on-heading-p))
11341 (org-update-checkbox-count)
11342 (setq l1 (org-outline-level))
11343 (setq end (save-excursion
11344 (outline-next-heading)
11345 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11346 (point)))
11347 (if (and (save-excursion
11348 (re-search-forward
11350 (not (save-excursion (re-search-forward
11352 (org-update-checkbox-count)
11353 (if (and l2 (> l2 l1))
11354 (progn
11355 (goto-char end)
11356 (org-update-parent-todo-statistics))
11357 (goto-char pos)
11358 (beginning-of-line 1)
11359 (while (re-search-forward
11361 (point-at-eol) t)
11362 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11363 (goto-char pos)
11364 (move-marker pos nil)))))
11366 (defvar org-entry-property-inherited-from) ;; defined below
11367 (defun org-update-parent-todo-statistics ()
11368 "Update any statistics cookie in the parent of the current headline.
11369 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11370 the entire subtree and this will travel up the hierarchy and update
11371 statistics everywhere."
11372 (let* ((prop (save-excursion (org-up-heading-safe)
11373 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11374 (recursive (or (not org-hierarchical-todo-statistics)
11376 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11377 0))
11378 (first t)
11380 level ltoggle l1 new ndel
11381 (cnt-all 0) (cnt-done 0) is-percent kwd
11382 checkbox-beg ov ovs ove cookie-present)
11383 (catch 'exit
11384 (save-excursion
11385 (beginning-of-line 1)
11386 (setq ltoggle (funcall outline-level))
11387 ;; Three situations are to consider:
11389 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11390 ;; to the top-level ancestor on the headline;
11392 ;; 2. If parent has "recursive" property, repeat up to the
11393 ;; headline setting that property, taking inheritance into
11394 ;; account;
11396 ;; 3. Else, move up to direct parent and proceed only once.
11397 (while (and (setq level (org-up-heading-safe))
11398 (or recursive first)
11399 (>= (point) lim))
11400 (setq first nil cookie-present nil)
11401 (unless (and level
11402 (not (string-match
11404 (downcase (or (org-entry-get nil "COOKIE_DATA")
11405 "")))))
11406 (throw 'exit nil))
11407 (while (re-search-forward box-re (point-at-eol) t)
11408 (setq cnt-all 0 cnt-done 0 cookie-present t)
11409 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11410 (save-match-data
11411 (unless (outline-next-heading) (throw 'exit nil))
11412 (while (and (looking-at org-complex-heading-regexp)
11413 (> (setq l1 (length (match-string 1))) level))
11414 (setq kwd (and (or recursive (= l1 ltoggle))
11415 (match-string 2)))
11416 (if (or (eq org-provide-todo-statistics 'all-headlines)
11417 (and (listp org-provide-todo-statistics)
11418 (or (member kwd org-provide-todo-statistics)
11419 (member kwd org-done-keywords))))
11420 (setq cnt-all (1+ cnt-all))
11421 (if (eq org-provide-todo-statistics t)
11422 (and kwd (setq cnt-all (1+ cnt-all)))))
11423 (and (member kwd org-done-keywords)
11424 (setq cnt-done (1+ cnt-done)))
11425 (outline-next-heading)))
11426 (setq new
11427 (if is-percent
11428 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11429 (format "[%d/%d]" cnt-done cnt-all))
11430 ndel (- (match-end 0) checkbox-beg))
11431 ;; handle overlays when updating cookie from column view
11432 (when (setq ov (car (overlays-at checkbox-beg)))
11433 (setq ovs (overlay-start ov) ove (overlay-end ov))
11434 (delete-overlay ov))
11435 (goto-char checkbox-beg)
11436 (insert new)
11437 (delete-region (point) (+ (point) ndel))
11438 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11439 (when ov (move-overlay ov ovs ove)))
11440 (when cookie-present
11441 (run-hook-with-args 'org-after-todo-statistics-hook
11442 cnt-done (- cnt-all cnt-done))))))
11443 (run-hooks 'org-todo-statistics-hook)))
11445 (defvar org-after-todo-statistics-hook nil
11446 "Hook that is called after a TODO statistics cookie has been updated.
11447 Each function is called with two arguments: the number of not-done entries
11448 and the number of done entries.
11450 For example, the following function, when added to this hook, will switch
11451 an entry to DONE when all children are done, and back to TODO when new
11452 entries are set to a TODO status. Note that this hook is only called
11453 when there is a statistics cookie in the headline!
11455 (defun org-summary-todo (n-done n-not-done)
11457 (let (org-log-done org-log-states) ; turn off logging
11459 ")
11461 (defvar org-todo-statistics-hook nil
11462 "Hook that is run whenever Org thinks TODO statistics should be updated.
11463 This hook runs even if there is no statistics cookie present, in which case
11464 `org-after-todo-statistics-hook' would not run.")
11466 (defun org-todo-trigger-tag-changes (state)
11467 "Apply the changes defined in `org-todo-state-tags-triggers'."
11468 (let ((l org-todo-state-tags-triggers)
11469 changes)
11470 (when (or (not state) (equal state ""))
11471 (setq changes (append changes (cdr (assoc "" l)))))
11472 (when (and (stringp state) (> (length state) 0))
11473 (setq changes (append changes (cdr (assoc state l)))))
11474 (when (member state org-not-done-keywords)
11475 (setq changes (append changes (cdr (assoc 'todo l)))))
11476 (when (member state org-done-keywords)
11477 (setq changes (append changes (cdr (assoc 'done l)))))
11478 (dolist (c changes)
11479 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11481 (defun org-local-logging (value)
11482 "Get logging settings from a property VALUE."
11483 (let* (words w a)
11484 ;; directly set the variables, they are already local.
11485 (setq org-log-done nil
11486 org-log-repeat nil
11487 org-todo-log-states nil)
11488 (setq words (org-split-string value))
11489 (while (setq w (pop words))
11490 (cond
11491 ((setq a (assoc w org-startup-options))
11492 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11493 (set (nth 1 a) (nth 2 a))))
11494 ((setq a (org-extract-log-state-settings w))
11495 (and (member (car a) org-todo-keywords-1)
11496 (push a org-todo-log-states)))))))
11498 (defun org-get-todo-sequence-head (kwd)
11499 "Return the head of the TODO sequence to which KWD belongs.
11500 If KWD is not set, check if there is a text property remembering the
11501 right sequence."
11502 (let (p)
11503 (cond
11504 ((not kwd)
11505 (or (get-text-property (point-at-bol) 'org-todo-head)
11506 (progn
11507 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11508 nil (point-at-eol)))
11509 (get-text-property p 'org-todo-head))))
11510 ((not (member kwd org-todo-keywords-1))
11511 (car org-todo-keywords-1))
11512 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11514 (defun org-fast-todo-selection ()
11515 "Fast TODO keyword selection with single keys.
11516 Returns the new TODO keyword, or nil if no state change should occur."
11517 (let* ((fulltable org-todo-key-alist)
11518 (done-keywords org-done-keywords) ;; needed for the faces.
11519 (maxlen (apply 'max (mapcar
11520 (lambda (x)
11521 (if (stringp (car x)) (string-width (car x)) 0))
11522 fulltable)))
11523 (expert nil)
11524 (fwidth (+ maxlen 3 1 3))
11525 (ncol (/ (- (window-width) 4) fwidth))
11526 tg cnt e c tbl
11527 groups ingroup)
11528 (save-excursion
11529 (save-window-excursion
11530 (if expert
11531 (set-buffer (get-buffer-create " *Org todo*"))
11532 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11533 (erase-buffer)
11534 (org-set-local 'org-done-keywords done-keywords)
11535 (setq tbl fulltable cnt 0)
11536 (while (setq e (pop tbl))
11537 (cond
11538 ((equal e '(:startgroup))
11539 (push '() groups) (setq ingroup t)
11540 (when (not (= cnt 0))
11541 (setq cnt 0)
11543 (insert "{ "))
11544 ((equal e '(:endgroup))
11545 (setq ingroup nil cnt 0)
11547 ((equal e '(:newline))
11548 (when (not (= cnt 0))
11549 (setq cnt 0)
11551 (setq e (car tbl))
11552 (while (equal (car tbl) '(:newline))
11554 (setq tbl (cdr tbl)))))
11555 (t
11556 (setq tg (car e) c (cdr e))
11557 (if ingroup (push tg (car groups)))
11558 (setq tg (org-add-props tg nil 'face
11559 (org-get-todo-face tg)))
11560 (if (and (= cnt 0) (not ingroup)) (insert " "))
11561 (insert "[" c "] " tg (make-string
11562 (- fwidth 4 (length tg)) ?\ ))
11563 (when (= (setq cnt (1+ cnt)) ncol)
11565 (if ingroup (insert " "))
11566 (setq cnt 0)))))
11568 (goto-char (point-min))
11569 (if (not expert) (org-fit-window-to-buffer))
11570 (message "[a-z..]:Set [SPC]:clear")
11571 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11572 (cond
11573 ((or (= c ?\C-g)
11574 (and (= c ?q) (not (rassoc c fulltable))))
11575 (setq quit-flag t))
11576 ((= c ?\ ) nil)
11577 ((setq e (rassoc c fulltable) tg (car e))
11578 tg)
11579 (t (setq quit-flag t)))))))
11581 (defun org-entry-is-todo-p ()
11582 (member (org-get-todo-state) org-not-done-keywords))
11584 (defun org-entry-is-done-p ()
11585 (member (org-get-todo-state) org-done-keywords))
11587 (defun org-get-todo-state ()
11588 (save-excursion
11589 (org-back-to-heading t)
11590 (and (looking-at org-todo-line-regexp)
11591 (match-end 2)
11592 (match-string 2))))
11594 (defun org-at-date-range-p (&optional inactive-ok)
11595 "Is the cursor inside a date range?"
11596 (interactive)
11597 (save-excursion
11598 (catch 'exit
11599 (let ((pos (point)))
11601 (skip-chars-backward "<[")
11602 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11603 (>= (match-end 0) pos)
11604 (throw 'exit t))
11606 (skip-chars-backward "<[")
11607 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11608 (>= (match-end 0) pos)
11609 (throw 'exit t)))
11610 nil)))
11612 (defun org-get-repeat (&optional tagline)
11613 "Check if there is a deadline/schedule with repeater in this entry."
11614 (save-match-data
11615 (save-excursion
11616 (org-back-to-heading t)
11617 (and (re-search-forward (if tagline
11619 org-repeat-re)
11620 (org-entry-end-position) t)
11621 (match-string-no-properties 1)))))
11623 (defvar org-last-changed-timestamp)
11624 (defvar org-last-inserted-timestamp)
11625 (defvar org-log-post-message)
11626 (defvar org-log-note-purpose)
11627 (defvar org-log-note-how)
11628 (defvar org-log-note-extra)
11629 (defun org-auto-repeat-maybe (done-word)
11630 "Check if the current headline contains a repeated deadline/schedule.
11631 If yes, set TODO state back to what it was and change the base date
11632 of repeating deadline/scheduled time stamps to new date.
11633 This function is run automatically after each state change to a DONE state."
11634 ;; last-state is dynamically scoped into this function
11635 (let* ((repeat (org-get-repeat))
11636 (aa (assoc last-state org-todo-kwd-alist))
11637 (interpret (nth 1 aa))
11638 (head (nth 2 aa))
11639 (whata '(("d" . day) ("m" . month) ("y" . year)))
11640 (msg "Entry repeats: ")
11641 (org-log-done nil)
11642 (org-todo-log-states nil)
11643 re type n what ts time to-state)
11644 (when repeat
11645 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11646 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11647 org-todo-repeat-to-state))
11648 (unless (and to-state (member to-state org-todo-keywords-1))
11649 (setq to-state (if (eq interpret 'type) last-state head)))
11650 (org-todo to-state)
11651 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11652 (org-entry-put nil "LAST_REPEAT" (format-time-string
11653 (org-time-stamp-format t t))))
11654 (when org-log-repeat
11655 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11656 (memq 'org-add-log-note post-command-hook))
11657 ;; OK, we are already setup for some record
11658 (if (eq org-log-repeat 'note)
11659 ;; make sure we take a note, not only a time stamp
11660 (setq org-log-note-how 'note))
11661 ;; Set up for taking a record
11662 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11663 last-state
11664 'findpos org-log-repeat)))
11665 (org-back-to-heading t)
11666 (org-add-planning-info nil nil 'closed)
11670 (while (re-search-forward
11671 re (save-excursion (outline-next-heading) (point)) t)
11672 (setq type (if (match-end 1) org-scheduled-string
11673 (if (match-end 3) org-deadline-string "Plain:"))
11674 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11676 (setq n (string-to-number (match-string 2 ts))
11677 what (match-string 3 ts))
11678 (if (equal what "w") (setq n (* n 7) what "d"))
11679 ;; Preparation, see if we need to modify the start date for the change
11680 (when (match-end 1)
11681 (setq time (save-match-data (org-time-string-to-time ts)))
11682 (cond
11683 ((equal (match-string 1 ts) ".")
11684 ;; Shift starting date to today
11685 (org-timestamp-change
11686 (- (org-today) (time-to-days time))
11687 'day))
11688 ((equal (match-string 1 ts) "+")
11689 (let ((nshiftmax 10) (nshift 0))
11690 (while (or (= nshift 0)
11691 (<= (time-to-days time)
11692 (time-to-days (current-time))))
11693 (when (= (incf nshift) nshiftmax)
11694 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11695 (error "Abort")))
11696 (org-timestamp-change n (cdr (assoc what whata)))
11697 (org-at-timestamp-p t)
11698 (setq ts (match-string 1))
11699 (setq time (save-match-data (org-time-string-to-time ts)))))
11700 (org-timestamp-change (- n) (cdr (assoc what whata)))
11701 ;; rematch, so that we have everything in place for the real shift
11702 (org-at-timestamp-p t)
11703 (setq ts (match-string 1))
11705 (org-timestamp-change n (cdr (assoc what whata)))
11706 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11707 (setq org-log-post-message msg)
11708 (message "%s" msg))))
11710 (defun org-show-todo-tree (arg)
11711 "Make a compact tree which shows all headlines marked with TODO.
11712 The tree will show the lines where the regexp matches, and all higher
11713 headlines above the match.
11715 With a numeric prefix N, construct a sparse tree for the Nth element
11716 of `org-todo-keywords-1'."
11717 (interactive "P")
11718 (let ((case-fold-search nil)
11719 (kwd-re
11720 (cond ((null arg) org-not-done-regexp)
11721 ((equal arg '(4))
11722 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11723 (mapcar 'list org-todo-keywords-1))))
11727 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11728 (regexp-quote (nth (1- (prefix-numeric-value arg))
11729 org-todo-keywords-1)))
11730 (t (error "Invalid prefix argument: %s" arg)))))
11731 (message "%d TODO entries found"
11732 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11734 (defun org-deadline (&optional remove time)
11736 With argument REMOVE, remove any deadline from the item.
11737 With argument TIME, set the deadline at the corresponding date. TIME
11739 (interactive "P")
11740 (org-loop-over-siblings-in-active-region
11741 (let* ((old-date (org-entry-get nil "DEADLINE"))
11742 (repeater (and old-date
11743 (string-match
11745 old-date)
11746 (match-string 1 old-date))))
11747 (if remove
11748 (progn
11749 (when (and old-date org-log-redeadline)
11750 (org-add-log-setup 'deldeadline nil old-date 'findpos
11751 org-log-redeadline))
11752 (org-remove-timestamp-with-keyword org-deadline-string)
11753 (message "Item no longer has a deadline."))
11754 (org-add-planning-info 'deadline time 'closed)
11755 (when (and old-date org-log-redeadline
11756 (not (equal old-date
11757 (substring org-last-inserted-timestamp 1 -1))))
11758 (org-add-log-setup 'redeadline nil old-date 'findpos
11759 org-log-redeadline))
11760 (when repeater
11761 (save-excursion
11762 (org-back-to-heading t)
11763 (when (re-search-forward (concat org-deadline-string " "
11764 org-last-inserted-timestamp)
11765 (save-excursion
11766 (outline-next-heading) (point)) t)
11767 (goto-char (1- (match-end 0)))
11768 (insert " " repeater)
11769 (setq org-last-inserted-timestamp
11770 (concat (substring org-last-inserted-timestamp 0 -1)
11771 " " repeater
11772 (substring org-last-inserted-timestamp -1))))))
11773 (message "Deadline on %s" org-last-inserted-timestamp)))))
11775 (defun org-schedule (&optional remove time)
11776 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11777 With argument REMOVE, remove any scheduling date from the item.
11778 With argument TIME, scheduled at the corresponding date. TIME can
11780 (interactive "P")
11781 (org-loop-over-siblings-in-active-region
11782 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11783 (repeater (and old-date
11784 (string-match
11786 old-date)
11787 (match-string 1 old-date))))
11788 (if remove
11789 (progn
11790 (when (and old-date org-log-reschedule)
11791 (org-add-log-setup 'delschedule nil old-date 'findpos
11792 org-log-reschedule))
11793 (org-remove-timestamp-with-keyword org-scheduled-string)
11794 (message "Item is no longer scheduled."))
11795 (org-add-planning-info 'scheduled time 'closed)
11796 (when (and old-date org-log-reschedule
11797 (not (equal old-date
11798 (substring org-last-inserted-timestamp 1 -1))))
11799 (org-add-log-setup 'reschedule nil old-date 'findpos
11800 org-log-reschedule))
11801 (when repeater
11802 (save-excursion
11803 (org-back-to-heading t)
11804 (when (re-search-forward (concat org-scheduled-string " "
11805 org-last-inserted-timestamp)
11806 (save-excursion
11807 (outline-next-heading) (point)) t)
11808 (goto-char (1- (match-end 0)))
11809 (insert " " repeater)
11810 (setq org-last-inserted-timestamp
11811 (concat (substring org-last-inserted-timestamp 0 -1)
11812 " " repeater
11813 (substring org-last-inserted-timestamp -1))))))
11814 (message "Scheduled to %s" org-last-inserted-timestamp)))))
11816 (defun org-get-scheduled-time (pom &optional inherit)
11817 "Get the scheduled time as a time tuple, of a format suitable
11818 for calling org-schedule with, or if there is no scheduling,
11819 returns nil."
11820 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11821 (when time
11822 (apply 'encode-time (org-parse-time-string time)))))
11824 (defun org-get-deadline-time (pom &optional inherit)
11825 "Get the deadline as a time tuple, of a format suitable for
11826 calling org-deadline with, or if there is no scheduling, returns
11827 nil."
11828 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11829 (when time
11830 (apply 'encode-time (org-parse-time-string time)))))
11832 (defun org-remove-timestamp-with-keyword (keyword)
11833 "Remove all time stamps with KEYWORD in the current entry."
11835 beg)
11836 (save-excursion
11837 (org-back-to-heading t)
11838 (setq beg (point))
11839 (outline-next-heading)
11840 (while (re-search-backward re beg t)
11841 (replace-match "")
11843 (equal (char-before) ?\ ))
11844 (backward-delete-char 1)
11846 (point-at-bol) (point-at-eol)))
11847 (delete-region (point-at-bol)
11848 (min (point-max) (1+ (point-at-eol))))))))))
11850 (defun org-add-planning-info (what &optional time &rest remove)
11851 "Insert new timestamp with keyword in the line directly after the headline.
11852 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
11853 If non is given, the user is prompted for a date.
11854 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11855 be removed."
11856 (interactive)
11857 (let (org-time-was-given org-end-time-was-given ts
11858 end default-time default-input)
11860 (catch 'exit
11861 (when (and (memq what '(scheduled deadline))
11862 (or (not time)
11863 (and (stringp time)
11864 (string-match "^[-+]+[0-9]" time))))
11865 ;; Try to get a default date/time from existing timestamp
11866 (save-excursion
11867 (org-back-to-heading t)
11868 (setq end (save-excursion (outline-next-heading) (point)))
11869 (when (re-search-forward (if (eq what 'scheduled)
11870 org-scheduled-time-regexp
11871 org-deadline-time-regexp)
11872 end t)
11873 (setq ts (match-string 1)
11874 default-time
11875 (apply 'encode-time (org-parse-time-string ts))
11876 default-input (and ts (org-get-compact-tod ts))))))
11877 (when what
11878 (setq time
11879 (if (and (stringp time)
11880 (string-match "^[-+]+[0-9]" time))
11881 ;; This is a relative time, set the proper date
11882 (apply 'encode-time
11883 (org-read-date-analyze
11884 time default-time (decode-time default-time)))
11885 ;; If necessary, get the time from the user
11886 (or time (org-read-date nil 'to-time nil nil
11887 default-time default-input)))))
11889 (when (and org-insert-labeled-timestamps-at-point
11890 (member what '(scheduled deadline)))
11891 (insert
11892 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11893 (org-insert-time-stamp time org-time-was-given
11894 nil nil nil (list org-end-time-was-given))
11895 (setq what nil))
11896 (save-excursion
11897 (save-restriction
11898 (let (col list elt ts buffer-invisibility-spec)
11899 (org-back-to-heading t)
11901 (goto-char (match-end 1))
11902 (setq col (current-column))
11903 (goto-char (match-end 0))
11905 (when (and (not what)
11906 (not (looking-at
11908 org-keyword-time-not-clock-regexp))))
11909 ;; Nothing to add, nothing to remove...... :-)
11910 (throw 'exit nil))
11911 (if (and (not (looking-at org-outline-regexp))
11914 (not (equal (match-string 1) org-clock-string)))
11915 (narrow-to-region (match-beginning 0) (match-end 0))
11917 (backward-char 1)
11918 (narrow-to-region (point) (point))
11919 (and org-adapt-indentation (org-indent-to-column col)))
11920 ;; Check if we have to remove something.
11921 (setq list (cons what remove))
11922 (while list
11923 (setq elt (pop list))
11924 (when (or (and (eq elt 'scheduled)
11925 (re-search-forward org-scheduled-time-regexp nil t))
11926 (and (eq elt 'deadline)
11927 (re-search-forward org-deadline-time-regexp nil t))
11928 (and (eq elt 'closed)
11929 (re-search-forward org-closed-time-regexp nil t)))
11930 (replace-match "")
11931 (if (looking-at "--+<[^>]+>") (replace-match ""))))
11933 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11934 (when what
11935 (insert
11936 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11937 (cond ((eq what 'scheduled) org-scheduled-string)
11938 ((eq what 'deadline) org-deadline-string)
11939 ((eq what 'closed) org-closed-string))
11940 " ")
11941 (setq ts (org-insert-time-stamp
11942 time
11943 (or org-time-was-given
11944 (and (eq what 'closed) org-log-done-with-time))
11945 (eq what 'closed)
11946 nil nil (list org-end-time-was-given)))
11947 (insert
11948 (if (not (or (bolp) (eq (char-before) ?\ )
11949 (memq (char-after) '(32 10))
11950 (eobp))) " " ""))
11951 (end-of-line 1))
11952 (goto-char (point-min))
11953 (widen)
11956 (delete-region (1- (point)) (point-at-eol)))
11957 ts))))))
11959 (defvar org-log-note-marker (make-marker))
11960 (defvar org-log-note-purpose nil)
11961 (defvar org-log-note-state nil)
11962 (defvar org-log-note-previous-state nil)
11963 (defvar org-log-note-how nil)
11964 (defvar org-log-note-extra nil)
11965 (defvar org-log-note-window-configuration nil)
11966 (defvar org-log-note-return-to (make-marker))
11967 (defvar org-log-note-effective-time nil
11968 "Remembered current time so that dynamically scoped
11969 `org-extend-today-until' affects tha timestamps in state change
11970 log")
11972 (defvar org-log-post-message nil
11973 "Message to be displayed after a log note has been stored.
11974 The auto-repeater uses this.")
11976 (defun org-add-note ()
11977 "Add a note to the current entry.
11978 This is done in the same way as adding a state change note."
11979 (interactive)
11980 (org-add-log-setup 'note nil nil 'findpos nil))
11982 (defvar org-property-end-re)
11983 (defun org-add-log-setup (&optional purpose state prev-state
11984 findpos how extra)
11985 "Set up the post command hook to take a note.
11986 If this is about to TODO state change, the new state is expected in STATE.
11987 When FINDPOS is non-nil, find the correct position for the note in
11988 the current entry. If not, assume that it can be inserted at point.
11989 HOW is an indicator what kind of note should be created.
11990 EXTRA is additional text that will be inserted into the notes buffer."
11991 (let* ((org-log-into-drawer (org-log-into-drawer))
11992 (drawer (cond ((stringp org-log-into-drawer)
11993 org-log-into-drawer)
11994 (org-log-into-drawer "LOGBOOK")
11995 (t nil))))
11996 (save-restriction
11997 (save-excursion
11998 (when findpos
11999 (org-back-to-heading t)
12000 (narrow-to-region (point) (save-excursion
12001 (outline-next-heading) (point)))
12005 (goto-char (match-end 0))
12006 (cond
12007 (drawer
12009 nil t)
12010 (progn
12011 (goto-char (match-end 0))
12012 (or org-log-states-order-reversed
12013 (and (re-search-forward org-property-end-re nil t)
12014 (goto-char (1- (match-beginning 0))))))
12016 (beginning-of-line 0)
12017 (org-indent-line-function)
12018 (beginning-of-line 2)
12019 (org-indent-line-function)
12020 (end-of-line 0)))
12021 ((and org-log-state-notes-insert-after-drawers
12022 (save-excursion
12023 (forward-line) (looking-at org-drawer-regexp)))
12024 (forward-line)
12025 (while (looking-at org-drawer-regexp)
12026 (goto-char (match-end 0))
12027 (re-search-forward org-property-end-re (point-max) t)
12028 (forward-line))
12029 (forward-line -1)))
12030 (unless org-log-states-order-reversed
12032 (org-skip-over-state-notes)
12034 (move-marker org-log-note-marker (point))
12035 (setq org-log-note-purpose purpose
12036 org-log-note-state state
12037 org-log-note-previous-state prev-state
12038 org-log-note-how how
12039 org-log-note-extra extra
12040 org-log-note-effective-time (org-current-effective-time))
12041 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12043 (defun org-skip-over-state-notes ()
12044 "Skip past the list of State notes in an entry."
12046 (when (ignore-errors (goto-char (org-in-item-p)))
12047 (let* ((struct (org-list-struct))
12048 (prevs (org-list-prevs-alist struct)))
12050 (goto-char (or (org-list-get-next-item (point) struct prevs)
12051 (org-list-get-item-end (point) struct)))))))
12053 (defun org-add-log-note (&optional purpose)
12054 "Pop up a window for taking a note, and add this note later at point."
12055 (remove-hook 'post-command-hook 'org-add-log-note)
12056 (setq org-log-note-window-configuration (current-window-configuration))
12057 (delete-other-windows)
12058 (move-marker org-log-note-return-to (point))
12059 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12060 (goto-char org-log-note-marker)
12061 (org-switch-to-buffer-other-window "*Org Note*")
12062 (erase-buffer)
12063 (if (memq org-log-note-how '(time state))
12064 (let (current-prefix-arg) (org-store-log-note))
12065 (let ((org-inhibit-startup t)) (org-mode))
12066 (insert (format "# Insert note for %s.
12068 (cond
12069 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12070 ((eq org-log-note-purpose 'done) "closed todo item")
12071 ((eq org-log-note-purpose 'state)
12073 (or org-log-note-previous-state "")
12074 (or org-log-note-state "")))
12075 ((eq org-log-note-purpose 'reschedule)
12076 "rescheduling")
12077 ((eq org-log-note-purpose 'delschedule)
12078 "no longer scheduled")
12079 ((eq org-log-note-purpose 'redeadline)
12080 "changing deadline")
12081 ((eq org-log-note-purpose 'deldeadline)
12082 "removing deadline")
12083 ((eq org-log-note-purpose 'refile)
12084 "refiling")
12085 ((eq org-log-note-purpose 'note)
12086 "this entry")
12087 (t (error "This should not happen")))))
12088 (if org-log-note-extra (insert org-log-note-extra))
12089 (org-set-local 'org-finish-function 'org-store-log-note)))
12091 (defvar org-note-abort nil) ; dynamically scoped
12092 (defun org-store-log-note ()
12093 "Finish taking a log note, and insert it to where it belongs."
12094 (let ((txt (buffer-string))
12095 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12096 lines ind bul)
12097 (kill-buffer (current-buffer))
12099 (setq txt (replace-match "" t t txt)))
12101 (setq txt (replace-match "" t t txt)))
12104 (setq note
12105 (org-replace-escapes
12106 note
12107 (list (cons "%u" (user-login-name))
12108 (cons "%U" user-full-name)
12109 (cons "%t" (format-time-string
12110 (org-time-stamp-format 'long 'inactive)
12111 org-log-note-effective-time))
12112 (cons "%T" (format-time-string
12113 (org-time-stamp-format 'long nil)
12114 org-log-note-effective-time))
12115 (cons "%s" (if org-log-note-state
12117 ""))
12118 (cons "%S" (if org-log-note-previous-state
12122 (push note lines))
12123 (when (or current-prefix-arg org-note-abort)
12124 (when org-log-into-drawer
12125 (org-remove-empty-drawer-at
12126 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12127 org-log-note-marker))
12128 (setq lines nil))
12129 (when lines
12130 (with-current-buffer (marker-buffer org-log-note-marker)
12131 (save-excursion
12132 (goto-char org-log-note-marker)
12133 (move-marker org-log-note-marker nil)
12134 (end-of-line 1)
12136 (setq ind (save-excursion
12137 (if (ignore-errors (goto-char (org-in-item-p)))
12138 (let ((struct (org-list-struct)))
12139 (org-list-get-ind
12140 (org-list-get-top-point struct) struct))
12142 (cond
12143 ((and (org-at-heading-p)
12144 org-adapt-indentation)
12145 (1+ (org-current-level)))
12146 ((org-at-heading-p) 0)
12147 (t (org-get-indentation))))))
12148 (setq bul (org-list-bullet-string "-"))
12149 (org-indent-line-to ind)
12150 (insert bul (pop lines))
12151 (let ((ind-body (+ (length bul) ind)))
12152 (while lines
12154 (org-indent-line-to ind-body)
12155 (insert (pop lines))))
12156 (message "Note stored")
12157 (org-back-to-heading t)
12158 (org-cycle-hide-drawers 'children)))))
12159 (set-window-configuration org-log-note-window-configuration)
12160 (with-current-buffer (marker-buffer org-log-note-return-to)
12161 (goto-char org-log-note-return-to))
12162 (move-marker org-log-note-return-to nil)
12163 (and org-log-post-message (message "%s" org-log-post-message)))
12165 (defun org-remove-empty-drawer-at (drawer pos)
12166 "Remove an empty drawer DRAWER at position POS.
12167 POS may also be a marker."
12168 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12169 (save-excursion
12170 (save-restriction
12171 (widen)
12172 (goto-char pos)
12173 (if (org-in-regexp
12175 (replace-match ""))))))
12177 (defun org-sparse-tree (&optional arg)
12178 "Create a sparse tree, prompt for the details.
12179 This command can create sparse trees. You first need to select the type
12180 of match used to create the tree:
12182 t Show all TODO entries.
12183 T Show entries with a specific TODO keyword.
12184 m Show entries selected by a tags/property match.
12185 p Enter a property name and its value (both with completion on existing
12186 names/values) and show entries with that property.
12187 r Show entries matching a regular expression (`/' can be used as well)
12188 d Show deadlines due within `org-deadline-warning-days'.
12189 b Show deadlines and scheduled items before a date.
12190 a Show deadlines and scheduled items after a date."
12191 (interactive "P")
12192 (let (ans kwd value)
12193 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12194 (setq ans (read-char-exclusive))
12195 (cond
12196 ((equal ans ?d)
12197 (call-interactively 'org-check-deadlines))
12198 ((equal ans ?b)
12199 (call-interactively 'org-check-before-date))
12200 ((equal ans ?a)
12201 (call-interactively 'org-check-after-date))
12202 ((equal ans ?t)
12203 (org-show-todo-tree nil))
12204 ((equal ans ?T)
12205 (org-show-todo-tree '(4)))
12206 ((member ans '(?T ?m))
12207 (call-interactively 'org-match-sparse-tree))
12208 ((member ans '(?p ?P))
12209 (setq kwd (org-icompleting-read "Property: "
12210 (mapcar 'list (org-buffer-property-keys))))
12211 (setq value (org-icompleting-read "Value: "
12212 (mapcar 'list (org-property-values kwd))))
12215 (org-match-sparse-tree arg (concat kwd "=" value)))
12216 ((member ans '(?r ?R ?/))
12217 (call-interactively 'org-occur))
12220 (defvar org-occur-highlights nil
12221 "List of overlays used for occur matches.")
12222 (make-variable-buffer-local 'org-occur-highlights)
12223 (defvar org-occur-parameters nil
12224 "Parameters of the active org-occur calls.
12225 This is a list, each call to org-occur pushes as cons cell,
12226 containing the regular expression and the callback, onto the list.
12227 The list can contain several entries if `org-occur' has been called
12228 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12229 will only contain one set of parameters. When the highlights are
12230 removed (for example with `C-c C-c', or with the next edit (depending
12231 on `org-remove-highlights-with-change'), this variable is emptied
12232 as well.")
12233 (make-variable-buffer-local 'org-occur-parameters)
12235 (defun org-occur (regexp &optional keep-previous callback)
12236 "Make a compact tree which shows all matches of REGEXP.
12237 The tree will show the lines where the regexp matches, and all higher
12238 headlines above the match. It will also show the heading after the match,
12239 to make sure editing the matching entry is easy.
12240 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12241 call to `org-occur' will be kept, to allow stacking of calls to this
12242 command.
12243 If CALLBACK is non-nil, it is a function which is called to confirm
12244 that the match should indeed be shown."
12246 (when (equal regexp "")
12247 (error "Regexp cannot be empty"))
12248 (unless keep-previous
12249 (org-remove-occur-highlights nil nil t))
12250 (push (cons regexp callback) org-occur-parameters)
12251 (let ((cnt 0))
12252 (save-excursion
12253 (goto-char (point-min))
12254 (if (or (not keep-previous) ; do not want to keep
12255 (not org-occur-highlights)) ; no previous matches
12256 ;; hide everything
12257 (org-overview))
12258 (while (re-search-forward regexp nil t)
12259 (when (or (not callback)
12260 (save-match-data (funcall callback)))
12261 (setq cnt (1+ cnt))
12262 (when org-highlight-sparse-tree-matches
12263 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12264 (org-show-context 'occur-tree))))
12265 (when org-remove-highlights-with-change
12266 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12267 nil 'local))
12268 (unless org-sparse-tree-open-archived-trees
12269 (org-hide-archived-subtrees (point-min) (point-max)))
12270 (run-hooks 'org-occur-hook)
12271 (if (org-called-interactively-p 'interactive)
12272 (message "%d match(es) for regexp %s" cnt regexp))
12273 cnt))
12275 (defun org-occur-next-match (&optional n reset)
12276 "Function for `next-error-function' to find sparse tree matches.
12277 N is the number of matches to move, when negative move backwards.
12278 RESET is entirely ignored - this function always goes back to the
12279 starting point when no match is found."
12280 (let* ((limit (if (< n 0) (point-min) (point-max)))
12281 (search-func (if (< n 0)
12282 'previous-single-char-property-change
12283 'next-single-char-property-change))
12284 (n (abs n))
12285 (pos (point))
12286 p1)
12287 (catch 'exit
12288 (while (setq p1 (funcall search-func (point) 'org-type))
12289 (when (equal p1 limit)
12290 (goto-char pos)
12291 (error "No more matches"))
12292 (when (equal (get-char-property p1 'org-type) 'org-occur)
12293 (setq n (1- n))
12294 (when (= n 0)
12295 (goto-char p1)
12296 (throw 'exit (point))))
12297 (goto-char p1))
12298 (goto-char p1)
12299 (error "No more matches"))))
12301 (defun org-show-context (&optional key)
12302 "Make sure point and context are visible.
12303 How much context is shown depends upon the variables
12304 `org-show-hierarchy-above', `org-show-following-heading'. and
12305 `org-show-siblings'."
12306 (let ((heading-p (org-on-heading-p t))
12307 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12308 (following-p (org-get-alist-option org-show-following-heading key))
12309 (entry-p (org-get-alist-option org-show-entry-below key))
12310 (siblings-p (org-get-alist-option org-show-siblings key)))
12311 (catch 'exit
12312 ;; Show heading or entry text
12313 (if (and heading-p (not entry-p))
12314 (org-flag-heading nil) ; only show the heading
12315 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12316 (org-show-hidden-entry))) ; show entire entry
12317 (when following-p
12318 ;; Show next sibling, or heading below text
12319 (save-excursion
12320 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12321 (org-flag-heading nil))))
12322 (when siblings-p (org-show-siblings))
12323 (when hierarchy-p
12324 ;; show all higher headings, possibly with siblings
12325 (save-excursion
12326 (while (and (condition-case nil
12327 (progn (org-up-heading-all 1) t)
12328 (error nil))
12329 (not (bobp)))
12330 (org-flag-heading nil)
12331 (when siblings-p (org-show-siblings))))))))
12333 (defvar org-reveal-start-hook nil
12334 "Hook run before revealing a location.")
12336 (defun org-reveal (&optional siblings)
12337 "Show current entry, hierarchy above it, and the following headline.
12338 This can be used to show a consistent set of context around locations
12339 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12340 not t for the search context.
12342 With optional argument SIBLINGS, on each level of the hierarchy all
12343 siblings are shown. This repairs the tree structure to what it would
12344 look like when opened with hierarchical calls to `org-cycle'.
12346 go to the parent and show the
12347 entire tree."
12348 (interactive "P")
12349 (run-hooks 'org-reveal-start-hook)
12350 (let ((org-show-hierarchy-above t)
12351 (org-show-following-heading t)
12352 (org-show-siblings (if siblings t org-show-siblings)))
12353 (org-show-context nil))
12354 (when (equal siblings '(16))
12355 (save-excursion
12356 (when (org-up-heading-safe)
12357 (org-show-subtree)
12358 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12360 (defun org-highlight-new-match (beg end)
12361 "Highlight from BEG to END and mark the highlight is an occur headline."
12362 (let ((ov (make-overlay beg end)))
12363 (overlay-put ov 'face 'secondary-selection)
12364 (overlay-put ov 'org-type 'org-occur)
12365 (push ov org-occur-highlights)))
12367 (defun org-remove-occur-highlights (&optional beg end noremove)
12368 "Remove the occur highlights from the buffer.
12369 BEG and END are ignored. If NOREMOVE is nil, remove this function
12370 from the `before-change-functions' in the current buffer."
12371 (interactive)
12372 (unless org-inhibit-highlight-removal
12373 (mapc 'delete-overlay org-occur-highlights)
12374 (setq org-occur-highlights nil)
12375 (setq org-occur-parameters nil)
12376 (unless noremove
12377 (remove-hook 'before-change-functions
12378 'org-remove-occur-highlights 'local))))
12380 ;;;; Priorities
12383 "Regular expression matching the priority indicator.")
12385 (defvar org-remove-priority-next-time nil)
12387 (defun org-priority-up ()
12388 "Increase the priority of the current item."
12389 (interactive)
12390 (org-priority 'up))
12392 (defun org-priority-down ()
12393 "Decrease the priority of the current item."
12394 (interactive)
12395 (org-priority 'down))
12397 (defun org-priority (&optional action)
12398 "Change the priority of an item by ARG.
12399 ACTION can be `set', `up', `down', or a character."
12400 (interactive)
12401 (unless org-enable-priority-commands
12402 (error "Priority commands are disabled"))
12403 (setq action (or action 'set))
12404 (let (current new news have remove)
12405 (save-excursion
12406 (org-back-to-heading t)
12407 (if (looking-at org-priority-regexp)
12408 (setq current (string-to-char (match-string 2))
12409 have t))
12410 (cond
12411 ((eq action 'remove)
12412 (setq remove t new ?\ ))
12413 ((or (eq action 'set)
12414 (if (featurep 'xemacs) (characterp action) (integerp action)))
12415 (if (not (eq action 'set))
12416 (setq new action)
12417 (message "Priority %c-%c, SPC to remove: "
12418 org-highest-priority org-lowest-priority)
12419 (save-match-data
12420 (setq new (read-char-exclusive))))
12421 (if (and (= (upcase org-highest-priority) org-highest-priority)
12422 (= (upcase org-lowest-priority) org-lowest-priority))
12423 (setq new (upcase new)))
12424 (cond ((equal new ?\ ) (setq remove t))
12425 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12426 (error "Priority must be between `%c' and `%c'"
12427 org-highest-priority org-lowest-priority))))
12428 ((eq action 'up)
12429 (setq new (if have
12430 (1- current) ; normal cycling
12431 ;; last priority was empty
12432 (if (eq last-command this-command)
12433 org-lowest-priority ; wrap around empty to lowest
12434 ;; default
12435 (if org-priority-start-cycle-with-default
12436 org-default-priority
12437 (1- org-default-priority))))))
12438 ((eq action 'down)
12439 (setq new (if have
12440 (1+ current) ; normal cycling
12441 ;; last priority was empty
12442 (if (eq last-command this-command)
12443 org-highest-priority ; wrap around empty to highest
12444 ;; default
12445 (if org-priority-start-cycle-with-default
12446 org-default-priority
12447 (1+ org-default-priority))))))
12448 (t (error "Invalid action")))
12449 (if (or (< (upcase new) org-highest-priority)
12450 (> (upcase new) org-lowest-priority))
12451 (if (and (memq action '(up down))
12452 (not have) (not (eq last-command this-command)))
12453 ;; `new' is from default priority
12454 (error
12455 "The default can not be set, see `org-default-priority' why")
12456 ;; normal cycling: `new' is beyond highest/lowest priority
12457 ;; and is wrapped around to the empty priority
12458 (setq remove t)))
12459 (setq news (format "%c" new))
12460 (if have
12461 (if remove
12462 (replace-match "" t t nil 1)
12463 (replace-match news t t nil 2))
12464 (if remove
12465 (error "No priority cookie found in line")
12466 (let ((case-fold-search nil))
12467 (looking-at org-todo-line-regexp))
12468 (if (match-end 2)
12469 (progn
12470 (goto-char (match-end 2))
12471 (insert " [#" news "]"))
12472 (goto-char (match-beginning 3))
12473 (insert "[#" news "] "))))
12474 (org-preserve-lc (org-set-tags nil 'align)))
12475 (if remove
12476 (message "Priority removed")
12477 (message "Priority of current item set to %s" news))))
12479 (defun org-get-priority (s)
12480 "Find priority cookie and return priority."
12481 (if (functionp org-get-priority-function)
12482 (funcall org-get-priority-function)
12483 (save-match-data
12484 (if (not (string-match org-priority-regexp s))
12485 (* 1000 (- org-lowest-priority org-default-priority))
12486 (* 1000 (- org-lowest-priority
12487 (string-to-char (match-string 2 s))))))))
12489 ;;;; Tags
12491 (defvar org-agenda-archives-mode)
12492 (defvar org-map-continue-from nil
12493 "Position from where mapping should continue.
12494 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12496 (defvar org-scanner-tags nil
12497 "The current tag list while the tags scanner is running.")
12498 (defvar org-trust-scanner-tags nil
12499 "Should `org-get-tags-at' use the tags for the scanner.
12500 This is for internal dynamical scoping only.
12501 When this is non-nil, the function `org-get-tags-at' will return the value
12502 of `org-scanner-tags' instead of building the list by itself. This
12503 can lead to large speed-ups when the tags scanner is used in a file with
12504 many entries, and when the list of tags is retrieved, for example to
12505 obtain a list of properties. Building the tags list for each entry in such
12506 a file becomes an N^2 operation - but with this variable set, it scales
12507 as N.")
12509 (defun org-scan-tags (action matcher &optional todo-only)
12510 "Scan headline tags with inheritance and produce output ACTION.
12512 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12513 or `agenda' to produce an entry list for an agenda view. It can also be
12514 a Lisp form or a function that should be called at each matched headline, in
12515 this case the return value is a list of all return values from these calls.
12517 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12518 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12519 only lines with a TODO keyword are included in the output."
12520 (require 'org-agenda)
12523 (org-re
12525 (props (list 'face 'default
12526 'done-face 'org-agenda-done
12527 'undone-face 'default
12528 'mouse-face 'highlight
12529 'org-not-done-regexp org-not-done-regexp
12530 'org-todo-regexp org-todo-regexp
12531 'help-echo
12532 (format "mouse-2 or RET jump to org file %s"
12533 (abbreviate-file-name
12534 (or (buffer-file-name (buffer-base-buffer))
12535 (buffer-name (buffer-base-buffer)))))))
12536 (case-fold-search nil)
12537 (org-map-continue-from nil)
12538 lspos tags tags-list
12539 (tags-alist (list (cons 0 org-file-tags)))
12540 (llast 0) rtn rtn1 level category i txt
12541 todo marker entry priority)
12542 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12543 (setq action (list 'lambda nil action)))
12544 (save-excursion
12545 (goto-char (point-min))
12546 (when (eq action 'sparse-tree)
12547 (org-overview)
12548 (org-remove-occur-highlights))
12549 (while (re-search-forward re nil t)
12550 (catch :skip
12551 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12552 tags (if (match-end 4) (org-match-string-no-properties 4)))
12553 (goto-char (setq lspos (match-beginning 0)))
12554 (setq level (org-reduced-level (funcall outline-level))
12555 category (org-get-category))
12556 (setq i llast llast level)
12557 ;; remove tag lists from same and sublevels
12558 (while (>= i level)
12559 (when (setq entry (assoc i tags-alist))
12560 (setq tags-alist (delete entry tags-alist)))
12561 (setq i (1- i)))
12562 ;; add the next tags
12563 (when tags
12564 (setq tags (org-split-string tags ":")
12565 tags-alist
12566 (cons (cons level tags) tags-alist)))
12567 ;; compile tags for current headline
12568 (setq tags-list
12569 (if org-use-tag-inheritance
12570 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12571 tags)
12572 org-scanner-tags tags-list)
12573 (when org-use-tag-inheritance
12574 (setcdr (car tags-alist)
12575 (mapcar (lambda (x)
12576 (setq x (copy-sequence x))
12577 (org-add-prop-inherited x))
12578 (cdar tags-alist))))
12579 (when (and tags org-use-tag-inheritance
12580 (or (not (eq t org-use-tag-inheritance))
12581 org-tags-exclude-from-inheritance))
12582 ;; selective inheritance, remove uninherited ones
12583 (setcdr (car tags-alist)
12584 (org-remove-uninherited-tags (cdar tags-alist))))
12585 (when (and
12587 ;; eval matcher only when the todo condition is OK
12588 (and (or (not todo-only) (member todo org-not-done-keywords))
12589 (let ((case-fold-search t)) (eval matcher)))
12591 ;; Call the skipper, but return t if it does not skip,
12592 ;; so that the `and' form continues evaluating
12593 (progn
12594 (unless (eq action 'sparse-tree) (org-agenda-skip))
12595 t)
12597 ;; Check if timestamps are deselecting this entry
12598 (or (not todo-only)
12599 (and (member todo org-not-done-keywords)
12600 (or (not org-agenda-tags-todo-honor-ignore-options)
12601 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12603 ;; Extra check for the archive tag
12604 ;; FIXME: Does the skipper already do this????
12605 (or
12606 (not (member org-archive-tag tags-list))
12607 ;; we have an archive tag, should we use this anyway?
12608 (or (not org-agenda-skip-archived-trees)
12609 (and (eq action 'agenda) org-agenda-archives-mode))))
12611 ;; select this headline
12613 (cond
12614 ((eq action 'sparse-tree)
12615 (and org-highlight-sparse-tree-matches
12616 (org-get-heading) (match-end 0)
12617 (org-highlight-new-match
12618 (match-beginning 0) (match-beginning 1)))
12619 (org-show-context 'tags-tree))
12620 ((eq action 'agenda)
12621 (setq txt (org-format-agenda-item
12622 ""
12623 (concat
12624 (if (eq org-tags-match-list-sublevels 'indented)
12625 (make-string (1- level) ?.) "")
12626 (org-get-heading))
12627 category
12628 tags-list
12629 )
12630 priority (org-get-priority txt))
12631 (goto-char lspos)
12632 (setq marker (org-agenda-new-marker))
12633 (org-add-props txt props
12634 'org-marker marker 'org-hd-marker marker 'org-category category
12635 'todo-state todo
12636 'priority priority 'type "tagsmatch")
12637 (push txt rtn))
12638 ((functionp action)
12639 (setq org-map-continue-from nil)
12640 (save-excursion
12641 (setq rtn1 (funcall action))
12642 (push rtn1 rtn)))
12643 (t (error "Invalid action")))
12645 ;; if we are to skip sublevels, jump to end of subtree
12646 (unless org-tags-match-list-sublevels
12647 (org-end-of-subtree t)
12648 (backward-char 1))))
12649 ;; Get the correct position from where to continue
12650 (if org-map-continue-from
12651 (goto-char org-map-continue-from)
12652 (and (= (point) lspos) (end-of-line 1)))))
12653 (when (and (eq action 'sparse-tree)
12654 (not org-sparse-tree-open-archived-trees))
12655 (org-hide-archived-subtrees (point-min) (point-max)))
12656 (nreverse rtn)))
12658 (defun org-remove-uninherited-tags (tags)
12659 "Remove all tags that are not inherited from the list TAGS."
12660 (cond
12661 ((eq org-use-tag-inheritance t)
12662 (if org-tags-exclude-from-inheritance
12663 (org-delete-all org-tags-exclude-from-inheritance tags)
12664 tags))
12665 ((not org-use-tag-inheritance) nil)
12666 ((stringp org-use-tag-inheritance)
12667 (delq nil (mapcar
12668 (lambda (x)
12669 (if (and (string-match org-use-tag-inheritance x)
12670 (not (member x org-tags-exclude-from-inheritance)))
12671 x nil))
12672 tags)))
12673 ((listp org-use-tag-inheritance)
12674 (delq nil (mapcar
12675 (lambda (x)
12676 (if (member x org-use-tag-inheritance) x nil))
12677 tags)))))
12679 (defvar todo-only) ;; dynamically scoped
12681 (defun org-match-sparse-tree (&optional todo-only match)
12682 "Create a sparse tree according to tags string MATCH.
12683 MATCH can contain positive and negative selection of tags, like
12685 If optional argument TODO-ONLY is non-nil, only select lines that are
12686 also TODO lines."
12687 (interactive "P")
12688 (org-prepare-agenda-buffers (list (current-buffer)))
12689 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12691 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12693 (defvar org-cached-props nil)
12694 (defun org-cached-entry-get (pom property)
12695 (if (or (eq t org-use-property-inheritance)
12696 (and (stringp org-use-property-inheritance)
12697 (string-match org-use-property-inheritance property))
12698 (and (listp org-use-property-inheritance)
12699 (member property org-use-property-inheritance)))
12700 ;; Caching is not possible, check it directly
12701 (org-entry-get pom property 'inherit)
12702 ;; Get all properties, so that we can do complicated checks easily
12703 (cdr (assoc property (or org-cached-props
12704 (setq org-cached-props
12705 (org-entry-properties pom)))))))
12707 (defun org-global-tags-completion-table (&optional files)
12708 "Return the list of all tags in all agenda buffer/files.
12709 Optional FILES argument is a list of files to which can be used
12710 instead of the agenda files."
12711 (save-excursion
12712 (org-uniquify
12713 (delq nil
12714 (apply 'append
12715 (mapcar
12716 (lambda (file)
12717 (set-buffer (find-file-noselect file))
12718 (append (org-get-buffer-tags)
12719 (mapcar (lambda (x) (if (stringp (car-safe x))
12720 (list (car-safe x)) nil))
12721 org-tag-alist)))
12722 (if (and files (car files))
12723 files
12724 (org-agenda-files))))))))
12726 (defun org-make-tags-matcher (match)
12727 "Create the TAGS/TODO matcher form for the selection string MATCH."
12728 ;; todo-only is scoped dynamically into this function, and the function
12729 ;; may change it if the matcher asks for it.
12730 (unless match
12731 ;; Get a new match request, with completion
12732 (let ((org-last-tags-completion-table
12733 (org-global-tags-completion-table)))
12734 (setq match (org-completing-read-no-i
12735 "Match: " 'org-tags-completion-function nil nil nil
12736 'org-tags-history))))
12738 ;; Parse the string and create a lisp form
12739 (let ((match0 match)
12740 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12741 minus tag mm
12742 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12743 orterms term orlist re-p str-p level-p level-op time-p
12744 prop-p pn pv po gv rest)
12745 (if (string-match "/+" match)
12746 ;; match contains also a todo-matching request
12747 (progn
12748 (setq tagsmatch (substring match 0 (match-beginning 0))
12749 todomatch (substring match (match-end 0)))
12750 (if (string-match "^!" todomatch)
12751 (setq todo-only t todomatch (substring todomatch 1)))
12753 (setq todomatch nil)))
12754 ;; only matching tags
12755 (setq tagsmatch match todomatch nil))
12757 ;; Make the tags matcher
12759 (setq tagsmatcher t)
12760 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12761 (while (setq term (pop orterms))
12763 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12764 (while (string-match re term)
12765 (setq rest (substring term (match-end 0))
12766 minus (and (match-end 1)
12767 (equal (match-string 1 term) "-"))
12768 tag (save-match-data (replace-regexp-in-string
12770 (match-string 2 term)))
12771 re-p (equal (string-to-char tag) ?{)
12772 level-p (match-end 4)
12773 prop-p (match-end 5)
12774 mm (cond
12775 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12776 (level-p
12777 (setq level-op (org-op-to-function (match-string 3 term)))
12778 `(,level-op level ,(string-to-number
12779 (match-string 4 term))))
12780 (prop-p
12781 (setq pn (match-string 5 term)
12782 po (match-string 6 term)
12783 pv (match-string 7 term)
12784 re-p (equal (string-to-char pv) ?{)
12786 time-p (save-match-data
12788 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12789 (if time-p (setq pv (org-matcher-time pv)))
12790 (setq po (org-op-to-function po (if time-p 'time str-p)))
12791 (cond
12792 ((equal pn "CATEGORY")
12793 (setq gv '(get-text-property (point) 'org-category)))
12794 ((equal pn "TODO")
12795 (setq gv 'todo))
12796 (t
12797 (setq gv `(org-cached-entry-get nil ,pn))))
12798 (if re-p
12799 (if (eq po 'org<>)
12800 `(not (string-match ,pv (or ,gv "")))
12801 `(string-match ,pv (or ,gv "")))
12802 (if str-p
12803 `(,po (or ,gv "") ,pv)
12804 `(,po (string-to-number (or ,gv ""))
12805 ,(string-to-number pv) ))))
12806 (t `(member ,tag tags-list)))
12807 mm (if minus (list 'not mm) mm)
12808 term rest)
12809 (push mm tagsmatcher))
12810 (push (if (> (length tagsmatcher) 1)
12811 (cons 'and tagsmatcher)
12812 (car tagsmatcher))
12813 orlist)
12814 (setq tagsmatcher nil))
12815 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12816 (setq tagsmatcher
12817 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12818 ;; Make the todo matcher
12820 (setq todomatcher t)
12821 (setq orterms (org-split-string todomatch "|") orlist nil)
12822 (while (setq term (pop orterms))
12823 (while (string-match re term)
12824 (setq minus (and (match-end 1)
12825 (equal (match-string 1 term) "-"))
12826 kwd (match-string 2 term)
12827 re-p (equal (string-to-char kwd) ?{)
12828 term (substring term (match-end 0))
12829 mm (if re-p
12830 `(string-match ,(substring kwd 1 -1) todo)
12831 (list 'equal 'todo kwd))
12832 mm (if minus (list 'not mm) mm))
12833 (push mm todomatcher))
12834 (push (if (> (length todomatcher) 1)
12835 (cons 'and todomatcher)
12836 (car todomatcher))
12837 orlist)
12838 (setq todomatcher nil))
12839 (setq todomatcher (if (> (length orlist) 1)
12840 (cons 'or orlist) (car orlist))))
12842 ;; Return the string and lisp forms of the matcher
12843 (setq matcher (if todomatcher
12844 (list 'and tagsmatcher todomatcher)
12845 tagsmatcher))
12846 (cons match0 matcher)))
12848 (defun org-op-to-function (op &optional stringp)
12849 "Turn an operator into the appropriate function."
12850 (setq op
12851 (cond
12852 ((equal op "<" ) '(< string< org-time<))
12853 ((equal op ">" ) '(> org-string> org-time>))
12854 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12855 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12856 ((member op '("=" "==")) '(= string= org-time=))
12857 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12858 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12860 (defun org<> (a b) (not (= a b)))
12861 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12862 (defun org-string>= (a b) (not (string< a b)))
12863 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12864 (defun org-string<> (a b) (not (string= a b)))
12865 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12866 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12867 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12868 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12869 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12870 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12871 (defun org-2ft (s)
12872 "Convert S to a floating point time.
12873 If S is already a number, just return it. If it is a string, parse
12874 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12875 (cond
12876 ((numberp s) s)
12877 ((stringp s)
12878 (condition-case nil
12879 (float-time (apply 'encode-time (org-parse-time-string s)))
12880 (error 0.)))
12881 (t 0.)))
12883 (defun org-time-today ()
12884 "Time in seconds today at 0:00.
12885 Returns the float number of seconds since the beginning of the
12886 epoch to the beginning of today (00:00)."
12887 (float-time (apply 'encode-time
12888 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12890 (defun org-matcher-time (s)
12891 "Interpret a time comparison value."
12892 (save-match-data
12893 (cond
12894 ((string= s "<now>") (float-time))
12895 ((string= s "<today>") (org-time-today))
12896 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12897 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12899 (+ (org-time-today)
12900 (* (string-to-number (match-string 1 s))
12901 (cdr (assoc (match-string 2 s)
12902 '(("d" . 86400.0) ("w" . 604800.0)
12903 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12904 (t (org-2ft s)))))
12906 (defun org-match-any-p (re list)
12907 "Does re match any element of list?"
12908 (setq list (mapcar (lambda (x) (string-match re x)) list))
12909 (delq nil list))
12911 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12912 (defvar org-tags-overlay (make-overlay 1 1))
12913 (org-detach-overlay org-tags-overlay)
12915 (defun org-get-local-tags-at (&optional pos)
12916 "Get a list of tags defined in the current headline."
12917 (org-get-tags-at pos 'local))
12919 (defun org-get-local-tags ()
12920 "Get a list of tags defined in the current headline."
12921 (org-get-tags-at nil 'local))
12923 (defun org-get-tags-at (&optional pos local)
12924 "Get a list of all headline tags applicable at POS.
12925 POS defaults to point. If tags are inherited, the list contains
12926 the targets in the same sequence as the headlines appear, i.e.
12927 the tags of the current headline come last.
12928 When LOCAL is non-nil, only return tags from the current headline,
12929 ignore inherited ones."
12930 (interactive)
12931 (if (and org-trust-scanner-tags
12932 (or (not pos) (equal pos (point)))
12933 (not local))
12934 org-scanner-tags
12935 (let (tags ltags lastpos parent)
12936 (save-excursion
12937 (save-restriction
12938 (widen)
12939 (goto-char (or pos (point)))
12940 (save-match-data
12941 (catch 'done
12942 (condition-case nil
12943 (progn
12944 (org-back-to-heading t)
12945 (while (not (equal lastpos (point)))
12946 (setq lastpos (point))
12947 (when (looking-at
12949 (setq ltags (org-split-string
12950 (org-match-string-no-properties 1) ":"))
12951 (when parent
12952 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12953 (setq tags (append
12954 (if parent
12955 (org-remove-uninherited-tags ltags)
12956 ltags)
12957 tags)))
12958 (or org-use-tag-inheritance (throw 'done t))
12959 (if local (throw 'done t))
12960 (or (org-up-heading-safe) (error nil))
12961 (setq parent t)))
12962 (error nil)))))
12963 (if local
12964 tags
12965 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12967 (defun org-add-prop-inherited (s)
12968 (add-text-properties 0 (length s) '(inherited t) s)
12969 s)
12971 (defun org-toggle-tag (tag &optional onoff)
12972 "Toggle the tag TAG for the current line.
12973 If ONOFF is `on' or `off', don't toggle but set to this state."
12974 (let (res current)
12975 (save-excursion
12976 (org-back-to-heading t)
12978 (point-at-eol) t)
12979 (progn
12980 (setq current (match-string 1))
12981 (replace-match ""))
12982 (setq current ""))
12983 (setq current (nreverse (org-split-string current ":")))
12984 (cond
12985 ((eq onoff 'on)
12986 (setq res t)
12987 (or (member tag current) (push tag current)))
12988 ((eq onoff 'off)
12989 (or (not (member tag current)) (setq current (delete tag current))))
12990 (t (if (member tag current)
12991 (setq current (delete tag current))
12992 (setq res t)
12993 (push tag current))))
12994 (end-of-line 1)
12995 (if current
12996 (progn
12997 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12998 (org-set-tags nil t))
12999 (delete-horizontal-space))
13000 (run-hooks 'org-after-tags-change-hook))
13001 res))
13003 (defun org-align-tags-here (to-col)
13004 ;; Assumes that this is a headline
13005 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13006 (beginning-of-line 1)
13008 (< pos (match-beginning 2)))
13009 (progn
13010 (setq tags-l (- (match-end 2) (match-beginning 2)))
13011 (goto-char (match-beginning 1))
13012 (insert " ")
13013 (delete-region (point) (1+ (match-beginning 2)))
13014 (setq ncol (max (1+ (current-column))
13015 (1+ col)
13016 (if (> to-col 0)
13017 to-col
13018 (- (abs to-col) tags-l))))
13019 (setq p (point))
13020 (insert (make-string (- ncol (current-column)) ?\ ))
13021 (setq ncol (current-column))
13022 (when indent-tabs-mode (tabify p (point-at-eol)))
13023 (org-move-to-column (min ncol col) t))
13024 (goto-char pos))))
13026 (defun org-set-tags-command (&optional arg just-align)
13027 "Call the set-tags command for the current entry."
13028 (interactive "P")
13029 (if (org-on-heading-p)
13030 (org-set-tags arg just-align)
13031 (save-excursion
13032 (org-back-to-heading t)
13033 (org-set-tags arg just-align))))
13035 (defun org-set-tags-to (data)
13036 "Set the tags of the current entry to DATA, replacing the current tags.
13037 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13038 If DATA is nil or the empty string, any tags will be removed."
13039 (interactive "sTags: ")
13040 (setq data
13041 (cond
13042 ((eq data nil) "")
13043 ((equal data "") "")
13044 ((stringp data)
13045 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13046 ":"))
13047 ((listp data)
13048 (concat ":" (mapconcat 'identity data ":") ":"))
13049 (t nil)))
13050 (when data
13051 (save-excursion
13052 (org-back-to-heading t)
13053 (when (looking-at org-complex-heading-regexp)
13054 (if (match-end 5)
13055 (progn
13056 (goto-char (match-beginning 5))
13057 (insert data)
13058 (delete-region (point) (point-at-eol))
13059 (org-set-tags nil 'align))
13060 (goto-char (point-at-eol))
13061 (insert " " data)
13062 (org-set-tags nil 'align)))
13063 (beginning-of-line 1)
13065 (delete-region (match-beginning 1) (match-end 1))))))
13067 (defun org-align-all-tags ()
13068 "Align the tags i all headings."
13069 (interactive)
13070 (save-excursion
13071 (or (ignore-errors (org-back-to-heading t))
13072 (outline-next-heading))
13073 (if (org-on-heading-p)
13074 (org-set-tags t)
13075 (message "No headings"))))
13077 (defvar org-indent-indentation-per-level)
13078 (defun org-set-tags (&optional arg just-align)
13079 "Set the tags for the current headline.
13080 With prefix ARG, realign all tags in headings in the current buffer."
13081 (interactive "P")
13082 (let* ((re org-outline-regexp-bol)
13083 (current (org-get-tags-string))
13084 (col (current-column))
13085 (org-setting-tags t)
13086 table current-tags inherited-tags ; computed below when needed
13087 tags p0 c0 c1 rpl di tc level)
13088 (if arg
13089 (save-excursion
13090 (goto-char (point-min))
13091 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13092 (while (re-search-forward re nil t)
13093 (org-set-tags nil t)
13094 (end-of-line 1)))
13095 (message "All tags realigned to column %d" org-tags-column))
13096 (if just-align
13097 (setq tags current)
13098 ;; Get a new set of tags from the user
13099 (save-excursion
13100 (setq table (append org-tag-persistent-alist
13101 (or org-tag-alist (org-get-buffer-tags))
13102 (and
13103 org-complete-tags-always-offer-all-agenda-tags
13104 (org-global-tags-completion-table
13105 (org-agenda-files))))
13106 org-last-tags-completion-table table
13107 current-tags (org-split-string current ":")
13108 inherited-tags (nreverse
13109 (nthcdr (length current-tags)
13110 (nreverse (org-get-tags-at))))
13111 tags
13112 (if (or (eq t org-use-fast-tag-selection)
13113 (and org-use-fast-tag-selection
13114 (delq nil (mapcar 'cdr table))))
13115 (org-fast-tag-selection
13116 current-tags inherited-tags table
13117 (if org-fast-tag-selection-include-todo
13118 org-todo-key-alist))
13119 (let ((org-add-colon-after-tag-completion t))
13120 (org-trim
13121 (org-icompleting-read "Tags: "
13122 'org-tags-completion-function
13123 nil nil current 'org-tags-history))))))
13124 (while (string-match "[-+&]+" tags)
13125 ;; No boolean logic, just a list
13126 (setq tags (replace-match ":" t t tags))))
13128 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13130 (if org-tags-sort-function
13131 (setq tags (mapconcat 'identity
13132 (sort (org-split-string
13133 tags (org-re "[^[:alnum:]_@#%]+"))
13134 org-tags-sort-function) ":")))
13137 (setq tags "")
13138 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13139 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13141 ;; Insert new tags at the correct column
13142 (beginning-of-line 1)
13143 (setq level (or (and (looking-at org-outline-regexp)
13144 (- (match-end 0) (point) 1))
13145 1))
13146 (cond
13147 ((and (equal current "") (equal tags "")))
13148 ((re-search-forward
13150 (point-at-eol) t)
13151 (if (equal tags "")
13152 (setq rpl "")
13153 (goto-char (match-beginning 0))
13154 (setq c0 (current-column)
13155 ;; compute offset for the case of org-indent-mode active
13156 di (if org-indent-mode
13157 (* (1- org-indent-indentation-per-level) (1- level))
13158 0)
13159 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13160 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13161 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13162 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13163 (replace-match rpl t t)
13164 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13165 tags)
13166 (t (error "Tags alignment failed")))
13167 (org-move-to-column col)
13168 (unless just-align
13169 (run-hooks 'org-after-tags-change-hook)))))
13171 (defun org-change-tag-in-region (beg end tag off)
13172 "Add or remove TAG for each entry in the region.
13173 This works in the agenda, and also in an org-mode buffer."
13174 (interactive
13175 (list (region-beginning) (region-end)
13176 (let ((org-last-tags-completion-table
13177 (if (org-mode-p)
13178 (org-get-buffer-tags)
13179 (org-global-tags-completion-table))))
13180 (org-icompleting-read
13181 "Tag: " 'org-tags-completion-function nil nil nil
13182 'org-tags-history))
13183 (progn
13185 (equal (read-char-exclusive) ?r))))
13186 (if (fboundp 'deactivate-mark) (deactivate-mark))
13187 (let ((agendap (equal major-mode 'org-agenda-mode))
13188 l1 l2 m buf pos newhead (cnt 0))
13189 (goto-char end)
13190 (setq l2 (1- (org-current-line)))
13191 (goto-char beg)
13192 (setq l1 (org-current-line))
13193 (loop for l from l1 to l2 do
13194 (org-goto-line l)
13195 (setq m (get-text-property (point) 'org-hd-marker))
13196 (when (or (and (org-mode-p) (org-on-heading-p))
13197 (and agendap m))
13198 (setq buf (if agendap (marker-buffer m) (current-buffer))
13199 pos (if agendap m (point)))
13200 (with-current-buffer buf
13201 (save-excursion
13202 (save-restriction
13203 (goto-char pos)
13204 (setq cnt (1+ cnt))
13205 (org-toggle-tag tag (if off 'off 'on))
13206 (setq newhead (org-get-heading)))))
13207 (and agendap (org-agenda-change-all-lines newhead m))))
13208 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13210 (defun org-tags-completion-function (string predicate &optional flag)
13211 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13212 (confirm (lambda (x) (stringp (car x)))))
13214 (setq s1 (match-string 1 string)
13215 s2 (match-string 2 string))
13216 (setq s1 "" s2 string))
13217 (cond
13218 ((eq flag nil)
13219 ;; try completion
13220 (setq rtn (try-completion s2 ctable confirm))
13221 (if (stringp rtn)
13222 (setq rtn
13223 (concat s1 s2 (substring rtn (length s2))
13224 (if (and org-add-colon-after-tag-completion
13225 (assoc rtn ctable))
13226 ":" ""))))
13227 rtn)
13228 ((eq flag t)
13229 ;; all-completions
13230 (all-completions s2 ctable confirm)
13231 )
13232 ((eq flag 'lambda)
13233 ;; exact match?
13234 (assoc s2 ctable)))
13235 ))
13237 (defun org-fast-tag-insert (kwd tags face &optional end)
13238 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13239 (insert (format "%-12s" (concat kwd ":"))
13240 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13241 (or end "")))
13243 (defun org-fast-tag-show-exit (flag)
13244 (save-excursion
13245 (org-goto-line 3)
13247 (replace-match ""))
13248 (when flag
13249 (end-of-line 1)
13250 (org-move-to-column (- (window-width) 19) t)
13251 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13253 (defun org-set-current-tags-overlay (current prefix)
13254 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13255 (if (featurep 'xemacs)
13256 (org-overlay-display org-tags-overlay (concat prefix s)
13257 'secondary-selection)
13258 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13259 (org-overlay-display org-tags-overlay (concat prefix s)))))
13261 (defvar org-last-tag-selection-key nil)
13262 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13263 "Fast tag selection with single keys.
13264 CURRENT is the current list of tags in the headline, INHERITED is the
13265 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13266 possibly with grouping information. TODO-TABLE is a similar table with
13267 TODO keywords, should these have keys assigned to them.
13268 If the keys are nil, a-z are automatically assigned.
13269 Returns the new tags string, or nil to not change the current settings."
13270 (let* ((fulltable (append table todo-table))
13271 (maxlen (apply 'max (mapcar
13272 (lambda (x)
13273 (if (stringp (car x)) (string-width (car x)) 0))
13274 fulltable)))
13275 (buf (current-buffer))
13276 (expert (eq org-fast-tag-selection-single-key 'expert))
13277 (buffer-tags nil)
13278 (fwidth (+ maxlen 3 1 3))
13279 (ncol (/ (- (window-width) 4) fwidth))
13280 (i-face 'org-done)
13281 (c-face 'org-todo)
13282 tg cnt e c char c1 c2 ntable tbl rtn
13283 ov-start ov-end ov-prefix
13284 (exit-after-next org-fast-tag-selection-single-key)
13285 (done-keywords org-done-keywords)
13286 groups ingroup)
13287 (save-excursion
13288 (beginning-of-line 1)
13289 (if (looking-at
13291 (setq ov-start (match-beginning 1)
13292 ov-end (match-end 1)
13293 ov-prefix "")
13294 (setq ov-start (1- (point-at-eol))
13295 ov-end (1+ ov-start))
13297 (setq ov-prefix
13298 (concat
13299 (buffer-substring (1- (point)) (point))
13300 (if (> (current-column) org-tags-column)
13301 " "
13302 (make-string (- org-tags-column (current-column)) ?\ ))))))
13303 (move-overlay org-tags-overlay ov-start ov-end)
13304 (save-window-excursion
13305 (if expert
13306 (set-buffer (get-buffer-create " *Org tags*"))
13307 (delete-other-windows)
13308 (split-window-vertically)
13309 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13310 (erase-buffer)
13311 (org-set-local 'org-done-keywords done-keywords)
13314 (org-fast-tag-show-exit exit-after-next)
13315 (org-set-current-tags-overlay current ov-prefix)
13316 (setq tbl fulltable char ?a cnt 0)
13317 (while (setq e (pop tbl))
13318 (cond
13319 ((equal (car e) :startgroup)
13320 (push '() groups) (setq ingroup t)
13321 (when (not (= cnt 0))
13322 (setq cnt 0)
13324 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13325 ((equal (car e) :endgroup)
13326 (setq ingroup nil cnt 0)
13328 ((equal e '(:newline))
13329 (when (not (= cnt 0))
13330 (setq cnt 0)
13332 (setq e (car tbl))
13333 (while (equal (car tbl) '(:newline))
13335 (setq tbl (cdr tbl)))))
13336 (t
13337 (setq tg (copy-sequence (car e)) c2 nil)
13338 (if (cdr e)
13339 (setq c (cdr e))
13340 ;; automatically assign a character.
13341 (setq c1 (string-to-char
13342 (downcase (substring
13343 tg (if (= (string-to-char tg) ?@) 1 0)))))
13344 (if (or (rassoc c1 ntable) (rassoc c1 table))
13345 (while (or (rassoc char ntable) (rassoc char table))
13346 (setq char (1+ char)))
13347 (setq c2 c1))
13348 (setq c (or c2 char)))
13349 (if ingroup (push tg (car groups)))
13350 (setq tg (org-add-props tg nil 'face
13351 (cond
13352 ((not (assoc tg table))
13353 (org-get-todo-face tg))
13354 ((member tg current) c-face)
13355 ((member tg inherited) i-face)
13356 (t nil))))
13357 (if (and (= cnt 0) (not ingroup)) (insert " "))
13358 (insert "[" c "] " tg (make-string
13359 (- fwidth 4 (length tg)) ?\ ))
13360 (push (cons tg c) ntable)
13361 (when (= (setq cnt (1+ cnt)) ncol)
13363 (if ingroup (insert " "))
13364 (setq cnt 0)))))
13365 (setq ntable (nreverse ntable))
13367 (goto-char (point-min))
13368 (if (not expert) (org-fit-window-to-buffer))
13369 (setq rtn
13370 (catch 'exit
13371 (while t
13372 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13373 (if (not groups) "no " "")
13374 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13375 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13376 (setq org-last-tag-selection-key c)
13377 (cond
13379 ((= c ?!)
13380 (setq groups (not groups))
13381 (goto-char (point-min))
13382 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13383 ((= c ?\C-c)
13384 (if (not expert)
13385 (org-fast-tag-show-exit
13386 (setq exit-after-next (not exit-after-next)))
13387 (setq expert nil)
13388 (delete-other-windows)
13389 (set-window-buffer (split-window-vertically) " *Org tags*")
13390 (org-switch-to-buffer-other-window " *Org tags*")
13391 (org-fit-window-to-buffer)))
13392 ((or (= c ?\C-g)
13393 (and (= c ?q) (not (rassoc c ntable))))
13394 (org-detach-overlay org-tags-overlay)
13395 (setq quit-flag t))
13396 ((= c ?\ )
13397 (setq current nil)
13398 (if exit-after-next (setq exit-after-next 'now)))
13400 (condition-case nil
13401 (setq tg (org-icompleting-read
13402 "Tag: "
13403 (or buffer-tags
13404 (with-current-buffer buf
13405 (org-get-buffer-tags)))))
13406 (quit (setq tg "")))
13408 (add-to-list 'buffer-tags (list tg))
13409 (if (member tg current)
13410 (setq current (delete tg current))
13411 (push tg current)))
13412 (if exit-after-next (setq exit-after-next 'now)))
13413 ((setq e (rassoc c todo-table) tg (car e))
13414 (with-current-buffer buf
13415 (save-excursion (org-todo tg)))
13416 (if exit-after-next (setq exit-after-next 'now)))
13417 ((setq e (rassoc c ntable) tg (car e))
13418 (if (member tg current)
13419 (setq current (delete tg current))
13420 (loop for g in groups do
13421 (if (member tg g)
13422 (mapc (lambda (x)
13423 (setq current (delete x current)))
13424 g)))
13425 (push tg current))
13426 (if exit-after-next (setq exit-after-next 'now))))
13428 ;; Create a sorted list
13429 (setq current
13430 (sort current
13431 (lambda (a b)
13432 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13433 (if (eq exit-after-next 'now) (throw 'exit t))
13434 (goto-char (point-min))
13435 (beginning-of-line 2)
13436 (delete-region (point) (point-at-eol))
13437 (org-fast-tag-insert "Current" current c-face)
13438 (org-set-current-tags-overlay current ov-prefix)
13439 (while (re-search-forward
13441 (setq tg (match-string 1))
13442 (add-text-properties
13443 (match-beginning 1) (match-end 1)
13444 (list 'face
13445 (cond
13446 ((member tg current) c-face)
13447 ((member tg inherited) i-face)
13448 (t (get-text-property (match-beginning 1) 'face))))))
13449 (goto-char (point-min)))))
13450 (org-detach-overlay org-tags-overlay)
13451 (if rtn
13452 (mapconcat 'identity current ":")
13453 nil))))
13455 (defun org-get-tags-string ()
13456 "Get the TAGS string in the current headline."
13457 (unless (org-on-heading-p t)
13458 (error "Not on a heading"))
13459 (save-excursion
13460 (beginning-of-line 1)
13462 (org-match-string-no-properties 1)
13463 "")))
13465 (defun org-get-tags ()
13466 "Get the list of tags specified in the current headline."
13467 (org-split-string (org-get-tags-string) ":"))
13469 (defun org-get-buffer-tags ()
13470 "Get a table of all tags used in the buffer, for completion."
13471 (let (tags)
13472 (save-excursion
13473 (goto-char (point-min))
13474 (while (re-search-forward
13476 (when (equal (char-after (point-at-bol 0)) ?*)
13477 (mapc (lambda (x) (add-to-list 'tags x))
13478 (org-split-string (org-match-string-no-properties 1) ":")))))
13479 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13480 (mapcar 'list tags)))
13482 ;;;; The mapping API
13484 ;;;###autoload
13485 (defun org-map-entries (func &optional match scope &rest skip)
13486 "Call FUNC at each headline selected by MATCH in SCOPE.
13488 FUNC is a function or a lisp form. The function will be called without
13489 arguments, with the cursor positioned at the beginning of the headline.
13490 The return values of all calls to the function will be collected and
13491 returned as a list.
13493 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13494 does not need to preserve point. After evaluation, the cursor will be
13495 moved to the end of the line (presumably of the headline of the
13496 processed entry) and search continues from there. Under some
13497 circumstances, this may not produce the wanted results. For example,
13498 if you have removed (e.g. archived) the current (sub)tree it could
13499 mean that the next entry will be skipped entirely. In such cases, you
13500 can specify the position from where search should continue by making
13501 FUNC set the variable `org-map-continue-from' to the desired buffer
13502 position.
13504 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13505 Only headlines that are matched by this query will be considered during
13506 the iteration. When MATCH is nil or t, all headlines will be
13507 visited by the iteration.
13509 SCOPE determines the scope of this command. It can be any of:
13511 nil The current buffer, respecting the restriction if any
13512 tree The subtree started with the entry at point
13513 file The current buffer, without restriction
13514 file-with-archives
13515 The current buffer, and any archives associated with it
13516 agenda All agenda files
13517 agenda-with-archives
13518 All agenda files with any archive files associated with them
13519 \(file1 file2 ...)
13520 If this is a list, all files in the list will be scanned
13522 The remaining args are treated as settings for the skipping facilities of
13523 the scanner. The following items can be given here:
13525 archive skip trees with the archive tag.
13526 comment skip trees with the COMMENT keyword
13527 function or Emacs Lisp form:
13528 will be used as value for `org-agenda-skip-function', so whenever
13529 the function returns t, FUNC will not be called for that
13530 entry and search will continue from the point where the
13531 function leaves it.
13533 If your function needs to retrieve the tags including inherited tags
13534 at the *current* entry, you can use the value of the variable
13535 `org-scanner-tags' which will be much faster than getting the value
13536 with `org-get-tags-at'. If your function gets properties with
13537 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13538 to t around the call to `org-entry-properties' to get the same speedup.
13539 Note that if your function moves around to retrieve tags and properties at
13540 a *different* entry, you cannot use these techniques."
13541 (let* ((org-agenda-archives-mode nil) ; just to make sure
13542 (org-agenda-skip-archived-trees (memq 'archive skip))
13543 (org-agenda-skip-comment-trees (memq 'comment skip))
13544 (org-agenda-skip-function
13545 (car (org-delete-all '(comment archive) skip)))
13546 (org-tags-match-list-sublevels t)
13547 matcher file res
13548 org-todo-keywords-for-agenda
13549 org-done-keywords-for-agenda
13550 org-todo-keyword-alist-for-agenda
13551 org-drawers-for-agenda
13552 org-tag-alist-for-agenda)
13554 (cond
13555 ((eq match t) (setq matcher t))
13556 ((eq match nil) (setq matcher t))
13557 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13559 (save-excursion
13560 (save-restriction
13561 (when (eq scope 'tree)
13562 (org-back-to-heading t)
13563 (org-narrow-to-subtree)
13564 (setq scope nil))
13566 (if (not scope)
13567 (progn
13568 (org-prepare-agenda-buffers
13569 (list (buffer-file-name (current-buffer))))
13570 (setq res (org-scan-tags func matcher)))
13571 ;; Get the right scope
13572 (cond
13573 ((and scope (listp scope) (symbolp (car scope)))
13574 (setq scope (eval scope)))
13575 ((eq scope 'agenda)
13576 (setq scope (org-agenda-files t)))
13577 ((eq scope 'agenda-with-archives)
13578 (setq scope (org-agenda-files t))
13579 (setq scope (org-add-archive-files scope)))
13580 ((eq scope 'file)
13581 (setq scope (list (buffer-file-name))))
13582 ((eq scope 'file-with-archives)
13583 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13584 (org-prepare-agenda-buffers scope)
13585 (while (setq file (pop scope))
13586 (with-current-buffer (org-find-base-buffer-visiting file)
13587 (save-excursion
13588 (save-restriction
13589 (widen)
13590 (goto-char (point-min))
13591 (setq res (append res (org-scan-tags func matcher))))))))))
13592 res))
13594 ;;;; Properties
13596 ;;; Setting and retrieving properties
13598 (defconst org-special-properties
13599 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13600 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13601 "The special properties valid in Org-mode.
13603 These are properties that are not defined in the property drawer,
13604 but in some other way.")
13606 (defconst org-default-properties
13607 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13608 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13609 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13610 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13611 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13612 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13613 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13614 "Some properties that are used by Org-mode for various purposes.
13615 Being in this list makes sure that they are offered for completion.")
13618 "Regular expression matching the first line of a property drawer.")
13621 "Regular expression matching the last line of a property drawer.")
13624 "Regular expression matching the first line of a property drawer.")
13627 "Regular expression matching the first line of a property drawer.")
13629 (defconst org-property-drawer-re
13632 "Matches an entire property drawer.")
13634 (defconst org-clock-drawer-re
13637 "Matches an entire clock drawer.")
13639 (defsubst org-re-property (property)
13640 "Return a regexp matching PROPERTY.
13641 Match group 1 will be set to the value "
13644 (defun org-property-action ()
13645 "Do an action on properties."
13646 (interactive)
13647 (let (c)
13648 (org-at-property-p)
13649 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13650 (setq c (read-char-exclusive))
13651 (cond
13652 ((equal c ?s)
13653 (call-interactively 'org-set-property))
13654 ((equal c ?d)
13655 (call-interactively 'org-delete-property))
13656 ((equal c ?D)
13657 (call-interactively 'org-delete-property-globally))
13658 ((equal c ?c)
13659 (call-interactively 'org-compute-property-at-point))
13660 (t (error "No such property action %c" c)))))
13662 (defun org-set-effort (&optional value)
13663 "Set the effort property of the current entry.
13664 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13665 allowed value."
13666 (interactive "P")
13667 (if (equal value 0) (setq value 10))
13668 (let* ((completion-ignore-case t)
13669 (prop org-effort-property)
13670 (cur (org-entry-get nil prop))
13671 (allowed (org-property-get-allowed-values nil prop 'table))
13672 (existing (mapcar 'list (org-property-values prop)))
13673 rpl
13674 (val (cond
13675 ((stringp value) value)
13676 ((and allowed (integerp value))
13677 (or (car (nth (1- value) allowed))
13678 (car (org-last allowed))))
13679 (allowed
13680 (message "Select 1-9,0, [RET%s]: %s"
13681 (if cur (concat "=" cur) "")
13682 (mapconcat 'car allowed " "))
13683 (setq rpl (read-char-exclusive))
13685 cur
13686 (setq rpl (- rpl ?0))
13687 (if (equal rpl 0) (setq rpl 10))
13688 (if (and (> rpl 0) (<= rpl (length allowed)))
13689 (car (nth (1- rpl) allowed))
13690 (org-completing-read "Effort: " allowed nil))))
13691 (t
13692 (let (org-completion-use-ido org-completion-use-iswitchb)
13693 (org-completing-read
13695 (concat "[" cur "]") "")
13696 ": ")
13697 existing nil nil "" nil cur))))))
13698 (unless (equal (org-entry-get nil prop) val)
13699 (org-entry-put nil prop val))
13700 (message "%s is now %s" prop val)))
13702 (defun org-at-property-p ()
13703 "Is cursor inside a property drawer?"
13704 (save-excursion
13705 (beginning-of-line 1)
13707 (save-match-data ;; Used by calling procedures
13708 (let ((p (point))
13709 (range (unless (org-before-first-heading-p)
13710 (org-get-property-block))))
13711 (and range (<= (car range) p) (< p (cdr range))))))))
13713 (defun org-get-property-block (&optional beg end force)
13714 "Return the (beg . end) range of the body of the property drawer.
13715 BEG and END can be beginning and end of subtree, if not given
13716 they will be found.
13717 If the drawer does not exist and FORCE is non-nil, create the drawer."
13718 (catch 'exit
13719 (save-excursion
13720 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13721 (end (or end (progn (outline-next-heading) (point)))))
13722 (goto-char beg)
13723 (if (re-search-forward org-property-start-re end t)
13724 (setq beg (1+ (match-end 0)))
13725 (if force
13726 (save-excursion
13727 (org-insert-property-drawer)
13728 (setq end (progn (outline-next-heading) (point))))
13729 (throw 'exit nil))
13730 (goto-char beg)
13731 (if (re-search-forward org-property-start-re end t)
13732 (setq beg (1+ (match-end 0)))))
13733 (if (re-search-forward org-property-end-re end t)
13734 (setq end (match-beginning 0))
13735 (or force (throw 'exit nil))
13736 (goto-char beg)
13737 (setq end beg)
13738 (org-indent-line-function)
13740 (cons beg end)))))
13742 (defun org-entry-properties (&optional pom which specific)
13743 "Get all properties of the entry at point-or-marker POM.
13744 This includes the TODO keyword, the tags, time strings for deadline,
13745 scheduled, and clocking, and any additional properties defined in the
13746 entry. The return value is an alist, keys may occur multiple times
13747 if the property key was used several times.
13748 POM may also be nil, in which case the current entry is used.
13749 If WHICH is nil or `all', get all properties. If WHICH is
13750 `special' or `standard', only get that subclass. If WHICH
13751 is a string only get exactly this property. SPECIFIC can be a string, the
13752 specific property we are interested in. Specifying it can speed
13753 things up because then unnecessary parsing is avoided."
13754 (setq which (or which 'all))
13755 (org-with-point-at pom
13756 (let ((clockstr (substring org-clock-string 0 -1))
13757 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13758 (case-fold-search nil)
13759 beg end range props sum-props key key1 value string clocksum)
13760 (save-excursion
13761 (when (condition-case nil
13762 (and (org-mode-p) (org-back-to-heading t))
13763 (error nil))
13764 (setq beg (point))
13765 (setq sum-props (get-text-property (point) 'org-summaries))
13766 (setq clocksum (get-text-property (point) :org-clock-minutes))
13767 (outline-next-heading)
13768 (setq end (point))
13769 (when (memq which '(all special))
13770 ;; Get the special properties, like TODO and tags
13771 (goto-char beg)
13772 (when (and (or (not specific) (string= specific "TODO"))
13773 (looking-at org-todo-line-regexp) (match-end 2))
13774 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13775 (when (and (or (not specific) (string= specific "PRIORITY"))
13776 (looking-at org-priority-regexp))
13777 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13778 (when (or (not specific) (string= specific "FILE"))
13779 (push (cons "FILE" buffer-file-name) props))
13780 (when (and (or (not specific) (string= specific "TAGS"))
13781 (setq value (org-get-tags-string))
13783 (push (cons "TAGS" value) props))
13784 (when (and (or (not specific) (string= specific "ALLTAGS"))
13785 (setq value (org-get-tags-at)))
13786 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13787 ":"))
13788 props))
13789 (when (or (not specific) (string= specific "BLOCKED"))
13790 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13791 (when (or (not specific)
13792 (member specific
13793 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13794 "TIMESTAMP" "TIMESTAMP_IA")))
13795 (catch 'match
13796 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13797 (setq key (if (match-end 1)
13798 (substring (org-match-string-no-properties 1)
13799 0 -1))
13800 string (if (equal key clockstr)
13801 (org-no-properties
13802 (org-trim
13803 (buffer-substring
13804 (match-beginning 3) (goto-char
13805 (point-at-eol)))))
13806 (substring (org-match-string-no-properties 3)
13807 1 -1)))
13808 ;; Get the correct property name from the key. This is
13809 ;; necessary if the user has configured time keywords.
13810 (setq key1 (concat key ":"))
13811 (cond
13812 ((not key)
13813 (setq key
13814 (if (= (char-after (match-beginning 3)) ?\[)
13815 "TIMESTAMP_IA" "TIMESTAMP")))
13816 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13817 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13818 ((equal key1 org-closed-string) (setq key "CLOSED"))
13819 ((equal key1 org-clock-string) (setq key "CLOCK")))
13820 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13821 (progn
13822 (push (cons key string) props)
13823 ;; no need to search further if match is found
13824 (throw 'match t))
13825 (when (or (equal key "CLOCK") (not (assoc key props)))
13826 (push (cons key string) props))))))
13827 )
13829 (when (memq which '(all standard))
13830 ;; Get the standard properties, like :PROP: ...
13831 (setq range (org-get-property-block beg end))
13832 (when range
13833 (goto-char (car range))
13834 (while (re-search-forward
13836 (cdr range) t)
13837 (setq key (org-match-string-no-properties 1)
13838 value (org-trim (or (org-match-string-no-properties 2) "")))
13839 (unless (member key excluded)
13840 (push (cons key (or value "")) props)))))
13841 (if clocksum
13842 (push (cons "CLOCKSUM"
13843 (org-columns-number-to-string (/ (float clocksum) 60.)
13844 'add_times))
13845 props))
13846 (unless (assoc "CATEGORY" props)
13847 (push (cons "CATEGORY" (org-get-category)) props))
13848 (append sum-props (nreverse props)))))))
13850 (defun org-entry-get (pom property &optional inherit literal-nil)
13851 "Get value of PROPERTY for entry at point-or-marker POM.
13852 If INHERIT is non-nil and the entry does not have the property,
13853 then also check higher levels of the hierarchy.
13854 If INHERIT is the symbol `selective', use inheritance only if the setting
13855 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13856 If the property is present but empty, the return value is the empty string.
13857 If the property is not present at all, nil is returned.
13860 do not interpret it as the list atom nil. This is used for inheritance
13862 (org-with-point-at pom
13863 (if (and inherit (if (eq inherit 'selective)
13864 (org-property-inherit-p property)
13865 t))
13866 (org-entry-get-with-inheritance property literal-nil)
13867 (if (member property org-special-properties)
13868 ;; We need a special property. Use `org-entry-properties' to
13869 ;; retrieve it, but specify the wanted property
13870 (cdr (assoc property (org-entry-properties nil 'special property)))
13871 (let ((range (unless (org-before-first-heading-p)
13872 (org-get-property-block))))
13873 (if (and range
13874 (goto-char (car range))
13875 (re-search-forward
13876 (org-re-property property)
13877 (cdr range) t))
13878 ;; Found the property, return it.
13879 (if (match-end 1)
13880 (if literal-nil
13881 (org-match-string-no-properties 1)
13882 (org-not-nil (org-match-string-no-properties 1)))
13883 "")))))))
13885 (defun org-property-or-variable-value (var &optional inherit)
13886 "Check if there is a property fixing the value of VAR.
13887 If yes, return this value. If not, return the current value of the variable."
13888 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13890 (read prop)
13891 (symbol-value var))))
13893 (defun org-entry-delete (pom property)
13894 "Delete the property PROPERTY from entry at point-or-marker POM."
13895 (org-with-point-at pom
13896 (if (member property org-special-properties)
13897 nil ; cannot delete these properties.
13898 (let ((range (org-get-property-block)))
13899 (if (and range
13900 (goto-char (car range))
13901 (re-search-forward
13902 (org-re-property property)
13903 (cdr range) t))
13904 (progn
13905 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13906 t)
13907 nil)))))
13909 ;; Multi-values properties are properties that contain multiple values
13910 ;; These values are assumed to be single words, separated by whitespace.
13911 (defun org-entry-add-to-multivalued-property (pom property value)
13912 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13913 (let* ((old (org-entry-get pom property))
13915 (setq value (org-entry-protect-space value))
13916 (unless (member value values)
13917 (setq values (cons value values))
13918 (org-entry-put pom property
13919 (mapconcat 'identity values " ")))))
13921 (defun org-entry-remove-from-multivalued-property (pom property value)
13922 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13923 (let* ((old (org-entry-get pom property))
13925 (setq value (org-entry-protect-space value))
13926 (when (member value values)
13927 (setq values (delete value values))
13928 (org-entry-put pom property
13929 (mapconcat 'identity values " ")))))
13931 (defun org-entry-member-in-multivalued-property (pom property value)
13932 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13933 (let* ((old (org-entry-get pom property))
13935 (setq value (org-entry-protect-space value))
13936 (member value values)))
13938 (defun org-entry-get-multivalued-property (pom property)
13939 "Return a list of values in a multivalued property."
13940 (let* ((value (org-entry-get pom property))
13942 (mapcar 'org-entry-restore-space values)))
13944 (defun org-entry-put-multivalued-property (pom property &rest values)
13945 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13946 VALUES should be a list of strings. Spaces will be protected."
13947 (org-entry-put pom property
13948 (mapconcat 'org-entry-protect-space values " "))
13949 (let* ((value (org-entry-get pom property))
13951 (mapcar 'org-entry-restore-space values)))
13953 (defun org-entry-protect-space (s)
13954 "Protect spaces and newline in string S."
13955 (while (string-match " " s)
13956 (setq s (replace-match "%20" t t s)))
13958 (setq s (replace-match "%0A" t t s)))
13959 s)
13961 (defun org-entry-restore-space (s)
13962 "Restore spaces and newline in string S."
13963 (while (string-match "%20" s)
13964 (setq s (replace-match " " t t s)))
13965 (while (string-match "%0A" s)
13967 s)
13969 (defvar org-entry-property-inherited-from (make-marker)
13970 "Marker pointing to the entry from where a property was inherited.
13971 Each call to `org-entry-get-with-inheritance' will set this marker to the
13972 location of the entry where the inheritance search matched. If there was
13973 no match, the marker will point nowhere.
13974 Note that also `org-entry-get' calls this function, if the INHERIT flag
13975 is set.")
13977 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13978 "Get entry property, and search higher levels if not present.
13979 The search will stop at the first ancestor which has the property defined.
13981 should be considered as undefined (this is the meaning of nil here).
13983 (move-marker org-entry-property-inherited-from nil)
13984 (let (tmp)
13985 (unless (org-before-first-heading-p)
13986 (save-excursion
13987 (save-restriction
13988 (widen)
13989 (catch 'ex
13990 (while t
13991 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13992 (org-back-to-heading t)
13993 (move-marker org-entry-property-inherited-from (point))
13994 (throw 'ex tmp))
13995 (or (org-up-heading-safe) (throw 'ex nil)))))))
13996 (setq tmp (or tmp
13997 (cdr (assoc property org-file-properties))
13998 (cdr (assoc property org-global-properties))
13999 (cdr (assoc property org-global-properties-fixed))))
14000 (if literal-nil tmp (org-not-nil tmp))))
14002 (defvar org-property-changed-functions nil
14003 "Hook called when the value of a property has changed.
14004 Each hook function should accept two arguments, the name of the property
14005 and the new value.")
14007 (defun org-entry-put (pom property value)
14008 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14009 (org-with-point-at pom
14010 (org-back-to-heading t)
14011 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14012 range)
14013 (cond
14014 ((equal property "TODO")
14016 (not (member value org-todo-keywords-1)))
14018 (if (or (not value)
14020 (setq value 'none))
14021 (org-todo value)
14022 (org-set-tags nil 'align))
14023 ((equal property "PRIORITY")
14025 (string-to-char value) ?\ ))
14026 (org-set-tags nil 'align))
14027 ((equal property "SCHEDULED")
14028 (if (re-search-forward org-scheduled-time-regexp end t)
14029 (cond
14030 ((eq value 'earlier) (org-timestamp-change -1 'day))
14031 ((eq value 'later) (org-timestamp-change 1 'day))
14032 (t (call-interactively 'org-schedule)))
14033 (call-interactively 'org-schedule)))
14034 ((equal property "DEADLINE")
14035 (if (re-search-forward org-deadline-time-regexp end t)
14036 (cond
14037 ((eq value 'earlier) (org-timestamp-change -1 'day))
14038 ((eq value 'later) (org-timestamp-change 1 'day))
14039 (t (call-interactively 'org-deadline)))
14040 (call-interactively 'org-deadline)))
14041 ((member property org-special-properties)
14042 (error "The %s property can not yet be set with `org-entry-put'"
14043 property))
14044 (t ; a non-special property
14045 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14046 (setq range (org-get-property-block beg end 'force))
14047 (goto-char (car range))
14048 (if (re-search-forward
14049 (org-re-property property) (cdr range) t)
14050 (progn
14051 (delete-region (match-beginning 0) (match-end 0))
14052 (goto-char (match-beginning 0)))
14053 (goto-char (cdr range))
14055 (backward-char 1)
14056 (org-indent-line-function))
14057 (insert ":" property ":")
14058 (and value (insert " " value))
14059 (org-indent-line-function)))))
14060 (run-hook-with-args 'org-property-changed-functions property value)))
14062 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14063 "Get all property keys in the current buffer.
14064 With INCLUDE-SPECIALS, also list the special properties that reflect things
14065 like tags and TODO state.
14066 With INCLUDE-DEFAULTS, also include properties that has special meaning
14067 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14068 and others.
14069 With INCLUDE-COLUMNS, also include property names given in COLUMN
14070 formats in the current buffer."
14071 (let (rtn range cfmt s p)
14072 (save-excursion
14073 (save-restriction
14074 (widen)
14075 (goto-char (point-min))
14076 (while (re-search-forward org-property-start-re nil t)
14077 (setq range (org-get-property-block))
14078 (goto-char (car range))
14079 (while (re-search-forward
14081 (cdr range) t)
14082 (add-to-list 'rtn (org-match-string-no-properties 1)))
14083 (outline-next-heading))))
14085 (when include-specials
14086 (setq rtn (append org-special-properties rtn)))
14088 (when include-defaults
14089 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14090 (add-to-list 'rtn org-effort-property))
14092 (when include-columns
14093 (save-excursion
14094 (save-restriction
14095 (widen)
14096 (goto-char (point-min))
14097 (while (re-search-forward
14099 nil t)
14100 (setq cfmt (match-string 2) s 0)
14102 cfmt s)
14103 (setq s (match-end 0)
14104 p (match-string 1 cfmt))
14105 (unless (or (equal p "ITEM")
14106 (member p org-special-properties))
14107 (add-to-list 'rtn (match-string 1 cfmt))))))))
14109 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14111 (defun org-property-values (key)
14112 "Return a list of all values of property KEY in the current buffer."
14113 (save-excursion
14114 (save-restriction
14115 (widen)
14116 (goto-char (point-min))
14117 (let ((re (org-re-property key))
14118 values)
14119 (while (re-search-forward re nil t)
14120 (add-to-list 'values (org-trim (match-string 1))))
14121 (delete "" values)))))
14123 (defun org-insert-property-drawer ()
14124 "Insert a property drawer into the current entry."
14125 (interactive)
14126 (org-back-to-heading t)
14127 (looking-at org-outline-regexp)
14128 (let ((indent (if org-adapt-indentation
14129 (- (match-end 0)(match-beginning 0))
14130 0))
14131 (beg (point))
14133 end hiddenp)
14134 (outline-next-heading)
14135 (setq end (point))
14136 (goto-char beg)
14137 (while (re-search-forward re end t))
14138 (setq hiddenp (outline-invisible-p))
14139 (end-of-line 1)
14142 (if (member (match-string 1) '("CLOCK:" ":END:"))
14143 ;; just skip this line
14144 (beginning-of-line 2)
14145 ;; Drawer start, find the end
14147 (beginning-of-line 1)))
14148 (org-skip-over-state-notes)
14150 (if (eq (char-before) ?*) (forward-char 1))
14152 (beginning-of-line 0)
14153 (org-indent-to-column indent)
14154 (beginning-of-line 2)
14155 (org-indent-to-column indent)
14156 (beginning-of-line 0)
14157 (if hiddenp
14158 (save-excursion
14159 (org-back-to-heading t)
14160 (hide-entry))
14161 (org-flag-drawer t))))
14163 (defvar org-property-set-functions-alist nil
14164 "Property set function alist.
14165 Each entry should have the following format:
14167 (PROPERTY . READ-FUNCTION)
14169 The read function will be called with the same argument as
14170 `org-completing-read'.")
14172 (defun org-set-property-function (property)
14173 "Get the function that should be used to set PROPERTY.
14174 This is computed according to `org-property-set-functions-alist'."
14175 (or (cdr (assoc property org-property-set-functions-alist))
14176 'org-completing-read))
14178 (defun org-read-property-value (property)
14179 "Read PROPERTY value from user."
14180 (let* ((completion-ignore-case t)
14181 (allowed (org-property-get-allowed-values nil property 'table))
14182 (cur (org-entry-get nil property))
14183 (prompt (concat property " value"
14185 (concat " [" cur "]") "") ": "))
14186 (set-function (org-set-property-function property))
14187 (val (if allowed
14188 (funcall set-function prompt allowed nil
14189 (not (get-text-property 0 'org-unrestricted
14190 (caar allowed))))
14191 (let (org-completion-use-ido org-completion-use-iswitchb)
14192 (funcall set-function prompt
14193 (mapcar 'list (org-property-values property))
14194 nil nil "" nil cur)))))
14195 (if (equal val "")
14196 cur
14197 val)))
14199 (defvar org-last-set-property nil)
14200 (defun org-read-property-name ()
14201 "Read a property name."
14202 (let* ((completion-ignore-case t)
14203 (keys (org-buffer-property-keys nil t t))
14204 (default-prop (or (save-excursion
14205 (save-match-data
14206 (beginning-of-line)
14208 (null (string= (match-string 1) "END"))
14209 (match-string 1))))
14210 org-last-set-property))
14211 (property (org-icompleting-read
14212 (concat "Property"
14213 (if default-prop (concat " [" default-prop "]") "")
14214 ": ")
14215 (mapcar 'list keys)
14216 nil nil nil nil
14217 default-prop
14218 )))
14219 (if (member property keys)
14220 property
14221 (or (cdr (assoc (downcase property)
14222 (mapcar (lambda (x) (cons (downcase x) x))
14223 keys)))
14224 property))))
14226 (defun org-set-property (property value)
14227 "In the current entry, set PROPERTY to VALUE.
14228 When called interactively, this will prompt for a property name, offering
14229 completion on existing and default properties. And then it will prompt
14230 for a value, offering completion either on allowed values (via an inherited
14231 xxx_ALL property) or on existing values in other instances of this property
14232 in the current file."
14233 (interactive (list nil nil))
14234 (let* ((property (or property (org-read-property-name)))
14235 (value (or value (org-read-property-value property))))
14236 (setq org-last-set-property property)
14237 (unless (equal (org-entry-get nil property) value)
14238 (org-entry-put nil property value))))
14240 (defun org-delete-property (property)
14241 "In the current entry, delete PROPERTY."
14242 (interactive
14243 (let* ((completion-ignore-case t)
14244 (prop (org-icompleting-read "Property: "
14245 (org-entry-properties nil 'standard))))
14246 (list prop)))
14247 (message "Property %s %s" property
14248 (if (org-entry-delete nil property)
14249 "deleted"
14250 "was not present in the entry")))
14252 (defun org-delete-property-globally (property)
14253 "Remove PROPERTY globally, from all entries."
14254 (interactive
14255 (let* ((completion-ignore-case t)
14256 (prop (org-icompleting-read
14257 "Globally remove property: "
14258 (mapcar 'list (org-buffer-property-keys)))))
14259 (list prop)))
14260 (save-excursion
14261 (save-restriction
14262 (widen)
14263 (goto-char (point-min))
14264 (let ((cnt 0))
14265 (while (re-search-forward
14266 (org-re-property property)
14267 nil t)
14268 (setq cnt (1+ cnt))
14269 (replace-match ""))
14272 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14274 (defun org-compute-property-at-point ()
14275 "Compute the property at point.
14276 This looks for an enclosing column format, extracts the operator and
14277 then applies it to the property in the column format's scope."
14278 (interactive)
14279 (unless (org-at-property-p)
14280 (error "Not at a property"))
14281 (let ((prop (org-match-string-no-properties 2)))
14282 (org-columns-get-format-and-top-level)
14283 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14284 (error "No operator defined for property %s" prop))
14285 (org-columns-compute prop)))
14287 (defvar org-property-allowed-value-functions nil
14288 "Hook for functions supplying allowed values for a specific property.
14289 The functions must take a single argument, the name of the property, and
14291 the values, this means that these values are intended as defaults for
14292 completion, but that other values should be allowed too.
14293 The functions must return nil if they are not responsible for this
14294 property.")
14296 (defun org-property-get-allowed-values (pom property &optional table)
14297 "Get allowed values for the property PROPERTY.
14298 When TABLE is non-nil, return an alist that can directly be used for
14299 completion."
14300 (let (vals)
14301 (cond
14302 ((equal property "TODO")
14303 (setq vals (org-with-point-at pom
14304 (append org-todo-keywords-1 '("")))))
14305 ((equal property "PRIORITY")
14306 (let ((n org-lowest-priority))
14307 (while (>= n org-highest-priority)
14308 (push (char-to-string n) vals)
14309 (setq n (1- n)))))
14310 ((member property org-special-properties))
14311 ((setq vals (run-hook-with-args-until-success
14312 'org-property-allowed-value-functions property)))
14313 (t
14314 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14316 (setq vals (car (read-from-string (concat "(" vals ")"))))
14317 (setq vals (mapcar (lambda (x)
14318 (cond ((stringp x) x)
14319 ((numberp x) (number-to-string x))
14320 ((symbolp x) (symbol-name x))
14321 (t "???")))
14322 vals)))))
14323 (when (member ":ETC" vals)
14324 (setq vals (remove ":ETC" vals))
14325 (org-add-props (car vals) '(org-unrestricted t)))
14326 (if table (mapcar 'list vals) vals)))
14328 (defun org-property-previous-allowed-value (&optional previous)
14329 "Switch to the next allowed value for this property."
14330 (interactive)
14331 (org-property-next-allowed-value t))
14333 (defun org-property-next-allowed-value (&optional previous)
14334 "Switch to the next allowed value for this property."
14335 (interactive)
14336 (unless (org-at-property-p)
14337 (error "Not at a property"))
14338 (let* ((key (match-string 2))
14339 (value (match-string 3))
14340 (allowed (or (org-property-get-allowed-values (point) key)
14341 (and (member value '("[ ]" "[-]" "[X]"))
14342 '("[ ]" "[X]"))))
14343 nval)
14344 (unless allowed
14345 (error "Allowed values for this property have not been defined"))
14346 (if previous (setq allowed (reverse allowed)))
14347 (if (member value allowed)
14348 (setq nval (car (cdr (member value allowed)))))
14349 (setq nval (or nval (car allowed)))
14350 (if (equal nval value)
14351 (error "Only one allowed value for this property"))
14352 (org-at-property-p)
14353 (replace-match (concat " :" key ": " nval) t t)
14354 (org-indent-line-function)
14355 (beginning-of-line 1)
14357 (run-hook-with-args 'org-property-changed-functions key nval)))
14359 (defun org-find-olp (path &optional this-buffer)
14360 "Return a marker pointing to the entry at outline path OLP.
14361 If anything goes wrong, throw an error.
14362 You can wrap this call to catch the error like this:
14364 (condition-case msg
14365 (org-mobile-locate-entry (match-string 4))
14366 (error (nth 1 msg)))
14368 The return value will then be either a string with the error message,
14369 or a marker if everything is OK.
14371 If THIS-BUFFER is set, the outline path does not contain a file,
14372 only headings."
14373 (let* ((file (if this-buffer buffer-file-name (pop path)))
14374 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14375 (level 1)
14376 (lmin 1)
14377 (lmax 1)
14378 limit re end found pos heading cnt flevel)
14379 (unless buffer (error "File not found :%s" file))
14380 (with-current-buffer buffer
14381 (save-excursion
14382 (save-restriction
14383 (widen)
14384 (setq limit (point-max))
14385 (goto-char (point-min))
14386 (while (setq heading (pop path))
14387 (setq re (format org-complex-heading-regexp-format
14388 (regexp-quote heading)))
14389 (setq cnt 0 pos (point))
14390 (while (re-search-forward re end t)
14391 (setq level (- (match-end 1) (match-beginning 1)))
14392 (if (and (>= level lmin) (<= level lmax))
14393 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14394 (when (= cnt 0) (error "Heading not found on level %d: %s"
14395 lmax heading))
14396 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14397 lmax heading))
14398 (goto-char found)
14399 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14400 (setq end (save-excursion (org-end-of-subtree t t))))
14401 (when (org-on-heading-p)
14402 (move-marker (make-marker) (point))))))))
14404 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14405 "Find node HEADING in BUFFER.
14406 Return a marker to the heading if it was found, or nil if not.
14407 If POS-ONLY is set, return just the position instead of a marker.
14409 The heading text must match exact, but it may have a TODO keyword,
14410 a priority cookie and tags in the standard locations."
14411 (with-current-buffer (or buffer (current-buffer))
14412 (save-excursion
14413 (save-restriction
14414 (widen)
14415 (goto-char (point-min))
14416 (let (case-fold-search)
14417 (if (re-search-forward
14418 (format org-complex-heading-regexp-format
14419 (regexp-quote heading)) nil t)
14420 (if pos-only
14421 (match-beginning 0)
14422 (move-marker (make-marker) (match-beginning 0)))))))))
14424 (defun org-find-exact-heading-in-directory (heading &optional dir)
14425 "Find Org node headline HEADING in all .org files in directory DIR.
14426 When the target headline is found, return a marker to this location."
14427 (let ((files (directory-files (or dir default-directory)
14429 file visiting m buffer)
14430 (catch 'found
14431 (while (setq file (pop files))
14432 (message "trying %s" file)
14433 (setq visiting (org-find-base-buffer-visiting file))
14434 (setq buffer (or visiting (find-file-noselect file)))
14435 (setq m (org-find-exact-headline-in-buffer
14436 heading buffer))
14437 (when (and (not m) (not visiting)) (kill-buffer buffer))
14438 (and m (throw 'found m))))))
14440 (defun org-find-entry-with-id (ident)
14441 "Locate the entry that contains the ID property with exact value IDENT.
14442 IDENT can be a string, a symbol or a number, this function will search for
14443 the string representation of it.
14444 Return the position where this entry starts, or nil if there is no such entry."
14445 (interactive "sID: ")
14446 (let ((id (cond
14447 ((stringp ident) ident)
14448 ((symbol-name ident) (symbol-name ident))
14449 ((numberp ident) (number-to-string ident))
14450 (t (error "IDENT %s must be a string, symbol or number" ident))))
14451 (case-fold-search nil))
14452 (save-excursion
14453 (save-restriction
14454 (widen)
14455 (goto-char (point-min))
14456 (when (re-search-forward
14458 nil t)
14459 (org-back-to-heading t)
14460 (point))))))
14462 ;;;; Timestamps
14464 (defvar org-last-changed-timestamp nil)
14465 (defvar org-last-inserted-timestamp nil
14466 "The last time stamp inserted with `org-insert-time-stamp'.")
14467 (defvar org-time-was-given) ; dynamically scoped parameter
14468 (defvar org-end-time-was-given) ; dynamically scoped parameter
14469 (defvar org-ts-what) ; dynamically scoped parameter
14471 (defun org-time-stamp (arg &optional inactive)
14472 "Prompt for a date/time and insert a time stamp.
14473 If the user specifies a time like HH:MM, or if this command is called
14474 with a prefix argument, the time stamp will contain date and time.
14475 Otherwise, only the date will be included. All parts of a date not
14476 specified by the user will be filled in from the current date/time.
14477 So if you press just return without typing anything, the time stamp
14478 will represent the current date/time. If there is already a timestamp
14479 at the cursor, it will be modified."
14480 (interactive "P")
14481 (let* ((ts nil)
14482 (default-time
14483 ;; Default time is either today, or, when entering a range,
14484 ;; the range start.
14485 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14486 (save-excursion
14487 (re-search-backward
14489 (- (point) 20) t)))
14490 (apply 'encode-time (org-parse-time-string (match-string 1)))
14491 (current-time)))
14492 (default-input (and ts (org-get-compact-tod ts)))
14493 (repeater (save-excursion
14494 (save-match-data
14495 (beginning-of-line)
14496 (when (re-search-forward
14498 (save-excursion (progn (end-of-line) (point))) t)
14499 (match-string 0)))))
14500 org-time-was-given org-end-time-was-given time)
14501 (cond
14502 ((and (org-at-timestamp-p t)
14503 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14504 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14505 (insert "--")
14506 (setq time (let ((this-command this-command))
14507 (org-read-date arg 'totime nil nil
14508 default-time default-input)))
14509 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14510 ((org-at-timestamp-p t)
14511 (setq time (let ((this-command this-command))
14512 (org-read-date arg 'totime nil nil default-time default-input)))
14513 (when (org-at-timestamp-p t) ; just to get the match data
14514 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14515 (replace-match "")
14516 (setq org-last-changed-timestamp
14517 (org-insert-time-stamp
14518 time (or org-time-was-given arg)
14519 inactive nil nil (list org-end-time-was-given)))
14520 (when repeater (goto-char (1- (point))) (insert " " repeater)
14521 (setq org-last-changed-timestamp
14522 (concat (substring org-last-inserted-timestamp 0 -1)
14523 " " repeater ">"))))
14524 (message "Timestamp updated"))
14525 (t
14526 (setq time (let ((this-command this-command))
14527 (org-read-date arg 'totime nil nil default-time default-input)))
14528 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14529 nil nil (list org-end-time-was-given))))))
14531 ;; FIXME: can we use this for something else, like computing time differences?
14532 (defun org-get-compact-tod (s)
14533 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14534 (let* ((t1 (match-string 1 s))
14535 (h1 (string-to-number (match-string 2 s)))
14536 (m1 (string-to-number (match-string 3 s)))
14537 (t2 (and (match-end 4) (match-string 5 s)))
14538 (h2 (and t2 (string-to-number (match-string 6 s))))
14539 (m2 (and t2 (string-to-number (match-string 7 s))))
14540 dh dm)
14541 (if (not t2)
14542 t1
14543 (setq dh (- h2 h1) dm (- m2 m1))
14544 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14545 (concat t1 "+" (number-to-string dh)
14546 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14548 (defun org-time-stamp-inactive (&optional arg)
14549 "Insert an inactive time stamp.
14550 An inactive time stamp is enclosed in square brackets instead of angle
14551 brackets. It is inactive in the sense that it does not trigger agenda entries,
14552 does not link to the calendar and cannot be changed with the S-cursor keys.
14553 So these are more for recording a certain time/date."
14554 (interactive "P")
14555 (org-time-stamp arg 'inactive))
14557 (defvar org-date-ovl (make-overlay 1 1))
14558 (overlay-put org-date-ovl 'face 'org-warning)
14559 (org-detach-overlay org-date-ovl)
14561 (defvar org-ans1) ; dynamically scoped parameter
14562 (defvar org-ans2) ; dynamically scoped parameter
14564 (defvar org-plain-time-of-day-regexp) ; defined below
14566 (defvar org-overriding-default-time nil) ; dynamically scoped
14567 (defvar org-read-date-overlay nil)
14568 (defvar org-dcst nil) ; dynamically scoped
14569 (defvar org-read-date-history nil)
14570 (defvar org-read-date-final-answer nil)
14571 (defvar org-read-date-analyze-futurep nil)
14572 (defvar org-read-date-analyze-forced-year nil)
14574 (defun org-read-date (&optional with-time to-time from-string prompt
14575 default-time default-input)
14576 "Read a date, possibly a time, and make things smooth for the user.
14577 The prompt will suggest to enter an ISO date, but you can also enter anything
14578 which will at least partially be understood by `parse-time-string'.
14579 Unrecognized parts of the date will default to the current day, month, year,
14580 hour and minute. If this command is called to replace a timestamp at point,
14581 of to enter the second timestamp of a range, the default time is taken
14582 from the existing stamp. Furthermore, the command prefers the future,
14583 so if you are giving a date where the year is not given, and the day-month
14584 combination is already past in the current year, it will assume you
14585 mean next year. For details, see the manual. A few examples:
14587 3-2-5 --> 2003-02-05
14588 feb 15 --> currentyear-02-15
14589 2/15 --> currentyear-02-15
14590 sep 12 9 --> 2009-09-12
14591 12:45 --> today 12:45
14592 22 sept 0:34 --> currentyear-09-22 0:34
14593 12 --> currentyear-currentmonth-12
14594 Fri --> nearest Friday (today or later)
14595 etc.
14597 Furthermore you can specify a relative date by giving, as the *first* thing
14598 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14599 change in days weeks, months, years.
14600 With a single plus or minus, the date is relative to today. With a double
14601 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14602 +4d --> four days from today
14603 +4 --> same as above
14604 +2w --> two weeks from today
14605 ++5 --> five days from default date
14607 The function understands only English month and weekday abbreviations,
14608 but this can be configured with the variables `parse-time-months' and
14609 `parse-time-weekdays'.
14611 While prompting, a calendar is popped up - you can also select the
14612 date with the mouse (button 1). The calendar shows a period of three
14613 months. To scroll it to other months, use the keys `>' and `<'.
14614 If you don't like the calendar, turn it off with
14615 \(setq org-read-date-popup-calendar nil)
14617 With optional argument TO-TIME, the date will immediately be converted
14618 to an internal time.
14619 With an optional argument WITH-TIME, the prompt will suggest to also
14620 insert a time. Note that when WITH-TIME is not set, you can still
14621 enter a time, and this function will inform the calling routine about
14622 this change. The calling routine may then choose to change the format
14623 used to insert the time stamp into the buffer to include the time.
14624 With optional argument FROM-STRING, read from this string instead from
14625 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14626 the time/date that is used for everything that is not specified by the
14627 user."
14628 (require 'parse-time)
14629 (let* ((org-time-stamp-rounding-minutes
14630 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14631 (org-dcst org-display-custom-times)
14632 (ct (org-current-time))
14633 (def (or org-overriding-default-time default-time ct))
14634 (defdecode (decode-time def))
14635 (dummy (progn
14636 (when (< (nth 2 defdecode) org-extend-today-until)
14637 (setcar (nthcdr 2 defdecode) -1)
14638 (setcar (nthcdr 1 defdecode) 59)
14639 (setq def (apply 'encode-time defdecode)
14640 defdecode (decode-time def)))))
14641 (calendar-frame-setup nil)
14642 (calendar-setup nil)
14643 (calendar-move-hook nil)
14644 (calendar-view-diary-initially-flag nil)
14645 (calendar-view-holidays-initially-flag nil)
14646 (timestr (format-time-string
14647 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14648 (prompt (concat (if prompt (concat prompt " ") "")
14649 (format "Date+time [%s]: " timestr)))
14650 ans (org-ans0 "") org-ans1 org-ans2 final)
14652 (cond
14653 (from-string (setq ans from-string))
14654 (org-read-date-popup-calendar
14655 (save-excursion
14656 (save-window-excursion
14657 (calendar)
14658 (unwind-protect
14659 (progn
14660 (calendar-forward-day (- (time-to-days def)
14661 (calendar-absolute-from-gregorian
14662 (calendar-current-date))))
14663 (org-eval-in-calendar nil t)
14664 (let* ((old-map (current-local-map))
14665 (map (copy-keymap calendar-mode-map))
14666 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14667 (org-defkey map (kbd "RET") 'org-calendar-select)
14668 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14669 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14670 (org-defkey minibuffer-local-map [(meta shift left)]
14671 (lambda () (interactive)
14672 (org-eval-in-calendar '(calendar-backward-month 1))))
14673 (org-defkey minibuffer-local-map [(meta shift right)]
14674 (lambda () (interactive)
14675 (org-eval-in-calendar '(calendar-forward-month 1))))
14676 (org-defkey minibuffer-local-map [(meta shift up)]
14677 (lambda () (interactive)
14678 (org-eval-in-calendar '(calendar-backward-year 1))))
14679 (org-defkey minibuffer-local-map [(meta shift down)]
14680 (lambda () (interactive)
14681 (org-eval-in-calendar '(calendar-forward-year 1))))
14682 (org-defkey minibuffer-local-map [?\e (shift left)]
14683 (lambda () (interactive)
14684 (org-eval-in-calendar '(calendar-backward-month 1))))
14685 (org-defkey minibuffer-local-map [?\e (shift right)]
14686 (lambda () (interactive)
14687 (org-eval-in-calendar '(calendar-forward-month 1))))
14688 (org-defkey minibuffer-local-map [?\e (shift up)]
14689 (lambda () (interactive)
14690 (org-eval-in-calendar '(calendar-backward-year 1))))
14691 (org-defkey minibuffer-local-map [?\e (shift down)]
14692 (lambda () (interactive)
14693 (org-eval-in-calendar '(calendar-forward-year 1))))
14694 (org-defkey minibuffer-local-map [(shift up)]
14695 (lambda () (interactive)
14696 (org-eval-in-calendar '(calendar-backward-week 1))))
14697 (org-defkey minibuffer-local-map [(shift down)]
14698 (lambda () (interactive)
14699 (org-eval-in-calendar '(calendar-forward-week 1))))
14700 (org-defkey minibuffer-local-map [(shift left)]
14701 (lambda () (interactive)
14702 (org-eval-in-calendar '(calendar-backward-day 1))))
14703 (org-defkey minibuffer-local-map [(shift right)]
14704 (lambda () (interactive)
14705 (org-eval-in-calendar '(calendar-forward-day 1))))
14706 (org-defkey minibuffer-local-map ">"
14707 (lambda () (interactive)
14708 (org-eval-in-calendar '(scroll-calendar-left 1))))
14709 (org-defkey minibuffer-local-map "<"
14710 (lambda () (interactive)
14711 (org-eval-in-calendar '(scroll-calendar-right 1))))
14712 (org-defkey minibuffer-local-map "\C-v"
14713 (lambda () (interactive)
14714 (org-eval-in-calendar
14715 '(calendar-scroll-left-three-months 1))))
14716 (org-defkey minibuffer-local-map "\M-v"
14717 (lambda () (interactive)
14718 (org-eval-in-calendar
14719 '(calendar-scroll-right-three-months 1))))
14720 (run-hooks 'org-read-date-minibuffer-setup-hook)
14721 (unwind-protect
14722 (progn
14723 (use-local-map map)
14724 (add-hook 'post-command-hook 'org-read-date-display)
14725 (setq org-ans0 (read-string prompt default-input
14726 'org-read-date-history nil))
14727 ;; org-ans0: from prompt
14728 ;; org-ans1: from mouse click
14729 ;; org-ans2: from calendar motion
14730 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14731 (remove-hook 'post-command-hook 'org-read-date-display)
14732 (use-local-map old-map)
14733 (when org-read-date-overlay
14734 (delete-overlay org-read-date-overlay)
14735 (setq org-read-date-overlay nil)))))
14736 (bury-buffer "*Calendar*")))))
14738 (t ; Naked prompt only
14739 (unwind-protect
14740 (setq ans (read-string prompt default-input
14741 'org-read-date-history timestr))
14742 (when org-read-date-overlay
14743 (delete-overlay org-read-date-overlay)
14744 (setq org-read-date-overlay nil)))))
14746 (setq final (org-read-date-analyze ans def defdecode))
14748 (when org-read-date-analyze-forced-year
14749 (message "Year was forced into %s"
14750 (if org-read-date-force-compatible-dates
14751 "compatible range (1970-2037)"
14752 "range representable on this machine"))
14753 (ding))
14755 ;; One round trip to get rid of 34th of August and stuff like that....
14756 (setq final (decode-time (apply 'encode-time final)))
14758 (setq org-read-date-final-answer ans)
14760 (if to-time
14761 (apply 'encode-time final)
14762 (if (and (boundp 'org-time-was-given) org-time-was-given)
14763 (format "%04d-%02d-%02d %02d:%02d"
14764 (nth 5 final) (nth 4 final) (nth 3 final)
14765 (nth 2 final) (nth 1 final))
14766 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14768 (defvar def)
14769 (defvar defdecode)
14770 (defvar with-time)
14771 (defun org-read-date-display ()
14772 "Display the current date prompt interpretation in the minibuffer."
14773 (when org-read-date-display-live
14774 (when org-read-date-overlay
14775 (delete-overlay org-read-date-overlay))
14776 (let ((p (point)))
14777 (end-of-line 1)
14778 (while (not (equal (buffer-substring
14779 (max (point-min) (- (point) 4)) (point))
14780 " "))
14781 (insert " "))
14782 (goto-char p))
14783 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14784 " " (or org-ans1 org-ans2)))
14785 (org-end-time-was-given nil)
14786 (f (org-read-date-analyze ans def defdecode))
14787 (fmts (if org-dcst
14788 org-time-stamp-custom-formats
14789 org-time-stamp-formats))
14790 (fmt (if (or with-time
14791 (and (boundp 'org-time-was-given) org-time-was-given))
14792 (cdr fmts)
14793 (car fmts)))
14794 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14795 (when (and org-end-time-was-given
14796 (string-match org-plain-time-of-day-regexp txt))
14797 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14798 org-end-time-was-given
14799 (substring txt (match-end 0)))))
14800 (when org-read-date-analyze-futurep
14801 (setq txt (concat txt " (=>F)")))
14802 (setq org-read-date-overlay
14803 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14804 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14806 (defun org-read-date-analyze (ans def defdecode)
14807 "Analyze the combined answer of the date prompt."
14808 ;; FIXME: cleanup and comment
14809 (let ((nowdecode (decode-time (current-time)))
14810 delta deltan deltaw deltadef year month day
14811 hour minute second wday pm h2 m2 tl wday1
14812 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14813 (setq org-read-date-analyze-futurep nil
14814 org-read-date-analyze-forced-year nil)
14816 (setq ans "+0"))
14818 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14819 (setq ans (replace-match "" t t ans)
14820 deltan (car delta)
14821 deltaw (nth 1 delta)
14822 deltadef (nth 2 delta)))
14824 ;; Check if there is an iso week date in there
14825 ;; If yes, store the info and postpone interpreting it until the rest
14826 ;; of the parsing is done
14827 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14828 (setq iso-year (if (match-end 1)
14829 (org-small-year-to-year
14830 (string-to-number (match-string 1 ans))))
14831 iso-weekday (if (match-end 3)
14832 (string-to-number (match-string 3 ans)))
14833 iso-week (string-to-number (match-string 2 ans)))
14834 (setq ans (replace-match "" t t ans)))
14836 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14837 (when (string-match
14839 (setq year (if (match-end 2)
14840 (string-to-number (match-string 2 ans))
14841 (progn (setq kill-year t)
14842 (string-to-number (format-time-string "%Y"))))
14843 month (string-to-number (match-string 3 ans))
14844 day (string-to-number (match-string 4 ans)))
14845 (if (< year 100) (setq year (+ 2000 year)))
14847 t nil ans)))
14849 ;; Help matching dottet european dates
14850 (when (string-match
14851 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14852 (setq year (if (match-end 3)
14853 (string-to-number (match-string 3 ans))
14854 (progn (setq kill-year t)
14855 (string-to-number (format-time-string "%Y"))))
14856 day (string-to-number (match-string 1 ans))
14857 month (string-to-number (match-string 2 ans))
14859 t nil ans)))
14861 ;; Help matching american dates, like 5/30 or 5/30/7
14862 (when (string-match
14863 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14864 (setq year (if (match-end 4)
14865 (string-to-number (match-string 4 ans))
14866 (progn (setq kill-year t)
14867 (string-to-number (format-time-string "%Y"))))
14868 month (string-to-number (match-string 1 ans))
14869 day (string-to-number (match-string 2 ans)))
14870 (if (< year 100) (setq year (+ 2000 year)))
14872 t nil ans)))
14873 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14874 ;; If there is a time with am/pm, and *no* time without it, we convert
14875 ;; so that matching will be successful.
14876 (loop for i from 1 to 2 do ; twice, for end time as well
14879 (setq hour (string-to-number (match-string 1 ans))
14880 minute (if (match-end 3)
14881 (string-to-number (match-string 3 ans))
14882 0)
14883 pm (equal ?p
14884 (string-to-char (downcase (match-string 4 ans)))))
14885 (if (and (= hour 12) (not pm))
14886 (setq hour 0)
14887 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14888 (setq ans (replace-match (format "%02d:%02d" hour minute)
14889 t t ans))))
14891 ;; Check if a time range is given as a duration
14892 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14893 (setq hour (string-to-number (match-string 1 ans))
14894 h2 (+ hour (string-to-number (match-string 3 ans)))
14895 minute (string-to-number (match-string 2 ans))
14896 m2 (+ minute (if (match-end 5) (string-to-number
14897 (match-string 5 ans))0)))
14898 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14899 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14900 t t ans)))
14902 ;; Check if there is a time range
14903 (when (boundp 'org-end-time-was-given)
14904 (setq org-time-was-given nil)
14905 (when (and (string-match org-plain-time-of-day-regexp ans)
14906 (match-end 8))
14907 (setq org-end-time-was-given (match-string 8 ans))
14908 (setq ans (concat (substring ans 0 (match-beginning 7))
14909 (substring ans (match-end 7))))))
14911 (setq tl (parse-time-string ans)
14912 day (or (nth 3 tl) (nth 3 defdecode))
14913 month (or (nth 4 tl)
14914 (if (and org-read-date-prefer-future
14915 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14916 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14917 (nth 4 defdecode)))
14918 year (or (and (not kill-year) (nth 5 tl))
14919 (if (and org-read-date-prefer-future
14920 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14921 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14922 (nth 5 defdecode)))
14923 hour (or (nth 2 tl) (nth 2 defdecode))
14924 minute (or (nth 1 tl) (nth 1 defdecode))
14925 second (or (nth 0 tl) 0)
14926 wday (nth 6 tl))
14928 (when (and (eq org-read-date-prefer-future 'time)
14929 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14930 (equal day (nth 3 nowdecode))
14931 (equal month (nth 4 nowdecode))
14932 (equal year (nth 5 nowdecode))
14933 (nth 2 tl)
14934 (or (< (nth 2 tl) (nth 2 nowdecode))
14935 (and (= (nth 2 tl) (nth 2 nowdecode))
14936 (nth 1 tl)
14937 (< (nth 1 tl) (nth 1 nowdecode)))))
14938 (setq day (1+ day)
14939 futurep t))
14941 ;; Special date definitions below
14942 (cond
14943 (iso-week
14944 ;; There was an iso week
14945 (require 'cal-iso)
14946 (setq futurep nil)
14947 (setq year (or iso-year year)
14948 day (or iso-weekday wday 1)
14949 wday nil ; to make sure that the trigger below does not match
14950 iso-date (calendar-gregorian-from-absolute
14951 (calendar-absolute-from-iso
14952 (list iso-week day year))))
14953 ; FIXME: Should we also push ISO weeks into the future?
14954 ; (when (and org-read-date-prefer-future
14955 ; (not iso-year)
14956 ; (< (calendar-absolute-from-gregorian iso-date)
14957 ; (time-to-days (current-time))))
14958 ; (setq year (1+ year)
14959 ; iso-date (calendar-gregorian-from-absolute
14960 ; (calendar-absolute-from-iso
14961 ; (list iso-week day year)))))
14962 (setq month (car iso-date)
14963 year (nth 2 iso-date)
14964 day (nth 1 iso-date)))
14965 (deltan
14966 (setq futurep nil)
14967 (unless deltadef
14968 (let ((now (decode-time (current-time))))
14969 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14970 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14971 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14972 ((equal deltaw "m") (setq month (+ month deltan)))
14973 ((equal deltaw "y") (setq year (+ year deltan)))))
14974 ((and wday (not (nth 3 tl)))
14975 (setq futurep nil)
14976 ;; Weekday was given, but no day, so pick that day in the week
14977 ;; on or after the derived date.
14978 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14979 (unless (equal wday wday1)
14980 (setq day (+ day (% (- wday wday1 -7) 7))))))
14981 (if (and (boundp 'org-time-was-given)
14982 (nth 2 tl))
14983 (setq org-time-was-given t))
14984 (if (< year 100) (setq year (+ 2000 year)))
14985 ;; Check of the date is representable
14986 (if org-read-date-force-compatible-dates
14987 (progn
14988 (if (< year 1970)
14989 (setq year 1970 org-read-date-analyze-forced-year t))
14990 (if (> year 2037)
14991 (setq year 2037 org-read-date-analyze-forced-year t)))
14992 (condition-case nil
14993 (ignore (encode-time second minute hour day month year))
14994 (error
14995 (setq year (nth 5 defdecode))
14996 (setq org-read-date-analyze-forced-year t))))
14997 (setq org-read-date-analyze-futurep futurep)
14998 (list second minute hour day month year)))
15000 (defvar parse-time-weekdays)
15002 (defun org-read-date-get-relative (s today default)
15003 "Check string S for special relative date string.
15004 TODAY and DEFAULT are internal times, for today and for a default.
15005 Return shift list (N what def-flag)
15007 N is the number of WHATs to shift.
15008 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15009 the DEFAULT date rather than TODAY."
15010 (when (and
15011 (string-match
15012 (concat
15017 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15018 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15019 (string-to-char (substring (match-string 1 s) -1))
15020 ?+))
15021 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15022 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15023 (what (if (match-end 3) (match-string 3 s) "d"))
15024 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15025 (date (if rel default today))
15026 (wday (nth 6 (decode-time date)))
15027 delta)
15028 (if wday1
15029 (progn
15030 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15031 (if (= dir ?-) (setq delta (- delta 7)))
15032 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15033 (list delta "d" rel))
15034 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15036 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15037 "Turn a user-specified date into the internal representation.
15038 The internal representation needed by the calendar is (month day year).
15039 This is a wrapper to handle the brain-dead convention in calendar that
15040 user function argument order change dependent on argument order."
15041 (if (boundp 'calendar-date-style)
15042 (cond
15043 ((eq calendar-date-style 'american)
15044 (list arg1 arg2 arg3))
15045 ((eq calendar-date-style 'european)
15046 (list arg2 arg1 arg3))
15047 ((eq calendar-date-style 'iso)
15048 (list arg2 arg3 arg1)))
15049 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15050 (if (org-bound-and-true-p european-calendar-style)
15051 (list arg2 arg1 arg3)
15052 (list arg1 arg2 arg3)))))
15054 (defun org-eval-in-calendar (form &optional keepdate)
15055 "Eval FORM in the calendar window and return to current window.
15056 Also, store the cursor date in variable org-ans2."
15057 (let ((sf (selected-frame))
15058 (sw (selected-window)))
15059 (select-window (get-buffer-window "*Calendar*" t))
15060 (eval form)
15061 (when (and (not keepdate) (calendar-cursor-to-date))
15062 (let* ((date (calendar-cursor-to-date))
15063 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15064 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15065 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15066 (select-window sw)
15067 (org-select-frame-set-input-focus sf)))
15069 (defun org-calendar-select ()
15070 "Return to `org-read-date' with the date currently selected.
15071 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15072 (interactive)
15073 (when (calendar-cursor-to-date)
15074 (let* ((date (calendar-cursor-to-date))
15075 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15076 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15077 (if (active-minibuffer-window) (exit-minibuffer))))
15079 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15080 "Insert a date stamp for the date given by the internal TIME.
15081 WITH-HM means use the stamp format that includes the time of the day.
15082 INACTIVE means use square brackets instead of angular ones, so that the
15083 stamp will not contribute to the agenda.
15084 PRE and POST are optional strings to be inserted before and after the
15085 stamp.
15086 The command returns the inserted time stamp."
15087 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15088 stamp)
15089 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15090 (insert-before-markers (or pre ""))
15091 (when (listp extra)
15092 (setq extra (car extra))
15093 (if (and (stringp extra)
15095 (setq extra (format "-%02d:%02d"
15096 (string-to-number (match-string 1 extra))
15097 (string-to-number (match-string 2 extra))))
15098 (setq extra nil)))
15099 (when extra
15100 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15101 (insert-before-markers (setq stamp (format-time-string fmt time)))
15102 (insert-before-markers (or post ""))
15103 (setq org-last-inserted-timestamp stamp)))
15105 (defun org-toggle-time-stamp-overlays ()
15106 "Toggle the use of custom time stamp formats."
15107 (interactive)
15108 (setq org-display-custom-times (not org-display-custom-times))
15109 (unless org-display-custom-times
15110 (let ((p (point-min)) (bmp (buffer-modified-p)))
15111 (while (setq p (next-single-property-change p 'display))
15112 (if (and (get-text-property p 'display)
15113 (eq (get-text-property p 'face) 'org-date))
15114 (remove-text-properties
15115 p (setq p (next-single-property-change p 'display))
15116 '(display t))))
15117 (set-buffer-modified-p bmp)))
15118 (if (featurep 'xemacs)
15119 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15120 (org-restart-font-lock)
15121 (setq org-table-may-need-update t)
15122 (if org-display-custom-times
15123 (message "Time stamps are overlayed with custom format")
15124 (message "Time stamp overlays removed")))
15126 (defun org-display-custom-time (beg end)
15127 "Overlay modified time stamp format over timestamp between BEG and END."
15128 (let* ((ts (buffer-substring beg end))
15129 t1 w1 with-hm tf time str w2 (off 0))
15130 (save-match-data
15131 (setq t1 (org-parse-time-string ts t))
15132 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15133 (setq off (- (match-end 0) (match-beginning 0)))))
15134 (setq end (- end off))
15135 (setq w1 (- end beg)
15136 with-hm (and (nth 1 t1) (nth 2 t1))
15137 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15138 time (org-fix-decoded-time t1)
15139 str (org-add-props
15140 (format-time-string
15141 (substring tf 1 -1) (apply 'encode-time time))
15142 nil 'mouse-face 'highlight)
15143 w2 (length str))
15144 (if (not (= w2 w1))
15145 (add-text-properties (1+ beg) (+ 2 beg)
15146 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15147 (if (featurep 'xemacs)
15148 (progn
15149 (put-text-property beg end 'invisible t)
15150 (put-text-property beg end 'end-glyph (make-glyph str)))
15151 (put-text-property beg end 'display str))))
15153 (defun org-translate-time (string)
15154 "Translate all timestamps in STRING to custom format.
15155 But do this only if the variable `org-display-custom-times' is set."
15156 (when org-display-custom-times
15157 (save-match-data
15158 (let* ((start 0)
15159 (re org-ts-regexp-both)
15160 t1 with-hm inactive tf time str beg end)
15161 (while (setq start (string-match re string start))
15162 (setq beg (match-beginning 0)
15163 end (match-end 0)
15164 t1 (save-match-data
15165 (org-parse-time-string (substring string beg end) t))
15166 with-hm (and (nth 1 t1) (nth 2 t1))
15167 inactive (equal (substring string beg (1+ beg)) "[")
15168 tf (funcall (if with-hm 'cdr 'car)
15169 org-time-stamp-custom-formats)
15170 time (org-fix-decoded-time t1)
15171 str (format-time-string
15172 (concat
15173 (if inactive "[" "<") (substring tf 1 -1)
15174 (if inactive "]" ">"))
15175 (apply 'encode-time time))
15176 string (replace-match str t t string)
15177 start (+ start (length str)))))))
15178 string)
15180 (defun org-fix-decoded-time (time)
15181 "Set 0 instead of nil for the first 6 elements of time.
15182 Don't touch the rest."
15183 (let ((n 0))
15184 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15186 (defun org-days-to-time (timestamp-string)
15187 "Difference between TIMESTAMP-STRING and now in days."
15188 (- (time-to-days (org-time-string-to-time timestamp-string))
15189 (time-to-days (current-time))))
15191 (defun org-deadline-close (timestamp-string &optional ndays)
15192 "Is the time in TIMESTAMP-STRING close to the current date?"
15193 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15194 (and (< (org-days-to-time timestamp-string) ndays)
15195 (not (org-entry-is-done-p))))
15197 (defun org-get-wdays (ts)
15198 "Get the deadline lead time appropriate for timestring TS."
15199 (cond
15200 ((<= org-deadline-warning-days 0)
15201 ;; 0 or negative, enforce this value no matter what
15202 (- org-deadline-warning-days))
15204 ;; lead time is specified.
15205 (floor (* (string-to-number (match-string 1 ts))
15206 (cdr (assoc (match-string 2 ts)
15207 '(("d" . 1) ("w" . 7)
15208 ("m" . 30.4) ("y" . 365.25)))))))
15209 ;; go for the default.
15210 (t org-deadline-warning-days)))
15212 (defun org-calendar-select-mouse (ev)
15213 "Return to `org-read-date' with the date currently selected.
15214 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15215 (interactive "e")
15216 (mouse-set-point ev)
15217 (when (calendar-cursor-to-date)
15218 (let* ((date (calendar-cursor-to-date))
15219 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15220 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15221 (if (active-minibuffer-window) (exit-minibuffer))))
15223 (defun org-check-deadlines (ndays)
15224 "Check if there are any deadlines due or past due.
15225 A deadline is considered due if it happens within `org-deadline-warning-days'
15226 days from today's date. If the deadline appears in an entry marked DONE,
15227 it is not shown. The prefix arg NDAYS can be used to test that many
15229 (interactive "P")
15230 (let* ((org-warn-days
15231 (cond
15232 ((equal ndays '(4)) 100000)
15233 (ndays (prefix-numeric-value ndays))
15234 (t (abs org-deadline-warning-days))))
15235 (case-fold-search nil)
15237 (callback
15238 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15240 (message "%d deadlines past-due or due within %d days"
15241 (org-occur regexp nil callback)
15242 org-warn-days)))
15244 (defun org-check-before-date (date)
15245 "Check if there are deadlines or scheduled entries before DATE."
15246 (interactive (list (org-read-date)))
15247 (let ((case-fold-search nil)
15251 (callback
15252 (lambda () (time-less-p
15253 (org-time-string-to-time (match-string 2))
15254 (org-time-string-to-time date)))))
15255 (message "%d entries before %s"
15256 (org-occur regexp nil callback) date)))
15258 (defun org-check-after-date (date)
15259 "Check if there are deadlines or scheduled entries after DATE."
15260 (interactive (list (org-read-date)))
15261 (let ((case-fold-search nil)
15265 (callback
15266 (lambda () (not
15267 (time-less-p
15268 (org-time-string-to-time (match-string 2))
15269 (org-time-string-to-time date))))))
15270 (message "%d entries after %s"
15271 (org-occur regexp nil callback) date)))
15273 (defun org-evaluate-time-range (&optional to-buffer)
15274 "Evaluate a time range by computing the difference between start and end.
15275 Normally the result is just printed in the echo area, but with prefix arg
15276 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15277 If the time range is actually in a table, the result is inserted into the
15278 next column.
15279 For time difference computation, a year is assumed to be exactly 365
15280 days in order to avoid rounding problems."
15281 (interactive "P")
15282 (or
15283 (org-clock-update-time-maybe)
15284 (save-excursion
15285 (unless (org-at-date-range-p t)
15286 (goto-char (point-at-bol))
15287 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15288 (if (not (org-at-date-range-p t))
15289 (error "Not at a time-stamp range, and none found in current line")))
15290 (let* ((ts1 (match-string 1))
15291 (ts2 (match-string 2))
15292 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15293 (match-end (match-end 0))
15294 (time1 (org-time-string-to-time ts1))
15295 (time2 (org-time-string-to-time ts2))
15296 (t1 (org-float-time time1))
15297 (t2 (org-float-time time2))
15298 (diff (abs (- t2 t1)))
15299 (negative (< (- t2 t1) 0))
15300 ;; (ys (floor (* 365 24 60 60)))
15301 (ds (* 24 60 60))
15302 (hs (* 60 60))
15303 (fy "%dy %dd %02d:%02d")
15304 (fy1 "%dy %dd")
15305 (fd "%dd %02d:%02d")
15306 (fd1 "%dd")
15307 (fh "%02d:%02d")
15308 y d h m align)
15309 (if havetime
15310 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15311 y 0
15312 d (floor (/ diff ds)) diff (mod diff ds)
15313 h (floor (/ diff hs)) diff (mod diff hs)
15314 m (floor (/ diff 60)))
15315 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15316 y 0
15317 d (floor (+ (/ diff ds) 0.5))
15318 h 0 m 0))
15319 (if (not to-buffer)
15320 (message "%s" (org-make-tdiff-string y d h m))
15321 (if (org-at-table-p)
15322 (progn
15323 (goto-char match-end)
15324 (setq align t)
15325 (and (looking-at " *|") (goto-char (match-end 0))))
15326 (goto-char match-end))
15327 (if (looking-at
15329 (replace-match ""))
15330 (if negative (insert " -"))
15331 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15332 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15333 (insert " " (format fh h m))))
15334 (if align (org-table-align))
15335 (message "Time difference inserted")))))
15337 (defun org-make-tdiff-string (y d h m)
15338 (let ((fmt "")
15339 (l nil))
15340 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15341 l (push y l)))
15342 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15343 l (push d l)))
15344 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15345 l (push h l)))
15346 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15347 l (push m l)))
15348 (apply 'format fmt (nreverse l))))
15350 (defun org-time-string-to-time (s)
15351 (apply 'encode-time (org-parse-time-string s)))
15352 (defun org-time-string-to-seconds (s)
15353 (org-float-time (org-time-string-to-time s)))
15355 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15356 "Convert a time stamp to an absolute day number.
15357 If there is a specifier for a cyclic time stamp, get the closest date to
15358 DAYNR.
15359 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15360 The variable date is bound by the calendar when this is called."
15361 (cond
15363 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15364 daynr
15365 (+ daynr 1000)))
15367 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15368 (time-to-days (current-time))) (match-string 0 s)
15369 prefer show-all))
15370 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15372 (defun org-days-to-iso-week (days)
15373 "Return the iso week number."
15374 (require 'cal-iso)
15375 (car (calendar-iso-from-absolute days)))
15377 (defun org-small-year-to-year (year)
15378 "Convert 2-digit years into 4-digit years.
15379 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15380 The year 2000 cannot be abbreviated. Any year larger than 99
15381 is returned unchanged."
15382 (if (< year 38)
15383 (setq year (+ 2000 year))
15384 (if (< year 100)
15385 (setq year (+ 1900 year))))
15386 year)
15388 (defun org-time-from-absolute (d)
15389 "Return the time corresponding to date D.
15390 D may be an absolute day number, or a calendar-type list (month day year)."
15391 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15392 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15394 (defun org-calendar-holiday ()
15395 "List of holidays, for Diary display in Org-mode."
15396 (require 'holidays)
15397 (let ((hl (funcall
15398 (if (fboundp 'calendar-check-holidays)
15399 'calendar-check-holidays 'check-calendar-holidays) date)))
15400 (if hl (mapconcat 'identity hl "; "))))
15402 (defun org-diary-sexp-entry (sexp entry date)
15403 "Process a SEXP diary ENTRY for DATE."
15404 (require 'diary-lib)
15405 (let ((result (if calendar-debug-sexp
15406 (let ((stack-trace-on-error t))
15407 (eval (car (read-from-string sexp))))
15408 (condition-case nil
15409 (eval (car (read-from-string sexp)))
15410 (error
15411 (beep)
15412 (message "Bad sexp at line %d in %s: %s"
15413 (org-current-line)
15414 (buffer-file-name) sexp)
15415 (sleep-for 2))))))
15416 (cond ((stringp result) (split-string result "; "))
15417 ((and (consp result)
15418 (not (consp (cdr result)))
15419 (stringp (cdr result))) (cdr result))
15420 ((and (consp result)
15421 (stringp (car result))) result)
15422 (result entry)
15423 (t nil))))
15425 (defun org-diary-to-ical-string (frombuf)
15426 "Get iCalendar entries from diary entries in buffer FROMBUF.
15427 This uses the icalendar.el library."
15428 (let* ((tmpdir (if (featurep 'xemacs)
15429 (temp-directory)
15430 temporary-file-directory))
15431 (tmpfile (make-temp-name
15432 (expand-file-name "orgics" tmpdir)))
15433 buf rtn b e)
15434 (with-current-buffer frombuf
15435 (icalendar-export-region (point-min) (point-max) tmpfile)
15436 (setq buf (find-buffer-visiting tmpfile))
15437 (set-buffer buf)
15438 (goto-char (point-min))
15439 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15440 (setq b (match-beginning 0)))
15441 (goto-char (point-max))
15442 (if (re-search-backward "^END:VEVENT" nil t)
15443 (setq e (match-end 0)))
15445 (kill-buffer buf)
15446 (delete-file tmpfile)
15447 rtn))
15449 (defun org-closest-date (start current change prefer show-all)
15450 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15451 When PREFER is `past', return a date that is either CURRENT or past.
15452 When PREFER is `future', return a date that is either CURRENT or future.
15453 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15454 ;; Make the proper lists from the dates
15455 (catch 'exit
15456 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15457 dn dw sday cday n1 n2 n0
15458 d m y y1 y2 date1 date2 nmonths nm ny m2)
15460 (setq start (org-date-to-gregorian start)
15461 current (org-date-to-gregorian
15462 (if show-all
15463 current
15464 (time-to-days (current-time))))
15465 sday (calendar-absolute-from-gregorian start)
15466 cday (calendar-absolute-from-gregorian current))
15468 (if (<= cday sday) (throw 'exit sday))
15471 (setq dn (string-to-number (match-string 1 change))
15472 dw (cdr (assoc (match-string 2 change) a1)))
15473 (error "Invalid change specifier: %s" change))
15474 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15475 (cond
15476 ((eq dw 'day)
15477 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15478 n2 (+ n1 dn)))
15479 ((eq dw 'year)
15480 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15481 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15482 (setq date1 (list m d y1)
15483 n1 (calendar-absolute-from-gregorian date1)
15484 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15485 n2 (calendar-absolute-from-gregorian date2)))
15486 ((eq dw 'month)
15487 ;; approx number of month between the two dates
15488 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15489 ;; How often does dn fit in there?
15490 (setq d (nth 1 start) m (car start) y (nth 2 start)
15491 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15492 m (+ m nm)
15493 ny (floor (/ m 12))
15494 y (+ y ny)
15495 m (- m (* ny 12)))
15496 (while (> m 12) (setq m (- m 12) y (1+ y)))
15497 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15498 (setq m2 (+ m dn) y2 y)
15499 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15500 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15501 (while (<= n2 cday)
15502 (setq n1 n2 m m2 y y2)
15503 (setq m2 (+ m dn) y2 y)
15504 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15505 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15506 ;; Make sure n1 is the earlier date
15507 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15508 (if show-all
15509 (cond
15510 ((eq prefer 'past) (if (= cday n2) n2 n1))
15511 ((eq prefer 'future) (if (= cday n1) n1 n2))
15512 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15513 (cond
15514 ((eq prefer 'past) (if (= cday n2) n2 n1))
15515 ((eq prefer 'future) (if (= cday n1) n1 n2))
15516 (t (if (= cday n1) n1 n2)))))))
15518 (defun org-date-to-gregorian (date)
15519 "Turn any specification of DATE into a Gregorian date for the calendar."
15520 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15521 ((and (listp date) (= (length date) 3)) date)
15522 ((stringp date)
15523 (setq date (org-parse-time-string date))
15524 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15525 ((listp date)
15526 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15528 (defun org-parse-time-string (s &optional nodefault)
15529 "Parse the standard Org-mode time string.
15530 This should be a lot faster than the normal `parse-time-string'.
15531 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15532 hour and minute fields will be nil if not given."
15533 (if (string-match org-ts-regexp0 s)
15534 (list 0
15535 (if (or (match-beginning 8) (not nodefault))
15536 (string-to-number (or (match-string 8 s) "0")))
15537 (if (or (match-beginning 7) (not nodefault))
15538 (string-to-number (or (match-string 7 s) "0")))
15539 (string-to-number (match-string 4 s))
15540 (string-to-number (match-string 3 s))
15541 (string-to-number (match-string 2 s))
15542 nil nil nil)
15543 (error "Not a standard Org-mode time string: %s" s)))
15545 (defun org-timestamp-up (&optional arg)
15546 "Increase the date item at the cursor by one.
15547 If the cursor is on the year, change the year. If it is on the month,
15548 the day or the time, change that.
15549 With prefix ARG, change by that many units."
15550 (interactive "p")
15551 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15553 (defun org-timestamp-down (&optional arg)
15554 "Decrease the date item at the cursor by one.
15555 If the cursor is on the year, change the year. If it is on the month,
15556 the day or the time, change that.
15557 With prefix ARG, change by that many units."
15558 (interactive "p")
15559 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15561 (defun org-timestamp-up-day (&optional arg)
15562 "Increase the date in the time stamp by one day.
15563 With prefix ARG, change that many days."
15564 (interactive "p")
15565 (if (and (not (org-at-timestamp-p t))
15566 (org-on-heading-p))
15567 (org-todo 'up)
15568 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15570 (defun org-timestamp-down-day (&optional arg)
15571 "Decrease the date in the time stamp by one day.
15572 With prefix ARG, change that many days."
15573 (interactive "p")
15574 (if (and (not (org-at-timestamp-p t))
15575 (org-on-heading-p))
15576 (org-todo 'down)
15577 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15579 (defun org-at-timestamp-p (&optional inactive-ok)
15580 "Determine if the cursor is in or at a timestamp."
15581 (interactive)
15582 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15583 (pos (point))
15584 (ans (or (looking-at tsr)
15585 (save-excursion
15587 (if (> (point) (point-min)) (backward-char 1))
15588 (and (looking-at tsr)
15589 (> (- (match-end 0) pos) -1))))))
15590 (and ans
15591 (boundp 'org-ts-what)
15592 (setq org-ts-what
15593 (cond
15594 ((= pos (match-beginning 0)) 'bracket)
15595 ((= pos (1- (match-end 0))) 'bracket)
15596 ((org-pos-in-match-range pos 2) 'year)
15597 ((org-pos-in-match-range pos 3) 'month)
15598 ((org-pos-in-match-range pos 7) 'hour)
15599 ((org-pos-in-match-range pos 8) 'minute)
15600 ((or (org-pos-in-match-range pos 4)
15601 (org-pos-in-match-range pos 5)) 'day)
15602 ((and (> pos (or (match-end 8) (match-end 5)))
15603 (< pos (match-end 0)))
15604 (- pos (or (match-end 8) (match-end 5))))
15605 (t 'day))))
15606 ans))
15608 (defun org-toggle-timestamp-type ()
15609 "Toggle the type (<active> or [inactive]) of a time stamp."
15610 (interactive)
15611 (when (org-at-timestamp-p t)
15612 (let ((beg (match-beginning 0)) (end (match-end 0))
15613 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15614 (save-excursion
15615 (goto-char beg)
15616 (while (re-search-forward "[][<>]" end t)
15617 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15618 t t)))
15619 (message "Timestamp is now %sactive"
15620 (if (equal (char-after beg) ?<) "" "in")))))
15622 (defun org-timestamp-change (n &optional what updown)
15623 "Change the date in the time stamp at point.
15624 The date will be changed by N times WHAT. WHAT can be `day', `month',
15625 `year', `minute', `second'. If WHAT is not given, the cursor position
15626 in the timestamp determines what will be changed."
15627 (let ((origin (point)) origin-cat
15628 with-hm inactive
15629 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15630 org-ts-what
15631 extra rem
15632 ts time time0)
15633 (if (not (org-at-timestamp-p t))
15634 (error "Not at a timestamp"))
15635 (if (and (not what) (eq org-ts-what 'bracket))
15636 (org-toggle-timestamp-type)
15637 ;; Point isn't on brackets. Remember the part of the time-stamp
15638 ;; the point was in. Indeed, size of time-stamps may change,
15639 ;; but point must be kept in the same category nonetheless.
15640 (setq origin-cat org-ts-what)
15641 (if (and (not what) (not (eq org-ts-what 'day))
15642 org-display-custom-times
15643 (get-text-property (point) 'display)
15644 (not (get-text-property (1- (point)) 'display)))
15645 (setq org-ts-what 'day))
15646 (setq org-ts-what (or what org-ts-what)
15647 inactive (= (char-after (match-beginning 0)) ?\[)
15648 ts (match-string 0))
15649 (replace-match "")
15650 (if (string-match
15652 ts)
15653 (setq extra (match-string 1 ts)))
15655 (setq with-hm t))
15656 (setq time0 (org-parse-time-string ts))
15657 (when (and updown
15658 (eq org-ts-what 'minute)
15659 (not current-prefix-arg))
15660 ;; This looks like s-up and s-down. Change by one rounding step.
15661 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15662 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15663 (setcar (cdr time0) (+ (nth 1 time0)
15664 (if (> n 0) (- rem) (- dm rem))))))
15665 (setq time
15666 (encode-time (or (car time0) 0)
15667 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15668 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15669 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15670 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15671 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15672 (nthcdr 6 time0)))
15673 (when (and (member org-ts-what '(hour minute))
15674 extra
15676 (setq extra (org-modify-ts-extra
15677 extra
15678 (if (eq org-ts-what 'hour) 2 5)
15679 n dm)))
15680 (when (integerp org-ts-what)
15681 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15682 (if (eq what 'calendar)
15683 (let ((cal-date (org-get-date-from-calendar)))
15684 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15685 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15686 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15687 (setcar time0 (or (car time0) 0))
15688 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15689 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15690 (setq time (apply 'encode-time time0))))
15691 ;; Insert the new time-stamp, and ensure point stays in the same
15692 ;; category as before (i.e. not after the last position in that
15693 ;; category).
15694 (let ((pos (point)))
15695 ;; Stay before inserted string. `save-excursion' is of no use.
15696 (setq org-last-changed-timestamp
15697 (org-insert-time-stamp time with-hm inactive nil nil extra))
15698 (goto-char pos))
15699 (save-match-data
15700 (looking-at org-ts-regexp3)
15701 (goto-char (cond
15702 ;; `day' category ends before `hour' if any, or at
15703 ;; the end of the day name.
15704 ((eq origin-cat 'day)
15705 (min (or (match-beginning 7) (1- (match-end 5))) origin))
15706 ((eq origin-cat 'hour) (min (match-end 7) origin))
15707 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
15708 ((integerp origin-cat) (min (1- (match-end 0)) origin))
15709 ;; `year' and `month' have both fixed size: point
15710 ;; couldn't have moved into another part.
15711 (t origin))))
15712 ;; Update clock if on a CLOCK line.
15713 (org-clock-update-time-maybe)
15714 ;; Try to recenter the calendar window, if any.
15715 (if (and org-calendar-follow-timestamp-change
15716 (get-buffer-window "*Calendar*" t)
15717 (memq org-ts-what '(day month year)))
15718 (org-recenter-calendar (time-to-days time))))))
15720 (defun org-modify-ts-extra (s pos n dm)
15721 "Change the different parts of the lead-time and repeat fields in timestamp."
15722 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15723 ng h m new rem)
15724 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15725 (cond
15726 ((or (org-pos-in-match-range pos 2)
15727 (org-pos-in-match-range pos 3))
15728 (setq m (string-to-number (match-string 3 s))
15729 h (string-to-number (match-string 2 s)))
15730 (if (org-pos-in-match-range pos 2)
15731 (setq h (+ h n))
15732 (setq n (* dm (org-no-warnings (signum n))))
15733 (when (not (= 0 (setq rem (% m dm))))
15734 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15735 (setq m (+ m n)))
15736 (if (< m 0) (setq m (+ m 60) h (1- h)))
15737 (if (> m 59) (setq m (- m 60) h (1+ h)))
15738 (setq h (min 24 (max 0 h)))
15739 (setq ng 1 new (format "-%02d:%02d" h m)))
15740 ((org-pos-in-match-range pos 6)
15741 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15742 ((org-pos-in-match-range pos 5)
15743 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15745 ((org-pos-in-match-range pos 9)
15746 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15747 ((org-pos-in-match-range pos 8)
15748 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15750 (when ng
15751 (setq s (concat
15752 (substring s 0 (match-beginning ng))
15753 new
15754 (substring s (match-end ng))))))
15755 s))
15757 (defun org-recenter-calendar (date)
15758 "If the calendar is visible, recenter it to DATE."
15759 (let* ((win (selected-window))
15760 (cwin (get-buffer-window "*Calendar*" t))
15761 (calendar-move-hook nil))
15762 (when cwin
15763 (select-window cwin)
15764 (calendar-goto-date (if (listp date) date
15765 (calendar-gregorian-from-absolute date)))
15766 (select-window win))))
15768 (defun org-goto-calendar (&optional arg)
15769 "Go to the Emacs calendar at the current date.
15770 If there is a time stamp in the current line, go to that date.
15771 A prefix ARG can be used to force the current date."
15772 (interactive "P")
15773 (let ((tsr org-ts-regexp) diff
15774 (calendar-move-hook nil)
15775 (calendar-view-holidays-initially-flag nil)
15776 (calendar-view-diary-initially-flag nil))
15777 (if (or (org-at-timestamp-p)
15778 (save-excursion
15779 (beginning-of-line 1)
15780 (looking-at (concat ".*" tsr))))
15781 (let ((d1 (time-to-days (current-time)))
15782 (d2 (time-to-days
15783 (org-time-string-to-time (match-string 1)))))
15784 (setq diff (- d2 d1))))
15785 (calendar)
15786 (calendar-goto-today)
15787 (if (and diff (not arg)) (calendar-forward-day diff))))
15789 (defun org-get-date-from-calendar ()
15790 "Return a list (month day year) of date at point in calendar."
15791 (with-current-buffer "*Calendar*"
15792 (save-match-data
15793 (calendar-cursor-to-date))))
15795 (defun org-date-from-calendar ()
15796 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15797 If there is already a time stamp at the cursor position, update it."
15798 (interactive)
15799 (if (org-at-timestamp-p t)
15800 (org-timestamp-change 0 'calendar)
15801 (let ((cal-date (org-get-date-from-calendar)))
15802 (org-insert-time-stamp
15803 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15805 (defun org-minutes-to-hh:mm-string (m)
15806 "Compute H:MM from a number of minutes."
15807 (let ((h (/ m 60)))
15808 (setq m (- m (* 60 h)))
15809 (format org-time-clocksum-format h m)))
15811 (defun org-hh:mm-string-to-minutes (s)
15812 "Convert a string H:MM to a number of minutes.
15813 If the string is just a number, interpret it as minutes.
15814 In fact, the first hh:mm or number in the string will be taken,
15815 there can be extra stuff in the string.
15816 If no number is found, the return value is 0."
15817 (cond
15818 ((integerp s) s)
15820 (+ (* (string-to-number (match-string 1 s)) 60)
15821 (string-to-number (match-string 2 s))))
15823 (string-to-number (match-string 1 s)))
15824 (t 0)))
15826 (defcustom org-effort-durations
15827 `(("h" . 60)
15828 ("d" . ,(* 60 8))
15829 ("w" . ,(* 60 8 5))
15830 ("m" . ,(* 60 8 5 4))
15831 ("y" . ,(* 60 8 5 40)))
15832 "Conversion factor to minutes for an effort modifier.
15834 Each entry has the form (MODIFIER . MINUTES).
15836 In an effort string, a number followed by MODIFIER is multiplied
15837 by the specified number of MINUTES to obtain an effort in
15838 minutes.
15842 :group 'org-agenda
15843 :type '(alist :key-type (string :tag "Modifier")
15844 :value-type (number :tag "Minutes")))
15846 (defun org-duration-string-to-minutes (s)
15847 "Convert a duration string S to minutes.
15849 A bare number is interpreted as minutes, modifiers can be set by
15850 customizing `org-effort-durations' (which see).
15852 Entries containing a colon are interpreted as H:MM by
15853 `org-hh:mm-string-to-minutes'."
15854 (let ((result 0)
15856 (regexp-opt (mapcar 'car org-effort-durations))
15858 (while (string-match re s)
15859 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15860 (string-to-number (match-string 1 s))))
15861 (setq s (replace-match "" nil t s)))
15862 (incf result (org-hh:mm-string-to-minutes s))
15863 result))
15865 ;;;; Files
15867 (defun org-save-all-org-buffers ()
15868 "Save all Org-mode buffers without user confirmation."
15869 (interactive)
15870 (message "Saving all Org-mode buffers...")
15871 (save-some-buffers t 'org-mode-p)
15872 (when (featurep 'org-id) (org-id-locations-save))
15873 (message "Saving all Org-mode buffers... done"))
15875 (defun org-revert-all-org-buffers ()
15876 "Revert all Org-mode buffers.
15877 Prompt for confirmation when there are unsaved changes.
15878 Be sure you know what you are doing before letting this function
15879 overwrite your changes.
15881 This function is useful in a setup where one tracks org files
15882 with a version control system, to revert on one machine after pulling
15883 changes from another. I believe the procedure must be like this:
15885 1. M-x org-save-all-org-buffers
15886 2. Pull changes from the other machine, resolve conflicts
15887 3. M-x org-revert-all-org-buffers"
15888 (interactive)
15889 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15890 (error "Abort"))
15891 (save-excursion
15892 (save-window-excursion
15893 (mapc
15894 (lambda (b)
15895 (when (and (with-current-buffer b (org-mode-p))
15896 (with-current-buffer b buffer-file-name))
15897 (org-pop-to-buffer-same-window b)
15898 (revert-buffer t 'no-confirm)))
15899 (buffer-list))
15900 (when (and (featurep 'org-id) org-id-track-globally)
15901 (org-id-locations-load)))))
15903 ;;;; Agenda files
15905 ;;;###autoload
15906 (defun org-switchb (&optional arg)
15907 "Switch between Org buffers.
15908 With a prefix argument, restrict available to files.
15909 With two prefix arguments, restrict available buffers to agenda files.
15911 Defaults to `iswitchb' for buffer name completion.
15912 Set `org-completion-use-ido' to make it use ido instead."
15913 (interactive "P")
15914 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15915 ((equal arg '(16)) (org-buffer-list 'agenda))
15916 (t (org-buffer-list))))
15917 (org-completion-use-iswitchb org-completion-use-iswitchb)
15918 (org-completion-use-ido org-completion-use-ido))
15919 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15920 (setq org-completion-use-iswitchb t))
15921 (org-pop-to-buffer-same-window
15922 (org-icompleting-read "Org buffer: "
15923 (mapcar 'list (mapcar 'buffer-name blist))
15924 nil t))))
15926 ;;; Define some older names previously used for this functionality
15927 ;;;###autoload
15928 (defalias 'org-ido-switchb 'org-switchb)
15929 ;;;###autoload
15930 (defalias 'org-iswitchb 'org-switchb)
15932 (defun org-buffer-list (&optional predicate exclude-tmp)
15933 "Return a list of Org buffers.
15934 PREDICATE can be `export', `files' or `agenda'.
15936 export restrict the list to Export buffers.
15937 files restrict the list to buffers visiting Org files.
15938 agenda restrict the list to buffers visiting agenda files.
15940 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15941 (let* ((bfn nil)
15942 (agenda-files (and (eq predicate 'agenda)
15943 (mapcar 'file-truename (org-agenda-files t))))
15944 (filter
15945 (cond
15946 ((eq predicate 'files)
15947 (lambda (b) (with-current-buffer b (org-mode-p))))
15948 ((eq predicate 'export)
15949 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15950 ((eq predicate 'agenda)
15951 (lambda (b)
15952 (with-current-buffer b
15953 (and (org-mode-p)
15954 (setq bfn (buffer-file-name b))
15955 (member (file-truename bfn) agenda-files)))))
15956 (t (lambda (b) (with-current-buffer b
15957 (or (org-mode-p)
15958 (string-match "\*Org .*Export"
15959 (buffer-name b)))))))))
15960 (delq nil
15961 (mapcar
15962 (lambda(b)
15963 (if (and (funcall filter b)
15964 (or (not exclude-tmp)
15965 (not (string-match "tmp" (buffer-name b)))))
15966 b
15967 nil))
15968 (buffer-list)))))
15970 (defun org-agenda-files (&optional unrestricted archives)
15971 "Get the list of agenda files.
15972 Optional UNRESTRICTED means return the full list even if a restriction
15973 is currently in place.
15974 When ARCHIVES is t, include all archive files that are really being
15975 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15976 `org-agenda-archives-mode' is t."
15977 (let ((files
15978 (cond
15979 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15980 ((stringp org-agenda-files) (org-read-agenda-file-list))
15981 ((listp org-agenda-files) org-agenda-files)
15982 (t (error "Invalid value of `org-agenda-files'")))))
15983 (setq files (apply 'append
15984 (mapcar (lambda (f)
15985 (if (file-directory-p f)
15986 (directory-files
15987 f t org-agenda-file-regexp)
15988 (list f)))
15989 files)))
15990 (when org-agenda-skip-unavailable-files
15991 (setq files (delq nil
15992 (mapcar (function
15993 (lambda (file)
15994 (and (file-readable-p file) file)))
15995 files))))
15996 (when (or (eq archives t)
15997 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15998 (setq files (org-add-archive-files files)))
15999 files))
16001 (defun org-agenda-file-p (&optional file)
16002 "Return non-nil, if FILE is an agenda file.
16003 If FILE is omitted, use the file associated with the current
16004 buffer."
16005 (member (or file (buffer-file-name))
16006 (org-agenda-files t)))
16008 (defun org-edit-agenda-file-list ()
16009 "Edit the list of agenda files.
16010 Depending on setup, this either uses customize to edit the variable
16011 `org-agenda-files', or it visits the file that is holding the list. In the
16012 latter case, the buffer is set up in a way that saving it automatically kills
16013 the buffer and restores the previous window configuration."
16014 (interactive)
16015 (if (stringp org-agenda-files)
16016 (let ((cw (current-window-configuration)))
16017 (find-file org-agenda-files)
16018 (org-set-local 'org-window-configuration cw)
16019 (org-add-hook 'after-save-hook
16020 (lambda ()
16021 (set-window-configuration
16022 (prog1 org-window-configuration
16023 (kill-buffer (current-buffer))))
16024 (org-install-agenda-files-menu)
16025 (message "New agenda file list installed"))
16026 nil 'local)
16027 (message "%s" (substitute-command-keys
16029 (customize-variable 'org-agenda-files)))
16031 (defun org-store-new-agenda-file-list (list)
16032 "Set new value for the agenda file list and save it correctly."
16033 (if (stringp org-agenda-files)
16034 (let ((fe (org-read-agenda-file-list t)) b u)
16035 (while (setq b (find-buffer-visiting org-agenda-files))
16036 (kill-buffer b))
16037 (with-temp-file org-agenda-files
16038 (insert
16039 (mapconcat
16040 (lambda (f) ;; Keep un-expanded entries.
16041 (if (setq u (assoc f fe))
16042 (cdr u)
16043 f))
16046 (let ((org-mode-hook nil) (org-inhibit-startup t)
16047 (org-insert-mode-line-in-empty-file nil))
16048 (setq org-agenda-files list)
16049 (customize-save-variable 'org-agenda-files org-agenda-files))))
16051 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16052 "Read the list of agenda files from a file.
16053 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16054 filenames, used by `org-store-new-agenda-file-list' to write back
16055 un-expanded file names."
16056 (when (file-directory-p org-agenda-files)
16057 (error "`org-agenda-files' cannot be a single directory"))
16058 (when (stringp org-agenda-files)
16059 (with-temp-buffer
16060 (insert-file-contents org-agenda-files)
16061 (mapcar
16062 (lambda (f)
16063 (let ((e (expand-file-name (substitute-in-file-name f)
16064 org-directory)))
16065 (if pair-with-expansion
16066 (cons e f)
16067 e)))
16070 ;;;###autoload
16071 (defun org-cycle-agenda-files ()
16072 "Cycle through the files in `org-agenda-files'.
16073 If the current buffer visits an agenda file, find the next one in the list.
16074 If the current buffer does not, find the first agenda file."
16075 (interactive)
16076 (let* ((fs (org-agenda-files t))
16077 (files (append fs (list (car fs))))
16078 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16079 file)
16080 (unless files (error "No agenda files"))
16081 (catch 'exit
16082 (while (setq file (pop files))
16083 (if (equal (file-truename file) tcf)
16084 (when (car files)
16085 (find-file (car files))
16086 (throw 'exit t))))
16087 (find-file (car fs)))
16088 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16090 (defun org-agenda-file-to-front (&optional to-end)
16091 "Move/add the current file to the top of the agenda file list.
16092 If the file is not present in the list, it is added to the front. If it is
16093 present, it is moved there. With optional argument TO-END, add/move to the
16094 end of the list."
16095 (interactive "P")
16096 (let ((org-agenda-skip-unavailable-files nil)
16097 (file-alist (mapcar (lambda (x)
16098 (cons (file-truename x) x))
16099 (org-agenda-files t)))
16100 (ctf (file-truename buffer-file-name))
16101 x had)
16102 (setq x (assoc ctf file-alist) had x)
16104 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16105 (if to-end
16106 (setq file-alist (append (delq x file-alist) (list x)))
16107 (setq file-alist (cons x (delq x file-alist))))
16108 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16109 (org-install-agenda-files-menu)
16110 (message "File %s to %s of agenda file list"
16111 (if had "moved" "added") (if to-end "end" "front"))))
16113 (defun org-remove-file (&optional file)
16114 "Remove current file from the list of files in variable `org-agenda-files'.
16115 These are the files which are being checked for agenda entries.
16116 Optional argument FILE means use this file instead of the current."
16117 (interactive)
16118 (let* ((org-agenda-skip-unavailable-files nil)
16119 (file (or file buffer-file-name))
16120 (true-file (file-truename file))
16121 (afile (abbreviate-file-name file))
16122 (files (delq nil (mapcar
16123 (lambda (x)
16124 (if (equal true-file
16125 (file-truename x))
16126 nil x))
16127 (org-agenda-files t)))))
16128 (if (not (= (length files) (length (org-agenda-files t))))
16129 (progn
16130 (org-store-new-agenda-file-list files)
16131 (org-install-agenda-files-menu)
16132 (message "Removed file: %s" afile))
16133 (message "File was not in list: %s (not removed)" afile))))
16135 (defun org-file-menu-entry (file)
16136 (vector file (list 'find-file file) t))
16138 (defun org-check-agenda-file (file)
16139 "Make sure FILE exists. If not, ask user what to do."
16140 (when (not (file-exists-p file))
16141 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16142 (abbreviate-file-name file))
16143 (let ((r (downcase (read-char-exclusive))))
16144 (cond
16145 ((equal r ?r)
16146 (org-remove-file file)
16147 (throw 'nextfile t))
16148 (t (error "Abort"))))))
16150 (defun org-get-agenda-file-buffer (file)
16151 "Get a buffer visiting FILE. If the buffer needs to be created, add
16152 it to the list of buffers which might be released later."
16153 (let ((buf (org-find-base-buffer-visiting file)))
16154 (if buf
16155 buf ; just return it
16156 ;; Make a new buffer and remember it
16157 (setq buf (find-file-noselect file))
16158 (if buf (push buf org-agenda-new-buffers))
16159 buf)))
16161 (defun org-release-buffers (blist)
16162 "Release all buffers in list, asking the user for confirmation when needed.
16163 When a buffer is unmodified, it is just killed. When modified, it is saved
16164 \(if the user agrees) and then killed."
16165 (let (buf file)
16166 (while (setq buf (pop blist))
16167 (setq file (buffer-file-name buf))
16168 (when (and (buffer-modified-p buf)
16169 file
16170 (y-or-n-p (format "Save file %s? " file)))
16171 (with-current-buffer buf (save-buffer)))
16172 (kill-buffer buf))))
16174 (defun org-prepare-agenda-buffers (files)
16175 "Create buffers for all agenda files, protect archived trees and comments."
16176 (interactive)
16177 (let ((pa '(:org-archived t))
16178 (pc '(:org-comment t))
16179 (pall '(:org-archived t :org-comment t))
16180 (inhibit-read-only t)
16181 (rea (concat ":" org-archive-tag ":"))
16182 bmp file re)
16183 (save-excursion
16184 (save-restriction
16185 (while (setq file (pop files))
16186 (catch 'nextfile
16187 (if (bufferp file)
16188 (set-buffer file)
16189 (org-check-agenda-file file)
16190 (set-buffer (org-get-agenda-file-buffer file)))
16191 (widen)
16192 (setq bmp (buffer-modified-p))
16193 (org-refresh-category-properties)
16194 (setq org-todo-keywords-for-agenda
16195 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16196 (setq org-done-keywords-for-agenda
16197 (append org-done-keywords-for-agenda org-done-keywords))
16198 (setq org-todo-keyword-alist-for-agenda
16199 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16200 (setq org-drawers-for-agenda
16201 (append org-drawers-for-agenda org-drawers))
16202 (setq org-tag-alist-for-agenda
16203 (append org-tag-alist-for-agenda org-tag-alist))
16205 (save-excursion
16206 (remove-text-properties (point-min) (point-max) pall)
16207 (when org-agenda-skip-archived-trees
16208 (goto-char (point-min))
16209 (while (re-search-forward rea nil t)
16210 (if (org-on-heading-p t)
16211 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16212 (goto-char (point-min))
16214 (while (re-search-forward re nil t)
16215 (add-text-properties
16216 (match-beginning 0) (org-end-of-subtree t) pc)))
16217 (set-buffer-modified-p bmp)))))
16218 (setq org-todo-keywords-for-agenda
16219 (org-uniquify org-todo-keywords-for-agenda))
16220 (setq org-todo-keyword-alist-for-agenda
16221 (org-uniquify org-todo-keyword-alist-for-agenda)
16222 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16224 ;;;; Embedded LaTeX
16226 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16227 "Keymap for the minor `org-cdlatex-mode'.")
16229 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16230 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16231 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16232 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16233 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16235 (defvar org-cdlatex-texmathp-advice-is-done nil
16236 "Flag remembering if we have applied the advice to texmathp already.")
16238 (define-minor-mode org-cdlatex-mode
16239 "Toggle the minor `org-cdlatex-mode'.
16240 This mode supports entering LaTeX environment and math in LaTeX fragments
16241 in Org-mode.
16243 nil " OCDL" nil
16244 (when org-cdlatex-mode (require 'cdlatex))
16245 (unless org-cdlatex-texmathp-advice-is-done
16246 (setq org-cdlatex-texmathp-advice-is-done t)
16247 (defadvice texmathp (around org-math-always-on activate)
16248 "Always return t in org-mode buffers.
16249 This is because we want to insert math symbols without dollars even outside
16250 the LaTeX math segments. If Orgmode thinks that point is actually inside
16251 an embedded LaTeX fragment, let texmathp do its job.
16253 (interactive)
16254 (let (p)
16255 (cond
16256 ((not (org-mode-p)) ad-do-it)
16257 ((eq this-command 'cdlatex-math-symbol)
16258 (setq ad-return-value t
16259 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16260 (t
16261 (let ((p (org-inside-LaTeX-fragment-p)))
16262 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16263 (setq ad-return-value t
16264 texmathp-why '("Org-mode embedded math" . 0))
16265 (if p ad-do-it)))))))))
16267 (defun turn-on-org-cdlatex ()
16268 "Unconditionally turn on `org-cdlatex-mode'."
16269 (org-cdlatex-mode 1))
16271 (defun org-inside-LaTeX-fragment-p ()
16272 "Test if point is inside a LaTeX fragment.
16274 sequence appearing also before point.
16275 Even though the matchers for math are configurable, this function assumes
16277 delimiters are skipped when they have been removed by customization.
16278 The return value is nil, or a cons cell with the delimiter and the
16279 position of this delimiter.
16281 This function does a reasonably good job, but can locally be fooled by
16282 for example currency specifications. For example it will assume being in
16284 fragments that are properly closed, but during editing, we have to live
16285 with the uncertainty caused by missing closing delimiters. This function
16286 looks only before point, not after."
16287 (catch 'exit
16288 (let ((pos (point))
16289 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16290 (lim (progn
16292 (point)))
16293 dd-on str (start 0) m re)
16294 (goto-char pos)
16295 (when dodollar
16297 re (nth 1 (assoc "$" org-latex-regexps)))
16298 (while (string-match re str start)
16299 (cond
16300 ((= (match-end 0) (length str))
16301 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16302 ((= (match-end 0) (- (length str) 5))
16303 (throw 'exit nil))
16304 (t (setq start (match-end 0))))))
16305 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16306 (goto-char pos)
16307 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16308 (and (match-beginning 2) (throw 'exit nil))
16309 ;; count $$
16311 (setq dd-on (not dd-on)))
16312 (goto-char pos)
16313 (if dd-on (cons "$$" m))))))
16315 (defun org-inside-latex-macro-p ()
16316 "Is point inside a LaTeX macro or its arguments?"
16317 (save-match-data
16318 (org-in-regexp
16321 (defun org-try-cdlatex-tab ()
16322 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16323 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16324 - inside a LaTeX fragment, or
16325 - after the first word in a line, where an abbreviation expansion could
16326 insert a LaTeX environment."
16327 (when org-cdlatex-mode
16328 (cond
16329 ((save-excursion
16330 (skip-chars-backward "a-zA-Z0-9*")
16332 (bolp))
16333 (cdlatex-tab) t)
16334 ((org-inside-LaTeX-fragment-p)
16335 (cdlatex-tab) t)
16336 (t nil))))
16338 (defun org-cdlatex-underscore-caret (&optional arg)
16339 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16340 Revert to the normal definition outside of these fragments."
16341 (interactive "P")
16342 (if (org-inside-LaTeX-fragment-p)
16343 (call-interactively 'cdlatex-sub-superscript)
16344 (let (org-cdlatex-mode)
16345 (call-interactively (key-binding (vector last-input-event))))))
16347 (defun org-cdlatex-math-modify (&optional arg)
16348 "Execute `cdlatex-math-modify' in LaTeX fragments.
16349 Revert to the normal definition outside of these fragments."
16350 (interactive "P")
16351 (if (org-inside-LaTeX-fragment-p)
16352 (call-interactively 'cdlatex-math-modify)
16353 (let (org-cdlatex-mode)
16354 (call-interactively (key-binding (vector last-input-event))))))
16356 (defvar org-latex-fragment-image-overlays nil
16357 "List of overlays carrying the images of latex fragments.")
16358 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16360 (defun org-remove-latex-fragment-image-overlays ()
16361 "Remove all overlays with LaTeX fragment images in current buffer."
16362 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16363 (setq org-latex-fragment-image-overlays nil))
16365 (defun org-preview-latex-fragment (&optional subtree)
16366 "Preview the LaTeX fragment at point, or all locally or globally.
16367 If the cursor is in a LaTeX fragment, create the image and overlay
16368 it over the source code. If there is no fragment at point, display
16369 all fragments in the current text, from one headline to the next. With
16370 prefix SUBTREE, display all fragments in the current subtree. With a
16372 the cursor is before the first headline,
16373 display all fragments in the buffer.
16375 (interactive "P")
16376 (org-remove-latex-fragment-image-overlays)
16377 (save-excursion
16378 (save-restriction
16379 (let (beg end at msg)
16380 (cond
16381 ((or (equal subtree '(16))
16382 (not (save-excursion
16383 (re-search-backward org-outline-regexp-bol nil t))))
16384 (setq beg (point-min) end (point-max)
16385 msg "Creating images for buffer...%s"))
16386 ((equal subtree '(4))
16387 (org-back-to-heading)
16388 (setq beg (point) end (org-end-of-subtree t)
16389 msg "Creating images for subtree...%s"))
16390 (t
16391 (if (setq at (org-inside-LaTeX-fragment-p))
16392 (goto-char (max (point-min) (- (cdr at) 2)))
16393 (org-back-to-heading))
16394 (setq beg (point) end (progn (outline-next-heading) (point))
16395 msg (if at "Creating image...%s"
16396 "Creating images for entry...%s"))))
16397 (message msg "")
16398 (narrow-to-region beg end)
16399 (goto-char beg)
16400 (org-format-latex
16401 (concat "ltxpng/" (file-name-sans-extension
16402 (file-name-nondirectory
16403 buffer-file-name)))
16404 default-directory 'overlays msg at 'forbuffer 'dvipng)
16405 (message msg "done. Use `C-c C-c' to remove images.")))))
16407 (defvar org-latex-regexps
16409 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16412 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16416 "Regular expressions for matching embedded LaTeX.")
16418 (defvar org-export-have-math nil) ;; dynamic scoping
16419 (defun org-format-latex (prefix &optional dir overlays msg at
16420 forbuffer processing-type)
16421 "Replace LaTeX fragments with links to an image, and produce images.
16422 Some of the options can be changed using the variable
16423 `org-format-latex-options'."
16424 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16425 (let* ((prefixnodir (file-name-nondirectory prefix))
16426 (absprefix (expand-file-name prefix dir))
16427 (todir (file-name-directory absprefix))
16428 (opt org-format-latex-options)
16429 (matchers (plist-get opt :matchers))
16430 (re-list org-latex-regexps)
16431 (org-format-latex-header-extra
16432 (plist-get (org-infile-export-plist) :latex-header-extra))
16433 (cnt 0) txt hash link beg end re e checkdir
16434 executables-checked string
16435 m n block linkfile movefile ov)
16436 ;; Check the different regular expressions
16437 (while (setq e (pop re-list))
16438 (setq m (car e) re (nth 1 e) n (nth 2 e)
16440 (when (member m matchers)
16441 (goto-char (point-min))
16442 (while (re-search-forward re nil t)
16443 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16444 (not (get-text-property (match-beginning n)
16445 'org-protected))
16446 (or (not overlays)
16447 (not (eq (get-char-property (match-beginning n)
16448 'org-overlay-type)
16449 'org-latex-overlay))))
16450 (setq org-export-have-math t)
16451 (cond
16452 ((eq processing-type 'verbatim)
16453 ;; Leave the text verbatim, just protect it
16454 (add-text-properties (match-beginning n) (match-end n)
16455 '(org-protected t)))
16456 ((eq processing-type 'mathjax)
16457 ;; Prepare for MathJax processing
16458 (setq string (match-string n))
16459 (if (member m '("$" "$1"))
16460 (save-excursion
16461 (delete-region (match-beginning n) (match-end n))
16462 (goto-char (match-beginning n))
16465 '(org-protected t))))
16466 (add-text-properties (match-beginning n) (match-end n)
16467 '(org-protected t))))
16468 ((or (eq processing-type 'dvipng) t)
16469 ;; Process to an image
16470 (setq txt (match-string n)
16471 beg (match-beginning n) end (match-end n)
16472 cnt (1+ cnt))
16473 (let (print-length print-level) ; make sure full list is printed
16474 (setq hash (sha1 (prin1-to-string
16475 (list org-format-latex-header
16476 org-format-latex-header-extra
16477 org-export-latex-default-packages-alist
16478 org-export-latex-packages-alist
16479 org-format-latex-options
16480 forbuffer txt)))
16481 linkfile (format "%s_%s.png" prefix hash)
16482 movefile (format "%s_%s.png" absprefix hash)))
16483 (setq link (concat block "[[file:" linkfile "]]" block))
16484 (if msg (message msg cnt))
16485 (goto-char beg)
16486 (unless checkdir ; make sure the directory exists
16487 (setq checkdir t)
16488 (or (file-directory-p todir) (make-directory todir t)))
16490 (unless executables-checked
16491 (org-check-external-command
16492 "latex" "needed to convert LaTeX fragments to images")
16493 (org-check-external-command
16494 "dvipng" "needed to convert LaTeX fragments to images")
16495 (setq executables-checked t))
16497 (unless (file-exists-p movefile)
16498 (org-create-formula-image
16499 txt movefile opt forbuffer))
16500 (if overlays
16501 (progn
16502 (mapc (lambda (o)
16503 (if (eq (overlay-get o 'org-overlay-type)
16504 'org-latex-overlay)
16505 (delete-overlay o)))
16506 (overlays-in beg end))
16507 (setq ov (make-overlay beg end))
16508 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16509 (if (featurep 'xemacs)
16510 (progn
16511 (overlay-put ov 'invisible t)
16512 (overlay-put
16513 ov 'end-glyph
16514 (make-glyph (vector 'png :file movefile))))
16515 (overlay-put
16516 ov 'display
16517 (list 'image :type 'png :file movefile :ascent 'center)))
16518 (push ov org-latex-fragment-image-overlays)
16519 (goto-char end))
16520 (delete-region beg end)
16521 (insert (org-add-props link
16522 (list 'org-latex-src
16523 (replace-regexp-in-string
16526 ;; This function borrows from Ganesh Swami's latex2png.el
16527 (defun org-create-formula-image (string tofile options buffer)
16528 "This calls dvipng."
16529 (require 'org-latex)
16530 (let* ((tmpdir (if (featurep 'xemacs)
16531 (temp-directory)
16532 temporary-file-directory))
16533 (texfilebase (make-temp-name
16534 (expand-file-name "orgtex" tmpdir)))
16535 (texfile (concat texfilebase ".tex"))
16536 (dvifile (concat texfilebase ".dvi"))
16537 (pngfile (concat texfilebase ".png"))
16538 (fnh (if (featurep 'xemacs)
16539 (font-height (get-face-font 'default))
16540 (face-attribute 'default :height nil)))
16541 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16542 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16543 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16544 "Black"))
16545 (bg (or (plist-get options (if buffer :background :html-background))
16546 "Transparent")))
16547 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16548 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16549 (with-temp-file texfile
16550 (insert (org-splice-latex-header
16551 org-format-latex-header
16552 org-export-latex-default-packages-alist
16553 org-export-latex-packages-alist t
16554 org-format-latex-header-extra))
16556 (require 'org-latex)
16557 (org-export-latex-fix-inputenc))
16558 (let ((dir default-directory))
16559 (condition-case nil
16560 (progn
16561 (cd tmpdir)
16562 (call-process "latex" nil nil nil texfile))
16563 (error nil))
16564 (cd dir))
16565 (if (not (file-exists-p dvifile))
16566 (progn (message "Failed to create dvi file from %s" texfile) nil)
16567 (condition-case nil
16568 (call-process "dvipng" nil nil nil
16569 "-fg" fg "-bg" bg
16570 "-D" dpi
16571 ;;"-x" scale "-y" scale
16572 "-T" "tight"
16573 "-o" pngfile
16574 dvifile)
16575 (error nil))
16576 (if (not (file-exists-p pngfile))
16577 (if org-format-latex-signal-error
16578 (error "Failed to create png file from %s" texfile)
16579 (message "Failed to create png file from %s" texfile)
16580 nil)
16581 ;; Use the requested file name and clean up
16582 (copy-file pngfile tofile 'replace)
16583 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16584 (delete-file (concat texfilebase e)))
16585 pngfile))))
16587 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16588 "Fill a LaTeX header template TPL.
16589 In the template, the following place holders will be recognized:
16592 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16594 [NO-PACKAGES] do not include PKG
16595 [EXTRA] the string EXTRA
16596 [NO-EXTRA] do not include EXTRA
16598 For backward compatibility, if both the positive and the negative place
16600 assumed to be present at the end of the template.
16601 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16602 EXTRA is a string.
16603 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16604 (let (rpl (end ""))
16606 (setq rpl (if (or (match-end 1) (not def-pkg))
16607 "" (org-latex-packages-to-string def-pkg snippets-p t))
16608 tpl (replace-match rpl t t tpl))
16609 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16612 (setq rpl (if (or (match-end 1) (not pkg))
16613 "" (org-latex-packages-to-string pkg snippets-p t))
16614 tpl (replace-match rpl t t tpl))
16615 (if pkg (setq end
16617 (org-latex-packages-to-string pkg snippets-p)))))
16620 (setq rpl (if (or (match-end 1) (not extra))
16622 tpl (replace-match rpl t t tpl))
16628 tpl)))
16630 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16632 (setq pkg (mapconcat (lambda(p)
16633 (cond
16634 ((stringp p) p)
16635 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16636 (format "%% Package %s omitted" (cadr p)))
16637 ((equal "" (car p))
16639 (t
16641 (car p) (cadr p)))))
16642 pkg
16646 (defun org-dvipng-color (attr)
16647 "Return an rgb color specification for dvipng."
16648 (apply 'format "rgb %s %s %s"
16649 (mapcar 'org-normalize-color
16650 (color-values (face-attribute 'default attr nil)))))
16652 (defun org-normalize-color (value)
16653 "Return string to be used as color value for an RGB component."
16654 (format "%g" (/ value 65535.0)))
16656 ;; Image display
16659 (defvar org-inline-image-overlays nil)
16660 (make-variable-buffer-local 'org-inline-image-overlays)
16662 (defun org-toggle-inline-images (&optional include-linked)
16663 "Toggle the display of inline images.
16664 INCLUDE-LINKED is passed to `org-display-inline-images'."
16665 (interactive "P")
16666 (if org-inline-image-overlays
16667 (progn
16668 (org-remove-inline-images)
16669 (message "Inline image display turned off"))
16670 (org-display-inline-images include-linked)
16671 (if org-inline-image-overlays
16672 (message "%d images displayed inline"
16673 (length org-inline-image-overlays))
16674 (message "No images to display inline"))))
16676 (defun org-display-inline-images (&optional include-linked refresh beg end)
16677 "Display inline images.
16678 Normally only links without a description part are inlined, because this
16679 is how it will work for export. When INCLUDE-LINKED is set, also links
16680 with a description part will be inlined. This can be nice for a quick
16681 look at those images, but it does not reflect what exported files will look
16682 like.
16683 When REFRESH is set, refresh existing images between BEG and END.
16684 This will create new image displays only if necessary.
16685 BEG and END default to the buffer boundaries."
16686 (interactive "P")
16687 (unless refresh
16688 (org-remove-inline-images)
16689 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16690 (save-excursion
16691 (save-restriction
16692 (widen)
16693 (setq beg (or beg (point-min)) end (or end (point-max)))
16694 (goto-char (point-min))
16696 (substring (org-image-file-name-regexp) 0 -2)
16698 old file ov img)
16699 (while (re-search-forward re end t)
16700 (setq old (get-char-property-and-overlay (match-beginning 1)
16701 'org-image-overlay))
16702 (setq file (expand-file-name
16703 (concat (or (match-string 3) "") (match-string 4))))
16704 (when (file-exists-p file)
16705 (if (and (car-safe old) refresh)
16706 (image-refresh (overlay-get (cdr old) 'display))
16707 (setq img (save-match-data (create-image file)))
16708 (when img
16709 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16710 (overlay-put ov 'display img)
16711 (overlay-put ov 'face 'default)
16712 (overlay-put ov 'org-image-overlay t)
16713 (overlay-put ov 'modification-hooks
16714 (list 'org-display-inline-modification-hook))
16715 (push ov org-inline-image-overlays)))))))))
16717 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16718 "Remove inline-display overlay if a corresponding region is modified."
16719 (let ((inhibit-modification-hooks t))
16720 (when (and ov after)
16721 (delete ov org-inline-image-overlays)
16722 (delete-overlay ov))))
16724 (defun org-remove-inline-images ()
16725 "Remove inline display of images."
16726 (interactive)
16727 (mapc 'delete-overlay org-inline-image-overlays)
16728 (setq org-inline-image-overlays nil))
16730 ;;;; Key bindings
16732 ;; Make `C-c C-x' a prefix key
16733 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16735 ;; TAB key with modifiers
16736 (org-defkey org-mode-map "\C-i" 'org-cycle)
16737 (org-defkey org-mode-map [(tab)] 'org-cycle)
16738 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16739 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16741 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16742 ;; The following line is necessary under Suse GNU/Linux
16743 (unless (featurep 'xemacs)
16744 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16745 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16746 (define-key org-mode-map [backtab] 'org-shifttab)
16748 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16749 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16750 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16752 ;; Cursor keys with modifiers
16753 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16754 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16755 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16756 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16758 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16759 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16760 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16761 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16763 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16764 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16765 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16766 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16768 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16769 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16770 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
16771 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
16773 ;; Babel keys
16774 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16775 (mapc (lambda (pair)
16776 (define-key org-babel-map (car pair) (cdr pair)))
16777 org-babel-key-bindings)
16779 ;;; Extra keys for tty access.
16780 ;; We only set them when really needed because otherwise the
16781 ;; menus don't show the simple keys
16783 (when (or org-use-extra-keys
16784 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16785 (not window-system))
16786 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16787 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16788 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16789 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16790 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16791 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16792 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16793 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16794 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16795 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16796 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16797 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16798 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16799 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16800 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16801 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16802 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16803 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16804 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16805 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16806 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16807 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16808 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16809 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16810 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16811 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16812 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16813 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16815 ;; All the other keys
16817 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16818 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16819 (if (boundp 'narrow-map)
16820 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16821 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16822 (if (boundp 'narrow-map)
16823 (org-defkey narrow-map "b" 'org-narrow-to-block)
16824 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16825 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16826 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16827 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16828 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16829 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16830 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16831 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16832 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16833 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16834 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16835 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16836 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16837 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16838 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16839 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16840 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16842 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16843 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16844 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16845 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
16846 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16847 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16848 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16849 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16850 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16851 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16852 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16853 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16854 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16855 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16856 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16857 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16858 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16859 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16860 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16861 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16863 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16864 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16865 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16866 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16867 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16868 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16869 (org-defkey org-mode-map "\C-c^" 'org-sort)
16870 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16871 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16872 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16873 (org-defkey org-mode-map "\C-m" 'org-return)
16874 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16875 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16876 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16877 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16878 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16879 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16880 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16881 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16882 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16883 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16884 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16885 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16886 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16887 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16888 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16889 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16890 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16891 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16892 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16893 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16894 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16895 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16897 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16898 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16899 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16900 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16902 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16903 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16904 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16905 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16906 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16907 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16908 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16909 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16910 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16911 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16913 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16914 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16915 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16916 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16917 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16918 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16919 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16921 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16922 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16923 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16924 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16925 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16927 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16929 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16931 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16932 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16934 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16937 (when (featurep 'xemacs)
16938 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16941 (defconst org-speed-commands-default
16942 '(
16943 ("Outline Navigation")
16944 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16945 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16946 ("f" . (org-speed-move-safe 'org-forward-same-level))
16947 ("b" . (org-speed-move-safe 'org-backward-same-level))
16948 ("u" . (org-speed-move-safe 'outline-up-heading))
16949 ("j" . org-goto)
16950 ("g" . (org-refile t))
16951 ("Outline Visibility")
16952 ("c" . org-cycle)
16953 ("C" . org-shifttab)
16954 (" " . org-display-outline-path)
16955 ("Outline Structure Editing")
16956 ("U" . org-shiftmetaup)
16957 ("D" . org-shiftmetadown)
16958 ("r" . org-metaright)
16959 ("l" . org-metaleft)
16960 ("R" . org-shiftmetaright)
16961 ("L" . org-shiftmetaleft)
16962 ("i" . (progn (forward-char 1) (call-interactively
16963 'org-insert-heading-respect-content)))
16964 ("^" . org-sort)
16965 ("w" . org-refile)
16966 ("a" . org-archive-subtree-default-with-confirmation)
16967 ("." . org-mark-subtree)
16968 ("Clock Commands")
16969 ("I" . org-clock-in)
16970 ("O" . org-clock-out)
16971 ("Meta Data Editing")
16972 ("t" . org-todo)
16973 ("0" . (org-priority ?\ ))
16974 ("1" . (org-priority ?A))
16975 ("2" . (org-priority ?B))
16976 ("3" . (org-priority ?C))
16977 (";" . org-set-tags-command)
16978 ("e" . org-set-effort)
16979 ("Agenda Views etc")
16980 ("v" . org-agenda)
16981 ("/" . org-sparse-tree)
16982 ("Misc")
16983 ("o" . org-open-at-point)
16984 ("?" . org-speed-command-help)
16985 ("<" . (org-agenda-set-restriction-lock 'subtree))
16986 (">" . (org-agenda-remove-restriction-lock))
16987 )
16988 "The default speed commands.")
16990 (defun org-print-speed-command (e)
16991 (if (> (length (car e)) 1)
16992 (progn
16994 (princ (car e))
16996 (princ (make-string (length (car e)) ?-))
16998 (princ (car e))
16999 (princ " ")
17000 (if (symbolp (cdr e))
17001 (princ (symbol-name (cdr e)))
17002 (prin1 (cdr e)))
17005 (defun org-speed-command-help ()
17006 "Show the available speed commands."
17007 (interactive)
17008 (if (not org-use-speed-commands)
17009 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17010 (with-output-to-temp-buffer "*Help*"
17012 (mapc 'org-print-speed-command org-speed-commands-user)
17015 (mapc 'org-print-speed-command org-speed-commands-default))
17016 (with-current-buffer "*Help*"
17017 (setq truncate-lines t))))
17019 (defun org-speed-move-safe (cmd)
17020 "Execute CMD, but make sure that the cursor always ends up in a headline.
17021 If not, return to the original position and throw an error."
17022 (interactive)
17023 (let ((pos (point)))
17024 (call-interactively cmd)
17025 (unless (and (bolp) (org-on-heading-p))
17026 (goto-char pos)
17027 (error "Boundary reached while executing %s" cmd))))
17029 (defvar org-self-insert-command-undo-counter 0)
17031 (defvar org-table-auto-blank-field) ; defined in org-table.el
17032 (defvar org-speed-command nil)
17034 (defun org-speed-command-default-hook (keys)
17035 "Hook for activating single-letter speed commands.
17036 `org-speed-commands-default' specifies a minimal command set. Use
17037 `org-speed-commands-user' for further customization."
17038 (when (or (and (bolp) (looking-at org-outline-regexp))
17039 (and (functionp org-use-speed-commands)
17040 (funcall org-use-speed-commands)))
17041 (cdr (assoc keys (append org-speed-commands-user
17042 org-speed-commands-default)))))
17044 (defun org-babel-speed-command-hook (keys)
17045 "Hook for activating single-letter code block commands."
17046 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17047 (cdr (assoc keys org-babel-key-bindings))))
17049 (defcustom org-speed-command-hook
17050 '(org-speed-command-default-hook org-babel-speed-command-hook)
17051 "Hook for activating speed commands at strategic locations.
17052 Hook functions are called in sequence until a valid handler is
17053 found.
17055 Each hook takes a single argument, a user-pressed command key
17056 which is also a `self-insert-command' from the global map.
17058 Within the hook, examine the cursor position and the command key
17059 and return nil or a valid handler as appropriate. Handler could
17060 be one of an interactive command, a function, or a form.
17062 Set `org-use-speed-commands' to non-nil value to enable this
17063 hook. The default setting is `org-speed-command-default-hook'."
17064 :group 'org-structure
17065 :type 'hook)
17067 (defun org-self-insert-command (N)
17068 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17069 If the cursor is in a table looking at whitespace, the whitespace is
17070 overwritten, and the table is not marked as requiring realignment."
17071 (interactive "p")
17072 (cond
17073 ((and org-use-speed-commands
17074 (setq org-speed-command
17075 (run-hook-with-args-until-success
17076 'org-speed-command-hook (this-command-keys))))
17077 (cond
17078 ((commandp org-speed-command)
17079 (setq this-command org-speed-command)
17080 (call-interactively org-speed-command))
17081 ((functionp org-speed-command)
17082 (funcall org-speed-command))
17083 ((and org-speed-command (listp org-speed-command))
17084 (eval org-speed-command))
17085 (t (let (org-use-speed-commands)
17086 (call-interactively 'org-self-insert-command)))))
17087 ((and
17088 (org-table-p)
17089 (progn
17090 ;; check if we blank the field, and if that triggers align
17091 (and (featurep 'org-table) org-table-auto-blank-field
17092 (member last-command
17093 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17095 ;; got extra space, this field does not determine column width
17096 (let (org-table-may-need-update) (org-table-blank-field))
17097 ;; no extra space, this field may determine column width
17098 (org-table-blank-field)))
17099 t)
17100 (eq N 1)
17102 (let (org-table-may-need-update)
17103 (goto-char (1- (match-end 0)))
17104 (delete-char -1)
17105 (goto-char (match-beginning 0))
17106 (self-insert-command N)))
17107 (t
17108 (setq org-table-may-need-update t)
17109 (self-insert-command N)
17110 (org-fix-tags-on-the-fly)
17111 (if org-self-insert-cluster-for-undo
17112 (if (not (eq last-command 'org-self-insert-command))
17113 (setq org-self-insert-command-undo-counter 1)
17114 (if (>= org-self-insert-command-undo-counter 20)
17115 (setq org-self-insert-command-undo-counter 1)
17116 (and (> org-self-insert-command-undo-counter 0)
17117 buffer-undo-list (listp buffer-undo-list)
17118 (not (cadr buffer-undo-list)) ; remove nil entry
17119 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17120 (setq org-self-insert-command-undo-counter
17121 (1+ org-self-insert-command-undo-counter))))))))
17123 (defun org-fix-tags-on-the-fly ()
17124 (when (and (equal (char-after (point-at-bol)) ?*)
17125 (org-on-heading-p))
17126 (org-align-tags-here org-tags-column)))
17128 (defun org-delete-backward-char (N)
17129 "Like `delete-backward-char', insert whitespace at field end in tables.
17130 When deleting backwards, in tables this function will insert whitespace in
17132 still be marked for re-alignment if the field did fill the entire column,
17133 because, in this case the deletion might narrow the column."
17134 (interactive "p")
17135 (if (and (org-table-p)
17136 (eq N 1)
17137 (string-match "|" (buffer-substring (point-at-bol) (point)))
17138 (looking-at ".*?|"))
17139 (let ((pos (point))
17141 (c org-table-may-need-update))
17142 (backward-delete-char N)
17143 (if (not overwrite-mode)
17144 (progn
17145 (skip-chars-forward "^|")
17146 (insert " ")
17147 (goto-char (1- pos))))
17148 ;; noalign: if there were two spaces at the end, this field
17149 ;; does not determine the width of the column.
17150 (if noalign (setq org-table-may-need-update c)))
17151 (backward-delete-char N)
17152 (org-fix-tags-on-the-fly)))
17154 (defun org-delete-char (N)
17155 "Like `delete-char', but insert whitespace at field end in tables.
17156 When deleting characters, in tables this function will insert whitespace in
17158 still be marked for re-alignment if the field did fill the entire column,
17159 because, in this case the deletion might narrow the column."
17160 (interactive "p")
17161 (if (and (org-table-p)
17162 (not (bolp))
17163 (not (= (char-after) ?|))
17164 (eq N 1))
17165 (if (looking-at ".*?|")
17166 (let ((pos (point))
17168 (c org-table-may-need-update))
17169 (replace-match (concat
17170 (substring (match-string 0) 1 -1)
17171 " |"))
17172 (goto-char pos)
17173 ;; noalign: if there were two spaces at the end, this field
17174 ;; does not determine the width of the column.
17175 (if noalign (setq org-table-may-need-update c)))
17176 (delete-char N))
17177 (delete-char N)
17178 (org-fix-tags-on-the-fly)))
17180 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17181 (put 'org-self-insert-command 'delete-selection t)
17182 (put 'orgtbl-self-insert-command 'delete-selection t)
17183 (put 'org-delete-char 'delete-selection 'supersede)
17184 (put 'org-delete-backward-char 'delete-selection 'supersede)
17185 (put 'org-yank 'delete-selection 'yank)
17187 ;; Make `flyspell-mode' delay after some commands
17188 (put 'org-self-insert-command 'flyspell-delayed t)
17189 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17190 (put 'org-delete-char 'flyspell-delayed t)
17191 (put 'org-delete-backward-char 'flyspell-delayed t)
17193 ;; Make pabbrev-mode expand after org-mode commands
17194 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17195 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17197 ;; How to do this: Measure non-white length of current string
17198 ;; If equal to column width, we should realign.
17200 (defun org-remap (map &rest commands)
17201 "In MAP, remap the functions given in COMMANDS.
17202 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17203 (let (new old)
17204 (while commands
17205 (setq old (pop commands) new (pop commands))
17206 (if (fboundp 'command-remapping)
17207 (org-defkey map (vector 'remap old) new)
17208 (substitute-key-definition old new map global-map)))))
17210 (when (eq org-enable-table-editor 'optimized)
17211 ;; If the user wants maximum table support, we need to hijack
17212 ;; some standard editing functions
17213 (org-remap org-mode-map
17214 'self-insert-command 'org-self-insert-command
17215 'delete-char 'org-delete-char
17216 'delete-backward-char 'org-delete-backward-char)
17217 (org-defkey org-mode-map "|" 'org-force-self-insert))
17219 (defvar org-ctrl-c-ctrl-c-hook nil
17220 "Hook for functions attaching themselves to `C-c C-c'.
17222 This can be used to add additional functionality to the C-c C-c
17223 key which executes context-dependent commands. This hook is run
17224 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17225 run after the last test.
17227 Each function will be called with no arguments. The function
17228 must check if the context is appropriate for it to act. If yes,
17229 it should do its thing and then return a non-nil value. If the
17230 context is wrong, just do nothing and return nil.")
17232 (defvar org-ctrl-c-ctrl-c-final-hook nil
17233 "Hook for functions attaching themselves to `C-c C-c'.
17235 This can be used to add additional functionality to the C-c C-c
17236 key which executes context-dependent commands. This hook is run
17237 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17238 before the first test.
17240 Each function will be called with no arguments. The function
17241 must check if the context is appropriate for it to act. If yes,
17242 it should do its thing and then return a non-nil value. If the
17243 context is wrong, just do nothing and return nil.")
17245 (defvar org-tab-first-hook nil
17246 "Hook for functions to attach themselves to TAB.
17247 See `org-ctrl-c-ctrl-c-hook' for more information.
17248 This hook runs as the first action when TAB is pressed, even before
17249 `org-cycle' messes around with the `outline-regexp' to cater for
17250 inline tasks and plain list item folding.
17251 If any function in this hook returns t, any other actions that
17252 would have been caused by TAB (such as table field motion or visibility
17253 cycling) will not occur.")
17255 (defvar org-tab-after-check-for-table-hook nil
17256 "Hook for functions to attach themselves to TAB.
17257 See `org-ctrl-c-ctrl-c-hook' for more information.
17258 This hook runs after it has been established that the cursor is not in a
17259 table, but before checking if the cursor is in a headline or if global cycling
17260 should be done.
17261 If any function in this hook returns t, not other actions like visibility
17262 cycling will be done.")
17264 (defvar org-tab-after-check-for-cycling-hook nil
17265 "Hook for functions to attach themselves to TAB.
17266 See `org-ctrl-c-ctrl-c-hook' for more information.
17267 This hook runs after it has been established that not table field motion and
17268 not visibility should be done because of current context. This is probably
17269 the place where a package like yasnippets can hook in.")
17271 (defvar org-tab-before-tab-emulation-hook nil
17272 "Hook for functions to attach themselves to TAB.
17273 See `org-ctrl-c-ctrl-c-hook' for more information.
17274 This hook runs after every other options for TAB have been exhausted, but
17277 (defvar org-metaleft-hook nil
17278 "Hook for functions attaching themselves to `M-left'.
17279 See `org-ctrl-c-ctrl-c-hook' for more information.")
17280 (defvar org-metaright-hook nil
17281 "Hook for functions attaching themselves to `M-right'.
17282 See `org-ctrl-c-ctrl-c-hook' for more information.")
17283 (defvar org-metaup-hook nil
17284 "Hook for functions attaching themselves to `M-up'.
17285 See `org-ctrl-c-ctrl-c-hook' for more information.")
17286 (defvar org-metadown-hook nil
17287 "Hook for functions attaching themselves to `M-down'.
17288 See `org-ctrl-c-ctrl-c-hook' for more information.")
17289 (defvar org-shiftmetaleft-hook nil
17290 "Hook for functions attaching themselves to `M-S-left'.
17291 See `org-ctrl-c-ctrl-c-hook' for more information.")
17292 (defvar org-shiftmetaright-hook nil
17293 "Hook for functions attaching themselves to `M-S-right'.
17294 See `org-ctrl-c-ctrl-c-hook' for more information.")
17295 (defvar org-shiftmetaup-hook nil
17296 "Hook for functions attaching themselves to `M-S-up'.
17297 See `org-ctrl-c-ctrl-c-hook' for more information.")
17298 (defvar org-shiftmetadown-hook nil
17299 "Hook for functions attaching themselves to `M-S-down'.
17300 See `org-ctrl-c-ctrl-c-hook' for more information.")
17301 (defvar org-metareturn-hook nil
17302 "Hook for functions attaching themselves to `M-RET'.
17303 See `org-ctrl-c-ctrl-c-hook' for more information.")
17304 (defvar org-shiftup-hook nil
17305 "Hook for functions attaching themselves to `S-up'.
17306 See `org-ctrl-c-ctrl-c-hook' for more information.")
17307 (defvar org-shiftup-final-hook nil
17308 "Hook for functions attaching themselves to `S-up'.
17309 This one runs after all other options except shift-select have been excluded.
17310 See `org-ctrl-c-ctrl-c-hook' for more information.")
17311 (defvar org-shiftdown-hook nil
17312 "Hook for functions attaching themselves to `S-down'.
17313 See `org-ctrl-c-ctrl-c-hook' for more information.")
17314 (defvar org-shiftdown-final-hook nil
17315 "Hook for functions attaching themselves to `S-down'.
17316 This one runs after all other options except shift-select have been excluded.
17317 See `org-ctrl-c-ctrl-c-hook' for more information.")
17318 (defvar org-shiftleft-hook nil
17319 "Hook for functions attaching themselves to `S-left'.
17320 See `org-ctrl-c-ctrl-c-hook' for more information.")
17321 (defvar org-shiftleft-final-hook nil
17322 "Hook for functions attaching themselves to `S-left'.
17323 This one runs after all other options except shift-select have been excluded.
17324 See `org-ctrl-c-ctrl-c-hook' for more information.")
17325 (defvar org-shiftright-hook nil
17326 "Hook for functions attaching themselves to `S-right'.
17327 See `org-ctrl-c-ctrl-c-hook' for more information.")
17328 (defvar org-shiftright-final-hook nil
17329 "Hook for functions attaching themselves to `S-right'.
17330 This one runs after all other options except shift-select have been excluded.
17331 See `org-ctrl-c-ctrl-c-hook' for more information.")
17333 (defun org-modifier-cursor-error ()
17334 "Throw an error, a modified cursor command was applied in wrong context."
17335 (error "This command is active in special context like tables, headlines or items"))
17337 (defun org-shiftselect-error ()
17338 "Throw an error because Shift-Cursor command was applied in wrong context."
17339 (if (and (boundp 'shift-select-mode) shift-select-mode)
17340 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17341 (error "This command works only in special context like headlines or timestamps")))
17343 (defun org-call-for-shift-select (cmd)
17344 (let ((this-command-keys-shift-translated t))
17345 (call-interactively cmd)))
17347 (defun org-shifttab (&optional arg)
17348 "Global visibility cycling or move to previous table field.
17349 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17350 on context.
17351 See the individual commands for more information."
17352 (interactive "P")
17353 (cond
17354 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17355 ((integerp arg)
17356 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17357 (message "Content view to level: %d" arg)
17358 (org-content (prefix-numeric-value arg2))
17359 (setq org-cycle-global-status 'overview)))
17360 (t (call-interactively 'org-global-cycle))))
17362 (defun org-shiftmetaleft ()
17363 "Promote subtree or delete table column.
17364 Calls `org-promote-subtree', `org-outdent-item',
17365 or `org-table-delete-column', depending on context.
17366 See the individual commands for more information."
17367 (interactive)
17368 (cond
17369 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17370 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17371 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17372 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17373 (t (org-modifier-cursor-error))))
17375 (defun org-shiftmetaright ()
17376 "Demote subtree or insert table column.
17377 Calls `org-demote-subtree', `org-indent-item',
17378 or `org-table-insert-column', depending on context.
17379 See the individual commands for more information."
17380 (interactive)
17381 (cond
17382 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17383 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17384 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17385 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17386 (t (org-modifier-cursor-error))))
17388 (defun org-shiftmetaup (&optional arg)
17389 "Move subtree up or kill table row.
17390 Calls `org-move-subtree-up' or `org-table-kill-row' or
17391 `org-move-item-up' depending on context. See the individual commands
17392 for more information."
17393 (interactive "P")
17394 (cond
17395 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17396 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17397 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17398 ((org-at-item-p) (call-interactively 'org-move-item-up))
17399 (t (org-modifier-cursor-error))))
17401 (defun org-shiftmetadown (&optional arg)
17402 "Move subtree down or insert table row.
17403 Calls `org-move-subtree-down' or `org-table-insert-row' or
17404 `org-move-item-down', depending on context. See the individual
17405 commands for more information."
17406 (interactive "P")
17407 (cond
17408 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17409 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17410 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17411 ((org-at-item-p) (call-interactively 'org-move-item-down))
17412 (t (org-modifier-cursor-error))))
17414 (defsubst org-hidden-tree-error ()
17415 (error
17416 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17418 (defun org-metaleft (&optional arg)
17419 "Promote heading or move table column to left.
17420 Calls `org-do-promote' or `org-table-move-column', depending on context.
17421 With no specific context, calls the Emacs default `backward-word'.
17422 See the individual commands for more information."
17423 (interactive "P")
17424 (cond
17425 ((run-hook-with-args-until-success 'org-metaleft-hook))
17426 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17427 ((org-with-limited-levels
17428 (or (org-on-heading-p)
17429 (and (org-region-active-p)
17430 (save-excursion
17431 (goto-char (region-beginning))
17432 (org-on-heading-p)))))
17433 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17434 (call-interactively 'org-do-promote))
17435 ;; At an inline task.
17436 ((org-on-heading-p)
17437 (call-interactively 'org-inlinetask-promote))
17438 ((or (org-at-item-p)
17439 (and (org-region-active-p)
17440 (save-excursion
17441 (goto-char (region-beginning))
17442 (org-at-item-p))))
17443 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17444 (call-interactively 'org-outdent-item))
17445 (t (call-interactively 'backward-word))))
17447 (defun org-metaright (&optional arg)
17448 "Demote subtree or move table column to right.
17449 Calls `org-do-demote' or `org-table-move-column', depending on context.
17450 With no specific context, calls the Emacs default `forward-word'.
17451 See the individual commands for more information."
17452 (interactive "P")
17453 (cond
17454 ((run-hook-with-args-until-success 'org-metaright-hook))
17455 ((org-at-table-p) (call-interactively 'org-table-move-column))
17456 ((org-with-limited-levels
17457 (or (org-on-heading-p)
17458 (and (org-region-active-p)
17459 (save-excursion
17460 (goto-char (region-beginning))
17461 (org-on-heading-p)))))
17462 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17463 (call-interactively 'org-do-demote))
17464 ;; At an inline task.
17465 ((org-on-heading-p)
17466 (call-interactively 'org-inlinetask-demote))
17467 ((or (org-at-item-p)
17468 (and (org-region-active-p)
17469 (save-excursion
17470 (goto-char (region-beginning))
17471 (org-at-item-p))))
17472 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17473 (call-interactively 'org-indent-item))
17474 (t (call-interactively 'forward-word))))
17476 (defun org-check-for-hidden (what)
17477 "Check if there are hidden headlines/items in the current visual line.
17478 WHAT can be either `headlines' or `items'. If the current line is
17479 an outline or item heading and it has a folded subtree below it,
17480 this function returns t, nil otherwise."
17481 (let ((re (cond
17482 ((eq what 'headlines) org-outline-regexp-bol)
17483 ((eq what 'items) (org-item-beginning-re))
17484 (t (error "This should not happen"))))
17485 beg end)
17486 (save-excursion
17487 (catch 'exit
17488 (unless (org-region-active-p)
17489 (setq beg (point-at-bol))
17490 (beginning-of-line 2)
17491 (while (and (not (eobp)) ;; this is like `next-line'
17492 (get-char-property (1- (point)) 'invisible))
17493 (beginning-of-line 2))
17494 (setq end (point))
17495 (goto-char beg)
17496 (goto-char (point-at-eol))
17497 (setq end (max end (point)))
17498 (while (re-search-forward re end t)
17499 (if (get-char-property (match-beginning 0) 'invisible)
17500 (throw 'exit t))))
17501 nil))))
17503 (defun org-metaup (&optional arg)
17504 "Move subtree up or move table row up.
17505 Calls `org-move-subtree-up' or `org-table-move-row' or
17506 `org-move-item-up', depending on context. See the individual commands
17507 for more information."
17508 (interactive "P")
17509 (cond
17510 ((run-hook-with-args-until-success 'org-metaup-hook))
17511 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17512 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17513 ((org-at-item-p) (call-interactively 'org-move-item-up))
17514 (t (transpose-lines 1) (beginning-of-line -1))))
17516 (defun org-metadown (&optional arg)
17517 "Move subtree down or move table row down.
17518 Calls `org-move-subtree-down' or `org-table-move-row' or
17519 `org-move-item-down', depending on context. See the individual
17520 commands for more information."
17521 (interactive "P")
17522 (cond
17523 ((run-hook-with-args-until-success 'org-metadown-hook))
17524 ((org-at-table-p) (call-interactively 'org-table-move-row))
17525 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17526 ((org-at-item-p) (call-interactively 'org-move-item-down))
17527 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17529 (defun org-shiftup (&optional arg)
17530 "Increase item in timestamp or increase priority of current headline.
17531 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17532 depending on context. See the individual commands for more information."
17533 (interactive "P")
17534 (cond
17535 ((run-hook-with-args-until-success 'org-shiftup-hook))
17536 ((and org-support-shift-select (org-region-active-p))
17537 (org-call-for-shift-select 'previous-line))
17538 ((org-at-timestamp-p t)
17539 (call-interactively (if org-edit-timestamp-down-means-later
17540 'org-timestamp-down 'org-timestamp-up)))
17541 ((and (not (eq org-support-shift-select 'always))
17542 org-enable-priority-commands
17543 (org-on-heading-p))
17544 (call-interactively 'org-priority-up))
17545 ((and (not org-support-shift-select) (org-at-item-p))
17546 (call-interactively 'org-previous-item))
17547 ((org-clocktable-try-shift 'up arg))
17548 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17549 (org-support-shift-select
17550 (org-call-for-shift-select 'previous-line))
17551 (t (org-shiftselect-error))))
17553 (defun org-shiftdown (&optional arg)
17554 "Decrease item in timestamp or decrease priority of current headline.
17555 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17556 depending on context. See the individual commands for more information."
17557 (interactive "P")
17558 (cond
17559 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17560 ((and org-support-shift-select (org-region-active-p))
17561 (org-call-for-shift-select 'next-line))
17562 ((org-at-timestamp-p t)
17563 (call-interactively (if org-edit-timestamp-down-means-later
17564 'org-timestamp-up 'org-timestamp-down)))
17565 ((and (not (eq org-support-shift-select 'always))
17566 org-enable-priority-commands
17567 (org-on-heading-p))
17568 (call-interactively 'org-priority-down))
17569 ((and (not org-support-shift-select) (org-at-item-p))
17570 (call-interactively 'org-next-item))
17571 ((org-clocktable-try-shift 'down arg))
17572 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17573 (org-support-shift-select
17574 (org-call-for-shift-select 'next-line))
17575 (t (org-shiftselect-error))))
17577 (defun org-shiftright (&optional arg)
17578 "Cycle the thing at point or in the current line, depending on context.
17579 Depending on context, this does one of the following:
17581 - switch a timestamp at point one day into the future
17582 - on a headline, switch to the next TODO keyword.
17583 - on an item, switch entire list to the next bullet type
17584 - on a property line, switch to the next allowed value
17585 - on a clocktable definition line, move time block into the future"
17586 (interactive "P")
17587 (cond
17588 ((run-hook-with-args-until-success 'org-shiftright-hook))
17589 ((and org-support-shift-select (org-region-active-p))
17590 (org-call-for-shift-select 'forward-char))
17591 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17592 ((and (not (eq org-support-shift-select 'always))
17593 (org-on-heading-p))
17594 (let ((org-inhibit-logging
17595 (not org-treat-S-cursor-todo-selection-as-state-change))
17596 (org-inhibit-blocking
17597 (not org-treat-S-cursor-todo-selection-as-state-change)))
17598 (org-call-with-arg 'org-todo 'right)))
17599 ((or (and org-support-shift-select
17600 (not (eq org-support-shift-select 'always))
17601 (org-at-item-bullet-p))
17602 (and (not org-support-shift-select) (org-at-item-p)))
17603 (org-call-with-arg 'org-cycle-list-bullet nil))
17604 ((and (not (eq org-support-shift-select 'always))
17605 (org-at-property-p))
17606 (call-interactively 'org-property-next-allowed-value))
17607 ((org-clocktable-try-shift 'right arg))
17608 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17609 (org-support-shift-select
17610 (org-call-for-shift-select 'forward-char))
17611 (t (org-shiftselect-error))))
17613 (defun org-shiftleft (&optional arg)
17614 "Cycle the thing at point or in the current line, depending on context.
17615 Depending on context, this does one of the following:
17617 - switch a timestamp at point one day into the past
17618 - on a headline, switch to the previous TODO keyword.
17619 - on an item, switch entire list to the previous bullet type
17620 - on a property line, switch to the previous allowed value
17621 - on a clocktable definition line, move time block into the past"
17622 (interactive "P")
17623 (cond
17624 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17625 ((and org-support-shift-select (org-region-active-p))
17626 (org-call-for-shift-select 'backward-char))
17627 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17628 ((and (not (eq org-support-shift-select 'always))
17629 (org-on-heading-p))
17630 (let ((org-inhibit-logging
17631 (not org-treat-S-cursor-todo-selection-as-state-change))
17632 (org-inhibit-blocking
17633 (not org-treat-S-cursor-todo-selection-as-state-change)))
17634 (org-call-with-arg 'org-todo 'left)))
17635 ((or (and org-support-shift-select
17636 (not (eq org-support-shift-select 'always))
17637 (org-at-item-bullet-p))
17638 (and (not org-support-shift-select) (org-at-item-p)))
17639 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17640 ((and (not (eq org-support-shift-select 'always))
17641 (org-at-property-p))
17642 (call-interactively 'org-property-previous-allowed-value))
17643 ((org-clocktable-try-shift 'left arg))
17644 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17645 (org-support-shift-select
17646 (org-call-for-shift-select 'backward-char))
17647 (t (org-shiftselect-error))))
17649 (defun org-shiftcontrolright ()
17650 "Switch to next TODO set."
17651 (interactive)
17652 (cond
17653 ((and org-support-shift-select (org-region-active-p))
17654 (org-call-for-shift-select 'forward-word))
17655 ((and (not (eq org-support-shift-select 'always))
17656 (org-on-heading-p))
17657 (org-call-with-arg 'org-todo 'nextset))
17658 (org-support-shift-select
17659 (org-call-for-shift-select 'forward-word))
17660 (t (org-shiftselect-error))))
17662 (defun org-shiftcontrolleft ()
17663 "Switch to previous TODO set."
17664 (interactive)
17665 (cond
17666 ((and org-support-shift-select (org-region-active-p))
17667 (org-call-for-shift-select 'backward-word))
17668 ((and (not (eq org-support-shift-select 'always))
17669 (org-on-heading-p))
17670 (org-call-with-arg 'org-todo 'previousset))
17671 (org-support-shift-select
17672 (org-call-for-shift-select 'backward-word))
17673 (t (org-shiftselect-error))))
17675 (defun org-shiftcontrolup ()
17676 "Change timestamps synchronously up in CLOCK log lines."
17677 (interactive)
17678 (cond ((and (not org-support-shift-select)
17679 (org-at-clock-log-p)
17680 (org-at-timestamp-p t))
17681 (org-clock-timestamps-up))
17682 (t (org-shiftselect-error))))
17684 (defun org-shiftcontroldown ()
17685 "Change timestamps synchronously down in CLOCK log lines."
17686 (interactive)
17687 (cond ((and (not org-support-shift-select)
17688 (org-at-clock-log-p)
17689 (org-at-timestamp-p t))
17690 (org-clock-timestamps-down))
17691 (t (org-shiftselect-error))))
17693 (defun org-ctrl-c-ret ()
17694 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17695 (interactive)
17696 (cond
17697 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17698 (t (call-interactively 'org-insert-heading))))
17700 (defun org-copy-visible (beg end)
17701 "Copy the visible parts of the region."
17702 (interactive "r")
17703 (let (snippets s)
17704 (save-excursion
17705 (save-restriction
17706 (narrow-to-region beg end)
17707 (setq s (goto-char (point-min)))
17708 (while (not (= (point) (point-max)))
17709 (goto-char (org-find-invisible))
17710 (push (buffer-substring s (point)) snippets)
17711 (setq s (goto-char (org-find-visible))))))
17712 (kill-new (apply 'concat (nreverse snippets)))))
17714 (defun org-copy-special ()
17715 "Copy region in table or copy current subtree.
17716 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17717 See the individual commands for more information."
17718 (interactive)
17719 (call-interactively
17720 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17722 (defun org-cut-special ()
17723 "Cut region in table or cut current subtree.
17724 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17725 See the individual commands for more information."
17726 (interactive)
17727 (call-interactively
17728 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17730 (defun org-paste-special (arg)
17731 "Paste rectangular region into table, or past subtree relative to level.
17732 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17733 See the individual commands for more information."
17734 (interactive "P")
17735 (if (org-at-table-p)
17736 (org-table-paste-rectangle)
17737 (org-paste-subtree arg)))
17739 (defun org-edit-special (&optional arg)
17740 "Call a special editor for the stuff at point.
17741 When at a table, call the formula editor with `org-table-edit-formulas'.
17742 When at the first line of an src example, call `org-edit-src-code'.
17743 When in an #+include line, visit the include file. Otherwise call
17744 `ffap' to visit the file at point."
17745 (interactive)
17746 ;; possibly prep session before editing source
17747 (when arg
17748 (let* ((info (org-babel-get-src-block-info))
17749 (lang (nth 0 info))
17750 (params (nth 2 info))
17751 (session (cdr (assoc :session params))))
17752 (when (and info session) ;; we are in a source-code block with a session
17753 (funcall
17754 (intern (concat "org-babel-prep-session:" lang)) session params))))
17755 (cond ;; proceed with `org-edit-special'
17756 ((save-excursion
17757 (beginning-of-line 1)
17758 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17759 (find-file (org-trim (match-string 1))))
17760 ((org-edit-src-code))
17761 ((org-edit-fixed-width-region))
17762 ((org-at-table.el-p)
17763 (org-edit-src-code))
17764 ((or (org-at-table-p)
17765 (save-excursion
17766 (beginning-of-line 1)
17768 (call-interactively 'org-table-edit-formulas))
17769 (t (call-interactively 'ffap))))
17771 (defun org-ctrl-c-ctrl-c (&optional arg)
17772 "Set tags in headline, or update according to changed information at point.
17774 This command does many different things, depending on context:
17776 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17777 this is what we do.
17779 - If the cursor is on a statistics cookie, update it.
17781 - If the cursor is in a headline, prompt for tags and insert them
17782 into the current line, aligned to `org-tags-column'. When called
17783 with prefix arg, realign all tags in the current buffer.
17785 - If the cursor is in one of the special #+KEYWORD lines, this
17786 triggers scanning the buffer for these lines and updating the
17787 information.
17789 - If the cursor is inside a table, realign the table. This command
17790 works even if the automatic table editor has been turned off.
17792 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17793 the entire table.
17795 - If the cursor is at a footnote reference or definition, jump to
17796 the corresponding definition or references, respectively.
17798 - If the cursor is a the beginning of a dynamic block, update it.
17800 - If the current buffer is a capture buffer, close note and file it.
17802 - If the cursor is on a <<<target>>>, update radio targets and
17803 corresponding links in this buffer.
17805 - If the cursor is on a numbered item in a plain list, renumber the
17806 ordered list.
17808 - If the cursor is on a checkbox, toggle it.
17810 - If the cursor is on a code block, evaluate it. The variable
17811 `org-confirm-babel-evaluate' can be used to control prompting
17812 before code block evaluation, by default every code block
17813 evaluation requires confirmation. Code block evaluation can be
17814 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17815 (interactive "P")
17816 (let ((org-enable-table-editor t))
17817 (cond
17818 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17819 org-occur-highlights
17820 org-latex-fragment-image-overlays)
17821 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17822 (org-remove-occur-highlights)
17823 (org-remove-latex-fragment-image-overlays)
17824 (message "Temporary highlights/overlays removed from current buffer"))
17825 ((and (local-variable-p 'org-finish-function (current-buffer))
17826 (fboundp org-finish-function))
17827 (funcall org-finish-function))
17828 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17829 ((or (looking-at org-property-start-re)
17830 (org-at-property-p))
17831 (call-interactively 'org-property-action))
17832 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17834 (or (org-on-heading-p) (org-at-item-p)))
17835 (call-interactively 'org-update-statistics-cookies))
17836 ((org-on-heading-p) (call-interactively 'org-set-tags))
17837 ((org-at-table.el-p)
17838 (message "Use C-c ' to edit table.el tables"))
17839 ((org-at-table-p)
17840 (org-table-maybe-eval-formula)
17841 (if arg
17842 (call-interactively 'org-table-recalculate)
17843 (org-table-maybe-recalculate-line))
17844 (call-interactively 'org-table-align)
17845 (orgtbl-send-table 'maybe))
17846 ((or (org-footnote-at-reference-p)
17847 (org-footnote-at-definition-p))
17848 (call-interactively 'org-footnote-action))
17849 ((org-at-item-checkbox-p)
17850 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17851 ;; list only if at top item.
17852 (let* ((cbox (match-string 1))
17853 (struct (org-list-struct))
17854 (old-struct (copy-tree struct))
17855 (parents (org-list-parents-alist struct))
17856 (prevs (org-list-prevs-alist struct))
17857 (orderedp (org-entry-get nil "ORDERED"))
17858 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17859 block-item)
17860 ;; Use a light version of `org-toggle-checkbox' to avoid
17861 ;; computing list structure twice.
17862 (org-list-set-checkbox (point-at-bol) struct
17863 (cond
17864 ((equal arg '(16)) "[-]")
17865 ((equal arg '(4)) nil)
17866 ((equal "[X]" cbox) "[ ]")
17867 (t "[X]")))
17868 (org-list-struct-fix-ind struct parents)
17869 (org-list-struct-fix-bul struct prevs)
17870 (setq block-item
17871 (org-list-struct-fix-box struct parents prevs orderedp))
17872 (when block-item
17873 (message
17874 "Checkboxes were removed due to unchecked box at line %d"
17875 (org-current-line block-item)))
17876 (org-list-struct-apply-struct struct old-struct)
17877 (org-update-checkbox-count-maybe)
17878 (when firstp (org-list-send-list 'maybe))))
17879 ((org-at-item-p)
17880 ;; Cursor at an item: repair list. Do checkbox related actions
17881 ;; only if function was called with an argument. Send list only
17882 ;; if at top item.
17883 (let* ((struct (org-list-struct))
17884 (old-struct (copy-tree struct))
17885 (parents (org-list-parents-alist struct))
17886 (prevs (org-list-prevs-alist struct))
17887 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17888 (org-list-struct-fix-ind struct parents)
17889 (org-list-struct-fix-bul struct prevs)
17890 (when arg
17891 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17892 (org-list-struct-fix-box struct parents prevs))
17893 (org-list-struct-apply-struct struct old-struct)
17894 (when arg (org-update-checkbox-count-maybe))
17895 (when firstp (org-list-send-list 'maybe))))
17896 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17897 ;; Dynamic block
17898 (beginning-of-line 1)
17899 (save-excursion (org-update-dblock)))
17900 ((save-excursion
17901 (beginning-of-line 1)
17903 (cond
17904 ((equal (match-string 1) "TBLFM")
17905 ;; Recalculate the table before this line
17906 (save-excursion
17907 (beginning-of-line 1)
17909 (if (org-at-table-p)
17910 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17911 (t
17912 (let ((org-inhibit-startup-visibility-stuff t)
17913 (org-startup-align-all-tables nil))
17914 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17915 (message "Local setup has been refreshed"))))
17916 ((org-clock-update-time-maybe))
17917 (t
17918 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
17919 (error "C-c C-c can do nothing useful at this location"))))))
17921 (defun org-mode-restart ()
17922 "Restart Org-mode, to scan again for special lines.
17923 Also updates the keyword regular expressions."
17924 (interactive)
17925 (org-mode)
17926 (message "Org-mode restarted"))
17928 (defun org-kill-note-or-show-branches ()
17929 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17930 (interactive)
17931 (if (not org-finish-function)
17932 (progn
17933 (hide-subtree)
17934 (call-interactively 'show-branches))
17935 (let ((org-note-abort t))
17936 (funcall org-finish-function))))
17938 (defun org-return (&optional indent)
17939 "Goto next table row or insert a newline.
17940 Calls `org-table-next-row' or `newline', depending on context.
17941 See the individual commands for more information."
17942 (interactive)
17943 (cond
17944 ((bobp) (if indent (newline-and-indent) (newline)))
17945 ((org-at-table-p)
17946 (org-table-justify-field-maybe)
17947 (call-interactively 'org-table-next-row))
17948 ;; when `newline-and-indent' is called within a list, make sure
17949 ;; text moved stays inside the item.
17950 ((and (org-in-item-p) indent)
17951 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17952 (progn
17953 (newline)
17954 (org-indent-line-to (length (match-string 0))))
17955 (let ((ind (org-get-indentation)))
17956 (newline)
17957 (if (org-looking-back org-list-end-re)
17958 (org-indent-line-function)
17959 (org-indent-line-to ind)))))
17960 ((and org-return-follows-link
17961 (eq (get-text-property (point) 'face) 'org-link))
17962 (call-interactively 'org-open-at-point))
17963 ((and (org-at-heading-p)
17964 (looking-at
17966 (org-show-entry)
17967 (end-of-line 1)
17968 (newline))
17969 (t (if indent (newline-and-indent) (newline)))))
17971 (defun org-return-indent ()
17972 "Goto next table row or insert a newline and indent.
17973 Calls `org-table-next-row' or `newline-and-indent', depending on
17974 context. See the individual commands for more information."
17975 (interactive)
17976 (org-return t))
17978 (defun org-ctrl-c-star ()
17979 "Compute table, or change heading status of lines.
17980 Calls `org-table-recalculate' or `org-toggle-heading',
17981 depending on context."
17982 (interactive)
17983 (cond
17984 ((org-at-table-p)
17985 (call-interactively 'org-table-recalculate))
17986 (t
17987 ;; Convert all lines in region to list items
17988 (call-interactively 'org-toggle-heading))))
17990 (defun org-ctrl-c-minus ()
17991 "Insert separator line in table or modify bullet status of line.
17992 Also turns a plain line or a region of lines into list items.
17993 Calls `org-table-insert-hline', `org-toggle-item', or
17994 `org-cycle-list-bullet', depending on context."
17995 (interactive)
17996 (cond
17997 ((org-at-table-p)
17998 (call-interactively 'org-table-insert-hline))
17999 ((org-region-active-p)
18000 (call-interactively 'org-toggle-item))
18001 ((org-in-item-p)
18002 (call-interactively 'org-cycle-list-bullet))
18003 (t
18004 (call-interactively 'org-toggle-item))))
18006 (defun org-toggle-item (arg)
18007 "Convert headings or normal lines to items, items to normal lines.
18008 If there is no active region, only the current line is considered.
18010 If the first non blank line in the region is an headline, convert
18011 all headlines to items, shifting text accordingly.
18013 If it is an item, convert all items to normal lines.
18015 If it is normal text, change region into an item. With a prefix
18016 argument ARG, change each line in region into an item."
18017 (interactive "P")
18018 (let ((shift-text
18019 (function
18020 ;; Shift text in current section to IND, from point to END.
18021 ;; The function leaves point to END line.
18022 (lambda (ind end)
18023 (let ((min-i 1000) (end (copy-marker end)))
18024 ;; First determine the minimum indentation (MIN-I) of
18025 ;; the text.
18026 (save-excursion
18027 (catch 'exit
18028 (while (< (point) end)
18029 (let ((i (org-get-indentation)))
18030 (cond
18031 ;; Skip blank lines and inline tasks.
18033 ((looking-at org-outline-regexp-bol))
18034 ;; We can't find less than 0 indentation.
18035 ((zerop i) (throw 'exit (setq min-i 0)))
18036 ((< i min-i) (setq min-i i))))
18037 (forward-line))))
18038 ;; Then indent each line so that a line indented to
18039 ;; MIN-I becomes indented to IND. Ignore blank lines
18040 ;; and inline tasks in the process.
18041 (let ((delta (- ind min-i)))
18042 (while (< (point) end)
18044 (looking-at org-outline-regexp-bol))
18045 (org-indent-line-to (+ (org-get-indentation) delta)))
18046 (forward-line)))))))
18047 (skip-blanks
18048 (function
18049 ;; Return beginning of first non-blank line, starting from
18050 ;; line at POS.
18051 (lambda (pos)
18052 (save-excursion
18053 (goto-char pos)
18055 (point-at-bol)))))
18056 beg end)
18057 ;; Determine boundaries of changes.
18058 (if (org-region-active-p)
18059 (setq beg (funcall skip-blanks (region-beginning))
18060 end (copy-marker (region-end)))
18061 (setq beg (funcall skip-blanks (point-at-bol))
18062 end (copy-marker (point-at-eol))))
18063 ;; Depending on the starting line, choose an action on the text
18064 ;; between BEG and END.
18065 (org-with-limited-levels
18066 (save-excursion
18067 (goto-char beg)
18068 (cond
18069 ;; Case 1. Start at an item: de-itemize. Note that it only
18070 ;; happens when a region is active: `org-ctrl-c-minus'
18071 ;; would call `org-cycle-list-bullet' otherwise.
18072 ((org-at-item-p)
18073 (while (< (point) end)
18074 (when (org-at-item-p)
18076 (delete-region (point) (match-end 0)))
18077 (forward-line)))
18078 ;; Case 2. Start at an heading: convert to items.
18079 ((org-on-heading-p)
18080 (let* ((bul (org-list-bullet-string "-"))
18081 (bul-len (length bul))
18082 ;; Indentation of the first heading. It should be
18083 ;; relative to the indentation of its parent, if any.
18084 (start-ind (save-excursion
18085 (cond
18086 ((not org-adapt-indentation) 0)
18087 ((not (outline-previous-heading)) 0)
18088 (t (length (match-string 0))))))
18089 ;; Level of first heading. Further headings will be
18090 ;; compared to it to determine hierarchy in the list.
18091 (ref-level (org-reduced-level (org-outline-level))))
18092 (while (< (point) end)
18093 (let* ((level (org-reduced-level (org-outline-level)))
18094 (delta (max 0 (- level ref-level))))
18095 ;; If current headline is less indented than the first
18096 ;; one, set it as reference, in order to preserve
18097 ;; subtrees.
18098 (when (< level ref-level) (setq ref-level level))
18099 (replace-match bul t t)
18100 (org-indent-line-to (+ start-ind (* delta bul-len)))
18101 ;; Ensure all text down to END (or SECTION-END) belongs
18102 ;; to the newly created item.
18103 (let ((section-end (save-excursion
18104 (or (outline-next-heading) (point)))))
18105 (forward-line)
18106 (funcall shift-text
18107 (+ start-ind (* (1+ delta) bul-len))
18108 (min end section-end)))))))
18109 ;; Case 3. Normal line with ARG: turn each non-item line into
18110 ;; an item.
18111 (arg
18112 (while (< (point) end)
18113 (unless (or (org-on-heading-p) (org-at-item-p))
18115 (replace-match
18117 (forward-line)))
18118 ;; Case 4. Normal line without ARG: make the first line of
18119 ;; region an item, and shift indentation of others
18120 ;; lines to set them as item's body.
18121 (t (let* ((bul (org-list-bullet-string "-"))
18122 (bul-len (length bul))
18123 (ref-ind (org-get-indentation)))
18125 (insert bul)
18126 (forward-line)
18127 (while (< (point) end)
18128 ;; Ensure that lines less indented than first one
18129 ;; still get included in item body.
18130 (funcall shift-text
18131 (+ ref-ind bul-len)
18132 (min end (save-excursion (or (outline-next-heading)
18133 (point)))))
18134 (forward-line)))))))))
18136 (defun org-toggle-heading (&optional nstars)
18137 "Convert headings to normal text, or items or text to headings.
18138 If there is no active region, only the current line is considered.
18140 If the first non blank line is an headline, remove the stars from
18141 all headlines in the region.
18143 If it is a plain list item, turn all plain list items into headings.
18145 If it is a normal line, turn each and every normal line (i.e. not
18146 an heading or an item) in the region into a heading.
18148 When converting a line into a heading, the number of stars is chosen
18149 such that the lines become children of the current entry. However,
18150 when a prefix argument is given, its value determines the number of
18151 stars to add."
18152 (interactive "P")
18153 (let ((skip-blanks
18154 (function
18155 ;; Return beginning of first non-blank line, starting from
18156 ;; line at POS.
18157 (lambda (pos)
18158 (save-excursion
18159 (goto-char pos)
18161 (point-at-bol)))))
18162 beg end)
18163 ;; Determine boundaries of changes. If region ends at a bol, do
18164 ;; not consider the last line to be in the region.
18165 (if (org-region-active-p)
18166 (setq beg (funcall skip-blanks (region-beginning))
18167 end (copy-marker (save-excursion
18168 (goto-char (region-end))
18169 (if (bolp) (point) (point-at-eol)))))
18170 (setq beg (funcall skip-blanks (point-at-bol))
18171 end (copy-marker (point-at-eol))))
18172 ;; Ensure inline tasks don't count as headings.
18173 (org-with-limited-levels
18174 (save-excursion
18175 (goto-char beg)
18176 (cond
18177 ;; Case 1. Started at an heading: de-star headings.
18178 ((org-on-heading-p)
18179 (while (< (point) end)
18180 (when (org-on-heading-p t)
18181 (looking-at org-outline-regexp) (replace-match ""))
18182 (forward-line)))
18183 ;; Case 2. Started at an item: change items into headlines.
18184 ;; One star will be added by `org-list-to-subtree'.
18185 ((org-at-item-p)
18186 (let* ((stars (make-string
18187 (if nstars
18188 ;; subtract the star that will be added again by
18189 ;; `org-list-to-subtree'
18190 (1- (prefix-numeric-value current-prefix-arg))
18191 (or (org-current-level) 0))
18192 ?*))
18193 (add-stars
18194 (cond (nstars "") ; stars from prefix only
18195 ((equal stars "") "") ; before first heading
18196 (org-odd-levels-only "*") ; inside heading, odd
18197 (t "")))) ; inside heading, oddeven
18198 (while (< (point) end)
18199 (when (org-at-item-p)
18200 ;; Pay attention to cases when region ends before list.
18201 (let* ((struct (org-list-struct))
18202 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18203 (save-restriction
18204 (narrow-to-region (point) list-end)
18205 (insert
18206 (org-list-to-subtree
18207 (org-list-parse-list t)
18208 '(:istart (concat stars add-stars (funcall get-stars depth))
18209 :icount (concat stars add-stars (funcall get-stars depth))))))))
18210 (forward-line))))
18211 ;; Case 3. Started at normal text: make every line an heading,
18212 ;; skipping headlines and items.
18213 (t (let* ((stars (make-string
18214 (if nstars
18215 (prefix-numeric-value current-prefix-arg)
18216 (or (org-current-level) 0))
18217 ?*))
18218 (add-stars
18219 (cond (nstars "") ; stars from prefix only
18220 ((equal stars "") "*") ; before first heading
18221 (org-odd-levels-only "**") ; inside heading, odd
18222 (t "*"))) ; inside heading, oddeven
18223 (rpl (concat stars add-stars " ")))
18224 (while (< (point) end)
18225 (when (and (not (org-on-heading-p)) (not (org-at-item-p))
18227 (replace-match (concat rpl (match-string 2))))
18228 (forward-line)))))))))
18230 (defun org-meta-return (&optional arg)
18231 "Insert a new heading or wrap a region in a table.
18232 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18233 See the individual commands for more information."
18234 (interactive "P")
18235 (cond
18236 ((run-hook-with-args-until-success 'org-metareturn-hook))
18237 ((org-at-table-p)
18238 (call-interactively 'org-table-wrap-region))
18239 (t (call-interactively 'org-insert-heading))))
18241 ;;; Menu entries
18243 ;; Define the Org-mode menus
18244 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18245 '("Tbl"
18246 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18247 ["Next Field" org-cycle (org-at-table-p)]
18248 ["Previous Field" org-shifttab (org-at-table-p)]
18249 ["Next Row" org-return (org-at-table-p)]
18250 "--"
18251 ["Blank Field" org-table-blank-field (org-at-table-p)]
18252 ["Edit Field" org-table-edit-field (org-at-table-p)]
18253 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18254 "--"
18255 ("Column"
18256 ["Move Column Left" org-metaleft (org-at-table-p)]
18257 ["Move Column Right" org-metaright (org-at-table-p)]
18258 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18259 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18260 ("Row"
18261 ["Move Row Up" org-metaup (org-at-table-p)]
18262 ["Move Row Down" org-metadown (org-at-table-p)]
18263 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18264 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18265 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18266 "--"
18267 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18268 ("Rectangle"
18269 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18270 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18271 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18272 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18273 "--"
18274 ("Calculate"
18275 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18276 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18277 ["Edit Formulas" org-edit-special (org-at-table-p)]
18278 "--"
18279 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18280 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18281 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18282 "--"
18283 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18284 "--"
18285 ["Sum Column/Rectangle" org-table-sum
18286 (or (org-at-table-p) (org-region-active-p))]
18287 ["Which Column?" org-table-current-column (org-at-table-p)])
18288 ["Debug Formulas"
18289 org-table-toggle-formula-debugger
18290 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18291 ["Show Col/Row Numbers"
18292 org-table-toggle-coordinate-overlays
18293 :style toggle
18294 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18295 "--"
18296 ["Create" org-table-create (and (not (org-at-table-p))
18297 org-enable-table-editor)]
18298 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18299 ["Import from File" org-table-import (not (org-at-table-p))]
18300 ["Export to File" org-table-export (org-at-table-p)]
18301 "--"
18302 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18304 (easy-menu-define org-org-menu org-mode-map "Org menu"
18305 '("Org"
18306 ("Show/Hide"
18307 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18308 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18309 ["Sparse Tree..." org-sparse-tree t]
18310 ["Reveal Context" org-reveal t]
18311 ["Show All" show-all t]
18312 "--"
18313 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18314 "--"
18315 ["New Heading" org-insert-heading t]
18316 ("Navigate Headings"
18317 ["Up" outline-up-heading t]
18318 ["Next" outline-next-visible-heading t]
18319 ["Previous" outline-previous-visible-heading t]
18320 ["Next Same Level" outline-forward-same-level t]
18321 ["Previous Same Level" outline-backward-same-level t]
18322 "--"
18323 ["Jump" org-goto t])
18324 ("Edit Structure"
18325 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18326 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18327 "--"
18328 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18329 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18330 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18331 "--"
18332 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18333 "--"
18334 ["Copy visible text" org-copy-visible t]
18335 "--"
18336 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18337 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18338 ["Demote Heading" org-metaright (not (org-at-table-p))]
18339 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18340 "--"
18341 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18342 "--"
18343 ["Convert to odd levels" org-convert-to-odd-levels t]
18344 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18345 ("Editing"
18346 ["Emphasis..." org-emphasize t]
18347 ["Edit Source Example" org-edit-special t]
18348 "--"
18349 ["Footnote new/jump" org-footnote-action t]
18350 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18351 ("Archive"
18352 ["Archive (default method)" org-archive-subtree-default t]
18353 "--"
18354 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18355 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18356 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18357 )
18358 "--"
18359 ("Hyperlinks"
18360 ["Store Link (Global)" org-store-link t]
18361 ["Find existing link to here" org-occur-link-in-agenda-files t]
18362 ["Insert Link" org-insert-link t]
18363 ["Follow Link" org-open-at-point t]
18364 "--"
18365 ["Next link" org-next-link t]
18366 ["Previous link" org-previous-link t]
18367 "--"
18368 ["Descriptive Links"
18369 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18370 :style radio
18371 :selected (member '(org-link) buffer-invisibility-spec)]
18372 ["Literal Links"
18373 (progn
18374 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18375 :style radio
18376 :selected (not (member '(org-link) buffer-invisibility-spec))])
18377 "--"
18378 ("TODO Lists"
18379 ["TODO/DONE/-" org-todo t]
18380 ("Select keyword"
18381 ["Next keyword" org-shiftright (org-on-heading-p)]
18382 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18383 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18384 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18385 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18386 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18387 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18388 "--"
18389 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18390 :selected org-enforce-todo-dependencies :style toggle :active t]
18391 "Settings for tree at point"
18392 ["Do Children sequentially" org-toggle-ordered-property :style radio
18393 :selected (org-entry-get nil "ORDERED")
18394 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18395 ["Do Children parallel" org-toggle-ordered-property :style radio
18396 :selected (not (org-entry-get nil "ORDERED"))
18397 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18398 "--"
18399 ["Set Priority" org-priority t]
18400 ["Priority Up" org-shiftup t]
18401 ["Priority Down" org-shiftdown t]
18402 "--"
18403 ["Get news from all feeds" org-feed-update-all t]
18404 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18405 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18406 ("TAGS and Properties"
18407 ["Set Tags" org-set-tags-command t]
18408 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18409 "--"
18410 ["Set property" org-set-property t]
18411 ["Column view of properties" org-columns t]
18412 ["Insert Column View DBlock" org-insert-columns-dblock t])
18413 ("Dates and Scheduling"
18414 ["Timestamp" org-time-stamp t]
18415 ["Timestamp (inactive)" org-time-stamp-inactive t]
18416 ("Change Date"
18417 ["1 Day Later" org-shiftright t]
18418 ["1 Day Earlier" org-shiftleft t]
18419 ["1 ... Later" org-shiftup t]
18420 ["1 ... Earlier" org-shiftdown t])
18421 ["Compute Time Range" org-evaluate-time-range t]
18422 ["Schedule Item" org-schedule t]
18423 ["Deadline" org-deadline t]
18424 "--"
18425 ["Custom time format" org-toggle-time-stamp-overlays
18426 :style radio :selected org-display-custom-times]
18427 "--"
18428 ["Goto Calendar" org-goto-calendar t]
18429 ["Date from Calendar" org-date-from-calendar t]
18430 "--"
18431 ["Start/Restart Timer" org-timer-start t]
18432 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18433 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18434 ["Insert Timer String" org-timer t]
18435 ["Insert Timer Item" org-timer-item t])
18436 ("Logging work"
18437 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18438 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18439 ["Clock out" org-clock-out t]
18440 ["Clock cancel" org-clock-cancel t]
18441 "--"
18442 ["Mark as default task" org-clock-mark-default-task t]
18443 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18444 ["Goto running clock" org-clock-goto t]
18445 "--"
18446 ["Display times" org-clock-display t]
18447 ["Create clock table" org-clock-report t]
18448 "--"
18449 ["Record DONE time"
18450 (progn (setq org-log-done (not org-log-done))
18451 (message "Switching to %s will %s record a timestamp"
18452 (car org-done-keywords)
18453 (if org-log-done "automatically" "not")))
18454 :style toggle :selected org-log-done])
18455 "--"
18456 ["Agenda Command..." org-agenda t]
18457 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18458 ("File List for Agenda")
18459 ("Special views current file"
18460 ["TODO Tree" org-show-todo-tree t]
18461 ["Check Deadlines" org-check-deadlines t]
18462 ["Timeline" org-timeline t]
18463 ["Tags/Property tree" org-match-sparse-tree t])
18464 "--"
18465 ["Export/Publish..." org-export t]
18466 ("LaTeX"
18467 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18468 :selected org-cdlatex-mode]
18469 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18470 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18471 ["Modify math symbol" org-cdlatex-math-modify
18472 (org-inside-LaTeX-fragment-p)]
18473 ["Insert citation" org-reftex-citation t]
18474 "--"
18475 ["Template for BEAMER" org-insert-beamer-options-template t])
18476 "--"
18477 ("MobileOrg"
18478 ["Push Files and Views" org-mobile-push t]
18479 ["Get Captured and Flagged" org-mobile-pull t]
18480 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18481 "--"
18482 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18483 "--"
18484 ("Documentation"
18485 ["Show Version" org-version t]
18486 ["Info Documentation" org-info t])
18487 ("Customize"
18488 ["Browse Org Group" org-customize t]
18489 "--"
18490 ["Expand This Menu" org-create-customize-menu
18491 (fboundp 'customize-menu-create)])
18492 ["Send bug report" org-submit-bug-report t]
18493 "--"
18494 ("Refresh/Reload"
18495 ["Refresh setup current buffer" org-mode-restart t]
18496 ["Reload Org (after update)" org-reload t]
18497 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18498 ))
18500 (defun org-info (&optional node)
18501 "Read documentation for Org-mode in the info system.
18502 With optional NODE, go directly to that node."
18503 (interactive)
18504 (info (format "(org)%s" (or node ""))))
18506 ;;;###autoload
18507 (defun org-submit-bug-report ()
18508 "Submit a bug report on Org-mode via mail.
18510 Don't hesitate to report any problems or inaccurate documentation.
18512 If you don't have setup sending mail from (X)Emacs, please copy the
18513 output buffer into your mail program, as it gives us important
18514 information about your Org-mode version and configuration."
18515 (interactive)
18516 (require 'reporter)
18517 (org-load-modules-maybe)
18518 (org-require-autoloaded-modules)
18519 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18520 (reporter-submit-bug-report
18521 "emacs-orgmode@gnu.org"
18522 (org-version)
18523 (let (list)
18524 (save-window-excursion
18525 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
18526 (delete-other-windows)
18527 (erase-buffer)
18528 (insert "You are about to submit a bug report to the Org-mode mailing list.
18530 We would like to add your full Org-mode and Outline configuration to the
18531 bug report. This greatly simplifies the work of the maintainer and
18532 other experts on the mailing list.
18534 HOWEVER, some variables you have customized may contain private
18535 information. The names of customers, colleagues, or friends, might
18536 appear in the form of file names, tags, todo states, or search strings.
18537 If you answer yes to the prompt, you might want to check and remove
18538 such private information before sending the email.")
18539 (add-text-properties (point-min) (point-max) '(face org-warning))
18540 (when (yes-or-no-p "Include your Org-mode configuration ")
18541 (mapatoms
18542 (lambda (v)
18543 (and (boundp v)
18545 (or (and (symbol-value v)
18547 (and
18548 (get v 'custom-type) (get v 'standard-value)
18549 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18550 (push v list)))))
18551 (kill-buffer (get-buffer "*Warn about privacy*"))
18552 list))
18553 nil nil
18554 "Remember to cover the basics, that is, what you expected to happen and
18555 what in fact did happen. You don't know how to make a good report? See
18557 http://orgmode.org/manual/Feedback.html#Feedback
18559 Your bug report will be posted to the Org-mode mailing list.
18560 ------------------------------------------------------------------------")
18561 (save-excursion
18566 (defun org-install-agenda-files-menu ()
18567 (let ((bl (buffer-list)))
18568 (save-excursion
18569 (while bl
18570 (set-buffer (pop bl))
18571 (if (org-mode-p) (setq bl nil)))
18572 (when (org-mode-p)
18573 (easy-menu-change
18574 '("Org") "File List for Agenda"
18575 (append
18576 (list
18577 ["Edit File List" (org-edit-agenda-file-list) t]
18578 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18579 ["Remove Current File from List" org-remove-file t]
18580 ["Cycle through agenda files" org-cycle-agenda-files t]
18581 ["Occur in all agenda files" org-occur-in-agenda-files t]
18582 "--")
18583 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18585 ;;;; Documentation
18587 ;;;###autoload
18588 (defun org-require-autoloaded-modules ()
18589 (interactive)
18590 (mapc 'require
18591 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18592 org-docbook org-exp org-html org-icalendar
18593 org-id org-latex
18594 org-publish org-remember org-table
18595 org-timer org-xoxo)))
18597 ;;;###autoload
18598 (defun org-reload (&optional uncompiled)
18599 "Reload all org lisp files.
18600 With prefix arg UNCOMPILED, load the uncompiled versions."
18601 (interactive "P")
18602 (require 'find-func)
18604 (dir-org (file-name-directory (org-find-library-name "org")))
18605 (dir-org-contrib (ignore-errors
18606 (file-name-directory
18607 (org-find-library-name "org-contribdir"))))
18608 (babel-files
18609 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18610 (append (list nil "comint" "eval" "exp" "keys"
18611 "lob" "ref" "table" "tangle")
18612 (delq nil
18613 (mapcar
18614 (lambda (lang)
18615 (when (cdr lang) (symbol-name (car lang))))
18616 org-babel-load-languages)))))
18617 (files
18618 (append (directory-files dir-org t file-re)
18619 babel-files
18620 (and dir-org-contrib
18621 (directory-files dir-org-contrib t file-re))))
18622 (remove-re (concat (if (featurep 'xemacs)
18623 "org-colview" "org-colview-xemacs")
18625 (setq files (mapcar 'file-name-sans-extension files))
18626 (setq files (mapcar
18627 (lambda (x) (if (string-match remove-re x) nil x))
18628 files))
18629 (setq files (delq nil files))
18630 (mapc
18631 (lambda (f)
18632 (when (featurep (intern (file-name-nondirectory f)))
18633 (if (and (not uncompiled)
18634 (file-exists-p (concat f ".elc")))
18635 (load (concat f ".elc") nil nil t)
18636 (load (concat f ".el") nil nil t))))
18637 files))
18638 (org-version))
18640 ;;;###autoload
18641 (defun org-customize ()
18642 "Call the customize function with org as argument."
18643 (interactive)
18644 (org-load-modules-maybe)
18645 (org-require-autoloaded-modules)
18646 (customize-browse 'org))
18648 (defun org-create-customize-menu ()
18649 "Create a full customization menu for Org-mode, insert it into the menu."
18650 (interactive)
18651 (org-load-modules-maybe)
18652 (org-require-autoloaded-modules)
18653 (if (fboundp 'customize-menu-create)
18654 (progn
18655 (easy-menu-change
18656 '("Org") "Customize"
18657 `(["Browse Org group" org-customize t]
18658 "--"
18659 ,(customize-menu-create 'org)
18660 ["Set" Custom-set t]
18661 ["Save" Custom-save t]
18662 ["Reset to Current" Custom-reset-current t]
18663 ["Reset to Saved" Custom-reset-saved t]
18664 ["Reset to Standard Settings" Custom-reset-standard t]))
18666 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18668 ;;;; Miscellaneous stuff
18670 ;;; Generally useful functions
18672 (defun org-get-at-bol (property)
18673 "Get text property PROPERTY at beginning of line."
18674 (get-text-property (point-at-bol) property))
18676 (defun org-find-text-property-in-string (prop s)
18677 "Return the first non-nil value of property PROP in string S."
18678 (or (get-text-property 0 prop s)
18679 (get-text-property (or (next-single-property-change 0 prop s) 0)
18680 prop s)))
18682 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18683 "Display the given MESSAGE as a warning."
18684 (if (fboundp 'display-warning)
18685 (display-warning 'org message
18686 (if (featurep 'xemacs) 'warning :warning))
18687 (let ((buf (get-buffer-create "*Org warnings*")))
18688 (with-current-buffer buf
18689 (goto-char (point-max))
18690 (insert "Warning (Org): " message)
18691 (unless (bolp)
18692 (newline)))
18693 (display-buffer buf)
18694 (sit-for 0))))
18696 (defun org-eval (form)
18697 "Eval FORM and return result."
18698 (condition-case error
18699 (eval form)
18700 (error (format "%%![Error: %s]" error))))
18702 (defun org-in-commented-line ()
18703 "Is point in a line starting with `#'?"
18704 (equal (char-after (point-at-bol)) ?#))
18706 (defun org-in-indented-comment-line ()
18707 "Is point in a line starting with `#' after some white space?"
18708 (save-excursion
18709 (save-match-data
18710 (goto-char (point-at-bol))
18713 (defun org-in-verbatim-emphasis ()
18714 (save-match-data
18715 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18717 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18718 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18719 (if (and marker (marker-buffer marker)
18720 (buffer-live-p (marker-buffer marker)))
18721 (progn
18722 (org-pop-to-buffer-same-window (marker-buffer marker))
18723 (if (or (> marker (point-max)) (< marker (point-min)))
18724 (widen))
18725 (goto-char marker)
18726 (org-show-context 'org-goto))
18727 (if bookmark
18728 (bookmark-jump bookmark)
18729 (error "Cannot find location"))))
18731 (defun org-quote-csv-field (s)
18732 "Quote field for inclusion in CSV material."
18735 s))
18737 (defun org-force-self-insert (N)
18738 "Needed to enforce self-insert under remapping."
18739 (interactive "p")
18740 (self-insert-command N))
18742 (defun org-string-width (s)
18743 "Compute width of string, ignoring invisible characters.
18744 This ignores character with invisibility property `org-link', and also
18745 characters with property `org-cwidth', because these will become invisible
18746 upon the next fontification round."
18747 (let (b l)
18748 (when (or (eq t buffer-invisibility-spec)
18749 (assq 'org-link buffer-invisibility-spec))
18750 (while (setq b (text-property-any 0 (length s)
18751 'invisible 'org-link s))
18752 (setq s (concat (substring s 0 b)
18753 (substring s (or (next-single-property-change
18754 b 'invisible s) (length s)))))))
18755 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18756 (setq s (concat (substring s 0 b)
18757 (substring s (or (next-single-property-change
18758 b 'org-cwidth s) (length s))))))
18759 (setq l (string-width s) b -1)
18760 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18761 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18762 l))
18764 (defun org-shorten-string (s maxlength)
18765 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18766 If the string is shorter or has length MAXLENGTH, just return the
18767 original string. If it is longer, the functions finds a space in the
18768 string, breaks this string off at that locations and adds three dots
18769 as ellipsis. Including the ellipsis, the string will not be longer
18770 than MAXLENGTH. If finding a good breaking point in the string does
18771 not work, the string is just chopped off in the middle of a word
18772 if necessary."
18773 (if (<= (length s) maxlength)
18774 s
18775 (let* ((n (max (- maxlength 4) 1))
18777 (if (string-match re s)
18778 (concat (match-string 1 s) "...")
18779 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18781 (defun org-get-indentation (&optional line)
18782 "Get the indentation of the current line, interpreting tabs.
18783 When LINE is given, assume it represents a line and compute its indentation."
18784 (if line
18785 (if (string-match "^ *" (org-remove-tabs line))
18786 (match-end 0))
18787 (save-excursion
18788 (beginning-of-line 1)
18790 (current-column))))
18792 (defun org-get-string-indentation (s)
18793 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18794 (let ((n -1) (i 0) (w tab-width) c)
18795 (catch 'exit
18796 (while (< (setq n (1+ n)) (length s))
18797 (setq c (aref s n))
18798 (cond ((= c ?\ ) (setq i (1+ i)))
18800 (t (throw 'exit t)))))
18801 i))
18803 (defun org-remove-tabs (s &optional width)
18804 "Replace tabulators in S with spaces.
18805 Assumes that s is a single line, starting in column 0."
18806 (setq width (or width tab-width))
18808 (setq s (replace-match
18809 (make-string
18810 (- (* width (/ (+ (match-beginning 0) width) width))
18811 (match-beginning 0)) ?\ )
18812 t t s)))
18813 s)
18815 (defun org-fix-indentation (line ind)
18816 "Fix indentation in LINE.
18817 IND is a cons cell with target and minimum indentation.
18818 If the current indentation in LINE is smaller than the minimum,
18819 leave it alone. If it is larger than ind, set it to the target."
18820 (let* ((l (org-remove-tabs line))
18821 (i (org-get-indentation l))
18822 (i1 (car ind)) (i2 (cdr ind)))
18823 (if (>= i i2) (setq l (substring line i2)))
18824 (if (> i1 0)
18825 (concat (make-string i1 ?\ ) l)
18826 l)))
18828 (defun org-remove-indentation (code &optional n)
18829 "Remove the maximum common indentation from the lines in CODE.
18830 N may optionally be the number of spaces to remove."
18831 (with-temp-buffer
18832 (insert code)
18833 (org-do-remove-indentation n)
18834 (buffer-string)))
18836 (defun org-do-remove-indentation (&optional n)
18837 "Remove the maximum common indentation from the buffer."
18838 (untabify (point-min) (point-max))
18839 (let ((min 10000) re)
18840 (if n
18841 (setq min n)
18842 (goto-char (point-min))
18844 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18845 (unless (or (= min 0) (= min 10000))
18847 (goto-char (point-min))
18848 (while (re-search-forward re nil t)
18849 (replace-match "")
18850 (end-of-line 1))
18851 min)))
18853 (defun org-fill-template (template alist)
18854 "Find each %key of ALIST in TEMPLATE and replace it."
18855 (let ((case-fold-search nil)
18856 entry key value)
18857 (setq alist (sort (copy-sequence alist)
18858 (lambda (a b) (< (length (car a)) (length (car b))))))
18859 (while (setq entry (pop alist))
18860 (setq template
18861 (replace-regexp-in-string
18862 (concat "%" (regexp-quote (car entry)))
18863 (cdr entry) template t t)))
18864 template))
18866 (defun org-base-buffer (buffer)
18867 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18868 (if (not buffer)
18869 buffer
18870 (or (buffer-base-buffer buffer)
18871 buffer)))
18873 (defun org-trim (s)
18874 "Remove whitespace at beginning and end of string."
18877 s)
18879 (defun org-wrap (string &optional width lines)
18880 "Wrap string to either a number of lines, or a width in characters.
18881 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18882 that costs. If there is a word longer than WIDTH, the text is actually
18883 wrapped to the length of that word.
18884 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18885 many lines, whatever width that takes.
18886 The return value is a list of lines, without newlines at the end."
18888 (maxword (apply 'max (mapcar 'org-string-width words)))
18889 w ll)
18890 (cond (width
18891 (org-do-wrap words (max maxword width)))
18892 (lines
18893 (setq w maxword)
18894 (setq ll (org-do-wrap words maxword))
18895 (if (<= (length ll) lines)
18896 ll
18897 (setq ll words)
18898 (while (> (length ll) lines)
18899 (setq w (1+ w))
18900 (setq ll (org-do-wrap words w)))
18901 ll))
18902 (t (error "Cannot wrap this")))))
18904 (defun org-do-wrap (words width)
18905 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18906 (let (lines line)
18907 (while words
18908 (setq line (pop words))
18909 (while (and words (< (+ (length line) (length (car words))) width))
18910 (setq line (concat line " " (pop words))))
18911 (setq lines (push line lines)))
18912 (nreverse lines)))
18914 (defun org-split-string (string &optional separators)
18915 "Splits STRING into substrings at SEPARATORS.
18916 No empty strings are returned if there are matches at the beginning
18917 and end of string."
18919 (start 0)
18920 notfirst
18921 (list nil))
18922 (while (and (string-match rexp string
18923 (if (and notfirst
18924 (= start (match-beginning 0))
18925 (< start (length string)))
18926 (1+ start) start))
18927 (< (match-beginning 0) (length string)))
18928 (setq notfirst t)
18929 (or (eq (match-beginning 0) 0)
18930 (and (eq (match-beginning 0) (match-end 0))
18931 (eq (match-beginning 0) start))
18932 (setq list
18933 (cons (substring string start (match-beginning 0))
18934 list)))
18935 (setq start (match-end 0)))
18936 (or (eq start (length string))
18937 (setq list
18938 (cons (substring string start)
18939 list)))
18940 (nreverse list)))
18942 (defun org-quote-vert (s)
18944 (while (string-match "|" s)
18946 s)
18948 (defun org-uuidgen-p (s)
18949 "Is S an ID created by UUIDGEN?"
18950 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18952 (defun org-context ()
18953 "Return a list of contexts of the current cursor position.
18954 If several contexts apply, all are returned.
18955 Each context entry is a list with a symbol naming the context, and
18956 two positions indicating start and end of the context. Possible
18957 contexts are:
18959 :headline anywhere in a headline
18960 :headline-stars on the leading stars in a headline
18961 :todo-keyword on a TODO keyword (including DONE) in a headline
18962 :tags on the TAGS in a headline
18963 :priority on the priority cookie in a headline
18964 :item on the first line of a plain list item
18965 :item-bullet on the bullet/number of a plain list item
18966 :checkbox on the checkbox in a plain list item
18967 :table in an org-mode table
18968 :table-special on a special filed in a table
18969 :table-table in a table.el table
18970 :link on a hyperlink
18971 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18972 :target on a <<target>>
18973 :radio-target on a <<<radio-target>>>
18974 :latex-fragment on a LaTeX fragment
18975 :latex-preview on a LaTeX fragment with overlayed preview image
18977 This function expects the position to be visible because it uses font-lock
18978 faces as a help to recognize the following contexts: :table-special, :link,
18979 and :keyword."
18980 (let* ((f (get-text-property (point) 'face))
18981 (faces (if (listp f) f (list f)))
18982 (p (point)) clist o)
18983 ;; First the large context
18984 (cond
18985 ((org-on-heading-p t)
18986 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18987 (when (progn
18988 (beginning-of-line 1)
18989 (looking-at org-todo-line-tags-regexp))
18990 (push (org-point-in-group p 1 :headline-stars) clist)
18991 (push (org-point-in-group p 2 :todo-keyword) clist)
18992 (push (org-point-in-group p 4 :tags) clist))
18993 (goto-char p)
18996 (push (org-point-in-group p 0 :priority) clist)))
18998 ((org-at-item-p)
18999 (push (org-point-in-group p 2 :item-bullet) clist)
19000 (push (list :item (point-at-bol)
19001 (save-excursion (org-end-of-item) (point)))
19002 clist)
19003 (and (org-at-item-checkbox-p)
19004 (push (org-point-in-group p 0 :checkbox) clist)))
19006 ((org-at-table-p)
19007 (push (list :table (org-table-begin) (org-table-end)) clist)
19008 (if (memq 'org-formula faces)
19009 (push (list :table-special
19010 (previous-single-property-change p 'face)
19011 (next-single-property-change p 'face)) clist)))
19012 ((org-at-table-p 'any)
19013 (push (list :table-table) clist)))
19014 (goto-char p)
19016 ;; Now the small context
19017 (cond
19018 ((org-at-timestamp-p)
19019 (push (org-point-in-group p 0 :timestamp) clist))
19020 ((memq 'org-link faces)
19021 (push (list :link
19022 (previous-single-property-change p 'face)
19023 (next-single-property-change p 'face)) clist))
19024 ((memq 'org-special-keyword faces)
19025 (push (list :keyword
19026 (previous-single-property-change p 'face)
19027 (next-single-property-change p 'face)) clist))
19028 ((org-on-target-p)
19029 (push (org-point-in-group p 0 :target) clist)
19030 (goto-char (1- (match-beginning 0)))
19031 (if (looking-at org-radio-target-regexp)
19032 (push (org-point-in-group p 0 :radio-target) clist))
19033 (goto-char p))
19034 ((setq o (car (delq nil
19035 (mapcar
19036 (lambda (x)
19037 (if (memq x org-latex-fragment-image-overlays) x))
19038 (overlays-at (point))))))
19039 (push (list :latex-fragment
19040 (overlay-start o) (overlay-end o)) clist)
19041 (push (list :latex-preview
19042 (overlay-start o) (overlay-end o)) clist))
19043 ((org-inside-LaTeX-fragment-p)
19044 ;; FIXME: positions wrong.
19045 (push (list :latex-fragment (point) (point)) clist)))
19047 (setq clist (nreverse (delq nil clist)))
19048 clist))
19050 ;; FIXME: Compare with at-regexp-p Do we need both?
19051 (defun org-in-regexp (re &optional nlines visually)
19052 "Check if point is inside a match of regexp.
19053 Normally only the current line is checked, but you can include NLINES extra
19054 lines both before and after point into the search.
19055 If VISUALLY is set, require that the cursor is not after the match but
19056 really on, so that the block visually is on the match."
19057 (catch 'exit
19058 (let ((pos (point))
19059 (eol (point-at-eol (+ 1 (or nlines 0))))
19060 (inc (if visually 1 0)))
19061 (save-excursion
19062 (beginning-of-line (- 1 (or nlines 0)))
19063 (while (re-search-forward re eol t)
19064 (if (and (<= (match-beginning 0) pos)
19065 (>= (+ inc (match-end 0)) pos))
19066 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19068 (defun org-at-regexp-p (regexp)
19069 "Is point inside a match of REGEXP in the current line?"
19070 (catch 'exit
19071 (save-excursion
19072 (let ((pos (point)) (end (point-at-eol)))
19073 (beginning-of-line 1)
19074 (while (re-search-forward regexp end t)
19075 (if (and (<= (match-beginning 0) pos)
19076 (>= (match-end 0) pos))
19077 (throw 'exit t)))
19078 nil))))
19080 (defun org-in-regexps-block-p (start-re end-re &optional bound)
19081 "Return t if the current point is between matches of START-RE and END-RE.
19082 This will also return t if point is on one of the two matches or
19083 in an unfinished block. END-RE can be a string or a form
19084 returning a string.
19086 An optional third argument bounds the search for START-RE. It
19087 defaults to previous heading or `point-min'."
19088 (let ((pos (point))
19089 (limit (or bound (save-excursion (outline-previous-heading)))))
19090 (save-excursion
19091 ;; we're on a block when point is on start-re...
19092 (or (org-at-regexp-p start-re)
19093 ;; ... or start-re can be found above...
19094 (and (re-search-backward start-re limit t)
19095 ;; ... but no end-re between start-re and point.
19096 (not (re-search-forward (eval end-re) pos t)))))))
19098 (defun org-in-block-p (names)
19099 "Is point inside any block whose name belongs to NAMES?
19101 NAMES is a list of strings containing names of blocks."
19102 (save-match-data
19103 (catch 'exit
19104 (let ((case-fold-search t))
19105 (mapc (lambda (name)
19106 (let ((n (regexp-quote name)))
19107 (when (org-in-regexps-block-p
19110 (throw 'exit t))))
19111 names))
19112 nil)))
19114 (defun org-occur-in-agenda-files (regexp &optional nlines)
19115 "Call `multi-occur' with buffers for all agenda files."
19117 (let* ((files (org-agenda-files))
19118 (tnames (mapcar 'file-truename files))
19119 (extra org-agenda-text-search-extra-files)
19120 f)
19121 (when (eq (car extra) 'agenda-archives)
19122 (setq extra (cdr extra))
19123 (setq files (org-add-archive-files files)))
19124 (while (setq f (pop extra))
19125 (unless (member (file-truename f) tnames)
19126 (add-to-list 'files f 'append)
19127 (add-to-list 'tnames (file-truename f) 'append)))
19128 (multi-occur
19129 (mapcar (lambda (x)
19130 (with-current-buffer
19131 (or (get-file-buffer x) (find-file-noselect x))
19132 (widen)
19133 (current-buffer)))
19134 files)
19135 regexp)))
19137 (if (boundp 'occur-mode-find-occurrence-hook)
19138 ;; Emacs 23
19139 (add-hook 'occur-mode-find-occurrence-hook
19140 (lambda ()
19141 (when (org-mode-p)
19142 (org-reveal))))
19143 ;; Emacs 22
19144 (defadvice occur-mode-goto-occurrence
19145 (after org-occur-reveal activate)
19146 (and (org-mode-p) (org-reveal)))
19147 (defadvice occur-mode-goto-occurrence-other-window
19148 (after org-occur-reveal activate)
19149 (and (org-mode-p) (org-reveal)))
19150 (defadvice occur-mode-display-occurrence
19151 (after org-occur-reveal activate)
19152 (when (org-mode-p)
19153 (let ((pos (occur-mode-find-occurrence)))
19154 (with-current-buffer (marker-buffer pos)
19155 (save-excursion
19156 (goto-char pos)
19157 (org-reveal)))))))
19159 (defun org-occur-link-in-agenda-files ()
19160 "Create a link and search for it in the agendas.
19161 The link is not stored in `org-stored-links', it is just created
19162 for the search purpose."
19163 (interactive)
19164 (let ((link (condition-case nil
19165 (org-store-link nil)
19166 (error "Unable to create a link to here"))))
19167 (org-occur-in-agenda-files (regexp-quote link))))
19169 (defun org-uniquify (list)
19170 "Remove duplicate elements from LIST."
19171 (let (res)
19172 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19173 res))
19175 (defun org-delete-all (elts list)
19176 "Remove all elements in ELTS from LIST."
19177 (while elts
19178 (setq list (delete (pop elts) list)))
19179 list)
19181 (defun org-count (cl-item cl-seq)
19182 "Count the number of occurrences of ITEM in SEQ.
19183 Taken from `count' in cl-seq.el with all keyword arguments removed."
19184 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19185 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19186 (while (< cl-start cl-end)
19187 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19188 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19189 (setq cl-start (1+ cl-start)))
19190 cl-count))
19192 (defun org-remove-if (predicate seq)
19193 "Remove everything from SEQ that fulfills PREDICATE."
19194 (let (res e)
19195 (while seq
19196 (setq e (pop seq))
19197 (if (not (funcall predicate e)) (push e res)))
19198 (nreverse res)))
19200 (defun org-remove-if-not (predicate seq)
19201 "Remove everything from SEQ that does not fulfill PREDICATE."
19202 (let (res e)
19203 (while seq
19204 (setq e (pop seq))
19205 (if (funcall predicate e) (push e res)))
19206 (nreverse res)))
19208 (defun org-back-over-empty-lines ()
19209 "Move backwards over whitespace, to the beginning of the first empty line.
19210 Returns the number of empty lines passed."
19211 (let ((pos (point)))
19212 (if (cdr (assoc 'heading org-blank-before-new-entry))
19214 (forward-line -1))
19215 (beginning-of-line 2)
19216 (goto-char (min (point) pos))
19217 (count-lines (point) pos)))
19219 (defun org-skip-whitespace ()
19222 (defun org-point-in-group (point group &optional context)
19223 "Check if POINT is in match-group GROUP.
19224 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19225 match. If the match group does not exist or point is not inside it,
19226 return nil."
19227 (and (match-beginning group)
19228 (>= point (match-beginning group))
19229 (<= point (match-end group))
19230 (if context
19231 (list context (match-beginning group) (match-end group))
19232 t)))
19234 (defun org-switch-to-buffer-other-window (&rest args)
19235 "Switch to buffer in a second window on the current frame.
19236 In particular, do not allow pop-up frames.
19237 Returns the newly created buffer."
19238 (let (pop-up-frames special-display-buffer-names special-display-regexps
19239 special-display-function)
19240 (apply 'switch-to-buffer-other-window args)))
19242 (defun org-combine-plists (&rest plists)
19243 "Create a single property list from all plists in PLISTS.
19244 The process starts by copying the first list, and then setting properties
19245 from the other lists. Settings in the last list are the most significant
19246 ones and overrule settings in the other lists."
19247 (let ((rtn (copy-sequence (pop plists)))
19248 p v ls)
19249 (while plists
19250 (setq ls (pop plists))
19251 (while ls
19252 (setq p (pop ls) v (pop ls))
19253 (setq rtn (plist-put rtn p v))))
19254 rtn))
19256 (defun org-move-line-down (arg)
19257 "Move the current line down. With prefix argument, move it past ARG lines."
19258 (interactive "p")
19259 (let ((col (current-column))
19260 beg end pos)
19261 (beginning-of-line 1) (setq beg (point))
19262 (beginning-of-line 2) (setq end (point))
19263 (beginning-of-line (+ 1 arg))
19264 (setq pos (move-marker (make-marker) (point)))
19265 (insert (delete-and-extract-region beg end))
19266 (goto-char pos)
19267 (org-move-to-column col)))
19269 (defun org-move-line-up (arg)
19270 "Move the current line up. With prefix argument, move it past ARG lines."
19271 (interactive "p")
19272 (let ((col (current-column))
19273 beg end pos)
19274 (beginning-of-line 1) (setq beg (point))
19275 (beginning-of-line 2) (setq end (point))
19276 (beginning-of-line (- arg))
19277 (setq pos (move-marker (make-marker) (point)))
19278 (insert (delete-and-extract-region beg end))
19279 (goto-char pos)
19280 (org-move-to-column col)))
19282 (defun org-replace-escapes (string table)
19283 "Replace %-escapes in STRING with values in TABLE.
19285 The sequences in STRING may contain normal field width and padding information,
19287 so values can contain further %-escapes if they are define later in TABLE."
19288 (let ((tbl (copy-alist table))
19289 (case-fold-search nil)
19290 (pchg 0)
19291 e re rpl)
19292 (while (setq e (pop tbl))
19293 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19294 (when (and (cdr e) (string-match re (cdr e)))
19295 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19296 (safe "SREF"))
19297 (add-text-properties 0 3 (list 'sref sref) safe)
19298 (setcdr e (replace-match safe t t (cdr e)))))
19299 (while (string-match re string)
19300 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19301 (cdr e)))
19302 (setq string (replace-match rpl t t string))))
19303 (while (setq pchg (next-property-change pchg string))
19304 (let ((sref (get-text-property pchg 'sref string)))
19305 (when (and sref (string-match "SREF" string pchg))
19306 (setq string (replace-match sref t t string)))))
19307 string))
19309 (defun org-sublist (list start end)
19310 "Return a section of LIST, from START to END.
19311 Counting starts at 1."
19312 (let (rtn (c start))
19313 (setq list (nthcdr (1- start) list))
19314 (while (and list (<= c end))
19315 (push (pop list) rtn)
19316 (setq c (1+ c)))
19317 (nreverse rtn)))
19319 (defun org-find-base-buffer-visiting (file)
19320 "Like `find-buffer-visiting' but always return the base buffer and
19321 not an indirect buffer."
19322 (let ((buf (or (get-file-buffer file)
19323 (find-buffer-visiting file))))
19324 (if buf
19325 (or (buffer-base-buffer buf) buf)
19326 nil)))
19328 (defun org-image-file-name-regexp (&optional extensions)
19329 "Return regexp matching the file names of images.
19330 If EXTENSIONS is given, only match these."
19331 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19332 (image-file-name-regexp)
19333 (let ((image-file-name-extensions
19334 (or extensions
19335 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19336 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19338 (regexp-opt (nconc (mapcar 'upcase
19339 image-file-name-extensions)
19340 image-file-name-extensions)
19341 t)
19344 (defun org-file-image-p (file &optional extensions)
19345 "Return non-nil if FILE is an image."
19346 (save-match-data
19347 (string-match (org-image-file-name-regexp extensions) file)))
19349 (defun org-get-cursor-date ()
19350 "Return the date at cursor in as a time.
19351 This works in the calendar and in the agenda, anywhere else it just
19352 returns the current time."
19353 (let (date day defd)
19354 (cond
19355 ((eq major-mode 'calendar-mode)
19356 (setq date (calendar-cursor-to-date)
19357 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19358 ((eq major-mode 'org-agenda-mode)
19359 (setq day (get-text-property (point) 'day))
19360 (if day
19361 (setq date (calendar-gregorian-from-absolute day)
19362 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19363 (nth 2 date))))))
19364 (or defd (current-time))))
19366 (defvar org-agenda-action-marker (make-marker)
19367 "Marker pointing to the entry for the next agenda action.")
19369 (defun org-mark-entry-for-agenda-action ()
19370 "Mark the current entry as target of an agenda action.
19371 Agenda actions are actions executed from the agenda with the key `k',
19372 which make use of the date at the cursor."
19373 (interactive)
19374 (move-marker org-agenda-action-marker
19375 (save-excursion (org-back-to-heading t) (point))
19376 (current-buffer))
19377 (message
19378 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19380 (defun org-mark-subtree ()
19381 "Mark the current subtree.
19382 This puts point at the start of the current subtree, and mark at the end.
19384 If point is in an inline task, mark that task instead."
19385 (interactive)
19386 (let ((inline-task-p
19387 (and (featurep 'org-inlinetask)
19388 (org-inlinetask-in-task-p)))
19389 (beg))
19390 ;; Get beginning of subtree
19391 (cond
19392 (inline-task-p (org-inlinetask-goto-beginning))
19393 ((org-at-heading-p) (beginning-of-line))
19394 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19395 (setq beg (point))
19396 ;; Get end of it
19397 (if inline-task-p
19398 (org-inlinetask-goto-end)
19399 (org-end-of-subtree))
19400 ;; Mark zone
19401 (push-mark (point) nil t)
19402 (goto-char beg)))
19404 ;;; Paragraph filling stuff.
19405 ;; We want this to be just right, so use the full arsenal.
19407 (defun org-indent-line-function ()
19408 "Indent line depending on context."
19409 (interactive)
19410 (let* ((pos (point))
19411 (itemp (org-at-item-p))
19412 (case-fold-search t)
19414 (inline-task-p (and (featurep 'org-inlinetask)
19415 (org-inlinetask-in-task-p)))
19416 (inline-re (and inline-task-p
19417 (org-inlinetask-outline-regexp)))
19418 column)
19419 (beginning-of-line 1)
19420 (cond
19421 ;; Comments
19422 ((looking-at "# ") (setq column 0))
19423 ;; Headings
19424 ((looking-at org-outline-regexp) (setq column 0))
19425 ;; Included files
19427 ;; Footnote definition
19428 ((looking-at org-footnote-definition-re) (setq column 0))
19429 ;; Literal examples
19431 (setq column (org-get-indentation))) ; do nothing
19432 ;; Lists
19433 ((ignore-errors (goto-char (org-in-item-p)))
19434 (setq column (if itemp
19435 (org-get-indentation)
19436 (org-list-item-body-column (point))))
19437 (goto-char pos))
19438 ;; Drawers
19440 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19441 (save-excursion
19442 (goto-char (1- (match-beginning 1)))
19443 (setq column (current-column))))
19444 ;; Special blocks
19446 (save-excursion
19447 (re-search-backward
19449 (setq column (org-get-indentation (match-string 0))))
19452 (save-excursion
19454 (setq column
19455 (if (equal (downcase (match-string 1)) "src")
19456 ;; src blocks: let `org-edit-src-exit' handle them
19457 (org-get-indentation)
19458 (org-get-indentation (match-string 0)))))
19459 ;; This line has nothing special, look at the previous relevant
19460 ;; line to compute indentation
19461 (t
19462 (beginning-of-line 0)
19463 (while (and (not (bobp))
19464 (not (looking-at org-drawer-regexp))
19465 ;; When point started in an inline task, do not move
19466 ;; above task starting line.
19467 (not (and inline-task-p (looking-at inline-re)))
19468 ;; Skip drawers, blocks, empty lines, verbatim,
19469 ;; comments, tables, footnotes definitions, lists,
19470 ;; inline tasks.
19472 (re-search-backward org-drawer-regexp nil t))
19476 (looking-at org-footnote-definition-re)
19477 (and (ignore-errors (goto-char (org-in-item-p)))
19478 (goto-char
19479 (org-list-get-top-point (org-list-struct))))
19480 (and (not inline-task-p)
19481 (featurep 'org-inlinetask)
19482 (org-inlinetask-in-task-p)
19483 (or (org-inlinetask-goto-beginning) t))))
19484 (beginning-of-line 0))
19485 (cond
19486 ;; There was an heading above.
19488 (if (not org-adapt-indentation)
19489 (setq column 0)
19490 (goto-char (match-end 0))
19491 (setq column (current-column))))
19492 ;; A drawer had started and is unfinished
19493 ((looking-at org-drawer-regexp)
19494 (goto-char (1- (match-beginning 1)))
19495 (setq column (current-column)))
19496 ;; Else, nothing noticeable found: get indentation and go on.
19497 (t (setq column (org-get-indentation))))))
19498 ;; Now apply indentation and move cursor accordingly
19499 (goto-char pos)
19500 (if (<= (current-column) (current-indentation))
19501 (org-indent-line-to column)
19502 (save-excursion (org-indent-line-to column)))
19503 ;; Special polishing for properties, see `org-property-format'
19504 (setq column (current-column))
19505 (beginning-of-line 1)
19506 (if (looking-at
19508 (replace-match (concat (match-string 1)
19509 (format org-property-format
19510 (match-string 2) (match-string 3)))
19511 t t))
19512 (org-move-to-column column)))
19514 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19515 "Variable to store copy of `adaptive-fill-regexp'.
19516 Since `adaptive-fill-regexp' is set to never match, we need to
19517 store a backup of its value before entering `org-mode' so that
19518 the functionality can be provided as a fall-back.")
19520 (defun org-set-autofill-regexps ()
19521 (interactive)
19522 ;; In the paragraph separator we include headlines, because filling
19523 ;; text in a line directly attached to a headline would otherwise
19524 ;; fill the headline as well.
19527 ;; The paragraph starter includes hand-formatted lists.
19528 (org-set-local
19529 'paragraph-start
19530 (concat
19539 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19540 ;; But only if the user has not turned off tables or fixed-width regions
19541 (org-set-local
19542 'auto-fill-inhibit-regexp
19543 (concat org-outline-regexp
19546 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19547 (concat
19549 (if org-enable-table-editor "|" "")
19550 (if org-enable-fixed-width-editor ":" "")
19551 "]"))))
19552 ;; We use our own fill-paragraph function, to make sure that tables
19553 ;; and fixed-width regions are not wrapped. That function will pass
19554 ;; through to `fill-paragraph' when appropriate.
19555 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19556 ;; Prevent auto-fill from inserting unwanted new items.
19557 (org-set-local 'fill-nobreak-predicate
19558 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19559 fill-nobreak-predicate
19560 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19561 ;; Adaptive filling: To get full control, first make sure that
19562 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19563 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19564 (org-set-local 'org-adaptive-fill-regexp-backup
19565 adaptive-fill-regexp))
19567 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19568 (org-set-local 'adaptive-fill-function
19569 'org-adaptive-fill-function)
19570 (org-set-local
19571 'align-mode-rules-list
19572 '((org-in-buffer-settings
19574 (modes . '(org-mode))))))
19576 (defun org-fill-item-nobreak-p ()
19577 "Non-nil when a line break at point would insert a new item."
19578 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19580 (defun org-fill-paragraph (&optional justify)
19581 "Re-align a table, pass through to fill-paragraph if no table."
19582 (let ((table-p (org-at-table-p))
19583 (table.el-p (org-at-table.el-p))
19584 (itemp (org-in-item-p)))
19585 (cond ((and (equal (char-after (point-at-bol)) ?*)
19586 (save-excursion (goto-char (point-at-bol))
19587 (looking-at org-outline-regexp)))
19588 t) ; skip headlines
19589 (table.el-p t) ; skip table.el tables
19590 (table-p (org-table-align) t) ; align Org tables
19591 (itemp ; align text in items
19592 (let* ((struct (save-excursion (goto-char itemp)
19593 (org-list-struct)))
19594 (parents (org-list-parents-alist struct))
19595 (children (org-list-get-children itemp struct parents))
19596 beg end prev next prefix)
19597 ;; Determine in which part of item point is: before
19598 ;; first child, after last child, between two
19599 ;; sub-lists, or simply in item if there's no child.
19600 (cond
19601 ((not children)
19602 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19603 beg itemp
19604 end (org-list-get-item-end itemp struct)))
19605 ((< (point) (setq next (car children)))
19606 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19607 beg itemp
19608 end next))
19609 ((> (point) (setq prev (car (last children))))
19610 (setq beg (org-list-get-item-end prev struct)
19611 end (org-list-get-item-end itemp struct)
19612 prefix (save-excursion
19613 (goto-char beg)
19615 (make-string (current-column) ?\ ))))
19616 (t (catch 'exit
19617 (while (setq next (pop children))
19618 (if (> (point) next)
19619 (setq prev next)
19620 (setq beg (org-list-get-item-end prev struct)
19621 end next
19622 prefix (save-excursion
19623 (goto-char beg)
19625 (make-string (current-column) ?\ )))
19626 (throw 'exit nil))))))
19627 ;; Use `fill-paragraph' with buffer narrowed to item
19628 ;; without any child, and with our computed PREFIX.
19629 (flet ((fill-context-prefix (from to &optional flr) prefix))
19630 (save-restriction
19631 (narrow-to-region beg end)
19632 (save-excursion (fill-paragraph justify)))) t))
19633 ;; Special case where point is not in a list but is on
19634 ;; a paragraph adjacent to a list: make sure this paragraph
19635 ;; doesn't get merged with the end of the list by narrowing
19636 ;; buffer first.
19637 ((save-excursion (forward-paragraph -1)
19638 (setq itemp (org-in-item-p)))
19639 (let ((struct (save-excursion (goto-char itemp)
19640 (org-list-struct))))
19641 (save-restriction
19642 (narrow-to-region (org-list-get-bottom-point struct)
19643 (save-excursion (forward-paragraph 1)
19644 (point)))
19645 (fill-paragraph justify) t)))
19646 ;; Else simply call `fill-paragraph'.
19647 (t nil))))
19649 ;; For reference, this is the default value of adaptive-fill-regexp
19652 (defun org-adaptive-fill-function ()
19653 "Return a fill prefix for org-mode files."
19654 (let (itemp)
19655 (save-excursion
19656 (cond
19657 ;; Comment line
19659 (match-string-no-properties 0))
19660 ;; Plain list item
19661 ((org-at-item-p)
19662 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19663 ;; Point is in a list after `backward-paragraph': original
19664 ;; point wasn't in the list, or filling would have been taken
19665 ;; care of by `org-auto-fill-function', but the list and the
19666 ;; real paragraph are not separated by a blank line. Thus, move
19667 ;; point after the list to go back to real paragraph and
19668 ;; determine fill-prefix.
19669 ((setq itemp (org-in-item-p))
19670 (goto-char itemp)
19671 (let* ((struct (org-list-struct))
19672 (bottom (org-list-get-bottom-point struct)))
19673 (goto-char bottom)
19674 (make-string (org-get-indentation) ?\ )))
19675 ;; Other text
19676 ((looking-at org-adaptive-fill-regexp-backup)
19677 (match-string-no-properties 0))))))
19679 (defun org-auto-fill-function ()
19680 "Auto-fill function."
19681 (let (itemp prefix)
19682 ;; When in a list, compute an appropriate fill-prefix and make
19683 ;; sure it will be used by `do-auto-fill'.
19684 (if (setq itemp (org-in-item-p))
19685 (progn
19686 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19687 (flet ((fill-context-prefix (from to &optional flr) prefix))
19688 (do-auto-fill)))
19689 ;; Else just use `do-auto-fill'.
19690 (do-auto-fill))))
19692 ;;; Other stuff.
19694 (defun org-toggle-fixed-width-section (arg)
19695 "Toggle the fixed-width export.
19696 If there is no active region, the QUOTE keyword at the current headline is
19697 inserted or removed. When present, it causes the text between this headline
19698 and the next to be exported as fixed-width text, and unmodified.
19699 If there is an active region, this command adds or removes a colon as the
19700 first character of this line. If the first character of a line is a colon,
19701 this line is also exported in fixed-width font."
19702 (interactive "P")
19703 (let* ((cc 0)
19704 (regionp (org-region-active-p))
19705 (beg (if regionp (region-beginning) (point)))
19706 (end (if regionp (region-end)))
19707 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19708 (case-fold-search nil)
19710 off)
19711 (if regionp
19712 (save-excursion
19713 (goto-char beg)
19714 (setq cc (current-column))
19715 (beginning-of-line 1)
19716 (setq off (looking-at re))
19717 (while (> nlines 0)
19718 (setq nlines (1- nlines))
19719 (beginning-of-line 1)
19720 (cond
19721 (arg
19722 (org-move-to-column cc t)
19724 (forward-line -1))
19725 ((and off (looking-at re))
19726 (replace-match "" t t nil 1))
19727 ((not off) (org-move-to-column cc t) (insert ": ")))
19728 (forward-line 1)))
19729 (save-excursion
19730 (org-back-to-heading)
19731 (if (looking-at (concat org-outline-regexp
19733 (replace-match "" t t nil 1)
19734 (if (looking-at org-outline-regexp)
19735 (progn
19736 (goto-char (match-end 0))
19737 (insert org-quote-string " "))))))))
19739 (defun org-reftex-citation ()
19740 "Use reftex-citation to insert a citation into the buffer.
19741 This looks for a line like
19743 #+BIBLIOGRAPHY: foo plain option:-d
19745 and derives from it that foo.bib is the bibliography file relevant
19746 for this document. It then installs the necessary environment for RefTeX
19747 to work in this buffer and calls `reftex-citation' to insert a citation
19748 into the buffer.
19750 Export of such citations to both LaTeX and HTML is handled by the contributed
19751 package org-exp-bibtex by Taru Karttunen."
19752 (interactive)
19753 (let ((reftex-docstruct-symbol 'rds)
19755 rds bib)
19756 (save-excursion
19757 (save-restriction
19758 (widen)
19759 (let ((case-fold-search t)
19761 (if (not (save-excursion
19762 (or (re-search-forward re nil t)
19763 (re-search-backward re nil t))))
19764 (error "No bibliography defined in file")
19765 (setq bib (concat (match-string 1) ".bib")
19766 rds (list (list 'bib bib)))))))
19767 (call-interactively 'reftex-citation)))
19769 ;;;; Functions extending outline functionality
19771 (defun org-beginning-of-line (&optional arg)
19772 "Go to the beginning of the current line. If that is invisible, continue
19773 to a visible line beginning. This makes the function of C-a more intuitive.
19774 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19775 first attempt, and only move to after the tags when the cursor is already
19776 beyond the end of the headline."
19777 (interactive "P")
19778 (let ((pos (point))
19779 (special (if (consp org-special-ctrl-a/e)
19780 (car org-special-ctrl-a/e)
19781 org-special-ctrl-a/e))
19782 refpos)
19783 (if (org-bound-and-true-p line-move-visual)
19784 (beginning-of-visual-line 1)
19785 (beginning-of-line 1))
19786 (if (and arg (fboundp 'move-beginning-of-line))
19787 (call-interactively 'move-beginning-of-line)
19788 (if (bobp)
19789 nil
19790 (backward-char 1)
19791 (if (org-truely-invisible-p)
19792 (while (and (not (bobp)) (org-truely-invisible-p))
19793 (backward-char 1)
19794 (beginning-of-line 1))
19795 (forward-char 1))))
19796 (when special
19797 (cond
19798 ((and (looking-at org-complex-heading-regexp)
19799 (= (char-after (match-end 1)) ?\ ))
19800 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19801 (point-at-eol)))
19802 (goto-char
19803 (if (eq special t)
19804 (cond ((> pos refpos) refpos)
19805 ((= pos (point)) refpos)
19806 (t (point)))
19807 (cond ((> pos (point)) (point))
19808 ((not (eq last-command this-command)) (point))
19809 (t refpos)))))
19810 ((org-at-item-p)
19811 (goto-char
19812 (if (eq special t)
19813 (cond ((> pos (match-end 0)) (match-end 0))
19814 ((= pos (point)) (match-end 0))
19815 (t (point)))
19816 (cond ((> pos (point)) (point))
19817 ((not (eq last-command this-command)) (point))
19818 (t (match-end 0))))))))
19819 (org-no-warnings
19820 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19822 (defun org-end-of-line (&optional arg)
19823 "Go to the end of the line.
19824 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19825 first attempt, and only move to after the tags when the cursor is already
19826 beyond the end of the headline."
19827 (interactive "P")
19828 (let ((special (if (consp org-special-ctrl-a/e)
19829 (cdr org-special-ctrl-a/e)
19830 org-special-ctrl-a/e)))
19831 (if (or (not special)
19832 (not (org-on-heading-p))
19833 arg)
19834 (call-interactively
19835 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19836 ((fboundp 'move-end-of-line) 'move-end-of-line)
19837 (t 'end-of-line)))
19838 (let ((pos (point)))
19839 (beginning-of-line 1)
19841 (if (eq special t)
19842 (if (or (< pos (match-beginning 1))
19843 (= pos (match-end 0)))
19844 (goto-char (match-beginning 1))
19845 (goto-char (match-end 0)))
19846 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19847 (goto-char (match-end 0))
19848 (goto-char (match-beginning 1))))
19849 (call-interactively (if (fboundp 'move-end-of-line)
19850 'move-end-of-line
19851 'end-of-line)))))
19852 (org-no-warnings
19853 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19855 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19856 (define-key org-mode-map "\C-e" 'org-end-of-line)
19858 (defun org-backward-sentence (&optional arg)
19859 "Go to beginning of sentence, or beginning of table field.
19860 This will call `backward-sentence' or `org-table-beginning-of-field',
19861 depending on context."
19862 (interactive "P")
19863 (cond
19864 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19865 (t (call-interactively 'backward-sentence))))
19867 (defun org-forward-sentence (&optional arg)
19868 "Go to end of sentence, or end of table field.
19869 This will call `forward-sentence' or `org-table-end-of-field',
19870 depending on context."
19871 (interactive "P")
19872 (cond
19873 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19874 (t (call-interactively 'forward-sentence))))
19876 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19877 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19879 (defun org-kill-line (&optional arg)
19880 "Kill line, to tags or end of line."
19881 (interactive "P")
19882 (cond
19883 ((or (not org-special-ctrl-k)
19884 (bolp)
19885 (not (org-on-heading-p)))
19886 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19887 org-ctrl-k-protect-subtree)
19888 (if (or (eq org-ctrl-k-protect-subtree 'error)
19889 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19890 (error "C-k aborted - would kill hidden subtree")))
19891 (call-interactively 'kill-line))
19893 (kill-region (point) (match-beginning 1))
19894 (org-set-tags nil t))
19895 (t (kill-region (point) (point-at-eol)))))
19897 (define-key org-mode-map "\C-k" 'org-kill-line)
19899 (defun org-yank (&optional arg)
19900 "Yank. If the kill is a subtree, treat it specially.
19901 This command will look at the current kill and check if is a single
19902 subtree, or a series of subtrees[1]. If it passes the test, and if the
19903 cursor is at the beginning of a line or after the stars of a currently
19904 empty headline, then the yank is handled specially. How exactly depends
19905 on the value of the following variables, both set by default.
19907 org-yank-folded-subtrees
19908 When set, the subtree(s) will be folded after insertion, but only
19909 if doing so would now swallow text after the yanked text.
19911 org-yank-adjusted-subtrees
19912 When set, the subtree will be promoted or demoted in order to
19913 fit into the local outline tree structure, which means that the level
19914 will be adjusted so that it becomes the smaller one of the two
19915 *visible* surrounding headings.
19917 Any prefix to this command will cause `yank' to be called directly with
19919 will just
19920 plainly yank the text as it is.
19922 \[1] The test checks if the first non-white line is a heading
19923 and if there are no other headings with fewer stars."
19924 (interactive "P")
19925 (org-yank-generic 'yank arg))
19927 (defun org-yank-generic (command arg)
19928 "Perform some yank-like command.
19930 This function implements the behavior described in the `org-yank'
19931 documentation. However, it has been generalized to work for any
19932 interactive command with similar behavior."
19934 ;; pretend to be command COMMAND
19935 (setq this-command command)
19937 (if arg
19938 (call-interactively command)
19940 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19941 (and (org-kill-is-subtree-p)
19942 (or (bolp)
19944 (string-match
19946 (buffer-substring (point-at-bol) (point)))))))
19947 swallowp)
19948 (cond
19949 ((and subtreep org-yank-folded-subtrees)
19950 (let ((beg (point))
19951 end)
19952 (if (and subtreep org-yank-adjusted-subtrees)
19953 (org-paste-subtree nil nil 'for-yank)
19954 (call-interactively command))
19956 (setq end (point))
19957 (goto-char beg)
19958 (when (and (bolp) subtreep
19959 (not (setq swallowp
19960 (org-yank-folding-would-swallow-text beg end))))
19961 (org-with-limited-levels
19962 (or (looking-at org-outline-regexp)
19963 (re-search-forward org-outline-regexp-bol end t))
19964 (while (and (< (point) end) (looking-at org-outline-regexp))
19965 (hide-subtree)
19966 (org-cycle-show-empty-lines 'folded)
19967 (condition-case nil
19968 (outline-forward-same-level 1)
19969 (error (goto-char end))))))
19970 (when swallowp
19971 (message
19972 "Inserted text not folded because that would swallow text"))
19974 (goto-char end)
19976 (beginning-of-line 1)
19977 (push-mark beg 'nomsg)))
19978 ((and subtreep org-yank-adjusted-subtrees)
19979 (let ((beg (point-at-bol)))
19980 (org-paste-subtree nil nil 'for-yank)
19981 (push-mark beg 'nomsg)))
19982 (t
19983 (call-interactively command))))))
19985 (defun org-yank-folding-would-swallow-text (beg end)
19986 "Would hide-subtree at BEG swallow any text after END?"
19987 (let (level)
19988 (org-with-limited-levels
19989 (save-excursion
19990 (goto-char beg)
19991 (when (or (looking-at org-outline-regexp)
19992 (re-search-forward org-outline-regexp-bol end t))
19993 (setq level (org-outline-level)))
19994 (goto-char end)
19996 (if (or (eobp)
19997 (and (bolp) (looking-at org-outline-regexp)
19998 (<= (org-outline-level) level)))
19999 nil ; Nothing would be swallowed
20000 t))))) ; something would swallow
20002 (define-key org-mode-map "\C-y" 'org-yank)
20004 (defun org-truely-invisible-p ()
20005 "Check if point is at a character currently not visible.
20006 This version does not only check the character property, but also
20007 `visible-mode'."
20008 ;; Early versions of noutline don't have `outline-invisible-p'.
20009 (if (org-bound-and-true-p visible-mode)
20010 nil
20011 (outline-invisible-p)))
20013 (defun org-invisible-p2 ()
20014 "Check if point is at a character currently not visible."
20015 (save-excursion
20016 (if (and (eolp) (not (bobp))) (backward-char 1))
20017 ;; Early versions of noutline don't have `outline-invisible-p'.
20018 (outline-invisible-p)))
20020 (defun org-back-to-heading (&optional invisible-ok)
20021 "Call `outline-back-to-heading', but provide a better error message."
20022 (condition-case nil
20023 (outline-back-to-heading invisible-ok)
20024 (error (error "Before first headline at position %d in buffer %s"
20025 (point) (current-buffer)))))
20027 (defun org-beginning-of-defun ()
20028 "Go to the beginning of the subtree, i.e. back to the heading."
20029 (org-back-to-heading))
20030 (defun org-end-of-defun ()
20031 "Go to the end of the subtree."
20032 (org-end-of-subtree nil t))
20034 (defun org-before-first-heading-p ()
20035 "Before first heading?"
20036 (save-excursion
20037 (end-of-line)
20038 (null (re-search-backward org-outline-regexp-bol nil t))))
20040 (defun org-on-heading-p (&optional ignored)
20041 (outline-on-heading-p t))
20042 (defun org-at-heading-p (&optional ignored)
20043 (outline-on-heading-p t))
20045 (defun org-point-at-end-of-empty-headline ()
20046 "If point is at the end of an empty headline, return t, else nil.
20047 If the heading only contains a TODO keyword, it is still still considered
20048 empty."
20050 (save-excursion
20051 (beginning-of-line 1)
20052 (let ((case-fold-search nil))
20055 (defun org-at-heading-or-item-p ()
20056 (or (org-on-heading-p) (org-at-item-p)))
20058 (defun org-on-target-p ()
20059 (or (org-in-regexp org-radio-target-regexp)
20060 (org-in-regexp org-target-regexp)))
20062 (defun org-up-heading-all (arg)
20063 "Move to the heading line of which the present line is a subheading.
20064 This function considers both visible and invisible heading lines.
20065 With argument, move up ARG levels."
20066 (if (fboundp 'outline-up-heading-all)
20067 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20068 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20070 (defun org-up-heading-safe ()
20071 "Move to the heading line of which the present line is a subheading.
20072 This version will not throw an error. It will return the level of the
20073 headline found, or nil if no higher level is found.
20075 Also, this function will be a lot faster than `outline-up-heading',
20076 because it relies on stars being the outline starters. This can really
20077 make a significant difference in outlines with very many siblings."
20078 (let (start-level re)
20079 (org-back-to-heading t)
20080 (setq start-level (funcall outline-level))
20081 (if (equal start-level 1)
20082 nil
20084 (if (re-search-backward re nil t)
20085 (funcall outline-level)))))
20087 (defun org-first-sibling-p ()
20088 "Is this heading the first child of its parents?"
20089 (interactive)
20090 (let ((re org-outline-regexp-bol)
20091 level l)
20092 (unless (org-at-heading-p t)
20093 (error "Not at a heading"))
20094 (setq level (funcall outline-level))
20095 (save-excursion
20096 (if (not (re-search-backward re nil t))
20097 t
20098 (setq l (funcall outline-level))
20099 (< l level)))))
20101 (defun org-goto-sibling (&optional previous)
20102 "Goto the next sibling, even if it is invisible.
20103 When PREVIOUS is set, go to the previous sibling instead. Returns t
20104 when a sibling was found. When none is found, return nil and don't
20105 move point."
20106 (let ((fun (if previous 're-search-backward 're-search-forward))
20107 (pos (point))
20108 (re org-outline-regexp-bol)
20109 level l)
20110 (when (condition-case nil (org-back-to-heading t) (error nil))
20111 (setq level (funcall outline-level))
20112 (catch 'exit
20113 (or previous (forward-char 1))
20114 (while (funcall fun re nil t)
20115 (setq l (funcall outline-level))
20116 (when (< l level) (goto-char pos) (throw 'exit nil))
20117 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20118 (goto-char pos)
20119 nil))))
20121 (defun org-show-siblings ()
20122 "Show all siblings of the current headline."
20123 (save-excursion
20124 (while (org-goto-sibling) (org-flag-heading nil)))
20125 (save-excursion
20126 (while (org-goto-sibling 'previous)
20127 (org-flag-heading nil))))
20129 (defun org-goto-first-child ()
20130 "Goto the first child, even if it is invisible.
20131 Return t when a child was found. Otherwise don't move point and
20132 return nil."
20133 (let (level (pos (point)) (re org-outline-regexp-bol))
20134 (when (condition-case nil (org-back-to-heading t) (error nil))
20135 (setq level (outline-level))
20136 (forward-char 1)
20137 (if (and (re-search-forward re nil t) (> (outline-level) level))
20138 (progn (goto-char (match-beginning 0)) t)
20139 (goto-char pos) nil))))
20141 (defun org-show-hidden-entry ()
20142 "Show an entry where even the heading is hidden."
20143 (save-excursion
20144 (org-show-entry)))
20146 (defun org-flag-heading (flag &optional entry)
20147 "Flag the current heading. FLAG non-nil means make invisible.
20148 When ENTRY is non-nil, show the entire entry."
20149 (save-excursion
20150 (org-back-to-heading t)
20151 ;; Check if we should show the entire entry
20152 (if entry
20153 (progn
20154 (org-show-entry)
20155 (save-excursion
20156 (and (outline-next-heading)
20157 (org-flag-heading nil))))
20158 (outline-flag-region (max (point-min) (1- (point)))
20159 (save-excursion (outline-end-of-heading) (point))
20160 flag))))
20162 (defun org-get-next-sibling ()
20163 "Move to next heading of the same level, and return point.
20164 If there is no such heading, return nil.
20165 This is like outline-next-sibling, but invisible headings are ok."
20166 (let ((level (funcall outline-level)))
20167 (outline-next-heading)
20168 (while (and (not (eobp)) (> (funcall outline-level) level))
20169 (outline-next-heading))
20170 (if (or (eobp) (< (funcall outline-level) level))
20171 nil
20172 (point))))
20174 (defun org-get-last-sibling ()
20175 "Move to previous heading of the same level, and return point.
20176 If there is no such heading, return nil."
20177 (let ((opoint (point))
20178 (level (funcall outline-level)))
20179 (outline-previous-heading)
20180 (when (and (/= (point) opoint) (outline-on-heading-p t))
20181 (while (and (> (funcall outline-level) level)
20182 (not (bobp)))
20183 (outline-previous-heading))
20184 (if (< (funcall outline-level) level)
20185 nil
20186 (point)))))
20188 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20189 ;; This contains an exact copy of the original function, but it uses
20190 ;; `org-back-to-heading', to make it work also in invisible
20191 ;; trees. And is uses an invisible-OK argument.
20192 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20193 ;; Furthermore, when used inside Org, finding the end of a large subtree
20194 ;; with many children and grandchildren etc, this can be much faster
20195 ;; than the outline version.
20196 (org-back-to-heading invisible-OK)
20197 (let ((first t)
20198 (level (funcall outline-level)))
20199 (if (and (org-mode-p) (< level 1000))
20200 ;; A true heading (not a plain list item), in Org-mode
20201 ;; This means we can easily find the end by looking
20202 ;; only for the right number of stars. Using a regexp to do
20203 ;; this is so much faster than using a Lisp loop.
20205 (forward-char 1)
20206 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20207 ;; something else, do it the slow way
20208 (while (and (not (eobp))
20209 (or first (> (funcall outline-level) level)))
20210 (setq first nil)
20211 (outline-next-heading)))
20212 (unless to-heading
20214 (progn
20215 ;; Go to end of line before heading
20216 (forward-char -1)
20218 ;; leave blank line before heading
20219 (forward-char -1))))))
20220 (point))
20222 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20223 "Use Org version in org-mode, for dramatic speed-up."
20224 (if (org-mode-p)
20225 (progn
20226 (org-end-of-subtree nil t)
20227 (unless (eobp) (backward-char 1)))
20228 ad-do-it))
20230 (defun org-end-of-meta-data-and-drawers ()
20231 "Jump to the first text after meta data and drawers in the current entry.
20232 This will move over empty lines, lines with planning time stamps,
20233 clocking lines, and drawers."
20234 (org-back-to-heading t)
20235 (let ((end (save-excursion (outline-next-heading) (point)))
20238 (forward-line 1)
20239 (while (re-search-forward re end t)
20240 (if (not (match-end 1))
20241 ;; empty or planning line
20242 (forward-line 1)
20243 ;; a drawer, find the end
20245 (forward-line 1)))
20247 (point)))
20249 (defun org-forward-same-level (arg &optional invisible-ok)
20250 "Move forward to the arg'th subheading at same level as this one.
20251 Stop at the first and last subheadings of a superior heading.
20252 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20253 it wil also look at invisible ones."
20254 (interactive "p")
20255 (org-back-to-heading invisible-ok)
20256 (org-on-heading-p)
20257 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20259 l)
20260 (forward-char 1)
20261 (while (> arg 0)
20262 (while (and (re-search-forward re nil 'move)
20263 (setq l (- (match-end 0) (match-beginning 0) 1))
20264 (= l level)
20265 (not invisible-ok)
20266 (progn (backward-char 1) (outline-invisible-p)))
20267 (if (< l level) (setq arg 1)))
20268 (setq arg (1- arg)))
20269 (beginning-of-line 1)))
20271 (defun org-backward-same-level (arg &optional invisible-ok)
20272 "Move backward to the arg'th subheading at same level as this one.
20273 Stop at the first and last subheadings of a superior heading."
20274 (interactive "p")
20275 (org-back-to-heading)
20276 (org-on-heading-p)
20277 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20279 l)
20280 (while (> arg 0)
20281 (while (and (re-search-backward re nil 'move)
20282 (setq l (- (match-end 0) (match-beginning 0) 1))
20283 (= l level)
20284 (not invisible-ok)
20285 (outline-invisible-p))
20286 (if (< l level) (setq arg 1)))
20287 (setq arg (1- arg)))))
20289 (defun org-show-subtree ()
20290 "Show everything after this heading at deeper levels."
20291 (outline-flag-region
20292 (point)
20293 (save-excursion
20294 (org-end-of-subtree t t))
20295 nil))
20297 (defun org-show-entry ()
20298 "Show the body directly following this heading.
20299 Show the heading too, if it is currently invisible."
20300 (interactive)
20301 (save-excursion
20302 (condition-case nil
20303 (progn
20304 (org-back-to-heading t)
20305 (outline-flag-region
20306 (max (point-min) (1- (point)))
20307 (save-excursion
20308 (if (re-search-forward
20310 (match-beginning 1)
20311 (point-max)))
20312 nil)
20313 (org-cycle-hide-drawers 'children))
20314 (error nil))))
20316 (defun org-make-options-regexp (kwds &optional extra)
20317 "Make a regular expression for keyword lines."
20318 (concat
20319 "^"
20326 ;; Make isearch reveal the necessary context
20327 (defun org-isearch-end ()
20328 "Reveal context after isearch exits."
20329 (when isearch-success ; only if search was successful
20330 (if (featurep 'xemacs)
20331 ;; Under XEmacs, the hook is run in the correct place,
20332 ;; we directly show the context.
20333 (org-show-context 'isearch)
20334 ;; In Emacs the hook runs *before* restoring the overlays.
20335 ;; So we have to use a one-time post-command-hook to do this.
20336 ;; (Emacs 22 has a special variable, see function `org-mode')
20337 (unless (and (boundp 'isearch-mode-end-hook-quit)
20338 isearch-mode-end-hook-quit)
20339 ;; Only when the isearch was not quitted.
20340 (org-add-hook 'post-command-hook 'org-isearch-post-command
20341 'append 'local)))))
20343 (defun org-isearch-post-command ()
20344 "Remove self from hook, and show context."
20345 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20346 (org-show-context 'isearch))
20349 ;;;; Integration with and fixes for other packages
20351 ;;; Imenu support
20353 (defvar org-imenu-markers nil
20354 "All markers currently used by Imenu.")
20355 (make-variable-buffer-local 'org-imenu-markers)
20357 (defun org-imenu-new-marker (&optional pos)
20358 "Return a new marker for use by Imenu, and remember the marker."
20359 (let ((m (make-marker)))
20360 (move-marker m (or pos (point)))
20361 (push m org-imenu-markers)
20362 m))
20364 (defun org-imenu-get-tree ()
20365 "Produce the index for Imenu."
20366 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20367 (setq org-imenu-markers nil)
20368 (let* ((n org-imenu-depth)
20369 (re (concat "^" (org-get-limited-outline-regexp)))
20370 (subs (make-vector (1+ n) nil))
20371 (last-level 0)
20372 m level head)
20373 (save-excursion
20374 (save-restriction
20375 (widen)
20376 (goto-char (point-max))
20377 (while (re-search-backward re nil t)
20378 (setq level (org-reduced-level (funcall outline-level)))
20379 (when (<= level n)
20380 (looking-at org-complex-heading-regexp)
20381 (setq head (org-link-display-format
20382 (org-match-string-no-properties 4))
20383 m (org-imenu-new-marker))
20384 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20385 (if (>= level last-level)
20386 (push (cons head m) (aref subs level))
20387 (push (cons head (aref subs (1+ level))) (aref subs level))
20388 (loop for i from (1+ level) to n do (aset subs i nil)))
20389 (setq last-level level)))))
20390 (aref subs 1)))
20392 (eval-after-load "imenu"
20393 '(progn
20394 (add-hook 'imenu-after-jump-hook
20395 (lambda ()
20396 (if (org-mode-p)
20397 (org-show-context 'org-goto))))))
20399 (defun org-link-display-format (link)
20400 "Replace a link with either the description, or the link target
20401 if no description is present"
20402 (save-match-data
20403 (if (string-match org-bracket-link-analytic-regexp link)
20404 (replace-match (if (match-end 5)
20405 (match-string 5 link)
20406 (concat (match-string 1 link)
20407 (match-string 3 link)))
20408 nil t link)
20409 link)))
20411 ;; Speedbar support
20413 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20414 "Overlay marking the agenda restriction line in speedbar.")
20415 (overlay-put org-speedbar-restriction-lock-overlay
20416 'face 'org-agenda-restriction-lock)
20417 (overlay-put org-speedbar-restriction-lock-overlay
20418 'help-echo "Agendas are currently limited to this item.")
20419 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20421 (defun org-speedbar-set-agenda-restriction ()
20422 "Restrict future agenda commands to the location at point in speedbar.
20424 (interactive)
20425 (require 'org-agenda)
20426 (let (p m tp np dir txt)
20427 (cond
20428 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20429 'org-imenu t))
20430 (setq m (get-text-property p 'org-imenu-marker))
20431 (with-current-buffer (marker-buffer m)
20432 (goto-char m)
20433 (org-agenda-set-restriction-lock 'subtree)))
20434 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20435 'speedbar-function 'speedbar-find-file))
20436 (setq tp (previous-single-property-change
20437 (1+ p) 'speedbar-function)
20438 np (next-single-property-change
20439 tp 'speedbar-function)
20440 dir (speedbar-line-directory)
20441 txt (buffer-substring-no-properties (or tp (point-min))
20442 (or np (point-max))))
20443 (with-current-buffer (find-file-noselect
20444 (let ((default-directory dir))
20445 (expand-file-name txt)))
20446 (unless (org-mode-p)
20447 (error "Cannot restrict to non-Org-mode file"))
20448 (org-agenda-set-restriction-lock 'file)))
20449 (t (error "Don't know how to restrict Org-mode's agenda")))
20450 (move-overlay org-speedbar-restriction-lock-overlay
20451 (point-at-bol) (point-at-eol))
20452 (setq current-prefix-arg nil)
20453 (org-agenda-maybe-redo)))
20455 (eval-after-load "speedbar"
20456 '(progn
20457 (speedbar-add-supported-extension ".org")
20458 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20459 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20460 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20461 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20462 (add-hook 'speedbar-visiting-tag-hook
20463 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20465 ;;; Fixes and Hacks for problems with other packages
20467 ;; Make flyspell not check words in links, to not mess up our keymap
20468 (defun org-mode-flyspell-verify ()
20469 "Don't let flyspell put overlays at active buttons, or on
20470 {todo,all-time,additional-option-like}-keywords."
20471 (let ((pos (max (1- (point)) (point-min)))
20472 (word (thing-at-point 'word)))
20473 (and (not (get-text-property pos 'keymap))
20474 (not (get-text-property pos 'org-no-flyspell))
20475 (not (member word org-todo-keywords-1))
20476 (not (member word org-all-time-keywords))
20477 (not (member word org-additional-option-like-keywords)))))
20479 (defun org-remove-flyspell-overlays-in (beg end)
20480 "Remove flyspell overlays in region."
20481 (and (org-bound-and-true-p flyspell-mode)
20482 (fboundp 'flyspell-delete-region-overlays)
20483 (flyspell-delete-region-overlays beg end))
20484 (add-text-properties beg end '(org-no-flyspell t)))
20486 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20487 (eval-after-load "bookmark"
20488 '(if (boundp 'bookmark-after-jump-hook)
20489 ;; We can use the hook
20490 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20491 ;; Hook not available, use advice
20492 (defadvice bookmark-jump (after org-make-visible activate)
20493 "Make the position visible."
20494 (org-bookmark-jump-unhide))))
20496 ;; Make sure saveplace shows the location if it was hidden
20497 (eval-after-load "saveplace"
20498 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20499 "Make the position visible."
20500 (org-bookmark-jump-unhide)))
20502 ;; Make sure ecb shows the location if it was hidden
20503 (eval-after-load "ecb"
20504 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20505 "Make hierarchy visible when jumping into location from ECB tree buffer."
20506 (if (org-mode-p)
20507 (org-show-context))))
20509 (defun org-bookmark-jump-unhide ()
20510 "Unhide the current position, to show the bookmark location."
20511 (and (org-mode-p)
20512 (or (outline-invisible-p)
20513 (save-excursion (goto-char (max (point-min) (1- (point))))
20514 (outline-invisible-p)))
20515 (org-show-context 'bookmark-jump)))
20517 ;; Make session.el ignore our circular variable
20518 (eval-after-load "session"
20519 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20521 ;;;; Experimental code
20523 (defun org-closed-in-range ()
20524 "Sparse tree of items closed in a certain time range.
20525 Still experimental, may disappear in the future."
20526 (interactive)
20527 ;; Get the time interval from the user.
20528 (let* ((time1 (org-float-time
20529 (org-read-date nil 'to-time nil "Starting date: ")))
20530 (time2 (org-float-time
20531 (org-read-date nil 'to-time nil "End date:")))
20532 ;; callback function
20533 (callback (lambda ()
20534 (let ((time
20535 (org-float-time
20536 (apply 'encode-time
20537 (org-parse-time-string
20538 (match-string 1))))))
20539 ;; check if time in interval
20540 (and (>= time time1) (<= time time2))))))
20541 ;; make tree, check each match with the callback
20544 ;;;; Finish up
20546 (provide 'org)
20548 (run-hooks 'org-load-hook)
20550 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20552 ;;; org.el ends here